@opusdns/api 0.112.0 → 0.113.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 +107 -1
- package/src/helpers/keys.ts +490 -0
- package/src/helpers/requests.d.ts +245 -164
- package/src/helpers/responses.d.ts +896 -139
- package/src/helpers/schemas-arrays.d.ts +48 -6
- package/src/helpers/schemas.d.ts +118 -6
- package/src/openapi.yaml +799 -189
- package/src/schema.d.ts +896 -120
|
@@ -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, DomainForwardPatchOp, HttpRedirectList, DomainForward, DeletePolicyType, SyncOperationType, DomainContact, DomainSearchSuggestionWithPrice, DomainStatus, DomainClientStatus, PriceInfo, ValidationError, LaunchPhaseBase, LocalPresenceRequirementType, ContactRoleType, OrganizationAttribute2, User, OrganizationAttributeCreate, UserCreate, BillingTransaction, ContactSchema, DnsZone, DomainForwardZone, Domain,
|
|
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, EmailForwardAliasCreate, EmailForwardAlias, EmailForward, PriceInfo, ValidationError, LaunchPhaseBase, LocalPresenceRequirementType, ContactRoleType, OrganizationAttribute2, User, OrganizationAttributeCreate, UserCreate, BillingTransaction, ContactSchema, DnsZone, DomainForwardZone, Domain, EmailForwardZone, EventResponse, Invoice, ObjectLog, Organization, RequestHistory, Period, Permission, PremiumAffectsType, Relation, TldBase, PostTransferRequirements, UserAttributeBase, DomainAvailability } from './schemas.d';
|
|
25
25
|
|
|
26
26
|
/**
|
|
27
27
|
* DomainDnssecDataResponse
|
|
@@ -443,6 +443,48 @@ export type DomainStatusArray = DomainStatus[];
|
|
|
443
443
|
* @see {@link DomainClientStatus} - The individual DomainClientStatus type definition
|
|
444
444
|
*/
|
|
445
445
|
export type DomainClientStatusArray = DomainClientStatus[];
|
|
446
|
+
/**
|
|
447
|
+
* EmailForwardAliasCreate
|
|
448
|
+
*
|
|
449
|
+
* @remarks
|
|
450
|
+
* Array type for EmailForwardAliasCreate objects. Used when the API returns a collection of EmailForwardAliasCreate instances.
|
|
451
|
+
*
|
|
452
|
+
* @example
|
|
453
|
+
* ```typescript
|
|
454
|
+
* const items: EmailForwardAliasCreateArray = await api.getEmailForwardAliasCreates();
|
|
455
|
+
* ```
|
|
456
|
+
*
|
|
457
|
+
* @see {@link EmailForwardAliasCreate} - The individual EmailForwardAliasCreate type definition
|
|
458
|
+
*/
|
|
459
|
+
export type EmailForwardAliasCreateArray = EmailForwardAliasCreate[];
|
|
460
|
+
/**
|
|
461
|
+
* EmailForwardAlias
|
|
462
|
+
*
|
|
463
|
+
* @remarks
|
|
464
|
+
* Array type for EmailForwardAlias objects. Used when the API returns a collection of EmailForwardAlias instances.
|
|
465
|
+
*
|
|
466
|
+
* @example
|
|
467
|
+
* ```typescript
|
|
468
|
+
* const items: EmailForwardAliasArray = await api.getEmailForwardAliass();
|
|
469
|
+
* ```
|
|
470
|
+
*
|
|
471
|
+
* @see {@link EmailForwardAlias} - The individual EmailForwardAlias type definition
|
|
472
|
+
*/
|
|
473
|
+
export type EmailForwardAliasArray = EmailForwardAlias[];
|
|
474
|
+
/**
|
|
475
|
+
* EmailForwardResponse
|
|
476
|
+
*
|
|
477
|
+
* @remarks
|
|
478
|
+
* Array type for EmailForwardResponse objects. Used when the API returns a collection of EmailForwardResponse instances.
|
|
479
|
+
*
|
|
480
|
+
* @example
|
|
481
|
+
* ```typescript
|
|
482
|
+
* const items: EmailForwardArray = await api.getEmailForwards();
|
|
483
|
+
* ```
|
|
484
|
+
*
|
|
485
|
+
* @see {@link EmailForward} - The individual EmailForwardResponse type definition
|
|
486
|
+
*/
|
|
487
|
+
export type EmailForwardArray = EmailForward[];
|
|
446
488
|
/**
|
|
447
489
|
* PriceInfo
|
|
448
490
|
*
|
|
@@ -640,19 +682,19 @@ export type DomainForwardZoneArray = DomainForwardZone[];
|
|
|
640
682
|
*/
|
|
641
683
|
export type DomainArray = Domain[];
|
|
642
684
|
/**
|
|
643
|
-
*
|
|
685
|
+
* EmailForwardZone
|
|
644
686
|
*
|
|
645
687
|
* @remarks
|
|
646
|
-
* Array type for
|
|
688
|
+
* Array type for EmailForwardZone objects. Used when the API returns a collection of EmailForwardZone instances.
|
|
647
689
|
*
|
|
648
690
|
* @example
|
|
649
691
|
* ```typescript
|
|
650
|
-
* const items:
|
|
692
|
+
* const items: EmailForwardZoneArray = await api.getEmailForwardZones();
|
|
651
693
|
* ```
|
|
652
694
|
*
|
|
653
|
-
* @see {@link
|
|
695
|
+
* @see {@link EmailForwardZone} - The individual EmailForwardZone type definition
|
|
654
696
|
*/
|
|
655
|
-
export type
|
|
697
|
+
export type EmailForwardZoneArray = EmailForwardZone[];
|
|
656
698
|
/**
|
|
657
699
|
* EventResponse
|
|
658
700
|
*
|
package/src/helpers/schemas.d.ts
CHANGED
|
@@ -1594,6 +1594,22 @@ export type DomainsExpiringSoon = components['schemas']['DomainsExpiringSoon'];
|
|
|
1594
1594
|
* @see {@link components} - The OpenAPI components schema definition
|
|
1595
1595
|
*/
|
|
1596
1596
|
export type EmailForwardAlias = components['schemas']['EmailForwardAlias'];
|
|
1597
|
+
/**
|
|
1598
|
+
* EmailForwardAliasCreate
|
|
1599
|
+
*
|
|
1600
|
+
* @remarks
|
|
1601
|
+
* Type alias for the `EmailForwardAliasCreate` OpenAPI schema.
|
|
1602
|
+
* This type represents emailforwardaliascreate data structures used in API requests and responses.
|
|
1603
|
+
*
|
|
1604
|
+
* @example
|
|
1605
|
+
* ```typescript
|
|
1606
|
+
* const response = await api.getEmailForwardAliasCreate();
|
|
1607
|
+
* const item: EmailForwardAliasCreate = response.results;
|
|
1608
|
+
* ```
|
|
1609
|
+
*
|
|
1610
|
+
* @see {@link components} - The OpenAPI components schema definition
|
|
1611
|
+
*/
|
|
1612
|
+
export type EmailForwardAliasCreate = components['schemas']['EmailForwardAliasCreate'];
|
|
1597
1613
|
/**
|
|
1598
1614
|
* EmailForwardAliasUpdate
|
|
1599
1615
|
*
|
|
@@ -1610,6 +1626,86 @@ export type EmailForwardAlias = components['schemas']['EmailForwardAlias'];
|
|
|
1610
1626
|
* @see {@link components} - The OpenAPI components schema definition
|
|
1611
1627
|
*/
|
|
1612
1628
|
export type EmailForwardAliasUpdate = components['schemas']['EmailForwardAliasUpdate'];
|
|
1629
|
+
/**
|
|
1630
|
+
* EmailForwardCreate
|
|
1631
|
+
*
|
|
1632
|
+
* @remarks
|
|
1633
|
+
* Type alias for the `EmailForwardCreate` OpenAPI schema.
|
|
1634
|
+
* This type represents emailforwardcreate data structures used in API requests and responses.
|
|
1635
|
+
*
|
|
1636
|
+
* @example
|
|
1637
|
+
* ```typescript
|
|
1638
|
+
* const response = await api.getEmailForwardCreate();
|
|
1639
|
+
* const item: EmailForwardCreate = response.results;
|
|
1640
|
+
* ```
|
|
1641
|
+
*
|
|
1642
|
+
* @see {@link components} - The OpenAPI components schema definition
|
|
1643
|
+
*/
|
|
1644
|
+
export type EmailForwardCreate = components['schemas']['EmailForwardCreate'];
|
|
1645
|
+
/**
|
|
1646
|
+
* EmailForwardResponse
|
|
1647
|
+
*
|
|
1648
|
+
* @remarks
|
|
1649
|
+
* Type alias for the `EmailForwardResponse` OpenAPI schema.
|
|
1650
|
+
* This type represents emailforwardresponse data structures used in API requests and responses.
|
|
1651
|
+
*
|
|
1652
|
+
* @example
|
|
1653
|
+
* ```typescript
|
|
1654
|
+
* const response = await api.getEmailForward();
|
|
1655
|
+
* const item: EmailForward = response.results;
|
|
1656
|
+
* ```
|
|
1657
|
+
*
|
|
1658
|
+
* @see {@link components} - The OpenAPI components schema definition
|
|
1659
|
+
*/
|
|
1660
|
+
export type EmailForward = components['schemas']['EmailForwardResponse'];
|
|
1661
|
+
/**
|
|
1662
|
+
* EmailForwardSortField
|
|
1663
|
+
*
|
|
1664
|
+
* @remarks
|
|
1665
|
+
* Type alias for the `EmailForwardSortField` OpenAPI schema.
|
|
1666
|
+
* This type represents emailforwardsortfield data structures used in API requests and responses.
|
|
1667
|
+
*
|
|
1668
|
+
* @example
|
|
1669
|
+
* ```typescript
|
|
1670
|
+
* const response = await api.getEmailForwardSortField();
|
|
1671
|
+
* const item: EmailForwardSortField = response.results;
|
|
1672
|
+
* ```
|
|
1673
|
+
*
|
|
1674
|
+
* @see {@link components} - The OpenAPI components schema definition
|
|
1675
|
+
*/
|
|
1676
|
+
export type EmailForwardSortField = components['schemas']['EmailForwardSortField'];
|
|
1677
|
+
/**
|
|
1678
|
+
* EmailForwardZone
|
|
1679
|
+
*
|
|
1680
|
+
* @remarks
|
|
1681
|
+
* Type alias for the `EmailForwardZone` OpenAPI schema.
|
|
1682
|
+
* This type represents emailforwardzone data structures used in API requests and responses.
|
|
1683
|
+
*
|
|
1684
|
+
* @example
|
|
1685
|
+
* ```typescript
|
|
1686
|
+
* const response = await api.getEmailForwardZone();
|
|
1687
|
+
* const item: EmailForwardZone = response.results;
|
|
1688
|
+
* ```
|
|
1689
|
+
*
|
|
1690
|
+
* @see {@link components} - The OpenAPI components schema definition
|
|
1691
|
+
*/
|
|
1692
|
+
export type EmailForwardZone = components['schemas']['EmailForwardZone'];
|
|
1693
|
+
/**
|
|
1694
|
+
* EmailForwardZoneSortField
|
|
1695
|
+
*
|
|
1696
|
+
* @remarks
|
|
1697
|
+
* Type alias for the `EmailForwardZoneSortField` OpenAPI schema.
|
|
1698
|
+
* This type represents emailforwardzonesortfield data structures used in API requests and responses.
|
|
1699
|
+
*
|
|
1700
|
+
* @example
|
|
1701
|
+
* ```typescript
|
|
1702
|
+
* const response = await api.getEmailForwardZoneSortField();
|
|
1703
|
+
* const item: EmailForwardZoneSortField = response.results;
|
|
1704
|
+
* ```
|
|
1705
|
+
*
|
|
1706
|
+
* @see {@link components} - The OpenAPI components schema definition
|
|
1707
|
+
*/
|
|
1708
|
+
export type EmailForwardZoneSortField = components['schemas']['EmailForwardZoneSortField'];
|
|
1613
1709
|
/**
|
|
1614
1710
|
* EmailVerificationStatus
|
|
1615
1711
|
*
|
|
@@ -2448,21 +2544,37 @@ export type Pagination_DomainForward = components['schemas']['Pagination_DomainF
|
|
|
2448
2544
|
*/
|
|
2449
2545
|
export type Pagination_Domain = components['schemas']['Pagination_DomainResponse_'];
|
|
2450
2546
|
/**
|
|
2451
|
-
* Pagination[
|
|
2547
|
+
* Pagination[EmailForwardResponse]
|
|
2548
|
+
*
|
|
2549
|
+
* @remarks
|
|
2550
|
+
* Type alias for the `Pagination_EmailForwardResponse_` OpenAPI schema.
|
|
2551
|
+
* This type represents pagination[emailforwardresponse] data structures used in API requests and responses.
|
|
2552
|
+
*
|
|
2553
|
+
* @example
|
|
2554
|
+
* ```typescript
|
|
2555
|
+
* const response = await api.getPagination_EmailForward();
|
|
2556
|
+
* const item: Pagination_EmailForward = response.results;
|
|
2557
|
+
* ```
|
|
2558
|
+
*
|
|
2559
|
+
* @see {@link components} - The OpenAPI components schema definition
|
|
2560
|
+
*/
|
|
2561
|
+
export type Pagination_EmailForward = components['schemas']['Pagination_EmailForwardResponse_'];
|
|
2562
|
+
/**
|
|
2563
|
+
* Pagination[EmailForwardZone]
|
|
2452
2564
|
*
|
|
2453
2565
|
* @remarks
|
|
2454
|
-
* Type alias for the `
|
|
2455
|
-
* This type represents pagination[
|
|
2566
|
+
* Type alias for the `Pagination_EmailForwardZone_` OpenAPI schema.
|
|
2567
|
+
* This type represents pagination[emailforwardzone] data structures used in API requests and responses.
|
|
2456
2568
|
*
|
|
2457
2569
|
* @example
|
|
2458
2570
|
* ```typescript
|
|
2459
|
-
* const response = await api.
|
|
2460
|
-
* const item:
|
|
2571
|
+
* const response = await api.getPagination_EmailForwardZone();
|
|
2572
|
+
* const item: Pagination_EmailForwardZone = response.results;
|
|
2461
2573
|
* ```
|
|
2462
2574
|
*
|
|
2463
2575
|
* @see {@link components} - The OpenAPI components schema definition
|
|
2464
2576
|
*/
|
|
2465
|
-
export type
|
|
2577
|
+
export type Pagination_EmailForwardZone = components['schemas']['Pagination_EmailForwardZone_'];
|
|
2466
2578
|
/**
|
|
2467
2579
|
* Pagination[EventResponse]
|
|
2468
2580
|
*
|