proxyrequest-sdk 2.2.0__tar.gz → 4.1.0__tar.gz

{proxyrequest_sdk-2.2.0 → proxyrequest_sdk-4.1.0}/CHANGELOG.md

@@ -2,8 +2,22 @@
 
 All notable changes to the ProxyRequest Python SDK are documented here.
 
+## 4.1.0 (2026-09-25)
+
+- Add provider data balances with typed pagination, byte strings, calculation status, and checkpoint history. Access requires a superuser JWT or a superuser-owned API key.
+- Add optional `include_asns` to country, region, and city methods. Request `true` to include nested ASNs; the current API returns empty nested ASN arrays by default.
+- Preserve existing public methods and argument compatibility, and regenerate SDK reference documentation from the latest public API contract.
+
 ## Unreleased
 
+## 4.0.0 - 2026-09-22
+
+- **Breaking:** replace empty inline nested response classes with the concrete public models used by the API contract.
+- Type order packages as `PackageShort`, order ledgers as `DataLedger`, coupon packages and stats as `PackageShort` and `CouponStats`, and user coupons and currency as `CouponShort` and `UserCurrency`.
+- Render true arbitrary JSON objects as mappings in the generated SDK Reference.
+- Regenerate the SDK Reference from backend contract commit `a2d7245`, including expandable nested model fields.
+- Start the synchronized JavaScript, Python, and PHP SDK release train at version 4.0.0.
+
 ## 2.2.0 - 2026-09-21
 
 - Synchronize the public OpenAPI contract from backend commit `2c4505a`.

