@opusdns/api 0.60.0 → 0.62.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 +111 -1
- package/src/helpers/keys.ts +320 -33
- package/src/helpers/requests.d.ts +90 -0
- package/src/helpers/responses.d.ts +111 -1
- package/src/helpers/schemas-arrays.d.ts +15 -1
- package/src/helpers/schemas.d.ts +80 -0
- package/src/openapi.yaml +275 -11
- package/src/schema.d.ts +177 -10
package/src/schema.d.ts
CHANGED
|
@@ -951,6 +951,40 @@ export interface paths {
|
|
|
951
951
|
patch?: never;
|
|
952
952
|
trace?: never;
|
|
953
953
|
};
|
|
954
|
+
"/v1/organizations/{organization_id}/transactions": {
|
|
955
|
+
parameters: {
|
|
956
|
+
query?: never;
|
|
957
|
+
header?: never;
|
|
958
|
+
path?: never;
|
|
959
|
+
cookie?: never;
|
|
960
|
+
};
|
|
961
|
+
/** Get transactions for an organization */
|
|
962
|
+
get: operations["get_transactions_v1_organizations__organization_id__transactions_get"];
|
|
963
|
+
put?: never;
|
|
964
|
+
post?: never;
|
|
965
|
+
delete?: never;
|
|
966
|
+
options?: never;
|
|
967
|
+
head?: never;
|
|
968
|
+
patch?: never;
|
|
969
|
+
trace?: never;
|
|
970
|
+
};
|
|
971
|
+
"/v1/organizations/{organization_id}/transactions/{transaction_id}": {
|
|
972
|
+
parameters: {
|
|
973
|
+
query?: never;
|
|
974
|
+
header?: never;
|
|
975
|
+
path?: never;
|
|
976
|
+
cookie?: never;
|
|
977
|
+
};
|
|
978
|
+
/** Get a specific transaction for an organization */
|
|
979
|
+
get: operations["get_transaction_v1_organizations__organization_id__transactions__transaction_id__get"];
|
|
980
|
+
put?: never;
|
|
981
|
+
post?: never;
|
|
982
|
+
delete?: never;
|
|
983
|
+
options?: never;
|
|
984
|
+
head?: never;
|
|
985
|
+
patch?: never;
|
|
986
|
+
trace?: never;
|
|
987
|
+
};
|
|
954
988
|
"/v1/tlds/portfolio": {
|
|
955
989
|
parameters: {
|
|
956
990
|
query?: never;
|
|
@@ -1170,6 +1204,55 @@ export interface components {
|
|
|
1170
1204
|
* @enum {string}
|
|
1171
1205
|
*/
|
|
1172
1206
|
BillingTransactionProductType: "domain" | "zones" | "email_forward" | "domain_forward";
|
|
1207
|
+
/** BillingTransactionResponse */
|
|
1208
|
+
BillingTransactionResponse: {
|
|
1209
|
+
/** @description The action performed in the transaction */
|
|
1210
|
+
action: components["schemas"]["BillingTransactionAction"];
|
|
1211
|
+
/**
|
|
1212
|
+
* Billing Transaction Id
|
|
1213
|
+
* Format: typeid
|
|
1214
|
+
*/
|
|
1215
|
+
billing_transaction_id?: TypeId<"billing_transaction">;
|
|
1216
|
+
/**
|
|
1217
|
+
* Completed On
|
|
1218
|
+
* @description The date/time the transaction completed
|
|
1219
|
+
*/
|
|
1220
|
+
completed_on?: Date | null;
|
|
1221
|
+
/**
|
|
1222
|
+
* Created On
|
|
1223
|
+
* Format: date-time
|
|
1224
|
+
* @description The date/time the transaction was created
|
|
1225
|
+
*/
|
|
1226
|
+
created_on?: Date;
|
|
1227
|
+
/**
|
|
1228
|
+
* Product Reference
|
|
1229
|
+
* @description The reference of the product
|
|
1230
|
+
*/
|
|
1231
|
+
product_reference: string | null;
|
|
1232
|
+
/** @description The type of product */
|
|
1233
|
+
product_type: components["schemas"]["BillingTransactionProductType"];
|
|
1234
|
+
/**
|
|
1235
|
+
* @description The status of the transaction
|
|
1236
|
+
* @default pending
|
|
1237
|
+
*/
|
|
1238
|
+
status: components["schemas"]["BillingTransactionStatus"];
|
|
1239
|
+
/**
|
|
1240
|
+
* Updated On
|
|
1241
|
+
* Format: date-time
|
|
1242
|
+
* @description The date/time the transaction was updated
|
|
1243
|
+
*/
|
|
1244
|
+
updated_on?: Date;
|
|
1245
|
+
};
|
|
1246
|
+
/**
|
|
1247
|
+
* BillingTransactionSortField
|
|
1248
|
+
* @enum {string}
|
|
1249
|
+
*/
|
|
1250
|
+
BillingTransactionSortField: "product_type" | "action" | "status" | "created_on" | "completed_on";
|
|
1251
|
+
/**
|
|
1252
|
+
* BillingTransactionStatus
|
|
1253
|
+
* @enum {string}
|
|
1254
|
+
*/
|
|
1255
|
+
BillingTransactionStatus: "pending" | "succeeded" | "failed" | "canceled";
|
|
1173
1256
|
/** Body_issue_organization_token_v1_auth_token_post */
|
|
1174
1257
|
Body_issue_organization_token_v1_auth_token_post: {
|
|
1175
1258
|
/**
|
|
@@ -3379,6 +3462,12 @@ export interface components {
|
|
|
3379
3462
|
/** Total Pages */
|
|
3380
3463
|
total_pages: number;
|
|
3381
3464
|
};
|
|
3465
|
+
/** Pagination[BillingTransactionResponse] */
|
|
3466
|
+
Pagination_BillingTransactionResponse_: {
|
|
3467
|
+
pagination: components["schemas"]["PaginationMetadata"];
|
|
3468
|
+
/** Results */
|
|
3469
|
+
results: components["schemas"]["BillingTransactionResponse"][];
|
|
3470
|
+
};
|
|
3382
3471
|
/** Pagination[ContactSchema] */
|
|
3383
3472
|
Pagination_ContactSchema_: {
|
|
3384
3473
|
pagination: components["schemas"]["PaginationMetadata"];
|
|
@@ -3545,16 +3634,8 @@ export interface components {
|
|
|
3545
3634
|
PriceInfo: {
|
|
3546
3635
|
/** Currency */
|
|
3547
3636
|
currency: string;
|
|
3548
|
-
/**
|
|
3549
|
-
|
|
3550
|
-
* @description Period unit: 'y' (year), 'm' (month), 'd' (day)
|
|
3551
|
-
*/
|
|
3552
|
-
period_unit?: string | null;
|
|
3553
|
-
/**
|
|
3554
|
-
* Period Value
|
|
3555
|
-
* @description Period value (e.g., 1 for 1 year)
|
|
3556
|
-
*/
|
|
3557
|
-
period_value?: number | null;
|
|
3637
|
+
/** @description Pricing period (e.g., 1 year, 2 months) */
|
|
3638
|
+
period?: components["schemas"]["PricingPeriod"] | null;
|
|
3558
3639
|
/** Price */
|
|
3559
3640
|
price: string;
|
|
3560
3641
|
/** Product Action */
|
|
@@ -3564,6 +3645,16 @@ export interface components {
|
|
|
3564
3645
|
/** Product Type */
|
|
3565
3646
|
product_type: string;
|
|
3566
3647
|
};
|
|
3648
|
+
/** PricingPeriod */
|
|
3649
|
+
PricingPeriod: {
|
|
3650
|
+
/** @description The unit of the period */
|
|
3651
|
+
unit: components["schemas"]["PeriodUnit"];
|
|
3652
|
+
/**
|
|
3653
|
+
* Value
|
|
3654
|
+
* @description Amount of time in the unit
|
|
3655
|
+
*/
|
|
3656
|
+
value: number;
|
|
3657
|
+
};
|
|
3567
3658
|
/** Problem */
|
|
3568
3659
|
Problem: {
|
|
3569
3660
|
/** Problem detail */
|
|
@@ -7662,6 +7753,82 @@ export interface operations {
|
|
|
7662
7753
|
};
|
|
7663
7754
|
};
|
|
7664
7755
|
};
|
|
7756
|
+
get_transactions_v1_organizations__organization_id__transactions_get: {
|
|
7757
|
+
parameters: {
|
|
7758
|
+
query?: {
|
|
7759
|
+
sort_by?: components["schemas"]["BillingTransactionSortField"];
|
|
7760
|
+
sort_order?: components["schemas"]["SortOrder"];
|
|
7761
|
+
product_reference?: string | null;
|
|
7762
|
+
product_type?: components["schemas"]["BillingTransactionProductType"] | null;
|
|
7763
|
+
action?: components["schemas"]["BillingTransactionAction"] | null;
|
|
7764
|
+
status?: components["schemas"]["BillingTransactionStatus"] | null;
|
|
7765
|
+
created_after?: Date | null;
|
|
7766
|
+
created_before?: Date | null;
|
|
7767
|
+
completed_after?: Date | null;
|
|
7768
|
+
completed_before?: Date | null;
|
|
7769
|
+
page?: number;
|
|
7770
|
+
page_size?: number;
|
|
7771
|
+
};
|
|
7772
|
+
header?: never;
|
|
7773
|
+
path: {
|
|
7774
|
+
organization_id: TypeId<"organization">;
|
|
7775
|
+
};
|
|
7776
|
+
cookie?: never;
|
|
7777
|
+
};
|
|
7778
|
+
requestBody?: never;
|
|
7779
|
+
responses: {
|
|
7780
|
+
/** @description Successful Response */
|
|
7781
|
+
200: {
|
|
7782
|
+
headers: {
|
|
7783
|
+
[name: string]: unknown;
|
|
7784
|
+
};
|
|
7785
|
+
content: {
|
|
7786
|
+
"application/json": components["schemas"]["Pagination_BillingTransactionResponse_"];
|
|
7787
|
+
};
|
|
7788
|
+
};
|
|
7789
|
+
/** @description Validation Error */
|
|
7790
|
+
422: {
|
|
7791
|
+
headers: {
|
|
7792
|
+
[name: string]: unknown;
|
|
7793
|
+
};
|
|
7794
|
+
content: {
|
|
7795
|
+
"application/problem+json": components["schemas"]["HTTPValidationError"];
|
|
7796
|
+
};
|
|
7797
|
+
};
|
|
7798
|
+
};
|
|
7799
|
+
};
|
|
7800
|
+
get_transaction_v1_organizations__organization_id__transactions__transaction_id__get: {
|
|
7801
|
+
parameters: {
|
|
7802
|
+
query?: never;
|
|
7803
|
+
header?: never;
|
|
7804
|
+
path: {
|
|
7805
|
+
organization_id: TypeId<"organization">;
|
|
7806
|
+
transaction_id: TypeId<"billing_transaction">;
|
|
7807
|
+
};
|
|
7808
|
+
cookie?: never;
|
|
7809
|
+
};
|
|
7810
|
+
requestBody?: never;
|
|
7811
|
+
responses: {
|
|
7812
|
+
/** @description Successful Response */
|
|
7813
|
+
200: {
|
|
7814
|
+
headers: {
|
|
7815
|
+
[name: string]: unknown;
|
|
7816
|
+
};
|
|
7817
|
+
content: {
|
|
7818
|
+
"application/json": components["schemas"]["BillingTransactionResponse"];
|
|
7819
|
+
};
|
|
7820
|
+
};
|
|
7821
|
+
/** @description Validation Error */
|
|
7822
|
+
422: {
|
|
7823
|
+
headers: {
|
|
7824
|
+
[name: string]: unknown;
|
|
7825
|
+
};
|
|
7826
|
+
content: {
|
|
7827
|
+
"application/problem+json": components["schemas"]["HTTPValidationError"];
|
|
7828
|
+
};
|
|
7829
|
+
};
|
|
7830
|
+
};
|
|
7831
|
+
};
|
|
7665
7832
|
get_tld_portfolio_v1_tlds_portfolio_get: {
|
|
7666
7833
|
parameters: {
|
|
7667
7834
|
query?: never;
|