@opusdns/api 0.10.0 → 0.11.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 +501 -441
- package/src/helpers/responses.ts +385 -547
- package/src/helpers/schemas-arrays.ts +169 -1
- package/src/helpers/schemas.ts +624 -0
- package/src/openapi.yaml +948 -1
- package/src/schema.d.ts +682 -0
- /package/src/{index.ts → index.d.ts} +0 -0
|
@@ -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, BulkOperationResult, DnsChange, DnsRecordCreate, DnsRecord, DnsRrsetCreate, DnsRecordPatchOp, DnsRrset, DnsRrsetPatchOp, DomainAvailabilityCheck, Nameserver, DomainContact, DomainStatus, DomainSearchSuggestion, DomainClientStatus, EmailForwardBulkUpdateItem, ValidationError, OrganizationAttribute2, User, OrganizationAttributeCreate, UserCreate, ContactSchema, DnsZone, Domain, EmailForward, EventResponse, OrganizationCredential, Organization, UserNotificationSummary, Permission, Relation, UserAttributeUpdate, DomainAvailability } from './schemas';
|
|
24
|
+
import { DomainDnssecData, DomainDnssecDataCreate, OrganizationAttribute, OrganizationAttributeUpdate, IpRestriction, TldResponseShort, BulkOperationResult, PostalAddressType, ContactConfigBase, DnsChange, DnsRecordCreate, DnsRecord, DnsRrsetCreate, DnsRecordPatchOp, DnsRrset, DnsRrsetPatchOp, DomainAvailabilityCheck, Nameserver, DeletePolicyType, SyncOperationType, DomainContact, DomainStatus, DomainSearchSuggestion, DomainClientStatus, EmailForwardBulkUpdateItem, ValidationError, LaunchPhaseBase, LocalPresenceRequirementType, ContactRoleType, OrganizationAttribute2, User, OrganizationAttributeCreate, UserCreate, ContactSchema, DnsZone, Domain, EmailForward, EventResponse, OrganizationCredential, Organization, UserNotificationSummary, Period, Permission, PremiumAffectsType, Relation, TldBase, PostTransferRequirements, UserAttributeUpdate, DomainAvailability } from './schemas';
|
|
25
25
|
|
|
26
26
|
/**
|
|
27
27
|
* DomainDnssecDataResponse
|
|
@@ -93,6 +93,20 @@ export type OrganizationAttributeUpdateArray = OrganizationAttributeUpdate[];
|
|
|
93
93
|
* @see {@link IpRestriction} - The individual IpRestrictionResponse type definition
|
|
94
94
|
*/
|
|
95
95
|
export type IpRestrictionArray = IpRestriction[];
|
|
96
|
+
/**
|
|
97
|
+
* TldResponseShort
|
|
98
|
+
*
|
|
99
|
+
* @remarks
|
|
100
|
+
* Array type for TldResponseShort objects. Used when the API returns a collection of TldResponseShort instances.
|
|
101
|
+
*
|
|
102
|
+
* @example
|
|
103
|
+
* ```typescript
|
|
104
|
+
* const items: TldResponseShortArray = await api.getTldResponseShorts();
|
|
105
|
+
* ```
|
|
106
|
+
*
|
|
107
|
+
* @see {@link TldResponseShort} - The individual TldResponseShort type definition
|
|
108
|
+
*/
|
|
109
|
+
export type TldResponseShortArray = TldResponseShort[];
|
|
96
110
|
/**
|
|
97
111
|
* BulkOperationResult
|
|
98
112
|
*
|
|
@@ -107,6 +121,34 @@ export type IpRestrictionArray = IpRestriction[];
|
|
|
107
121
|
* @see {@link BulkOperationResult} - The individual BulkOperationResult type definition
|
|
108
122
|
*/
|
|
109
123
|
export type BulkOperationResultArray = BulkOperationResult[];
|
|
124
|
+
/**
|
|
125
|
+
* PostalAddressType
|
|
126
|
+
*
|
|
127
|
+
* @remarks
|
|
128
|
+
* Array type for PostalAddressType objects. Used when the API returns a collection of PostalAddressType instances.
|
|
129
|
+
*
|
|
130
|
+
* @example
|
|
131
|
+
* ```typescript
|
|
132
|
+
* const items: PostalAddressTypeArray = await api.getPostalAddressTypes();
|
|
133
|
+
* ```
|
|
134
|
+
*
|
|
135
|
+
* @see {@link PostalAddressType} - The individual PostalAddressType type definition
|
|
136
|
+
*/
|
|
137
|
+
export type PostalAddressTypeArray = PostalAddressType[];
|
|
138
|
+
/**
|
|
139
|
+
* ContactConfigBase
|
|
140
|
+
*
|
|
141
|
+
* @remarks
|
|
142
|
+
* Array type for ContactConfigBase objects. Used when the API returns a collection of ContactConfigBase instances.
|
|
143
|
+
*
|
|
144
|
+
* @example
|
|
145
|
+
* ```typescript
|
|
146
|
+
* const items: ContactConfigBaseArray = await api.getContactConfigBases();
|
|
147
|
+
* ```
|
|
148
|
+
*
|
|
149
|
+
* @see {@link ContactConfigBase} - The individual ContactConfigBase type definition
|
|
150
|
+
*/
|
|
151
|
+
export type ContactConfigBaseArray = ContactConfigBase[];
|
|
110
152
|
/**
|
|
111
153
|
* DnsChangeResponse
|
|
112
154
|
*
|
|
@@ -233,6 +275,34 @@ export type DomainAvailabilityCheckArray = DomainAvailabilityCheck[];
|
|
|
233
275
|
* @see {@link Nameserver} - The individual Nameserver type definition
|
|
234
276
|
*/
|
|
235
277
|
export type NameserverArray = Nameserver[];
|
|
278
|
+
/**
|
|
279
|
+
* DeletePolicyType
|
|
280
|
+
*
|
|
281
|
+
* @remarks
|
|
282
|
+
* Array type for DeletePolicyType objects. Used when the API returns a collection of DeletePolicyType instances.
|
|
283
|
+
*
|
|
284
|
+
* @example
|
|
285
|
+
* ```typescript
|
|
286
|
+
* const items: DeletePolicyTypeArray = await api.getDeletePolicyTypes();
|
|
287
|
+
* ```
|
|
288
|
+
*
|
|
289
|
+
* @see {@link DeletePolicyType} - The individual DeletePolicyType type definition
|
|
290
|
+
*/
|
|
291
|
+
export type DeletePolicyTypeArray = DeletePolicyType[];
|
|
292
|
+
/**
|
|
293
|
+
* SyncOperationType
|
|
294
|
+
*
|
|
295
|
+
* @remarks
|
|
296
|
+
* Array type for SyncOperationType objects. Used when the API returns a collection of SyncOperationType instances.
|
|
297
|
+
*
|
|
298
|
+
* @example
|
|
299
|
+
* ```typescript
|
|
300
|
+
* const items: SyncOperationTypeArray = await api.getSyncOperationTypes();
|
|
301
|
+
* ```
|
|
302
|
+
*
|
|
303
|
+
* @see {@link SyncOperationType} - The individual SyncOperationType type definition
|
|
304
|
+
*/
|
|
305
|
+
export type SyncOperationTypeArray = SyncOperationType[];
|
|
236
306
|
/**
|
|
237
307
|
* DomainContactResponse
|
|
238
308
|
*
|
|
@@ -317,6 +387,48 @@ export type EmailForwardBulkUpdateItemArray = EmailForwardBulkUpdateItem[];
|
|
|
317
387
|
* @see {@link ValidationError} - The individual ValidationError type definition
|
|
318
388
|
*/
|
|
319
389
|
export type ValidationErrorArray = ValidationError[];
|
|
390
|
+
/**
|
|
391
|
+
* LaunchPhaseBase
|
|
392
|
+
*
|
|
393
|
+
* @remarks
|
|
394
|
+
* Array type for LaunchPhaseBase objects. Used when the API returns a collection of LaunchPhaseBase instances.
|
|
395
|
+
*
|
|
396
|
+
* @example
|
|
397
|
+
* ```typescript
|
|
398
|
+
* const items: LaunchPhaseBaseArray = await api.getLaunchPhaseBases();
|
|
399
|
+
* ```
|
|
400
|
+
*
|
|
401
|
+
* @see {@link LaunchPhaseBase} - The individual LaunchPhaseBase type definition
|
|
402
|
+
*/
|
|
403
|
+
export type LaunchPhaseBaseArray = LaunchPhaseBase[];
|
|
404
|
+
/**
|
|
405
|
+
* LocalPresenceRequirementType
|
|
406
|
+
*
|
|
407
|
+
* @remarks
|
|
408
|
+
* Array type for LocalPresenceRequirementType objects. Used when the API returns a collection of LocalPresenceRequirementType instances.
|
|
409
|
+
*
|
|
410
|
+
* @example
|
|
411
|
+
* ```typescript
|
|
412
|
+
* const items: LocalPresenceRequirementTypeArray = await api.getLocalPresenceRequirementTypes();
|
|
413
|
+
* ```
|
|
414
|
+
*
|
|
415
|
+
* @see {@link LocalPresenceRequirementType} - The individual LocalPresenceRequirementType type definition
|
|
416
|
+
*/
|
|
417
|
+
export type LocalPresenceRequirementTypeArray = LocalPresenceRequirementType[];
|
|
418
|
+
/**
|
|
419
|
+
* ContactRoleType
|
|
420
|
+
*
|
|
421
|
+
* @remarks
|
|
422
|
+
* Array type for ContactRoleType objects. Used when the API returns a collection of ContactRoleType instances.
|
|
423
|
+
*
|
|
424
|
+
* @example
|
|
425
|
+
* ```typescript
|
|
426
|
+
* const items: ContactRoleTypeArray = await api.getContactRoleTypes();
|
|
427
|
+
* ```
|
|
428
|
+
*
|
|
429
|
+
* @see {@link ContactRoleType} - The individual ContactRoleType type definition
|
|
430
|
+
*/
|
|
431
|
+
export type ContactRoleTypeArray = ContactRoleType[];
|
|
320
432
|
/**
|
|
321
433
|
* OrganizationAttribute
|
|
322
434
|
*
|
|
@@ -485,6 +597,20 @@ export type OrganizationArray = Organization[];
|
|
|
485
597
|
* @see {@link UserNotificationSummary} - The individual UserNotificationSummary type definition
|
|
486
598
|
*/
|
|
487
599
|
export type UserNotificationSummaryArray = UserNotificationSummary[];
|
|
600
|
+
/**
|
|
601
|
+
* Period
|
|
602
|
+
*
|
|
603
|
+
* @remarks
|
|
604
|
+
* Array type for Period objects. Used when the API returns a collection of Period instances.
|
|
605
|
+
*
|
|
606
|
+
* @example
|
|
607
|
+
* ```typescript
|
|
608
|
+
* const items: PeriodArray = await api.getPeriods();
|
|
609
|
+
* ```
|
|
610
|
+
*
|
|
611
|
+
* @see {@link Period} - The individual Period type definition
|
|
612
|
+
*/
|
|
613
|
+
export type PeriodArray = Period[];
|
|
488
614
|
/**
|
|
489
615
|
* Permission
|
|
490
616
|
*
|
|
@@ -499,6 +625,20 @@ export type UserNotificationSummaryArray = UserNotificationSummary[];
|
|
|
499
625
|
* @see {@link Permission} - The individual Permission type definition
|
|
500
626
|
*/
|
|
501
627
|
export type PermissionArray = Permission[];
|
|
628
|
+
/**
|
|
629
|
+
* PremiumAffectsType
|
|
630
|
+
*
|
|
631
|
+
* @remarks
|
|
632
|
+
* Array type for PremiumAffectsType objects. Used when the API returns a collection of PremiumAffectsType instances.
|
|
633
|
+
*
|
|
634
|
+
* @example
|
|
635
|
+
* ```typescript
|
|
636
|
+
* const items: PremiumAffectsTypeArray = await api.getPremiumAffectsTypes();
|
|
637
|
+
* ```
|
|
638
|
+
*
|
|
639
|
+
* @see {@link PremiumAffectsType} - The individual PremiumAffectsType type definition
|
|
640
|
+
*/
|
|
641
|
+
export type PremiumAffectsTypeArray = PremiumAffectsType[];
|
|
502
642
|
/**
|
|
503
643
|
* Relation
|
|
504
644
|
*
|
|
@@ -513,6 +653,34 @@ export type PermissionArray = Permission[];
|
|
|
513
653
|
* @see {@link Relation} - The individual Relation type definition
|
|
514
654
|
*/
|
|
515
655
|
export type RelationArray = Relation[];
|
|
656
|
+
/**
|
|
657
|
+
* TldBase
|
|
658
|
+
*
|
|
659
|
+
* @remarks
|
|
660
|
+
* Array type for TldBase objects. Used when the API returns a collection of TldBase instances.
|
|
661
|
+
*
|
|
662
|
+
* @example
|
|
663
|
+
* ```typescript
|
|
664
|
+
* const items: TldBaseArray = await api.getTldBases();
|
|
665
|
+
* ```
|
|
666
|
+
*
|
|
667
|
+
* @see {@link TldBase} - The individual TldBase type definition
|
|
668
|
+
*/
|
|
669
|
+
export type TldBaseArray = TldBase[];
|
|
670
|
+
/**
|
|
671
|
+
* PostTransferRequirements
|
|
672
|
+
*
|
|
673
|
+
* @remarks
|
|
674
|
+
* Array type for PostTransferRequirements objects. Used when the API returns a collection of PostTransferRequirements instances.
|
|
675
|
+
*
|
|
676
|
+
* @example
|
|
677
|
+
* ```typescript
|
|
678
|
+
* const items: PostTransferRequirementsArray = await api.getPostTransferRequirementss();
|
|
679
|
+
* ```
|
|
680
|
+
*
|
|
681
|
+
* @see {@link PostTransferRequirements} - The individual PostTransferRequirements type definition
|
|
682
|
+
*/
|
|
683
|
+
export type PostTransferRequirementsArray = PostTransferRequirements[];
|
|
516
684
|
/**
|
|
517
685
|
* UserAttributeUpdate
|
|
518
686
|
*
|