release: 0.2.0

.github/workflows/ci.yml

@@ -18,7 +18,7 @@ jobs:
   lint:
     timeout-minutes: 10
     name: lint
-    runs-on: ${{ github.repository == 'stainless-sdks/onlyfansapi-python' && 'depot-ubuntu-24.04' || 'ubuntu-latest' }}
+    runs-on: ${{ startsWith(github.repository, 'stainless-sdks/') && 'depot-ubuntu-24.04' || 'ubuntu-latest' }}
     if: (github.event_name == 'push' || github.event.pull_request.head.repo.fork) && (github.event_name != 'push' || github.event.head_commit.message != 'codegen metadata')
     steps:
       - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
@@ -41,7 +41,7 @@ jobs:
     permissions:
       contents: read
       id-token: write
-    runs-on: ${{ github.repository == 'stainless-sdks/onlyfansapi-python' && 'depot-ubuntu-24.04' || 'ubuntu-latest' }}
+    runs-on: ${{ startsWith(github.repository, 'stainless-sdks/') && 'depot-ubuntu-24.04' || 'ubuntu-latest' }}
     steps:
       - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
 
@@ -78,7 +78,7 @@ jobs:
   test:
     timeout-minutes: 10
     name: test
-    runs-on: ${{ github.repository == 'stainless-sdks/onlyfansapi-python' && 'depot-ubuntu-24.04' || 'ubuntu-latest' }}
+    runs-on: ${{ startsWith(github.repository, 'stainless-sdks/') && 'depot-ubuntu-24.04' || 'ubuntu-latest' }}
     if: github.event_name == 'push' || github.event.pull_request.head.repo.fork
     steps:
       - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2

.release-please-manifest.json

@@ -1,3 +1,3 @@
 {
-  ".": "0.1.2"
+  ".": "0.2.0"
 }

.stats.yml

@@ -1,4 +1,4 @@
-configured_endpoints: 266
-openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/onlyfansapi/onlyfansapi-ba5efdf86108ef077f2db1f8a05b84d58f7f218fe2b7e0eb72e3c371cfa30015.yml
-openapi_spec_hash: 6c2d47cd85674ece07dc37e471a36ac9
+configured_endpoints: 265
+openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/onlyfansapi/onlyfansapi-136aa659b2d54ff3c25f6b35164a84db20dba3a7b513bf2c72544bbdb13ce6c1.yml
+openapi_spec_hash: 94a889e758a4baf8e3b699a6cbe17d01
 config_hash: 397c91e15c0024f8b5bbed9b82c2348c

api.md

@@ -233,18 +233,6 @@ Methods:
 
 - <code title="post /api/{account}/chats/mark-as-read">client.chats.mark_all_as_read.<a href="./src/onlyfansapi/resources/chats/mark_all_as_read.py">all</a>(account) -> <a href="./src/onlyfansapi/types/chats/mark_all_as_read_all_response.py">MarkAllAsReadAllResponse</a></code>
 
-# Messages
-
-Types:
-
-```python
-from onlyfansapi.types import MessageAttachTagsResponse
-```
-
-Methods:
-
-- <code title="post /api/{account}/messages/{message_id}/attach-tags">client.messages.<a href="./src/onlyfansapi/resources/messages.py">attach_tags</a>(message_id, \*, account, \*\*<a href="src/onlyfansapi/types/message_attach_tags_params.py">params</a>) -> <a href="./src/onlyfansapi/types/message_attach_tags_response.py">MessageAttachTagsResponse</a></code>
-
 # ClientSessions
 
 Types:
@@ -520,12 +508,12 @@ Methods:
 Types:
 
 ```python
-from onlyfansapi.types import MediaDownloadResponse, MediaScrapeResponse, MediaUploadResponse
+from onlyfansapi.types import MediaScrapeResponse, MediaUploadResponse
 ```
 
 Methods:
 
