@opusdns/api 0.53.0 → 0.55.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 +57 -51
- package/src/helpers/keys.ts +50 -1273
- package/src/helpers/requests.d.ts +53 -255
- package/src/helpers/responses.d.ts +56 -295
- package/src/helpers/schemas-arrays.d.ts +1 -15
- package/src/helpers/schemas.d.ts +32 -128
- package/src/openapi.yaml +56 -503
- package/src/schema.d.ts +62 -492
|
@@ -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, PostalAddressType, ContactConfigBase, DnsChange, DnsRecordCreate, DnsRecord, DnsRrsetCreate, DnsRecordPatchOp, DnsRrset, DnsRrsetPatchOp, DomainAvailabilityCheck, ContactHandle, Nameserver, DeletePolicyType, SyncOperationType, DomainContact, DomainSearchSuggestionWithPrice, DomainStatus, DomainClientStatus, PlanInfo, PriceInfo, ValidationError, LaunchPhaseBase, LocalPresenceRequirementType, ContactRoleType, OrganizationAttribute2, User, OrganizationAttributeCreate, UserCreate, ContactSchema, DnsZone, Domain, EmailForwardAlias, EventResponse, OrganizationCredential, Organization,
|
|
24
|
+
import { DomainDnssecData, DomainDnssecDataCreate, OrganizationAttribute, OrganizationAttributeUpdate, IpRestriction, TldResponseShort, PostalAddressType, ContactConfigBase, DnsChange, DnsRecordCreate, DnsRecord, DnsRrsetCreate, DnsRecordPatchOp, DnsRrset, DnsRrsetPatchOp, DomainAvailabilityCheck, ContactHandle, Nameserver, DeletePolicyType, SyncOperationType, DomainContact, DomainSearchSuggestionWithPrice, DomainStatus, DomainClientStatus, PlanInfo, PriceInfo, ValidationError, LaunchPhaseBase, LocalPresenceRequirementType, ContactRoleType, OrganizationAttribute2, User, OrganizationAttributeCreate, UserCreate, ContactSchema, DnsZone, Domain, EmailForwardAlias, EventResponse, OrganizationCredential, Organization, Period, Permission, PremiumAffectsType, Relation, UserAgreementAcceptance, TldBase, PostTransferRequirements, UserAttributeBase, DomainAvailability } from './schemas.d';
|
|
25
25
|
|
|
26
26
|
/**
|
|
27
27
|
* DomainDnssecDataResponse
|
|
@@ -597,20 +597,6 @@ export type OrganizationCredentialArray = OrganizationCredential[];
|
|
|
597
597
|
* @see {@link Organization} - The individual Organization type definition
|
|
598
598
|
*/
|
|
599
599
|
export type OrganizationArray = Organization[];
|
|
600
|
-
/**
|
|
601
|
-
* UserNotificationSummary
|
|
602
|
-
*
|
|
603
|
-
* @remarks
|
|
604
|
-
* Array type for UserNotificationSummary objects. Used when the API returns a collection of UserNotificationSummary instances.
|
|
605
|
-
*
|
|
606
|
-
* @example
|
|
607
|
-
* ```typescript
|
|
608
|
-
* const items: UserNotificationSummaryArray = await api.getUserNotificationSummarys();
|
|
609
|
-
* ```
|
|
610
|
-
*
|
|
611
|
-
* @see {@link UserNotificationSummary} - The individual UserNotificationSummary type definition
|
|
612
|
-
*/
|
|
613
|
-
export type UserNotificationSummaryArray = UserNotificationSummary[];
|
|
614
600
|
/**
|
|
615
601
|
* Period
|
|
616
602
|
*
|
package/src/helpers/schemas.d.ts
CHANGED
|
@@ -1663,70 +1663,6 @@ export type LocalPresenceRequirementType = components['schemas']['LocalPresenceR
|
|
|
1663
1663
|
* @see {@link components} - The OpenAPI components schema definition
|
|
1664
1664
|
*/
|
|
1665
1665
|
export type Nameserver = components['schemas']['Nameserver'];
|
|
1666
|
-
/**
|
|
1667
|
-
* Notification
|
|
1668
|
-
*
|
|
1669
|
-
* @remarks
|
|
1670
|
-
* Type alias for the `Notification` OpenAPI schema.
|
|
1671
|
-
* This type represents notification data structures used in API requests and responses.
|
|
1672
|
-
*
|
|
1673
|
-
* @example
|
|
1674
|
-
* ```typescript
|
|
1675
|
-
* const response = await api.getNotification();
|
|
1676
|
-
* const item: Notification = response.results;
|
|
1677
|
-
* ```
|
|
1678
|
-
*
|
|
1679
|
-
* @see {@link components} - The OpenAPI components schema definition
|
|
1680
|
-
*/
|
|
1681
|
-
export type Notification = components['schemas']['Notification'];
|
|
1682
|
-
/**
|
|
1683
|
-
* NotificationCreate
|
|
1684
|
-
*
|
|
1685
|
-
* @remarks
|
|
1686
|
-
* Type alias for the `NotificationCreate` OpenAPI schema.
|
|
1687
|
-
* This type represents notificationcreate data structures used in API requests and responses.
|
|
1688
|
-
*
|
|
1689
|
-
* @example
|
|
1690
|
-
* ```typescript
|
|
1691
|
-
* const response = await api.getNotificationCreate();
|
|
1692
|
-
* const item: NotificationCreate = response.results;
|
|
1693
|
-
* ```
|
|
1694
|
-
*
|
|
1695
|
-
* @see {@link components} - The OpenAPI components schema definition
|
|
1696
|
-
*/
|
|
1697
|
-
export type NotificationCreate = components['schemas']['NotificationCreate'];
|
|
1698
|
-
/**
|
|
1699
|
-
* NotificationSummary
|
|
1700
|
-
*
|
|
1701
|
-
* @remarks
|
|
1702
|
-
* Type alias for the `NotificationSummary` OpenAPI schema.
|
|
1703
|
-
* This type represents notificationsummary data structures used in API requests and responses.
|
|
1704
|
-
*
|
|
1705
|
-
* @example
|
|
1706
|
-
* ```typescript
|
|
1707
|
-
* const response = await api.getNotificationSummary();
|
|
1708
|
-
* const item: NotificationSummary = response.results;
|
|
1709
|
-
* ```
|
|
1710
|
-
*
|
|
1711
|
-
* @see {@link components} - The OpenAPI components schema definition
|
|
1712
|
-
*/
|
|
1713
|
-
export type NotificationSummary = components['schemas']['NotificationSummary'];
|
|
1714
|
-
/**
|
|
1715
|
-
* NotificationUpdate
|
|
1716
|
-
*
|
|
1717
|
-
* @remarks
|
|
1718
|
-
* Type alias for the `NotificationUpdate` OpenAPI schema.
|
|
1719
|
-
* This type represents notificationupdate data structures used in API requests and responses.
|
|
1720
|
-
*
|
|
1721
|
-
* @example
|
|
1722
|
-
* ```typescript
|
|
1723
|
-
* const response = await api.getNotificationUpdate();
|
|
1724
|
-
* const item: NotificationUpdate = response.results;
|
|
1725
|
-
* ```
|
|
1726
|
-
*
|
|
1727
|
-
* @see {@link components} - The OpenAPI components schema definition
|
|
1728
|
-
*/
|
|
1729
|
-
export type NotificationUpdate = components['schemas']['NotificationUpdate'];
|
|
1730
1666
|
/**
|
|
1731
1667
|
* Organization
|
|
1732
1668
|
*
|
|
@@ -2079,22 +2015,6 @@ export type Pagination_OrganizationCredential = components['schemas']['Paginatio
|
|
|
2079
2015
|
* @see {@link components} - The OpenAPI components schema definition
|
|
2080
2016
|
*/
|
|
2081
2017
|
export type Pagination_Organization = components['schemas']['Pagination_Organization_'];
|
|
2082
|
-
/**
|
|
2083
|
-
* Pagination[UserNotificationSummary]
|
|
2084
|
-
*
|
|
2085
|
-
* @remarks
|
|
2086
|
-
* Type alias for the `Pagination_UserNotificationSummary_` OpenAPI schema.
|
|
2087
|
-
* This type represents pagination[usernotificationsummary] data structures used in API requests and responses.
|
|
2088
|
-
*
|
|
2089
|
-
* @example
|
|
2090
|
-
* ```typescript
|
|
2091
|
-
* const response = await api.getPagination_UserNotificationSummary();
|
|
2092
|
-
* const item: Pagination_UserNotificationSummary = response.results;
|
|
2093
|
-
* ```
|
|
2094
|
-
*
|
|
2095
|
-
* @see {@link components} - The OpenAPI components schema definition
|
|
2096
|
-
*/
|
|
2097
|
-
export type Pagination_UserNotificationSummary = components['schemas']['Pagination_UserNotificationSummary_'];
|
|
2098
2018
|
/**
|
|
2099
2019
|
* Pagination[User]
|
|
2100
2020
|
*
|
|
@@ -2239,6 +2159,38 @@ export type PermissionSet = components['schemas']['PermissionSet'];
|
|
|
2239
2159
|
* @see {@link components} - The OpenAPI components schema definition
|
|
2240
2160
|
*/
|
|
2241
2161
|
export type PlanInfo = components['schemas']['PlanInfo'];
|
|
2162
|
+
/**
|
|
2163
|
+
* PlanRelation
|
|
2164
|
+
*
|
|
2165
|
+
* @remarks
|
|
2166
|
+
* Type alias for the `PlanRelation` OpenAPI schema.
|
|
2167
|
+
* This type represents planrelation data structures used in API requests and responses.
|
|
2168
|
+
*
|
|
2169
|
+
* @example
|
|
2170
|
+
* ```typescript
|
|
2171
|
+
* const response = await api.getPlanRelation();
|
|
2172
|
+
* const item: PlanRelation = response.results;
|
|
2173
|
+
* ```
|
|
2174
|
+
*
|
|
2175
|
+
* @see {@link components} - The OpenAPI components schema definition
|
|
2176
|
+
*/
|
|
2177
|
+
export type PlanRelation = components['schemas']['PlanRelation'];
|
|
2178
|
+
/**
|
|
2179
|
+
* PlanUpdate
|
|
2180
|
+
*
|
|
2181
|
+
* @remarks
|
|
2182
|
+
* Type alias for the `PlanUpdate` OpenAPI schema.
|
|
2183
|
+
* This type represents planupdate data structures used in API requests and responses.
|
|
2184
|
+
*
|
|
2185
|
+
* @example
|
|
2186
|
+
* ```typescript
|
|
2187
|
+
* const response = await api.getPlanUpdate();
|
|
2188
|
+
* const item: PlanUpdate = response.results;
|
|
2189
|
+
* ```
|
|
2190
|
+
*
|
|
2191
|
+
* @see {@link components} - The OpenAPI components schema definition
|
|
2192
|
+
*/
|
|
2193
|
+
export type PlanUpdate = components['schemas']['PlanUpdate'];
|
|
2242
2194
|
/**
|
|
2243
2195
|
* PostTransferRequirements
|
|
2244
2196
|
*
|
|
@@ -2799,54 +2751,6 @@ export type UserAttributeBase = components['schemas']['UserAttributeBase'];
|
|
|
2799
2751
|
* @see {@link components} - The OpenAPI components schema definition
|
|
2800
2752
|
*/
|
|
2801
2753
|
export type UserCreate = components['schemas']['UserCreate'];
|
|
2802
|
-
/**
|
|
2803
|
-
* UserNotification
|
|
2804
|
-
*
|
|
2805
|
-
* @remarks
|
|
2806
|
-
* Type alias for the `UserNotification` OpenAPI schema.
|
|
2807
|
-
* This type represents usernotification data structures used in API requests and responses.
|
|
2808
|
-
*
|
|
2809
|
-
* @example
|
|
2810
|
-
* ```typescript
|
|
2811
|
-
* const response = await api.getUserNotification();
|
|
2812
|
-
* const item: UserNotification = response.results;
|
|
2813
|
-
* ```
|
|
2814
|
-
*
|
|
2815
|
-
* @see {@link components} - The OpenAPI components schema definition
|
|
2816
|
-
*/
|
|
2817
|
-
export type UserNotification = components['schemas']['UserNotification'];
|
|
2818
|
-
/**
|
|
2819
|
-
* UserNotificationStatus
|
|
2820
|
-
*
|
|
2821
|
-
* @remarks
|
|
2822
|
-
* Type alias for the `UserNotificationStatus` OpenAPI schema.
|
|
2823
|
-
* This type represents usernotificationstatus data structures used in API requests and responses.
|
|
2824
|
-
*
|
|
2825
|
-
* @example
|
|
2826
|
-
* ```typescript
|
|
2827
|
-
* const response = await api.getUserNotificationStatus();
|
|
2828
|
-
* const item: UserNotificationStatus = response.results;
|
|
2829
|
-
* ```
|
|
2830
|
-
*
|
|
2831
|
-
* @see {@link components} - The OpenAPI components schema definition
|
|
2832
|
-
*/
|
|
2833
|
-
export type UserNotificationStatus = components['schemas']['UserNotificationStatus'];
|
|
2834
|
-
/**
|
|
2835
|
-
* UserNotificationSummary
|
|
2836
|
-
*
|
|
2837
|
-
* @remarks
|
|
2838
|
-
* Type alias for the `UserNotificationSummary` OpenAPI schema.
|
|
2839
|
-
* This type represents usernotificationsummary data structures used in API requests and responses.
|
|
2840
|
-
*
|
|
2841
|
-
* @example
|
|
2842
|
-
* ```typescript
|
|
2843
|
-
* const response = await api.getUserNotificationSummary();
|
|
2844
|
-
* const item: UserNotificationSummary = response.results;
|
|
2845
|
-
* ```
|
|
2846
|
-
*
|
|
2847
|
-
* @see {@link components} - The OpenAPI components schema definition
|
|
2848
|
-
*/
|
|
2849
|
-
export type UserNotificationSummary = components['schemas']['UserNotificationSummary'];
|
|
2850
2754
|
/**
|
|
2851
2755
|
* UserPasswordResetEmailResponse
|
|
2852
2756
|
*
|