@opusdns/api 0.62.0 → 0.64.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/package.json +1 -1
- package/src/helpers/constants.ts +51 -57
- package/src/helpers/keys.ts +605 -50
- package/src/helpers/requests.d.ts +220 -2
- package/src/helpers/responses.d.ts +259 -2
- package/src/helpers/schemas-arrays.d.ts +15 -1
- package/src/helpers/schemas.d.ts +108 -28
- package/src/openapi.yaml +325 -18
- package/src/schema.d.ts +354 -11
package/src/schema.d.ts
CHANGED
|
@@ -900,6 +900,91 @@ export interface paths {
|
|
|
900
900
|
patch: operations["update_organization_v1_organizations__organization_id__patch"];
|
|
901
901
|
trace?: never;
|
|
902
902
|
};
|
|
903
|
+
"/v1/organizations/{organization_id}/billing/checkout-sessions": {
|
|
904
|
+
parameters: {
|
|
905
|
+
query?: never;
|
|
906
|
+
header?: never;
|
|
907
|
+
path?: never;
|
|
908
|
+
cookie?: never;
|
|
909
|
+
};
|
|
910
|
+
get?: never;
|
|
911
|
+
put?: never;
|
|
912
|
+
/** Get Checkout Session */
|
|
913
|
+
post: operations["get_checkout_session_v1_organizations__organization_id__billing_checkout_sessions_post"];
|
|
914
|
+
delete?: never;
|
|
915
|
+
options?: never;
|
|
916
|
+
head?: never;
|
|
917
|
+
patch?: never;
|
|
918
|
+
trace?: never;
|
|
919
|
+
};
|
|
920
|
+
"/v1/organizations/{organization_id}/billing/payment-methods": {
|
|
921
|
+
parameters: {
|
|
922
|
+
query?: never;
|
|
923
|
+
header?: never;
|
|
924
|
+
path?: never;
|
|
925
|
+
cookie?: never;
|
|
926
|
+
};
|
|
927
|
+
/** List Payment Methods */
|
|
928
|
+
get: operations["list_payment_methods_v1_organizations__organization_id__billing_payment_methods_get"];
|
|
929
|
+
put?: never;
|
|
930
|
+
post?: never;
|
|
931
|
+
delete?: never;
|
|
932
|
+
options?: never;
|
|
933
|
+
head?: never;
|
|
934
|
+
patch?: never;
|
|
935
|
+
trace?: never;
|
|
936
|
+
};
|
|
937
|
+
"/v1/organizations/{organization_id}/billing/payment-methods/{payment_method_id}": {
|
|
938
|
+
parameters: {
|
|
939
|
+
query?: never;
|
|
940
|
+
header?: never;
|
|
941
|
+
path?: never;
|
|
942
|
+
cookie?: never;
|
|
943
|
+
};
|
|
944
|
+
get?: never;
|
|
945
|
+
put?: never;
|
|
946
|
+
post?: never;
|
|
947
|
+
/** Delete Payment Method */
|
|
948
|
+
delete: operations["delete_payment_method_v1_organizations__organization_id__billing_payment_methods__payment_method_id__delete"];
|
|
949
|
+
options?: never;
|
|
950
|
+
head?: never;
|
|
951
|
+
patch?: never;
|
|
952
|
+
trace?: never;
|
|
953
|
+
};
|
|
954
|
+
"/v1/organizations/{organization_id}/billing/payment-methods/{payment_method_id}/default": {
|
|
955
|
+
parameters: {
|
|
956
|
+
query?: never;
|
|
957
|
+
header?: never;
|
|
958
|
+
path?: never;
|
|
959
|
+
cookie?: never;
|
|
960
|
+
};
|
|
961
|
+
get?: never;
|
|
962
|
+
put?: never;
|
|
963
|
+
post?: never;
|
|
964
|
+
delete?: never;
|
|
965
|
+
options?: never;
|
|
966
|
+
head?: never;
|
|
967
|
+
/** Update Default Payment Method */
|
|
968
|
+
patch: operations["update_default_payment_method_v1_organizations__organization_id__billing_payment_methods__payment_method_id__default_patch"];
|
|
969
|
+
trace?: never;
|
|
970
|
+
};
|
|
971
|
+
"/v1/organizations/{organization_id}/billing/wallet/credits": {
|
|
972
|
+
parameters: {
|
|
973
|
+
query?: never;
|
|
974
|
+
header?: never;
|
|
975
|
+
path?: never;
|
|
976
|
+
cookie?: never;
|
|
977
|
+
};
|
|
978
|
+
get?: never;
|
|
979
|
+
put?: never;
|
|
980
|
+
/** Credit Wallet */
|
|
981
|
+
post: operations["credit_wallet_v1_organizations__organization_id__billing_wallet_credits_post"];
|
|
982
|
+
delete?: never;
|
|
983
|
+
options?: never;
|
|
984
|
+
head?: never;
|
|
985
|
+
patch?: never;
|
|
986
|
+
trace?: never;
|
|
987
|
+
};
|
|
903
988
|
"/v1/organizations/{organization_id}/plan": {
|
|
904
989
|
parameters: {
|
|
905
990
|
query?: never;
|
|
@@ -1278,6 +1363,22 @@ export interface components {
|
|
|
1278
1363
|
*/
|
|
1279
1364
|
username?: string | null;
|
|
1280
1365
|
};
|
|
1366
|
+
/** CheckoutSessionRequest */
|
|
1367
|
+
CheckoutSessionRequest: {
|
|
1368
|
+
/**
|
|
1369
|
+
* Return Url
|
|
1370
|
+
* @description Return URL that will be used
|
|
1371
|
+
*/
|
|
1372
|
+
return_url: string;
|
|
1373
|
+
};
|
|
1374
|
+
/** CheckoutSessionResponse */
|
|
1375
|
+
CheckoutSessionResponse: {
|
|
1376
|
+
/**
|
|
1377
|
+
* Session Client Secret
|
|
1378
|
+
* @description Checkout session client secret - meant to be used in the embedded checkout
|
|
1379
|
+
*/
|
|
1380
|
+
session_client_secret: string;
|
|
1381
|
+
};
|
|
1281
1382
|
/** ContactConfigBase */
|
|
1282
1383
|
ContactConfigBase: {
|
|
1283
1384
|
/**
|
|
@@ -1742,6 +1843,44 @@ export interface components {
|
|
|
1742
1843
|
* @enum {string}
|
|
1743
1844
|
*/
|
|
1744
1845
|
Currency: "USD" | "EUR";
|
|
1846
|
+
/** CustomerCreditCardPaymentMethod */
|
|
1847
|
+
CustomerCreditCardPaymentMethod: {
|
|
1848
|
+
/**
|
|
1849
|
+
* Brand
|
|
1850
|
+
* @description Card brand
|
|
1851
|
+
*/
|
|
1852
|
+
brand: string;
|
|
1853
|
+
/**
|
|
1854
|
+
* Country
|
|
1855
|
+
* @description Country code
|
|
1856
|
+
*/
|
|
1857
|
+
country?: string | null;
|
|
1858
|
+
/**
|
|
1859
|
+
* Exp Month
|
|
1860
|
+
* @description Expiration month
|
|
1861
|
+
*/
|
|
1862
|
+
exp_month: number;
|
|
1863
|
+
/**
|
|
1864
|
+
* Exp Year
|
|
1865
|
+
* @description Expiration year
|
|
1866
|
+
*/
|
|
1867
|
+
exp_year: number;
|
|
1868
|
+
/**
|
|
1869
|
+
* Id
|
|
1870
|
+
* @description Payment method ID
|
|
1871
|
+
*/
|
|
1872
|
+
id: string;
|
|
1873
|
+
/**
|
|
1874
|
+
* Is Default
|
|
1875
|
+
* @description Whether this is the default payment method
|
|
1876
|
+
*/
|
|
1877
|
+
is_default: boolean;
|
|
1878
|
+
/**
|
|
1879
|
+
* Last4
|
|
1880
|
+
* @description Last four digits of the card
|
|
1881
|
+
*/
|
|
1882
|
+
last4: string;
|
|
1883
|
+
};
|
|
1745
1884
|
/**
|
|
1746
1885
|
* DeletePolicyType
|
|
1747
1886
|
* @enum {string}
|
|
@@ -3552,6 +3691,14 @@ export interface components {
|
|
|
3552
3691
|
/** Permissions */
|
|
3553
3692
|
permissions?: components["schemas"]["Permission"][];
|
|
3554
3693
|
};
|
|
3694
|
+
/** PlanIdRequest */
|
|
3695
|
+
PlanIdRequest: {
|
|
3696
|
+
/**
|
|
3697
|
+
* Plan Id
|
|
3698
|
+
* @description Plan ID from available plans
|
|
3699
|
+
*/
|
|
3700
|
+
plan_id: string;
|
|
3701
|
+
};
|
|
3555
3702
|
/** PlanInfo */
|
|
3556
3703
|
PlanInfo: {
|
|
3557
3704
|
/**
|
|
@@ -3585,16 +3732,6 @@ export interface components {
|
|
|
3585
3732
|
*/
|
|
3586
3733
|
plan_type?: string | null;
|
|
3587
3734
|
};
|
|
3588
|
-
/**
|
|
3589
|
-
* PlanRelation
|
|
3590
|
-
* @enum {string}
|
|
3591
|
-
*/
|
|
3592
|
-
PlanRelation: "basic" | "enterprise" | "corporate" | "premium" | "starter";
|
|
3593
|
-
/** PlanUpdate */
|
|
3594
|
-
PlanUpdate: {
|
|
3595
|
-
/** @default basic */
|
|
3596
|
-
plan: components["schemas"]["PlanRelation"];
|
|
3597
|
-
};
|
|
3598
3735
|
/**
|
|
3599
3736
|
* PostTransferRequirements
|
|
3600
3737
|
* @enum {string}
|
|
@@ -4318,6 +4455,49 @@ export interface components {
|
|
|
4318
4455
|
* @enum {string}
|
|
4319
4456
|
*/
|
|
4320
4457
|
VerificationType: "api" | "email";
|
|
4458
|
+
/** WalletCreditRequest */
|
|
4459
|
+
WalletCreditRequest: {
|
|
4460
|
+
/**
|
|
4461
|
+
* Amount
|
|
4462
|
+
* @description Amount to credit the customer wallet
|
|
4463
|
+
*/
|
|
4464
|
+
amount: number | string;
|
|
4465
|
+
/**
|
|
4466
|
+
* Payment Method Id
|
|
4467
|
+
* @description Payment method ID that should be used
|
|
4468
|
+
*/
|
|
4469
|
+
payment_method_id: string;
|
|
4470
|
+
};
|
|
4471
|
+
/**
|
|
4472
|
+
* WalletCreditResponseStatus
|
|
4473
|
+
* @enum {string}
|
|
4474
|
+
*/
|
|
4475
|
+
WalletCreditResponseStatus: "success" | "failed";
|
|
4476
|
+
/** WalletCreditResponseWithBalance */
|
|
4477
|
+
WalletCreditResponseWithBalance: {
|
|
4478
|
+
/**
|
|
4479
|
+
* Amount
|
|
4480
|
+
* @description Amount credited to the customer wallet
|
|
4481
|
+
*/
|
|
4482
|
+
amount: string;
|
|
4483
|
+
/**
|
|
4484
|
+
* Balance
|
|
4485
|
+
* @description Updated wallet balance after the credit
|
|
4486
|
+
*/
|
|
4487
|
+
balance: string;
|
|
4488
|
+
/**
|
|
4489
|
+
* Credit Id
|
|
4490
|
+
* @description Unique identifier of the wallet credit transaction
|
|
4491
|
+
*/
|
|
4492
|
+
credit_id: string;
|
|
4493
|
+
/**
|
|
4494
|
+
* Message
|
|
4495
|
+
* @description Optional human-readable message describing the result
|
|
4496
|
+
*/
|
|
4497
|
+
message?: string | null;
|
|
4498
|
+
/** @description Status of the credit operation */
|
|
4499
|
+
status: components["schemas"]["WalletCreditResponseStatus"];
|
|
4500
|
+
};
|
|
4321
4501
|
/** WhoisBase */
|
|
4322
4502
|
WhoisBase: {
|
|
4323
4503
|
/**
|
|
@@ -7652,6 +7832,169 @@ export interface operations {
|
|
|
7652
7832
|
};
|
|
7653
7833
|
};
|
|
7654
7834
|
};
|
|
7835
|
+
get_checkout_session_v1_organizations__organization_id__billing_checkout_sessions_post: {
|
|
7836
|
+
parameters: {
|
|
7837
|
+
query?: never;
|
|
7838
|
+
header?: never;
|
|
7839
|
+
path: {
|
|
7840
|
+
organization_id: TypeId<"organization">;
|
|
7841
|
+
};
|
|
7842
|
+
cookie?: never;
|
|
7843
|
+
};
|
|
7844
|
+
requestBody: {
|
|
7845
|
+
content: {
|
|
7846
|
+
"application/json": components["schemas"]["CheckoutSessionRequest"];
|
|
7847
|
+
};
|
|
7848
|
+
};
|
|
7849
|
+
responses: {
|
|
7850
|
+
/** @description Successful Response */
|
|
7851
|
+
200: {
|
|
7852
|
+
headers: {
|
|
7853
|
+
[name: string]: unknown;
|
|
7854
|
+
};
|
|
7855
|
+
content: {
|
|
7856
|
+
"application/json": components["schemas"]["CheckoutSessionResponse"];
|
|
7857
|
+
};
|
|
7858
|
+
};
|
|
7859
|
+
/** @description Validation Error */
|
|
7860
|
+
422: {
|
|
7861
|
+
headers: {
|
|
7862
|
+
[name: string]: unknown;
|
|
7863
|
+
};
|
|
7864
|
+
content: {
|
|
7865
|
+
"application/problem+json": components["schemas"]["HTTPValidationError"];
|
|
7866
|
+
};
|
|
7867
|
+
};
|
|
7868
|
+
};
|
|
7869
|
+
};
|
|
7870
|
+
list_payment_methods_v1_organizations__organization_id__billing_payment_methods_get: {
|
|
7871
|
+
parameters: {
|
|
7872
|
+
query?: never;
|
|
7873
|
+
header?: never;
|
|
7874
|
+
path: {
|
|
7875
|
+
organization_id: TypeId<"organization">;
|
|
7876
|
+
};
|
|
7877
|
+
cookie?: never;
|
|
7878
|
+
};
|
|
7879
|
+
requestBody?: never;
|
|
7880
|
+
responses: {
|
|
7881
|
+
/** @description Successful Response */
|
|
7882
|
+
200: {
|
|
7883
|
+
headers: {
|
|
7884
|
+
[name: string]: unknown;
|
|
7885
|
+
};
|
|
7886
|
+
content: {
|
|
7887
|
+
"application/json": components["schemas"]["CustomerCreditCardPaymentMethod"][];
|
|
7888
|
+
};
|
|
7889
|
+
};
|
|
7890
|
+
/** @description Validation Error */
|
|
7891
|
+
422: {
|
|
7892
|
+
headers: {
|
|
7893
|
+
[name: string]: unknown;
|
|
7894
|
+
};
|
|
7895
|
+
content: {
|
|
7896
|
+
"application/problem+json": components["schemas"]["HTTPValidationError"];
|
|
7897
|
+
};
|
|
7898
|
+
};
|
|
7899
|
+
};
|
|
7900
|
+
};
|
|
7901
|
+
delete_payment_method_v1_organizations__organization_id__billing_payment_methods__payment_method_id__delete: {
|
|
7902
|
+
parameters: {
|
|
7903
|
+
query?: never;
|
|
7904
|
+
header?: never;
|
|
7905
|
+
path: {
|
|
7906
|
+
payment_method_id: string;
|
|
7907
|
+
organization_id: TypeId<"organization">;
|
|
7908
|
+
};
|
|
7909
|
+
cookie?: never;
|
|
7910
|
+
};
|
|
7911
|
+
requestBody?: never;
|
|
7912
|
+
responses: {
|
|
7913
|
+
/** @description Successful Response */
|
|
7914
|
+
204: {
|
|
7915
|
+
headers: {
|
|
7916
|
+
[name: string]: unknown;
|
|
7917
|
+
};
|
|
7918
|
+
content?: never;
|
|
7919
|
+
};
|
|
7920
|
+
/** @description Validation Error */
|
|
7921
|
+
422: {
|
|
7922
|
+
headers: {
|
|
7923
|
+
[name: string]: unknown;
|
|
7924
|
+
};
|
|
7925
|
+
content: {
|
|
7926
|
+
"application/problem+json": components["schemas"]["HTTPValidationError"];
|
|
7927
|
+
};
|
|
7928
|
+
};
|
|
7929
|
+
};
|
|
7930
|
+
};
|
|
7931
|
+
update_default_payment_method_v1_organizations__organization_id__billing_payment_methods__payment_method_id__default_patch: {
|
|
7932
|
+
parameters: {
|
|
7933
|
+
query?: never;
|
|
7934
|
+
header?: never;
|
|
7935
|
+
path: {
|
|
7936
|
+
payment_method_id: string;
|
|
7937
|
+
organization_id: TypeId<"organization">;
|
|
7938
|
+
};
|
|
7939
|
+
cookie?: never;
|
|
7940
|
+
};
|
|
7941
|
+
requestBody?: never;
|
|
7942
|
+
responses: {
|
|
7943
|
+
/** @description Successful Response */
|
|
7944
|
+
200: {
|
|
7945
|
+
headers: {
|
|
7946
|
+
[name: string]: unknown;
|
|
7947
|
+
};
|
|
7948
|
+
content: {
|
|
7949
|
+
"application/json": components["schemas"]["CustomerCreditCardPaymentMethod"][];
|
|
7950
|
+
};
|
|
7951
|
+
};
|
|
7952
|
+
/** @description Validation Error */
|
|
7953
|
+
422: {
|
|
7954
|
+
headers: {
|
|
7955
|
+
[name: string]: unknown;
|
|
7956
|
+
};
|
|
7957
|
+
content: {
|
|
7958
|
+
"application/problem+json": components["schemas"]["HTTPValidationError"];
|
|
7959
|
+
};
|
|
7960
|
+
};
|
|
7961
|
+
};
|
|
7962
|
+
};
|
|
7963
|
+
credit_wallet_v1_organizations__organization_id__billing_wallet_credits_post: {
|
|
7964
|
+
parameters: {
|
|
7965
|
+
query?: never;
|
|
7966
|
+
header?: never;
|
|
7967
|
+
path: {
|
|
7968
|
+
organization_id: TypeId<"organization">;
|
|
7969
|
+
};
|
|
7970
|
+
cookie?: never;
|
|
7971
|
+
};
|
|
7972
|
+
requestBody: {
|
|
7973
|
+
content: {
|
|
7974
|
+
"application/json": components["schemas"]["WalletCreditRequest"];
|
|
7975
|
+
};
|
|
7976
|
+
};
|
|
7977
|
+
responses: {
|
|
7978
|
+
/** @description Successful Response */
|
|
7979
|
+
200: {
|
|
7980
|
+
headers: {
|
|
7981
|
+
[name: string]: unknown;
|
|
7982
|
+
};
|
|
7983
|
+
content: {
|
|
7984
|
+
"application/json": components["schemas"]["WalletCreditResponseWithBalance"];
|
|
7985
|
+
};
|
|
7986
|
+
};
|
|
7987
|
+
/** @description Validation Error */
|
|
7988
|
+
422: {
|
|
7989
|
+
headers: {
|
|
7990
|
+
[name: string]: unknown;
|
|
7991
|
+
};
|
|
7992
|
+
content: {
|
|
7993
|
+
"application/problem+json": components["schemas"]["HTTPValidationError"];
|
|
7994
|
+
};
|
|
7995
|
+
};
|
|
7996
|
+
};
|
|
7997
|
+
};
|
|
7655
7998
|
change_plan_v1_organizations__organization_id__plan_patch: {
|
|
7656
7999
|
parameters: {
|
|
7657
8000
|
query?: never;
|
|
@@ -7663,7 +8006,7 @@ export interface operations {
|
|
|
7663
8006
|
};
|
|
7664
8007
|
requestBody: {
|
|
7665
8008
|
content: {
|
|
7666
|
-
"application/json": components["schemas"]["
|
|
8009
|
+
"application/json": components["schemas"]["PlanIdRequest"];
|
|
7667
8010
|
};
|
|
7668
8011
|
};
|
|
7669
8012
|
responses: {
|