@proxyrequest/sdk 2.0.0 → 2.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +9 -0
- package/README.md +18 -2
- package/dist/index.cjs +41 -16
- package/dist/index.cjs.map +1 -1
- package/dist/index.d.cts +41 -25
- package/dist/index.d.cts.map +1 -1
- package/dist/index.d.ts +41 -25
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js +41 -16
- package/dist/index.js.map +1 -1
- package/dist/{models-CNN_LuGV.d.ts → models-Ci7ojtEW.d.cts} +4 -3
- package/dist/{models-BDeknFzS.d.cts.map → models-Ci7ojtEW.d.cts.map} +1 -1
- package/dist/{models-BDeknFzS.d.cts → models-rpFTQLRE.d.ts} +4 -3
- package/dist/{models-CNN_LuGV.d.ts.map → models-rpFTQLRE.d.ts.map} +1 -1
- package/dist/models.d.cts +2 -2
- package/dist/models.d.ts +2 -2
- package/dist/openapi.d.cts +1 -1
- package/dist/openapi.d.ts +1 -1
- package/dist/{schema-BNl4txEF.d.cts → schema-B2orTIrr.d.cts} +210 -48
- package/dist/schema-B2orTIrr.d.cts.map +1 -0
- package/dist/{schema-BNl4txEF.d.ts → schema-B2orTIrr.d.ts} +210 -48
- package/dist/schema-B2orTIrr.d.ts.map +1 -0
- package/docs/webhooks.md +1 -1
- package/package.json +1 -1
- package/dist/schema-BNl4txEF.d.cts.map +0 -1
- package/dist/schema-BNl4txEF.d.ts.map +0 -1
|
@@ -383,7 +383,7 @@ interface paths {
|
|
|
383
383
|
put?: never;
|
|
384
384
|
/**
|
|
385
385
|
* Create an invoice
|
|
386
|
-
* @description Calculates package pricing and initializes the selected payment provider when required. The status defaults to `pending`. Only superusers may create an already-paid invoice by setting `status` to `paid`; other authenticated users receive a 403 response. For wallet payments, omit `status`: the invoice is created as pending and becomes paid after the balance is debited successfully.
|
|
386
|
+
* @description Calculates package pricing and initializes the selected payment provider when required. The status defaults to `pending`. Only superusers may create an already-paid invoice by setting `status` to `paid`; other authenticated users receive a 403 response. For wallet payments, omit `status`: the invoice is created as pending and becomes paid after the balance is debited successfully. For your own billing system, confirm payment on your backend before sending gateway=manual and status=paid with a superuser credential. Sending user_id also requires is_reseller; omit user_id for a purchase by the caller. Sub-users cannot create invoices themselves. A paid package purchase creates or tops up the recipient's order for that package. Repeated purchases reuse the order. Finite expiring purchases have separate data ledgers; compatible non-expiring purchases and unlimited packages may reuse a ledger. This is different from assigning a child quota with /users/{id}/data/add. An amount-only invoice tops up money, not data. Persist the invoice ID and use Idempotency-Key for retries. Before delivering access, read the paid invoice and the resulting order: fulfillment can be recovered asynchronously. Accounting webhooks do not include invoice.paid.
|
|
387
387
|
*/
|
|
388
388
|
post: operations["invoices_create"];
|
|
389
389
|
delete?: never;
|
|
@@ -745,7 +745,7 @@ interface paths {
|
|
|
745
745
|
};
|
|
746
746
|
/**
|
|
747
747
|
* List active orders
|
|
748
|
-
* @description Returns active package orders owned by the authenticated account.
|
|
748
|
+
* @description Returns active package orders owned by the authenticated account. Superusers can inspect other accounts, including inactive orders; filters never expand a normal caller's ownership scope. Repeated purchases of one package reuse the same user/package order. Read data_remaining and ledgers for usable purchased data, not data minus data_spent. To inspect a managed customer, use /users/{id}/orders.
|
|
749
749
|
*/
|
|
750
750
|
get: operations["orders_list"];
|
|
751
751
|
put?: never;
|
|
@@ -765,14 +765,14 @@ interface paths {
|
|
|
765
765
|
};
|
|
766
766
|
/**
|
|
767
767
|
* Get an order
|
|
768
|
-
* @description Returns one active order with package, usage, expiration, and proxy credential details.
|
|
768
|
+
* @description Returns one active order with package, usage, expiration, and proxy credential details. Virtual child data_remaining is a personal quota, not the parent's shared balance. The order's expires value is not a list of all purchased bucket deadlines; inspect each returned ledger's expires.
|
|
769
769
|
*/
|
|
770
770
|
get: operations["orders_retrieve"];
|
|
771
771
|
put?: never;
|
|
772
772
|
post?: never;
|
|
773
773
|
/**
|
|
774
774
|
* Delete a sub-user order
|
|
775
|
-
* @description Removes an
|
|
775
|
+
* @description Removes an order in the caller's permitted scope. This is destructive, not a payment refund. Deleting a virtual child order does not credit its quota to the shared ledger. Independently purchased sub-user orders have a legacy parent-order data-counter adjustment; do not treat it as a guaranteed restoration of usable ledger balance.
|
|
776
776
|
*/
|
|
777
777
|
delete: operations["orders_destroy"];
|
|
778
778
|
options?: never;
|
|
@@ -1126,8 +1126,8 @@ interface paths {
|
|
|
1126
1126
|
get: operations["users_list"];
|
|
1127
1127
|
put?: never;
|
|
1128
1128
|
/**
|
|
1129
|
-
* Create a
|
|
1130
|
-
* @description Creates a user
|
|
1129
|
+
* Create a customer account
|
|
1130
|
+
* @description Creates a sub-user under the caller by default. A superuser can send is_top_level=true to create an independent customer account. A sub-user cannot create another generation of users. Omit package_id and data to create identity only, then provision the chosen accounting model separately. For shared-pool allocation, supply package_id and positive integer-byte data; the parent must already own a root order for that package. An independent paid purchase is provisioned through invoices, not a shared-pool quota.
|
|
1131
1131
|
*/
|
|
1132
1132
|
post: operations["users_create"];
|
|
1133
1133
|
delete?: never;
|
|
@@ -1175,7 +1175,7 @@ interface paths {
|
|
|
1175
1175
|
put?: never;
|
|
1176
1176
|
/**
|
|
1177
1177
|
* Add data to a sub-user order
|
|
1178
|
-
* @description Adds
|
|
1178
|
+
* @description Adds data integer bytes to a managed sub-user's virtual quota for package_id and returns the updated order. Both fields are required. The caller must own a root order for this package and the target sub-user. Creates the child order if absent; an existing independently purchased order cannot be converted by this operation. The allocation does not reserve or debit the parent's ledger, and may exceed its remaining data. Actual traffic needs both personal quota and a usable parent pool. Use Idempotency-Key to avoid granting the same quota twice.
|
|
1179
1179
|
*/
|
|
1180
1180
|
post: operations["users_data_add_create"];
|
|
1181
1181
|
delete?: never;
|
|
@@ -1184,6 +1184,26 @@ interface paths {
|
|
|
1184
1184
|
patch?: never;
|
|
1185
1185
|
trace?: never;
|
|
1186
1186
|
};
|
|
1187
|
+
"/users/{id}/data/reset": {
|
|
1188
|
+
parameters: {
|
|
1189
|
+
query?: never;
|
|
1190
|
+
header?: never;
|
|
1191
|
+
path?: never;
|
|
1192
|
+
cookie?: never;
|
|
1193
|
+
};
|
|
1194
|
+
get?: never;
|
|
1195
|
+
put?: never;
|
|
1196
|
+
/**
|
|
1197
|
+
* Reset a user's remaining data
|
|
1198
|
+
* @description Atomically resets remaining data to zero for package_id, including zero or negative balances. Supply package_id only; data is not accepted. System administrators may reset any user; other accounts may reset only their direct children. Purchased root orders have their ledger balances cleared; virtual child orders have their quota set to usage without changing the parent's pool. Usage history and invoices are preserved. Unlimited packages are rejected. Use Idempotency-Key for safe retries so a repeated request cannot clear a subsequent top-up.
|
|
1199
|
+
*/
|
|
1200
|
+
post: operations["users_data_reset_create"];
|
|
1201
|
+
delete?: never;
|
|
1202
|
+
options?: never;
|
|
1203
|
+
head?: never;
|
|
1204
|
+
patch?: never;
|
|
1205
|
+
trace?: never;
|
|
1206
|
+
};
|
|
1187
1207
|
"/users/{id}/data/subtract": {
|
|
1188
1208
|
parameters: {
|
|
1189
1209
|
query?: never;
|
|
@@ -1195,7 +1215,7 @@ interface paths {
|
|
|
1195
1215
|
put?: never;
|
|
1196
1216
|
/**
|
|
1197
1217
|
* Subtract data from a sub-user order
|
|
1198
|
-
* @description Subtracts the
|
|
1218
|
+
* @description Subtracts data from the assigned quota of a managed virtual child order in integer bytes for package_id. Both fields are required. This is not a refund or a transfer back into the parent's ledger, and does not erase data_spent. The amount cannot exceed the total assigned data; reducing the quota below usage can stop the child's access. An independently purchased order is not managed through this allocation endpoint. Use Idempotency-Key for safe retries.
|
|
1199
1219
|
*/
|
|
1200
1220
|
post: operations["users_data_subtract_create"];
|
|
1201
1221
|
delete?: never;
|
|
@@ -1213,7 +1233,7 @@ interface paths {
|
|
|
1213
1233
|
};
|
|
1214
1234
|
/**
|
|
1215
1235
|
* List a sub-user's orders
|
|
1216
|
-
* @description Returns
|
|
1236
|
+
* @description Returns the selected user's package orders, including inactive orders. A user may have a purchased root order with its own ledgers or a virtual child order whose quota uses its parent's pool. User ownership and order ownership are different: being a sub-user does not imply shared-pool accounting.
|
|
1217
1237
|
*/
|
|
1218
1238
|
get: operations["users_orders_list"];
|
|
1219
1239
|
put?: never;
|
|
@@ -1235,7 +1255,7 @@ interface paths {
|
|
|
1235
1255
|
put?: never;
|
|
1236
1256
|
/**
|
|
1237
1257
|
* Rotate a sub-user proxy password
|
|
1238
|
-
* @description Rotates the proxy password for the selected user
|
|
1258
|
+
* @description Rotates the proxy password for the selected user's package order. Send package_id to select the affected order.
|
|
1239
1259
|
*/
|
|
1240
1260
|
post: operations["users_password_create"];
|
|
1241
1261
|
delete?: never;
|
|
@@ -1297,8 +1317,12 @@ type webhooks = Record<string, never>;
|
|
|
1297
1317
|
interface components {
|
|
1298
1318
|
schemas: {
|
|
1299
1319
|
AddDataRequest: {
|
|
1320
|
+
/** @description Positive integer bytes to add to the child's assigned quota. Does not reserve parent data; may exceed the parent's remaining pool. */
|
|
1300
1321
|
data: number;
|
|
1301
|
-
/**
|
|
1322
|
+
/**
|
|
1323
|
+
* Format: uuid
|
|
1324
|
+
* @description Package for which the caller owns a root order.
|
|
1325
|
+
*/
|
|
1302
1326
|
package_id: string;
|
|
1303
1327
|
};
|
|
1304
1328
|
Affiliate: {
|
|
@@ -1711,7 +1735,7 @@ interface components {
|
|
|
1711
1735
|
targeting?: components["schemas"]["ProxyGenerationTargetingRequest"];
|
|
1712
1736
|
/**
|
|
1713
1737
|
* Format: uuid
|
|
1714
|
-
* @description ProxyRequest sub-user UUID that will use the generated credentials.
|
|
1738
|
+
* @description ProxyRequest sub-user UUID that will use the generated credentials. Resolve it from your local customer mapping. Must be the caller's own sub-user, even for superusers. Omit to generate for the authenticated account. For an independent top-level customer, authenticate as that customer rather than sending its ID with a global key.
|
|
1715
1739
|
*/
|
|
1716
1740
|
user_id?: string;
|
|
1717
1741
|
};
|
|
@@ -1780,7 +1804,7 @@ interface components {
|
|
|
1780
1804
|
internal_id?: string;
|
|
1781
1805
|
/**
|
|
1782
1806
|
* One-Time Purchase
|
|
1783
|
-
* @description
|
|
1807
|
+
* @description Whether this pricing tier is restricted to a one-time purchase. False does not create a recurring subscription or a renewal schedule.
|
|
1784
1808
|
*/
|
|
1785
1809
|
is_one_time?: boolean;
|
|
1786
1810
|
/**
|
|
@@ -1813,7 +1837,7 @@ interface components {
|
|
|
1813
1837
|
provider_payment_id?: string;
|
|
1814
1838
|
/** @description The number of proxies to assign. */
|
|
1815
1839
|
quantity?: number;
|
|
1816
|
-
/** @description
|
|
1840
|
+
/** @description Payment state. A paid package invoice funds an order; a paid balance invoice credits money. Confirm the resulting order before delivering access, because fulfillment can recover asynchronously. Creating an invoice with status=paid requires a superuser. This read field is not a public status-update or refund endpoint. * `pending` - Pending * `paid` - Paid * `unpaid` - Unpaid * `error` - Error */
|
|
1817
1841
|
status?: components["schemas"]["InvoiceStatusEnum"];
|
|
1818
1842
|
/** @description The type of invoice, indicating the type of proxy service. Options include: RESIDENTIAL: Residential proxies. STATIC: Static proxies. * `static` - Static * `residential` - Residential * `balance` - Balance */
|
|
1819
1843
|
type?: components["schemas"]["InvoiceTypeEnum"];
|
|
@@ -1834,7 +1858,7 @@ interface components {
|
|
|
1834
1858
|
*/
|
|
1835
1859
|
InvoiceCreateRequestGatewayEnum: "crypto" | "credit_card" | "wallet" | "manual" | "stripe" | "coinbase" | "cryptomus" | "coingate" | "whitepay" | "wayforpay" | "usegateway" | "binance" | "anymoney" | "coinpayments" | "checkoutcom" | "nowpayments" | "btcpay" | "braintree" | "monobank" | "liqpay" | "iyzico" | "paytr" | "payu" | "tpay" | "przelewy24" | "gopay" | "comgate" | "monei" | "redsys" | "payplug" | "mollie" | "unzer" | "payone" | "nexi_xpay" | "halyk_epay" | "kaspi_pay" | "vipps_mobilepay" | "paytrail" | (string & {});
|
|
1836
1860
|
InvoiceCreateRequestRequest: {
|
|
1837
|
-
/** @description Account balance amount to purchase, in the smallest currency unit. */
|
|
1861
|
+
/** @description Account balance amount to purchase, in the smallest currency unit. Use for a wallet top-up without package_id, not for buying proxy data. */
|
|
1838
1862
|
amount?: number;
|
|
1839
1863
|
company_name?: string;
|
|
1840
1864
|
company_registration_number?: string;
|
|
@@ -1843,9 +1867,9 @@ interface components {
|
|
|
1843
1867
|
country_code?: string;
|
|
1844
1868
|
coupon_code?: string;
|
|
1845
1869
|
crypto_currency?: string;
|
|
1846
|
-
/** @description Residential proxy data to purchase, in bytes. */
|
|
1870
|
+
/** @description Residential proxy data to purchase, in integer bytes (1 GiB = 1073741824). Required with package_id for a residential purchase. A paid purchase funds the recipient's order; it is not a virtual allocation from a parent pool. */
|
|
1847
1871
|
data?: number;
|
|
1848
|
-
/** @description Optional expiration as a Unix timestamp in seconds. */
|
|
1872
|
+
/** @description Optional future expiration as a Unix timestamp in seconds, not milliseconds. Otherwise a positive package billing cycle determines the purchased data's expiration from the payment date; a zero cycle has no automatic expiration. A later purchase does not extend earlier finite, expiring ledgers. */
|
|
1849
1873
|
expires?: number;
|
|
1850
1874
|
gateway: components["schemas"]["InvoiceCreateRequestGatewayEnum"];
|
|
1851
1875
|
/**
|
|
@@ -1864,7 +1888,7 @@ interface components {
|
|
|
1864
1888
|
status?: components["schemas"]["InvoiceCreateRequestStatusEnum"];
|
|
1865
1889
|
/**
|
|
1866
1890
|
* Format: uuid
|
|
1867
|
-
* @description
|
|
1891
|
+
* @description Account receiving the purchase. Omit for your own account. Sending user_id requires is_reseller; a reseller can target its own sub-user, while a superuser with is_reseller can target another account. Do not send your own ID.
|
|
1868
1892
|
*/
|
|
1869
1893
|
user_id?: string;
|
|
1870
1894
|
};
|
|
@@ -2101,6 +2125,7 @@ interface components {
|
|
|
2101
2125
|
* @description Total data allowance for this order in bytes. 1073741824 = 1 GiB 10737418240 = 10 GiB
|
|
2102
2126
|
*/
|
|
2103
2127
|
data?: number;
|
|
2128
|
+
/** @description Integer bytes. Root order: sum of usable ledger balances, not data minus data_spent. Virtual child order: max(data - data_spent, 0), a personal quota that does not guarantee the parent still has usable data. */
|
|
2104
2129
|
readonly data_remaining: number;
|
|
2105
2130
|
/**
|
|
2106
2131
|
* Data Spent (bytes)
|
|
@@ -2127,6 +2152,7 @@ interface components {
|
|
|
2127
2152
|
* @description Timestamp of the most recent data top-up, set when an invoice is fulfilled.
|
|
2128
2153
|
*/
|
|
2129
2154
|
latest_data_top_up_date?: string | null;
|
|
2155
|
+
/** @description Usable, non-expired ledger balances for a purchased root order; empty for a virtual child order using its parent's pool. Not a complete history. Array position does not identify the active ledger or spending order. */
|
|
2130
2156
|
readonly ledgers: {
|
|
2131
2157
|
[key: string]: unknown;
|
|
2132
2158
|
}[];
|
|
@@ -2163,6 +2189,7 @@ interface components {
|
|
|
2163
2189
|
* @description Total data allowance for this order in bytes. 1073741824 = 1 GiB 10737418240 = 10 GiB
|
|
2164
2190
|
*/
|
|
2165
2191
|
data?: number;
|
|
2192
|
+
/** @description Integer bytes. Root order: sum of usable ledger balances. Virtual child order: max(data - data_spent, 0); access also needs a usable parent pool. */
|
|
2166
2193
|
readonly data_remaining: number;
|
|
2167
2194
|
/**
|
|
2168
2195
|
* Data Spent (bytes)
|
|
@@ -2199,6 +2226,7 @@ interface components {
|
|
|
2199
2226
|
* @description Timestamp of the most recent data top-up, set when an invoice is fulfilled.
|
|
2200
2227
|
*/
|
|
2201
2228
|
latest_data_top_up_date?: string | null;
|
|
2229
|
+
/** @description Usable, non-expired purchased buckets; empty for virtual child orders. Not a complete history, and array position is not spending priority. */
|
|
2202
2230
|
readonly ledgers: {
|
|
2203
2231
|
[key: string]: unknown;
|
|
2204
2232
|
}[];
|
|
@@ -2838,6 +2866,13 @@ interface components {
|
|
|
2838
2866
|
/** @description Native-language name of the region as it appears in the source data. */
|
|
2839
2867
|
original_name?: string;
|
|
2840
2868
|
};
|
|
2869
|
+
ResetDataRequest: {
|
|
2870
|
+
/**
|
|
2871
|
+
* Format: uuid
|
|
2872
|
+
* @description Package whose remaining data is reset to zero.
|
|
2873
|
+
*/
|
|
2874
|
+
package_id: string;
|
|
2875
|
+
};
|
|
2841
2876
|
ResetPasswordRequest: {
|
|
2842
2877
|
/** Format: uuid */
|
|
2843
2878
|
order_id: string;
|
|
@@ -2927,8 +2962,12 @@ interface components {
|
|
|
2927
2962
|
token: string;
|
|
2928
2963
|
};
|
|
2929
2964
|
SubtractDataRequest: {
|
|
2965
|
+
/** @description Positive integer bytes to remove from assigned quota, not from usage. Cannot exceed total assigned data. Does not credit the parent's pool. */
|
|
2930
2966
|
data: number;
|
|
2931
|
-
/**
|
|
2967
|
+
/**
|
|
2968
|
+
* Format: uuid
|
|
2969
|
+
* @description Package of the managed virtual child order.
|
|
2970
|
+
*/
|
|
2932
2971
|
package_id: string;
|
|
2933
2972
|
};
|
|
2934
2973
|
TargetingOptions: {
|
|
@@ -3095,7 +3134,7 @@ interface components {
|
|
|
3095
3134
|
is_superuser?: boolean;
|
|
3096
3135
|
language?: components["schemas"]["LanguageEnum"];
|
|
3097
3136
|
last_name?: string;
|
|
3098
|
-
/** @description
|
|
3137
|
+
/** @description The user's package orders, including inactive orders. Each order contains its own data allowance, usage, ledgers, and proxy credentials. An empty list means the user has no orders. */
|
|
3099
3138
|
readonly orders?: components["schemas"]["Order"][];
|
|
3100
3139
|
/** @description ID of the parent user (for sub-accounts) */
|
|
3101
3140
|
readonly parent_id: string;
|
|
@@ -3135,7 +3174,7 @@ interface components {
|
|
|
3135
3174
|
connection_limit?: number;
|
|
3136
3175
|
/** @description User's country of residence. */
|
|
3137
3176
|
country?: string;
|
|
3138
|
-
/** @description Initial data
|
|
3177
|
+
/** @description Initial integer-byte data amount. With package_id, a normal sub-user receives a virtual quota from the caller's existing root order; is_top_level=true provisions a separate paid purchase. Omit both data and package_id to create identity without package access. */
|
|
3139
3178
|
data?: number;
|
|
3140
3179
|
/**
|
|
3141
3180
|
* Format: email
|
|
@@ -3150,7 +3189,7 @@ interface components {
|
|
|
3150
3189
|
*/
|
|
3151
3190
|
is_reseller: boolean;
|
|
3152
3191
|
/**
|
|
3153
|
-
* @description
|
|
3192
|
+
* @description Superuser only: true creates an independent account with no parent. False (default) creates a sub-user under the caller.
|
|
3154
3193
|
* @default false
|
|
3155
3194
|
*/
|
|
3156
3195
|
is_top_level: boolean;
|
|
@@ -3162,7 +3201,7 @@ interface components {
|
|
|
3162
3201
|
};
|
|
3163
3202
|
/**
|
|
3164
3203
|
* Format: uuid
|
|
3165
|
-
* @description ProxyRequest package UUID to assign to the user
|
|
3204
|
+
* @description ProxyRequest package UUID to assign to the user. Headless integrations resolve it from their local product mapping.
|
|
3166
3205
|
*/
|
|
3167
3206
|
package_id?: string;
|
|
3168
3207
|
/** @description Account password. Must be 8-128 characters long. */
|
|
@@ -3177,7 +3216,7 @@ interface components {
|
|
|
3177
3216
|
UserPasswordResetRequestRequest: {
|
|
3178
3217
|
/**
|
|
3179
3218
|
* Format: uuid
|
|
3180
|
-
* @description Package whose proxy password should be rotated.
|
|
3219
|
+
* @description Package whose order's proxy password should be rotated.
|
|
3181
3220
|
*/
|
|
3182
3221
|
package_id?: string;
|
|
3183
3222
|
};
|
|
@@ -6024,7 +6063,7 @@ interface operations {
|
|
|
6024
6063
|
};
|
|
6025
6064
|
locations_asn_list: {
|
|
6026
6065
|
parameters: {
|
|
6027
|
-
query
|
|
6066
|
+
query: {
|
|
6028
6067
|
code?: string;
|
|
6029
6068
|
country__code?: string;
|
|
6030
6069
|
/** @description Set to true to return only globally targetable ASNs. */
|
|
@@ -6036,8 +6075,8 @@ interface operations {
|
|
|
6036
6075
|
offset?: number;
|
|
6037
6076
|
/** @description Which field to use when ordering the results. */
|
|
6038
6077
|
ordering?: string;
|
|
6039
|
-
/** @description Package whose targeting availability should be returned.
|
|
6040
|
-
package_id
|
|
6078
|
+
/** @description Package whose targeting availability should be returned. */
|
|
6079
|
+
package_id: string;
|
|
6041
6080
|
/** @description Case-insensitive partial search across ASN fields: `code` and `name`. Separate multiple terms with spaces or commas; every term must match at least one listed field. */
|
|
6042
6081
|
search?: string;
|
|
6043
6082
|
};
|
|
@@ -6108,7 +6147,7 @@ interface operations {
|
|
|
6108
6147
|
};
|
|
6109
6148
|
locations_cities_list: {
|
|
6110
6149
|
parameters: {
|
|
6111
|
-
query
|
|
6150
|
+
query: {
|
|
6112
6151
|
code?: string;
|
|
6113
6152
|
country__code?: string;
|
|
6114
6153
|
/** @description Number of results to return per page. */
|
|
@@ -6118,8 +6157,8 @@ interface operations {
|
|
|
6118
6157
|
offset?: number;
|
|
6119
6158
|
/** @description Which field to use when ordering the results. */
|
|
6120
6159
|
ordering?: string;
|
|
6121
|
-
/** @description Package whose targeting availability should be returned.
|
|
6122
|
-
package_id
|
|
6160
|
+
/** @description Package whose targeting availability should be returned. */
|
|
6161
|
+
package_id: string;
|
|
6123
6162
|
region__code?: string;
|
|
6124
6163
|
/** @description Case-insensitive partial search across City fields: `code` and `name`. Separate multiple terms with spaces or commas; every term must match at least one listed field. */
|
|
6125
6164
|
search?: string;
|
|
@@ -6191,7 +6230,10 @@ interface operations {
|
|
|
6191
6230
|
};
|
|
6192
6231
|
locations_cities_retrieve: {
|
|
6193
6232
|
parameters: {
|
|
6194
|
-
query
|
|
6233
|
+
query: {
|
|
6234
|
+
/** @description Package whose targeting availability should be returned. */
|
|
6235
|
+
package_id: string;
|
|
6236
|
+
};
|
|
6195
6237
|
header?: {
|
|
6196
6238
|
/** @description Preferred language for human-readable API errors. Supported languages: en, ru, uk, de, it, fr, es, zh-hans, ja. Regional language tags and quality weights are accepted; unsupported or omitted values use English. */
|
|
6197
6239
|
"Accept-Language"?: string;
|
|
@@ -6276,7 +6318,7 @@ interface operations {
|
|
|
6276
6318
|
};
|
|
6277
6319
|
locations_continents_list: {
|
|
6278
6320
|
parameters: {
|
|
6279
|
-
query
|
|
6321
|
+
query: {
|
|
6280
6322
|
code?: string;
|
|
6281
6323
|
/** @description Number of results to return per page. */
|
|
6282
6324
|
limit?: number;
|
|
@@ -6285,8 +6327,8 @@ interface operations {
|
|
|
6285
6327
|
offset?: number;
|
|
6286
6328
|
/** @description Which field to use when ordering the results. */
|
|
6287
6329
|
ordering?: string;
|
|
6288
|
-
/** @description Package whose targeting availability should be returned.
|
|
6289
|
-
package_id
|
|
6330
|
+
/** @description Package whose targeting availability should be returned. */
|
|
6331
|
+
package_id: string;
|
|
6290
6332
|
/** @description Case-insensitive partial search across Continent fields: `code` and `name`. Separate multiple terms with spaces or commas; every term must match at least one listed field. */
|
|
6291
6333
|
search?: string;
|
|
6292
6334
|
};
|
|
@@ -6357,7 +6399,10 @@ interface operations {
|
|
|
6357
6399
|
};
|
|
6358
6400
|
locations_continents_retrieve: {
|
|
6359
6401
|
parameters: {
|
|
6360
|
-
query
|
|
6402
|
+
query: {
|
|
6403
|
+
/** @description Package whose targeting availability should be returned. */
|
|
6404
|
+
package_id: string;
|
|
6405
|
+
};
|
|
6361
6406
|
header?: {
|
|
6362
6407
|
/** @description Preferred language for human-readable API errors. Supported languages: en, ru, uk, de, it, fr, es, zh-hans, ja. Regional language tags and quality weights are accepted; unsupported or omitted values use English. */
|
|
6363
6408
|
"Accept-Language"?: string;
|
|
@@ -6442,7 +6487,7 @@ interface operations {
|
|
|
6442
6487
|
};
|
|
6443
6488
|
locations_countries_list: {
|
|
6444
6489
|
parameters: {
|
|
6445
|
-
query
|
|
6490
|
+
query: {
|
|
6446
6491
|
code?: string;
|
|
6447
6492
|
/** @description Number of results to return per page. */
|
|
6448
6493
|
limit?: number;
|
|
@@ -6451,8 +6496,8 @@ interface operations {
|
|
|
6451
6496
|
offset?: number;
|
|
6452
6497
|
/** @description Which field to use when ordering the results. */
|
|
6453
6498
|
ordering?: string;
|
|
6454
|
-
/** @description Package whose targeting availability should be returned.
|
|
6455
|
-
package_id
|
|
6499
|
+
/** @description Package whose targeting availability should be returned. */
|
|
6500
|
+
package_id: string;
|
|
6456
6501
|
/** @description Case-insensitive partial search across Country fields: `code` and `name`. Separate multiple terms with spaces or commas; every term must match at least one listed field. */
|
|
6457
6502
|
search?: string;
|
|
6458
6503
|
};
|
|
@@ -6523,7 +6568,10 @@ interface operations {
|
|
|
6523
6568
|
};
|
|
6524
6569
|
locations_countries_retrieve: {
|
|
6525
6570
|
parameters: {
|
|
6526
|
-
query
|
|
6571
|
+
query: {
|
|
6572
|
+
/** @description Package whose targeting availability should be returned. */
|
|
6573
|
+
package_id: string;
|
|
6574
|
+
};
|
|
6527
6575
|
header?: {
|
|
6528
6576
|
/** @description Preferred language for human-readable API errors. Supported languages: en, ru, uk, de, it, fr, es, zh-hans, ja. Regional language tags and quality weights are accepted; unsupported or omitted values use English. */
|
|
6529
6577
|
"Accept-Language"?: string;
|
|
@@ -6608,7 +6656,7 @@ interface operations {
|
|
|
6608
6656
|
};
|
|
6609
6657
|
locations_isps_list: {
|
|
6610
6658
|
parameters: {
|
|
6611
|
-
query
|
|
6659
|
+
query: {
|
|
6612
6660
|
code?: string;
|
|
6613
6661
|
country__code?: string;
|
|
6614
6662
|
/** @description Number of results to return per page. */
|
|
@@ -6618,8 +6666,8 @@ interface operations {
|
|
|
6618
6666
|
offset?: number;
|
|
6619
6667
|
/** @description Which field to use when ordering the results. */
|
|
6620
6668
|
ordering?: string;
|
|
6621
|
-
/** @description Package whose targeting availability should be returned.
|
|
6622
|
-
package_id
|
|
6669
|
+
/** @description Package whose targeting availability should be returned. */
|
|
6670
|
+
package_id: string;
|
|
6623
6671
|
/** @description Case-insensitive partial search across ISP fields: `code` and `name`. Separate multiple terms with spaces or commas; every term must match at least one listed field. */
|
|
6624
6672
|
search?: string;
|
|
6625
6673
|
};
|
|
@@ -6690,7 +6738,7 @@ interface operations {
|
|
|
6690
6738
|
};
|
|
6691
6739
|
locations_regions_list: {
|
|
6692
6740
|
parameters: {
|
|
6693
|
-
query
|
|
6741
|
+
query: {
|
|
6694
6742
|
code?: string;
|
|
6695
6743
|
country__code?: string;
|
|
6696
6744
|
/** @description Number of results to return per page. */
|
|
@@ -6700,8 +6748,8 @@ interface operations {
|
|
|
6700
6748
|
offset?: number;
|
|
6701
6749
|
/** @description Which field to use when ordering the results. */
|
|
6702
6750
|
ordering?: string;
|
|
6703
|
-
/** @description Package whose targeting availability should be returned.
|
|
6704
|
-
package_id
|
|
6751
|
+
/** @description Package whose targeting availability should be returned. */
|
|
6752
|
+
package_id: string;
|
|
6705
6753
|
/** @description Case-insensitive partial search across Region fields: `code` and `name`. Separate multiple terms with spaces or commas; every term must match at least one listed field. */
|
|
6706
6754
|
search?: string;
|
|
6707
6755
|
};
|
|
@@ -6772,7 +6820,10 @@ interface operations {
|
|
|
6772
6820
|
};
|
|
6773
6821
|
locations_regions_retrieve: {
|
|
6774
6822
|
parameters: {
|
|
6775
|
-
query
|
|
6823
|
+
query: {
|
|
6824
|
+
/** @description Package whose targeting availability should be returned. */
|
|
6825
|
+
package_id: string;
|
|
6826
|
+
};
|
|
6776
6827
|
header?: {
|
|
6777
6828
|
/** @description Preferred language for human-readable API errors. Supported languages: en, ru, uk, de, it, fr, es, zh-hans, ja. Regional language tags and quality weights are accepted; unsupported or omitted values use English. */
|
|
6778
6829
|
"Accept-Language"?: string;
|
|
@@ -9434,6 +9485,117 @@ interface operations {
|
|
|
9434
9485
|
};
|
|
9435
9486
|
};
|
|
9436
9487
|
};
|
|
9488
|
+
users_data_reset_create: {
|
|
9489
|
+
parameters: {
|
|
9490
|
+
query?: never;
|
|
9491
|
+
header?: {
|
|
9492
|
+
/** @description Preferred language for human-readable API errors. Supported languages: en, ru, uk, de, it, fr, es, zh-hans, ja. Regional language tags and quality weights are accepted; unsupported or omitted values use English. */
|
|
9493
|
+
"Accept-Language"?: string;
|
|
9494
|
+
/** @description Stable key for one logical mutation. Successful responses are replayable for 24 hours; reusing a key with a different request returns 409. */
|
|
9495
|
+
"Idempotency-Key"?: string;
|
|
9496
|
+
};
|
|
9497
|
+
path: {
|
|
9498
|
+
/** @description A UUID string identifying this user. */
|
|
9499
|
+
id: string;
|
|
9500
|
+
};
|
|
9501
|
+
cookie?: never;
|
|
9502
|
+
};
|
|
9503
|
+
requestBody: {
|
|
9504
|
+
content: {
|
|
9505
|
+
"application/json": components["schemas"]["ResetDataRequest"];
|
|
9506
|
+
"application/x-www-form-urlencoded": components["schemas"]["ResetDataRequest"];
|
|
9507
|
+
"multipart/form-data": components["schemas"]["ResetDataRequest"];
|
|
9508
|
+
};
|
|
9509
|
+
};
|
|
9510
|
+
responses: {
|
|
9511
|
+
/** @description The request was accepted and the updated resource is returned. */
|
|
9512
|
+
202: {
|
|
9513
|
+
headers: {
|
|
9514
|
+
/** @description True when the response was replayed from a prior request. */
|
|
9515
|
+
"Idempotency-Replayed"?: "true";
|
|
9516
|
+
[name: string]: unknown;
|
|
9517
|
+
};
|
|
9518
|
+
content: {
|
|
9519
|
+
"application/json": components["schemas"]["Order"];
|
|
9520
|
+
};
|
|
9521
|
+
};
|
|
9522
|
+
/** @description The request is malformed or violates a business rule. */
|
|
9523
|
+
400: {
|
|
9524
|
+
headers: {
|
|
9525
|
+
"Content-Language": components["headers"]["ContentLanguage"];
|
|
9526
|
+
[name: string]: unknown;
|
|
9527
|
+
};
|
|
9528
|
+
content: {
|
|
9529
|
+
"application/json": {
|
|
9530
|
+
detail?: string;
|
|
9531
|
+
non_field_errors?: string[];
|
|
9532
|
+
} & {
|
|
9533
|
+
[key: string]: string | string[];
|
|
9534
|
+
};
|
|
9535
|
+
};
|
|
9536
|
+
};
|
|
9537
|
+
/** @description Authentication credentials are missing, expired, or invalid. */
|
|
9538
|
+
401: {
|
|
9539
|
+
headers: {
|
|
9540
|
+
"Content-Language": components["headers"]["ContentLanguage"];
|
|
9541
|
+
[name: string]: unknown;
|
|
9542
|
+
};
|
|
9543
|
+
content: {
|
|
9544
|
+
"application/json": {
|
|
9545
|
+
detail?: string;
|
|
9546
|
+
non_field_errors?: string[];
|
|
9547
|
+
} & {
|
|
9548
|
+
[key: string]: string | string[];
|
|
9549
|
+
};
|
|
9550
|
+
};
|
|
9551
|
+
};
|
|
9552
|
+
/** @description The authenticated account cannot perform this operation. */
|
|
9553
|
+
403: {
|
|
9554
|
+
headers: {
|
|
9555
|
+
"Content-Language": components["headers"]["ContentLanguage"];
|
|
9556
|
+
[name: string]: unknown;
|
|
9557
|
+
};
|
|
9558
|
+
content: {
|
|
9559
|
+
"application/json": {
|
|
9560
|
+
detail?: string;
|
|
9561
|
+
non_field_errors?: string[];
|
|
9562
|
+
} & {
|
|
9563
|
+
[key: string]: string | string[];
|
|
9564
|
+
};
|
|
9565
|
+
};
|
|
9566
|
+
};
|
|
9567
|
+
/** @description The requested resource does not exist in the current account scope. */
|
|
9568
|
+
404: {
|
|
9569
|
+
headers: {
|
|
9570
|
+
"Content-Language": components["headers"]["ContentLanguage"];
|
|
9571
|
+
[name: string]: unknown;
|
|
9572
|
+
};
|
|
9573
|
+
content: {
|
|
9574
|
+
"application/json": {
|
|
9575
|
+
detail?: string;
|
|
9576
|
+
non_field_errors?: string[];
|
|
9577
|
+
} & {
|
|
9578
|
+
[key: string]: string | string[];
|
|
9579
|
+
};
|
|
9580
|
+
};
|
|
9581
|
+
};
|
|
9582
|
+
/** @description The idempotency key is in progress or was reused for a different request. */
|
|
9583
|
+
409: {
|
|
9584
|
+
headers: {
|
|
9585
|
+
"Content-Language": components["headers"]["ContentLanguage"];
|
|
9586
|
+
[name: string]: unknown;
|
|
9587
|
+
};
|
|
9588
|
+
content: {
|
|
9589
|
+
"application/json": {
|
|
9590
|
+
detail?: string;
|
|
9591
|
+
non_field_errors?: string[];
|
|
9592
|
+
} & {
|
|
9593
|
+
[key: string]: string | string[];
|
|
9594
|
+
};
|
|
9595
|
+
};
|
|
9596
|
+
};
|
|
9597
|
+
};
|
|
9598
|
+
};
|
|
9437
9599
|
users_data_subtract_create: {
|
|
9438
9600
|
parameters: {
|
|
9439
9601
|
query?: never;
|
|
@@ -9654,7 +9816,7 @@ interface operations {
|
|
|
9654
9816
|
};
|
|
9655
9817
|
cookie?: never;
|
|
9656
9818
|
};
|
|
9657
|
-
requestBody
|
|
9819
|
+
requestBody: {
|
|
9658
9820
|
content: {
|
|
9659
9821
|
"application/json": components["schemas"]["UserPasswordResetRequestRequest"];
|
|
9660
9822
|
"application/x-www-form-urlencoded": components["schemas"]["UserPasswordResetRequestRequest"];
|
|
@@ -10114,4 +10276,4 @@ interface operations {
|
|
|
10114
10276
|
}
|
|
10115
10277
|
//#endregion
|
|
10116
10278
|
export { webhooks as i, operations as n, paths as r, components as t };
|
|
10117
|
-
//# sourceMappingURL=schema-
|
|
10279
|
+
//# sourceMappingURL=schema-B2orTIrr.d.ts.map
|