{proxyrequest_sdk-2.2.0 → proxyrequest_sdk-4.1.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: proxyrequest-sdk
-Version: 2.2.0
+Version: 4.1.0
 Summary: Official sync and async Python SDK for the ProxyRequest public API.
 Project-URL: Homepage, https://proxyrequest.com
 Project-URL: Documentation, https://proxyrequest.com/docs/
@@ -35,7 +35,7 @@ Description-Content-Type: text/markdown
 [![Python](https://img.shields.io/pypi/pyversions/proxyrequest-sdk.svg?cacheSeconds=300)](https://pypi.org/project/proxyrequest-sdk/)
 
 Official synchronous and asynchronous Python client for the
-[ProxyRequest](https://proxyrequest.com/) public API. It covers 80 supported operations
+[ProxyRequest](https://proxyrequest.com/) public API. It covers 81 supported operations
 in the current contract: users, orders, proxy generation, analytics, invoices,
 packages, locations, webhooks, API keys, Telegram integration, and more.
 
@@ -153,8 +153,8 @@ async def list_users() -> None:
 
 ## Resource API
 
-`Client` and `AsyncClient` expose 17 API groups. The pinned public schema contains
-82 operations; disabled `sessions_list` and `sessions_destroy` operations are
+`Client` and `AsyncClient` expose 18 API groups. The pinned public schema contains
+83 operations; disabled `sessions_list` and `sessions_destroy` operations are
 intentionally excluded. Sticky session options in proxy generation remain supported.
 
 See [backend compatibility and MFA](docs/backend-compatibility.md) for updated
@@ -165,6 +165,7 @@ client.authorization
 client.users
 client.profile
 client.orders
+client.providers
 client.proxies
 client.analytics
 client.invoices
@@ -183,7 +184,7 @@ client.news
 All operation parameters and return values are typed. Request and response
 models live in `proxyrequest_sdk.models`, use snake_case attributes, and expose
 `to_dict()` / `from_dict()` helpers. IDs follow their OpenAPI type (`UUID` or
-opaque `str`), and all byte amounts are Python integers.
+opaque `str`). Provider balance byte amounts are decimal strings; other byte amounts are Python integers.
 
 See the generated [API resource reference](https://github.com/proxyrequest/python-sdk/blob/main/docs/reference/api.md)
 and [model reference](https://github.com/proxyrequest/python-sdk/blob/main/docs/reference/models.md).
@@ -355,3 +356,17 @@ Send only `package_id`, without `data`. A system administrator can reset any use
 Persist one operation ID and reuse it when retrying the same reset, including after a process restart. This prevents a repeated request from clearing a later top-up. Use subtraction when an explicit amount should be removed from a child quota. The backend must support the reset endpoint before calling it.
 
 Version 2.1 retains legacy user and invoice models from 2.0 for compatibility with older deployments. These compatibility types do not change the current public API contract.
+
+## Provider data balances
+
+Available since 4.1.0. Authenticate with a superuser JWT or an API key owned by an active superuser.
+
+```python
+page = client.providers.list_data_balances(limit=20)
+for balance in page.results:
+    print(balance.provider_name, balance.remaining_bytes, balance.history)
+```
+
+Provider byte amounts are exact decimal **strings**, including history entries; calculated usage and remaining amounts can be `null`. The response includes observation and calculation times, freshness, errors, and recent checkpoint history. History is limited by the server's `PROVIDER_DATA_BALANCE_HISTORY_LIMIT` setting (default 10). Standard pagination applies to providers.
+
+Country, region, and city methods also support `include_asns`. Set it to `true` to populate nested ASN arrays; omitted or false uses the API's empty-array default.

{proxyrequest_sdk-2.2.0 → proxyrequest_sdk-4.1.0}/README.md

@@ -5,7 +5,7 @@
 [![Python](https://img.shields.io/pypi/pyversions/proxyrequest-sdk.svg?cacheSeconds=300)](https://pypi.org/project/proxyrequest-sdk/)
 
 Official synchronous and asynchronous Python client for the
-[ProxyRequest](https://proxyrequest.com/) public API. It covers 80 supported operations
+[ProxyRequest](https://proxyrequest.com/) public API. It covers 81 supported operations
 in the current contract: users, orders, proxy generation, analytics, invoices,
 packages, locations, webhooks, API keys, Telegram integration, and more.
 
@@ -123,8 +123,8 @@ async def list_users() -> None:
 
 ## Resource API
 
-`Client` and `AsyncClient` expose 17 API groups. The pinned public schema contains
-82 operations; disabled `sessions_list` and `sessions_destroy` operations are
+`Client` and `AsyncClient` expose 18 API groups. The pinned public schema contains
+83 operations; disabled `sessions_list` and `sessions_destroy` operations are
 intentionally excluded. Sticky session options in proxy generation remain supported.
 
 See [backend compatibility and MFA](docs/backend-compatibility.md) for updated
@@ -135,6 +135,7 @@ client.authorization
 client.users
 client.profile
 client.orders
+client.providers
 client.proxies
 client.analytics
 client.invoices
@@ -153,7 +154,7 @@ client.news
 All operation parameters and return values are typed. Request and response
 models live in `proxyrequest_sdk.models`, use snake_case attributes, and expose
 `to_dict()` / `from_dict()` helpers. IDs follow their OpenAPI type (`UUID` or
-opaque `str`), and all byte amounts are Python integers.
+opaque `str`). Provider balance byte amounts are decimal strings; other byte amounts are Python integers.
 
 See the generated [API resource reference](https://github.com/proxyrequest/python-sdk/blob/main/docs/reference/api.md)
 and [model reference](https://github.com/proxyrequest/python-sdk/blob/main/docs/reference/models.md).
@@ -325,3 +326,17 @@ Send only `package_id`, without `data`. A system administrator can reset any use
 Persist one operation ID and reuse it when retrying the same reset, including after a process restart. This prevents a repeated request from clearing a later top-up. Use subtraction when an explicit amount should be removed from a child quota. The backend must support the reset endpoint before calling it.
 
 Version 2.1 retains legacy user and invoice models from 2.0 for compatibility with older deployments. These compatibility types do not change the current public API contract.
+
+## Provider data balances
+
+Available since 4.1.0. Authenticate with a superuser JWT or an API key owned by an active superuser.
+
+```python
+page = client.providers.list_data_balances(limit=20)
+for balance in page.results:
+    print(balance.provider_name, balance.remaining_bytes, balance.history)
+```
+
+Provider byte amounts are exact decimal **strings**, including history entries; calculated usage and remaining amounts can be `null`. The response includes observation and calculation times, freshness, errors, and recent checkpoint history. History is limited by the server's `PROVIDER_DATA_BALANCE_HISTORY_LIMIT` setting (default 10). Standard pagination applies to providers.
+
+Country, region, and city methods also support `include_asns`. Set it to `true` to populate nested ASN arrays; omitted or false uses the API's empty-array default.

{proxyrequest_sdk-2.2.0 → proxyrequest_sdk-4.1.0}/docs/reference/api.md

@@ -115,6 +115,12 @@ All methods exist on both `Client` and `AsyncClient`; async calls must be awaite
 | `setup_two_factor()` | `POST /profile/2fa/setup` | `TwoFactorSetupResponse` |
 | `update()` | `PATCH /profile` | `User` |
 
+## `providers`
+
+| Method | HTTP endpoint | Returns |
+| --- | --- | --- |
+| `list_data_balances()` | `GET /providers/data-balances` | `PaginatedProviderDataBalanceList` |
+
 ## `proxies`
 
 | Method | HTTP endpoint | Returns |

{proxyrequest_sdk-2.2.0 → proxyrequest_sdk-4.1.0}/docs/reference/models.md

@@ -24,13 +24,16 @@ Models use snake_case attributes and provide `to_dict()` / `from_dict()` helpers
 - `CouponPriceResponse`
 - `CouponRedeem`
 - `CouponShort`
+- `CouponStats`
 - `CouponTypeEnum` — * `free_data` - Free Data * `monetary` - Money * `percentage` - Percentage
 - `CouponUpdateRequest`
+- `DataLedger` — A purchased data bucket, not a complete transaction history. Finite purchases with an expiration have separate buckets. Compatible non-expiring top-ups and unlimited packages may reuse an existing bucket.
 - `DomainRecord`
 - `DomainsResponse`
 - `EnabledResponse`
 - `FeedRecord`
 - `FeedResponse`
+- `FreshnessEnum` — * `fresh` - fresh * `stale` - stale * `unavailable` - unavailable
 - `GenerateProxyRequest` — Validates proxy generation request data and builds generator config.
 - `GenerateProxyResponse`
 - `GeneratedProxy`
@@ -57,6 +60,7 @@ Models use snake_case attributes and provide `to_dict()` / `from_dict()` helpers
 - `LogsResponse`
 - `MessageResponse`
 - `News`
+- `NullEnum`
 - `OTPChallenge`
 - `Order`
 - `OrderDetailed`
@@ -80,6 +84,7 @@ Models use snake_case attributes and provide `to_dict()` / `from_dict()` helpers
 - `PaginatedOrderList`
 - `PaginatedPackageCommissionList`
 - `PaginatedPackageList`
+- `PaginatedProviderDataBalanceList`
 - `PaginatedRegionList`
 - `PaginatedRewardList`
 - `PaginatedUserList`
@@ -95,6 +100,8 @@ Models use snake_case attributes and provide `to_dict()` / `from_dict()` helpers
 - `PricingEnum` — * `fixed` - Fixed * `range` - Range
 - `PricingUnitEnum` — * `data` - Data * `proxy` - Proxy
 - `ProtocolEnum` — * `http` - http * `socks5` - socks5 * `auto` - auto
+- `ProviderBalanceCheckpoint`
+- `ProviderDataBalance`
 - `ProxyGenerationConnectionRequest`
 - `ProxyGenerationSessionRequest`
 - `ProxyGenerationTargetingRequest`
@@ -111,6 +118,7 @@ Models use snake_case attributes and provide `to_dict()` / `from_dict()` helpers
 - `SettingsGateway`
 - `SettingsReferral`
 - `SettingsResponse`
+- `SeverityEnum` — * `warning` - warning * `danger` - danger
 - `SignUpRequest` — Comprehensive user registration with enhanced validation, security measures, and referral/affiliate code handling.
 - `SubtractDataRequest`
 - `TargetingOptions`
@@ -127,6 +135,7 @@ Models use snake_case attributes and provide `to_dict()` / `from_dict()` helpers
 - `TwoFactorSetupResponse`
 - `User` — Customer account with contact details, security settings, package data, referral information, and managed sub-users visible to the caller.
 - `UserCreateRequest` — Fields accepted when a reseller or administrator creates a customer account.
+- `UserCurrency`
 - `UserPasswordResetRequestRequest`
 - `VerifyOTPRequest`
 - `WebhookCreateRequest`