release: 0.3.0

.github/workflows/ci.yml

@@ -18,7 +18,7 @@ jobs:
   lint:
     timeout-minutes: 10
     name: lint
-    runs-on: ${{ github.repository == 'stainless-sdks/onlyfansapi-php' && '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:
@@ -37,7 +37,7 @@ jobs:
   test:
     timeout-minutes: 10
     name: test
-    runs-on: ${{ github.repository == 'stainless-sdks/onlyfansapi-php' && '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.2.0"
+  ".": "0.3.0"
 }

.stats.yml

@@ -1,4 +1,4 @@
-configured_endpoints: 266
-openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/onlyfansapi/onlyfansapi-ad938f500376cbcae3299507132eab0c74bdb34628abb43b9be1c74bf72b9772.yml
-openapi_spec_hash: da475361c28b843ddd1b45bbea333762
-config_hash: 91d6546a82dc433b7ba1747dbe1ce4a6
+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

README.md

@@ -38,7 +38,7 @@ Parameters with a default value must be set by name.
 ```php
 <?php
 
-use Onlyfansapi\Client;
+use OnlyFansAPI\Client;
 
 $client = new Client(apiKey: getenv('ONLYFANSAPI_API_KEY') ?: 'My API Key');
 
@@ -56,14 +56,14 @@ However, builders are also provided `(new Dog)->withName("Joey")`.
 
 ### Handling errors
 
-When the library is unable to connect to the API, or if the API returns a non-success status code (i.e., 4xx or 5xx response), a subclass of `Onlyfansapi\Core\Exceptions\APIException` will be thrown:
+When the library is unable to connect to the API, or if the API returns a non-success status code (i.e., 4xx or 5xx response), a subclass of `OnlyFansAPI\Core\Exceptions\APIException` will be thrown:
 
 ```php
 <?php
 
-use Onlyfansapi\Core\Exceptions\APIConnectionException;
-use Onlyfansapi\Core\Exceptions\RateLimitException;
-use Onlyfansapi\Core\Exceptions\APIStatusException;
+use OnlyFansAPI\Core\Exceptions\APIConnectionException;
+use OnlyFansAPI\Core\Exceptions\RateLimitException;
+use OnlyFansAPI\Core\Exceptions\APIStatusException;
 
 try {
   $whoami = $client->whoami->retrieve();
@@ -105,7 +105,7 @@ You can use the `maxRetries` option to configure or disable this:
 ```php
 <?php
 
-use Onlyfansapi\Client;
+use OnlyFansAPI\Client;
 
 // Configure the default for all requests:
 $client = new Client(requestOptions: ['maxRetries' => 0]);
@@ -121,7 +121,7 @@ Request parameters that correspond to file uploads can be passed as a resource r
 ```php
 <?php
 
-use Onlyfansapi\Core\FileParam;
+use OnlyFansAPI\Core\FileParam;
 
 // Pass a string with filename and content type:
 $contents = file_get_contents('/path/to/file');

composer.json

@@ -6,7 +6,7 @@
       "src/Version.php"
     ],
     "psr-4": {
-      "Onlyfansapi\\": "src/"
+      "OnlyFansAPI\\": "src/"
     }
   },
   "autoload-dev": {

src/Accounts/AccountListParams.php

@@ -2,17 +2,17 @@
 
 declare(strict_types=1);
 
-namespace Onlyfansapi\Accounts;
+namespace OnlyFansAPI\Accounts;
 
-use Onlyfansapi\Core\Attributes\Optional;
-use Onlyfansapi\Core\Concerns\SdkModel;
-use Onlyfansapi\Core\Concerns\SdkParams;
-use Onlyfansapi\Core\Contracts\BaseModel;
+use OnlyFansAPI\Core\Attributes\Optional;
+use OnlyFansAPI\Core\Concerns\SdkModel;
+use OnlyFansAPI\Core\Concerns\SdkParams;
+use OnlyFansAPI\Core\Contracts\BaseModel;
 
 /**
  * List all connected OnlyFans accounts.
  *
- * @see Onlyfansapi\Services\AccountsService::list()
+ * @see OnlyFansAPI\Services\AccountsService::list()
  *
  * @phpstan-type AccountListParamsShape = array{
  *   onlyfansEmail?: string|null,

src/Accounts/AccountListResponseItem.php

@@ -2,15 +2,15 @@
 
 declare(strict_types=1);
 
-namespace Onlyfansapi\Accounts;
+namespace OnlyFansAPI\Accounts;
 
-use Onlyfansapi\Accounts\AccountListResponseItem\OnlyfansUserData;
-use Onlyfansapi\Core\Attributes\Optional;
-use Onlyfansapi\Core\Concerns\SdkModel;
-use Onlyfansapi\Core\Contracts\BaseModel;
+use OnlyFansAPI\Accounts\AccountListResponseItem\OnlyfansUserData;
+use OnlyFansAPI\Core\Attributes\Optional;
+use OnlyFansAPI\Core\Concerns\SdkModel;
+use OnlyFansAPI\Core\Contracts\BaseModel;
 
 /**
- * @phpstan-import-type OnlyfansUserDataShape from \Onlyfansapi\Accounts\AccountListResponseItem\OnlyfansUserData
+ * @phpstan-import-type OnlyfansUserDataShape from \OnlyFansAPI\Accounts\AccountListResponseItem\OnlyfansUserData
  *
  * @phpstan-type AccountListResponseItemShape = array{
  *   id?: string|null,

src/Accounts/AccountListResponseItem/OnlyfansUserData.php

@@ -2,23 +2,23 @@
 
 declare(strict_types=1);
 
-namespace Onlyfansapi\Accounts\AccountListResponseItem;
+namespace OnlyFansAPI\Accounts\AccountListResponseItem;
 
-use Onlyfansapi\Accounts\AccountListResponseItem\OnlyfansUserData\AvatarThumbs;
-use Onlyfansapi\Accounts\AccountListResponseItem\OnlyfansUserData\HasNewTicketReplies;
-use Onlyfansapi\Accounts\AccountListResponseItem\OnlyfansUserData\HeaderSize;
-use Onlyfansapi\Accounts\AccountListResponseItem\OnlyfansUserData\HeaderThumbs;
-use Onlyfansapi\Accounts\AccountListResponseItem\OnlyfansUserData\Upload;
-use Onlyfansapi\Core\Attributes\Optional;
-use Onlyfansapi\Core\Concerns\SdkModel;
-use Onlyfansapi\Core\Contracts\BaseModel;
+use OnlyFansAPI\Accounts\AccountListResponseItem\OnlyfansUserData\AvatarThumbs;
+use OnlyFansAPI\Accounts\AccountListResponseItem\OnlyfansUserData\HasNewTicketReplies;
+use OnlyFansAPI\Accounts\AccountListResponseItem\OnlyfansUserData\HeaderSize;
+use OnlyFansAPI\Accounts\AccountListResponseItem\OnlyfansUserData\HeaderThumbs;
+use OnlyFansAPI\Accounts\AccountListResponseItem\OnlyfansUserData\Upload;
+use OnlyFansAPI\Core\Attributes\Optional;
+use OnlyFansAPI\Core\Concerns\SdkModel;
+use OnlyFansAPI\Core\Contracts\BaseModel;
 
 /**
- * @phpstan-import-type AvatarThumbsShape from \Onlyfansapi\Accounts\AccountListResponseItem\OnlyfansUserData\AvatarThumbs
- * @phpstan-import-type HasNewTicketRepliesShape from \Onlyfansapi\Accounts\AccountListResponseItem\OnlyfansUserData\HasNewTicketReplies
- * @phpstan-import-type HeaderSizeShape from \Onlyfansapi\Accounts\AccountListResponseItem\OnlyfansUserData\HeaderSize
- * @phpstan-import-type HeaderThumbsShape from \Onlyfansapi\Accounts\AccountListResponseItem\OnlyfansUserData\HeaderThumbs
- * @phpstan-import-type UploadShape from \Onlyfansapi\Accounts\AccountListResponseItem\OnlyfansUserData\Upload
+ * @phpstan-import-type AvatarThumbsShape from \OnlyFansAPI\Accounts\AccountListResponseItem\OnlyfansUserData\AvatarThumbs
+ * @phpstan-import-type HasNewTicketRepliesShape from \OnlyFansAPI\Accounts\AccountListResponseItem\OnlyfansUserData\HasNewTicketReplies
+ * @phpstan-import-type HeaderSizeShape from \OnlyFansAPI\Accounts\AccountListResponseItem\OnlyfansUserData\HeaderSize
+ * @phpstan-import-type HeaderThumbsShape from \OnlyFansAPI\Accounts\AccountListResponseItem\OnlyfansUserData\HeaderThumbs
+ * @phpstan-import-type UploadShape from \OnlyFansAPI\Accounts\AccountListResponseItem\OnlyfansUserData\Upload
  *
  * @phpstan-type OnlyfansUserDataShape = array{
  *   id?: int|null,

src/Accounts/AccountListResponseItem/OnlyfansUserData/AvatarThumbs.php

@@ -2,11 +2,11 @@
 
 declare(strict_types=1);
 
-namespace Onlyfansapi\Accounts\AccountListResponseItem\OnlyfansUserData;
+namespace OnlyFansAPI\Accounts\AccountListResponseItem\OnlyfansUserData;
 
-use Onlyfansapi\Core\Attributes\Optional;
-use Onlyfansapi\Core\Concerns\SdkModel;
-use Onlyfansapi\Core\Contracts\BaseModel;
+use OnlyFansAPI\Core\Attributes\Optional;
+use OnlyFansAPI\Core\Concerns\SdkModel;
+use OnlyFansAPI\Core\Contracts\BaseModel;
 
 /**
  * @phpstan-type AvatarThumbsShape = array{c144?: string|null, c50?: string|null}

src/Accounts/AccountListResponseItem/OnlyfansUserData/HasNewTicketReplies.php

@@ -2,11 +2,11 @@
 
 declare(strict_types=1);
 
-namespace Onlyfansapi\Accounts\AccountListResponseItem\OnlyfansUserData;
+namespace OnlyFansAPI\Accounts\AccountListResponseItem\OnlyfansUserData;
 
-use Onlyfansapi\Core\Attributes\Optional;
-use Onlyfansapi\Core\Concerns\SdkModel;
-use Onlyfansapi\Core\Contracts\BaseModel;
+use OnlyFansAPI\Core\Attributes\Optional;
+use OnlyFansAPI\Core\Concerns\SdkModel;
+use OnlyFansAPI\Core\Contracts\BaseModel;
 
 /**
  * @phpstan-type HasNewTicketRepliesShape = array{

src/Accounts/AccountListResponseItem/OnlyfansUserData/HeaderSize.php

@@ -2,11 +2,11 @@
 
 declare(strict_types=1);
 
-namespace Onlyfansapi\Accounts\AccountListResponseItem\OnlyfansUserData;
+namespace OnlyFansAPI\Accounts\AccountListResponseItem\OnlyfansUserData;
 
-use Onlyfansapi\Core\Attributes\Optional;
-use Onlyfansapi\Core\Concerns\SdkModel;
-use Onlyfansapi\Core\Contracts\BaseModel;
+use OnlyFansAPI\Core\Attributes\Optional;
+use OnlyFansAPI\Core\Concerns\SdkModel;
+use OnlyFansAPI\Core\Contracts\BaseModel;
 
 /**
  * @phpstan-type HeaderSizeShape = array{height?: int|null, width?: int|null}

src/Accounts/AccountListResponseItem/OnlyfansUserData/HeaderThumbs.php

@@ -2,11 +2,11 @@
 
 declare(strict_types=1);
 
-namespace Onlyfansapi\Accounts\AccountListResponseItem\OnlyfansUserData;
+namespace OnlyFansAPI\Accounts\AccountListResponseItem\OnlyfansUserData;
 
-use Onlyfansapi\Core\Attributes\Optional;
-use Onlyfansapi\Core\Concerns\SdkModel;
-use Onlyfansapi\Core\Contracts\BaseModel;
+use OnlyFansAPI\Core\Attributes\Optional;
+use OnlyFansAPI\Core\Concerns\SdkModel;
+use OnlyFansAPI\Core\Contracts\BaseModel;
 
 /**
  * @phpstan-type HeaderThumbsShape = array{w480?: string|null, w760?: string|null}

src/Accounts/AccountListResponseItem/OnlyfansUserData/Upload.php

@@ -2,15 +2,15 @@
 
 declare(strict_types=1);
 
-namespace Onlyfansapi\Accounts\AccountListResponseItem\OnlyfansUserData;
+namespace OnlyFansAPI\Accounts\AccountListResponseItem\OnlyfansUserData;
 
-use Onlyfansapi\Accounts\AccountListResponseItem\OnlyfansUserData\Upload\GeoUploadArgs;
-use Onlyfansapi\Core\Attributes\Optional;
-use Onlyfansapi\Core\Concerns\SdkModel;
-use Onlyfansapi\Core\Contracts\BaseModel;
+use OnlyFansAPI\Accounts\AccountListResponseItem\OnlyfansUserData\Upload\GeoUploadArgs;
+use OnlyFansAPI\Core\Attributes\Optional;
+use OnlyFansAPI\Core\Concerns\SdkModel;
+use OnlyFansAPI\Core\Contracts\BaseModel;
 
 /**
- * @phpstan-import-type GeoUploadArgsShape from \Onlyfansapi\Accounts\AccountListResponseItem\OnlyfansUserData\Upload\GeoUploadArgs
+ * @phpstan-import-type GeoUploadArgsShape from \OnlyFansAPI\Accounts\AccountListResponseItem\OnlyfansUserData\Upload\GeoUploadArgs
  *
  * @phpstan-type UploadShape = array{
  *   geoUploadArgs?: null|GeoUploadArgs|GeoUploadArgsShape

src/Accounts/AccountListResponseItem/OnlyfansUserData/Upload/GeoUploadArgs.php

@@ -2,15 +2,15 @@
 
 declare(strict_types=1);
 
-namespace Onlyfansapi\Accounts\AccountListResponseItem\OnlyfansUserData\Upload;
+namespace OnlyFansAPI\Accounts\AccountListResponseItem\OnlyfansUserData\Upload;
 
-use Onlyfansapi\Accounts\AccountListResponseItem\OnlyfansUserData\Upload\GeoUploadArgs\Additional;
-use Onlyfansapi\Core\Attributes\Optional;
-use Onlyfansapi\Core\Concerns\SdkModel;
-use Onlyfansapi\Core\Contracts\BaseModel;
+use OnlyFansAPI\Accounts\AccountListResponseItem\OnlyfansUserData\Upload\GeoUploadArgs\Additional;
+use OnlyFansAPI\Core\Attributes\Optional;
+use OnlyFansAPI\Core\Concerns\SdkModel;
+use OnlyFansAPI\Core\Contracts\BaseModel;
 
 /**
- * @phpstan-import-type AdditionalShape from \Onlyfansapi\Accounts\AccountListResponseItem\OnlyfansUserData\Upload\GeoUploadArgs\Additional
+ * @phpstan-import-type AdditionalShape from \OnlyFansAPI\Accounts\AccountListResponseItem\OnlyfansUserData\Upload\GeoUploadArgs\Additional
  *
  * @phpstan-type GeoUploadArgsShape = array{
  *   additional?: null|Additional|AdditionalShape,

src/Accounts/AccountListResponseItem/OnlyfansUserData/Upload/GeoUploadArgs/Additional.php

@@ -2,11 +2,11 @@
 
 declare(strict_types=1);
 
-namespace Onlyfansapi\Accounts\AccountListResponseItem\OnlyfansUserData\Upload\GeoUploadArgs;
+namespace OnlyFansAPI\Accounts\AccountListResponseItem\OnlyfansUserData\Upload\GeoUploadArgs;
 
-use Onlyfansapi\Core\Attributes\Optional;
-use Onlyfansapi\Core\Concerns\SdkModel;
-use Onlyfansapi\Core\Contracts\BaseModel;
+use OnlyFansAPI\Core\Attributes\Optional;
+use OnlyFansAPI\Core\Concerns\SdkModel;
+use OnlyFansAPI\Core\Contracts\BaseModel;
 
 /**
  * @phpstan-type AdditionalShape = array{user?: string|null}

src/Analytics/Financial/FinancialGetForecastParams.php

@@ -2,19 +2,19 @@
 
 declare(strict_types=1);
 
-namespace Onlyfansapi\Analytics\Financial;
+namespace OnlyFansAPI\Analytics\Financial;
 
-use Onlyfansapi\Analytics\Financial\FinancialGetForecastParams\Metric;
-use Onlyfansapi\Analytics\Financial\FinancialGetForecastParams\Model;
-use Onlyfansapi\Core\Attributes\Required;
-use Onlyfansapi\Core\Concerns\SdkModel;
-use Onlyfansapi\Core\Concerns\SdkParams;
-use Onlyfansapi\Core\Contracts\BaseModel;
+use OnlyFansAPI\Analytics\Financial\FinancialGetForecastParams\Metric;
+use OnlyFansAPI\Analytics\Financial\FinancialGetForecastParams\Model;
+use OnlyFansAPI\Core\Attributes\Required;
+use OnlyFansAPI\Core\Concerns\SdkModel;
+use OnlyFansAPI\Core\Concerns\SdkParams;
+use OnlyFansAPI\Core\Contracts\BaseModel;
 
 /**
  * Generate revenue or churn forecasts using statistical models (Moving Average, Linear Regression, ARIMA, SARIMA).
  *
- * @see Onlyfansapi\Services\Analytics\FinancialService::getForecast()
+ * @see OnlyFansAPI\Services\Analytics\FinancialService::getForecast()
  *
  * @phpstan-type FinancialGetForecastParamsShape = array{
  *   accountIDs: list<string>,

src/Analytics/Financial/FinancialGetForecastParams/Metric.php

@@ -2,7 +2,7 @@
 
 declare(strict_types=1);
 
-namespace Onlyfansapi\Analytics\Financial\FinancialGetForecastParams;
+namespace OnlyFansAPI\Analytics\Financial\FinancialGetForecastParams;
 
 /**
  * The metric to forecast.

src/Analytics/Financial/FinancialGetForecastParams/Model.php

@@ -2,7 +2,7 @@
 
 declare(strict_types=1);
 
-namespace Onlyfansapi\Analytics\Financial\FinancialGetForecastParams;
+namespace OnlyFansAPI\Analytics\Financial\FinancialGetForecastParams;
 
 /**
  * The forecasting model to use.

src/Analytics/Financial/FinancialGetForecastResponse.php

@@ -2,17 +2,17 @@
 
 declare(strict_types=1);
 
-namespace Onlyfansapi\Analytics\Financial;
+namespace OnlyFansAPI\Analytics\Financial;
 
-use Onlyfansapi\Analytics\Financial\FinancialGetForecastResponse\Forecast;
-use Onlyfansapi\Analytics\Financial\FinancialGetForecastResponse\Historical;
-use Onlyfansapi\Core\Attributes\Optional;
-use Onlyfansapi\Core\Concerns\SdkModel;
-use Onlyfansapi\Core\Contracts\BaseModel;
+use OnlyFansAPI\Analytics\Financial\FinancialGetForecastResponse\Forecast;
+use OnlyFansAPI\Analytics\Financial\FinancialGetForecastResponse\Historical;
+use OnlyFansAPI\Core\Attributes\Optional;
+use OnlyFansAPI\Core\Concerns\SdkModel;
+use OnlyFansAPI\Core\Contracts\BaseModel;
 
 /**
- * @phpstan-import-type ForecastShape from \Onlyfansapi\Analytics\Financial\FinancialGetForecastResponse\Forecast
- * @phpstan-import-type HistoricalShape from \Onlyfansapi\Analytics\Financial\FinancialGetForecastResponse\Historical
+ * @phpstan-import-type ForecastShape from \OnlyFansAPI\Analytics\Financial\FinancialGetForecastResponse\Forecast
+ * @phpstan-import-type HistoricalShape from \OnlyFansAPI\Analytics\Financial\FinancialGetForecastResponse\Historical
  *
  * @phpstan-type FinancialGetForecastResponseShape = array{
  *   forecast?: list<Forecast|ForecastShape>|null,

src/Analytics/Financial/FinancialGetForecastResponse/Forecast.php

@@ -2,11 +2,11 @@
 
 declare(strict_types=1);
 
-namespace Onlyfansapi\Analytics\Financial\FinancialGetForecastResponse;
+namespace OnlyFansAPI\Analytics\Financial\FinancialGetForecastResponse;
 
-use Onlyfansapi\Core\Attributes\Optional;
-use Onlyfansapi\Core\Concerns\SdkModel;
-use Onlyfansapi\Core\Contracts\BaseModel;
+use OnlyFansAPI\Core\Attributes\Optional;
+use OnlyFansAPI\Core\Concerns\SdkModel;
+use OnlyFansAPI\Core\Contracts\BaseModel;
 
 /**
  * @phpstan-type ForecastShape = array{date?: string|null, value?: float|null}

src/Analytics/Financial/FinancialGetForecastResponse/Historical.php

@@ -2,11 +2,11 @@
 
 declare(strict_types=1);
 
-namespace Onlyfansapi\Analytics\Financial\FinancialGetForecastResponse;
+namespace OnlyFansAPI\Analytics\Financial\FinancialGetForecastResponse;
 
-use Onlyfansapi\Core\Attributes\Optional;
-use Onlyfansapi\Core\Concerns\SdkModel;
-use Onlyfansapi\Core\Contracts\BaseModel;
+use OnlyFansAPI\Core\Attributes\Optional;
+use OnlyFansAPI\Core\Concerns\SdkModel;
+use OnlyFansAPI\Core\Contracts\BaseModel;
 
 /**
  * @phpstan-type HistoricalShape = array{date?: string|null, value?: float|null}