-- <code title="get /api/{account}/media/download/{cdnUrl}">client.media.<a href="./src/onlyfansapi/resources/media/media.py">download</a>(cdn_url, \*, account) -> str</code>
+- <code title="get /api/{account}/media/download/{cdnUrl}">client.media.<a href="./src/onlyfansapi/resources/media/media.py">download</a>(cdn_url, \*, account) -> None</code>
 - <code title="post /api/{account}/media/scrape">client.media.<a href="./src/onlyfansapi/resources/media/media.py">scrape</a>(account, \*\*<a href="src/onlyfansapi/types/media_scrape_params.py">params</a>) -> <a href="./src/onlyfansapi/types/media_scrape_response.py">MediaScrapeResponse</a></code>
 - <code title="post /api/{account}/media/upload">client.media.<a href="./src/onlyfansapi/resources/media/media.py">upload</a>(account, \*\*<a href="src/onlyfansapi/types/media_upload_params.py">params</a>) -> <a href="./src/onlyfansapi/types/media_upload_response.py">MediaUploadResponse</a></code>
 
@@ -579,7 +567,7 @@ Methods:
 
 - <code title="post /api/{account}/media/vault/lists">client.media.vault.lists.<a href="./src/onlyfansapi/resources/media/vault/lists/lists.py">create</a>(account, \*\*<a href="src/onlyfansapi/types/media/vault/list_create_params.py">params</a>) -> <a href="./src/onlyfansapi/types/media/vault/list_create_response.py">ListCreateResponse</a></code>
 - <code title="get /api/{account}/media/vault/lists/{list_id}">client.media.vault.lists.<a href="./src/onlyfansapi/resources/media/vault/lists/lists.py">retrieve</a>(list_id, \*, account) -> <a href="./src/onlyfansapi/types/media/vault/list_retrieve_response.py">ListRetrieveResponse</a></code>
-- <code title="put /api/{account}/media/vault/lists/{list_id}">client.media.vault.lists.<a href="./src/onlyfansapi/resources/media/vault/lists/lists.py">update</a>(list_id, \*, account) -> <a href="./src/onlyfansapi/types/media/vault/list_update_response.py">ListUpdateResponse</a></code>
+- <code title="put /api/{account}/media/vault/lists/{list_id}">client.media.vault.lists.<a href="./src/onlyfansapi/resources/media/vault/lists/lists.py">update</a>(list_id, \*, account, \*\*<a href="src/onlyfansapi/types/media/vault/list_update_params.py">params</a>) -> <a href="./src/onlyfansapi/types/media/vault/list_update_response.py">ListUpdateResponse</a></code>
 - <code title="get /api/{account}/media/vault/lists">client.media.vault.lists.<a href="./src/onlyfansapi/resources/media/vault/lists/lists.py">list</a>(account, \*\*<a href="src/onlyfansapi/types/media/vault/list_list_params.py">params</a>) -> <a href="./src/onlyfansapi/types/media/vault/list_list_response.py">ListListResponse</a></code>
 - <code title="delete /api/{account}/media/vault/lists/{list_id}">client.media.vault.lists.<a href="./src/onlyfansapi/resources/media/vault/lists/lists.py">delete</a>(list_id, \*, account) -> <a href="./src/onlyfansapi/types/media/vault/list_delete_response.py">ListDeleteResponse</a></code>
 

pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "onlyfans"
-version = "0.1.2"
+version = "0.2.0"
 description = "The official Python library for the OnlyFansAPI API"
 dynamic = ["readme"]
 license = "Apache-2.0"

scripts/lint

@@ -13,7 +13,7 @@ else
 fi
 
 echo "==> Running pyright"
-uv run pyright
+uv run pyright -p .
 
 echo "==> Running mypy"
 uv run mypy .

src/onlyfansapi/_client.py

@@ -53,7 +53,6 @@
         payouts,
         stories,
         accounts,
-        messages,
         profiles,
         settings,
         webhooks,
@@ -90,7 +89,6 @@
     from .resources.bundles import BundlesResource, AsyncBundlesResource
     from .resources.payouts import PayoutsResource, AsyncPayoutsResource
     from .resources.accounts import AccountsResource, AsyncAccountsResource
