@proxyrequest/sdk 1.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 +33 -0
- package/README.md +58 -8
- package/SECURITY.md +1 -1
- package/dist/index.cjs +665 -266
- package/dist/index.cjs.map +1 -1
- package/dist/index.d.cts +249 -74
- package/dist/index.d.cts.map +1 -1
- package/dist/index.d.ts +249 -74
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js +666 -265
- package/dist/index.js.map +1 -1
- package/dist/{models-VMmyyuf_.d.cts → models-Ci7ojtEW.d.cts} +13 -9
- package/dist/models-Ci7ojtEW.d.cts.map +1 -0
- package/dist/{models-ECy_bhdn.d.ts → models-rpFTQLRE.d.ts} +13 -9
- package/dist/models-rpFTQLRE.d.ts.map +1 -0
- 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-CvCxeox5.d.cts → schema-B2orTIrr.d.cts} +970 -453
- package/dist/schema-B2orTIrr.d.cts.map +1 -0
- package/dist/{schema-CvCxeox5.d.ts → schema-B2orTIrr.d.ts} +970 -453
- package/dist/schema-B2orTIrr.d.ts.map +1 -0
- package/docs/SDK-AUDIT.md +273 -0
- package/docs/backend-compatibility.md +66 -0
- package/docs/errors-and-pagination.md +1 -1
- package/docs/getting-started.md +1 -2
- package/docs/releasing.md +13 -3
- package/docs/reseller-workflow.md +1 -1
- package/docs/webhooks.md +4 -7
- package/package.json +3 -2
- package/dist/models-ECy_bhdn.d.ts.map +0 -1
- package/dist/models-VMmyyuf_.d.cts.map +0 -1
- package/dist/schema-CvCxeox5.d.cts.map +0 -1
- package/dist/schema-CvCxeox5.d.ts.map +0 -1
|
@@ -1,8 +1,4 @@
|
|
|
1
1
|
//#region src/generated/schema.d.ts
|
|
2
|
-
/**
|
|
3
|
-
* This file was auto-generated by openapi-typescript.
|
|
4
|
-
* Do not make direct changes to the file.
|
|
5
|
-
*/
|
|
6
2
|
interface paths {
|
|
7
3
|
"/affiliates": {
|
|
8
4
|
parameters: {
|
|
@@ -372,46 +368,6 @@ interface paths {
|
|
|
372
368
|
patch?: never;
|
|
373
369
|
trace?: never;
|
|
374
370
|
};
|
|
375
|
-
"/integrations/telegram/link/consume": {
|
|
376
|
-
parameters: {
|
|
377
|
-
query?: never;
|
|
378
|
-
header?: never;
|
|
379
|
-
path?: never;
|
|
380
|
-
cookie?: never;
|
|
381
|
-
};
|
|
382
|
-
get?: never;
|
|
383
|
-
put?: never;
|
|
384
|
-
/**
|
|
385
|
-
* Consume a Telegram account link
|
|
386
|
-
* @description Links a private Telegram chat after validating the single-use token.
|
|
387
|
-
*/
|
|
388
|
-
post: operations["integrations_telegram_link_consume_create"];
|
|
389
|
-
delete?: never;
|
|
390
|
-
options?: never;
|
|
391
|
-
head?: never;
|
|
392
|
-
patch?: never;
|
|
393
|
-
trace?: never;
|
|
394
|
-
};
|
|
395
|
-
"/integrations/telegram/session": {
|
|
396
|
-
parameters: {
|
|
397
|
-
query?: never;
|
|
398
|
-
header?: never;
|
|
399
|
-
path?: never;
|
|
400
|
-
cookie?: never;
|
|
401
|
-
};
|
|
402
|
-
get?: never;
|
|
403
|
-
put?: never;
|
|
404
|
-
/**
|
|
405
|
-
* Create a Telegram API session
|
|
406
|
-
* @description Returns a two-minute access token for an already linked private chat.
|
|
407
|
-
*/
|
|
408
|
-
post: operations["integrations_telegram_session_create"];
|
|
409
|
-
delete?: never;
|
|
410
|
-
options?: never;
|
|
411
|
-
head?: never;
|
|
412
|
-
patch?: never;
|
|
413
|
-
trace?: never;
|
|
414
|
-
};
|
|
415
371
|
"/invoices": {
|
|
416
372
|
parameters: {
|
|
417
373
|
query?: never;
|
|
@@ -427,7 +383,7 @@ interface paths {
|
|
|
427
383
|
put?: never;
|
|
428
384
|
/**
|
|
429
385
|
* Create an invoice
|
|
430
|
-
* @description Calculates package pricing, creates a
|
|
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.
|
|
431
387
|
*/
|
|
432
388
|
post: operations["invoices_create"];
|
|
433
389
|
delete?: never;
|
|
@@ -740,6 +696,26 @@ interface paths {
|
|
|
740
696
|
patch?: never;
|
|
741
697
|
trace?: never;
|
|
742
698
|
};
|
|
699
|
+
"/login/otp": {
|
|
700
|
+
parameters: {
|
|
701
|
+
query?: never;
|
|
702
|
+
header?: never;
|
|
703
|
+
path?: never;
|
|
704
|
+
cookie?: never;
|
|
705
|
+
};
|
|
706
|
+
get?: never;
|
|
707
|
+
put?: never;
|
|
708
|
+
/**
|
|
709
|
+
* Complete two-factor sign-in
|
|
710
|
+
* @description Exchanges a single-use sign-in challenge and authenticator code for account tokens.
|
|
711
|
+
*/
|
|
712
|
+
post: operations["login_otp_create"];
|
|
713
|
+
delete?: never;
|
|
714
|
+
options?: never;
|
|
715
|
+
head?: never;
|
|
716
|
+
patch?: never;
|
|
717
|
+
trace?: never;
|
|
718
|
+
};
|
|
743
719
|
"/news": {
|
|
744
720
|
parameters: {
|
|
745
721
|
query?: never;
|
|
@@ -769,7 +745,7 @@ interface paths {
|
|
|
769
745
|
};
|
|
770
746
|
/**
|
|
771
747
|
* List active orders
|
|
772
|
-
* @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.
|
|
773
749
|
*/
|
|
774
750
|
get: operations["orders_list"];
|
|
775
751
|
put?: never;
|
|
@@ -789,14 +765,14 @@ interface paths {
|
|
|
789
765
|
};
|
|
790
766
|
/**
|
|
791
767
|
* Get an order
|
|
792
|
-
* @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.
|
|
793
769
|
*/
|
|
794
770
|
get: operations["orders_retrieve"];
|
|
795
771
|
put?: never;
|
|
796
772
|
post?: never;
|
|
797
773
|
/**
|
|
798
774
|
* Delete a sub-user order
|
|
799
|
-
* @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.
|
|
800
776
|
*/
|
|
801
777
|
delete: operations["orders_destroy"];
|
|
802
778
|
options?: never;
|
|
@@ -886,8 +862,8 @@ interface paths {
|
|
|
886
862
|
get?: never;
|
|
887
863
|
put?: never;
|
|
888
864
|
/**
|
|
889
|
-
* Confirm two-factor
|
|
890
|
-
* @description
|
|
865
|
+
* Confirm two-factor authentication
|
|
866
|
+
* @description Activates the pending authenticator after verifying its code and revokes previous JWTs.
|
|
891
867
|
*/
|
|
892
868
|
post: operations["profile_2fa_confirm_create"];
|
|
893
869
|
delete?: never;
|
|
@@ -907,7 +883,7 @@ interface paths {
|
|
|
907
883
|
put?: never;
|
|
908
884
|
/**
|
|
909
885
|
* Disable two-factor authentication
|
|
910
|
-
* @description
|
|
886
|
+
* @description Requires the primary factor and current authenticator code, then revokes previous JWTs.
|
|
911
887
|
*/
|
|
912
888
|
post: operations["profile_2fa_disable_create"];
|
|
913
889
|
delete?: never;
|
|
@@ -926,8 +902,8 @@ interface paths {
|
|
|
926
902
|
get?: never;
|
|
927
903
|
put?: never;
|
|
928
904
|
/**
|
|
929
|
-
*
|
|
930
|
-
* @description
|
|
905
|
+
* Prepare two-factor authentication
|
|
906
|
+
* @description Confirms the primary factor and prepares a pending secret without disabling current protection.
|
|
931
907
|
*/
|
|
932
908
|
post: operations["profile_2fa_setup_create"];
|
|
933
909
|
delete?: never;
|
|
@@ -1096,46 +1072,6 @@ interface paths {
|
|
|
1096
1072
|
patch?: never;
|
|
1097
1073
|
trace?: never;
|
|
1098
1074
|
};
|
|
1099
|
-
"/sessions": {
|
|
1100
|
-
parameters: {
|
|
1101
|
-
query?: never;
|
|
1102
|
-
header?: never;
|
|
1103
|
-
path?: never;
|
|
1104
|
-
cookie?: never;
|
|
1105
|
-
};
|
|
1106
|
-
/**
|
|
1107
|
-
* List active proxy sessions
|
|
1108
|
-
* @description Returns sticky proxy session identifiers owned by the authenticated username. At most the configured safety limit is returned.
|
|
1109
|
-
*/
|
|
1110
|
-
get: operations["sessions_list"];
|
|
1111
|
-
put?: never;
|
|
1112
|
-
post?: never;
|
|
1113
|
-
delete?: never;
|
|
1114
|
-
options?: never;
|
|
1115
|
-
head?: never;
|
|
1116
|
-
patch?: never;
|
|
1117
|
-
trace?: never;
|
|
1118
|
-
};
|
|
1119
|
-
"/sessions/{id}": {
|
|
1120
|
-
parameters: {
|
|
1121
|
-
query?: never;
|
|
1122
|
-
header?: never;
|
|
1123
|
-
path?: never;
|
|
1124
|
-
cookie?: never;
|
|
1125
|
-
};
|
|
1126
|
-
get?: never;
|
|
1127
|
-
put?: never;
|
|
1128
|
-
post?: never;
|
|
1129
|
-
/**
|
|
1130
|
-
* Revoke a proxy session
|
|
1131
|
-
* @description Deletes matching sticky-session keys owned by the authenticated username. The path value is treated as the session identifier fragment.
|
|
1132
|
-
*/
|
|
1133
|
-
delete: operations["sessions_destroy"];
|
|
1134
|
-
options?: never;
|
|
1135
|
-
head?: never;
|
|
1136
|
-
patch?: never;
|
|
1137
|
-
trace?: never;
|
|
1138
|
-
};
|
|
1139
1075
|
"/settings": {
|
|
1140
1076
|
parameters: {
|
|
1141
1077
|
query?: never;
|
|
@@ -1190,8 +1126,8 @@ interface paths {
|
|
|
1190
1126
|
get: operations["users_list"];
|
|
1191
1127
|
put?: never;
|
|
1192
1128
|
/**
|
|
1193
|
-
* Create a
|
|
1194
|
-
* @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.
|
|
1195
1131
|
*/
|
|
1196
1132
|
post: operations["users_create"];
|
|
1197
1133
|
delete?: never;
|
|
@@ -1239,7 +1175,7 @@ interface paths {
|
|
|
1239
1175
|
put?: never;
|
|
1240
1176
|
/**
|
|
1241
1177
|
* Add data to a sub-user order
|
|
1242
|
-
* @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.
|
|
1243
1179
|
*/
|
|
1244
1180
|
post: operations["users_data_add_create"];
|
|
1245
1181
|
delete?: never;
|
|
@@ -1248,6 +1184,26 @@ interface paths {
|
|
|
1248
1184
|
patch?: never;
|
|
1249
1185
|
trace?: never;
|
|
1250
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
|
+
};
|
|
1251
1207
|
"/users/{id}/data/subtract": {
|
|
1252
1208
|
parameters: {
|
|
1253
1209
|
query?: never;
|
|
@@ -1259,7 +1215,7 @@ interface paths {
|
|
|
1259
1215
|
put?: never;
|
|
1260
1216
|
/**
|
|
1261
1217
|
* Subtract data from a sub-user order
|
|
1262
|
-
* @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.
|
|
1263
1219
|
*/
|
|
1264
1220
|
post: operations["users_data_subtract_create"];
|
|
1265
1221
|
delete?: never;
|
|
@@ -1277,7 +1233,7 @@ interface paths {
|
|
|
1277
1233
|
};
|
|
1278
1234
|
/**
|
|
1279
1235
|
* List a sub-user's orders
|
|
1280
|
-
* @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.
|
|
1281
1237
|
*/
|
|
1282
1238
|
get: operations["users_orders_list"];
|
|
1283
1239
|
put?: never;
|
|
@@ -1299,7 +1255,7 @@ interface paths {
|
|
|
1299
1255
|
put?: never;
|
|
1300
1256
|
/**
|
|
1301
1257
|
* Rotate a sub-user proxy password
|
|
1302
|
-
* @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.
|
|
1303
1259
|
*/
|
|
1304
1260
|
post: operations["users_password_create"];
|
|
1305
1261
|
delete?: never;
|
|
@@ -1361,8 +1317,12 @@ type webhooks = Record<string, never>;
|
|
|
1361
1317
|
interface components {
|
|
1362
1318
|
schemas: {
|
|
1363
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. */
|
|
1364
1321
|
data: number;
|
|
1365
|
-
/**
|
|
1322
|
+
/**
|
|
1323
|
+
* Format: uuid
|
|
1324
|
+
* @description Package for which the caller owns a root order.
|
|
1325
|
+
*/
|
|
1366
1326
|
package_id: string;
|
|
1367
1327
|
};
|
|
1368
1328
|
Affiliate: {
|
|
@@ -1437,6 +1397,11 @@ interface components {
|
|
|
1437
1397
|
new_password2: string;
|
|
1438
1398
|
old_password: string;
|
|
1439
1399
|
};
|
|
1400
|
+
/**
|
|
1401
|
+
* @description * `not_required` - Not required * `initializing` - Initializing * `ready` - Ready * `failed` - Failed
|
|
1402
|
+
* @enum {string}
|
|
1403
|
+
*/
|
|
1404
|
+
CheckoutStatusEnum: "not_required" | "initializing" | "ready" | "failed";
|
|
1440
1405
|
City: {
|
|
1441
1406
|
readonly asns: components["schemas"]["LocationCodeName"][];
|
|
1442
1407
|
/** @description Raw city code as it appears in the source data. los_angeles paris */
|
|
@@ -1770,7 +1735,7 @@ interface components {
|
|
|
1770
1735
|
targeting?: components["schemas"]["ProxyGenerationTargetingRequest"];
|
|
1771
1736
|
/**
|
|
1772
1737
|
* Format: uuid
|
|
1773
|
-
* @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.
|
|
1774
1739
|
*/
|
|
1775
1740
|
user_id?: string;
|
|
1776
1741
|
};
|
|
@@ -1798,10 +1763,7 @@ interface components {
|
|
|
1798
1763
|
* @description The balance to top up for the user. Must be zero or positive.
|
|
1799
1764
|
*/
|
|
1800
1765
|
balance?: number;
|
|
1801
|
-
|
|
1802
|
-
coinbase_charge_id?: string;
|
|
1803
|
-
/** @description The Coingate order token for the payment. Optional field with a maximum length of 255 characters. */
|
|
1804
|
-
coingate_order_token?: string;
|
|
1766
|
+
checkout_status?: components["schemas"]["CheckoutStatusEnum"];
|
|
1805
1767
|
company_address?: string;
|
|
1806
1768
|
company_city?: string;
|
|
1807
1769
|
company_name?: string;
|
|
@@ -1810,10 +1772,15 @@ interface components {
|
|
|
1810
1772
|
company_vat_number?: string;
|
|
1811
1773
|
/** @description The maximum number of concurrent connections allowed for this package. */
|
|
1812
1774
|
connection_limit?: number;
|
|
1813
|
-
readonly country: components["schemas"]["Country"];
|
|
1814
|
-
readonly coupon: components["schemas"]["CouponShort"];
|
|
1775
|
+
readonly country: components["schemas"]["Country"] | null;
|
|
1776
|
+
readonly coupon: components["schemas"]["CouponShort"] | null;
|
|
1815
1777
|
/** Format: date-time */
|
|
1816
1778
|
readonly created: string;
|
|
1779
|
+
/**
|
|
1780
|
+
* Billing Currency
|
|
1781
|
+
* @description ISO 4217 currency captured when the invoice is created.
|
|
1782
|
+
*/
|
|
1783
|
+
currency?: string;
|
|
1817
1784
|
/**
|
|
1818
1785
|
* Data (bytes)
|
|
1819
1786
|
* Format: int64
|
|
@@ -1822,9 +1789,14 @@ interface components {
|
|
|
1822
1789
|
data?: number;
|
|
1823
1790
|
/** @description A description of the invoice. This field is optional and can be left blank. */
|
|
1824
1791
|
description?: string;
|
|
1792
|
+
readonly fx_effective_rate: string;
|
|
1793
|
+
readonly fx_market_rate: string;
|
|
1794
|
+
readonly fx_markup_percent: string;
|
|
1795
|
+
/** Format: date-time */
|
|
1796
|
+
readonly fx_quoted_at: string | null;
|
|
1825
1797
|
/**
|
|
1826
1798
|
* Payment Gateway
|
|
1827
|
-
* @description The payment gateway used for processing the payment. * `coinbase` - Coinbase * `cryptomus` - Cryptomus * `stripe` - Stripe * `coingate` - Coingate * `wallet` - Wallet * `manual` - Manual
|
|
1799
|
+
* @description The payment gateway used for processing the payment. * `coinbase` - Coinbase * `cryptomus` - Cryptomus * `stripe` - Stripe * `coingate` - Coingate * `wallet` - Wallet * `manual` - Manual * `whitepay` - Whitepay * `wayforpay` - WayForPay * `usegateway` - UseGateway * `binance` - Binance Pay * `anymoney` - Any.Money * `coinpayments` - CoinPayments * `checkoutcom` - Checkout.com * `nowpayments` - NOWPayments * `btcpay` - BTCPay Server * `braintree` - Braintree * `monobank` - monobank * `liqpay` - LiqPay * `iyzico` - iyzico * `paytr` - PayTR * `payu` - PayU * `tpay` - Tpay * `przelewy24` - Przelewy24 * `gopay` - GoPay * `comgate` - Comgate * `monei` - MONEI * `redsys` - Redsys * `payplug` - PayPlug * `mollie` - Mollie * `unzer` - Unzer * `payone` - PAYONE * `nexi_xpay` - Nexi XPay * `halyk_epay` - Halyk ePay * `kaspi_pay` - Kaspi Pay * `vipps_mobilepay` - Vipps MobilePay * `paytrail` - Paytrail
|
|
1828
1800
|
*/
|
|
1829
1801
|
gateway?: components["schemas"]["InvoiceGatewayEnum"];
|
|
1830
1802
|
id?: string;
|
|
@@ -1832,7 +1804,7 @@ interface components {
|
|
|
1832
1804
|
internal_id?: string;
|
|
1833
1805
|
/**
|
|
1834
1806
|
* One-Time Purchase
|
|
1835
|
-
* @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.
|
|
1836
1808
|
*/
|
|
1837
1809
|
is_one_time?: boolean;
|
|
1838
1810
|
/**
|
|
@@ -1840,12 +1812,14 @@ interface components {
|
|
|
1840
1812
|
* @description Indicates whether this invoice is a payout to the marketer. Default is False.
|
|
1841
1813
|
*/
|
|
1842
1814
|
is_payout?: boolean;
|
|
1843
|
-
readonly package: components["schemas"]["PackageShort"];
|
|
1815
|
+
readonly package: components["schemas"]["PackageShort"] | null;
|
|
1844
1816
|
/**
|
|
1845
1817
|
* Format: date-time
|
|
1846
1818
|
* @description The date and time when the invoice was paid.
|
|
1847
1819
|
*/
|
|
1848
1820
|
paid?: string | null;
|
|
1821
|
+
readonly payment_amount: number;
|
|
1822
|
+
readonly payment_currency: string;
|
|
1849
1823
|
/**
|
|
1850
1824
|
* Format: uri
|
|
1851
1825
|
* @description The URL for making the payment. Optional field with a maximum length of 500 characters.
|
|
@@ -1857,9 +1831,13 @@ interface components {
|
|
|
1857
1831
|
* @description The total price of the invoice, including any discounts. Must be at least 1 cent.
|
|
1858
1832
|
*/
|
|
1859
1833
|
price_total?: number;
|
|
1834
|
+
/** @description Provider-side hosted checkout identifier used for reconciliation. */
|
|
1835
|
+
provider_checkout_id?: string;
|
|
1836
|
+
/** @description Provider-side payment or transaction identifier used for reconciliation. */
|
|
1837
|
+
provider_payment_id?: string;
|
|
1860
1838
|
/** @description The number of proxies to assign. */
|
|
1861
1839
|
quantity?: number;
|
|
1862
|
-
/** @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 */
|
|
1863
1841
|
status?: components["schemas"]["InvoiceStatusEnum"];
|
|
1864
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 */
|
|
1865
1843
|
type?: components["schemas"]["InvoiceTypeEnum"];
|
|
@@ -1875,12 +1853,12 @@ interface components {
|
|
|
1875
1853
|
vat?: number;
|
|
1876
1854
|
};
|
|
1877
1855
|
/**
|
|
1878
|
-
* @description * `crypto` - crypto * `wallet` - wallet * `manual` - manual * `stripe` - stripe
|
|
1856
|
+
* @description * `crypto` - crypto * `credit_card` - credit_card * `wallet` - wallet * `manual` - manual * `stripe` - stripe * `coinbase` - coinbase * `cryptomus` - cryptomus * `coingate` - coingate * `whitepay` - whitepay * `wayforpay` - wayforpay * `usegateway` - usegateway * `binance` - binance * `anymoney` - anymoney * `coinpayments` - coinpayments * `checkoutcom` - checkoutcom * `nowpayments` - nowpayments * `btcpay` - btcpay * `braintree` - braintree * `monobank` - monobank * `liqpay` - liqpay * `iyzico` - iyzico * `paytr` - paytr * `payu` - payu * `tpay` - tpay * `przelewy24` - przelewy24 * `gopay` - gopay * `comgate` - comgate * `monei` - monei * `redsys` - redsys * `payplug` - payplug * `mollie` - mollie * `unzer` - unzer * `payone` - payone * `nexi_xpay` - nexi_xpay * `halyk_epay` - halyk_epay * `kaspi_pay` - kaspi_pay * `vipps_mobilepay` - vipps_mobilepay * `paytrail` - paytrail
|
|
1879
1857
|
* @enum {string}
|
|
1880
1858
|
*/
|
|
1881
|
-
InvoiceCreateRequestGatewayEnum: "crypto" | "wallet" | "manual" | "stripe";
|
|
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 & {});
|
|
1882
1860
|
InvoiceCreateRequestRequest: {
|
|
1883
|
-
/** @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. */
|
|
1884
1862
|
amount?: number;
|
|
1885
1863
|
company_name?: string;
|
|
1886
1864
|
company_registration_number?: string;
|
|
@@ -1889,9 +1867,9 @@ interface components {
|
|
|
1889
1867
|
country_code?: string;
|
|
1890
1868
|
coupon_code?: string;
|
|
1891
1869
|
crypto_currency?: string;
|
|
1892
|
-
/** @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. */
|
|
1893
1871
|
data?: number;
|
|
1894
|
-
/** @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. */
|
|
1895
1873
|
expires?: number;
|
|
1896
1874
|
gateway: components["schemas"]["InvoiceCreateRequestGatewayEnum"];
|
|
1897
1875
|
/**
|
|
@@ -1899,19 +1877,115 @@ interface components {
|
|
|
1899
1877
|
* @description Package to purchase. Required for package purchases.
|
|
1900
1878
|
*/
|
|
1901
1879
|
package_id?: string;
|
|
1880
|
+
/** @description ISO 4217 currency charged by a regional fiat provider. */
|
|
1881
|
+
payment_currency?: string;
|
|
1902
1882
|
/** @description Number of static proxies to purchase. */
|
|
1903
1883
|
quantity?: number;
|
|
1884
|
+
/**
|
|
1885
|
+
* @description Initial invoice status. Defaults to pending. Only superusers may set paid; other authenticated users receive a 403 response. * `pending` - pending * `paid` - paid
|
|
1886
|
+
* @default pending
|
|
1887
|
+
*/
|
|
1888
|
+
status?: components["schemas"]["InvoiceCreateRequestStatusEnum"];
|
|
1904
1889
|
/**
|
|
1905
1890
|
* Format: uuid
|
|
1906
|
-
* @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.
|
|
1907
1892
|
*/
|
|
1908
1893
|
user_id?: string;
|
|
1909
1894
|
};
|
|
1910
1895
|
/**
|
|
1911
|
-
* @description * `
|
|
1896
|
+
* @description * `pending` - pending * `paid` - paid
|
|
1912
1897
|
* @enum {string}
|
|
1913
1898
|
*/
|
|
1914
|
-
|
|
1899
|
+
InvoiceCreateRequestStatusEnum: "pending" | "paid";
|
|
1900
|
+
/**
|
|
1901
|
+
* @description * `coinbase` - Coinbase * `cryptomus` - Cryptomus * `stripe` - Stripe * `coingate` - Coingate * `wallet` - Wallet * `manual` - Manual * `whitepay` - Whitepay * `wayforpay` - WayForPay * `usegateway` - UseGateway * `binance` - Binance Pay * `anymoney` - Any.Money * `coinpayments` - CoinPayments * `checkoutcom` - Checkout.com * `nowpayments` - NOWPayments * `btcpay` - BTCPay Server * `braintree` - Braintree * `monobank` - monobank * `liqpay` - LiqPay * `iyzico` - iyzico * `paytr` - PayTR * `payu` - PayU * `tpay` - Tpay * `przelewy24` - Przelewy24 * `gopay` - GoPay * `comgate` - Comgate * `monei` - MONEI * `redsys` - Redsys * `payplug` - PayPlug * `mollie` - Mollie * `unzer` - Unzer * `payone` - PAYONE * `nexi_xpay` - Nexi XPay * `halyk_epay` - Halyk ePay * `kaspi_pay` - Kaspi Pay * `vipps_mobilepay` - Vipps MobilePay * `paytrail` - Paytrail
|
|
1902
|
+
* @enum {string}
|
|
1903
|
+
*/
|
|
1904
|
+
InvoiceGatewayEnum: "coinbase" | "cryptomus" | "stripe" | "coingate" | "wallet" | "manual" | "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 & {});
|
|
1905
|
+
/** @description Full invoice in package-based deployments; short invoice otherwise. Invoice creation always returns the full Invoice representation. */
|
|
1906
|
+
InvoiceRead: components["schemas"]["Invoice"] | components["schemas"]["InvoiceShort"];
|
|
1907
|
+
InvoiceShort: {
|
|
1908
|
+
/**
|
|
1909
|
+
* Balance Top Up (cents)
|
|
1910
|
+
* Format: int64
|
|
1911
|
+
* @description The balance to top up for the user. Must be zero or positive.
|
|
1912
|
+
*/
|
|
1913
|
+
balance?: number;
|
|
1914
|
+
checkout_status?: components["schemas"]["CheckoutStatusEnum"];
|
|
1915
|
+
company_address?: string;
|
|
1916
|
+
company_city?: string;
|
|
1917
|
+
company_name?: string;
|
|
1918
|
+
company_postal_code?: string;
|
|
1919
|
+
company_registration_number?: string;
|
|
1920
|
+
company_vat_number?: string;
|
|
1921
|
+
/** @description The maximum number of concurrent connections allowed for this package. */
|
|
1922
|
+
connection_limit?: number;
|
|
1923
|
+
readonly country: components["schemas"]["Country"] | null;
|
|
1924
|
+
readonly coupon: components["schemas"]["Coupon"] | null;
|
|
1925
|
+
/** Format: date-time */
|
|
1926
|
+
readonly created: string;
|
|
1927
|
+
/**
|
|
1928
|
+
* Billing Currency
|
|
1929
|
+
* @description ISO 4217 currency captured when the invoice is created.
|
|
1930
|
+
*/
|
|
1931
|
+
currency?: string;
|
|
1932
|
+
/**
|
|
1933
|
+
* Data (bytes)
|
|
1934
|
+
* Format: int64
|
|
1935
|
+
* @description The amount of data in bytes.
|
|
1936
|
+
*/
|
|
1937
|
+
data?: number;
|
|
1938
|
+
/** @description A description of the invoice. This field is optional and can be left blank. */
|
|
1939
|
+
description?: string;
|
|
1940
|
+
/**
|
|
1941
|
+
* Format: date-time
|
|
1942
|
+
* @description The date and time when the invoice expires. If not set, the invoice does not expire.
|
|
1943
|
+
*/
|
|
1944
|
+
expires?: string | null;
|
|
1945
|
+
/**
|
|
1946
|
+
* Payment Gateway
|
|
1947
|
+
* @description The payment gateway used for processing the payment. * `coinbase` - Coinbase * `cryptomus` - Cryptomus * `stripe` - Stripe * `coingate` - Coingate * `wallet` - Wallet * `manual` - Manual * `whitepay` - Whitepay * `wayforpay` - WayForPay * `usegateway` - UseGateway * `binance` - Binance Pay * `anymoney` - Any.Money * `coinpayments` - CoinPayments * `checkoutcom` - Checkout.com * `nowpayments` - NOWPayments * `btcpay` - BTCPay Server * `braintree` - Braintree * `monobank` - monobank * `liqpay` - LiqPay * `iyzico` - iyzico * `paytr` - PayTR * `payu` - PayU * `tpay` - Tpay * `przelewy24` - Przelewy24 * `gopay` - GoPay * `comgate` - Comgate * `monei` - MONEI * `redsys` - Redsys * `payplug` - PayPlug * `mollie` - Mollie * `unzer` - Unzer * `payone` - PAYONE * `nexi_xpay` - Nexi XPay * `halyk_epay` - Halyk ePay * `kaspi_pay` - Kaspi Pay * `vipps_mobilepay` - Vipps MobilePay * `paytrail` - Paytrail
|
|
1948
|
+
*/
|
|
1949
|
+
gateway?: components["schemas"]["InvoiceGatewayEnum"];
|
|
1950
|
+
id?: string;
|
|
1951
|
+
/** @description A unique identifier for the invoice, generated automatically. */
|
|
1952
|
+
internal_id?: string;
|
|
1953
|
+
/**
|
|
1954
|
+
* One-Time Purchase
|
|
1955
|
+
* @description Indicates whether this invoice is for a one-time purchase. Default is False, meaning it is a recurring invoice.
|
|
1956
|
+
*/
|
|
1957
|
+
is_one_time?: boolean;
|
|
1958
|
+
/**
|
|
1959
|
+
* Payout
|
|
1960
|
+
* @description Indicates whether this invoice is a payout to the marketer. Default is False.
|
|
1961
|
+
*/
|
|
1962
|
+
is_payout?: boolean;
|
|
1963
|
+
/**
|
|
1964
|
+
* Format: date-time
|
|
1965
|
+
* @description The date and time when the invoice was paid.
|
|
1966
|
+
*/
|
|
1967
|
+
paid?: string | null;
|
|
1968
|
+
/**
|
|
1969
|
+
* Price (cents)
|
|
1970
|
+
* Format: int64
|
|
1971
|
+
* @description The total price of the invoice, including any discounts. Must be at least 1 cent.
|
|
1972
|
+
*/
|
|
1973
|
+
price_total?: number;
|
|
1974
|
+
/** @description Provider-side hosted checkout identifier used for reconciliation. */
|
|
1975
|
+
provider_checkout_id?: string;
|
|
1976
|
+
/** @description Provider-side payment or transaction identifier used for reconciliation. */
|
|
1977
|
+
provider_payment_id?: string;
|
|
1978
|
+
/** @description After changing invoice status to PAID, the invoice will be processed and user package created in case none exists. If you need to cancel the invoice, make sure to subtract data from the user package after changing the invoice status. Changing the status from PAID to any other will not affect the user package's data or proxies. * `pending` - Pending * `paid` - Paid * `unpaid` - Unpaid * `error` - Error */
|
|
1979
|
+
status?: components["schemas"]["InvoiceStatusEnum"];
|
|
1980
|
+
/** Format: date-time */
|
|
1981
|
+
readonly updated: string;
|
|
1982
|
+
/**
|
|
1983
|
+
* VAT (%)
|
|
1984
|
+
* Format: double
|
|
1985
|
+
* @description The VAT percentage applied to the invoice. Must be between 0 and 100.
|
|
1986
|
+
*/
|
|
1987
|
+
vat?: number;
|
|
1988
|
+
};
|
|
1915
1989
|
/**
|
|
1916
1990
|
* @description * `pending` - Pending * `paid` - Paid * `unpaid` - Unpaid * `error` - Error
|
|
1917
1991
|
* @enum {string}
|
|
@@ -2051,6 +2125,7 @@ interface components {
|
|
|
2051
2125
|
* @description Total data allowance for this order in bytes. 1073741824 = 1 GiB 10737418240 = 10 GiB
|
|
2052
2126
|
*/
|
|
2053
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. */
|
|
2054
2129
|
readonly data_remaining: number;
|
|
2055
2130
|
/**
|
|
2056
2131
|
* Data Spent (bytes)
|
|
@@ -2077,6 +2152,7 @@ interface components {
|
|
|
2077
2152
|
* @description Timestamp of the most recent data top-up, set when an invoice is fulfilled.
|
|
2078
2153
|
*/
|
|
2079
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. */
|
|
2080
2156
|
readonly ledgers: {
|
|
2081
2157
|
[key: string]: unknown;
|
|
2082
2158
|
}[];
|
|
@@ -2113,6 +2189,7 @@ interface components {
|
|
|
2113
2189
|
* @description Total data allowance for this order in bytes. 1073741824 = 1 GiB 10737418240 = 10 GiB
|
|
2114
2190
|
*/
|
|
2115
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. */
|
|
2116
2193
|
readonly data_remaining: number;
|
|
2117
2194
|
/**
|
|
2118
2195
|
* Data Spent (bytes)
|
|
@@ -2149,6 +2226,7 @@ interface components {
|
|
|
2149
2226
|
* @description Timestamp of the most recent data top-up, set when an invoice is fulfilled.
|
|
2150
2227
|
*/
|
|
2151
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. */
|
|
2152
2230
|
readonly ledgers: {
|
|
2153
2231
|
[key: string]: unknown;
|
|
2154
2232
|
}[];
|
|
@@ -2166,6 +2244,11 @@ interface components {
|
|
|
2166
2244
|
/** Format: uuid */
|
|
2167
2245
|
user_id: string;
|
|
2168
2246
|
};
|
|
2247
|
+
OTPChallenge: {
|
|
2248
|
+
challenge: string;
|
|
2249
|
+
expires_in: number;
|
|
2250
|
+
status: string;
|
|
2251
|
+
};
|
|
2169
2252
|
OverallPoint: {
|
|
2170
2253
|
data: number;
|
|
2171
2254
|
requests: number;
|
|
@@ -2391,7 +2474,7 @@ interface components {
|
|
|
2391
2474
|
previous?: string | null;
|
|
2392
2475
|
results: components["schemas"]["CouponShort"][];
|
|
2393
2476
|
};
|
|
2394
|
-
|
|
2477
|
+
PaginatedInvoiceReadList: {
|
|
2395
2478
|
/** @example 1 */
|
|
2396
2479
|
count: number;
|
|
2397
2480
|
/**
|
|
@@ -2404,7 +2487,7 @@ interface components {
|
|
|
2404
2487
|
* @example null
|
|
2405
2488
|
*/
|
|
2406
2489
|
previous?: string | null;
|
|
2407
|
-
results: components["schemas"]["
|
|
2490
|
+
results: components["schemas"]["InvoiceRead"][];
|
|
2408
2491
|
};
|
|
2409
2492
|
PaginatedISPList: {
|
|
2410
2493
|
/** @example 1 */
|
|
@@ -2676,6 +2759,14 @@ interface components {
|
|
|
2676
2759
|
/** @description User's postal/ZIP code. */
|
|
2677
2760
|
zip?: string;
|
|
2678
2761
|
};
|
|
2762
|
+
PaymentGateway: {
|
|
2763
|
+
code: string;
|
|
2764
|
+
kind: string;
|
|
2765
|
+
name: string;
|
|
2766
|
+
requires_crypto_currency: boolean;
|
|
2767
|
+
supported_crypto_currencies: string[];
|
|
2768
|
+
supported_currencies: string[];
|
|
2769
|
+
};
|
|
2679
2770
|
PaymentLinkResponse: {
|
|
2680
2771
|
/**
|
|
2681
2772
|
* Format: uri
|
|
@@ -2775,6 +2866,13 @@ interface components {
|
|
|
2775
2866
|
/** @description Native-language name of the region as it appears in the source data. */
|
|
2776
2867
|
original_name?: string;
|
|
2777
2868
|
};
|
|
2869
|
+
ResetDataRequest: {
|
|
2870
|
+
/**
|
|
2871
|
+
* Format: uuid
|
|
2872
|
+
* @description Package whose remaining data is reset to zero.
|
|
2873
|
+
*/
|
|
2874
|
+
package_id: string;
|
|
2875
|
+
};
|
|
2778
2876
|
ResetPasswordRequest: {
|
|
2779
2877
|
/** Format: uuid */
|
|
2780
2878
|
order_id: string;
|
|
@@ -2809,13 +2907,6 @@ interface components {
|
|
|
2809
2907
|
* @enum {string}
|
|
2810
2908
|
*/
|
|
2811
2909
|
RewardStatusEnum: "pending" | "paid" | "review" | "cancelled";
|
|
2812
|
-
SessionDeleteResponse: {
|
|
2813
|
-
deleted: boolean;
|
|
2814
|
-
};
|
|
2815
|
-
SessionListResponse: {
|
|
2816
|
-
count: number;
|
|
2817
|
-
results: string[];
|
|
2818
|
-
};
|
|
2819
2910
|
SettingsCrypto: {
|
|
2820
2911
|
currencies: string[];
|
|
2821
2912
|
};
|
|
@@ -2848,6 +2939,7 @@ interface components {
|
|
|
2848
2939
|
gateways: components["schemas"]["SettingsGateway"][];
|
|
2849
2940
|
orders_active: number;
|
|
2850
2941
|
orders_total: number;
|
|
2942
|
+
payment_gateways: components["schemas"]["PaymentGateway"][];
|
|
2851
2943
|
payment_methods: string[];
|
|
2852
2944
|
referrals: components["schemas"]["SettingsReferral"];
|
|
2853
2945
|
/** Format: double */
|
|
@@ -2870,8 +2962,12 @@ interface components {
|
|
|
2870
2962
|
token: string;
|
|
2871
2963
|
};
|
|
2872
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. */
|
|
2873
2966
|
data: number;
|
|
2874
|
-
/**
|
|
2967
|
+
/**
|
|
2968
|
+
* Format: uuid
|
|
2969
|
+
* @description Package of the managed virtual child order.
|
|
2970
|
+
*/
|
|
2875
2971
|
package_id: string;
|
|
2876
2972
|
};
|
|
2877
2973
|
TargetingOptions: {
|
|
@@ -2913,13 +3009,6 @@ interface components {
|
|
|
2913
3009
|
telegram_username?: string;
|
|
2914
3010
|
timezone: string;
|
|
2915
3011
|
};
|
|
2916
|
-
TelegramLinkConsumeRequest: {
|
|
2917
|
-
chat_id: number;
|
|
2918
|
-
language_code?: string;
|
|
2919
|
-
telegram_user_id: number;
|
|
2920
|
-
token: string;
|
|
2921
|
-
username?: string;
|
|
2922
|
-
};
|
|
2923
3012
|
TelegramLinkResponse: {
|
|
2924
3013
|
/** Format: uri */
|
|
2925
3014
|
bot_url: string;
|
|
@@ -2927,19 +3016,6 @@ interface components {
|
|
|
2927
3016
|
expires_at: string;
|
|
2928
3017
|
status: string;
|
|
2929
3018
|
};
|
|
2930
|
-
TelegramSessionRequest: {
|
|
2931
|
-
chat_id: number;
|
|
2932
|
-
telegram_user_id: number;
|
|
2933
|
-
};
|
|
2934
|
-
TelegramSessionResponse: {
|
|
2935
|
-
access: string;
|
|
2936
|
-
expires_in: number;
|
|
2937
|
-
locale: string;
|
|
2938
|
-
timezone: string;
|
|
2939
|
-
user: {
|
|
2940
|
-
[key: string]: unknown;
|
|
2941
|
-
};
|
|
2942
|
-
};
|
|
2943
3019
|
TokenPairResponse: {
|
|
2944
3020
|
/** @description Long-lived token used to request a new access token. */
|
|
2945
3021
|
refresh: string;
|
|
@@ -2984,6 +3060,13 @@ interface components {
|
|
|
2984
3060
|
};
|
|
2985
3061
|
TwoFactorDisableRequest: {
|
|
2986
3062
|
code: string;
|
|
3063
|
+
credential?: string;
|
|
3064
|
+
password?: string;
|
|
3065
|
+
};
|
|
3066
|
+
TwoFactorSetupRequestRequest: {
|
|
3067
|
+
code?: string;
|
|
3068
|
+
credential?: string;
|
|
3069
|
+
password?: string;
|
|
2987
3070
|
};
|
|
2988
3071
|
TwoFactorSetupResponse: {
|
|
2989
3072
|
otpauth_url: string;
|
|
@@ -3016,15 +3099,15 @@ interface components {
|
|
|
3016
3099
|
readonly currency: {
|
|
3017
3100
|
[key: string]: string;
|
|
3018
3101
|
};
|
|
3019
|
-
/** @description
|
|
3020
|
-
readonly data
|
|
3021
|
-
/** @description
|
|
3022
|
-
readonly data_spent
|
|
3102
|
+
/** @description Present only when SITE_PACKAGE_BASED_AUTH is disabled. */
|
|
3103
|
+
readonly data?: number | null;
|
|
3104
|
+
/** @description Present only when SITE_PACKAGE_BASED_AUTH is disabled. */
|
|
3105
|
+
readonly data_spent?: number | null;
|
|
3023
3106
|
/**
|
|
3024
3107
|
* Format: date-time
|
|
3025
|
-
* @description
|
|
3108
|
+
* @description Present only when SITE_PACKAGE_BASED_AUTH is disabled.
|
|
3026
3109
|
*/
|
|
3027
|
-
readonly data_updated
|
|
3110
|
+
readonly data_updated?: string | null;
|
|
3028
3111
|
/** Format: date-time */
|
|
3029
3112
|
readonly date_joined: string;
|
|
3030
3113
|
/** @description Timestamp of when the user joined */
|
|
@@ -3051,15 +3134,17 @@ interface components {
|
|
|
3051
3134
|
is_superuser?: boolean;
|
|
3052
3135
|
language?: components["schemas"]["LanguageEnum"];
|
|
3053
3136
|
last_name?: string;
|
|
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. */
|
|
3138
|
+
readonly orders?: components["schemas"]["Order"][];
|
|
3054
3139
|
/** @description ID of the parent user (for sub-accounts) */
|
|
3055
3140
|
readonly parent_id: string;
|
|
3056
|
-
/** @description
|
|
3057
|
-
readonly proxy_password
|
|
3141
|
+
/** @description Present only when SITE_PACKAGE_BASED_AUTH is disabled. */
|
|
3142
|
+
readonly proxy_password?: string | null;
|
|
3058
3143
|
/**
|
|
3059
3144
|
* Format: date-time
|
|
3060
|
-
* @description
|
|
3145
|
+
* @description Present only when SITE_PACKAGE_BASED_AUTH is disabled.
|
|
3061
3146
|
*/
|
|
3062
|
-
readonly proxy_password_reset
|
|
3147
|
+
readonly proxy_password_reset?: string | null;
|
|
3063
3148
|
readonly referral_balance_earned: number;
|
|
3064
3149
|
readonly referral_balance_pending: number;
|
|
3065
3150
|
readonly referral_code: string;
|
|
@@ -3089,7 +3174,7 @@ interface components {
|
|
|
3089
3174
|
connection_limit?: number;
|
|
3090
3175
|
/** @description User's country of residence. */
|
|
3091
3176
|
country?: string;
|
|
3092
|
-
/** @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. */
|
|
3093
3178
|
data?: number;
|
|
3094
3179
|
/**
|
|
3095
3180
|
* Format: email
|
|
@@ -3104,7 +3189,7 @@ interface components {
|
|
|
3104
3189
|
*/
|
|
3105
3190
|
is_reseller: boolean;
|
|
3106
3191
|
/**
|
|
3107
|
-
* @description
|
|
3192
|
+
* @description Superuser only: true creates an independent account with no parent. False (default) creates a sub-user under the caller.
|
|
3108
3193
|
* @default false
|
|
3109
3194
|
*/
|
|
3110
3195
|
is_top_level: boolean;
|
|
@@ -3116,7 +3201,7 @@ interface components {
|
|
|
3116
3201
|
};
|
|
3117
3202
|
/**
|
|
3118
3203
|
* Format: uuid
|
|
3119
|
-
* @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.
|
|
3120
3205
|
*/
|
|
3121
3206
|
package_id?: string;
|
|
3122
3207
|
/** @description Account password. Must be 8-128 characters long. */
|
|
@@ -3131,10 +3216,14 @@ interface components {
|
|
|
3131
3216
|
UserPasswordResetRequestRequest: {
|
|
3132
3217
|
/**
|
|
3133
3218
|
* Format: uuid
|
|
3134
|
-
* @description Package whose proxy password should be rotated.
|
|
3219
|
+
* @description Package whose order's proxy password should be rotated.
|
|
3135
3220
|
*/
|
|
3136
3221
|
package_id?: string;
|
|
3137
3222
|
};
|
|
3223
|
+
VerifyOTPRequest: {
|
|
3224
|
+
challenge: string;
|
|
3225
|
+
code: string;
|
|
3226
|
+
};
|
|
3138
3227
|
WebhookCreated: {
|
|
3139
3228
|
/** Format: date-time */
|
|
3140
3229
|
readonly created: string;
|
|
@@ -4238,6 +4327,8 @@ interface operations {
|
|
|
4238
4327
|
header?: {
|
|
4239
4328
|
/** @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. */
|
|
4240
4329
|
"Accept-Language"?: string;
|
|
4330
|
+
/** @description Stable key for one logical mutation. Successful responses are replayable for 24 hours; reusing a key with a different request returns 409. */
|
|
4331
|
+
"Idempotency-Key"?: string;
|
|
4241
4332
|
};
|
|
4242
4333
|
path: {
|
|
4243
4334
|
/** @description A unique value identifying this API Key. */
|
|
@@ -4250,6 +4341,8 @@ interface operations {
|
|
|
4250
4341
|
/** @description No response body */
|
|
4251
4342
|
204: {
|
|
4252
4343
|
headers: {
|
|
4344
|
+
/** @description True when the response was replayed from a prior request. */
|
|
4345
|
+
"Idempotency-Replayed"?: "true";
|
|
4253
4346
|
[name: string]: unknown;
|
|
4254
4347
|
};
|
|
4255
4348
|
content?: never;
|
|
@@ -4314,6 +4407,21 @@ interface operations {
|
|
|
4314
4407
|
};
|
|
4315
4408
|
};
|
|
4316
4409
|
};
|
|
4410
|
+
/** @description The idempotency key is in progress or was reused for a different request. */
|
|
4411
|
+
409: {
|
|
4412
|
+
headers: {
|
|
4413
|
+
"Content-Language": components["headers"]["ContentLanguage"];
|
|
4414
|
+
[name: string]: unknown;
|
|
4415
|
+
};
|
|
4416
|
+
content: {
|
|
4417
|
+
"application/json": {
|
|
4418
|
+
detail?: string;
|
|
4419
|
+
non_field_errors?: string[];
|
|
4420
|
+
} & {
|
|
4421
|
+
[key: string]: string | string[];
|
|
4422
|
+
};
|
|
4423
|
+
};
|
|
4424
|
+
};
|
|
4317
4425
|
};
|
|
4318
4426
|
};
|
|
4319
4427
|
coupons_list: {
|
|
@@ -4402,6 +4510,8 @@ interface operations {
|
|
|
4402
4510
|
header?: {
|
|
4403
4511
|
/** @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. */
|
|
4404
4512
|
"Accept-Language"?: string;
|
|
4513
|
+
/** @description Stable key for one logical mutation. Successful responses are replayable for 24 hours; reusing a key with a different request returns 409. */
|
|
4514
|
+
"Idempotency-Key"?: string;
|
|
4405
4515
|
};
|
|
4406
4516
|
path?: never;
|
|
4407
4517
|
cookie?: never;
|
|
@@ -4417,6 +4527,10 @@ interface operations {
|
|
|
4417
4527
|
/** @description The resource or action result was created successfully. */
|
|
4418
4528
|
201: {
|
|
4419
4529
|
headers: {
|
|
4530
|
+
/** @description Strong entity tag for optimistic concurrency control. */
|
|
4531
|
+
ETag?: string;
|
|
4532
|
+
/** @description True when the response was replayed from a prior request. */
|
|
4533
|
+
"Idempotency-Replayed"?: "true";
|
|
4420
4534
|
[name: string]: unknown;
|
|
4421
4535
|
};
|
|
4422
4536
|
content: {
|
|
@@ -4468,6 +4582,21 @@ interface operations {
|
|
|
4468
4582
|
};
|
|
4469
4583
|
};
|
|
4470
4584
|
};
|
|
4585
|
+
/** @description The idempotency key is in progress or was reused for a different request. */
|
|
4586
|
+
409: {
|
|
4587
|
+
headers: {
|
|
4588
|
+
"Content-Language": components["headers"]["ContentLanguage"];
|
|
4589
|
+
[name: string]: unknown;
|
|
4590
|
+
};
|
|
4591
|
+
content: {
|
|
4592
|
+
"application/json": {
|
|
4593
|
+
detail?: string;
|
|
4594
|
+
non_field_errors?: string[];
|
|
4595
|
+
} & {
|
|
4596
|
+
[key: string]: string | string[];
|
|
4597
|
+
};
|
|
4598
|
+
};
|
|
4599
|
+
};
|
|
4471
4600
|
};
|
|
4472
4601
|
};
|
|
4473
4602
|
coupons_retrieve: {
|
|
@@ -4488,6 +4617,8 @@ interface operations {
|
|
|
4488
4617
|
/** @description The operation completed successfully. */
|
|
4489
4618
|
200: {
|
|
4490
4619
|
headers: {
|
|
4620
|
+
/** @description Strong entity tag for optimistic concurrency control. */
|
|
4621
|
+
ETag?: string;
|
|
4491
4622
|
[name: string]: unknown;
|
|
4492
4623
|
};
|
|
4493
4624
|
content: {
|
|
@@ -4562,6 +4693,8 @@ interface operations {
|
|
|
4562
4693
|
header?: {
|
|
4563
4694
|
/** @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. */
|
|
4564
4695
|
"Accept-Language"?: string;
|
|
4696
|
+
/** @description Strong ETag from the latest representation of this resource. */
|
|
4697
|
+
"If-Match"?: string;
|
|
4565
4698
|
};
|
|
4566
4699
|
path: {
|
|
4567
4700
|
/** @description A unique value identifying this Coupon. */
|
|
@@ -4580,6 +4713,8 @@ interface operations {
|
|
|
4580
4713
|
/** @description The operation completed successfully. */
|
|
4581
4714
|
200: {
|
|
4582
4715
|
headers: {
|
|
4716
|
+
/** @description Strong entity tag for optimistic concurrency control. */
|
|
4717
|
+
ETag?: string;
|
|
4583
4718
|
[name: string]: unknown;
|
|
4584
4719
|
};
|
|
4585
4720
|
content: {
|
|
@@ -4646,6 +4781,23 @@ interface operations {
|
|
|
4646
4781
|
};
|
|
4647
4782
|
};
|
|
4648
4783
|
};
|
|
4784
|
+
/** @description The resource no longer matches the supplied ETag. */
|
|
4785
|
+
412: {
|
|
4786
|
+
headers: {
|
|
4787
|
+
"Content-Language": components["headers"]["ContentLanguage"];
|
|
4788
|
+
/** @description Strong entity tag for optimistic concurrency control. */
|
|
4789
|
+
ETag?: string;
|
|
4790
|
+
[name: string]: unknown;
|
|
4791
|
+
};
|
|
4792
|
+
content: {
|
|
4793
|
+
"application/json": {
|
|
4794
|
+
detail?: string;
|
|
4795
|
+
non_field_errors?: string[];
|
|
4796
|
+
} & {
|
|
4797
|
+
[key: string]: string | string[];
|
|
4798
|
+
};
|
|
4799
|
+
};
|
|
4800
|
+
};
|
|
4649
4801
|
};
|
|
4650
4802
|
};
|
|
4651
4803
|
coupons_destroy: {
|
|
@@ -4654,6 +4806,10 @@ interface operations {
|
|
|
4654
4806
|
header?: {
|
|
4655
4807
|
/** @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. */
|
|
4656
4808
|
"Accept-Language"?: string;
|
|
4809
|
+
/** @description Stable key for one logical mutation. Successful responses are replayable for 24 hours; reusing a key with a different request returns 409. */
|
|
4810
|
+
"Idempotency-Key"?: string;
|
|
4811
|
+
/** @description Strong ETag from the latest representation of this resource. */
|
|
4812
|
+
"If-Match"?: string;
|
|
4657
4813
|
};
|
|
4658
4814
|
path: {
|
|
4659
4815
|
/** @description A unique value identifying this Coupon. */
|
|
@@ -4666,6 +4822,8 @@ interface operations {
|
|
|
4666
4822
|
/** @description No response body */
|
|
4667
4823
|
204: {
|
|
4668
4824
|
headers: {
|
|
4825
|
+
/** @description True when the response was replayed from a prior request. */
|
|
4826
|
+
"Idempotency-Replayed"?: "true";
|
|
4669
4827
|
[name: string]: unknown;
|
|
4670
4828
|
};
|
|
4671
4829
|
content?: never;
|
|
@@ -4730,6 +4888,38 @@ interface operations {
|
|
|
4730
4888
|
};
|
|
4731
4889
|
};
|
|
4732
4890
|
};
|
|
4891
|
+
/** @description The idempotency key is in progress or was reused for a different request. */
|
|
4892
|
+
409: {
|
|
4893
|
+
headers: {
|
|
4894
|
+
"Content-Language": components["headers"]["ContentLanguage"];
|
|
4895
|
+
[name: string]: unknown;
|
|
4896
|
+
};
|
|
4897
|
+
content: {
|
|
4898
|
+
"application/json": {
|
|
4899
|
+
detail?: string;
|
|
4900
|
+
non_field_errors?: string[];
|
|
4901
|
+
} & {
|
|
4902
|
+
[key: string]: string | string[];
|
|
4903
|
+
};
|
|
4904
|
+
};
|
|
4905
|
+
};
|
|
4906
|
+
/** @description The resource no longer matches the supplied ETag. */
|
|
4907
|
+
412: {
|
|
4908
|
+
headers: {
|
|
4909
|
+
"Content-Language": components["headers"]["ContentLanguage"];
|
|
4910
|
+
/** @description Strong entity tag for optimistic concurrency control. */
|
|
4911
|
+
ETag?: string;
|
|
4912
|
+
[name: string]: unknown;
|
|
4913
|
+
};
|
|
4914
|
+
content: {
|
|
4915
|
+
"application/json": {
|
|
4916
|
+
detail?: string;
|
|
4917
|
+
non_field_errors?: string[];
|
|
4918
|
+
} & {
|
|
4919
|
+
[key: string]: string | string[];
|
|
4920
|
+
};
|
|
4921
|
+
};
|
|
4922
|
+
};
|
|
4733
4923
|
};
|
|
4734
4924
|
};
|
|
4735
4925
|
coupons_partial_update: {
|
|
@@ -4738,6 +4928,8 @@ interface operations {
|
|
|
4738
4928
|
header?: {
|
|
4739
4929
|
/** @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. */
|
|
4740
4930
|
"Accept-Language"?: string;
|
|
4931
|
+
/** @description Strong ETag from the latest representation of this resource. */
|
|
4932
|
+
"If-Match"?: string;
|
|
4741
4933
|
};
|
|
4742
4934
|
path: {
|
|
4743
4935
|
/** @description A unique value identifying this Coupon. */
|
|
@@ -4756,6 +4948,8 @@ interface operations {
|
|
|
4756
4948
|
/** @description The operation completed successfully. */
|
|
4757
4949
|
200: {
|
|
4758
4950
|
headers: {
|
|
4951
|
+
/** @description Strong entity tag for optimistic concurrency control. */
|
|
4952
|
+
ETag?: string;
|
|
4759
4953
|
[name: string]: unknown;
|
|
4760
4954
|
};
|
|
4761
4955
|
content: {
|
|
@@ -4822,6 +5016,23 @@ interface operations {
|
|
|
4822
5016
|
};
|
|
4823
5017
|
};
|
|
4824
5018
|
};
|
|
5019
|
+
/** @description The resource no longer matches the supplied ETag. */
|
|
5020
|
+
412: {
|
|
5021
|
+
headers: {
|
|
5022
|
+
"Content-Language": components["headers"]["ContentLanguage"];
|
|
5023
|
+
/** @description Strong entity tag for optimistic concurrency control. */
|
|
5024
|
+
ETag?: string;
|
|
5025
|
+
[name: string]: unknown;
|
|
5026
|
+
};
|
|
5027
|
+
content: {
|
|
5028
|
+
"application/json": {
|
|
5029
|
+
detail?: string;
|
|
5030
|
+
non_field_errors?: string[];
|
|
5031
|
+
} & {
|
|
5032
|
+
[key: string]: string | string[];
|
|
5033
|
+
};
|
|
5034
|
+
};
|
|
5035
|
+
};
|
|
4825
5036
|
};
|
|
4826
5037
|
};
|
|
4827
5038
|
coupons_redeems_list: {
|
|
@@ -5270,103 +5481,11 @@ interface operations {
|
|
|
5270
5481
|
};
|
|
5271
5482
|
};
|
|
5272
5483
|
};
|
|
5273
|
-
integrations_telegram_link_consume_create: {
|
|
5274
|
-
parameters: {
|
|
5275
|
-
query?: never;
|
|
5276
|
-
header: {
|
|
5277
|
-
/** @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. */
|
|
5278
|
-
"Accept-Language"?: string;
|
|
5279
|
-
/** @description Shared service credential configured on the ProxyRequest bot runtime. */
|
|
5280
|
-
"X-ProxyRequest-Telegram-Secret": string;
|
|
5281
|
-
};
|
|
5282
|
-
path?: never;
|
|
5283
|
-
cookie?: never;
|
|
5284
|
-
};
|
|
5285
|
-
requestBody: {
|
|
5286
|
-
content: {
|
|
5287
|
-
"application/json": components["schemas"]["TelegramLinkConsumeRequest"];
|
|
5288
|
-
"application/x-www-form-urlencoded": components["schemas"]["TelegramLinkConsumeRequest"];
|
|
5289
|
-
"multipart/form-data": components["schemas"]["TelegramLinkConsumeRequest"];
|
|
5290
|
-
};
|
|
5291
|
-
};
|
|
5292
|
-
responses: {
|
|
5293
|
-
/** @description The operation completed successfully. */
|
|
5294
|
-
200: {
|
|
5295
|
-
headers: {
|
|
5296
|
-
[name: string]: unknown;
|
|
5297
|
-
};
|
|
5298
|
-
content: {
|
|
5299
|
-
"application/json": components["schemas"]["TelegramConnectionResponse"];
|
|
5300
|
-
};
|
|
5301
|
-
};
|
|
5302
|
-
/** @description The request is malformed or violates a business rule. */
|
|
5303
|
-
400: {
|
|
5304
|
-
headers: {
|
|
5305
|
-
"Content-Language": components["headers"]["ContentLanguage"];
|
|
5306
|
-
[name: string]: unknown;
|
|
5307
|
-
};
|
|
5308
|
-
content: {
|
|
5309
|
-
"application/json": {
|
|
5310
|
-
detail?: string;
|
|
5311
|
-
non_field_errors?: string[];
|
|
5312
|
-
} & {
|
|
5313
|
-
[key: string]: string | string[];
|
|
5314
|
-
};
|
|
5315
|
-
};
|
|
5316
|
-
};
|
|
5317
|
-
};
|
|
5318
|
-
};
|
|
5319
|
-
integrations_telegram_session_create: {
|
|
5320
|
-
parameters: {
|
|
5321
|
-
query?: never;
|
|
5322
|
-
header: {
|
|
5323
|
-
/** @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. */
|
|
5324
|
-
"Accept-Language"?: string;
|
|
5325
|
-
/** @description Shared service credential configured on the ProxyRequest bot runtime. */
|
|
5326
|
-
"X-ProxyRequest-Telegram-Secret": string;
|
|
5327
|
-
};
|
|
5328
|
-
path?: never;
|
|
5329
|
-
cookie?: never;
|
|
5330
|
-
};
|
|
5331
|
-
requestBody: {
|
|
5332
|
-
content: {
|
|
5333
|
-
"application/json": components["schemas"]["TelegramSessionRequest"];
|
|
5334
|
-
"application/x-www-form-urlencoded": components["schemas"]["TelegramSessionRequest"];
|
|
5335
|
-
"multipart/form-data": components["schemas"]["TelegramSessionRequest"];
|
|
5336
|
-
};
|
|
5337
|
-
};
|
|
5338
|
-
responses: {
|
|
5339
|
-
/** @description The operation completed successfully. */
|
|
5340
|
-
200: {
|
|
5341
|
-
headers: {
|
|
5342
|
-
[name: string]: unknown;
|
|
5343
|
-
};
|
|
5344
|
-
content: {
|
|
5345
|
-
"application/json": components["schemas"]["TelegramSessionResponse"];
|
|
5346
|
-
};
|
|
5347
|
-
};
|
|
5348
|
-
/** @description The request is malformed or violates a business rule. */
|
|
5349
|
-
400: {
|
|
5350
|
-
headers: {
|
|
5351
|
-
"Content-Language": components["headers"]["ContentLanguage"];
|
|
5352
|
-
[name: string]: unknown;
|
|
5353
|
-
};
|
|
5354
|
-
content: {
|
|
5355
|
-
"application/json": {
|
|
5356
|
-
detail?: string;
|
|
5357
|
-
non_field_errors?: string[];
|
|
5358
|
-
} & {
|
|
5359
|
-
[key: string]: string | string[];
|
|
5360
|
-
};
|
|
5361
|
-
};
|
|
5362
|
-
};
|
|
5363
|
-
};
|
|
5364
|
-
};
|
|
5365
5484
|
invoices_list: {
|
|
5366
5485
|
parameters: {
|
|
5367
5486
|
query?: {
|
|
5368
|
-
/** @description The payment gateway used for processing the payment. * `coinbase` - Coinbase * `cryptomus` - Cryptomus * `stripe` - Stripe * `coingate` - Coingate * `wallet` - Wallet * `manual` - Manual */
|
|
5369
|
-
gateway?: "coinbase" | "coingate" | "cryptomus" | "manual" | "stripe" | "wallet";
|
|
5487
|
+
/** @description The payment gateway used for processing the payment. * `coinbase` - Coinbase * `cryptomus` - Cryptomus * `stripe` - Stripe * `coingate` - Coingate * `wallet` - Wallet * `manual` - Manual * `whitepay` - Whitepay * `wayforpay` - WayForPay * `usegateway` - UseGateway * `binance` - Binance Pay * `anymoney` - Any.Money * `coinpayments` - CoinPayments * `checkoutcom` - Checkout.com * `nowpayments` - NOWPayments * `btcpay` - BTCPay Server * `braintree` - Braintree * `monobank` - monobank * `liqpay` - LiqPay * `iyzico` - iyzico * `paytr` - PayTR * `payu` - PayU * `tpay` - Tpay * `przelewy24` - Przelewy24 * `gopay` - GoPay * `comgate` - Comgate * `monei` - MONEI * `redsys` - Redsys * `payplug` - PayPlug * `mollie` - Mollie * `unzer` - Unzer * `payone` - PAYONE * `nexi_xpay` - Nexi XPay * `halyk_epay` - Halyk ePay * `kaspi_pay` - Kaspi Pay * `vipps_mobilepay` - Vipps MobilePay * `paytrail` - Paytrail */
|
|
5488
|
+
gateway?: "anymoney" | "binance" | "braintree" | "btcpay" | "checkoutcom" | "coinbase" | "coingate" | "coinpayments" | "comgate" | "cryptomus" | "gopay" | "halyk_epay" | "iyzico" | "kaspi_pay" | "liqpay" | "manual" | "mollie" | "monei" | "monobank" | "nexi_xpay" | "nowpayments" | "payone" | "payplug" | "paytr" | "paytrail" | "payu" | "przelewy24" | "redsys" | "stripe" | "tpay" | "unzer" | "usegateway" | "vipps_mobilepay" | "wallet" | "wayforpay" | "whitepay";
|
|
5370
5489
|
internal_id?: string;
|
|
5371
5490
|
/** @description Number of results to return per page. */
|
|
5372
5491
|
limit?: number;
|
|
@@ -5399,7 +5518,7 @@ interface operations {
|
|
|
5399
5518
|
[name: string]: unknown;
|
|
5400
5519
|
};
|
|
5401
5520
|
content: {
|
|
5402
|
-
"application/json": components["schemas"]["
|
|
5521
|
+
"application/json": components["schemas"]["PaginatedInvoiceReadList"];
|
|
5403
5522
|
};
|
|
5404
5523
|
};
|
|
5405
5524
|
/** @description The request is malformed or violates a business rule. */
|
|
@@ -5455,6 +5574,8 @@ interface operations {
|
|
|
5455
5574
|
header?: {
|
|
5456
5575
|
/** @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. */
|
|
5457
5576
|
"Accept-Language"?: string;
|
|
5577
|
+
/** @description Stable key for one logical mutation. Successful responses are replayable for 24 hours; reusing a key with a different request returns 409. */
|
|
5578
|
+
"Idempotency-Key"?: string;
|
|
5458
5579
|
};
|
|
5459
5580
|
path?: never;
|
|
5460
5581
|
cookie?: never;
|
|
@@ -5470,6 +5591,10 @@ interface operations {
|
|
|
5470
5591
|
/** @description The resource or action result was created successfully. */
|
|
5471
5592
|
201: {
|
|
5472
5593
|
headers: {
|
|
5594
|
+
/** @description Strong entity tag for optimistic concurrency control. */
|
|
5595
|
+
ETag?: string;
|
|
5596
|
+
/** @description True when the response was replayed from a prior request. */
|
|
5597
|
+
"Idempotency-Replayed"?: "true";
|
|
5473
5598
|
[name: string]: unknown;
|
|
5474
5599
|
};
|
|
5475
5600
|
content: {
|
|
@@ -5521,6 +5646,37 @@ interface operations {
|
|
|
5521
5646
|
};
|
|
5522
5647
|
};
|
|
5523
5648
|
};
|
|
5649
|
+
/** @description The idempotency key is in progress or was reused for a different request. */
|
|
5650
|
+
409: {
|
|
5651
|
+
headers: {
|
|
5652
|
+
"Content-Language": components["headers"]["ContentLanguage"];
|
|
5653
|
+
[name: string]: unknown;
|
|
5654
|
+
};
|
|
5655
|
+
content: {
|
|
5656
|
+
"application/json": {
|
|
5657
|
+
detail?: string;
|
|
5658
|
+
non_field_errors?: string[];
|
|
5659
|
+
} & {
|
|
5660
|
+
[key: string]: string | string[];
|
|
5661
|
+
};
|
|
5662
|
+
};
|
|
5663
|
+
};
|
|
5664
|
+
/** @description The upstream payment provider could not initialize checkout. */
|
|
5665
|
+
502: {
|
|
5666
|
+
headers: {
|
|
5667
|
+
"Content-Language": components["headers"]["ContentLanguage"];
|
|
5668
|
+
[name: string]: unknown;
|
|
5669
|
+
};
|
|
5670
|
+
content: {
|
|
5671
|
+
"application/json": {
|
|
5672
|
+
gateway: string;
|
|
5673
|
+
/** Format: uuid */
|
|
5674
|
+
invoice_id: string;
|
|
5675
|
+
non_field_errors: string[];
|
|
5676
|
+
retryable: boolean;
|
|
5677
|
+
};
|
|
5678
|
+
};
|
|
5679
|
+
};
|
|
5524
5680
|
};
|
|
5525
5681
|
};
|
|
5526
5682
|
invoices_retrieve: {
|
|
@@ -5541,10 +5697,12 @@ interface operations {
|
|
|
5541
5697
|
/** @description The operation completed successfully. */
|
|
5542
5698
|
200: {
|
|
5543
5699
|
headers: {
|
|
5700
|
+
/** @description Strong entity tag for optimistic concurrency control. */
|
|
5701
|
+
ETag?: string;
|
|
5544
5702
|
[name: string]: unknown;
|
|
5545
5703
|
};
|
|
5546
5704
|
content: {
|
|
5547
|
-
"application/json": components["schemas"]["
|
|
5705
|
+
"application/json": components["schemas"]["InvoiceRead"];
|
|
5548
5706
|
};
|
|
5549
5707
|
};
|
|
5550
5708
|
/** @description The request is malformed or violates a business rule. */
|
|
@@ -5615,6 +5773,10 @@ interface operations {
|
|
|
5615
5773
|
header?: {
|
|
5616
5774
|
/** @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. */
|
|
5617
5775
|
"Accept-Language"?: string;
|
|
5776
|
+
/** @description Stable key for one logical mutation. Successful responses are replayable for 24 hours; reusing a key with a different request returns 409. */
|
|
5777
|
+
"Idempotency-Key"?: string;
|
|
5778
|
+
/** @description Strong ETag from the latest representation of this resource. */
|
|
5779
|
+
"If-Match"?: string;
|
|
5618
5780
|
};
|
|
5619
5781
|
path: {
|
|
5620
5782
|
/** @description A unique value identifying this Invoice. */
|
|
@@ -5627,6 +5789,8 @@ interface operations {
|
|
|
5627
5789
|
/** @description No response body */
|
|
5628
5790
|
204: {
|
|
5629
5791
|
headers: {
|
|
5792
|
+
/** @description True when the response was replayed from a prior request. */
|
|
5793
|
+
"Idempotency-Replayed"?: "true";
|
|
5630
5794
|
[name: string]: unknown;
|
|
5631
5795
|
};
|
|
5632
5796
|
content?: never;
|
|
@@ -5691,6 +5855,38 @@ interface operations {
|
|
|
5691
5855
|
};
|
|
5692
5856
|
};
|
|
5693
5857
|
};
|
|
5858
|
+
/** @description The idempotency key is in progress or was reused for a different request. */
|
|
5859
|
+
409: {
|
|
5860
|
+
headers: {
|
|
5861
|
+
"Content-Language": components["headers"]["ContentLanguage"];
|
|
5862
|
+
[name: string]: unknown;
|
|
5863
|
+
};
|
|
5864
|
+
content: {
|
|
5865
|
+
"application/json": {
|
|
5866
|
+
detail?: string;
|
|
5867
|
+
non_field_errors?: string[];
|
|
5868
|
+
} & {
|
|
5869
|
+
[key: string]: string | string[];
|
|
5870
|
+
};
|
|
5871
|
+
};
|
|
5872
|
+
};
|
|
5873
|
+
/** @description The resource no longer matches the supplied ETag. */
|
|
5874
|
+
412: {
|
|
5875
|
+
headers: {
|
|
5876
|
+
"Content-Language": components["headers"]["ContentLanguage"];
|
|
5877
|
+
/** @description Strong entity tag for optimistic concurrency control. */
|
|
5878
|
+
ETag?: string;
|
|
5879
|
+
[name: string]: unknown;
|
|
5880
|
+
};
|
|
5881
|
+
content: {
|
|
5882
|
+
"application/json": {
|
|
5883
|
+
detail?: string;
|
|
5884
|
+
non_field_errors?: string[];
|
|
5885
|
+
} & {
|
|
5886
|
+
[key: string]: string | string[];
|
|
5887
|
+
};
|
|
5888
|
+
};
|
|
5889
|
+
};
|
|
5694
5890
|
};
|
|
5695
5891
|
};
|
|
5696
5892
|
invoices_download_pdf_retrieve: {
|
|
@@ -5867,7 +6063,7 @@ interface operations {
|
|
|
5867
6063
|
};
|
|
5868
6064
|
locations_asn_list: {
|
|
5869
6065
|
parameters: {
|
|
5870
|
-
query
|
|
6066
|
+
query: {
|
|
5871
6067
|
code?: string;
|
|
5872
6068
|
country__code?: string;
|
|
5873
6069
|
/** @description Set to true to return only globally targetable ASNs. */
|
|
@@ -5879,8 +6075,8 @@ interface operations {
|
|
|
5879
6075
|
offset?: number;
|
|
5880
6076
|
/** @description Which field to use when ordering the results. */
|
|
5881
6077
|
ordering?: string;
|
|
5882
|
-
/** @description Package whose targeting availability should be returned.
|
|
5883
|
-
package_id
|
|
6078
|
+
/** @description Package whose targeting availability should be returned. */
|
|
6079
|
+
package_id: string;
|
|
5884
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. */
|
|
5885
6081
|
search?: string;
|
|
5886
6082
|
};
|
|
@@ -5951,7 +6147,7 @@ interface operations {
|
|
|
5951
6147
|
};
|
|
5952
6148
|
locations_cities_list: {
|
|
5953
6149
|
parameters: {
|
|
5954
|
-
query
|
|
6150
|
+
query: {
|
|
5955
6151
|
code?: string;
|
|
5956
6152
|
country__code?: string;
|
|
5957
6153
|
/** @description Number of results to return per page. */
|
|
@@ -5961,8 +6157,8 @@ interface operations {
|
|
|
5961
6157
|
offset?: number;
|
|
5962
6158
|
/** @description Which field to use when ordering the results. */
|
|
5963
6159
|
ordering?: string;
|
|
5964
|
-
/** @description Package whose targeting availability should be returned.
|
|
5965
|
-
package_id
|
|
6160
|
+
/** @description Package whose targeting availability should be returned. */
|
|
6161
|
+
package_id: string;
|
|
5966
6162
|
region__code?: string;
|
|
5967
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. */
|
|
5968
6164
|
search?: string;
|
|
@@ -6034,7 +6230,10 @@ interface operations {
|
|
|
6034
6230
|
};
|
|
6035
6231
|
locations_cities_retrieve: {
|
|
6036
6232
|
parameters: {
|
|
6037
|
-
query
|
|
6233
|
+
query: {
|
|
6234
|
+
/** @description Package whose targeting availability should be returned. */
|
|
6235
|
+
package_id: string;
|
|
6236
|
+
};
|
|
6038
6237
|
header?: {
|
|
6039
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. */
|
|
6040
6239
|
"Accept-Language"?: string;
|
|
@@ -6119,7 +6318,7 @@ interface operations {
|
|
|
6119
6318
|
};
|
|
6120
6319
|
locations_continents_list: {
|
|
6121
6320
|
parameters: {
|
|
6122
|
-
query
|
|
6321
|
+
query: {
|
|
6123
6322
|
code?: string;
|
|
6124
6323
|
/** @description Number of results to return per page. */
|
|
6125
6324
|
limit?: number;
|
|
@@ -6128,8 +6327,8 @@ interface operations {
|
|
|
6128
6327
|
offset?: number;
|
|
6129
6328
|
/** @description Which field to use when ordering the results. */
|
|
6130
6329
|
ordering?: string;
|
|
6131
|
-
/** @description Package whose targeting availability should be returned.
|
|
6132
|
-
package_id
|
|
6330
|
+
/** @description Package whose targeting availability should be returned. */
|
|
6331
|
+
package_id: string;
|
|
6133
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. */
|
|
6134
6333
|
search?: string;
|
|
6135
6334
|
};
|
|
@@ -6200,7 +6399,10 @@ interface operations {
|
|
|
6200
6399
|
};
|
|
6201
6400
|
locations_continents_retrieve: {
|
|
6202
6401
|
parameters: {
|
|
6203
|
-
query
|
|
6402
|
+
query: {
|
|
6403
|
+
/** @description Package whose targeting availability should be returned. */
|
|
6404
|
+
package_id: string;
|
|
6405
|
+
};
|
|
6204
6406
|
header?: {
|
|
6205
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. */
|
|
6206
6408
|
"Accept-Language"?: string;
|
|
@@ -6285,7 +6487,7 @@ interface operations {
|
|
|
6285
6487
|
};
|
|
6286
6488
|
locations_countries_list: {
|
|
6287
6489
|
parameters: {
|
|
6288
|
-
query
|
|
6490
|
+
query: {
|
|
6289
6491
|
code?: string;
|
|
6290
6492
|
/** @description Number of results to return per page. */
|
|
6291
6493
|
limit?: number;
|
|
@@ -6294,8 +6496,8 @@ interface operations {
|
|
|
6294
6496
|
offset?: number;
|
|
6295
6497
|
/** @description Which field to use when ordering the results. */
|
|
6296
6498
|
ordering?: string;
|
|
6297
|
-
/** @description Package whose targeting availability should be returned.
|
|
6298
|
-
package_id
|
|
6499
|
+
/** @description Package whose targeting availability should be returned. */
|
|
6500
|
+
package_id: string;
|
|
6299
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. */
|
|
6300
6502
|
search?: string;
|
|
6301
6503
|
};
|
|
@@ -6366,7 +6568,10 @@ interface operations {
|
|
|
6366
6568
|
};
|
|
6367
6569
|
locations_countries_retrieve: {
|
|
6368
6570
|
parameters: {
|
|
6369
|
-
query
|
|
6571
|
+
query: {
|
|
6572
|
+
/** @description Package whose targeting availability should be returned. */
|
|
6573
|
+
package_id: string;
|
|
6574
|
+
};
|
|
6370
6575
|
header?: {
|
|
6371
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. */
|
|
6372
6577
|
"Accept-Language"?: string;
|
|
@@ -6451,7 +6656,7 @@ interface operations {
|
|
|
6451
6656
|
};
|
|
6452
6657
|
locations_isps_list: {
|
|
6453
6658
|
parameters: {
|
|
6454
|
-
query
|
|
6659
|
+
query: {
|
|
6455
6660
|
code?: string;
|
|
6456
6661
|
country__code?: string;
|
|
6457
6662
|
/** @description Number of results to return per page. */
|
|
@@ -6461,8 +6666,8 @@ interface operations {
|
|
|
6461
6666
|
offset?: number;
|
|
6462
6667
|
/** @description Which field to use when ordering the results. */
|
|
6463
6668
|
ordering?: string;
|
|
6464
|
-
/** @description Package whose targeting availability should be returned.
|
|
6465
|
-
package_id
|
|
6669
|
+
/** @description Package whose targeting availability should be returned. */
|
|
6670
|
+
package_id: string;
|
|
6466
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. */
|
|
6467
6672
|
search?: string;
|
|
6468
6673
|
};
|
|
@@ -6533,7 +6738,7 @@ interface operations {
|
|
|
6533
6738
|
};
|
|
6534
6739
|
locations_regions_list: {
|
|
6535
6740
|
parameters: {
|
|
6536
|
-
query
|
|
6741
|
+
query: {
|
|
6537
6742
|
code?: string;
|
|
6538
6743
|
country__code?: string;
|
|
6539
6744
|
/** @description Number of results to return per page. */
|
|
@@ -6543,8 +6748,8 @@ interface operations {
|
|
|
6543
6748
|
offset?: number;
|
|
6544
6749
|
/** @description Which field to use when ordering the results. */
|
|
6545
6750
|
ordering?: string;
|
|
6546
|
-
/** @description Package whose targeting availability should be returned.
|
|
6547
|
-
package_id
|
|
6751
|
+
/** @description Package whose targeting availability should be returned. */
|
|
6752
|
+
package_id: string;
|
|
6548
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. */
|
|
6549
6754
|
search?: string;
|
|
6550
6755
|
};
|
|
@@ -6615,7 +6820,10 @@ interface operations {
|
|
|
6615
6820
|
};
|
|
6616
6821
|
locations_regions_retrieve: {
|
|
6617
6822
|
parameters: {
|
|
6618
|
-
query
|
|
6823
|
+
query: {
|
|
6824
|
+
/** @description Package whose targeting availability should be returned. */
|
|
6825
|
+
package_id: string;
|
|
6826
|
+
};
|
|
6619
6827
|
header?: {
|
|
6620
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. */
|
|
6621
6829
|
"Accept-Language"?: string;
|
|
@@ -6725,6 +6933,15 @@ interface operations {
|
|
|
6725
6933
|
"application/json": components["schemas"]["TokenPairResponse"];
|
|
6726
6934
|
};
|
|
6727
6935
|
};
|
|
6936
|
+
/** @description The request was accepted and the updated resource is returned. */
|
|
6937
|
+
202: {
|
|
6938
|
+
headers: {
|
|
6939
|
+
[name: string]: unknown;
|
|
6940
|
+
};
|
|
6941
|
+
content: {
|
|
6942
|
+
"application/json": components["schemas"]["OTPChallenge"];
|
|
6943
|
+
};
|
|
6944
|
+
};
|
|
6728
6945
|
/** @description The request is malformed or violates a business rule. */
|
|
6729
6946
|
400: {
|
|
6730
6947
|
headers: {
|
|
@@ -6769,6 +6986,15 @@ interface operations {
|
|
|
6769
6986
|
"application/json": components["schemas"]["TokenPairResponse"];
|
|
6770
6987
|
};
|
|
6771
6988
|
};
|
|
6989
|
+
/** @description The request was accepted and the updated resource is returned. */
|
|
6990
|
+
202: {
|
|
6991
|
+
headers: {
|
|
6992
|
+
[name: string]: unknown;
|
|
6993
|
+
};
|
|
6994
|
+
content: {
|
|
6995
|
+
"application/json": components["schemas"]["OTPChallenge"];
|
|
6996
|
+
};
|
|
6997
|
+
};
|
|
6772
6998
|
/** @description The request is malformed or violates a business rule. */
|
|
6773
6999
|
400: {
|
|
6774
7000
|
headers: {
|
|
@@ -6801,6 +7027,50 @@ interface operations {
|
|
|
6801
7027
|
};
|
|
6802
7028
|
};
|
|
6803
7029
|
};
|
|
7030
|
+
login_otp_create: {
|
|
7031
|
+
parameters: {
|
|
7032
|
+
query?: never;
|
|
7033
|
+
header?: {
|
|
7034
|
+
/** @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. */
|
|
7035
|
+
"Accept-Language"?: string;
|
|
7036
|
+
};
|
|
7037
|
+
path?: never;
|
|
7038
|
+
cookie?: never;
|
|
7039
|
+
};
|
|
7040
|
+
requestBody: {
|
|
7041
|
+
content: {
|
|
7042
|
+
"application/json": components["schemas"]["VerifyOTPRequest"];
|
|
7043
|
+
"application/x-www-form-urlencoded": components["schemas"]["VerifyOTPRequest"];
|
|
7044
|
+
"multipart/form-data": components["schemas"]["VerifyOTPRequest"];
|
|
7045
|
+
};
|
|
7046
|
+
};
|
|
7047
|
+
responses: {
|
|
7048
|
+
/** @description The operation completed successfully. */
|
|
7049
|
+
200: {
|
|
7050
|
+
headers: {
|
|
7051
|
+
[name: string]: unknown;
|
|
7052
|
+
};
|
|
7053
|
+
content: {
|
|
7054
|
+
"application/json": components["schemas"]["TokenPairResponse"];
|
|
7055
|
+
};
|
|
7056
|
+
};
|
|
7057
|
+
/** @description The request is malformed or violates a business rule. */
|
|
7058
|
+
400: {
|
|
7059
|
+
headers: {
|
|
7060
|
+
"Content-Language": components["headers"]["ContentLanguage"];
|
|
7061
|
+
[name: string]: unknown;
|
|
7062
|
+
};
|
|
7063
|
+
content: {
|
|
7064
|
+
"application/json": {
|
|
7065
|
+
detail?: string;
|
|
7066
|
+
non_field_errors?: string[];
|
|
7067
|
+
} & {
|
|
7068
|
+
[key: string]: string | string[];
|
|
7069
|
+
};
|
|
7070
|
+
};
|
|
7071
|
+
};
|
|
7072
|
+
};
|
|
7073
|
+
};
|
|
6804
7074
|
news_list: {
|
|
6805
7075
|
parameters: {
|
|
6806
7076
|
query?: {
|
|
@@ -6979,6 +7249,8 @@ interface operations {
|
|
|
6979
7249
|
/** @description The operation completed successfully. */
|
|
6980
7250
|
200: {
|
|
6981
7251
|
headers: {
|
|
7252
|
+
/** @description Strong entity tag for optimistic concurrency control. */
|
|
7253
|
+
ETag?: string;
|
|
6982
7254
|
[name: string]: unknown;
|
|
6983
7255
|
};
|
|
6984
7256
|
content: {
|
|
@@ -7053,6 +7325,10 @@ interface operations {
|
|
|
7053
7325
|
header?: {
|
|
7054
7326
|
/** @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. */
|
|
7055
7327
|
"Accept-Language"?: string;
|
|
7328
|
+
/** @description Stable key for one logical mutation. Successful responses are replayable for 24 hours; reusing a key with a different request returns 409. */
|
|
7329
|
+
"Idempotency-Key"?: string;
|
|
7330
|
+
/** @description Strong ETag from the latest representation of this resource. */
|
|
7331
|
+
"If-Match"?: string;
|
|
7056
7332
|
};
|
|
7057
7333
|
path: {
|
|
7058
7334
|
/** @description A unique value identifying this Order. */
|
|
@@ -7065,6 +7341,8 @@ interface operations {
|
|
|
7065
7341
|
/** @description No response body */
|
|
7066
7342
|
204: {
|
|
7067
7343
|
headers: {
|
|
7344
|
+
/** @description True when the response was replayed from a prior request. */
|
|
7345
|
+
"Idempotency-Replayed"?: "true";
|
|
7068
7346
|
[name: string]: unknown;
|
|
7069
7347
|
};
|
|
7070
7348
|
content?: never;
|
|
@@ -7129,21 +7407,55 @@ interface operations {
|
|
|
7129
7407
|
};
|
|
7130
7408
|
};
|
|
7131
7409
|
};
|
|
7132
|
-
|
|
7133
|
-
|
|
7134
|
-
|
|
7135
|
-
|
|
7136
|
-
|
|
7137
|
-
|
|
7138
|
-
|
|
7139
|
-
|
|
7140
|
-
|
|
7141
|
-
|
|
7142
|
-
|
|
7143
|
-
|
|
7144
|
-
|
|
7145
|
-
|
|
7146
|
-
|
|
7410
|
+
/** @description The idempotency key is in progress or was reused for a different request. */
|
|
7411
|
+
409: {
|
|
7412
|
+
headers: {
|
|
7413
|
+
"Content-Language": components["headers"]["ContentLanguage"];
|
|
7414
|
+
[name: string]: unknown;
|
|
7415
|
+
};
|
|
7416
|
+
content: {
|
|
7417
|
+
"application/json": {
|
|
7418
|
+
detail?: string;
|
|
7419
|
+
non_field_errors?: string[];
|
|
7420
|
+
} & {
|
|
7421
|
+
[key: string]: string | string[];
|
|
7422
|
+
};
|
|
7423
|
+
};
|
|
7424
|
+
};
|
|
7425
|
+
/** @description The resource no longer matches the supplied ETag. */
|
|
7426
|
+
412: {
|
|
7427
|
+
headers: {
|
|
7428
|
+
"Content-Language": components["headers"]["ContentLanguage"];
|
|
7429
|
+
/** @description Strong entity tag for optimistic concurrency control. */
|
|
7430
|
+
ETag?: string;
|
|
7431
|
+
[name: string]: unknown;
|
|
7432
|
+
};
|
|
7433
|
+
content: {
|
|
7434
|
+
"application/json": {
|
|
7435
|
+
detail?: string;
|
|
7436
|
+
non_field_errors?: string[];
|
|
7437
|
+
} & {
|
|
7438
|
+
[key: string]: string | string[];
|
|
7439
|
+
};
|
|
7440
|
+
};
|
|
7441
|
+
};
|
|
7442
|
+
};
|
|
7443
|
+
};
|
|
7444
|
+
orders_partial_update: {
|
|
7445
|
+
parameters: {
|
|
7446
|
+
query?: never;
|
|
7447
|
+
header?: {
|
|
7448
|
+
/** @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. */
|
|
7449
|
+
"Accept-Language"?: string;
|
|
7450
|
+
/** @description Strong ETag from the latest representation of this resource. */
|
|
7451
|
+
"If-Match"?: string;
|
|
7452
|
+
};
|
|
7453
|
+
path: {
|
|
7454
|
+
/** @description A unique value identifying this Order. */
|
|
7455
|
+
id: string;
|
|
7456
|
+
};
|
|
7457
|
+
cookie?: never;
|
|
7458
|
+
};
|
|
7147
7459
|
requestBody?: {
|
|
7148
7460
|
content: {
|
|
7149
7461
|
"application/json": components["schemas"]["PatchedOrderAutoRenewalRequest"];
|
|
@@ -7155,6 +7467,8 @@ interface operations {
|
|
|
7155
7467
|
/** @description The operation completed successfully. */
|
|
7156
7468
|
200: {
|
|
7157
7469
|
headers: {
|
|
7470
|
+
/** @description Strong entity tag for optimistic concurrency control. */
|
|
7471
|
+
ETag?: string;
|
|
7158
7472
|
[name: string]: unknown;
|
|
7159
7473
|
};
|
|
7160
7474
|
content: {
|
|
@@ -7221,6 +7535,23 @@ interface operations {
|
|
|
7221
7535
|
};
|
|
7222
7536
|
};
|
|
7223
7537
|
};
|
|
7538
|
+
/** @description The resource no longer matches the supplied ETag. */
|
|
7539
|
+
412: {
|
|
7540
|
+
headers: {
|
|
7541
|
+
"Content-Language": components["headers"]["ContentLanguage"];
|
|
7542
|
+
/** @description Strong entity tag for optimistic concurrency control. */
|
|
7543
|
+
ETag?: string;
|
|
7544
|
+
[name: string]: unknown;
|
|
7545
|
+
};
|
|
7546
|
+
content: {
|
|
7547
|
+
"application/json": {
|
|
7548
|
+
detail?: string;
|
|
7549
|
+
non_field_errors?: string[];
|
|
7550
|
+
} & {
|
|
7551
|
+
[key: string]: string | string[];
|
|
7552
|
+
};
|
|
7553
|
+
};
|
|
7554
|
+
};
|
|
7224
7555
|
};
|
|
7225
7556
|
};
|
|
7226
7557
|
packages_list: {
|
|
@@ -7400,6 +7731,8 @@ interface operations {
|
|
|
7400
7731
|
/** @description The operation completed successfully. */
|
|
7401
7732
|
200: {
|
|
7402
7733
|
headers: {
|
|
7734
|
+
/** @description Strong entity tag for optimistic concurrency control. */
|
|
7735
|
+
ETag?: string;
|
|
7403
7736
|
[name: string]: unknown;
|
|
7404
7737
|
};
|
|
7405
7738
|
content: {
|
|
@@ -7459,6 +7792,8 @@ interface operations {
|
|
|
7459
7792
|
header?: {
|
|
7460
7793
|
/** @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. */
|
|
7461
7794
|
"Accept-Language"?: string;
|
|
7795
|
+
/** @description Strong ETag from the latest representation of this resource. */
|
|
7796
|
+
"If-Match"?: string;
|
|
7462
7797
|
};
|
|
7463
7798
|
path?: never;
|
|
7464
7799
|
cookie?: never;
|
|
@@ -7517,6 +7852,23 @@ interface operations {
|
|
|
7517
7852
|
};
|
|
7518
7853
|
};
|
|
7519
7854
|
};
|
|
7855
|
+
/** @description The resource no longer matches the supplied ETag. */
|
|
7856
|
+
412: {
|
|
7857
|
+
headers: {
|
|
7858
|
+
"Content-Language": components["headers"]["ContentLanguage"];
|
|
7859
|
+
/** @description Strong entity tag for optimistic concurrency control. */
|
|
7860
|
+
ETag?: string;
|
|
7861
|
+
[name: string]: unknown;
|
|
7862
|
+
};
|
|
7863
|
+
content: {
|
|
7864
|
+
"application/json": {
|
|
7865
|
+
detail?: string;
|
|
7866
|
+
non_field_errors?: string[];
|
|
7867
|
+
} & {
|
|
7868
|
+
[key: string]: string | string[];
|
|
7869
|
+
};
|
|
7870
|
+
};
|
|
7871
|
+
};
|
|
7520
7872
|
};
|
|
7521
7873
|
};
|
|
7522
7874
|
profile_partial_update: {
|
|
@@ -7525,6 +7877,8 @@ interface operations {
|
|
|
7525
7877
|
header?: {
|
|
7526
7878
|
/** @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. */
|
|
7527
7879
|
"Accept-Language"?: string;
|
|
7880
|
+
/** @description Strong ETag from the latest representation of this resource. */
|
|
7881
|
+
"If-Match"?: string;
|
|
7528
7882
|
};
|
|
7529
7883
|
path?: never;
|
|
7530
7884
|
cookie?: never;
|
|
@@ -7540,6 +7894,8 @@ interface operations {
|
|
|
7540
7894
|
/** @description The request was accepted and the updated resource is returned. */
|
|
7541
7895
|
202: {
|
|
7542
7896
|
headers: {
|
|
7897
|
+
/** @description Strong entity tag for optimistic concurrency control. */
|
|
7898
|
+
ETag?: string;
|
|
7543
7899
|
[name: string]: unknown;
|
|
7544
7900
|
};
|
|
7545
7901
|
content: {
|
|
@@ -7591,6 +7947,23 @@ interface operations {
|
|
|
7591
7947
|
};
|
|
7592
7948
|
};
|
|
7593
7949
|
};
|
|
7950
|
+
/** @description The resource no longer matches the supplied ETag. */
|
|
7951
|
+
412: {
|
|
7952
|
+
headers: {
|
|
7953
|
+
"Content-Language": components["headers"]["ContentLanguage"];
|
|
7954
|
+
/** @description Strong entity tag for optimistic concurrency control. */
|
|
7955
|
+
ETag?: string;
|
|
7956
|
+
[name: string]: unknown;
|
|
7957
|
+
};
|
|
7958
|
+
content: {
|
|
7959
|
+
"application/json": {
|
|
7960
|
+
detail?: string;
|
|
7961
|
+
non_field_errors?: string[];
|
|
7962
|
+
} & {
|
|
7963
|
+
[key: string]: string | string[];
|
|
7964
|
+
};
|
|
7965
|
+
};
|
|
7966
|
+
};
|
|
7594
7967
|
};
|
|
7595
7968
|
};
|
|
7596
7969
|
profile_2fa_confirm_create: {
|
|
@@ -7751,7 +8124,13 @@ interface operations {
|
|
|
7751
8124
|
path?: never;
|
|
7752
8125
|
cookie?: never;
|
|
7753
8126
|
};
|
|
7754
|
-
requestBody?:
|
|
8127
|
+
requestBody?: {
|
|
8128
|
+
content: {
|
|
8129
|
+
"application/json": components["schemas"]["TwoFactorSetupRequestRequest"];
|
|
8130
|
+
"application/x-www-form-urlencoded": components["schemas"]["TwoFactorSetupRequestRequest"];
|
|
8131
|
+
"multipart/form-data": components["schemas"]["TwoFactorSetupRequestRequest"];
|
|
8132
|
+
};
|
|
8133
|
+
};
|
|
7755
8134
|
responses: {
|
|
7756
8135
|
/** @description The operation completed successfully. */
|
|
7757
8136
|
200: {
|
|
@@ -8353,160 +8732,6 @@ interface operations {
|
|
|
8353
8732
|
};
|
|
8354
8733
|
};
|
|
8355
8734
|
};
|
|
8356
|
-
sessions_list: {
|
|
8357
|
-
parameters: {
|
|
8358
|
-
query?: never;
|
|
8359
|
-
header?: {
|
|
8360
|
-
/** @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. */
|
|
8361
|
-
"Accept-Language"?: string;
|
|
8362
|
-
};
|
|
8363
|
-
path?: never;
|
|
8364
|
-
cookie?: never;
|
|
8365
|
-
};
|
|
8366
|
-
requestBody?: never;
|
|
8367
|
-
responses: {
|
|
8368
|
-
/** @description The operation completed successfully. */
|
|
8369
|
-
200: {
|
|
8370
|
-
headers: {
|
|
8371
|
-
[name: string]: unknown;
|
|
8372
|
-
};
|
|
8373
|
-
content: {
|
|
8374
|
-
"application/json": components["schemas"]["SessionListResponse"][];
|
|
8375
|
-
};
|
|
8376
|
-
};
|
|
8377
|
-
/** @description The request is malformed or violates a business rule. */
|
|
8378
|
-
400: {
|
|
8379
|
-
headers: {
|
|
8380
|
-
"Content-Language": components["headers"]["ContentLanguage"];
|
|
8381
|
-
[name: string]: unknown;
|
|
8382
|
-
};
|
|
8383
|
-
content: {
|
|
8384
|
-
"application/json": {
|
|
8385
|
-
detail?: string;
|
|
8386
|
-
non_field_errors?: string[];
|
|
8387
|
-
} & {
|
|
8388
|
-
[key: string]: string | string[];
|
|
8389
|
-
};
|
|
8390
|
-
};
|
|
8391
|
-
};
|
|
8392
|
-
/** @description Authentication credentials are missing, expired, or invalid. */
|
|
8393
|
-
401: {
|
|
8394
|
-
headers: {
|
|
8395
|
-
"Content-Language": components["headers"]["ContentLanguage"];
|
|
8396
|
-
[name: string]: unknown;
|
|
8397
|
-
};
|
|
8398
|
-
content: {
|
|
8399
|
-
"application/json": {
|
|
8400
|
-
detail?: string;
|
|
8401
|
-
non_field_errors?: string[];
|
|
8402
|
-
} & {
|
|
8403
|
-
[key: string]: string | string[];
|
|
8404
|
-
};
|
|
8405
|
-
};
|
|
8406
|
-
};
|
|
8407
|
-
/** @description The authenticated account cannot perform this operation. */
|
|
8408
|
-
403: {
|
|
8409
|
-
headers: {
|
|
8410
|
-
"Content-Language": components["headers"]["ContentLanguage"];
|
|
8411
|
-
[name: string]: unknown;
|
|
8412
|
-
};
|
|
8413
|
-
content: {
|
|
8414
|
-
"application/json": {
|
|
8415
|
-
detail?: string;
|
|
8416
|
-
non_field_errors?: string[];
|
|
8417
|
-
} & {
|
|
8418
|
-
[key: string]: string | string[];
|
|
8419
|
-
};
|
|
8420
|
-
};
|
|
8421
|
-
};
|
|
8422
|
-
};
|
|
8423
|
-
};
|
|
8424
|
-
sessions_destroy: {
|
|
8425
|
-
parameters: {
|
|
8426
|
-
query?: never;
|
|
8427
|
-
header?: {
|
|
8428
|
-
/** @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. */
|
|
8429
|
-
"Accept-Language"?: string;
|
|
8430
|
-
};
|
|
8431
|
-
path: {
|
|
8432
|
-
/** @description Sticky session identifier or unique suffix. */
|
|
8433
|
-
id: string;
|
|
8434
|
-
};
|
|
8435
|
-
cookie?: never;
|
|
8436
|
-
};
|
|
8437
|
-
requestBody?: never;
|
|
8438
|
-
responses: {
|
|
8439
|
-
/** @description The operation completed successfully. */
|
|
8440
|
-
200: {
|
|
8441
|
-
headers: {
|
|
8442
|
-
[name: string]: unknown;
|
|
8443
|
-
};
|
|
8444
|
-
content: {
|
|
8445
|
-
"application/json": components["schemas"]["SessionDeleteResponse"];
|
|
8446
|
-
};
|
|
8447
|
-
};
|
|
8448
|
-
/** @description The request is malformed or violates a business rule. */
|
|
8449
|
-
400: {
|
|
8450
|
-
headers: {
|
|
8451
|
-
"Content-Language": components["headers"]["ContentLanguage"];
|
|
8452
|
-
[name: string]: unknown;
|
|
8453
|
-
};
|
|
8454
|
-
content: {
|
|
8455
|
-
"application/json": {
|
|
8456
|
-
detail?: string;
|
|
8457
|
-
non_field_errors?: string[];
|
|
8458
|
-
} & {
|
|
8459
|
-
[key: string]: string | string[];
|
|
8460
|
-
};
|
|
8461
|
-
};
|
|
8462
|
-
};
|
|
8463
|
-
/** @description Authentication credentials are missing, expired, or invalid. */
|
|
8464
|
-
401: {
|
|
8465
|
-
headers: {
|
|
8466
|
-
"Content-Language": components["headers"]["ContentLanguage"];
|
|
8467
|
-
[name: string]: unknown;
|
|
8468
|
-
};
|
|
8469
|
-
content: {
|
|
8470
|
-
"application/json": {
|
|
8471
|
-
detail?: string;
|
|
8472
|
-
non_field_errors?: string[];
|
|
8473
|
-
} & {
|
|
8474
|
-
[key: string]: string | string[];
|
|
8475
|
-
};
|
|
8476
|
-
};
|
|
8477
|
-
};
|
|
8478
|
-
/** @description The authenticated account cannot perform this operation. */
|
|
8479
|
-
403: {
|
|
8480
|
-
headers: {
|
|
8481
|
-
"Content-Language": components["headers"]["ContentLanguage"];
|
|
8482
|
-
[name: string]: unknown;
|
|
8483
|
-
};
|
|
8484
|
-
content: {
|
|
8485
|
-
"application/json": {
|
|
8486
|
-
detail?: string;
|
|
8487
|
-
non_field_errors?: string[];
|
|
8488
|
-
} & {
|
|
8489
|
-
[key: string]: string | string[];
|
|
8490
|
-
};
|
|
8491
|
-
};
|
|
8492
|
-
};
|
|
8493
|
-
/** @description The requested resource does not exist in the current account scope. */
|
|
8494
|
-
404: {
|
|
8495
|
-
headers: {
|
|
8496
|
-
"Content-Language": components["headers"]["ContentLanguage"];
|
|
8497
|
-
[name: string]: unknown;
|
|
8498
|
-
};
|
|
8499
|
-
content: {
|
|
8500
|
-
"application/json": {
|
|
8501
|
-
detail?: string;
|
|
8502
|
-
non_field_errors?: string[];
|
|
8503
|
-
} & {
|
|
8504
|
-
[key: string]: string | string[];
|
|
8505
|
-
};
|
|
8506
|
-
};
|
|
8507
|
-
};
|
|
8508
|
-
};
|
|
8509
|
-
};
|
|
8510
8735
|
settings_retrieve: {
|
|
8511
8736
|
parameters: {
|
|
8512
8737
|
query?: never;
|
|
@@ -8737,6 +8962,8 @@ interface operations {
|
|
|
8737
8962
|
header?: {
|
|
8738
8963
|
/** @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. */
|
|
8739
8964
|
"Accept-Language"?: string;
|
|
8965
|
+
/** @description Stable key for one logical mutation. Successful responses are replayable for 24 hours; reusing a key with a different request returns 409. */
|
|
8966
|
+
"Idempotency-Key"?: string;
|
|
8740
8967
|
};
|
|
8741
8968
|
path?: never;
|
|
8742
8969
|
cookie?: never;
|
|
@@ -8752,6 +8979,10 @@ interface operations {
|
|
|
8752
8979
|
/** @description The resource or action result was created successfully. */
|
|
8753
8980
|
201: {
|
|
8754
8981
|
headers: {
|
|
8982
|
+
/** @description Strong entity tag for optimistic concurrency control. */
|
|
8983
|
+
ETag?: string;
|
|
8984
|
+
/** @description True when the response was replayed from a prior request. */
|
|
8985
|
+
"Idempotency-Replayed"?: "true";
|
|
8755
8986
|
[name: string]: unknown;
|
|
8756
8987
|
};
|
|
8757
8988
|
content: {
|
|
@@ -8803,6 +9034,21 @@ interface operations {
|
|
|
8803
9034
|
};
|
|
8804
9035
|
};
|
|
8805
9036
|
};
|
|
9037
|
+
/** @description The idempotency key is in progress or was reused for a different request. */
|
|
9038
|
+
409: {
|
|
9039
|
+
headers: {
|
|
9040
|
+
"Content-Language": components["headers"]["ContentLanguage"];
|
|
9041
|
+
[name: string]: unknown;
|
|
9042
|
+
};
|
|
9043
|
+
content: {
|
|
9044
|
+
"application/json": {
|
|
9045
|
+
detail?: string;
|
|
9046
|
+
non_field_errors?: string[];
|
|
9047
|
+
} & {
|
|
9048
|
+
[key: string]: string | string[];
|
|
9049
|
+
};
|
|
9050
|
+
};
|
|
9051
|
+
};
|
|
8806
9052
|
};
|
|
8807
9053
|
};
|
|
8808
9054
|
users_retrieve: {
|
|
@@ -8823,6 +9069,8 @@ interface operations {
|
|
|
8823
9069
|
/** @description The operation completed successfully. */
|
|
8824
9070
|
200: {
|
|
8825
9071
|
headers: {
|
|
9072
|
+
/** @description Strong entity tag for optimistic concurrency control. */
|
|
9073
|
+
ETag?: string;
|
|
8826
9074
|
[name: string]: unknown;
|
|
8827
9075
|
};
|
|
8828
9076
|
content: {
|
|
@@ -8897,6 +9145,10 @@ interface operations {
|
|
|
8897
9145
|
header?: {
|
|
8898
9146
|
/** @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. */
|
|
8899
9147
|
"Accept-Language"?: string;
|
|
9148
|
+
/** @description Stable key for one logical mutation. Successful responses are replayable for 24 hours; reusing a key with a different request returns 409. */
|
|
9149
|
+
"Idempotency-Key"?: string;
|
|
9150
|
+
/** @description Strong ETag from the latest representation of this resource. */
|
|
9151
|
+
"If-Match"?: string;
|
|
8900
9152
|
};
|
|
8901
9153
|
path: {
|
|
8902
9154
|
/** @description A UUID string identifying this user. */
|
|
@@ -8909,6 +9161,8 @@ interface operations {
|
|
|
8909
9161
|
/** @description No response body */
|
|
8910
9162
|
204: {
|
|
8911
9163
|
headers: {
|
|
9164
|
+
/** @description True when the response was replayed from a prior request. */
|
|
9165
|
+
"Idempotency-Replayed"?: "true";
|
|
8912
9166
|
[name: string]: unknown;
|
|
8913
9167
|
};
|
|
8914
9168
|
content?: never;
|
|
@@ -8973,6 +9227,38 @@ interface operations {
|
|
|
8973
9227
|
};
|
|
8974
9228
|
};
|
|
8975
9229
|
};
|
|
9230
|
+
/** @description The idempotency key is in progress or was reused for a different request. */
|
|
9231
|
+
409: {
|
|
9232
|
+
headers: {
|
|
9233
|
+
"Content-Language": components["headers"]["ContentLanguage"];
|
|
9234
|
+
[name: string]: unknown;
|
|
9235
|
+
};
|
|
9236
|
+
content: {
|
|
9237
|
+
"application/json": {
|
|
9238
|
+
detail?: string;
|
|
9239
|
+
non_field_errors?: string[];
|
|
9240
|
+
} & {
|
|
9241
|
+
[key: string]: string | string[];
|
|
9242
|
+
};
|
|
9243
|
+
};
|
|
9244
|
+
};
|
|
9245
|
+
/** @description The resource no longer matches the supplied ETag. */
|
|
9246
|
+
412: {
|
|
9247
|
+
headers: {
|
|
9248
|
+
"Content-Language": components["headers"]["ContentLanguage"];
|
|
9249
|
+
/** @description Strong entity tag for optimistic concurrency control. */
|
|
9250
|
+
ETag?: string;
|
|
9251
|
+
[name: string]: unknown;
|
|
9252
|
+
};
|
|
9253
|
+
content: {
|
|
9254
|
+
"application/json": {
|
|
9255
|
+
detail?: string;
|
|
9256
|
+
non_field_errors?: string[];
|
|
9257
|
+
} & {
|
|
9258
|
+
[key: string]: string | string[];
|
|
9259
|
+
};
|
|
9260
|
+
};
|
|
9261
|
+
};
|
|
8976
9262
|
};
|
|
8977
9263
|
};
|
|
8978
9264
|
users_partial_update: {
|
|
@@ -8981,6 +9267,8 @@ interface operations {
|
|
|
8981
9267
|
header?: {
|
|
8982
9268
|
/** @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. */
|
|
8983
9269
|
"Accept-Language"?: string;
|
|
9270
|
+
/** @description Strong ETag from the latest representation of this resource. */
|
|
9271
|
+
"If-Match"?: string;
|
|
8984
9272
|
};
|
|
8985
9273
|
path: {
|
|
8986
9274
|
/** @description A UUID string identifying this user. */
|
|
@@ -8999,6 +9287,8 @@ interface operations {
|
|
|
8999
9287
|
/** @description The request was accepted and the updated resource is returned. */
|
|
9000
9288
|
202: {
|
|
9001
9289
|
headers: {
|
|
9290
|
+
/** @description Strong entity tag for optimistic concurrency control. */
|
|
9291
|
+
ETag?: string;
|
|
9002
9292
|
[name: string]: unknown;
|
|
9003
9293
|
};
|
|
9004
9294
|
content: {
|
|
@@ -9065,6 +9355,23 @@ interface operations {
|
|
|
9065
9355
|
};
|
|
9066
9356
|
};
|
|
9067
9357
|
};
|
|
9358
|
+
/** @description The resource no longer matches the supplied ETag. */
|
|
9359
|
+
412: {
|
|
9360
|
+
headers: {
|
|
9361
|
+
"Content-Language": components["headers"]["ContentLanguage"];
|
|
9362
|
+
/** @description Strong entity tag for optimistic concurrency control. */
|
|
9363
|
+
ETag?: string;
|
|
9364
|
+
[name: string]: unknown;
|
|
9365
|
+
};
|
|
9366
|
+
content: {
|
|
9367
|
+
"application/json": {
|
|
9368
|
+
detail?: string;
|
|
9369
|
+
non_field_errors?: string[];
|
|
9370
|
+
} & {
|
|
9371
|
+
[key: string]: string | string[];
|
|
9372
|
+
};
|
|
9373
|
+
};
|
|
9374
|
+
};
|
|
9068
9375
|
};
|
|
9069
9376
|
};
|
|
9070
9377
|
users_data_add_create: {
|
|
@@ -9073,6 +9380,8 @@ interface operations {
|
|
|
9073
9380
|
header?: {
|
|
9074
9381
|
/** @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. */
|
|
9075
9382
|
"Accept-Language"?: string;
|
|
9383
|
+
/** @description Stable key for one logical mutation. Successful responses are replayable for 24 hours; reusing a key with a different request returns 409. */
|
|
9384
|
+
"Idempotency-Key"?: string;
|
|
9076
9385
|
};
|
|
9077
9386
|
path: {
|
|
9078
9387
|
/** @description A UUID string identifying this user. */
|
|
@@ -9091,6 +9400,8 @@ interface operations {
|
|
|
9091
9400
|
/** @description The request was accepted and the updated resource is returned. */
|
|
9092
9401
|
202: {
|
|
9093
9402
|
headers: {
|
|
9403
|
+
/** @description True when the response was replayed from a prior request. */
|
|
9404
|
+
"Idempotency-Replayed"?: "true";
|
|
9094
9405
|
[name: string]: unknown;
|
|
9095
9406
|
};
|
|
9096
9407
|
content: {
|
|
@@ -9157,6 +9468,132 @@ interface operations {
|
|
|
9157
9468
|
};
|
|
9158
9469
|
};
|
|
9159
9470
|
};
|
|
9471
|
+
/** @description The idempotency key is in progress or was reused for a different request. */
|
|
9472
|
+
409: {
|
|
9473
|
+
headers: {
|
|
9474
|
+
"Content-Language": components["headers"]["ContentLanguage"];
|
|
9475
|
+
[name: string]: unknown;
|
|
9476
|
+
};
|
|
9477
|
+
content: {
|
|
9478
|
+
"application/json": {
|
|
9479
|
+
detail?: string;
|
|
9480
|
+
non_field_errors?: string[];
|
|
9481
|
+
} & {
|
|
9482
|
+
[key: string]: string | string[];
|
|
9483
|
+
};
|
|
9484
|
+
};
|
|
9485
|
+
};
|
|
9486
|
+
};
|
|
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
|
+
};
|
|
9160
9597
|
};
|
|
9161
9598
|
};
|
|
9162
9599
|
users_data_subtract_create: {
|
|
@@ -9165,6 +9602,8 @@ interface operations {
|
|
|
9165
9602
|
header?: {
|
|
9166
9603
|
/** @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. */
|
|
9167
9604
|
"Accept-Language"?: string;
|
|
9605
|
+
/** @description Stable key for one logical mutation. Successful responses are replayable for 24 hours; reusing a key with a different request returns 409. */
|
|
9606
|
+
"Idempotency-Key"?: string;
|
|
9168
9607
|
};
|
|
9169
9608
|
path: {
|
|
9170
9609
|
/** @description A UUID string identifying this user. */
|
|
@@ -9183,6 +9622,8 @@ interface operations {
|
|
|
9183
9622
|
/** @description The request was accepted and the updated resource is returned. */
|
|
9184
9623
|
202: {
|
|
9185
9624
|
headers: {
|
|
9625
|
+
/** @description True when the response was replayed from a prior request. */
|
|
9626
|
+
"Idempotency-Replayed"?: "true";
|
|
9186
9627
|
[name: string]: unknown;
|
|
9187
9628
|
};
|
|
9188
9629
|
content: {
|
|
@@ -9249,6 +9690,21 @@ interface operations {
|
|
|
9249
9690
|
};
|
|
9250
9691
|
};
|
|
9251
9692
|
};
|
|
9693
|
+
/** @description The idempotency key is in progress or was reused for a different request. */
|
|
9694
|
+
409: {
|
|
9695
|
+
headers: {
|
|
9696
|
+
"Content-Language": components["headers"]["ContentLanguage"];
|
|
9697
|
+
[name: string]: unknown;
|
|
9698
|
+
};
|
|
9699
|
+
content: {
|
|
9700
|
+
"application/json": {
|
|
9701
|
+
detail?: string;
|
|
9702
|
+
non_field_errors?: string[];
|
|
9703
|
+
} & {
|
|
9704
|
+
[key: string]: string | string[];
|
|
9705
|
+
};
|
|
9706
|
+
};
|
|
9707
|
+
};
|
|
9252
9708
|
};
|
|
9253
9709
|
};
|
|
9254
9710
|
users_orders_list: {
|
|
@@ -9360,7 +9816,7 @@ interface operations {
|
|
|
9360
9816
|
};
|
|
9361
9817
|
cookie?: never;
|
|
9362
9818
|
};
|
|
9363
|
-
requestBody
|
|
9819
|
+
requestBody: {
|
|
9364
9820
|
content: {
|
|
9365
9821
|
"application/json": components["schemas"]["UserPasswordResetRequestRequest"];
|
|
9366
9822
|
"application/x-www-form-urlencoded": components["schemas"]["UserPasswordResetRequestRequest"];
|
|
@@ -9518,6 +9974,8 @@ interface operations {
|
|
|
9518
9974
|
header?: {
|
|
9519
9975
|
/** @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. */
|
|
9520
9976
|
"Accept-Language"?: string;
|
|
9977
|
+
/** @description Stable key for one logical mutation. Successful responses are replayable for 24 hours; reusing a key with a different request returns 409. */
|
|
9978
|
+
"Idempotency-Key"?: string;
|
|
9521
9979
|
};
|
|
9522
9980
|
path?: never;
|
|
9523
9981
|
cookie?: never;
|
|
@@ -9533,6 +9991,10 @@ interface operations {
|
|
|
9533
9991
|
/** @description The resource or action result was created successfully. */
|
|
9534
9992
|
201: {
|
|
9535
9993
|
headers: {
|
|
9994
|
+
/** @description Strong entity tag for optimistic concurrency control. */
|
|
9995
|
+
ETag?: string;
|
|
9996
|
+
/** @description True when the response was replayed from a prior request. */
|
|
9997
|
+
"Idempotency-Replayed"?: "true";
|
|
9536
9998
|
[name: string]: unknown;
|
|
9537
9999
|
};
|
|
9538
10000
|
content: {
|
|
@@ -9584,6 +10046,21 @@ interface operations {
|
|
|
9584
10046
|
};
|
|
9585
10047
|
};
|
|
9586
10048
|
};
|
|
10049
|
+
/** @description The idempotency key is in progress or was reused for a different request. */
|
|
10050
|
+
409: {
|
|
10051
|
+
headers: {
|
|
10052
|
+
"Content-Language": components["headers"]["ContentLanguage"];
|
|
10053
|
+
[name: string]: unknown;
|
|
10054
|
+
};
|
|
10055
|
+
content: {
|
|
10056
|
+
"application/json": {
|
|
10057
|
+
detail?: string;
|
|
10058
|
+
non_field_errors?: string[];
|
|
10059
|
+
} & {
|
|
10060
|
+
[key: string]: string | string[];
|
|
10061
|
+
};
|
|
10062
|
+
};
|
|
10063
|
+
};
|
|
9587
10064
|
};
|
|
9588
10065
|
};
|
|
9589
10066
|
webhooks_retrieve: {
|
|
@@ -9604,6 +10081,8 @@ interface operations {
|
|
|
9604
10081
|
/** @description The operation completed successfully. */
|
|
9605
10082
|
200: {
|
|
9606
10083
|
headers: {
|
|
10084
|
+
/** @description Strong entity tag for optimistic concurrency control. */
|
|
10085
|
+
ETag?: string;
|
|
9607
10086
|
[name: string]: unknown;
|
|
9608
10087
|
};
|
|
9609
10088
|
content: {
|
|
@@ -9678,6 +10157,10 @@ interface operations {
|
|
|
9678
10157
|
header?: {
|
|
9679
10158
|
/** @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. */
|
|
9680
10159
|
"Accept-Language"?: string;
|
|
10160
|
+
/** @description Stable key for one logical mutation. Successful responses are replayable for 24 hours; reusing a key with a different request returns 409. */
|
|
10161
|
+
"Idempotency-Key"?: string;
|
|
10162
|
+
/** @description Strong ETag from the latest representation of this resource. */
|
|
10163
|
+
"If-Match"?: string;
|
|
9681
10164
|
};
|
|
9682
10165
|
path: {
|
|
9683
10166
|
/** @description A unique value identifying this Webhook. */
|
|
@@ -9690,6 +10173,8 @@ interface operations {
|
|
|
9690
10173
|
/** @description No response body */
|
|
9691
10174
|
204: {
|
|
9692
10175
|
headers: {
|
|
10176
|
+
/** @description True when the response was replayed from a prior request. */
|
|
10177
|
+
"Idempotency-Replayed"?: "true";
|
|
9693
10178
|
[name: string]: unknown;
|
|
9694
10179
|
};
|
|
9695
10180
|
content?: never;
|
|
@@ -9754,9 +10239,41 @@ interface operations {
|
|
|
9754
10239
|
};
|
|
9755
10240
|
};
|
|
9756
10241
|
};
|
|
10242
|
+
/** @description The idempotency key is in progress or was reused for a different request. */
|
|
10243
|
+
409: {
|
|
10244
|
+
headers: {
|
|
10245
|
+
"Content-Language": components["headers"]["ContentLanguage"];
|
|
10246
|
+
[name: string]: unknown;
|
|
10247
|
+
};
|
|
10248
|
+
content: {
|
|
10249
|
+
"application/json": {
|
|
10250
|
+
detail?: string;
|
|
10251
|
+
non_field_errors?: string[];
|
|
10252
|
+
} & {
|
|
10253
|
+
[key: string]: string | string[];
|
|
10254
|
+
};
|
|
10255
|
+
};
|
|
10256
|
+
};
|
|
10257
|
+
/** @description The resource no longer matches the supplied ETag. */
|
|
10258
|
+
412: {
|
|
10259
|
+
headers: {
|
|
10260
|
+
"Content-Language": components["headers"]["ContentLanguage"];
|
|
10261
|
+
/** @description Strong entity tag for optimistic concurrency control. */
|
|
10262
|
+
ETag?: string;
|
|
10263
|
+
[name: string]: unknown;
|
|
10264
|
+
};
|
|
10265
|
+
content: {
|
|
10266
|
+
"application/json": {
|
|
10267
|
+
detail?: string;
|
|
10268
|
+
non_field_errors?: string[];
|
|
10269
|
+
} & {
|
|
10270
|
+
[key: string]: string | string[];
|
|
10271
|
+
};
|
|
10272
|
+
};
|
|
10273
|
+
};
|
|
9757
10274
|
};
|
|
9758
10275
|
};
|
|
9759
10276
|
}
|
|
9760
10277
|
//#endregion
|
|
9761
10278
|
export { webhooks as i, operations as n, paths as r, components as t };
|
|
9762
|
-
//# sourceMappingURL=schema-
|
|
10279
|
+
//# sourceMappingURL=schema-B2orTIrr.d.ts.map
|