@opusdns/api 0.93.0 → 0.94.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 +2715 -1822
- package/src/helpers/requests.d.ts +255 -108
- package/src/helpers/responses.d.ts +833 -128
- package/src/helpers/schemas-arrays.d.ts +16 -16
- package/src/helpers/schemas.d.ts +104 -40
- package/src/openapi.yaml +730 -122
- package/src/schema.d.ts +790 -116
|
@@ -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, DeletePolicyType, SyncOperationType, DomainContact, DomainSearchSuggestionWithPrice, DomainStatus, DomainClientStatus, PriceInfo, ValidationError, LaunchPhaseBase, LocalPresenceRequirementType, ContactRoleType, OrganizationAttribute2, User, OrganizationAttributeCreate, UserCreate, BillingTransaction, ContactSchema, DnsZone, DomainForward, 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,33 @@ 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
348
|
/**
|
|
349
349
|
* DeletePolicyType
|
|
350
350
|
*
|
|
@@ -598,19 +598,19 @@ export type ContactSchemaArray = ContactSchema[];
|
|
|
598
598
|
*/
|
|
599
599
|
export type DnsZoneArray = DnsZone[];
|
|
600
600
|
/**
|
|
601
|
-
*
|
|
601
|
+
* DomainForward
|
|
602
602
|
*
|
|
603
603
|
* @remarks
|
|
604
|
-
* Array type for
|
|
604
|
+
* Array type for DomainForward objects. Used when the API returns a collection of DomainForward instances.
|
|
605
605
|
*
|
|
606
606
|
* @example
|
|
607
607
|
* ```typescript
|
|
608
|
-
* const items:
|
|
608
|
+
* const items: DomainForwardArray = await api.getDomainForwards();
|
|
609
609
|
* ```
|
|
610
610
|
*
|
|
611
|
-
* @see {@link
|
|
611
|
+
* @see {@link DomainForward} - The individual DomainForward type definition
|
|
612
612
|
*/
|
|
613
|
-
export type
|
|
613
|
+
export type DomainForwardArray = DomainForward[];
|
|
614
614
|
/**
|
|
615
615
|
* DomainResponse
|
|
616
616
|
*
|
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
|
*
|
|
@@ -1099,21 +1115,37 @@ export type DomainForwardProtocols = components['schemas']['DomainForwardProtoco
|
|
|
1099
1115
|
*/
|
|
1100
1116
|
export type DomainForwardRequest = components['schemas']['DomainForwardRequest'];
|
|
1101
1117
|
/**
|
|
1102
|
-
*
|
|
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
|
|
1103
1135
|
*
|
|
1104
1136
|
* @remarks
|
|
1105
|
-
* Type alias for the `
|
|
1106
|
-
* This type represents
|
|
1137
|
+
* Type alias for the `DomainForwardSetResponse` OpenAPI schema.
|
|
1138
|
+
* This type represents domainforwardsetresponse data structures used in API requests and responses.
|
|
1107
1139
|
*
|
|
1108
1140
|
* @example
|
|
1109
1141
|
* ```typescript
|
|
1110
|
-
* const response = await api.
|
|
1111
|
-
* const item:
|
|
1142
|
+
* const response = await api.getDomainForwardSet();
|
|
1143
|
+
* const item: DomainForwardSet = response.results;
|
|
1112
1144
|
* ```
|
|
1113
1145
|
*
|
|
1114
1146
|
* @see {@link components} - The OpenAPI components schema definition
|
|
1115
1147
|
*/
|
|
1116
|
-
export type
|
|
1148
|
+
export type DomainForwardSet = components['schemas']['DomainForwardSetResponse'];
|
|
1117
1149
|
/**
|
|
1118
1150
|
* DomainLifecycleBase
|
|
1119
1151
|
*
|
|
@@ -1675,21 +1707,21 @@ export type HTTPValidationError = components['schemas']['HTTPValidationError'];
|
|
|
1675
1707
|
*/
|
|
1676
1708
|
export type HttpProtocol = components['schemas']['HttpProtocol'];
|
|
1677
1709
|
/**
|
|
1678
|
-
*
|
|
1710
|
+
* HttpRedirectListResponse
|
|
1679
1711
|
*
|
|
1680
1712
|
* @remarks
|
|
1681
|
-
* Type alias for the `
|
|
1682
|
-
* This type represents
|
|
1713
|
+
* Type alias for the `HttpRedirectListResponse` OpenAPI schema.
|
|
1714
|
+
* This type represents httpredirectlistresponse data structures used in API requests and responses.
|
|
1683
1715
|
*
|
|
1684
1716
|
* @example
|
|
1685
1717
|
* ```typescript
|
|
1686
|
-
* const response = await api.
|
|
1687
|
-
* const item:
|
|
1718
|
+
* const response = await api.getHttpRedirectList();
|
|
1719
|
+
* const item: HttpRedirectList = response.results;
|
|
1688
1720
|
* ```
|
|
1689
1721
|
*
|
|
1690
1722
|
* @see {@link components} - The OpenAPI components schema definition
|
|
1691
1723
|
*/
|
|
1692
|
-
export type
|
|
1724
|
+
export type HttpRedirectList = components['schemas']['HttpRedirectListResponse'];
|
|
1693
1725
|
/**
|
|
1694
1726
|
* HttpRedirectRemove
|
|
1695
1727
|
*
|
|
@@ -1706,6 +1738,38 @@ export type HttpRedirect = components['schemas']['HttpRedirect'];
|
|
|
1706
1738
|
* @see {@link components} - The OpenAPI components schema definition
|
|
1707
1739
|
*/
|
|
1708
1740
|
export type HttpRedirectRemove = components['schemas']['HttpRedirectRemove'];
|
|
1741
|
+
/**
|
|
1742
|
+
* HttpRedirectRequest
|
|
1743
|
+
*
|
|
1744
|
+
* @remarks
|
|
1745
|
+
* Type alias for the `HttpRedirectRequest` OpenAPI schema.
|
|
1746
|
+
* This type represents httpredirectrequest data structures used in API requests and responses.
|
|
1747
|
+
*
|
|
1748
|
+
* @example
|
|
1749
|
+
* ```typescript
|
|
1750
|
+
* const response = await api.getHttpRedirectRequest();
|
|
1751
|
+
* const item: HttpRedirectRequest = response.results;
|
|
1752
|
+
* ```
|
|
1753
|
+
*
|
|
1754
|
+
* @see {@link components} - The OpenAPI components schema definition
|
|
1755
|
+
*/
|
|
1756
|
+
export type HttpRedirectRequest = components['schemas']['HttpRedirectRequest'];
|
|
1757
|
+
/**
|
|
1758
|
+
* HttpRedirectUpsert
|
|
1759
|
+
*
|
|
1760
|
+
* @remarks
|
|
1761
|
+
* Type alias for the `HttpRedirectUpsert` OpenAPI schema.
|
|
1762
|
+
* This type represents httpredirectupsert data structures used in API requests and responses.
|
|
1763
|
+
*
|
|
1764
|
+
* @example
|
|
1765
|
+
* ```typescript
|
|
1766
|
+
* const response = await api.getHttpRedirectUpsert();
|
|
1767
|
+
* const item: HttpRedirectUpsert = response.results;
|
|
1768
|
+
* ```
|
|
1769
|
+
*
|
|
1770
|
+
* @see {@link components} - The OpenAPI components schema definition
|
|
1771
|
+
*/
|
|
1772
|
+
export type HttpRedirectUpsert = components['schemas']['HttpRedirectUpsert'];
|
|
1709
1773
|
/**
|
|
1710
1774
|
* IdnBase
|
|
1711
1775
|
*
|
|
@@ -2176,21 +2240,21 @@ export type Pagination_ContactSchema = components['schemas']['Pagination_Contact
|
|
|
2176
2240
|
*/
|
|
2177
2241
|
export type Pagination_DnsZone = components['schemas']['Pagination_DnsZoneResponse_'];
|
|
2178
2242
|
/**
|
|
2179
|
-
* Pagination[
|
|
2243
|
+
* Pagination[DomainForward]
|
|
2180
2244
|
*
|
|
2181
2245
|
* @remarks
|
|
2182
|
-
* Type alias for the `
|
|
2183
|
-
* This type represents pagination[
|
|
2246
|
+
* Type alias for the `Pagination_DomainForward_` OpenAPI schema.
|
|
2247
|
+
* This type represents pagination[domainforward] data structures used in API requests and responses.
|
|
2184
2248
|
*
|
|
2185
2249
|
* @example
|
|
2186
2250
|
* ```typescript
|
|
2187
|
-
* const response = await api.
|
|
2188
|
-
* const item:
|
|
2251
|
+
* const response = await api.getPagination_DomainForward();
|
|
2252
|
+
* const item: Pagination_DomainForward = response.results;
|
|
2189
2253
|
* ```
|
|
2190
2254
|
*
|
|
2191
2255
|
* @see {@link components} - The OpenAPI components schema definition
|
|
2192
2256
|
*/
|
|
2193
|
-
export type
|
|
2257
|
+
export type Pagination_DomainForward = components['schemas']['Pagination_DomainForward_'];
|
|
2194
2258
|
/**
|
|
2195
2259
|
* Pagination[DomainResponse]
|
|
2196
2260
|
*
|
|
@@ -2527,22 +2591,6 @@ export type PricingPeriod = components['schemas']['PricingPeriod'];
|
|
|
2527
2591
|
* @see {@link components} - The OpenAPI components schema definition
|
|
2528
2592
|
*/
|
|
2529
2593
|
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
2594
|
/**
|
|
2547
2595
|
* PublicAuthRequestForm
|
|
2548
2596
|
*
|
|
@@ -3087,6 +3135,22 @@ export type VerificationType = components['schemas']['VerificationType'];
|
|
|
3087
3135
|
* @see {@link components} - The OpenAPI components schema definition
|
|
3088
3136
|
*/
|
|
3089
3137
|
export type WhoisBase = components['schemas']['WhoisBase'];
|
|
3138
|
+
/**
|
|
3139
|
+
* WildcardHttpRedirectRequest
|
|
3140
|
+
*
|
|
3141
|
+
* @remarks
|
|
3142
|
+
* Type alias for the `WildcardHttpRedirectRequest` OpenAPI schema.
|
|
3143
|
+
* This type represents wildcardhttpredirectrequest data structures used in API requests and responses.
|
|
3144
|
+
*
|
|
3145
|
+
* @example
|
|
3146
|
+
* ```typescript
|
|
3147
|
+
* const response = await api.getWildcardHttpRedirectRequest();
|
|
3148
|
+
* const item: WildcardHttpRedirectRequest = response.results;
|
|
3149
|
+
* ```
|
|
3150
|
+
*
|
|
3151
|
+
* @see {@link components} - The OpenAPI components schema definition
|
|
3152
|
+
*/
|
|
3153
|
+
export type WildcardHttpRedirectRequest = components['schemas']['WildcardHttpRedirectRequest'];
|
|
3090
3154
|
/**
|
|
3091
3155
|
* ZoneSortField
|
|
3092
3156
|
*
|