-    from .resources.messages import MessagesResource, AsyncMessagesResource
     from .resources.profiles import ProfilesResource, AsyncProfilesResource
     from .resources.webhooks import WebhooksResource, AsyncWebhooksResource
     from .resources.fans.fans import FansResource, AsyncFansResource
@@ -251,12 +249,6 @@ def chats(self) -> ChatsResource:
 
         return ChatsResource(self)
 
-    @cached_property
-    def messages(self) -> MessagesResource:
-        from .resources.messages import MessagesResource
-
-        return MessagesResource(self)
-
     @cached_property
     def client_sessions(self) -> ClientSessionsResource:
         from .resources.client_sessions import ClientSessionsResource
@@ -311,7 +303,7 @@ def giphy(self) -> GiphyResource:
 
     @cached_property
     def link_tags(self) -> LinkTagsResource:
-        """APIs for managing tags on free trial links and tracking links"""
+        """APIs for managing tags on free trial links, tracking links, and Smart Links"""
         from .resources.link_tags import LinkTagsResource
 
         return LinkTagsResource(self)
@@ -505,9 +497,11 @@ def qs(self) -> Querystring:
 
     @override
     def _auth_headers(self, security: SecurityOptions) -> dict[str, str]:
-        return {
-            **(self._default if security.get("default", False) else {}),
-        }
+        headers: dict[str, str] = {}
+        if security.get("default", False):
+            for key, value in self._default.items():
+                headers.setdefault(key, value)
+        return headers
 
     @property
     def _default(self) -> dict[str, str]:
@@ -719,12 +713,6 @@ def chats(self) -> AsyncChatsResource:
 
         return AsyncChatsResource(self)
 
-    @cached_property
-    def messages(self) -> AsyncMessagesResource:
-        from .resources.messages import AsyncMessagesResource
-
-        return AsyncMessagesResource(self)
-
     @cached_property
     def client_sessions(self) -> AsyncClientSessionsResource:
         from .resources.client_sessions import AsyncClientSessionsResource
@@ -779,7 +767,7 @@ def giphy(self) -> AsyncGiphyResource:
 
     @cached_property
     def link_tags(self) -> AsyncLinkTagsResource:
-        """APIs for managing tags on free trial links and tracking links"""
+        """APIs for managing tags on free trial links, tracking links, and Smart Links"""
         from .resources.link_tags import AsyncLinkTagsResource
 
         return AsyncLinkTagsResource(self)
@@ -973,9 +961,11 @@ def qs(self) -> Querystring:
 
     @override
     def _auth_headers(self, security: SecurityOptions) -> dict[str, str]:
-        return {
-            **(self._default if security.get("default", False) else {}),
-        }
+        headers: dict[str, str] = {}
+        if security.get("default", False):
+            for key, value in self._default.items():
+                headers.setdefault(key, value)
+        return headers
 
     @property
     def _default(self) -> dict[str, str]:
@@ -1129,12 +1119,6 @@ def chats(self) -> chats.ChatsResourceWithRawResponse:
 
         return ChatsResourceWithRawResponse(self._client.chats)
 
-    @cached_property
-    def messages(self) -> messages.MessagesResourceWithRawResponse:
-        from .resources.messages import MessagesResourceWithRawResponse
-
-        return MessagesResourceWithRawResponse(self._client.messages)
-
     @cached_property
     def client_sessions(self) -> client_sessions.ClientSessionsResourceWithRawResponse:
         from .resources.client_sessions import ClientSessionsResourceWithRawResponse
@@ -1189,7 +1173,7 @@ def giphy(self) -> giphy.GiphyResourceWithRawResponse:
 
     @cached_property
     def link_tags(self) -> link_tags.LinkTagsResourceWithRawResponse:
-        """APIs for managing tags on free trial links and tracking links"""
+        """APIs for managing tags on free trial links, tracking links, and Smart Links"""
         from .resources.link_tags import LinkTagsResourceWithRawResponse
 
         return LinkTagsResourceWithRawResponse(self._client.link_tags)
