@proxyrequest/sdk 2.0.0 → 3.0.1
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 +21 -0
- package/README.md +21 -2
- package/dist/index.cjs +916 -41
- package/dist/index.cjs.map +1 -1
- package/dist/index.d.cts +42 -26
- package/dist/index.d.cts.map +1 -1
- package/dist/index.d.ts +42 -26
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js +922 -19
- package/dist/index.js.map +1 -1
- package/dist/{models-CNN_LuGV.d.ts → models-2V3Llpqk.d.cts} +4 -3
- package/dist/{models-BDeknFzS.d.cts.map → models-2V3Llpqk.d.cts.map} +1 -1
- package/dist/{models-BDeknFzS.d.cts → models-Bemi0dKg.d.ts} +4 -3
- package/dist/{models-CNN_LuGV.d.ts.map → models-Bemi0dKg.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-BZvnw81E.d.cts} +249 -81
- package/dist/schema-BZvnw81E.d.cts.map +1 -0
- package/dist/{schema-BNl4txEF.d.ts → schema-BZvnw81E.d.ts} +249 -81
- package/dist/schema-BZvnw81E.d.ts.map +1 -0
- package/docs/analytics.md +47 -0
- package/docs/third-party-notices.md +38 -0
- package/docs/webhooks.md +1 -1
- package/package.json +2 -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;
|
|
@@ -963,7 +963,7 @@ interface paths {
|
|
|
963
963
|
put?: never;
|
|
964
964
|
/**
|
|
965
965
|
* Generate proxy credentials
|
|
966
|
-
* @description Creates ready-to-use proxy credentials for a purchased package. Use targeting to choose a location or provider scope, connection to choose protocol and output format, and session to control sticky session lifetime.
|
|
966
|
+
* @description Creates ready-to-use proxy credentials for a purchased package. Use targeting to choose a location or provider scope, connection to choose protocol and output format, and session to control sticky session lifetime. Omit connection.host to choose one random eligible gateway for the entire request. The default port comes from that gateway's cluster. Targeting location does not select the entry gateway's region. Explicit host and port remain supported for custom endpoints.
|
|
967
967
|
*/
|
|
968
968
|
post: operations["proxies_generate_create"];
|
|
969
969
|
delete?: 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: {
|
|
@@ -1660,7 +1684,8 @@ interface components {
|
|
|
1660
1684
|
data: number;
|
|
1661
1685
|
established_connections: number;
|
|
1662
1686
|
hostname: string;
|
|
1663
|
-
|
|
1687
|
+
/** @description Exact decimal UInt64 identifier, normalized from the API's JSON number. */
|
|
1688
|
+
id: string;
|
|
1664
1689
|
is_session: boolean;
|
|
1665
1690
|
ledger_id: string;
|
|
1666
1691
|
method: string;
|
|
@@ -1711,7 +1736,7 @@ interface components {
|
|
|
1711
1736
|
targeting?: components["schemas"]["ProxyGenerationTargetingRequest"];
|
|
1712
1737
|
/**
|
|
1713
1738
|
* Format: uuid
|
|
1714
|
-
* @description ProxyRequest sub-user UUID that will use the generated credentials.
|
|
1739
|
+
* @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
1740
|
*/
|
|
1716
1741
|
user_id?: string;
|
|
1717
1742
|
};
|
|
@@ -1780,7 +1805,7 @@ interface components {
|
|
|
1780
1805
|
internal_id?: string;
|
|
1781
1806
|
/**
|
|
1782
1807
|
* One-Time Purchase
|
|
1783
|
-
* @description
|
|
1808
|
+
* @description Whether this pricing tier is restricted to a one-time purchase. False does not create a recurring subscription or a renewal schedule.
|
|
1784
1809
|
*/
|
|
1785
1810
|
is_one_time?: boolean;
|
|
1786
1811
|
/**
|
|
@@ -1813,7 +1838,7 @@ interface components {
|
|
|
1813
1838
|
provider_payment_id?: string;
|
|
1814
1839
|
/** @description The number of proxies to assign. */
|
|
1815
1840
|
quantity?: number;
|
|
1816
|
-
/** @description
|
|
1841
|
+
/** @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
1842
|
status?: components["schemas"]["InvoiceStatusEnum"];
|
|
1818
1843
|
/** @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
1844
|
type?: components["schemas"]["InvoiceTypeEnum"];
|
|
@@ -1834,7 +1859,7 @@ interface components {
|
|
|
1834
1859
|
*/
|
|
1835
1860
|
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
1861
|
InvoiceCreateRequestRequest: {
|
|
1837
|
-
/** @description Account balance amount to purchase, in the smallest currency unit. */
|
|
1862
|
+
/** @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
1863
|
amount?: number;
|
|
1839
1864
|
company_name?: string;
|
|
1840
1865
|
company_registration_number?: string;
|
|
@@ -1843,9 +1868,9 @@ interface components {
|
|
|
1843
1868
|
country_code?: string;
|
|
1844
1869
|
coupon_code?: string;
|
|
1845
1870
|
crypto_currency?: string;
|
|
1846
|
-
/** @description Residential proxy data to purchase, in bytes. */
|
|
1871
|
+
/** @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
1872
|
data?: number;
|
|
1848
|
-
/** @description Optional expiration as a Unix timestamp in seconds. */
|
|
1873
|
+
/** @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
1874
|
expires?: number;
|
|
1850
1875
|
gateway: components["schemas"]["InvoiceCreateRequestGatewayEnum"];
|
|
1851
1876
|
/**
|
|
@@ -1864,7 +1889,7 @@ interface components {
|
|
|
1864
1889
|
status?: components["schemas"]["InvoiceCreateRequestStatusEnum"];
|
|
1865
1890
|
/**
|
|
1866
1891
|
* Format: uuid
|
|
1867
|
-
* @description
|
|
1892
|
+
* @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
1893
|
*/
|
|
1869
1894
|
user_id?: string;
|
|
1870
1895
|
};
|
|
@@ -2101,6 +2126,7 @@ interface components {
|
|
|
2101
2126
|
* @description Total data allowance for this order in bytes. 1073741824 = 1 GiB 10737418240 = 10 GiB
|
|
2102
2127
|
*/
|
|
2103
2128
|
data?: number;
|
|
2129
|
+
/** @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
2130
|
readonly data_remaining: number;
|
|
2105
2131
|
/**
|
|
2106
2132
|
* Data Spent (bytes)
|
|
@@ -2127,6 +2153,7 @@ interface components {
|
|
|
2127
2153
|
* @description Timestamp of the most recent data top-up, set when an invoice is fulfilled.
|
|
2128
2154
|
*/
|
|
2129
2155
|
latest_data_top_up_date?: string | null;
|
|
2156
|
+
/** @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
2157
|
readonly ledgers: {
|
|
2131
2158
|
[key: string]: unknown;
|
|
2132
2159
|
}[];
|
|
@@ -2163,6 +2190,7 @@ interface components {
|
|
|
2163
2190
|
* @description Total data allowance for this order in bytes. 1073741824 = 1 GiB 10737418240 = 10 GiB
|
|
2164
2191
|
*/
|
|
2165
2192
|
data?: number;
|
|
2193
|
+
/** @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
2194
|
readonly data_remaining: number;
|
|
2167
2195
|
/**
|
|
2168
2196
|
* Data Spent (bytes)
|
|
@@ -2199,6 +2227,7 @@ interface components {
|
|
|
2199
2227
|
* @description Timestamp of the most recent data top-up, set when an invoice is fulfilled.
|
|
2200
2228
|
*/
|
|
2201
2229
|
latest_data_top_up_date?: string | null;
|
|
2230
|
+
/** @description Usable, non-expired purchased buckets; empty for virtual child orders. Not a complete history, and array position is not spending priority. */
|
|
2202
2231
|
readonly ledgers: {
|
|
2203
2232
|
[key: string]: unknown;
|
|
2204
2233
|
}[];
|
|
@@ -2767,7 +2796,7 @@ interface components {
|
|
|
2767
2796
|
* @default {protocol}://{username}:{password}@{host}:{port}
|
|
2768
2797
|
*/
|
|
2769
2798
|
format: string;
|
|
2770
|
-
/** @description Gateway host. Leave empty to
|
|
2799
|
+
/** @description Gateway host. Leave empty to choose one available gateway for the entire request. */
|
|
2771
2800
|
host?: string;
|
|
2772
2801
|
/** @description Gateway port. Leave empty to use the port for the selected protocol. */
|
|
2773
2802
|
port?: number;
|
|
@@ -2838,6 +2867,13 @@ interface components {
|
|
|
2838
2867
|
/** @description Native-language name of the region as it appears in the source data. */
|
|
2839
2868
|
original_name?: string;
|
|
2840
2869
|
};
|
|
2870
|
+
ResetDataRequest: {
|
|
2871
|
+
/**
|
|
2872
|
+
* Format: uuid
|
|
2873
|
+
* @description Package whose remaining data is reset to zero.
|
|
2874
|
+
*/
|
|
2875
|
+
package_id: string;
|
|
2876
|
+
};
|
|
2841
2877
|
ResetPasswordRequest: {
|
|
2842
2878
|
/** Format: uuid */
|
|
2843
2879
|
order_id: string;
|
|
@@ -2876,7 +2912,9 @@ interface components {
|
|
|
2876
2912
|
currencies: string[];
|
|
2877
2913
|
};
|
|
2878
2914
|
SettingsGateway: {
|
|
2915
|
+
/** @description Cluster gateway domain, or a server IP when no domain is configured. */
|
|
2879
2916
|
hostname: string;
|
|
2917
|
+
/** @description The cluster domain, or unique server IPs when no domain is configured. */
|
|
2880
2918
|
hostnames: string[];
|
|
2881
2919
|
/** Format: uuid */
|
|
2882
2920
|
id: string;
|
|
@@ -2927,8 +2965,12 @@ interface components {
|
|
|
2927
2965
|
token: string;
|
|
2928
2966
|
};
|
|
2929
2967
|
SubtractDataRequest: {
|
|
2968
|
+
/** @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
2969
|
data: number;
|
|
2931
|
-
/**
|
|
2970
|
+
/**
|
|
2971
|
+
* Format: uuid
|
|
2972
|
+
* @description Package of the managed virtual child order.
|
|
2973
|
+
*/
|
|
2932
2974
|
package_id: string;
|
|
2933
2975
|
};
|
|
2934
2976
|
TargetingOptions: {
|
|
@@ -3095,7 +3137,7 @@ interface components {
|
|
|
3095
3137
|
is_superuser?: boolean;
|
|
3096
3138
|
language?: components["schemas"]["LanguageEnum"];
|
|
3097
3139
|
last_name?: string;
|
|
3098
|
-
/** @description
|
|
3140
|
+
/** @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
3141
|
readonly orders?: components["schemas"]["Order"][];
|
|
3100
3142
|
/** @description ID of the parent user (for sub-accounts) */
|
|
3101
3143
|
readonly parent_id: string;
|
|
@@ -3135,7 +3177,7 @@ interface components {
|
|
|
3135
3177
|
connection_limit?: number;
|
|
3136
3178
|
/** @description User's country of residence. */
|
|
3137
3179
|
country?: string;
|
|
3138
|
-
/** @description Initial data
|
|
3180
|
+
/** @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
3181
|
data?: number;
|
|
3140
3182
|
/**
|
|
3141
3183
|
* Format: email
|
|
@@ -3150,7 +3192,7 @@ interface components {
|
|
|
3150
3192
|
*/
|
|
3151
3193
|
is_reseller: boolean;
|
|
3152
3194
|
/**
|
|
3153
|
-
* @description
|
|
3195
|
+
* @description Superuser only: true creates an independent account with no parent. False (default) creates a sub-user under the caller.
|
|
3154
3196
|
* @default false
|
|
3155
3197
|
*/
|
|
3156
3198
|
is_top_level: boolean;
|
|
@@ -3162,7 +3204,7 @@ interface components {
|
|
|
3162
3204
|
};
|
|
3163
3205
|
/**
|
|
3164
3206
|
* Format: uuid
|
|
3165
|
-
* @description ProxyRequest package UUID to assign to the user
|
|
3207
|
+
* @description ProxyRequest package UUID to assign to the user. Headless integrations resolve it from their local product mapping.
|
|
3166
3208
|
*/
|
|
3167
3209
|
package_id?: string;
|
|
3168
3210
|
/** @description Account password. Must be 8-128 characters long. */
|
|
@@ -3177,7 +3219,7 @@ interface components {
|
|
|
3177
3219
|
UserPasswordResetRequestRequest: {
|
|
3178
3220
|
/**
|
|
3179
3221
|
* Format: uuid
|
|
3180
|
-
* @description Package whose proxy password should be rotated.
|
|
3222
|
+
* @description Package whose order's proxy password should be rotated.
|
|
3181
3223
|
*/
|
|
3182
3224
|
package_id?: string;
|
|
3183
3225
|
};
|
|
@@ -3496,8 +3538,8 @@ interface operations {
|
|
|
3496
3538
|
analytics_transactions_retrieve: {
|
|
3497
3539
|
parameters: {
|
|
3498
3540
|
query?: {
|
|
3499
|
-
/** @description Exclusive end of the reporting window. */
|
|
3500
|
-
end?: string;
|
|
3541
|
+
/** @description Exclusive end of the reporting window. Defaults to the current time. Accepts ISO 8601 datetime strings with or without a timezone offset (including Z and fractional seconds), YYYY-MM-DD HH:MM:SS, DD-MM-YYYY HH:MM:SS, YYYY-MM-DD, DD-MM-YYYY, or a Unix timestamp in seconds (including fractional seconds, not milliseconds). Datetime strings without an offset and date-only strings use the requested timezone; explicit offsets are converted to that timezone. Date-only values start at midnight. Seconds and fractional seconds are discarded, rounding the reporting boundary down to the minute. Prefer ISO 8601 with an explicit offset for unambiguous timezone handling. */
|
|
3542
|
+
end?: string | number;
|
|
3501
3543
|
/** @description Maximum records returned on this page. */
|
|
3502
3544
|
limit?: number;
|
|
3503
3545
|
/** @description Zero-based number of matching records to skip. */
|
|
@@ -3506,9 +3548,9 @@ interface operations {
|
|
|
3506
3548
|
recipient_id?: string;
|
|
3507
3549
|
/** @description Restrict transactions to this sender account. */
|
|
3508
3550
|
sender_id?: string;
|
|
3509
|
-
/** @description Inclusive start of the reporting window. Defaults to a recent window. */
|
|
3510
|
-
start?: string;
|
|
3511
|
-
/** @description IANA timezone used for bucket boundaries.
|
|
3551
|
+
/** @description Inclusive start of the reporting window. Defaults to a recent window. Accepts ISO 8601 datetime strings with or without a timezone offset (including Z and fractional seconds), YYYY-MM-DD HH:MM:SS, DD-MM-YYYY HH:MM:SS, YYYY-MM-DD, DD-MM-YYYY, or a Unix timestamp in seconds (including fractional seconds, not milliseconds). Datetime strings without an offset and date-only strings use the requested timezone; explicit offsets are converted to that timezone. Date-only values start at midnight. Seconds and fractional seconds are discarded, rounding the reporting boundary down to the minute. Prefer ISO 8601 with an explicit offset for unambiguous timezone handling. */
|
|
3552
|
+
start?: string | number;
|
|
3553
|
+
/** @description IANA timezone used for bucket boundaries and datetime strings without an offset. Missing, empty or unknown names use the deployment timezone (UTC by default). */
|
|
3512
3554
|
timezone?: string;
|
|
3513
3555
|
/** @description Transaction type identifier. Defaults to data transactions. */
|
|
3514
3556
|
type?: number;
|
|
@@ -3706,11 +3748,11 @@ interface operations {
|
|
|
3706
3748
|
analytics_domains_retrieve: {
|
|
3707
3749
|
parameters: {
|
|
3708
3750
|
query?: {
|
|
3709
|
-
/** @description Exclusive end of the reporting window. */
|
|
3710
|
-
end?: string;
|
|
3711
|
-
/** @description Comma-separated
|
|
3751
|
+
/** @description Exclusive end of the reporting window. Defaults to the current time. Accepts ISO 8601 datetime strings with or without a timezone offset (including Z and fractional seconds), YYYY-MM-DD HH:MM:SS, DD-MM-YYYY HH:MM:SS, YYYY-MM-DD, DD-MM-YYYY, or a Unix timestamp in seconds (including fractional seconds, not milliseconds). Datetime strings without an offset and date-only strings use the requested timezone; explicit offsets are converted to that timezone. Date-only values start at midnight. Seconds and fractional seconds are discarded, rounding the reporting boundary down to the minute. Prefer ISO 8601 with an explicit offset for unambiguous timezone handling. */
|
|
3752
|
+
end?: string | number;
|
|
3753
|
+
/** @description Comma-separated domains, IPv4/IPv6 addresses or HTTP(S) URLs to include. Surrounding whitespace is ignored. URLs and host:port values are normalized to their hostname; schemes, ports, paths and IPv6 brackets are removed. Use brackets around IPv6 addresses when specifying a port. */
|
|
3712
3754
|
hostname?: string;
|
|
3713
|
-
/** @description Aggregate the selected user's data with all of their sub-users. Superusers can apply this to any selected user; resellers can apply it to their own account. Ignored for regular users. Defaults to false. */
|
|
3755
|
+
/** @description Aggregate the selected user's data with all of their sub-users. Superusers can apply this to any selected user; resellers can apply it to their own account. Ignored for regular users. Use true or false. Defaults to false. */
|
|
3714
3756
|
include_sub_users?: boolean;
|
|
3715
3757
|
/** @description Restrict results to one data ledger when supported. */
|
|
3716
3758
|
ledger_id?: string;
|
|
@@ -3724,9 +3766,9 @@ interface operations {
|
|
|
3724
3766
|
package_id?: string;
|
|
3725
3767
|
/** @description Case-insensitive partial match against the listed field: `hostname`. */
|
|
3726
3768
|
search?: string;
|
|
3727
|
-
/** @description Inclusive start of the reporting window. Defaults to a recent window. */
|
|
3728
|
-
start?: string;
|
|
3729
|
-
/** @description IANA timezone used for bucket boundaries.
|
|
3769
|
+
/** @description Inclusive start of the reporting window. Defaults to a recent window. Accepts ISO 8601 datetime strings with or without a timezone offset (including Z and fractional seconds), YYYY-MM-DD HH:MM:SS, DD-MM-YYYY HH:MM:SS, YYYY-MM-DD, DD-MM-YYYY, or a Unix timestamp in seconds (including fractional seconds, not milliseconds). Datetime strings without an offset and date-only strings use the requested timezone; explicit offsets are converted to that timezone. Date-only values start at midnight. Seconds and fractional seconds are discarded, rounding the reporting boundary down to the minute. Prefer ISO 8601 with an explicit offset for unambiguous timezone handling. */
|
|
3770
|
+
start?: string | number;
|
|
3771
|
+
/** @description IANA timezone used for bucket boundaries and datetime strings without an offset. Missing, empty or unknown names use the deployment timezone (UTC by default). */
|
|
3730
3772
|
timezone?: string;
|
|
3731
3773
|
/** @description Restrict results to the current account or an accessible sub-user. */
|
|
3732
3774
|
user_id?: string;
|
|
@@ -3818,9 +3860,9 @@ interface operations {
|
|
|
3818
3860
|
city?: string;
|
|
3819
3861
|
/** @description Lowercase ISO 3166-1 alpha-2 country code. */
|
|
3820
3862
|
country?: string;
|
|
3821
|
-
/** @description Exclusive end of the reporting window. */
|
|
3822
|
-
end?: string;
|
|
3823
|
-
/** @description Comma-separated
|
|
3863
|
+
/** @description Exclusive end of the reporting window. Defaults to the current time. Accepts ISO 8601 datetime strings with or without a timezone offset (including Z and fractional seconds), YYYY-MM-DD HH:MM:SS, DD-MM-YYYY HH:MM:SS, YYYY-MM-DD, DD-MM-YYYY, or a Unix timestamp in seconds (including fractional seconds, not milliseconds). Datetime strings without an offset and date-only strings use the requested timezone; explicit offsets are converted to that timezone. Date-only values start at midnight. Seconds and fractional seconds are discarded, rounding the reporting boundary down to the minute. Prefer ISO 8601 with an explicit offset for unambiguous timezone handling. */
|
|
3864
|
+
end?: string | number;
|
|
3865
|
+
/** @description Comma-separated domains, IPv4/IPv6 addresses or HTTP(S) URLs to include. Surrounding whitespace is ignored. URLs and host:port values are normalized to their hostname; schemes, ports, paths and IPv6 brackets are removed. Use brackets around IPv6 addresses when specifying a port. */
|
|
3824
3866
|
hostname?: string;
|
|
3825
3867
|
/** @description Restrict results to one data ledger when supported. */
|
|
3826
3868
|
ledger_id?: string;
|
|
@@ -3836,9 +3878,9 @@ interface operations {
|
|
|
3836
3878
|
region?: string;
|
|
3837
3879
|
/** @description Case-insensitive partial match against the listed field: `hostname`. */
|
|
3838
3880
|
search?: string;
|
|
3839
|
-
/** @description Inclusive start of the reporting window. Defaults to a recent window. */
|
|
3840
|
-
start?: string;
|
|
3841
|
-
/** @description IANA timezone used for bucket boundaries.
|
|
3881
|
+
/** @description Inclusive start of the reporting window. Defaults to a recent window. Accepts ISO 8601 datetime strings with or without a timezone offset (including Z and fractional seconds), YYYY-MM-DD HH:MM:SS, DD-MM-YYYY HH:MM:SS, YYYY-MM-DD, DD-MM-YYYY, or a Unix timestamp in seconds (including fractional seconds, not milliseconds). Datetime strings without an offset and date-only strings use the requested timezone; explicit offsets are converted to that timezone. Date-only values start at midnight. Seconds and fractional seconds are discarded, rounding the reporting boundary down to the minute. Prefer ISO 8601 with an explicit offset for unambiguous timezone handling. */
|
|
3882
|
+
start?: string | number;
|
|
3883
|
+
/** @description IANA timezone used for bucket boundaries and datetime strings without an offset. Missing, empty or unknown names use the deployment timezone (UTC by default). */
|
|
3842
3884
|
timezone?: string;
|
|
3843
3885
|
/** @description Restrict results to the current account or an accessible sub-user. */
|
|
3844
3886
|
user_id?: string;
|
|
@@ -3930,11 +3972,14 @@ interface operations {
|
|
|
3930
3972
|
city?: string;
|
|
3931
3973
|
/** @description Lowercase ISO 3166-1 alpha-2 country code. */
|
|
3932
3974
|
country?: string;
|
|
3933
|
-
/** @description Exclusive end of the reporting window. */
|
|
3934
|
-
end?: string;
|
|
3975
|
+
/** @description Exclusive end of the reporting window. Defaults to the current time. Accepts ISO 8601 datetime strings with or without a timezone offset (including Z and fractional seconds), YYYY-MM-DD HH:MM:SS, DD-MM-YYYY HH:MM:SS, YYYY-MM-DD, DD-MM-YYYY, or a Unix timestamp in seconds (including fractional seconds, not milliseconds). Datetime strings without an offset and date-only strings use the requested timezone; explicit offsets are converted to that timezone. Date-only values start at midnight. Seconds and fractional seconds are discarded, rounding the reporting boundary down to the minute. Prefer ISO 8601 with an explicit offset for unambiguous timezone handling. */
|
|
3976
|
+
end?: string | number;
|
|
3935
3977
|
/** @description Restrict results to one non-negative proxy error code. */
|
|
3936
3978
|
error_code?: number;
|
|
3937
|
-
/**
|
|
3979
|
+
/**
|
|
3980
|
+
* @deprecated
|
|
3981
|
+
* @description Compatibility parameter; ignored by the server.
|
|
3982
|
+
*/
|
|
3938
3983
|
hostname?: string;
|
|
3939
3984
|
/** @description Restrict results to one data ledger when supported. */
|
|
3940
3985
|
ledger_id?: string;
|
|
@@ -3948,9 +3993,9 @@ interface operations {
|
|
|
3948
3993
|
protocol?: "http" | "socks5";
|
|
3949
3994
|
/** @description Normalized region targeting code. country is required. */
|
|
3950
3995
|
region?: string;
|
|
3951
|
-
/** @description Inclusive start of the reporting window. Defaults to a recent window. */
|
|
3952
|
-
start?: string;
|
|
3953
|
-
/** @description IANA timezone used for bucket boundaries.
|
|
3996
|
+
/** @description Inclusive start of the reporting window. Defaults to a recent window. Accepts ISO 8601 datetime strings with or without a timezone offset (including Z and fractional seconds), YYYY-MM-DD HH:MM:SS, DD-MM-YYYY HH:MM:SS, YYYY-MM-DD, DD-MM-YYYY, or a Unix timestamp in seconds (including fractional seconds, not milliseconds). Datetime strings without an offset and date-only strings use the requested timezone; explicit offsets are converted to that timezone. Date-only values start at midnight. Seconds and fractional seconds are discarded, rounding the reporting boundary down to the minute. Prefer ISO 8601 with an explicit offset for unambiguous timezone handling. */
|
|
3997
|
+
start?: string | number;
|
|
3998
|
+
/** @description IANA timezone used for bucket boundaries and datetime strings without an offset. Missing, empty or unknown names use the deployment timezone (UTC by default). */
|
|
3954
3999
|
timezone?: string;
|
|
3955
4000
|
/** @description Restrict results to the current account or an accessible sub-user. */
|
|
3956
4001
|
user_id?: string;
|
|
@@ -4038,9 +4083,9 @@ interface operations {
|
|
|
4038
4083
|
analytics_overall_retrieve: {
|
|
4039
4084
|
parameters: {
|
|
4040
4085
|
query?: {
|
|
4041
|
-
/** @description Exclusive end of the reporting window. */
|
|
4042
|
-
end?: string;
|
|
4043
|
-
/** @description Aggregate the selected user's data with all of their sub-users. Superusers can apply this to any selected user; resellers can apply it to their own account. Ignored for regular users. Defaults to false. */
|
|
4086
|
+
/** @description Exclusive end of the reporting window. Defaults to the current time. Accepts ISO 8601 datetime strings with or without a timezone offset (including Z and fractional seconds), YYYY-MM-DD HH:MM:SS, DD-MM-YYYY HH:MM:SS, YYYY-MM-DD, DD-MM-YYYY, or a Unix timestamp in seconds (including fractional seconds, not milliseconds). Datetime strings without an offset and date-only strings use the requested timezone; explicit offsets are converted to that timezone. Date-only values start at midnight. Seconds and fractional seconds are discarded, rounding the reporting boundary down to the minute. Prefer ISO 8601 with an explicit offset for unambiguous timezone handling. */
|
|
4087
|
+
end?: string | number;
|
|
4088
|
+
/** @description Aggregate the selected user's data with all of their sub-users. Superusers can apply this to any selected user; resellers can apply it to their own account. Ignored for regular users. Use true or false. Defaults to false. */
|
|
4044
4089
|
include_sub_users?: boolean;
|
|
4045
4090
|
/** @description Maximum records returned on this page. */
|
|
4046
4091
|
limit?: number;
|
|
@@ -4048,9 +4093,9 @@ interface operations {
|
|
|
4048
4093
|
offset?: number;
|
|
4049
4094
|
/** @description Restrict results to one purchased package. */
|
|
4050
4095
|
package_id?: string;
|
|
4051
|
-
/** @description Inclusive start of the reporting window. Defaults to a recent window. */
|
|
4052
|
-
start?: string;
|
|
4053
|
-
/** @description IANA timezone used for bucket boundaries.
|
|
4096
|
+
/** @description Inclusive start of the reporting window. Defaults to a recent window. Accepts ISO 8601 datetime strings with or without a timezone offset (including Z and fractional seconds), YYYY-MM-DD HH:MM:SS, DD-MM-YYYY HH:MM:SS, YYYY-MM-DD, DD-MM-YYYY, or a Unix timestamp in seconds (including fractional seconds, not milliseconds). Datetime strings without an offset and date-only strings use the requested timezone; explicit offsets are converted to that timezone. Date-only values start at midnight. Seconds and fractional seconds are discarded, rounding the reporting boundary down to the minute. Prefer ISO 8601 with an explicit offset for unambiguous timezone handling. */
|
|
4097
|
+
start?: string | number;
|
|
4098
|
+
/** @description IANA timezone used for bucket boundaries and datetime strings without an offset. Missing, empty or unknown names use the deployment timezone (UTC by default). */
|
|
4054
4099
|
timezone?: string;
|
|
4055
4100
|
/** @description Restrict results to the current account or an accessible sub-user. */
|
|
4056
4101
|
user_id?: string;
|
|
@@ -6024,7 +6069,7 @@ interface operations {
|
|
|
6024
6069
|
};
|
|
6025
6070
|
locations_asn_list: {
|
|
6026
6071
|
parameters: {
|
|
6027
|
-
query
|
|
6072
|
+
query: {
|
|
6028
6073
|
code?: string;
|
|
6029
6074
|
country__code?: string;
|
|
6030
6075
|
/** @description Set to true to return only globally targetable ASNs. */
|
|
@@ -6036,8 +6081,8 @@ interface operations {
|
|
|
6036
6081
|
offset?: number;
|
|
6037
6082
|
/** @description Which field to use when ordering the results. */
|
|
6038
6083
|
ordering?: string;
|
|
6039
|
-
/** @description Package whose targeting availability should be returned.
|
|
6040
|
-
package_id
|
|
6084
|
+
/** @description Package whose targeting availability should be returned. */
|
|
6085
|
+
package_id: string;
|
|
6041
6086
|
/** @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
6087
|
search?: string;
|
|
6043
6088
|
};
|
|
@@ -6108,7 +6153,7 @@ interface operations {
|
|
|
6108
6153
|
};
|
|
6109
6154
|
locations_cities_list: {
|
|
6110
6155
|
parameters: {
|
|
6111
|
-
query
|
|
6156
|
+
query: {
|
|
6112
6157
|
code?: string;
|
|
6113
6158
|
country__code?: string;
|
|
6114
6159
|
/** @description Number of results to return per page. */
|
|
@@ -6118,8 +6163,8 @@ interface operations {
|
|
|
6118
6163
|
offset?: number;
|
|
6119
6164
|
/** @description Which field to use when ordering the results. */
|
|
6120
6165
|
ordering?: string;
|
|
6121
|
-
/** @description Package whose targeting availability should be returned.
|
|
6122
|
-
package_id
|
|
6166
|
+
/** @description Package whose targeting availability should be returned. */
|
|
6167
|
+
package_id: string;
|
|
6123
6168
|
region__code?: string;
|
|
6124
6169
|
/** @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
6170
|
search?: string;
|
|
@@ -6191,7 +6236,10 @@ interface operations {
|
|
|
6191
6236
|
};
|
|
6192
6237
|
locations_cities_retrieve: {
|
|
6193
6238
|
parameters: {
|
|
6194
|
-
query
|
|
6239
|
+
query: {
|
|
6240
|
+
/** @description Package whose targeting availability should be returned. */
|
|
6241
|
+
package_id: string;
|
|
6242
|
+
};
|
|
6195
6243
|
header?: {
|
|
6196
6244
|
/** @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
6245
|
"Accept-Language"?: string;
|
|
@@ -6276,7 +6324,7 @@ interface operations {
|
|
|
6276
6324
|
};
|
|
6277
6325
|
locations_continents_list: {
|
|
6278
6326
|
parameters: {
|
|
6279
|
-
query
|
|
6327
|
+
query: {
|
|
6280
6328
|
code?: string;
|
|
6281
6329
|
/** @description Number of results to return per page. */
|
|
6282
6330
|
limit?: number;
|
|
@@ -6285,8 +6333,8 @@ interface operations {
|
|
|
6285
6333
|
offset?: number;
|
|
6286
6334
|
/** @description Which field to use when ordering the results. */
|
|
6287
6335
|
ordering?: string;
|
|
6288
|
-
/** @description Package whose targeting availability should be returned.
|
|
6289
|
-
package_id
|
|
6336
|
+
/** @description Package whose targeting availability should be returned. */
|
|
6337
|
+
package_id: string;
|
|
6290
6338
|
/** @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
6339
|
search?: string;
|
|
6292
6340
|
};
|
|
@@ -6357,7 +6405,10 @@ interface operations {
|
|
|
6357
6405
|
};
|
|
6358
6406
|
locations_continents_retrieve: {
|
|
6359
6407
|
parameters: {
|
|
6360
|
-
query
|
|
6408
|
+
query: {
|
|
6409
|
+
/** @description Package whose targeting availability should be returned. */
|
|
6410
|
+
package_id: string;
|
|
6411
|
+
};
|
|
6361
6412
|
header?: {
|
|
6362
6413
|
/** @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
6414
|
"Accept-Language"?: string;
|
|
@@ -6442,7 +6493,7 @@ interface operations {
|
|
|
6442
6493
|
};
|
|
6443
6494
|
locations_countries_list: {
|
|
6444
6495
|
parameters: {
|
|
6445
|
-
query
|
|
6496
|
+
query: {
|
|
6446
6497
|
code?: string;
|
|
6447
6498
|
/** @description Number of results to return per page. */
|
|
6448
6499
|
limit?: number;
|
|
@@ -6451,8 +6502,8 @@ interface operations {
|
|
|
6451
6502
|
offset?: number;
|
|
6452
6503
|
/** @description Which field to use when ordering the results. */
|
|
6453
6504
|
ordering?: string;
|
|
6454
|
-
/** @description Package whose targeting availability should be returned.
|
|
6455
|
-
package_id
|
|
6505
|
+
/** @description Package whose targeting availability should be returned. */
|
|
6506
|
+
package_id: string;
|
|
6456
6507
|
/** @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
6508
|
search?: string;
|
|
6458
6509
|
};
|
|
@@ -6523,7 +6574,10 @@ interface operations {
|
|
|
6523
6574
|
};
|
|
6524
6575
|
locations_countries_retrieve: {
|
|
6525
6576
|
parameters: {
|
|
6526
|
-
query
|
|
6577
|
+
query: {
|
|
6578
|
+
/** @description Package whose targeting availability should be returned. */
|
|
6579
|
+
package_id: string;
|
|
6580
|
+
};
|
|
6527
6581
|
header?: {
|
|
6528
6582
|
/** @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
6583
|
"Accept-Language"?: string;
|
|
@@ -6608,7 +6662,7 @@ interface operations {
|
|
|
6608
6662
|
};
|
|
6609
6663
|
locations_isps_list: {
|
|
6610
6664
|
parameters: {
|
|
6611
|
-
query
|
|
6665
|
+
query: {
|
|
6612
6666
|
code?: string;
|
|
6613
6667
|
country__code?: string;
|
|
6614
6668
|
/** @description Number of results to return per page. */
|
|
@@ -6618,8 +6672,8 @@ interface operations {
|
|
|
6618
6672
|
offset?: number;
|
|
6619
6673
|
/** @description Which field to use when ordering the results. */
|
|
6620
6674
|
ordering?: string;
|
|
6621
|
-
/** @description Package whose targeting availability should be returned.
|
|
6622
|
-
package_id
|
|
6675
|
+
/** @description Package whose targeting availability should be returned. */
|
|
6676
|
+
package_id: string;
|
|
6623
6677
|
/** @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
6678
|
search?: string;
|
|
6625
6679
|
};
|
|
@@ -6690,7 +6744,7 @@ interface operations {
|
|
|
6690
6744
|
};
|
|
6691
6745
|
locations_regions_list: {
|
|
6692
6746
|
parameters: {
|
|
6693
|
-
query
|
|
6747
|
+
query: {
|
|
6694
6748
|
code?: string;
|
|
6695
6749
|
country__code?: string;
|
|
6696
6750
|
/** @description Number of results to return per page. */
|
|
@@ -6700,8 +6754,8 @@ interface operations {
|
|
|
6700
6754
|
offset?: number;
|
|
6701
6755
|
/** @description Which field to use when ordering the results. */
|
|
6702
6756
|
ordering?: string;
|
|
6703
|
-
/** @description Package whose targeting availability should be returned.
|
|
6704
|
-
package_id
|
|
6757
|
+
/** @description Package whose targeting availability should be returned. */
|
|
6758
|
+
package_id: string;
|
|
6705
6759
|
/** @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
6760
|
search?: string;
|
|
6707
6761
|
};
|
|
@@ -6772,7 +6826,10 @@ interface operations {
|
|
|
6772
6826
|
};
|
|
6773
6827
|
locations_regions_retrieve: {
|
|
6774
6828
|
parameters: {
|
|
6775
|
-
query
|
|
6829
|
+
query: {
|
|
6830
|
+
/** @description Package whose targeting availability should be returned. */
|
|
6831
|
+
package_id: string;
|
|
6832
|
+
};
|
|
6776
6833
|
header?: {
|
|
6777
6834
|
/** @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
6835
|
"Accept-Language"?: string;
|
|
@@ -9434,6 +9491,117 @@ interface operations {
|
|
|
9434
9491
|
};
|
|
9435
9492
|
};
|
|
9436
9493
|
};
|
|
9494
|
+
users_data_reset_create: {
|
|
9495
|
+
parameters: {
|
|
9496
|
+
query?: never;
|
|
9497
|
+
header?: {
|
|
9498
|
+
/** @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. */
|
|
9499
|
+
"Accept-Language"?: string;
|
|
9500
|
+
/** @description Stable key for one logical mutation. Successful responses are replayable for 24 hours; reusing a key with a different request returns 409. */
|
|
9501
|
+
"Idempotency-Key"?: string;
|
|
9502
|
+
};
|
|
9503
|
+
path: {
|
|
9504
|
+
/** @description A UUID string identifying this user. */
|
|
9505
|
+
id: string;
|
|
9506
|
+
};
|
|
9507
|
+
cookie?: never;
|
|
9508
|
+
};
|
|
9509
|
+
requestBody: {
|
|
9510
|
+
content: {
|
|
9511
|
+
"application/json": components["schemas"]["ResetDataRequest"];
|
|
9512
|
+
"application/x-www-form-urlencoded": components["schemas"]["ResetDataRequest"];
|
|
9513
|
+
"multipart/form-data": components["schemas"]["ResetDataRequest"];
|
|
9514
|
+
};
|
|
9515
|
+
};
|
|
9516
|
+
responses: {
|
|
9517
|
+
/** @description The request was accepted and the updated resource is returned. */
|
|
9518
|
+
202: {
|
|
9519
|
+
headers: {
|
|
9520
|
+
/** @description True when the response was replayed from a prior request. */
|
|
9521
|
+
"Idempotency-Replayed"?: "true";
|
|
9522
|
+
[name: string]: unknown;
|
|
9523
|
+
};
|
|
9524
|
+
content: {
|
|
9525
|
+
"application/json": components["schemas"]["Order"];
|
|
9526
|
+
};
|
|
9527
|
+
};
|
|
9528
|
+
/** @description The request is malformed or violates a business rule. */
|
|
9529
|
+
400: {
|
|
9530
|
+
headers: {
|
|
9531
|
+
"Content-Language": components["headers"]["ContentLanguage"];
|
|
9532
|
+
[name: string]: unknown;
|
|
9533
|
+
};
|
|
9534
|
+
content: {
|
|
9535
|
+
"application/json": {
|
|
9536
|
+
detail?: string;
|
|
9537
|
+
non_field_errors?: string[];
|
|
9538
|
+
} & {
|
|
9539
|
+
[key: string]: string | string[];
|
|
9540
|
+
};
|
|
9541
|
+
};
|
|
9542
|
+
};
|
|
9543
|
+
/** @description Authentication credentials are missing, expired, or invalid. */
|
|
9544
|
+
401: {
|
|
9545
|
+
headers: {
|
|
9546
|
+
"Content-Language": components["headers"]["ContentLanguage"];
|
|
9547
|
+
[name: string]: unknown;
|
|
9548
|
+
};
|
|
9549
|
+
content: {
|
|
9550
|
+
"application/json": {
|
|
9551
|
+
detail?: string;
|
|
9552
|
+
non_field_errors?: string[];
|
|
9553
|
+
} & {
|
|
9554
|
+
[key: string]: string | string[];
|
|
9555
|
+
};
|
|
9556
|
+
};
|
|
9557
|
+
};
|
|
9558
|
+
/** @description The authenticated account cannot perform this operation. */
|
|
9559
|
+
403: {
|
|
9560
|
+
headers: {
|
|
9561
|
+
"Content-Language": components["headers"]["ContentLanguage"];
|
|
9562
|
+
[name: string]: unknown;
|
|
9563
|
+
};
|
|
9564
|
+
content: {
|
|
9565
|
+
"application/json": {
|
|
9566
|
+
detail?: string;
|
|
9567
|
+
non_field_errors?: string[];
|
|
9568
|
+
} & {
|
|
9569
|
+
[key: string]: string | string[];
|
|
9570
|
+
};
|
|
9571
|
+
};
|
|
9572
|
+
};
|
|
9573
|
+
/** @description The requested resource does not exist in the current account scope. */
|
|
9574
|
+
404: {
|
|
9575
|
+
headers: {
|
|
9576
|
+
"Content-Language": components["headers"]["ContentLanguage"];
|
|
9577
|
+
[name: string]: unknown;
|
|
9578
|
+
};
|
|
9579
|
+
content: {
|
|
9580
|
+
"application/json": {
|
|
9581
|
+
detail?: string;
|
|
9582
|
+
non_field_errors?: string[];
|
|
9583
|
+
} & {
|
|
9584
|
+
[key: string]: string | string[];
|
|
9585
|
+
};
|
|
9586
|
+
};
|
|
9587
|
+
};
|
|
9588
|
+
/** @description The idempotency key is in progress or was reused for a different request. */
|
|
9589
|
+
409: {
|
|
9590
|
+
headers: {
|
|
9591
|
+
"Content-Language": components["headers"]["ContentLanguage"];
|
|
9592
|
+
[name: string]: unknown;
|
|
9593
|
+
};
|
|
9594
|
+
content: {
|
|
9595
|
+
"application/json": {
|
|
9596
|
+
detail?: string;
|
|
9597
|
+
non_field_errors?: string[];
|
|
9598
|
+
} & {
|
|
9599
|
+
[key: string]: string | string[];
|
|
9600
|
+
};
|
|
9601
|
+
};
|
|
9602
|
+
};
|
|
9603
|
+
};
|
|
9604
|
+
};
|
|
9437
9605
|
users_data_subtract_create: {
|
|
9438
9606
|
parameters: {
|
|
9439
9607
|
query?: never;
|
|
@@ -9654,7 +9822,7 @@ interface operations {
|
|
|
9654
9822
|
};
|
|
9655
9823
|
cookie?: never;
|
|
9656
9824
|
};
|
|
9657
|
-
requestBody
|
|
9825
|
+
requestBody: {
|
|
9658
9826
|
content: {
|
|
9659
9827
|
"application/json": components["schemas"]["UserPasswordResetRequestRequest"];
|
|
9660
9828
|
"application/x-www-form-urlencoded": components["schemas"]["UserPasswordResetRequestRequest"];
|
|
@@ -10114,4 +10282,4 @@ interface operations {
|
|
|
10114
10282
|
}
|
|
10115
10283
|
//#endregion
|
|
10116
10284
|
export { webhooks as i, operations as n, paths as r, components as t };
|
|
10117
|
-
//# sourceMappingURL=schema-
|
|
10285
|
+
//# sourceMappingURL=schema-BZvnw81E.d.cts.map
|