@opusdns/api 0.10.0 → 0.12.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 +3 -3
- package/src/helpers/constants.ts +771 -1
- package/src/helpers/index.ts +1 -0
- package/src/helpers/keys.ts +8077 -4699
- package/src/helpers/requests.ts +537 -441
- package/src/helpers/responses.ts +440 -547
- package/src/helpers/schemas-arrays.ts +169 -1
- package/src/helpers/schemas.ts +624 -0
- package/src/openapi.yaml +975 -1
- package/src/schema.d.ts +732 -0
- /package/src/{index.ts → index.d.ts} +0 -0
package/src/helpers/schemas.ts
CHANGED
|
@@ -26,6 +26,38 @@
|
|
|
26
26
|
*/
|
|
27
27
|
import { components } from '../schema';
|
|
28
28
|
|
|
29
|
+
/**
|
|
30
|
+
* AllocationMethodType
|
|
31
|
+
*
|
|
32
|
+
* @remarks
|
|
33
|
+
* Type alias for the `AllocationMethodType` OpenAPI schema.
|
|
34
|
+
* This type represents allocationmethodtype data structures used in API requests and responses.
|
|
35
|
+
*
|
|
36
|
+
* @example
|
|
37
|
+
* ```typescript
|
|
38
|
+
* const response = await api.getAllocationMethodType();
|
|
39
|
+
* const item: AllocationMethodType = response.results;
|
|
40
|
+
* ```
|
|
41
|
+
*
|
|
42
|
+
* @see {@link components} - The OpenAPI components schema definition
|
|
43
|
+
*/
|
|
44
|
+
export type AllocationMethodType = components['schemas']['AllocationMethodType'];
|
|
45
|
+
/**
|
|
46
|
+
* AllowedNumberOfNameserverBase
|
|
47
|
+
*
|
|
48
|
+
* @remarks
|
|
49
|
+
* Type alias for the `AllowedNumberOfNameserverBase` OpenAPI schema.
|
|
50
|
+
* This type represents allowednumberofnameserverbase data structures used in API requests and responses.
|
|
51
|
+
*
|
|
52
|
+
* @example
|
|
53
|
+
* ```typescript
|
|
54
|
+
* const response = await api.getAllowedNumberOfNameserverBase();
|
|
55
|
+
* const item: AllowedNumberOfNameserverBase = response.results;
|
|
56
|
+
* ```
|
|
57
|
+
*
|
|
58
|
+
* @see {@link components} - The OpenAPI components schema definition
|
|
59
|
+
*/
|
|
60
|
+
export type AllowedNumberOfNameserverBase = components['schemas']['AllowedNumberOfNameserverBase'];
|
|
29
61
|
/**
|
|
30
62
|
* Body_issue_organization_token_v1_auth_token_post
|
|
31
63
|
*
|
|
@@ -106,6 +138,22 @@ export type BulkOperationResult = components['schemas']['BulkOperationResult'];
|
|
|
106
138
|
* @see {@link components} - The OpenAPI components schema definition
|
|
107
139
|
*/
|
|
108
140
|
export type BulkOperationStatus = components['schemas']['BulkOperationStatus'];
|
|
141
|
+
/**
|
|
142
|
+
* ContactConfigBase
|
|
143
|
+
*
|
|
144
|
+
* @remarks
|
|
145
|
+
* Type alias for the `ContactConfigBase` OpenAPI schema.
|
|
146
|
+
* This type represents contactconfigbase data structures used in API requests and responses.
|
|
147
|
+
*
|
|
148
|
+
* @example
|
|
149
|
+
* ```typescript
|
|
150
|
+
* const response = await api.getContactConfigBase();
|
|
151
|
+
* const item: ContactConfigBase = response.results;
|
|
152
|
+
* ```
|
|
153
|
+
*
|
|
154
|
+
* @see {@link components} - The OpenAPI components schema definition
|
|
155
|
+
*/
|
|
156
|
+
export type ContactConfigBase = components['schemas']['ContactConfigBase'];
|
|
109
157
|
/**
|
|
110
158
|
* ContactCreate
|
|
111
159
|
*
|
|
@@ -154,6 +202,22 @@ export type ContactIdList = components['schemas']['ContactIdList'];
|
|
|
154
202
|
* @see {@link components} - The OpenAPI components schema definition
|
|
155
203
|
*/
|
|
156
204
|
export type Contact = components['schemas']['ContactResponse'];
|
|
205
|
+
/**
|
|
206
|
+
* ContactRoleType
|
|
207
|
+
*
|
|
208
|
+
* @remarks
|
|
209
|
+
* Type alias for the `ContactRoleType` OpenAPI schema.
|
|
210
|
+
* This type represents contactroletype data structures used in API requests and responses.
|
|
211
|
+
*
|
|
212
|
+
* @example
|
|
213
|
+
* ```typescript
|
|
214
|
+
* const response = await api.getContactRoleType();
|
|
215
|
+
* const item: ContactRoleType = response.results;
|
|
216
|
+
* ```
|
|
217
|
+
*
|
|
218
|
+
* @see {@link components} - The OpenAPI components schema definition
|
|
219
|
+
*/
|
|
220
|
+
export type ContactRoleType = components['schemas']['ContactRoleType'];
|
|
157
221
|
/**
|
|
158
222
|
* ContactSchema
|
|
159
223
|
*
|
|
@@ -234,6 +298,22 @@ export type ContactVerificationEmail = components['schemas']['ContactVerificatio
|
|
|
234
298
|
* @see {@link components} - The OpenAPI components schema definition
|
|
235
299
|
*/
|
|
236
300
|
export type ContactVerification = components['schemas']['ContactVerificationResponse'];
|
|
301
|
+
/**
|
|
302
|
+
* ContactsBase
|
|
303
|
+
*
|
|
304
|
+
* @remarks
|
|
305
|
+
* Type alias for the `ContactsBase` OpenAPI schema.
|
|
306
|
+
* This type represents contactsbase data structures used in API requests and responses.
|
|
307
|
+
*
|
|
308
|
+
* @example
|
|
309
|
+
* ```typescript
|
|
310
|
+
* const response = await api.getContactsBase();
|
|
311
|
+
* const item: ContactsBase = response.results;
|
|
312
|
+
* ```
|
|
313
|
+
*
|
|
314
|
+
* @see {@link components} - The OpenAPI components schema definition
|
|
315
|
+
*/
|
|
316
|
+
export type ContactsBase = components['schemas']['ContactsBase'];
|
|
237
317
|
/**
|
|
238
318
|
* Currency
|
|
239
319
|
*
|
|
@@ -250,6 +330,22 @@ export type ContactVerification = components['schemas']['ContactVerificationResp
|
|
|
250
330
|
* @see {@link components} - The OpenAPI components schema definition
|
|
251
331
|
*/
|
|
252
332
|
export type Currency = components['schemas']['Currency'];
|
|
333
|
+
/**
|
|
334
|
+
* DeletePolicyType
|
|
335
|
+
*
|
|
336
|
+
* @remarks
|
|
337
|
+
* Type alias for the `DeletePolicyType` OpenAPI schema.
|
|
338
|
+
* This type represents deletepolicytype data structures used in API requests and responses.
|
|
339
|
+
*
|
|
340
|
+
* @example
|
|
341
|
+
* ```typescript
|
|
342
|
+
* const response = await api.getDeletePolicyType();
|
|
343
|
+
* const item: DeletePolicyType = response.results;
|
|
344
|
+
* ```
|
|
345
|
+
*
|
|
346
|
+
* @see {@link components} - The OpenAPI components schema definition
|
|
347
|
+
*/
|
|
348
|
+
export type DeletePolicyType = components['schemas']['DeletePolicyType'];
|
|
253
349
|
/**
|
|
254
350
|
* DeletedEvent
|
|
255
351
|
*
|
|
@@ -314,6 +410,22 @@ export type DnsChange = components['schemas']['DnsChangeResponse'];
|
|
|
314
410
|
* @see {@link components} - The OpenAPI components schema definition
|
|
315
411
|
*/
|
|
316
412
|
export type DnsChanges = components['schemas']['DnsChangesResponse'];
|
|
413
|
+
/**
|
|
414
|
+
* DnsConfigurationBase
|
|
415
|
+
*
|
|
416
|
+
* @remarks
|
|
417
|
+
* Type alias for the `DnsConfigurationBase` OpenAPI schema.
|
|
418
|
+
* This type represents dnsconfigurationbase data structures used in API requests and responses.
|
|
419
|
+
*
|
|
420
|
+
* @example
|
|
421
|
+
* ```typescript
|
|
422
|
+
* const response = await api.getDnsConfigurationBase();
|
|
423
|
+
* const item: DnsConfigurationBase = response.results;
|
|
424
|
+
* ```
|
|
425
|
+
*
|
|
426
|
+
* @see {@link components} - The OpenAPI components schema definition
|
|
427
|
+
*/
|
|
428
|
+
export type DnsConfigurationBase = components['schemas']['DnsConfigurationBase'];
|
|
317
429
|
/**
|
|
318
430
|
* DnsRecordCreate
|
|
319
431
|
*
|
|
@@ -570,6 +682,22 @@ export type DnssecAlgorithm = components['schemas']['DnssecAlgorithm'];
|
|
|
570
682
|
* @see {@link components} - The OpenAPI components schema definition
|
|
571
683
|
*/
|
|
572
684
|
export type DnssecDigestType = components['schemas']['DnssecDigestType'];
|
|
685
|
+
/**
|
|
686
|
+
* DnssecModeType
|
|
687
|
+
*
|
|
688
|
+
* @remarks
|
|
689
|
+
* Type alias for the `DnssecModeType` OpenAPI schema.
|
|
690
|
+
* This type represents dnssecmodetype data structures used in API requests and responses.
|
|
691
|
+
*
|
|
692
|
+
* @example
|
|
693
|
+
* ```typescript
|
|
694
|
+
* const response = await api.getDnssecModeType();
|
|
695
|
+
* const item: DnssecModeType = response.results;
|
|
696
|
+
* ```
|
|
697
|
+
*
|
|
698
|
+
* @see {@link components} - The OpenAPI components schema definition
|
|
699
|
+
*/
|
|
700
|
+
export type DnssecModeType = components['schemas']['DnssecModeType'];
|
|
573
701
|
/**
|
|
574
702
|
* DnssecRecordType
|
|
575
703
|
*
|
|
@@ -762,6 +890,22 @@ export type DomainDnssecDataCreate = components['schemas']['DomainDnssecDataCrea
|
|
|
762
890
|
* @see {@link components} - The OpenAPI components schema definition
|
|
763
891
|
*/
|
|
764
892
|
export type DomainDnssecData = components['schemas']['DomainDnssecDataResponse'];
|
|
893
|
+
/**
|
|
894
|
+
* DomainLifecycleBase
|
|
895
|
+
*
|
|
896
|
+
* @remarks
|
|
897
|
+
* Type alias for the `DomainLifecycleBase` OpenAPI schema.
|
|
898
|
+
* This type represents domainlifecyclebase data structures used in API requests and responses.
|
|
899
|
+
*
|
|
900
|
+
* @example
|
|
901
|
+
* ```typescript
|
|
902
|
+
* const response = await api.getDomainLifecycleBase();
|
|
903
|
+
* const item: DomainLifecycleBase = response.results;
|
|
904
|
+
* ```
|
|
905
|
+
*
|
|
906
|
+
* @see {@link components} - The OpenAPI components schema definition
|
|
907
|
+
*/
|
|
908
|
+
export type DomainLifecycleBase = components['schemas']['DomainLifecycleBase'];
|
|
765
909
|
/**
|
|
766
910
|
* DomainNameParts
|
|
767
911
|
*
|
|
@@ -922,6 +1066,22 @@ export type DomainSortField = components['schemas']['DomainSortField'];
|
|
|
922
1066
|
* @see {@link components} - The OpenAPI components schema definition
|
|
923
1067
|
*/
|
|
924
1068
|
export type DomainStatus = components['schemas']['DomainStatus'];
|
|
1069
|
+
/**
|
|
1070
|
+
* DomainStatusesBase
|
|
1071
|
+
*
|
|
1072
|
+
* @remarks
|
|
1073
|
+
* Type alias for the `DomainStatusesBase` OpenAPI schema.
|
|
1074
|
+
* This type represents domainstatusesbase data structures used in API requests and responses.
|
|
1075
|
+
*
|
|
1076
|
+
* @example
|
|
1077
|
+
* ```typescript
|
|
1078
|
+
* const response = await api.getDomainStatusesBase();
|
|
1079
|
+
* const item: DomainStatusesBase = response.results;
|
|
1080
|
+
* ```
|
|
1081
|
+
*
|
|
1082
|
+
* @see {@link components} - The OpenAPI components schema definition
|
|
1083
|
+
*/
|
|
1084
|
+
export type DomainStatusesBase = components['schemas']['DomainStatusesBase'];
|
|
925
1085
|
/**
|
|
926
1086
|
* DomainSummaryData
|
|
927
1087
|
*
|
|
@@ -1226,6 +1386,22 @@ export type EventSubtype = components['schemas']['EventSubtype'];
|
|
|
1226
1386
|
* @see {@link components} - The OpenAPI components schema definition
|
|
1227
1387
|
*/
|
|
1228
1388
|
export type EventType = components['schemas']['EventType'];
|
|
1389
|
+
/**
|
|
1390
|
+
* GeneralAvailabilityBase
|
|
1391
|
+
*
|
|
1392
|
+
* @remarks
|
|
1393
|
+
* Type alias for the `GeneralAvailabilityBase` OpenAPI schema.
|
|
1394
|
+
* This type represents generalavailabilitybase data structures used in API requests and responses.
|
|
1395
|
+
*
|
|
1396
|
+
* @example
|
|
1397
|
+
* ```typescript
|
|
1398
|
+
* const response = await api.getGeneralAvailabilityBase();
|
|
1399
|
+
* const item: GeneralAvailabilityBase = response.results;
|
|
1400
|
+
* ```
|
|
1401
|
+
*
|
|
1402
|
+
* @see {@link components} - The OpenAPI components schema definition
|
|
1403
|
+
*/
|
|
1404
|
+
export type GeneralAvailabilityBase = components['schemas']['GeneralAvailabilityBase'];
|
|
1229
1405
|
/**
|
|
1230
1406
|
* GrantType
|
|
1231
1407
|
*
|
|
@@ -1258,6 +1434,22 @@ export type GrantType = components['schemas']['GrantType'];
|
|
|
1258
1434
|
* @see {@link components} - The OpenAPI components schema definition
|
|
1259
1435
|
*/
|
|
1260
1436
|
export type HTTPValidationError = components['schemas']['HTTPValidationError'];
|
|
1437
|
+
/**
|
|
1438
|
+
* IdnBase
|
|
1439
|
+
*
|
|
1440
|
+
* @remarks
|
|
1441
|
+
* Type alias for the `IdnBase` OpenAPI schema.
|
|
1442
|
+
* This type represents idnbase data structures used in API requests and responses.
|
|
1443
|
+
*
|
|
1444
|
+
* @example
|
|
1445
|
+
* ```typescript
|
|
1446
|
+
* const response = await api.getIdnBase();
|
|
1447
|
+
* const item: IdnBase = response.results;
|
|
1448
|
+
* ```
|
|
1449
|
+
*
|
|
1450
|
+
* @see {@link components} - The OpenAPI components schema definition
|
|
1451
|
+
*/
|
|
1452
|
+
export type IdnBase = components['schemas']['IdnBase'];
|
|
1261
1453
|
/**
|
|
1262
1454
|
* IpRestrictionCreate
|
|
1263
1455
|
*
|
|
@@ -1322,6 +1514,86 @@ export type IpRestrictionUpdate = components['schemas']['IpRestrictionUpdate'];
|
|
|
1322
1514
|
* @see {@link components} - The OpenAPI components schema definition
|
|
1323
1515
|
*/
|
|
1324
1516
|
export type JsonValue = components['schemas']['JsonValue'];
|
|
1517
|
+
/**
|
|
1518
|
+
* LaunchPhaseBase
|
|
1519
|
+
*
|
|
1520
|
+
* @remarks
|
|
1521
|
+
* Type alias for the `LaunchPhaseBase` OpenAPI schema.
|
|
1522
|
+
* This type represents launchphasebase data structures used in API requests and responses.
|
|
1523
|
+
*
|
|
1524
|
+
* @example
|
|
1525
|
+
* ```typescript
|
|
1526
|
+
* const response = await api.getLaunchPhaseBase();
|
|
1527
|
+
* const item: LaunchPhaseBase = response.results;
|
|
1528
|
+
* ```
|
|
1529
|
+
*
|
|
1530
|
+
* @see {@link components} - The OpenAPI components schema definition
|
|
1531
|
+
*/
|
|
1532
|
+
export type LaunchPhaseBase = components['schemas']['LaunchPhaseBase'];
|
|
1533
|
+
/**
|
|
1534
|
+
* LaunchPhaseType
|
|
1535
|
+
*
|
|
1536
|
+
* @remarks
|
|
1537
|
+
* Type alias for the `LaunchPhaseType` OpenAPI schema.
|
|
1538
|
+
* This type represents launchphasetype data structures used in API requests and responses.
|
|
1539
|
+
*
|
|
1540
|
+
* @example
|
|
1541
|
+
* ```typescript
|
|
1542
|
+
* const response = await api.getLaunchPhaseType();
|
|
1543
|
+
* const item: LaunchPhaseType = response.results;
|
|
1544
|
+
* ```
|
|
1545
|
+
*
|
|
1546
|
+
* @see {@link components} - The OpenAPI components schema definition
|
|
1547
|
+
*/
|
|
1548
|
+
export type LaunchPhaseType = components['schemas']['LaunchPhaseType'];
|
|
1549
|
+
/**
|
|
1550
|
+
* LaunchPhasesBase
|
|
1551
|
+
*
|
|
1552
|
+
* @remarks
|
|
1553
|
+
* Type alias for the `LaunchPhasesBase` OpenAPI schema.
|
|
1554
|
+
* This type represents launchphasesbase data structures used in API requests and responses.
|
|
1555
|
+
*
|
|
1556
|
+
* @example
|
|
1557
|
+
* ```typescript
|
|
1558
|
+
* const response = await api.getLaunchPhasesBase();
|
|
1559
|
+
* const item: LaunchPhasesBase = response.results;
|
|
1560
|
+
* ```
|
|
1561
|
+
*
|
|
1562
|
+
* @see {@link components} - The OpenAPI components schema definition
|
|
1563
|
+
*/
|
|
1564
|
+
export type LaunchPhasesBase = components['schemas']['LaunchPhasesBase'];
|
|
1565
|
+
/**
|
|
1566
|
+
* LocalPresenceBase
|
|
1567
|
+
*
|
|
1568
|
+
* @remarks
|
|
1569
|
+
* Type alias for the `LocalPresenceBase` OpenAPI schema.
|
|
1570
|
+
* This type represents localpresencebase data structures used in API requests and responses.
|
|
1571
|
+
*
|
|
1572
|
+
* @example
|
|
1573
|
+
* ```typescript
|
|
1574
|
+
* const response = await api.getLocalPresenceBase();
|
|
1575
|
+
* const item: LocalPresenceBase = response.results;
|
|
1576
|
+
* ```
|
|
1577
|
+
*
|
|
1578
|
+
* @see {@link components} - The OpenAPI components schema definition
|
|
1579
|
+
*/
|
|
1580
|
+
export type LocalPresenceBase = components['schemas']['LocalPresenceBase'];
|
|
1581
|
+
/**
|
|
1582
|
+
* LocalPresenceRequirementType
|
|
1583
|
+
*
|
|
1584
|
+
* @remarks
|
|
1585
|
+
* Type alias for the `LocalPresenceRequirementType` OpenAPI schema.
|
|
1586
|
+
* This type represents localpresencerequirementtype data structures used in API requests and responses.
|
|
1587
|
+
*
|
|
1588
|
+
* @example
|
|
1589
|
+
* ```typescript
|
|
1590
|
+
* const response = await api.getLocalPresenceRequirementType();
|
|
1591
|
+
* const item: LocalPresenceRequirementType = response.results;
|
|
1592
|
+
* ```
|
|
1593
|
+
*
|
|
1594
|
+
* @see {@link components} - The OpenAPI components schema definition
|
|
1595
|
+
*/
|
|
1596
|
+
export type LocalPresenceRequirementType = components['schemas']['LocalPresenceRequirementType'];
|
|
1325
1597
|
/**
|
|
1326
1598
|
* Nameserver
|
|
1327
1599
|
*
|
|
@@ -1802,6 +2074,38 @@ export type Pagination_User = components['schemas']['Pagination_User_'];
|
|
|
1802
2074
|
* @see {@link components} - The OpenAPI components schema definition
|
|
1803
2075
|
*/
|
|
1804
2076
|
export type PatchOp = components['schemas']['PatchOp'];
|
|
2077
|
+
/**
|
|
2078
|
+
* Period
|
|
2079
|
+
*
|
|
2080
|
+
* @remarks
|
|
2081
|
+
* Type alias for the `Period` OpenAPI schema.
|
|
2082
|
+
* This type represents period data structures used in API requests and responses.
|
|
2083
|
+
*
|
|
2084
|
+
* @example
|
|
2085
|
+
* ```typescript
|
|
2086
|
+
* const response = await api.getPeriod();
|
|
2087
|
+
* const item: Period = response.results;
|
|
2088
|
+
* ```
|
|
2089
|
+
*
|
|
2090
|
+
* @see {@link components} - The OpenAPI components schema definition
|
|
2091
|
+
*/
|
|
2092
|
+
export type Period = components['schemas']['Period'];
|
|
2093
|
+
/**
|
|
2094
|
+
* PeriodList
|
|
2095
|
+
*
|
|
2096
|
+
* @remarks
|
|
2097
|
+
* Type alias for the `PeriodList` OpenAPI schema.
|
|
2098
|
+
* This type represents periodlist data structures used in API requests and responses.
|
|
2099
|
+
*
|
|
2100
|
+
* @example
|
|
2101
|
+
* ```typescript
|
|
2102
|
+
* const response = await api.getPeriodList();
|
|
2103
|
+
* const item: PeriodList = response.results;
|
|
2104
|
+
* ```
|
|
2105
|
+
*
|
|
2106
|
+
* @see {@link components} - The OpenAPI components schema definition
|
|
2107
|
+
*/
|
|
2108
|
+
export type PeriodList = components['schemas']['PeriodList'];
|
|
1805
2109
|
/**
|
|
1806
2110
|
* PeriodUnit
|
|
1807
2111
|
*
|
|
@@ -1882,6 +2186,86 @@ export type PlanRelation = components['schemas']['PlanRelation'];
|
|
|
1882
2186
|
* @see {@link components} - The OpenAPI components schema definition
|
|
1883
2187
|
*/
|
|
1884
2188
|
export type PlanUpdate = components['schemas']['PlanUpdate'];
|
|
2189
|
+
/**
|
|
2190
|
+
* PostTransferRequirements
|
|
2191
|
+
*
|
|
2192
|
+
* @remarks
|
|
2193
|
+
* Type alias for the `PostTransferRequirements` OpenAPI schema.
|
|
2194
|
+
* This type represents posttransferrequirements data structures used in API requests and responses.
|
|
2195
|
+
*
|
|
2196
|
+
* @example
|
|
2197
|
+
* ```typescript
|
|
2198
|
+
* const response = await api.getPostTransferRequirements();
|
|
2199
|
+
* const item: PostTransferRequirements = response.results;
|
|
2200
|
+
* ```
|
|
2201
|
+
*
|
|
2202
|
+
* @see {@link components} - The OpenAPI components schema definition
|
|
2203
|
+
*/
|
|
2204
|
+
export type PostTransferRequirements = components['schemas']['PostTransferRequirements'];
|
|
2205
|
+
/**
|
|
2206
|
+
* PostalAddressType
|
|
2207
|
+
*
|
|
2208
|
+
* @remarks
|
|
2209
|
+
* Type alias for the `PostalAddressType` OpenAPI schema.
|
|
2210
|
+
* This type represents postaladdresstype data structures used in API requests and responses.
|
|
2211
|
+
*
|
|
2212
|
+
* @example
|
|
2213
|
+
* ```typescript
|
|
2214
|
+
* const response = await api.getPostalAddressType();
|
|
2215
|
+
* const item: PostalAddressType = response.results;
|
|
2216
|
+
* ```
|
|
2217
|
+
*
|
|
2218
|
+
* @see {@link components} - The OpenAPI components schema definition
|
|
2219
|
+
*/
|
|
2220
|
+
export type PostalAddressType = components['schemas']['PostalAddressType'];
|
|
2221
|
+
/**
|
|
2222
|
+
* PremiumAffectsType
|
|
2223
|
+
*
|
|
2224
|
+
* @remarks
|
|
2225
|
+
* Type alias for the `PremiumAffectsType` OpenAPI schema.
|
|
2226
|
+
* This type represents premiumaffectstype data structures used in API requests and responses.
|
|
2227
|
+
*
|
|
2228
|
+
* @example
|
|
2229
|
+
* ```typescript
|
|
2230
|
+
* const response = await api.getPremiumAffectsType();
|
|
2231
|
+
* const item: PremiumAffectsType = response.results;
|
|
2232
|
+
* ```
|
|
2233
|
+
*
|
|
2234
|
+
* @see {@link components} - The OpenAPI components schema definition
|
|
2235
|
+
*/
|
|
2236
|
+
export type PremiumAffectsType = components['schemas']['PremiumAffectsType'];
|
|
2237
|
+
/**
|
|
2238
|
+
* PremiumDomainsBase
|
|
2239
|
+
*
|
|
2240
|
+
* @remarks
|
|
2241
|
+
* Type alias for the `PremiumDomainsBase` OpenAPI schema.
|
|
2242
|
+
* This type represents premiumdomainsbase data structures used in API requests and responses.
|
|
2243
|
+
*
|
|
2244
|
+
* @example
|
|
2245
|
+
* ```typescript
|
|
2246
|
+
* const response = await api.getPremiumDomainsBase();
|
|
2247
|
+
* const item: PremiumDomainsBase = response.results;
|
|
2248
|
+
* ```
|
|
2249
|
+
*
|
|
2250
|
+
* @see {@link components} - The OpenAPI components schema definition
|
|
2251
|
+
*/
|
|
2252
|
+
export type PremiumDomainsBase = components['schemas']['PremiumDomainsBase'];
|
|
2253
|
+
/**
|
|
2254
|
+
* PremiumSourceType
|
|
2255
|
+
*
|
|
2256
|
+
* @remarks
|
|
2257
|
+
* Type alias for the `PremiumSourceType` OpenAPI schema.
|
|
2258
|
+
* This type represents premiumsourcetype data structures used in API requests and responses.
|
|
2259
|
+
*
|
|
2260
|
+
* @example
|
|
2261
|
+
* ```typescript
|
|
2262
|
+
* const response = await api.getPremiumSourceType();
|
|
2263
|
+
* const item: PremiumSourceType = response.results;
|
|
2264
|
+
* ```
|
|
2265
|
+
*
|
|
2266
|
+
* @see {@link components} - The OpenAPI components schema definition
|
|
2267
|
+
*/
|
|
2268
|
+
export type PremiumSourceType = components['schemas']['PremiumSourceType'];
|
|
1885
2269
|
/**
|
|
1886
2270
|
* Problem
|
|
1887
2271
|
*
|
|
@@ -1898,6 +2282,54 @@ export type PlanUpdate = components['schemas']['PlanUpdate'];
|
|
|
1898
2282
|
* @see {@link components} - The OpenAPI components schema definition
|
|
1899
2283
|
*/
|
|
1900
2284
|
export type Problem = components['schemas']['Problem'];
|
|
2285
|
+
/**
|
|
2286
|
+
* RdapBase
|
|
2287
|
+
*
|
|
2288
|
+
* @remarks
|
|
2289
|
+
* Type alias for the `RdapBase` OpenAPI schema.
|
|
2290
|
+
* This type represents rdapbase data structures used in API requests and responses.
|
|
2291
|
+
*
|
|
2292
|
+
* @example
|
|
2293
|
+
* ```typescript
|
|
2294
|
+
* const response = await api.getRdapBase();
|
|
2295
|
+
* const item: RdapBase = response.results;
|
|
2296
|
+
* ```
|
|
2297
|
+
*
|
|
2298
|
+
* @see {@link components} - The OpenAPI components schema definition
|
|
2299
|
+
*/
|
|
2300
|
+
export type RdapBase = components['schemas']['RdapBase'];
|
|
2301
|
+
/**
|
|
2302
|
+
* RegistrantChangeType
|
|
2303
|
+
*
|
|
2304
|
+
* @remarks
|
|
2305
|
+
* Type alias for the `RegistrantChangeType` OpenAPI schema.
|
|
2306
|
+
* This type represents registrantchangetype data structures used in API requests and responses.
|
|
2307
|
+
*
|
|
2308
|
+
* @example
|
|
2309
|
+
* ```typescript
|
|
2310
|
+
* const response = await api.getRegistrantChangeType();
|
|
2311
|
+
* const item: RegistrantChangeType = response.results;
|
|
2312
|
+
* ```
|
|
2313
|
+
*
|
|
2314
|
+
* @see {@link components} - The OpenAPI components schema definition
|
|
2315
|
+
*/
|
|
2316
|
+
export type RegistrantChangeType = components['schemas']['RegistrantChangeType'];
|
|
2317
|
+
/**
|
|
2318
|
+
* RegistryLockBase
|
|
2319
|
+
*
|
|
2320
|
+
* @remarks
|
|
2321
|
+
* Type alias for the `RegistryLockBase` OpenAPI schema.
|
|
2322
|
+
* This type represents registrylockbase data structures used in API requests and responses.
|
|
2323
|
+
*
|
|
2324
|
+
* @example
|
|
2325
|
+
* ```typescript
|
|
2326
|
+
* const response = await api.getRegistryLockBase();
|
|
2327
|
+
* const item: RegistryLockBase = response.results;
|
|
2328
|
+
* ```
|
|
2329
|
+
*
|
|
2330
|
+
* @see {@link components} - The OpenAPI components schema definition
|
|
2331
|
+
*/
|
|
2332
|
+
export type RegistryLockBase = components['schemas']['RegistryLockBase'];
|
|
1901
2333
|
/**
|
|
1902
2334
|
* Relation
|
|
1903
2335
|
*
|
|
@@ -1946,6 +2378,38 @@ export type RelationSet = components['schemas']['RelationSet'];
|
|
|
1946
2378
|
* @see {@link components} - The OpenAPI components schema definition
|
|
1947
2379
|
*/
|
|
1948
2380
|
export type RenewalMode = components['schemas']['RenewalMode'];
|
|
2381
|
+
/**
|
|
2382
|
+
* ReservedDomainsBase
|
|
2383
|
+
*
|
|
2384
|
+
* @remarks
|
|
2385
|
+
* Type alias for the `ReservedDomainsBase` OpenAPI schema.
|
|
2386
|
+
* This type represents reserveddomainsbase data structures used in API requests and responses.
|
|
2387
|
+
*
|
|
2388
|
+
* @example
|
|
2389
|
+
* ```typescript
|
|
2390
|
+
* const response = await api.getReservedDomainsBase();
|
|
2391
|
+
* const item: ReservedDomainsBase = response.results;
|
|
2392
|
+
* ```
|
|
2393
|
+
*
|
|
2394
|
+
* @see {@link components} - The OpenAPI components schema definition
|
|
2395
|
+
*/
|
|
2396
|
+
export type ReservedDomainsBase = components['schemas']['ReservedDomainsBase'];
|
|
2397
|
+
/**
|
|
2398
|
+
* ReservedSourceType
|
|
2399
|
+
*
|
|
2400
|
+
* @remarks
|
|
2401
|
+
* Type alias for the `ReservedSourceType` OpenAPI schema.
|
|
2402
|
+
* This type represents reservedsourcetype data structures used in API requests and responses.
|
|
2403
|
+
*
|
|
2404
|
+
* @example
|
|
2405
|
+
* ```typescript
|
|
2406
|
+
* const response = await api.getReservedSourceType();
|
|
2407
|
+
* const item: ReservedSourceType = response.results;
|
|
2408
|
+
* ```
|
|
2409
|
+
*
|
|
2410
|
+
* @see {@link components} - The OpenAPI components schema definition
|
|
2411
|
+
*/
|
|
2412
|
+
export type ReservedSourceType = components['schemas']['ReservedSourceType'];
|
|
1949
2413
|
/**
|
|
1950
2414
|
* SignupCreate
|
|
1951
2415
|
*
|
|
@@ -1962,6 +2426,22 @@ export type RenewalMode = components['schemas']['RenewalMode'];
|
|
|
1962
2426
|
* @see {@link components} - The OpenAPI components schema definition
|
|
1963
2427
|
*/
|
|
1964
2428
|
export type SignupCreate = components['schemas']['SignupCreate'];
|
|
2429
|
+
/**
|
|
2430
|
+
* SldLength
|
|
2431
|
+
*
|
|
2432
|
+
* @remarks
|
|
2433
|
+
* Type alias for the `SldLength` OpenAPI schema.
|
|
2434
|
+
* This type represents sldlength data structures used in API requests and responses.
|
|
2435
|
+
*
|
|
2436
|
+
* @example
|
|
2437
|
+
* ```typescript
|
|
2438
|
+
* const response = await api.getSldLength();
|
|
2439
|
+
* const item: SldLength = response.results;
|
|
2440
|
+
* ```
|
|
2441
|
+
*
|
|
2442
|
+
* @see {@link components} - The OpenAPI components schema definition
|
|
2443
|
+
*/
|
|
2444
|
+
export type SldLength = components['schemas']['SldLength'];
|
|
1965
2445
|
/**
|
|
1966
2446
|
* SortOrder
|
|
1967
2447
|
*
|
|
@@ -1994,6 +2474,38 @@ export type SortOrder = components['schemas']['SortOrder'];
|
|
|
1994
2474
|
* @see {@link components} - The OpenAPI components schema definition
|
|
1995
2475
|
*/
|
|
1996
2476
|
export type SpiceDbRelationshipUpdate = components['schemas']['SpiceDbRelationshipUpdate'];
|
|
2477
|
+
/**
|
|
2478
|
+
* SyncOperationType
|
|
2479
|
+
*
|
|
2480
|
+
* @remarks
|
|
2481
|
+
* Type alias for the `SyncOperationType` OpenAPI schema.
|
|
2482
|
+
* This type represents syncoperationtype data structures used in API requests and responses.
|
|
2483
|
+
*
|
|
2484
|
+
* @example
|
|
2485
|
+
* ```typescript
|
|
2486
|
+
* const response = await api.getSyncOperationType();
|
|
2487
|
+
* const item: SyncOperationType = response.results;
|
|
2488
|
+
* ```
|
|
2489
|
+
*
|
|
2490
|
+
* @see {@link components} - The OpenAPI components schema definition
|
|
2491
|
+
*/
|
|
2492
|
+
export type SyncOperationType = components['schemas']['SyncOperationType'];
|
|
2493
|
+
/**
|
|
2494
|
+
* TLDType
|
|
2495
|
+
*
|
|
2496
|
+
* @remarks
|
|
2497
|
+
* Type alias for the `TLDType` OpenAPI schema.
|
|
2498
|
+
* This type represents tldtype data structures used in API requests and responses.
|
|
2499
|
+
*
|
|
2500
|
+
* @example
|
|
2501
|
+
* ```typescript
|
|
2502
|
+
* const response = await api.getTLDType();
|
|
2503
|
+
* const item: TLDType = response.results;
|
|
2504
|
+
* ```
|
|
2505
|
+
*
|
|
2506
|
+
* @see {@link components} - The OpenAPI components schema definition
|
|
2507
|
+
*/
|
|
2508
|
+
export type TLDType = components['schemas']['TLDType'];
|
|
1997
2509
|
/**
|
|
1998
2510
|
* TermsOfServiceAccept
|
|
1999
2511
|
*
|
|
@@ -2010,6 +2522,86 @@ export type SpiceDbRelationshipUpdate = components['schemas']['SpiceDbRelationsh
|
|
|
2010
2522
|
* @see {@link components} - The OpenAPI components schema definition
|
|
2011
2523
|
*/
|
|
2012
2524
|
export type TermsOfServiceAccept = components['schemas']['TermsOfServiceAccept'];
|
|
2525
|
+
/**
|
|
2526
|
+
* TldBase
|
|
2527
|
+
*
|
|
2528
|
+
* @remarks
|
|
2529
|
+
* Type alias for the `TldBase` OpenAPI schema.
|
|
2530
|
+
* This type represents tldbase data structures used in API requests and responses.
|
|
2531
|
+
*
|
|
2532
|
+
* @example
|
|
2533
|
+
* ```typescript
|
|
2534
|
+
* const response = await api.getTldBase();
|
|
2535
|
+
* const item: TldBase = response.results;
|
|
2536
|
+
* ```
|
|
2537
|
+
*
|
|
2538
|
+
* @see {@link components} - The OpenAPI components schema definition
|
|
2539
|
+
*/
|
|
2540
|
+
export type TldBase = components['schemas']['TldBase'];
|
|
2541
|
+
/**
|
|
2542
|
+
* TldResponseShort
|
|
2543
|
+
*
|
|
2544
|
+
* @remarks
|
|
2545
|
+
* Type alias for the `TldResponseShort` OpenAPI schema.
|
|
2546
|
+
* This type represents tldresponseshort data structures used in API requests and responses.
|
|
2547
|
+
*
|
|
2548
|
+
* @example
|
|
2549
|
+
* ```typescript
|
|
2550
|
+
* const response = await api.getTldResponseShort();
|
|
2551
|
+
* const item: TldResponseShort = response.results;
|
|
2552
|
+
* ```
|
|
2553
|
+
*
|
|
2554
|
+
* @see {@link components} - The OpenAPI components schema definition
|
|
2555
|
+
*/
|
|
2556
|
+
export type TldResponseShort = components['schemas']['TldResponseShort'];
|
|
2557
|
+
/**
|
|
2558
|
+
* TldSpecificationResponse
|
|
2559
|
+
*
|
|
2560
|
+
* @remarks
|
|
2561
|
+
* Type alias for the `TldSpecificationResponse` OpenAPI schema.
|
|
2562
|
+
* This type represents tldspecificationresponse data structures used in API requests and responses.
|
|
2563
|
+
*
|
|
2564
|
+
* @example
|
|
2565
|
+
* ```typescript
|
|
2566
|
+
* const response = await api.getTldSpecification();
|
|
2567
|
+
* const item: TldSpecification = response.results;
|
|
2568
|
+
* ```
|
|
2569
|
+
*
|
|
2570
|
+
* @see {@link components} - The OpenAPI components schema definition
|
|
2571
|
+
*/
|
|
2572
|
+
export type TldSpecification = components['schemas']['TldSpecificationResponse'];
|
|
2573
|
+
/**
|
|
2574
|
+
* TrademarkClaimsBase
|
|
2575
|
+
*
|
|
2576
|
+
* @remarks
|
|
2577
|
+
* Type alias for the `TrademarkClaimsBase` OpenAPI schema.
|
|
2578
|
+
* This type represents trademarkclaimsbase data structures used in API requests and responses.
|
|
2579
|
+
*
|
|
2580
|
+
* @example
|
|
2581
|
+
* ```typescript
|
|
2582
|
+
* const response = await api.getTrademarkClaimsBase();
|
|
2583
|
+
* const item: TrademarkClaimsBase = response.results;
|
|
2584
|
+
* ```
|
|
2585
|
+
*
|
|
2586
|
+
* @see {@link components} - The OpenAPI components schema definition
|
|
2587
|
+
*/
|
|
2588
|
+
export type TrademarkClaimsBase = components['schemas']['TrademarkClaimsBase'];
|
|
2589
|
+
/**
|
|
2590
|
+
* TransferAckType
|
|
2591
|
+
*
|
|
2592
|
+
* @remarks
|
|
2593
|
+
* Type alias for the `TransferAckType` OpenAPI schema.
|
|
2594
|
+
* This type represents transferacktype data structures used in API requests and responses.
|
|
2595
|
+
*
|
|
2596
|
+
* @example
|
|
2597
|
+
* ```typescript
|
|
2598
|
+
* const response = await api.getTransferAckType();
|
|
2599
|
+
* const item: TransferAckType = response.results;
|
|
2600
|
+
* ```
|
|
2601
|
+
*
|
|
2602
|
+
* @see {@link components} - The OpenAPI components schema definition
|
|
2603
|
+
*/
|
|
2604
|
+
export type TransferAckType = components['schemas']['TransferAckType'];
|
|
2013
2605
|
/**
|
|
2014
2606
|
* TransferEvent
|
|
2015
2607
|
*
|
|
@@ -2026,6 +2618,22 @@ export type TermsOfServiceAccept = components['schemas']['TermsOfServiceAccept']
|
|
|
2026
2618
|
* @see {@link components} - The OpenAPI components schema definition
|
|
2027
2619
|
*/
|
|
2028
2620
|
export type TransferEvent = components['schemas']['TransferEvent'];
|
|
2621
|
+
/**
|
|
2622
|
+
* TransferPoliciesBase
|
|
2623
|
+
*
|
|
2624
|
+
* @remarks
|
|
2625
|
+
* Type alias for the `TransferPoliciesBase` OpenAPI schema.
|
|
2626
|
+
* This type represents transferpoliciesbase data structures used in API requests and responses.
|
|
2627
|
+
*
|
|
2628
|
+
* @example
|
|
2629
|
+
* ```typescript
|
|
2630
|
+
* const response = await api.getTransferPoliciesBase();
|
|
2631
|
+
* const item: TransferPoliciesBase = response.results;
|
|
2632
|
+
* ```
|
|
2633
|
+
*
|
|
2634
|
+
* @see {@link components} - The OpenAPI components schema definition
|
|
2635
|
+
*/
|
|
2636
|
+
export type TransferPoliciesBase = components['schemas']['TransferPoliciesBase'];
|
|
2029
2637
|
/**
|
|
2030
2638
|
* User
|
|
2031
2639
|
*
|
|
@@ -2234,6 +2842,22 @@ export type ValidationError = components['schemas']['ValidationError'];
|
|
|
2234
2842
|
* @see {@link components} - The OpenAPI components schema definition
|
|
2235
2843
|
*/
|
|
2236
2844
|
export type VerificationType = components['schemas']['VerificationType'];
|
|
2845
|
+
/**
|
|
2846
|
+
* WhoisBase
|
|
2847
|
+
*
|
|
2848
|
+
* @remarks
|
|
2849
|
+
* Type alias for the `WhoisBase` OpenAPI schema.
|
|
2850
|
+
* This type represents whoisbase data structures used in API requests and responses.
|
|
2851
|
+
*
|
|
2852
|
+
* @example
|
|
2853
|
+
* ```typescript
|
|
2854
|
+
* const response = await api.getWhoisBase();
|
|
2855
|
+
* const item: WhoisBase = response.results;
|
|
2856
|
+
* ```
|
|
2857
|
+
*
|
|
2858
|
+
* @see {@link components} - The OpenAPI components schema definition
|
|
2859
|
+
*/
|
|
2860
|
+
export type WhoisBase = components['schemas']['WhoisBase'];
|
|
2237
2861
|
/**
|
|
2238
2862
|
* ZoneSortField
|
|
2239
2863
|
*
|