@opusdns/api 0.271.0 → 0.273.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/keys.ts +52 -0
- package/src/helpers/requests.d.ts +108 -108
- package/src/helpers/responses.d.ts +160 -160
- package/src/openapi.yaml +167 -151
- package/src/schema.d.ts +110 -100
package/src/schema.d.ts
CHANGED
|
@@ -1527,30 +1527,6 @@ export interface paths {
|
|
|
1527
1527
|
patch: operations["update_attributes_v1_organizations_attributes_patch"];
|
|
1528
1528
|
trace?: never;
|
|
1529
1529
|
};
|
|
1530
|
-
"/v1/organizations/attributes/{organization_id}": {
|
|
1531
|
-
parameters: {
|
|
1532
|
-
query?: never;
|
|
1533
|
-
header?: never;
|
|
1534
|
-
path?: never;
|
|
1535
|
-
cookie?: never;
|
|
1536
|
-
};
|
|
1537
|
-
/**
|
|
1538
|
-
* List organization attributes
|
|
1539
|
-
* @description Retrieves a list of organization attributes for the specified organization
|
|
1540
|
-
*/
|
|
1541
|
-
get: operations["get_attributes_v1_organizations_attributes__organization_id__get"];
|
|
1542
|
-
put?: never;
|
|
1543
|
-
post?: never;
|
|
1544
|
-
delete?: never;
|
|
1545
|
-
options?: never;
|
|
1546
|
-
head?: never;
|
|
1547
|
-
/**
|
|
1548
|
-
* Update organization attributes
|
|
1549
|
-
* @description Updates one or more organization attributes for the specified organization
|
|
1550
|
-
*/
|
|
1551
|
-
patch: operations["update_attributes_v1_organizations_attributes__organization_id__patch"];
|
|
1552
|
-
trace?: never;
|
|
1553
|
-
};
|
|
1554
1530
|
"/v1/organizations/ip-restrictions": {
|
|
1555
1531
|
parameters: {
|
|
1556
1532
|
query?: never;
|
|
@@ -1685,6 +1661,30 @@ export interface paths {
|
|
|
1685
1661
|
patch: operations["update_organization_v1_organizations__organization_id__patch"];
|
|
1686
1662
|
trace?: never;
|
|
1687
1663
|
};
|
|
1664
|
+
"/v1/organizations/{organization_id}/attributes": {
|
|
1665
|
+
parameters: {
|
|
1666
|
+
query?: never;
|
|
1667
|
+
header?: never;
|
|
1668
|
+
path?: never;
|
|
1669
|
+
cookie?: never;
|
|
1670
|
+
};
|
|
1671
|
+
/**
|
|
1672
|
+
* List organization attributes
|
|
1673
|
+
* @description Retrieves a list of organization attributes for the specified organization
|
|
1674
|
+
*/
|
|
1675
|
+
get: operations["get_attributes_v1_organizations__organization_id__attributes_get"];
|
|
1676
|
+
put?: never;
|
|
1677
|
+
post?: never;
|
|
1678
|
+
delete?: never;
|
|
1679
|
+
options?: never;
|
|
1680
|
+
head?: never;
|
|
1681
|
+
/**
|
|
1682
|
+
* Update organization attributes
|
|
1683
|
+
* @description Updates one or more organization attributes for the specified organization
|
|
1684
|
+
*/
|
|
1685
|
+
patch: operations["update_attributes_v1_organizations__organization_id__attributes_patch"];
|
|
1686
|
+
trace?: never;
|
|
1687
|
+
};
|
|
1688
1688
|
"/v1/organizations/{organization_id}/billing/invoices": {
|
|
1689
1689
|
parameters: {
|
|
1690
1690
|
query?: never;
|
|
@@ -4011,6 +4011,11 @@ export interface components {
|
|
|
4011
4011
|
* @description The auth code used for the domain
|
|
4012
4012
|
*/
|
|
4013
4013
|
auth_code?: string | null;
|
|
4014
|
+
/**
|
|
4015
|
+
* The accept_hash of the related claims notice
|
|
4016
|
+
* @description During the claims phase domain names that match a trademark registered in the Trademark Clearinghouse require an acceptance by the registrant.
|
|
4017
|
+
*/
|
|
4018
|
+
claims_notice_acceptance_hash?: string | null;
|
|
4014
4019
|
/**
|
|
4015
4020
|
* Contacts
|
|
4016
4021
|
* @description The contacts of the domain
|
|
@@ -4168,6 +4173,11 @@ export interface components {
|
|
|
4168
4173
|
* @description The auth code used for the domain
|
|
4169
4174
|
*/
|
|
4170
4175
|
auth_code?: string | null;
|
|
4176
|
+
/**
|
|
4177
|
+
* The accept_hash of the related claims notice
|
|
4178
|
+
* @description During the claims phase domain names that match a trademark registered in the Trademark Clearinghouse require an acceptance by the registrant.
|
|
4179
|
+
*/
|
|
4180
|
+
claims_notice_acceptance_hash?: string | null;
|
|
4171
4181
|
/**
|
|
4172
4182
|
* Contacts
|
|
4173
4183
|
* @description The contacts of the domain
|
|
@@ -15657,16 +15667,11 @@ export interface operations {
|
|
|
15657
15667
|
};
|
|
15658
15668
|
};
|
|
15659
15669
|
};
|
|
15660
|
-
|
|
15670
|
+
list_ip_restrictions_v1_organizations_ip_restrictions_get: {
|
|
15661
15671
|
parameters: {
|
|
15662
|
-
query?:
|
|
15663
|
-
/** @description Optional list of attribute keys to filter */
|
|
15664
|
-
keys?: string[] | null;
|
|
15665
|
-
};
|
|
15672
|
+
query?: never;
|
|
15666
15673
|
header?: never;
|
|
15667
|
-
path
|
|
15668
|
-
organization_id: TypeId<"organization"> | null;
|
|
15669
|
-
};
|
|
15674
|
+
path?: never;
|
|
15670
15675
|
cookie?: never;
|
|
15671
15676
|
};
|
|
15672
15677
|
requestBody?: never;
|
|
@@ -15677,7 +15682,7 @@ export interface operations {
|
|
|
15677
15682
|
[name: string]: unknown;
|
|
15678
15683
|
};
|
|
15679
15684
|
content: {
|
|
15680
|
-
"application/json": components["schemas"]["
|
|
15685
|
+
"application/json": components["schemas"]["IpRestrictionResponse"][];
|
|
15681
15686
|
};
|
|
15682
15687
|
};
|
|
15683
15688
|
/** @description Unauthorized */
|
|
@@ -15723,18 +15728,16 @@ export interface operations {
|
|
|
15723
15728
|
};
|
|
15724
15729
|
};
|
|
15725
15730
|
};
|
|
15726
|
-
|
|
15731
|
+
create_ip_restriction_v1_organizations_ip_restrictions_post: {
|
|
15727
15732
|
parameters: {
|
|
15728
15733
|
query?: never;
|
|
15729
15734
|
header?: never;
|
|
15730
|
-
path
|
|
15731
|
-
organization_id: TypeId<"organization"> | null;
|
|
15732
|
-
};
|
|
15735
|
+
path?: never;
|
|
15733
15736
|
cookie?: never;
|
|
15734
15737
|
};
|
|
15735
15738
|
requestBody: {
|
|
15736
15739
|
content: {
|
|
15737
|
-
"application/json": components["schemas"]["
|
|
15740
|
+
"application/json": components["schemas"]["IpRestrictionCreate"];
|
|
15738
15741
|
};
|
|
15739
15742
|
};
|
|
15740
15743
|
responses: {
|
|
@@ -15744,7 +15747,7 @@ export interface operations {
|
|
|
15744
15747
|
[name: string]: unknown;
|
|
15745
15748
|
};
|
|
15746
15749
|
content: {
|
|
15747
|
-
"application/json": components["schemas"]["
|
|
15750
|
+
"application/json": components["schemas"]["IpRestrictionResponse"];
|
|
15748
15751
|
};
|
|
15749
15752
|
};
|
|
15750
15753
|
/** @description Unauthorized */
|
|
@@ -15790,11 +15793,13 @@ export interface operations {
|
|
|
15790
15793
|
};
|
|
15791
15794
|
};
|
|
15792
15795
|
};
|
|
15793
|
-
|
|
15796
|
+
get_ip_restriction_v1_organizations_ip_restrictions__ip_restriction_id__get: {
|
|
15794
15797
|
parameters: {
|
|
15795
15798
|
query?: never;
|
|
15796
15799
|
header?: never;
|
|
15797
|
-
path
|
|
15800
|
+
path: {
|
|
15801
|
+
ip_restriction_id: number;
|
|
15802
|
+
};
|
|
15798
15803
|
cookie?: never;
|
|
15799
15804
|
};
|
|
15800
15805
|
requestBody?: never;
|
|
@@ -15805,7 +15810,7 @@ export interface operations {
|
|
|
15805
15810
|
[name: string]: unknown;
|
|
15806
15811
|
};
|
|
15807
15812
|
content: {
|
|
15808
|
-
"application/json": components["schemas"]["IpRestrictionResponse"]
|
|
15813
|
+
"application/json": components["schemas"]["IpRestrictionResponse"];
|
|
15809
15814
|
};
|
|
15810
15815
|
};
|
|
15811
15816
|
/** @description Unauthorized */
|
|
@@ -15851,27 +15856,23 @@ export interface operations {
|
|
|
15851
15856
|
};
|
|
15852
15857
|
};
|
|
15853
15858
|
};
|
|
15854
|
-
|
|
15859
|
+
delete_ip_restriction_v1_organizations_ip_restrictions__ip_restriction_id__delete: {
|
|
15855
15860
|
parameters: {
|
|
15856
15861
|
query?: never;
|
|
15857
15862
|
header?: never;
|
|
15858
|
-
path
|
|
15859
|
-
|
|
15860
|
-
};
|
|
15861
|
-
requestBody: {
|
|
15862
|
-
content: {
|
|
15863
|
-
"application/json": components["schemas"]["IpRestrictionCreate"];
|
|
15863
|
+
path: {
|
|
15864
|
+
ip_restriction_id: number;
|
|
15864
15865
|
};
|
|
15866
|
+
cookie?: never;
|
|
15865
15867
|
};
|
|
15868
|
+
requestBody?: never;
|
|
15866
15869
|
responses: {
|
|
15867
15870
|
/** @description Successful Response */
|
|
15868
|
-
|
|
15871
|
+
204: {
|
|
15869
15872
|
headers: {
|
|
15870
15873
|
[name: string]: unknown;
|
|
15871
15874
|
};
|
|
15872
|
-
content
|
|
15873
|
-
"application/json": components["schemas"]["IpRestrictionResponse"];
|
|
15874
|
-
};
|
|
15875
|
+
content?: never;
|
|
15875
15876
|
};
|
|
15876
15877
|
/** @description Unauthorized */
|
|
15877
15878
|
401: {
|
|
@@ -15916,7 +15917,7 @@ export interface operations {
|
|
|
15916
15917
|
};
|
|
15917
15918
|
};
|
|
15918
15919
|
};
|
|
15919
|
-
|
|
15920
|
+
update_ip_restriction_v1_organizations_ip_restrictions__ip_restriction_id__patch: {
|
|
15920
15921
|
parameters: {
|
|
15921
15922
|
query?: never;
|
|
15922
15923
|
header?: never;
|
|
@@ -15925,7 +15926,11 @@ export interface operations {
|
|
|
15925
15926
|
};
|
|
15926
15927
|
cookie?: never;
|
|
15927
15928
|
};
|
|
15928
|
-
requestBody
|
|
15929
|
+
requestBody: {
|
|
15930
|
+
content: {
|
|
15931
|
+
"application/json": components["schemas"]["IpRestrictionUpdate"];
|
|
15932
|
+
};
|
|
15933
|
+
};
|
|
15929
15934
|
responses: {
|
|
15930
15935
|
/** @description Successful Response */
|
|
15931
15936
|
200: {
|
|
@@ -15979,23 +15984,23 @@ export interface operations {
|
|
|
15979
15984
|
};
|
|
15980
15985
|
};
|
|
15981
15986
|
};
|
|
15982
|
-
|
|
15987
|
+
list_roles_v1_organizations_roles_get: {
|
|
15983
15988
|
parameters: {
|
|
15984
15989
|
query?: never;
|
|
15985
15990
|
header?: never;
|
|
15986
|
-
path
|
|
15987
|
-
ip_restriction_id: number;
|
|
15988
|
-
};
|
|
15991
|
+
path?: never;
|
|
15989
15992
|
cookie?: never;
|
|
15990
15993
|
};
|
|
15991
15994
|
requestBody?: never;
|
|
15992
15995
|
responses: {
|
|
15993
15996
|
/** @description Successful Response */
|
|
15994
|
-
|
|
15997
|
+
200: {
|
|
15995
15998
|
headers: {
|
|
15996
15999
|
[name: string]: unknown;
|
|
15997
16000
|
};
|
|
15998
|
-
content
|
|
16001
|
+
content: {
|
|
16002
|
+
"application/json": unknown;
|
|
16003
|
+
};
|
|
15999
16004
|
};
|
|
16000
16005
|
/** @description Unauthorized */
|
|
16001
16006
|
401: {
|
|
@@ -16040,20 +16045,20 @@ export interface operations {
|
|
|
16040
16045
|
};
|
|
16041
16046
|
};
|
|
16042
16047
|
};
|
|
16043
|
-
|
|
16048
|
+
list_users_v1_organizations_users_get: {
|
|
16044
16049
|
parameters: {
|
|
16045
|
-
query?:
|
|
16046
|
-
|
|
16047
|
-
|
|
16048
|
-
|
|
16050
|
+
query?: {
|
|
16051
|
+
sort_by?: components["schemas"]["UserSortField"];
|
|
16052
|
+
sort_order?: components["schemas"]["SortOrder"];
|
|
16053
|
+
search?: string | null;
|
|
16054
|
+
page?: number;
|
|
16055
|
+
page_size?: number;
|
|
16049
16056
|
};
|
|
16057
|
+
header?: never;
|
|
16058
|
+
path?: never;
|
|
16050
16059
|
cookie?: never;
|
|
16051
16060
|
};
|
|
16052
|
-
requestBody
|
|
16053
|
-
content: {
|
|
16054
|
-
"application/json": components["schemas"]["IpRestrictionUpdate"];
|
|
16055
|
-
};
|
|
16056
|
-
};
|
|
16061
|
+
requestBody?: never;
|
|
16057
16062
|
responses: {
|
|
16058
16063
|
/** @description Successful Response */
|
|
16059
16064
|
200: {
|
|
@@ -16061,7 +16066,7 @@ export interface operations {
|
|
|
16061
16066
|
[name: string]: unknown;
|
|
16062
16067
|
};
|
|
16063
16068
|
content: {
|
|
16064
|
-
"application/json": components["schemas"]["
|
|
16069
|
+
"application/json": components["schemas"]["Pagination_UserPublic_"];
|
|
16065
16070
|
};
|
|
16066
16071
|
};
|
|
16067
16072
|
/** @description Unauthorized */
|
|
@@ -16107,11 +16112,13 @@ export interface operations {
|
|
|
16107
16112
|
};
|
|
16108
16113
|
};
|
|
16109
16114
|
};
|
|
16110
|
-
|
|
16115
|
+
get_organization_v1_organizations__organization_id__get: {
|
|
16111
16116
|
parameters: {
|
|
16112
16117
|
query?: never;
|
|
16113
16118
|
header?: never;
|
|
16114
|
-
path
|
|
16119
|
+
path: {
|
|
16120
|
+
organization_id: TypeId<"organization">;
|
|
16121
|
+
};
|
|
16115
16122
|
cookie?: never;
|
|
16116
16123
|
};
|
|
16117
16124
|
requestBody?: never;
|
|
@@ -16122,7 +16129,7 @@ export interface operations {
|
|
|
16122
16129
|
[name: string]: unknown;
|
|
16123
16130
|
};
|
|
16124
16131
|
content: {
|
|
16125
|
-
"application/json":
|
|
16132
|
+
"application/json": components["schemas"]["OrganizationWithBillingData"];
|
|
16126
16133
|
};
|
|
16127
16134
|
};
|
|
16128
16135
|
/** @description Unauthorized */
|
|
@@ -16168,29 +16175,23 @@ export interface operations {
|
|
|
16168
16175
|
};
|
|
16169
16176
|
};
|
|
16170
16177
|
};
|
|
16171
|
-
|
|
16178
|
+
delete_organization_v1_organizations__organization_id__delete: {
|
|
16172
16179
|
parameters: {
|
|
16173
|
-
query?:
|
|
16174
|
-
sort_by?: components["schemas"]["UserSortField"];
|
|
16175
|
-
sort_order?: components["schemas"]["SortOrder"];
|
|
16176
|
-
search?: string | null;
|
|
16177
|
-
page?: number;
|
|
16178
|
-
page_size?: number;
|
|
16179
|
-
};
|
|
16180
|
+
query?: never;
|
|
16180
16181
|
header?: never;
|
|
16181
|
-
path
|
|
16182
|
+
path: {
|
|
16183
|
+
organization_id: TypeId<"organization">;
|
|
16184
|
+
};
|
|
16182
16185
|
cookie?: never;
|
|
16183
16186
|
};
|
|
16184
16187
|
requestBody?: never;
|
|
16185
16188
|
responses: {
|
|
16186
16189
|
/** @description Successful Response */
|
|
16187
|
-
|
|
16190
|
+
204: {
|
|
16188
16191
|
headers: {
|
|
16189
16192
|
[name: string]: unknown;
|
|
16190
16193
|
};
|
|
16191
|
-
content
|
|
16192
|
-
"application/json": components["schemas"]["Pagination_UserPublic_"];
|
|
16193
|
-
};
|
|
16194
|
+
content?: never;
|
|
16194
16195
|
};
|
|
16195
16196
|
/** @description Unauthorized */
|
|
16196
16197
|
401: {
|
|
@@ -16235,7 +16236,7 @@ export interface operations {
|
|
|
16235
16236
|
};
|
|
16236
16237
|
};
|
|
16237
16238
|
};
|
|
16238
|
-
|
|
16239
|
+
update_organization_v1_organizations__organization_id__patch: {
|
|
16239
16240
|
parameters: {
|
|
16240
16241
|
query?: never;
|
|
16241
16242
|
header?: never;
|
|
@@ -16244,7 +16245,11 @@ export interface operations {
|
|
|
16244
16245
|
};
|
|
16245
16246
|
cookie?: never;
|
|
16246
16247
|
};
|
|
16247
|
-
requestBody
|
|
16248
|
+
requestBody: {
|
|
16249
|
+
content: {
|
|
16250
|
+
"application/json": components["schemas"]["OrganizationUpdate"];
|
|
16251
|
+
};
|
|
16252
|
+
};
|
|
16248
16253
|
responses: {
|
|
16249
16254
|
/** @description Successful Response */
|
|
16250
16255
|
200: {
|
|
@@ -16252,7 +16257,7 @@ export interface operations {
|
|
|
16252
16257
|
[name: string]: unknown;
|
|
16253
16258
|
};
|
|
16254
16259
|
content: {
|
|
16255
|
-
"application/json": components["schemas"]["
|
|
16260
|
+
"application/json": components["schemas"]["Organization"];
|
|
16256
16261
|
};
|
|
16257
16262
|
};
|
|
16258
16263
|
/** @description Unauthorized */
|
|
@@ -16298,23 +16303,28 @@ export interface operations {
|
|
|
16298
16303
|
};
|
|
16299
16304
|
};
|
|
16300
16305
|
};
|
|
16301
|
-
|
|
16306
|
+
get_attributes_v1_organizations__organization_id__attributes_get: {
|
|
16302
16307
|
parameters: {
|
|
16303
|
-
query?:
|
|
16308
|
+
query?: {
|
|
16309
|
+
/** @description Optional list of attribute keys to filter */
|
|
16310
|
+
keys?: string[] | null;
|
|
16311
|
+
};
|
|
16304
16312
|
header?: never;
|
|
16305
16313
|
path: {
|
|
16306
|
-
organization_id: TypeId<"organization"
|
|
16314
|
+
organization_id: TypeId<"organization"> | null;
|
|
16307
16315
|
};
|
|
16308
16316
|
cookie?: never;
|
|
16309
16317
|
};
|
|
16310
16318
|
requestBody?: never;
|
|
16311
16319
|
responses: {
|
|
16312
16320
|
/** @description Successful Response */
|
|
16313
|
-
|
|
16321
|
+
200: {
|
|
16314
16322
|
headers: {
|
|
16315
16323
|
[name: string]: unknown;
|
|
16316
16324
|
};
|
|
16317
|
-
content
|
|
16325
|
+
content: {
|
|
16326
|
+
"application/json": components["schemas"]["OrganizationAttributeResponse"][];
|
|
16327
|
+
};
|
|
16318
16328
|
};
|
|
16319
16329
|
/** @description Unauthorized */
|
|
16320
16330
|
401: {
|
|
@@ -16359,18 +16369,18 @@ export interface operations {
|
|
|
16359
16369
|
};
|
|
16360
16370
|
};
|
|
16361
16371
|
};
|
|
16362
|
-
|
|
16372
|
+
update_attributes_v1_organizations__organization_id__attributes_patch: {
|
|
16363
16373
|
parameters: {
|
|
16364
16374
|
query?: never;
|
|
16365
16375
|
header?: never;
|
|
16366
16376
|
path: {
|
|
16367
|
-
organization_id: TypeId<"organization"
|
|
16377
|
+
organization_id: TypeId<"organization"> | null;
|
|
16368
16378
|
};
|
|
16369
16379
|
cookie?: never;
|
|
16370
16380
|
};
|
|
16371
16381
|
requestBody: {
|
|
16372
16382
|
content: {
|
|
16373
|
-
"application/json": components["schemas"]["
|
|
16383
|
+
"application/json": components["schemas"]["OrganizationAttributeUpdate"][];
|
|
16374
16384
|
};
|
|
16375
16385
|
};
|
|
16376
16386
|
responses: {
|
|
@@ -16380,7 +16390,7 @@ export interface operations {
|
|
|
16380
16390
|
[name: string]: unknown;
|
|
16381
16391
|
};
|
|
16382
16392
|
content: {
|
|
16383
|
-
"application/json": components["schemas"]["
|
|
16393
|
+
"application/json": components["schemas"]["OrganizationAttributeResponse"][];
|
|
16384
16394
|
};
|
|
16385
16395
|
};
|
|
16386
16396
|
/** @description Unauthorized */
|