@@ -1422,12 +1406,6 @@ def chats(self) -> chats.AsyncChatsResourceWithRawResponse:
 
         return AsyncChatsResourceWithRawResponse(self._client.chats)
 
-    @cached_property
-    def messages(self) -> messages.AsyncMessagesResourceWithRawResponse:
-        from .resources.messages import AsyncMessagesResourceWithRawResponse
-
-        return AsyncMessagesResourceWithRawResponse(self._client.messages)
-
     @cached_property
     def client_sessions(self) -> client_sessions.AsyncClientSessionsResourceWithRawResponse:
         from .resources.client_sessions import AsyncClientSessionsResourceWithRawResponse
@@ -1482,7 +1460,7 @@ def giphy(self) -> giphy.AsyncGiphyResourceWithRawResponse:
 
     @cached_property
     def link_tags(self) -> link_tags.AsyncLinkTagsResourceWithRawResponse:
-        """APIs for managing tags on free trial links and tracking links"""
+        """APIs for managing tags on free trial links, tracking links, and Smart Links"""
         from .resources.link_tags import AsyncLinkTagsResourceWithRawResponse
 
         return AsyncLinkTagsResourceWithRawResponse(self._client.link_tags)
@@ -1715,12 +1693,6 @@ def chats(self) -> chats.ChatsResourceWithStreamingResponse:
 
         return ChatsResourceWithStreamingResponse(self._client.chats)
 
-    @cached_property
-    def messages(self) -> messages.MessagesResourceWithStreamingResponse:
-        from .resources.messages import MessagesResourceWithStreamingResponse
-
-        return MessagesResourceWithStreamingResponse(self._client.messages)
-
     @cached_property
     def client_sessions(self) -> client_sessions.ClientSessionsResourceWithStreamingResponse:
         from .resources.client_sessions import ClientSessionsResourceWithStreamingResponse
@@ -1775,7 +1747,7 @@ def giphy(self) -> giphy.GiphyResourceWithStreamingResponse:
 
     @cached_property
     def link_tags(self) -> link_tags.LinkTagsResourceWithStreamingResponse:
-        """APIs for managing tags on free trial links and tracking links"""
+        """APIs for managing tags on free trial links, tracking links, and Smart Links"""
         from .resources.link_tags import LinkTagsResourceWithStreamingResponse
 
         return LinkTagsResourceWithStreamingResponse(self._client.link_tags)
@@ -2008,12 +1980,6 @@ def chats(self) -> chats.AsyncChatsResourceWithStreamingResponse:
 
         return AsyncChatsResourceWithStreamingResponse(self._client.chats)
 
-    @cached_property
-    def messages(self) -> messages.AsyncMessagesResourceWithStreamingResponse:
-        from .resources.messages import AsyncMessagesResourceWithStreamingResponse
-
-        return AsyncMessagesResourceWithStreamingResponse(self._client.messages)
-
     @cached_property
     def client_sessions(self) -> client_sessions.AsyncClientSessionsResourceWithStreamingResponse:
         from .resources.client_sessions import AsyncClientSessionsResourceWithStreamingResponse
@@ -2068,7 +2034,7 @@ def giphy(self) -> giphy.AsyncGiphyResourceWithStreamingResponse:
 
     @cached_property
     def link_tags(self) -> link_tags.AsyncLinkTagsResourceWithStreamingResponse:
-        """APIs for managing tags on free trial links and tracking links"""
+        """APIs for managing tags on free trial links, tracking links, and Smart Links"""
         from .resources.link_tags import AsyncLinkTagsResourceWithStreamingResponse
 
         return AsyncLinkTagsResourceWithStreamingResponse(self._client.link_tags)

src/onlyfansapi/_version.py

@@ -1,4 +1,4 @@
 # File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
 __title__ = "onlyfansapi"
-__version__ = "0.1.2"  # x-release-please-version
+__version__ = "0.2.0"  # x-release-please-version

src/onlyfansapi/resources/__init__.py

@@ -128,14 +128,6 @@
     AccountsResourceWithStreamingResponse,
     AsyncAccountsResourceWithStreamingResponse,
 )
