@opusdns/api 0.93.0 → 0.95.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 +1359 -413
- package/src/helpers/requests.d.ts +335 -108
- package/src/helpers/responses.d.ts +1067 -173
- package/src/helpers/schemas-arrays.d.ts +25 -11
- package/src/helpers/schemas.d.ts +124 -28
- package/src/openapi.yaml +993 -159
- package/src/schema.d.ts +1055 -188
|
@@ -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, RegistryHandleAttributeType, ContactAttributeDefinition, ContactRoleAttributeRequirement, PostalAddressType, ContactConfigBase, DnsChange, DnsRecordCreate, DnsRecord, DnsRrsetCreate, DnsRecordPatchOp, DnsRrset, DnsRrsetPatchOp, DomainAvailabilityCheck, ContactHandle, Nameserver,
|
|
24
|
+
import { DomainDnssecData, DomainDnssecDataCreate, OrganizationAttribute, OrganizationAttributeUpdate, IpRestriction, TldResponseShort, RegistryHandleAttributeType, ContactAttributeDefinition, ContactRoleAttributeRequirement, PostalAddressType, ContactConfigBase, DnsChange, DnsRecordCreate, DnsRecord, DnsRrsetCreate, DnsRecordPatchOp, DnsRrset, DnsRrsetPatchOp, DomainAvailabilityCheck, ContactHandle, Nameserver, DomainForwardPatchOp, HttpRedirectList, DomainForward, DeletePolicyType, SyncOperationType, DomainContact, DomainSearchSuggestionWithPrice, DomainStatus, DomainClientStatus, PriceInfo, ValidationError, LaunchPhaseBase, LocalPresenceRequirementType, ContactRoleType, OrganizationAttribute2, User, OrganizationAttributeCreate, UserCreate, BillingTransaction, ContactSchema, DnsZone, DomainForwardZone, Domain, EmailForwardAlias, EventResponse, Invoice, Organization, Period, Permission, PremiumAffectsType, Relation, TldBase, PostTransferRequirements, UserAttributeBase, DomainAvailability } from './schemas.d';
|
|
25
25
|
|
|
26
26
|
/**
|
|
27
27
|
* DomainDnssecDataResponse
|
|
@@ -318,33 +318,47 @@ export type ContactHandleArray = ContactHandle[];
|
|
|
318
318
|
*/
|
|
319
319
|
export type NameserverArray = Nameserver[];
|
|
320
320
|
/**
|
|
321
|
-
*
|
|
321
|
+
* DomainForwardPatchOp
|
|
322
322
|
*
|
|
323
323
|
* @remarks
|
|
324
|
-
* Array type for
|
|
324
|
+
* Array type for DomainForwardPatchOp objects. Used when the API returns a collection of DomainForwardPatchOp instances.
|
|
325
325
|
*
|
|
326
326
|
* @example
|
|
327
327
|
* ```typescript
|
|
328
|
-
* const items:
|
|
328
|
+
* const items: DomainForwardPatchOpArray = await api.getDomainForwardPatchOps();
|
|
329
329
|
* ```
|
|
330
330
|
*
|
|
331
|
-
* @see {@link
|
|
331
|
+
* @see {@link DomainForwardPatchOp} - The individual DomainForwardPatchOp type definition
|
|
332
332
|
*/
|
|
333
|
-
export type
|
|
333
|
+
export type DomainForwardPatchOpArray = DomainForwardPatchOp[];
|
|
334
334
|
/**
|
|
335
|
-
*
|
|
335
|
+
* HttpRedirectListResponse
|
|
336
336
|
*
|
|
337
337
|
* @remarks
|
|
338
|
-
* Array type for
|
|
338
|
+
* Array type for HttpRedirectListResponse objects. Used when the API returns a collection of HttpRedirectListResponse instances.
|
|
339
339
|
*
|
|
340
340
|
* @example
|
|
341
341
|
* ```typescript
|
|
342
|
-
* const items:
|
|
342
|
+
* const items: HttpRedirectListArray = await api.getHttpRedirectLists();
|
|
343
343
|
* ```
|
|
344
344
|
*
|
|
345
|
-
* @see {@link
|
|
345
|
+
* @see {@link HttpRedirectList} - The individual HttpRedirectListResponse type definition
|
|
346
346
|
*/
|
|
347
|
-
export type
|
|
347
|
+
export type HttpRedirectListArray = HttpRedirectList[];
|
|
348
|
+
/**
|
|
349
|
+
* DomainForward
|
|
350
|
+
*
|
|
351
|
+
* @remarks
|
|
352
|
+
* Array type for DomainForward objects. Used when the API returns a collection of DomainForward instances.
|
|
353
|
+
*
|
|
354
|
+
* @example
|
|
355
|
+
* ```typescript
|
|
356
|
+
* const items: DomainForwardArray = await api.getDomainForwards();
|
|
357
|
+
* ```
|
|
358
|
+
*
|
|
359
|
+
* @see {@link DomainForward} - The individual DomainForward type definition
|
|
360
|
+
*/
|
|
361
|
+
export type DomainForwardArray = DomainForward[];
|
|
348
362
|
/**
|
|
349
363
|
* DeletePolicyType
|
|
350
364
|
*
|
package/src/helpers/schemas.d.ts
CHANGED
|
@@ -1067,21 +1067,37 @@ export type DomainForwardPatchOp = components['schemas']['DomainForwardPatchOp']
|
|
|
1067
1067
|
*/
|
|
1068
1068
|
export type DomainForwardPatchOps = components['schemas']['DomainForwardPatchOps'];
|
|
1069
1069
|
/**
|
|
1070
|
-
*
|
|
1070
|
+
* DomainForwardProtocolSetRequest
|
|
1071
1071
|
*
|
|
1072
1072
|
* @remarks
|
|
1073
|
-
* Type alias for the `
|
|
1074
|
-
* This type represents
|
|
1073
|
+
* Type alias for the `DomainForwardProtocolSetRequest` OpenAPI schema.
|
|
1074
|
+
* This type represents domainforwardprotocolsetrequest data structures used in API requests and responses.
|
|
1075
1075
|
*
|
|
1076
1076
|
* @example
|
|
1077
1077
|
* ```typescript
|
|
1078
|
-
* const response = await api.
|
|
1079
|
-
* const item:
|
|
1078
|
+
* const response = await api.getDomainForwardProtocolSetRequest();
|
|
1079
|
+
* const item: DomainForwardProtocolSetRequest = response.results;
|
|
1080
1080
|
* ```
|
|
1081
1081
|
*
|
|
1082
1082
|
* @see {@link components} - The OpenAPI components schema definition
|
|
1083
1083
|
*/
|
|
1084
|
-
export type
|
|
1084
|
+
export type DomainForwardProtocolSetRequest = components['schemas']['DomainForwardProtocolSetRequest'];
|
|
1085
|
+
/**
|
|
1086
|
+
* DomainForwardProtocolSetResponse
|
|
1087
|
+
*
|
|
1088
|
+
* @remarks
|
|
1089
|
+
* Type alias for the `DomainForwardProtocolSetResponse` OpenAPI schema.
|
|
1090
|
+
* This type represents domainforwardprotocolsetresponse data structures used in API requests and responses.
|
|
1091
|
+
*
|
|
1092
|
+
* @example
|
|
1093
|
+
* ```typescript
|
|
1094
|
+
* const response = await api.getDomainForwardProtocolSet();
|
|
1095
|
+
* const item: DomainForwardProtocolSet = response.results;
|
|
1096
|
+
* ```
|
|
1097
|
+
*
|
|
1098
|
+
* @see {@link components} - The OpenAPI components schema definition
|
|
1099
|
+
*/
|
|
1100
|
+
export type DomainForwardProtocolSet = components['schemas']['DomainForwardProtocolSetResponse'];
|
|
1085
1101
|
/**
|
|
1086
1102
|
* DomainForwardRequest
|
|
1087
1103
|
*
|
|
@@ -1098,6 +1114,38 @@ export type DomainForwardProtocols = components['schemas']['DomainForwardProtoco
|
|
|
1098
1114
|
* @see {@link components} - The OpenAPI components schema definition
|
|
1099
1115
|
*/
|
|
1100
1116
|
export type DomainForwardRequest = components['schemas']['DomainForwardRequest'];
|
|
1117
|
+
/**
|
|
1118
|
+
* DomainForwardSetRequest
|
|
1119
|
+
*
|
|
1120
|
+
* @remarks
|
|
1121
|
+
* Type alias for the `DomainForwardSetRequest` OpenAPI schema.
|
|
1122
|
+
* This type represents domainforwardsetrequest data structures used in API requests and responses.
|
|
1123
|
+
*
|
|
1124
|
+
* @example
|
|
1125
|
+
* ```typescript
|
|
1126
|
+
* const response = await api.getDomainForwardSetRequest();
|
|
1127
|
+
* const item: DomainForwardSetRequest = response.results;
|
|
1128
|
+
* ```
|
|
1129
|
+
*
|
|
1130
|
+
* @see {@link components} - The OpenAPI components schema definition
|
|
1131
|
+
*/
|
|
1132
|
+
export type DomainForwardSetRequest = components['schemas']['DomainForwardSetRequest'];
|
|
1133
|
+
/**
|
|
1134
|
+
* DomainForwardSetResponse
|
|
1135
|
+
*
|
|
1136
|
+
* @remarks
|
|
1137
|
+
* Type alias for the `DomainForwardSetResponse` OpenAPI schema.
|
|
1138
|
+
* This type represents domainforwardsetresponse data structures used in API requests and responses.
|
|
1139
|
+
*
|
|
1140
|
+
* @example
|
|
1141
|
+
* ```typescript
|
|
1142
|
+
* const response = await api.getDomainForwardSet();
|
|
1143
|
+
* const item: DomainForwardSet = response.results;
|
|
1144
|
+
* ```
|
|
1145
|
+
*
|
|
1146
|
+
* @see {@link components} - The OpenAPI components schema definition
|
|
1147
|
+
*/
|
|
1148
|
+
export type DomainForwardSet = components['schemas']['DomainForwardSetResponse'];
|
|
1101
1149
|
/**
|
|
1102
1150
|
* DomainForwardZone
|
|
1103
1151
|
*
|
|
@@ -1675,21 +1723,21 @@ export type HTTPValidationError = components['schemas']['HTTPValidationError'];
|
|
|
1675
1723
|
*/
|
|
1676
1724
|
export type HttpProtocol = components['schemas']['HttpProtocol'];
|
|
1677
1725
|
/**
|
|
1678
|
-
*
|
|
1726
|
+
* HttpRedirectListResponse
|
|
1679
1727
|
*
|
|
1680
1728
|
* @remarks
|
|
1681
|
-
* Type alias for the `
|
|
1682
|
-
* This type represents
|
|
1729
|
+
* Type alias for the `HttpRedirectListResponse` OpenAPI schema.
|
|
1730
|
+
* This type represents httpredirectlistresponse data structures used in API requests and responses.
|
|
1683
1731
|
*
|
|
1684
1732
|
* @example
|
|
1685
1733
|
* ```typescript
|
|
1686
|
-
* const response = await api.
|
|
1687
|
-
* const item:
|
|
1734
|
+
* const response = await api.getHttpRedirectList();
|
|
1735
|
+
* const item: HttpRedirectList = response.results;
|
|
1688
1736
|
* ```
|
|
1689
1737
|
*
|
|
1690
1738
|
* @see {@link components} - The OpenAPI components schema definition
|
|
1691
1739
|
*/
|
|
1692
|
-
export type
|
|
1740
|
+
export type HttpRedirectList = components['schemas']['HttpRedirectListResponse'];
|
|
1693
1741
|
/**
|
|
1694
1742
|
* HttpRedirectRemove
|
|
1695
1743
|
*
|
|
@@ -1706,6 +1754,38 @@ export type HttpRedirect = components['schemas']['HttpRedirect'];
|
|
|
1706
1754
|
* @see {@link components} - The OpenAPI components schema definition
|
|
1707
1755
|
*/
|
|
1708
1756
|
export type HttpRedirectRemove = components['schemas']['HttpRedirectRemove'];
|
|
1757
|
+
/**
|
|
1758
|
+
* HttpRedirectRequest
|
|
1759
|
+
*
|
|
1760
|
+
* @remarks
|
|
1761
|
+
* Type alias for the `HttpRedirectRequest` OpenAPI schema.
|
|
1762
|
+
* This type represents httpredirectrequest data structures used in API requests and responses.
|
|
1763
|
+
*
|
|
1764
|
+
* @example
|
|
1765
|
+
* ```typescript
|
|
1766
|
+
* const response = await api.getHttpRedirectRequest();
|
|
1767
|
+
* const item: HttpRedirectRequest = response.results;
|
|
1768
|
+
* ```
|
|
1769
|
+
*
|
|
1770
|
+
* @see {@link components} - The OpenAPI components schema definition
|
|
1771
|
+
*/
|
|
1772
|
+
export type HttpRedirectRequest = components['schemas']['HttpRedirectRequest'];
|
|
1773
|
+
/**
|
|
1774
|
+
* HttpRedirectUpsert
|
|
1775
|
+
*
|
|
1776
|
+
* @remarks
|
|
1777
|
+
* Type alias for the `HttpRedirectUpsert` OpenAPI schema.
|
|
1778
|
+
* This type represents httpredirectupsert data structures used in API requests and responses.
|
|
1779
|
+
*
|
|
1780
|
+
* @example
|
|
1781
|
+
* ```typescript
|
|
1782
|
+
* const response = await api.getHttpRedirectUpsert();
|
|
1783
|
+
* const item: HttpRedirectUpsert = response.results;
|
|
1784
|
+
* ```
|
|
1785
|
+
*
|
|
1786
|
+
* @see {@link components} - The OpenAPI components schema definition
|
|
1787
|
+
*/
|
|
1788
|
+
export type HttpRedirectUpsert = components['schemas']['HttpRedirectUpsert'];
|
|
1709
1789
|
/**
|
|
1710
1790
|
* IdnBase
|
|
1711
1791
|
*
|
|
@@ -2191,6 +2271,22 @@ export type Pagination_DnsZone = components['schemas']['Pagination_DnsZoneRespon
|
|
|
2191
2271
|
* @see {@link components} - The OpenAPI components schema definition
|
|
2192
2272
|
*/
|
|
2193
2273
|
export type Pagination_DomainForwardZone = components['schemas']['Pagination_DomainForwardZone_'];
|
|
2274
|
+
/**
|
|
2275
|
+
* Pagination[DomainForward]
|
|
2276
|
+
*
|
|
2277
|
+
* @remarks
|
|
2278
|
+
* Type alias for the `Pagination_DomainForward_` OpenAPI schema.
|
|
2279
|
+
* This type represents pagination[domainforward] data structures used in API requests and responses.
|
|
2280
|
+
*
|
|
2281
|
+
* @example
|
|
2282
|
+
* ```typescript
|
|
2283
|
+
* const response = await api.getPagination_DomainForward();
|
|
2284
|
+
* const item: Pagination_DomainForward = response.results;
|
|
2285
|
+
* ```
|
|
2286
|
+
*
|
|
2287
|
+
* @see {@link components} - The OpenAPI components schema definition
|
|
2288
|
+
*/
|
|
2289
|
+
export type Pagination_DomainForward = components['schemas']['Pagination_DomainForward_'];
|
|
2194
2290
|
/**
|
|
2195
2291
|
* Pagination[DomainResponse]
|
|
2196
2292
|
*
|
|
@@ -2527,22 +2623,6 @@ export type PricingPeriod = components['schemas']['PricingPeriod'];
|
|
|
2527
2623
|
* @see {@link components} - The OpenAPI components schema definition
|
|
2528
2624
|
*/
|
|
2529
2625
|
export type Problem = components['schemas']['Problem'];
|
|
2530
|
-
/**
|
|
2531
|
-
* ProtocolRedirects
|
|
2532
|
-
*
|
|
2533
|
-
* @remarks
|
|
2534
|
-
* Type alias for the `ProtocolRedirects` OpenAPI schema.
|
|
2535
|
-
* This type represents protocolredirects data structures used in API requests and responses.
|
|
2536
|
-
*
|
|
2537
|
-
* @example
|
|
2538
|
-
* ```typescript
|
|
2539
|
-
* const response = await api.getProtocolRedirects();
|
|
2540
|
-
* const item: ProtocolRedirects = response.results;
|
|
2541
|
-
* ```
|
|
2542
|
-
*
|
|
2543
|
-
* @see {@link components} - The OpenAPI components schema definition
|
|
2544
|
-
*/
|
|
2545
|
-
export type ProtocolRedirects = components['schemas']['ProtocolRedirects'];
|
|
2546
2626
|
/**
|
|
2547
2627
|
* PublicAuthRequestForm
|
|
2548
2628
|
*
|
|
@@ -3087,6 +3167,22 @@ export type VerificationType = components['schemas']['VerificationType'];
|
|
|
3087
3167
|
* @see {@link components} - The OpenAPI components schema definition
|
|
3088
3168
|
*/
|
|
3089
3169
|
export type WhoisBase = components['schemas']['WhoisBase'];
|
|
3170
|
+
/**
|
|
3171
|
+
* WildcardHttpRedirectRequest
|
|
3172
|
+
*
|
|
3173
|
+
* @remarks
|
|
3174
|
+
* Type alias for the `WildcardHttpRedirectRequest` OpenAPI schema.
|
|
3175
|
+
* This type represents wildcardhttpredirectrequest data structures used in API requests and responses.
|
|
3176
|
+
*
|
|
3177
|
+
* @example
|
|
3178
|
+
* ```typescript
|
|
3179
|
+
* const response = await api.getWildcardHttpRedirectRequest();
|
|
3180
|
+
* const item: WildcardHttpRedirectRequest = response.results;
|
|
3181
|
+
* ```
|
|
3182
|
+
*
|
|
3183
|
+
* @see {@link components} - The OpenAPI components schema definition
|
|
3184
|
+
*/
|
|
3185
|
+
export type WildcardHttpRedirectRequest = components['schemas']['WildcardHttpRedirectRequest'];
|
|
3090
3186
|
/**
|
|
3091
3187
|
* ZoneSortField
|
|
3092
3188
|
*
|