feat(api): api update

Author: stainless-app[bot]

.stats.yml

@@ -1,4 +1,4 @@
 configured_endpoints: 265
-openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/onlyfansapi/onlyfansapi-0f5b27a377922abdbb2e57feb12601f2d92833cefaad9e301ad09a9972ea72c2.yml
-openapi_spec_hash: 57c96cc1e38a5988580696892c0ce585
+openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/onlyfansapi/onlyfansapi-5b7eaf3aea520bc245be9b93991257f9c1b5ad2ebad57eb17e80ac97fbdc66a4.yml
+openapi_spec_hash: c6cfa0dc8655e915bd8f945d84121803
 config_hash: 397c91e15c0024f8b5bbed9b82c2348c

src/onlyfansapi/resources/data_exports.py

@@ -70,6 +70,7 @@ def create(
             "fans",
             "followings",
             "profile_visitors",
+            "fansly_chat_messages",
         ],
         account_ids: SequenceNotStr[str] | Omit = omit,
         auto_start: bool | Omit = omit,
@@ -91,18 +92,20 @@ def create(
           end_date: The end date for the export (ISO 8601 format).
 
           file_type: The output file format. Supported formats vary by export type: `csv` or `xlsx`
-              for transactions, chat_messages, trial_links, tracking_links, smart_links,
-              payouts, chargebacks, public_profiles, fans, followings, profile_visitors; `zip`
-              for media_vault.
+              for transactions, chat_messages, fansly_chat_messages, trial_links,
+              tracking_links, smart_links, payouts, chargebacks, public_profiles, fans,
+              followings, profile_visitors; `zip` for media_vault.
 
           start_date: The start date for the export (ISO 8601 format).
 
-          type: The type of data to export. `profile_visitors` returns one row per account per
-              day, scraped one day at a time so the daily numbers are not aggregated away by
-              OnlyFans.
+          type: The type of data to export. Use `fansly_chat_messages` to export Fansly chat
+              messages (all other types are OnlyFans). `profile_visitors` returns one row per
+              account per day, scraped one day at a time so the daily numbers are not
+              aggregated away by OnlyFans.
 
           account_ids: Array of account prefixed IDs to export data from. Not required for
-              `public_profiles` type.
+              `public_profiles` type. For `fansly_chat_messages`, pass Fansly account prefixed
+              IDs (`fansly_acct_...`); all other types take OnlyFans account IDs.
 
           auto_start: When true, automatically starts the export after creation.
 
@@ -113,20 +116,23 @@ def create(
               account, max 10,000,000), `maxChats` (optional per-account chat scrape limit),
               `skipMassMessages` (optional, bool), `chatIds` (optional array of numeric
               fan/chat IDs; filters output and can drastically reduce totals). For
-              `media_vault`: `mediaType` (required, one of: `all`, `photo`, `gif`, `video`,
-              `audio`). For `fans`: `type` (required, one of: `all`, `active`, `expired`,
-              `latest`). For `followings`: `type` (required, one of: `all`, `active`,
-              `expired`). For `public_profiles`: `query` (optional, full-text search),
-              `gender` (optional, filter: male, female, trans, couple), `minSubscribePrice`
-              (optional, USD), `maxSubscribePrice` (optional, USD), `location` (optional),
-              `minPostsCount` (optional, minimum posts), `minPhotosCount` (optional, minimum
-              photos), `minVideosCount` (optional, minimum videos), `minSubscribersCount`
-              (optional, minimum subscribers), `maxSubscribersCount` (optional, maximum
-              subscribers), `minJoinDate` (optional, ISO 8601 date), `minLastSeenAt`
-              (optional, ISO 8601 date), `createdAtFrom` (optional, ISO 8601 date, profile
-              added to DB after), `createdAtTo` (optional, ISO 8601 date, profile added to DB
-              before), `instagram` (optional), `twitter` (optional), `tiktok` (optional),
-              `maxResults` (optional, limit results).
+              `fansly_chat_messages`: `maxMessages` (required per account, max 10,000,000),
+              `maxChats` (optional per-account chat scrape limit), `chatIds` (optional array
+              of Fansly group ID strings; filters output and can drastically reduce totals).
+              For `media_vault`: `mediaType` (required, one of: `all`, `photo`, `gif`,
+              `video`, `audio`). For `fans`: `type` (required, one of: `all`, `active`,
+              `expired`, `latest`). For `followings`: `type` (required, one of: `all`,
+              `active`, `expired`). For `public_profiles`: `query` (optional, full-text
+              search), `gender` (optional, filter: male, female, trans, couple),
+              `minSubscribePrice` (optional, USD), `maxSubscribePrice` (optional, USD),
+              `location` (optional), `minPostsCount` (optional, minimum posts),
+              `minPhotosCount` (optional, minimum photos), `minVideosCount` (optional, minimum
+              videos), `minSubscribersCount` (optional, minimum subscribers),
+              `maxSubscribersCount` (optional, maximum subscribers), `minJoinDate` (optional,
+              ISO 8601 date), `minLastSeenAt` (optional, ISO 8601 date), `createdAtFrom`
+              (optional, ISO 8601 date, profile added to DB after), `createdAtTo` (optional,
+              ISO 8601 date, profile added to DB before), `instagram` (optional), `twitter`
+              (optional), `tiktok` (optional), `maxResults` (optional, limit results).
 
           extra_headers: Send extra headers
 
@@ -230,6 +236,7 @@ def list(
             "fans",
             "followings",
             "profile_visitors",
+            "fansly_chat_messages",
         ]
         | Omit = omit,
         # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
@@ -428,6 +435,7 @@ async def create(
             "fans",
             "followings",
             "profile_visitors",
+            "fansly_chat_messages",
         ],
         account_ids: SequenceNotStr[str] | Omit = omit,
         auto_start: bool | Omit = omit,
@@ -449,18 +457,20 @@ async def create(
           end_date: The end date for the export (ISO 8601 format).
 
           file_type: The output file format. Supported formats vary by export type: `csv` or `xlsx`
-              for transactions, chat_messages, trial_links, tracking_links, smart_links,
-              payouts, chargebacks, public_profiles, fans, followings, profile_visitors; `zip`
-              for media_vault.
+              for transactions, chat_messages, fansly_chat_messages, trial_links,
+              tracking_links, smart_links, payouts, chargebacks, public_profiles, fans,
+              followings, profile_visitors; `zip` for media_vault.
 
           start_date: The start date for the export (ISO 8601 format).
 
-          type: The type of data to export. `profile_visitors` returns one row per account per
-              day, scraped one day at a time so the daily numbers are not aggregated away by
-              OnlyFans.
+          type: The type of data to export. Use `fansly_chat_messages` to export Fansly chat
+              messages (all other types are OnlyFans). `profile_visitors` returns one row per
+              account per day, scraped one day at a time so the daily numbers are not
+              aggregated away by OnlyFans.
 
           account_ids: Array of account prefixed IDs to export data from. Not required for
-              `public_profiles` type.
+              `public_profiles` type. For `fansly_chat_messages`, pass Fansly account prefixed
+              IDs (`fansly_acct_...`); all other types take OnlyFans account IDs.
 
           auto_start: When true, automatically starts the export after creation.
 
@@ -471,20 +481,23 @@ async def create(
               account, max 10,000,000), `maxChats` (optional per-account chat scrape limit),
               `skipMassMessages` (optional, bool), `chatIds` (optional array of numeric
               fan/chat IDs; filters output and can drastically reduce totals). For
-              `media_vault`: `mediaType` (required, one of: `all`, `photo`, `gif`, `video`,
-              `audio`). For `fans`: `type` (required, one of: `all`, `active`, `expired`,
-              `latest`). For `followings`: `type` (required, one of: `all`, `active`,
-              `expired`). For `public_profiles`: `query` (optional, full-text search),
-              `gender` (optional, filter: male, female, trans, couple), `minSubscribePrice`
-              (optional, USD), `maxSubscribePrice` (optional, USD), `location` (optional),
-              `minPostsCount` (optional, minimum posts), `minPhotosCount` (optional, minimum
-              photos), `minVideosCount` (optional, minimum videos), `minSubscribersCount`
-              (optional, minimum subscribers), `maxSubscribersCount` (optional, maximum
-              subscribers), `minJoinDate` (optional, ISO 8601 date), `minLastSeenAt`
-              (optional, ISO 8601 date), `createdAtFrom` (optional, ISO 8601 date, profile
-              added to DB after), `createdAtTo` (optional, ISO 8601 date, profile added to DB
-              before), `instagram` (optional), `twitter` (optional), `tiktok` (optional),
-              `maxResults` (optional, limit results).
+              `fansly_chat_messages`: `maxMessages` (required per account, max 10,000,000),
+              `maxChats` (optional per-account chat scrape limit), `chatIds` (optional array
+              of Fansly group ID strings; filters output and can drastically reduce totals).
+              For `media_vault`: `mediaType` (required, one of: `all`, `photo`, `gif`,
+              `video`, `audio`). For `fans`: `type` (required, one of: `all`, `active`,
+              `expired`, `latest`). For `followings`: `type` (required, one of: `all`,
+              `active`, `expired`). For `public_profiles`: `query` (optional, full-text
+              search), `gender` (optional, filter: male, female, trans, couple),
+              `minSubscribePrice` (optional, USD), `maxSubscribePrice` (optional, USD),
+              `location` (optional), `minPostsCount` (optional, minimum posts),
+              `minPhotosCount` (optional, minimum photos), `minVideosCount` (optional, minimum
+              videos), `minSubscribersCount` (optional, minimum subscribers),
+              `maxSubscribersCount` (optional, maximum subscribers), `minJoinDate` (optional,
+              ISO 8601 date), `minLastSeenAt` (optional, ISO 8601 date), `createdAtFrom`
+              (optional, ISO 8601 date, profile added to DB after), `createdAtTo` (optional,
+              ISO 8601 date, profile added to DB before), `instagram` (optional), `twitter`
+              (optional), `tiktok` (optional), `maxResults` (optional, limit results).
 
           extra_headers: Send extra headers
 
@@ -588,6 +601,7 @@ async def list(
             "fans",
             "followings",
             "profile_visitors",
+            "fansly_chat_messages",
         ]
         | Omit = omit,
         # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.

src/onlyfansapi/resources/media/vault/lists/lists.py

@@ -2,6 +2,8 @@
 
 from __future__ import annotations
 
+from typing import Any, cast
+
 import httpx
 
 from .media import (
@@ -175,6 +177,7 @@ def list(
         self,
         account: str,
         *,
+        lightweight: bool | Omit = omit,
         limit: int | Omit = omit,
         offset: int | Omit = omit,
         query: str | Omit = omit,
@@ -188,7 +191,25 @@ def list(
         """
         List your Vault lists (categories).
 
+        Every response carries an `ETag` computed over the `data` payload. Send it back
+        as `If-None-Match` on your next call and you will get a `304 Not Modified` with
+        an empty body when nothing changed, so you can keep serving your cached copy
+        instead of re-parsing the full list. Credits are debited either way — we still
+        have to ask OnlyFans for the current state to know whether it changed.
+
+        The `ETag` covers `data` only, never `_meta` — your credits balance changes on
+        every call, so including it would mean the `ETag` never matches. Because a `304`
+        has no body, it also has no `_meta`: read the current credits and rate-limit
+        counters from the `X-OFAPI-Credits-Used`, `X-OFAPI-Credits-Balance`,
+        `X-Rate-Limit-Limit-Minute` and `X-Rate-Limit-Remaining-Minute` response
+        headers, which are sent on `304` responses too. The `_meta` inside a body you
+        cached earlier is stale by definition.
+
         Args:
+          lightweight: Set to `true` to return only `id`, `name`, `type`, `canUpdate` and a rolled-up
+              `mediaCount` per list, dropping the `medias` previews. Much smaller payload —
+              ideal for rendering a folder picker. Default: `false`
+
           limit: Number of media to return per page. Default: `24`
 
           offset: The offset used for pagination. Default `0`
@@ -205,23 +226,27 @@ def list(
         """
         if not account:
             raise ValueError(f"Expected a non-empty value for `account` but received {account!r}")
-        return self._get(
-            path_template("/api/{account}/media/vault/lists", account=account),
-            options=make_request_options(
-                extra_headers=extra_headers,
-                extra_query=extra_query,
-                extra_body=extra_body,
-                timeout=timeout,
-                query=maybe_transform(
-                    {
-                        "limit": limit,
-                        "offset": offset,
-                        "query": query,
-                    },
-                    list_list_params.ListListParams,
+        return cast(
+            ListListResponse,
+            self._get(
+                path_template("/api/{account}/media/vault/lists", account=account),
+                options=make_request_options(
+                    extra_headers=extra_headers,
+                    extra_query=extra_query,
+                    extra_body=extra_body,
+                    timeout=timeout,
+                    query=maybe_transform(
+                        {
+                            "lightweight": lightweight,
+                            "limit": limit,
+                            "offset": offset,
+                            "query": query,
+                        },
+                        list_list_params.ListListParams,
+                    ),
                 ),
+                cast_to=cast(Any, ListListResponse),  # Union types cannot be passed in as arguments in the type system
             ),
-            cast_to=ListListResponse,
         )
 
     def delete(
@@ -403,6 +428,7 @@ async def list(
         self,
         account: str,
         *,
+        lightweight: bool | Omit = omit,
         limit: int | Omit = omit,
         offset: int | Omit = omit,
         query: str | Omit = omit,
@@ -416,7 +442,25 @@ async def list(
         """
         List your Vault lists (categories).
 
+        Every response carries an `ETag` computed over the `data` payload. Send it back
+        as `If-None-Match` on your next call and you will get a `304 Not Modified` with
+        an empty body when nothing changed, so you can keep serving your cached copy
+        instead of re-parsing the full list. Credits are debited either way — we still
+        have to ask OnlyFans for the current state to know whether it changed.
+
+        The `ETag` covers `data` only, never `_meta` — your credits balance changes on
+        every call, so including it would mean the `ETag` never matches. Because a `304`
+        has no body, it also has no `_meta`: read the current credits and rate-limit
+        counters from the `X-OFAPI-Credits-Used`, `X-OFAPI-Credits-Balance`,
+        `X-Rate-Limit-Limit-Minute` and `X-Rate-Limit-Remaining-Minute` response
+        headers, which are sent on `304` responses too. The `_meta` inside a body you
+        cached earlier is stale by definition.
+
         Args:
+          lightweight: Set to `true` to return only `id`, `name`, `type`, `canUpdate` and a rolled-up
+              `mediaCount` per list, dropping the `medias` previews. Much smaller payload —
+              ideal for rendering a folder picker. Default: `false`
+
           limit: Number of media to return per page. Default: `24`
 
           offset: The offset used for pagination. Default `0`
@@ -433,23 +477,27 @@ async def list(
         """
         if not account:
             raise ValueError(f"Expected a non-empty value for `account` but received {account!r}")
-        return await self._get(
-            path_template("/api/{account}/media/vault/lists", account=account),
-            options=make_request_options(
-                extra_headers=extra_headers,
-                extra_query=extra_query,
-                extra_body=extra_body,
-                timeout=timeout,
-                query=await async_maybe_transform(
-                    {
-                        "limit": limit,
-                        "offset": offset,
-                        "query": query,
-                    },
-                    list_list_params.ListListParams,
+        return cast(
+            ListListResponse,
+            await self._get(
+                path_template("/api/{account}/media/vault/lists", account=account),
+                options=make_request_options(
+                    extra_headers=extra_headers,
+                    extra_query=extra_query,
+                    extra_body=extra_body,
+                    timeout=timeout,
+                    query=await async_maybe_transform(
+                        {
+                            "lightweight": lightweight,
+                            "limit": limit,
+                            "offset": offset,
+                            "query": query,
+                        },
+                        list_list_params.ListListParams,
+                    ),
                 ),
+                cast_to=cast(Any, ListListResponse),  # Union types cannot be passed in as arguments in the type system
             ),
-            cast_to=ListListResponse,
         )
 
     async def delete(