-from .messages import (
-    MessagesResource,
-    AsyncMessagesResource,
-    MessagesResourceWithRawResponse,
-    AsyncMessagesResourceWithRawResponse,
-    MessagesResourceWithStreamingResponse,
-    AsyncMessagesResourceWithStreamingResponse,
-)
 from .profiles import (
     ProfilesResource,
     AsyncProfilesResource,
@@ -388,12 +380,6 @@
     "AsyncChatsResourceWithRawResponse",
     "ChatsResourceWithStreamingResponse",
     "AsyncChatsResourceWithStreamingResponse",
-    "MessagesResource",
-    "AsyncMessagesResource",
-    "MessagesResourceWithRawResponse",
-    "AsyncMessagesResourceWithRawResponse",
-    "MessagesResourceWithStreamingResponse",
-    "AsyncMessagesResourceWithStreamingResponse",
     "ClientSessionsResource",
     "AsyncClientSessionsResource",
     "ClientSessionsResourceWithRawResponse",

src/onlyfansapi/resources/authenticate.py

@@ -165,7 +165,7 @@ def start(
         force_connect: bool | Omit = omit,
         name: str | Omit = omit,
         password: str | Omit = omit,
-        proxy_country: Literal["us", "uk"] | Omit = omit,
+        proxy_country: Literal["us", "uk", "gb"] | Omit = omit,
         user_agent: str | Omit = omit,
         xbc: str | Omit = omit,
         # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
@@ -440,7 +440,7 @@ async def start(
         force_connect: bool | Omit = omit,
         name: str | Omit = omit,
         password: str | Omit = omit,
-        proxy_country: Literal["us", "uk"] | Omit = omit,
+        proxy_country: Literal["us", "uk", "gb"] | Omit = omit,
         user_agent: str | Omit = omit,
         xbc: str | 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/chats/chats.py

@@ -107,7 +107,8 @@ def list(
 
           query: Search query to filter chats
 
-          skip_users: Whether to skip user details in response (all or none). Default = all
+          skip_users: Whether to skip user details in the response (`all` or `none`). Defaults to
+              `all`.
 
           extra_headers: Send extra headers
 
@@ -239,7 +240,8 @@ def list_media(
 
           offset: Number of medias to skip for pagination
 
-          skip_users: Whether to skip user details in response (all or none). Default = all
+          skip_users: Whether to skip user details in the response (`all` or `none`). Defaults to
+              `all`.
 
           type: Filter by specific media types. Keep empty to return all.
 
@@ -399,8 +401,8 @@ def start_typing(
     ) -> ChatStartTypingResponse:
         """
         Calling this endpoint will show the target fan a "Model is typing..." note in
-        the chat for ~4 seconds. If you want to continue showing the indicator call this
-        endpoint multiple times. Free - no credits charged.
+        the chat for ~4 seconds. Duplicate calls for the same account and chat are
+        coalesced during that window.
 
         Args:
           extra_headers: Send extra headers
@@ -519,7 +521,8 @@ async def list(
 
           query: Search query to filter chats
 
-          skip_users: Whether to skip user details in response (all or none). Default = all
+          skip_users: Whether to skip user details in the response (`all` or `none`). Defaults to
+              `all`.
 
           extra_headers: Send extra headers
 
@@ -651,7 +654,8 @@ async def list_media(
 
           offset: Number of medias to skip for pagination
 
-          skip_users: Whether to skip user details in response (all or none). Default = all
+          skip_users: Whether to skip user details in the response (`all` or `none`). Defaults to
+              `all`.
 
           type: Filter by specific media types. Keep empty to return all.
 
@@ -811,8 +815,8 @@ async def start_typing(
     ) -> ChatStartTypingResponse:
         """
         Calling this endpoint will show the target fan a "Model is typing..." note in
-        the chat for ~4 seconds. If you want to continue showing the indicator call this
-        endpoint multiple times. Free - no credits charged.
+        the chat for ~4 seconds. Duplicate calls for the same account and chat are
+        coalesced during that window.
 
         Args:
           extra_headers: Send extra headers