@opusdns/api 0.61.0 → 0.63.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/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;
@@ -951,6 +1036,40 @@ export interface paths {
951
1036
  patch?: never;
952
1037
  trace?: never;
953
1038
  };
1039
+ "/v1/organizations/{organization_id}/transactions": {
1040
+ parameters: {
1041
+ query?: never;
1042
+ header?: never;
1043
+ path?: never;
1044
+ cookie?: never;
1045
+ };
1046
+ /** Get transactions for an organization */
1047
+ get: operations["get_transactions_v1_organizations__organization_id__transactions_get"];
1048
+ put?: never;
1049
+ post?: never;
1050
+ delete?: never;
1051
+ options?: never;
1052
+ head?: never;
1053
+ patch?: never;
1054
+ trace?: never;
1055
+ };
1056
+ "/v1/organizations/{organization_id}/transactions/{transaction_id}": {
1057
+ parameters: {
1058
+ query?: never;
1059
+ header?: never;
1060
+ path?: never;
1061
+ cookie?: never;
1062
+ };
1063
+ /** Get a specific transaction for an organization */
1064
+ get: operations["get_transaction_v1_organizations__organization_id__transactions__transaction_id__get"];
1065
+ put?: never;
1066
+ post?: never;
1067
+ delete?: never;
1068
+ options?: never;
1069
+ head?: never;
1070
+ patch?: never;
1071
+ trace?: never;
1072
+ };
954
1073
  "/v1/tlds/portfolio": {
955
1074
  parameters: {
956
1075
  query?: never;
@@ -1170,6 +1289,55 @@ export interface components {
1170
1289
  * @enum {string}
1171
1290
  */
1172
1291
  BillingTransactionProductType: "domain" | "zones" | "email_forward" | "domain_forward";
1292
+ /** BillingTransactionResponse */
1293
+ BillingTransactionResponse: {
1294
+ /** @description The action performed in the transaction */
1295
+ action: components["schemas"]["BillingTransactionAction"];
1296
+ /**
1297
+ * Billing Transaction Id
1298
+ * Format: typeid
1299
+ */
1300
+ billing_transaction_id?: TypeId<"billing_transaction">;
1301
+ /**
1302
+ * Completed On
1303
+ * @description The date/time the transaction completed
1304
+ */
1305
+ completed_on?: Date | null;
1306
+ /**
1307
+ * Created On
1308
+ * Format: date-time
1309
+ * @description The date/time the transaction was created
1310
+ */
1311
+ created_on?: Date;
1312
+ /**
1313
+ * Product Reference
1314
+ * @description The reference of the product
1315
+ */
1316
+ product_reference: string | null;
1317
+ /** @description The type of product */
1318
+ product_type: components["schemas"]["BillingTransactionProductType"];
1319
+ /**
1320
+ * @description The status of the transaction
1321
+ * @default pending
1322
+ */
1323
+ status: components["schemas"]["BillingTransactionStatus"];
1324
+ /**
1325
+ * Updated On
1326
+ * Format: date-time
1327
+ * @description The date/time the transaction was updated
1328
+ */
1329
+ updated_on?: Date;
1330
+ };
1331
+ /**
1332
+ * BillingTransactionSortField
1333
+ * @enum {string}
1334
+ */
1335
+ BillingTransactionSortField: "product_type" | "action" | "status" | "created_on" | "completed_on";
1336
+ /**
1337
+ * BillingTransactionStatus
1338
+ * @enum {string}
1339
+ */
1340
+ BillingTransactionStatus: "pending" | "succeeded" | "failed" | "canceled";
1173
1341
  /** Body_issue_organization_token_v1_auth_token_post */
1174
1342
  Body_issue_organization_token_v1_auth_token_post: {
1175
1343
  /**
@@ -1195,6 +1363,22 @@ export interface components {
1195
1363
  */
1196
1364
  username?: string | null;
1197
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
+ };
1198
1382
  /** ContactConfigBase */
1199
1383
  ContactConfigBase: {
1200
1384
  /**
@@ -1659,6 +1843,44 @@ export interface components {
1659
1843
  * @enum {string}
1660
1844
  */
1661
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
+ };
1662
1884
  /**
1663
1885
  * DeletePolicyType
1664
1886
  * @enum {string}
@@ -3379,6 +3601,12 @@ export interface components {
3379
3601
  /** Total Pages */
3380
3602
  total_pages: number;
3381
3603
  };
3604
+ /** Pagination[BillingTransactionResponse] */
3605
+ Pagination_BillingTransactionResponse_: {
3606
+ pagination: components["schemas"]["PaginationMetadata"];
3607
+ /** Results */
3608
+ results: components["schemas"]["BillingTransactionResponse"][];
3609
+ };
3382
3610
  /** Pagination[ContactSchema] */
3383
3611
  Pagination_ContactSchema_: {
3384
3612
  pagination: components["schemas"]["PaginationMetadata"];
@@ -4229,6 +4457,49 @@ export interface components {
4229
4457
  * @enum {string}
4230
4458
  */
4231
4459
  VerificationType: "api" | "email";
4460
+ /** WalletCreditRequest */
4461
+ WalletCreditRequest: {
4462
+ /**
4463
+ * Amount
4464
+ * @description Amount to credit the customer wallet
4465
+ */
4466
+ amount: number | string;
4467
+ /**
4468
+ * Payment Method Id
4469
+ * @description Payment method ID that should be used
4470
+ */
4471
+ payment_method_id: string;
4472
+ };
4473
+ /**
4474
+ * WalletCreditResponseStatus
4475
+ * @enum {string}
4476
+ */
4477
+ WalletCreditResponseStatus: "success" | "failed";
4478
+ /** WalletCreditResponseWithBalance */
4479
+ WalletCreditResponseWithBalance: {
4480
+ /**
4481
+ * Amount
4482
+ * @description Amount credited to the customer wallet
4483
+ */
4484
+ amount: string;
4485
+ /**
4486
+ * Balance
4487
+ * @description Updated wallet balance after the credit
4488
+ */
4489
+ balance: string;
4490
+ /**
4491
+ * Credit Id
4492
+ * @description Unique identifier of the wallet credit transaction
4493
+ */
4494
+ credit_id: string;
4495
+ /**
4496
+ * Message
4497
+ * @description Optional human-readable message describing the result
4498
+ */
4499
+ message?: string | null;
4500
+ /** @description Status of the credit operation */
4501
+ status: components["schemas"]["WalletCreditResponseStatus"];
4502
+ };
4232
4503
  /** WhoisBase */
4233
4504
  WhoisBase: {
4234
4505
  /**
@@ -7563,6 +7834,169 @@ export interface operations {
7563
7834
  };
7564
7835
  };
7565
7836
  };
7837
+ get_checkout_session_v1_organizations__organization_id__billing_checkout_sessions_post: {
7838
+ parameters: {
7839
+ query?: never;
7840
+ header?: never;
7841
+ path: {
7842
+ organization_id: TypeId<"organization">;
7843
+ };
7844
+ cookie?: never;
7845
+ };
7846
+ requestBody: {
7847
+ content: {
7848
+ "application/json": components["schemas"]["CheckoutSessionRequest"];
7849
+ };
7850
+ };
7851
+ responses: {
7852
+ /** @description Successful Response */
7853
+ 200: {
7854
+ headers: {
7855
+ [name: string]: unknown;
7856
+ };
7857
+ content: {
7858
+ "application/json": components["schemas"]["CheckoutSessionResponse"];
7859
+ };
7860
+ };
7861
+ /** @description Validation Error */
7862
+ 422: {
7863
+ headers: {
7864
+ [name: string]: unknown;
7865
+ };
7866
+ content: {
7867
+ "application/problem+json": components["schemas"]["HTTPValidationError"];
7868
+ };
7869
+ };
7870
+ };
7871
+ };
7872
+ list_payment_methods_v1_organizations__organization_id__billing_payment_methods_get: {
7873
+ parameters: {
7874
+ query?: never;
7875
+ header?: never;
7876
+ path: {
7877
+ organization_id: TypeId<"organization">;
7878
+ };
7879
+ cookie?: never;
7880
+ };
7881
+ requestBody?: never;
7882
+ responses: {
7883
+ /** @description Successful Response */
7884
+ 200: {
7885
+ headers: {
7886
+ [name: string]: unknown;
7887
+ };
7888
+ content: {
7889
+ "application/json": components["schemas"]["CustomerCreditCardPaymentMethod"][];
7890
+ };
7891
+ };
7892
+ /** @description Validation Error */
7893
+ 422: {
7894
+ headers: {
7895
+ [name: string]: unknown;
7896
+ };
7897
+ content: {
7898
+ "application/problem+json": components["schemas"]["HTTPValidationError"];
7899
+ };
7900
+ };
7901
+ };
7902
+ };
7903
+ delete_payment_method_v1_organizations__organization_id__billing_payment_methods__payment_method_id__delete: {
7904
+ parameters: {
7905
+ query?: never;
7906
+ header?: never;
7907
+ path: {
7908
+ payment_method_id: string;
7909
+ organization_id: TypeId<"organization">;
7910
+ };
7911
+ cookie?: never;
7912
+ };
7913
+ requestBody?: never;
7914
+ responses: {
7915
+ /** @description Successful Response */
7916
+ 204: {
7917
+ headers: {
7918
+ [name: string]: unknown;
7919
+ };
7920
+ content?: never;
7921
+ };
7922
+ /** @description Validation Error */
7923
+ 422: {
7924
+ headers: {
7925
+ [name: string]: unknown;
7926
+ };
7927
+ content: {
7928
+ "application/problem+json": components["schemas"]["HTTPValidationError"];
7929
+ };
7930
+ };
7931
+ };
7932
+ };
7933
+ update_default_payment_method_v1_organizations__organization_id__billing_payment_methods__payment_method_id__default_patch: {
7934
+ parameters: {
7935
+ query?: never;
7936
+ header?: never;
7937
+ path: {
7938
+ payment_method_id: string;
7939
+ organization_id: TypeId<"organization">;
7940
+ };
7941
+ cookie?: never;
7942
+ };
7943
+ requestBody?: never;
7944
+ responses: {
7945
+ /** @description Successful Response */
7946
+ 200: {
7947
+ headers: {
7948
+ [name: string]: unknown;
7949
+ };
7950
+ content: {
7951
+ "application/json": components["schemas"]["CustomerCreditCardPaymentMethod"][];
7952
+ };
7953
+ };
7954
+ /** @description Validation Error */
7955
+ 422: {
7956
+ headers: {
7957
+ [name: string]: unknown;
7958
+ };
7959
+ content: {
7960
+ "application/problem+json": components["schemas"]["HTTPValidationError"];
7961
+ };
7962
+ };
7963
+ };
7964
+ };
7965
+ credit_wallet_v1_organizations__organization_id__billing_wallet_credits_post: {
7966
+ parameters: {
7967
+ query?: never;
7968
+ header?: never;
7969
+ path: {
7970
+ organization_id: TypeId<"organization">;
7971
+ };
7972
+ cookie?: never;
7973
+ };
7974
+ requestBody: {
7975
+ content: {
7976
+ "application/json": components["schemas"]["WalletCreditRequest"];
7977
+ };
7978
+ };
7979
+ responses: {
7980
+ /** @description Successful Response */
7981
+ 200: {
7982
+ headers: {
7983
+ [name: string]: unknown;
7984
+ };
7985
+ content: {
7986
+ "application/json": components["schemas"]["WalletCreditResponseWithBalance"];
7987
+ };
7988
+ };
7989
+ /** @description Validation Error */
7990
+ 422: {
7991
+ headers: {
7992
+ [name: string]: unknown;
7993
+ };
7994
+ content: {
7995
+ "application/problem+json": components["schemas"]["HTTPValidationError"];
7996
+ };
7997
+ };
7998
+ };
7999
+ };
7566
8000
  change_plan_v1_organizations__organization_id__plan_patch: {
7567
8001
  parameters: {
7568
8002
  query?: never;
@@ -7664,6 +8098,82 @@ export interface operations {
7664
8098
  };
7665
8099
  };
7666
8100
  };
8101
+ get_transactions_v1_organizations__organization_id__transactions_get: {
8102
+ parameters: {
8103
+ query?: {
8104
+ sort_by?: components["schemas"]["BillingTransactionSortField"];
8105
+ sort_order?: components["schemas"]["SortOrder"];
8106
+ product_reference?: string | null;
8107
+ product_type?: components["schemas"]["BillingTransactionProductType"] | null;
8108
+ action?: components["schemas"]["BillingTransactionAction"] | null;
8109
+ status?: components["schemas"]["BillingTransactionStatus"] | null;
8110
+ created_after?: Date | null;
8111
+ created_before?: Date | null;
8112
+ completed_after?: Date | null;
8113
+ completed_before?: Date | null;
8114
+ page?: number;
8115
+ page_size?: number;
8116
+ };
8117
+ header?: never;
8118
+ path: {
8119
+ organization_id: TypeId<"organization">;
8120
+ };
8121
+ cookie?: never;
8122
+ };
8123
+ requestBody?: never;
8124
+ responses: {
8125
+ /** @description Successful Response */
8126
+ 200: {
8127
+ headers: {
8128
+ [name: string]: unknown;
8129
+ };
8130
+ content: {
8131
+ "application/json": components["schemas"]["Pagination_BillingTransactionResponse_"];
8132
+ };
8133
+ };
8134
+ /** @description Validation Error */
8135
+ 422: {
8136
+ headers: {
8137
+ [name: string]: unknown;
8138
+ };
8139
+ content: {
8140
+ "application/problem+json": components["schemas"]["HTTPValidationError"];
8141
+ };
8142
+ };
8143
+ };
8144
+ };
8145
+ get_transaction_v1_organizations__organization_id__transactions__transaction_id__get: {
8146
+ parameters: {
8147
+ query?: never;
8148
+ header?: never;
8149
+ path: {
8150
+ organization_id: TypeId<"organization">;
8151
+ transaction_id: TypeId<"billing_transaction">;
8152
+ };
8153
+ cookie?: never;
8154
+ };
8155
+ requestBody?: never;
8156
+ responses: {
8157
+ /** @description Successful Response */
8158
+ 200: {
8159
+ headers: {
8160
+ [name: string]: unknown;
8161
+ };
8162
+ content: {
8163
+ "application/json": components["schemas"]["BillingTransactionResponse"];
8164
+ };
8165
+ };
8166
+ /** @description Validation Error */
8167
+ 422: {
8168
+ headers: {
8169
+ [name: string]: unknown;
8170
+ };
8171
+ content: {
8172
+ "application/problem+json": components["schemas"]["HTTPValidationError"];
8173
+ };
8174
+ };
8175
+ };
8176
+ };
7667
8177
  get_tld_portfolio_v1_tlds_portfolio_get: {
7668
8178
  parameters: {
7669
8179
  query?: never;