@opusdns/api 0.15.0 → 0.17.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 +1 -101
- package/src/helpers/keys.ts +45 -723
- package/src/helpers/requests.d.ts +229 -147
- package/src/helpers/responses.d.ts +210 -236
- package/src/helpers/schemas-arrays.d.ts +6 -34
- package/src/helpers/schemas.d.ts +18 -162
- package/src/openapi.yaml +146 -311
- package/src/schema.d.ts +117 -211
|
@@ -21,7 +21,7 @@
|
|
|
21
21
|
* This file is auto-generated from the OpenAPI specification.
|
|
22
22
|
* Do not edit manually.
|
|
23
23
|
*/
|
|
24
|
-
import { DomainDnssecData, DomainDnssecDataCreate, OrganizationAttribute, OrganizationAttributeUpdate, IpRestriction, TldResponseShort,
|
|
24
|
+
import { DomainDnssecData, DomainDnssecDataCreate, OrganizationAttribute, OrganizationAttributeUpdate, IpRestriction, TldResponseShort, PostalAddressType, ContactConfigBase, DnsChange, DnsRecordCreate, DnsRecord, DnsRrsetCreate, DnsRecordPatchOp, DnsRrset, DnsRrsetPatchOp, DomainAvailabilityCheck, Nameserver, DeletePolicyType, SyncOperationType, DomainContact, DomainStatus, DomainSearchSuggestion, DomainClientStatus, ValidationError, LaunchPhaseBase, LocalPresenceRequirementType, ContactRoleType, OrganizationAttribute2, User, OrganizationAttributeCreate, UserCreate, ContactSchema, DnsZone, Domain, EmailForwardAlias, EventResponse, OrganizationCredential, Organization, UserNotificationSummary, Period, Permission, PremiumAffectsType, Relation, TldBase, PostTransferRequirements, UserAttributeBase, UserAttributeUpdate, DomainAvailability } from './schemas.d';
|
|
25
25
|
|
|
26
26
|
/**
|
|
27
27
|
* DomainDnssecDataResponse
|
|
@@ -107,20 +107,6 @@ export type IpRestrictionArray = IpRestriction[];
|
|
|
107
107
|
* @see {@link TldResponseShort} - The individual TldResponseShort type definition
|
|
108
108
|
*/
|
|
109
109
|
export type TldResponseShortArray = TldResponseShort[];
|
|
110
|
-
/**
|
|
111
|
-
* BulkOperationResult
|
|
112
|
-
*
|
|
113
|
-
* @remarks
|
|
114
|
-
* Array type for BulkOperationResult objects. Used when the API returns a collection of BulkOperationResult instances.
|
|
115
|
-
*
|
|
116
|
-
* @example
|
|
117
|
-
* ```typescript
|
|
118
|
-
* const items: BulkOperationResultArray = await api.getBulkOperationResults();
|
|
119
|
-
* ```
|
|
120
|
-
*
|
|
121
|
-
* @see {@link BulkOperationResult} - The individual BulkOperationResult type definition
|
|
122
|
-
*/
|
|
123
|
-
export type BulkOperationResultArray = BulkOperationResult[];
|
|
124
110
|
/**
|
|
125
111
|
* PostalAddressType
|
|
126
112
|
*
|
|
@@ -359,20 +345,6 @@ export type DomainSearchSuggestionArray = DomainSearchSuggestion[];
|
|
|
359
345
|
* @see {@link DomainClientStatus} - The individual DomainClientStatus type definition
|
|
360
346
|
*/
|
|
361
347
|
export type DomainClientStatusArray = DomainClientStatus[];
|
|
362
|
-
/**
|
|
363
|
-
* EmailForwardBulkUpdateItem
|
|
364
|
-
*
|
|
365
|
-
* @remarks
|
|
366
|
-
* Array type for EmailForwardBulkUpdateItem objects. Used when the API returns a collection of EmailForwardBulkUpdateItem instances.
|
|
367
|
-
*
|
|
368
|
-
* @example
|
|
369
|
-
* ```typescript
|
|
370
|
-
* const items: EmailForwardBulkUpdateItemArray = await api.getEmailForwardBulkUpdateItems();
|
|
371
|
-
* ```
|
|
372
|
-
*
|
|
373
|
-
* @see {@link EmailForwardBulkUpdateItem} - The individual EmailForwardBulkUpdateItem type definition
|
|
374
|
-
*/
|
|
375
|
-
export type EmailForwardBulkUpdateItemArray = EmailForwardBulkUpdateItem[];
|
|
376
348
|
/**
|
|
377
349
|
* ValidationError
|
|
378
350
|
*
|
|
@@ -528,19 +500,19 @@ export type DnsZoneArray = DnsZone[];
|
|
|
528
500
|
*/
|
|
529
501
|
export type DomainArray = Domain[];
|
|
530
502
|
/**
|
|
531
|
-
*
|
|
503
|
+
* EmailForwardAlias
|
|
532
504
|
*
|
|
533
505
|
* @remarks
|
|
534
|
-
* Array type for
|
|
506
|
+
* Array type for EmailForwardAlias objects. Used when the API returns a collection of EmailForwardAlias instances.
|
|
535
507
|
*
|
|
536
508
|
* @example
|
|
537
509
|
* ```typescript
|
|
538
|
-
* const items:
|
|
510
|
+
* const items: EmailForwardAliasArray = await api.getEmailForwardAliass();
|
|
539
511
|
* ```
|
|
540
512
|
*
|
|
541
|
-
* @see {@link
|
|
513
|
+
* @see {@link EmailForwardAlias} - The individual EmailForwardAlias type definition
|
|
542
514
|
*/
|
|
543
|
-
export type
|
|
515
|
+
export type EmailForwardAliasArray = EmailForwardAlias[];
|
|
544
516
|
/**
|
|
545
517
|
* EventResponse
|
|
546
518
|
*
|
package/src/helpers/schemas.d.ts
CHANGED
|
@@ -74,70 +74,6 @@ export type AllowedNumberOfNameserverBase = components['schemas']['AllowedNumber
|
|
|
74
74
|
* @see {@link components} - The OpenAPI components schema definition
|
|
75
75
|
*/
|
|
76
76
|
export type Body_issue_organization_token_v1_auth_token_post = components['schemas']['Body_issue_organization_token_v1_auth_token_post'];
|
|
77
|
-
/**
|
|
78
|
-
* BulkOperationResponse[EmailForwardBulkDeleteResult]
|
|
79
|
-
*
|
|
80
|
-
* @remarks
|
|
81
|
-
* Type alias for the `BulkOperationResponse_EmailForwardBulkDeleteResult_` OpenAPI schema.
|
|
82
|
-
* This type represents bulkoperationresponse[emailforwardbulkdeleteresult] data structures used in API requests and responses.
|
|
83
|
-
*
|
|
84
|
-
* @example
|
|
85
|
-
* ```typescript
|
|
86
|
-
* const response = await api.getEmailForwardBulkDeleteResult();
|
|
87
|
-
* const item: EmailForwardBulkDeleteResult = response.results;
|
|
88
|
-
* ```
|
|
89
|
-
*
|
|
90
|
-
* @see {@link components} - The OpenAPI components schema definition
|
|
91
|
-
*/
|
|
92
|
-
export type EmailForwardBulkDeleteResult = components['schemas']['BulkOperationResponse_EmailForwardBulkDeleteResult_'];
|
|
93
|
-
/**
|
|
94
|
-
* BulkOperationResponse[EmailForwardBulkUpdateResult]
|
|
95
|
-
*
|
|
96
|
-
* @remarks
|
|
97
|
-
* Type alias for the `BulkOperationResponse_EmailForwardBulkUpdateResult_` OpenAPI schema.
|
|
98
|
-
* This type represents bulkoperationresponse[emailforwardbulkupdateresult] data structures used in API requests and responses.
|
|
99
|
-
*
|
|
100
|
-
* @example
|
|
101
|
-
* ```typescript
|
|
102
|
-
* const response = await api.getEmailForwardBulkUpdateResult();
|
|
103
|
-
* const item: EmailForwardBulkUpdateResult = response.results;
|
|
104
|
-
* ```
|
|
105
|
-
*
|
|
106
|
-
* @see {@link components} - The OpenAPI components schema definition
|
|
107
|
-
*/
|
|
108
|
-
export type EmailForwardBulkUpdateResult = components['schemas']['BulkOperationResponse_EmailForwardBulkUpdateResult_'];
|
|
109
|
-
/**
|
|
110
|
-
* BulkOperationResult
|
|
111
|
-
*
|
|
112
|
-
* @remarks
|
|
113
|
-
* Type alias for the `BulkOperationResult` OpenAPI schema.
|
|
114
|
-
* This type represents bulkoperationresult data structures used in API requests and responses.
|
|
115
|
-
*
|
|
116
|
-
* @example
|
|
117
|
-
* ```typescript
|
|
118
|
-
* const response = await api.getBulkOperationResult();
|
|
119
|
-
* const item: BulkOperationResult = response.results;
|
|
120
|
-
* ```
|
|
121
|
-
*
|
|
122
|
-
* @see {@link components} - The OpenAPI components schema definition
|
|
123
|
-
*/
|
|
124
|
-
export type BulkOperationResult = components['schemas']['BulkOperationResult'];
|
|
125
|
-
/**
|
|
126
|
-
* BulkOperationStatus
|
|
127
|
-
*
|
|
128
|
-
* @remarks
|
|
129
|
-
* Type alias for the `BulkOperationStatus` OpenAPI schema.
|
|
130
|
-
* This type represents bulkoperationstatus data structures used in API requests and responses.
|
|
131
|
-
*
|
|
132
|
-
* @example
|
|
133
|
-
* ```typescript
|
|
134
|
-
* const response = await api.getBulkOperationStatus();
|
|
135
|
-
* const item: BulkOperationStatus = response.results;
|
|
136
|
-
* ```
|
|
137
|
-
*
|
|
138
|
-
* @see {@link components} - The OpenAPI components schema definition
|
|
139
|
-
*/
|
|
140
|
-
export type BulkOperationStatus = components['schemas']['BulkOperationStatus'];
|
|
141
77
|
/**
|
|
142
78
|
* ContactConfigBase
|
|
143
79
|
*
|
|
@@ -1179,117 +1115,37 @@ export type DomainUpdate = components['schemas']['DomainUpdate'];
|
|
|
1179
1115
|
*/
|
|
1180
1116
|
export type DomainsExpiringSoon = components['schemas']['DomainsExpiringSoon'];
|
|
1181
1117
|
/**
|
|
1182
|
-
*
|
|
1183
|
-
*
|
|
1184
|
-
* @remarks
|
|
1185
|
-
* Type alias for the `EmailForward` OpenAPI schema.
|
|
1186
|
-
* This type represents emailforward data structures used in API requests and responses.
|
|
1187
|
-
*
|
|
1188
|
-
* @example
|
|
1189
|
-
* ```typescript
|
|
1190
|
-
* const response = await api.getEmailForward();
|
|
1191
|
-
* const item: EmailForward = response.results;
|
|
1192
|
-
* ```
|
|
1193
|
-
*
|
|
1194
|
-
* @see {@link components} - The OpenAPI components schema definition
|
|
1195
|
-
*/
|
|
1196
|
-
export type EmailForward = components['schemas']['EmailForward'];
|
|
1197
|
-
/**
|
|
1198
|
-
* EmailForwardBulkDelete
|
|
1199
|
-
*
|
|
1200
|
-
* @remarks
|
|
1201
|
-
* Type alias for the `EmailForwardBulkDelete` OpenAPI schema.
|
|
1202
|
-
* This type represents emailforwardbulkdelete data structures used in API requests and responses.
|
|
1203
|
-
*
|
|
1204
|
-
* @example
|
|
1205
|
-
* ```typescript
|
|
1206
|
-
* const response = await api.getEmailForwardBulkDelete();
|
|
1207
|
-
* const item: EmailForwardBulkDelete = response.results;
|
|
1208
|
-
* ```
|
|
1209
|
-
*
|
|
1210
|
-
* @see {@link components} - The OpenAPI components schema definition
|
|
1211
|
-
*/
|
|
1212
|
-
export type EmailForwardBulkDelete = components['schemas']['EmailForwardBulkDelete'];
|
|
1213
|
-
/**
|
|
1214
|
-
* EmailForwardBulkUpdate
|
|
1215
|
-
*
|
|
1216
|
-
* @remarks
|
|
1217
|
-
* Type alias for the `EmailForwardBulkUpdate` OpenAPI schema.
|
|
1218
|
-
* This type represents emailforwardbulkupdate data structures used in API requests and responses.
|
|
1219
|
-
*
|
|
1220
|
-
* @example
|
|
1221
|
-
* ```typescript
|
|
1222
|
-
* const response = await api.getEmailForwardBulkUpdate();
|
|
1223
|
-
* const item: EmailForwardBulkUpdate = response.results;
|
|
1224
|
-
* ```
|
|
1225
|
-
*
|
|
1226
|
-
* @see {@link components} - The OpenAPI components schema definition
|
|
1227
|
-
*/
|
|
1228
|
-
export type EmailForwardBulkUpdate = components['schemas']['EmailForwardBulkUpdate'];
|
|
1229
|
-
/**
|
|
1230
|
-
* EmailForwardBulkUpdateItem
|
|
1231
|
-
*
|
|
1232
|
-
* @remarks
|
|
1233
|
-
* Type alias for the `EmailForwardBulkUpdateItem` OpenAPI schema.
|
|
1234
|
-
* This type represents emailforwardbulkupdateitem data structures used in API requests and responses.
|
|
1235
|
-
*
|
|
1236
|
-
* @example
|
|
1237
|
-
* ```typescript
|
|
1238
|
-
* const response = await api.getEmailForwardBulkUpdateItem();
|
|
1239
|
-
* const item: EmailForwardBulkUpdateItem = response.results;
|
|
1240
|
-
* ```
|
|
1241
|
-
*
|
|
1242
|
-
* @see {@link components} - The OpenAPI components schema definition
|
|
1243
|
-
*/
|
|
1244
|
-
export type EmailForwardBulkUpdateItem = components['schemas']['EmailForwardBulkUpdateItem'];
|
|
1245
|
-
/**
|
|
1246
|
-
* EmailForwardCreate
|
|
1247
|
-
*
|
|
1248
|
-
* @remarks
|
|
1249
|
-
* Type alias for the `EmailForwardCreate` OpenAPI schema.
|
|
1250
|
-
* This type represents emailforwardcreate data structures used in API requests and responses.
|
|
1251
|
-
*
|
|
1252
|
-
* @example
|
|
1253
|
-
* ```typescript
|
|
1254
|
-
* const response = await api.getEmailForwardCreate();
|
|
1255
|
-
* const item: EmailForwardCreate = response.results;
|
|
1256
|
-
* ```
|
|
1257
|
-
*
|
|
1258
|
-
* @see {@link components} - The OpenAPI components schema definition
|
|
1259
|
-
*/
|
|
1260
|
-
export type EmailForwardCreate = components['schemas']['EmailForwardCreate'];
|
|
1261
|
-
/**
|
|
1262
|
-
* EmailForwardStatus
|
|
1118
|
+
* EmailForwardAlias
|
|
1263
1119
|
*
|
|
1264
1120
|
* @remarks
|
|
1265
|
-
* Type alias for the `
|
|
1266
|
-
* This type represents
|
|
1121
|
+
* Type alias for the `EmailForwardAlias` OpenAPI schema.
|
|
1122
|
+
* This type represents emailforwardalias data structures used in API requests and responses.
|
|
1267
1123
|
*
|
|
1268
1124
|
* @example
|
|
1269
1125
|
* ```typescript
|
|
1270
|
-
* const response = await api.
|
|
1271
|
-
* const item:
|
|
1126
|
+
* const response = await api.getEmailForwardAlias();
|
|
1127
|
+
* const item: EmailForwardAlias = response.results;
|
|
1272
1128
|
* ```
|
|
1273
1129
|
*
|
|
1274
1130
|
* @see {@link components} - The OpenAPI components schema definition
|
|
1275
1131
|
*/
|
|
1276
|
-
export type
|
|
1132
|
+
export type EmailForwardAlias = components['schemas']['EmailForwardAlias'];
|
|
1277
1133
|
/**
|
|
1278
|
-
*
|
|
1134
|
+
* EmailForwardAliasUpdate
|
|
1279
1135
|
*
|
|
1280
1136
|
* @remarks
|
|
1281
|
-
* Type alias for the `
|
|
1282
|
-
* This type represents
|
|
1137
|
+
* Type alias for the `EmailForwardAliasUpdate` OpenAPI schema.
|
|
1138
|
+
* This type represents emailforwardaliasupdate data structures used in API requests and responses.
|
|
1283
1139
|
*
|
|
1284
1140
|
* @example
|
|
1285
1141
|
* ```typescript
|
|
1286
|
-
* const response = await api.
|
|
1287
|
-
* const item:
|
|
1142
|
+
* const response = await api.getEmailForwardAliasUpdate();
|
|
1143
|
+
* const item: EmailForwardAliasUpdate = response.results;
|
|
1288
1144
|
* ```
|
|
1289
1145
|
*
|
|
1290
1146
|
* @see {@link components} - The OpenAPI components schema definition
|
|
1291
1147
|
*/
|
|
1292
|
-
export type
|
|
1148
|
+
export type EmailForwardAliasUpdate = components['schemas']['EmailForwardAliasUpdate'];
|
|
1293
1149
|
/**
|
|
1294
1150
|
* EmailVerificationStatus
|
|
1295
1151
|
*
|
|
@@ -1979,21 +1835,21 @@ export type Pagination_DnsZone = components['schemas']['Pagination_DnsZoneRespon
|
|
|
1979
1835
|
*/
|
|
1980
1836
|
export type Pagination_Domain = components['schemas']['Pagination_DomainResponse_'];
|
|
1981
1837
|
/**
|
|
1982
|
-
* Pagination[
|
|
1838
|
+
* Pagination[EmailForwardAlias]
|
|
1983
1839
|
*
|
|
1984
1840
|
* @remarks
|
|
1985
|
-
* Type alias for the `
|
|
1986
|
-
* This type represents pagination[
|
|
1841
|
+
* Type alias for the `Pagination_EmailForwardAlias_` OpenAPI schema.
|
|
1842
|
+
* This type represents pagination[emailforwardalias] data structures used in API requests and responses.
|
|
1987
1843
|
*
|
|
1988
1844
|
* @example
|
|
1989
1845
|
* ```typescript
|
|
1990
|
-
* const response = await api.
|
|
1991
|
-
* const item:
|
|
1846
|
+
* const response = await api.getPagination_EmailForwardAlias();
|
|
1847
|
+
* const item: Pagination_EmailForwardAlias = response.results;
|
|
1992
1848
|
* ```
|
|
1993
1849
|
*
|
|
1994
1850
|
* @see {@link components} - The OpenAPI components schema definition
|
|
1995
1851
|
*/
|
|
1996
|
-
export type
|
|
1852
|
+
export type Pagination_EmailForwardAlias = components['schemas']['Pagination_EmailForwardAlias_'];
|
|
1997
1853
|
/**
|
|
1998
1854
|
* Pagination[EventResponse]
|
|
1999
1855
|
*
|