@opusdns/api 0.31.0 → 0.33.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 +1048 -33
- package/src/helpers/requests.d.ts +411 -1
- package/src/helpers/responses.d.ts +732 -1
- package/src/helpers/schemas-arrays.d.ts +6 -6
- package/src/helpers/schemas.d.ts +118 -6
- package/src/openapi.yaml +757 -22
- package/src/schema.d.ts +874 -40
|
@@ -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, Nameserver, DeletePolicyType, SyncOperationType, DomainContact,
|
|
24
|
+
import { DomainDnssecData, DomainDnssecDataCreate, OrganizationAttribute, OrganizationAttributeUpdate, IpRestriction, TldResponseShort, PostalAddressType, ContactConfigBase, DnsChange, DnsRecordCreate, DnsRecord, DnsRrsetCreate, DnsRecordPatchOp, DnsRrset, DnsRrsetPatchOp, DomainAvailabilityCheck, Nameserver, DeletePolicyType, SyncOperationType, DomainContact, DomainSearchSuggestionWithPrice, DomainStatus, DomainClientStatus, PlanInfo, PriceInfo, ValidationError, LaunchPhaseBase, LocalPresenceRequirementType, ContactRoleType, OrganizationAttribute2, User, OrganizationAttributeCreate, UserCreate, ContactSchema, DnsZone, Domain, EmailForwardAlias, EventResponse, OrganizationCredential, Organization, UserNotificationSummary, Period, Permission, PremiumAffectsType, Relation, TldBase, PostTransferRequirements, UserAttributeBase, DomainAvailability } from './schemas.d';
|
|
25
25
|
|
|
26
26
|
/**
|
|
27
27
|
* DomainDnssecDataResponse
|
|
@@ -304,19 +304,19 @@ export type SyncOperationTypeArray = SyncOperationType[];
|
|
|
304
304
|
*/
|
|
305
305
|
export type DomainContactArray = DomainContact[];
|
|
306
306
|
/**
|
|
307
|
-
*
|
|
307
|
+
* DomainSearchSuggestionWithPrice
|
|
308
308
|
*
|
|
309
309
|
* @remarks
|
|
310
|
-
* Array type for
|
|
310
|
+
* Array type for DomainSearchSuggestionWithPrice objects. Used when the API returns a collection of DomainSearchSuggestionWithPrice instances.
|
|
311
311
|
*
|
|
312
312
|
* @example
|
|
313
313
|
* ```typescript
|
|
314
|
-
* const items:
|
|
314
|
+
* const items: DomainSearchSuggestionWithPriceArray = await api.getDomainSearchSuggestionWithPrices();
|
|
315
315
|
* ```
|
|
316
316
|
*
|
|
317
|
-
* @see {@link
|
|
317
|
+
* @see {@link DomainSearchSuggestionWithPrice} - The individual DomainSearchSuggestionWithPrice type definition
|
|
318
318
|
*/
|
|
319
|
-
export type
|
|
319
|
+
export type DomainSearchSuggestionWithPriceArray = DomainSearchSuggestionWithPrice[];
|
|
320
320
|
/**
|
|
321
321
|
* DomainStatus
|
|
322
322
|
*
|
package/src/helpers/schemas.d.ts
CHANGED
|
@@ -987,21 +987,37 @@ export type DomainSearchMeta = components['schemas']['DomainSearchMeta'];
|
|
|
987
987
|
*/
|
|
988
988
|
export type DomainSearch = components['schemas']['DomainSearchResponse'];
|
|
989
989
|
/**
|
|
990
|
-
*
|
|
990
|
+
* DomainSearchSuggestionPriceData
|
|
991
991
|
*
|
|
992
992
|
* @remarks
|
|
993
|
-
* Type alias for the `
|
|
994
|
-
* This type represents
|
|
993
|
+
* Type alias for the `DomainSearchSuggestionPriceData` OpenAPI schema.
|
|
994
|
+
* This type represents domainsearchsuggestionpricedata data structures used in API requests and responses.
|
|
995
995
|
*
|
|
996
996
|
* @example
|
|
997
997
|
* ```typescript
|
|
998
|
-
* const response = await api.
|
|
999
|
-
* const item:
|
|
998
|
+
* const response = await api.getDomainSearchSuggestionPriceData();
|
|
999
|
+
* const item: DomainSearchSuggestionPriceData = response.results;
|
|
1000
1000
|
* ```
|
|
1001
1001
|
*
|
|
1002
1002
|
* @see {@link components} - The OpenAPI components schema definition
|
|
1003
1003
|
*/
|
|
1004
|
-
export type
|
|
1004
|
+
export type DomainSearchSuggestionPriceData = components['schemas']['DomainSearchSuggestionPriceData'];
|
|
1005
|
+
/**
|
|
1006
|
+
* DomainSearchSuggestionWithPrice
|
|
1007
|
+
*
|
|
1008
|
+
* @remarks
|
|
1009
|
+
* Type alias for the `DomainSearchSuggestionWithPrice` OpenAPI schema.
|
|
1010
|
+
* This type represents domainsearchsuggestionwithprice data structures used in API requests and responses.
|
|
1011
|
+
*
|
|
1012
|
+
* @example
|
|
1013
|
+
* ```typescript
|
|
1014
|
+
* const response = await api.getDomainSearchSuggestionWithPrice();
|
|
1015
|
+
* const item: DomainSearchSuggestionWithPrice = response.results;
|
|
1016
|
+
* ```
|
|
1017
|
+
*
|
|
1018
|
+
* @see {@link components} - The OpenAPI components schema definition
|
|
1019
|
+
*/
|
|
1020
|
+
export type DomainSearchSuggestionWithPrice = components['schemas']['DomainSearchSuggestionWithPrice'];
|
|
1005
1021
|
/**
|
|
1006
1022
|
* DomainSortField
|
|
1007
1023
|
*
|
|
@@ -1978,6 +1994,22 @@ export type Pagination_UserNotificationSummary = components['schemas']['Paginati
|
|
|
1978
1994
|
* @see {@link components} - The OpenAPI components schema definition
|
|
1979
1995
|
*/
|
|
1980
1996
|
export type Pagination_User = components['schemas']['Pagination_User_'];
|
|
1997
|
+
/**
|
|
1998
|
+
* PasswordUpdate
|
|
1999
|
+
*
|
|
2000
|
+
* @remarks
|
|
2001
|
+
* Type alias for the `PasswordUpdate` OpenAPI schema.
|
|
2002
|
+
* This type represents passwordupdate data structures used in API requests and responses.
|
|
2003
|
+
*
|
|
2004
|
+
* @example
|
|
2005
|
+
* ```typescript
|
|
2006
|
+
* const response = await api.getPasswordUpdate();
|
|
2007
|
+
* const item: PasswordUpdate = response.results;
|
|
2008
|
+
* ```
|
|
2009
|
+
*
|
|
2010
|
+
* @see {@link components} - The OpenAPI components schema definition
|
|
2011
|
+
*/
|
|
2012
|
+
export type PasswordUpdate = components['schemas']['PasswordUpdate'];
|
|
1981
2013
|
/**
|
|
1982
2014
|
* PatchOp
|
|
1983
2015
|
*
|
|
@@ -2442,6 +2474,22 @@ export type SortOrder = components['schemas']['SortOrder'];
|
|
|
2442
2474
|
* @see {@link components} - The OpenAPI components schema definition
|
|
2443
2475
|
*/
|
|
2444
2476
|
export type SpiceDbRelationshipUpdate = components['schemas']['SpiceDbRelationshipUpdate'];
|
|
2477
|
+
/**
|
|
2478
|
+
* StartPasswordReset
|
|
2479
|
+
*
|
|
2480
|
+
* @remarks
|
|
2481
|
+
* Type alias for the `StartPasswordReset` OpenAPI schema.
|
|
2482
|
+
* This type represents startpasswordreset data structures used in API requests and responses.
|
|
2483
|
+
*
|
|
2484
|
+
* @example
|
|
2485
|
+
* ```typescript
|
|
2486
|
+
* const response = await api.getStartPasswordReset();
|
|
2487
|
+
* const item: StartPasswordReset = response.results;
|
|
2488
|
+
* ```
|
|
2489
|
+
*
|
|
2490
|
+
* @see {@link components} - The OpenAPI components schema definition
|
|
2491
|
+
*/
|
|
2492
|
+
export type StartPasswordReset = components['schemas']['StartPasswordReset'];
|
|
2445
2493
|
/**
|
|
2446
2494
|
* SyncOperationType
|
|
2447
2495
|
*
|
|
@@ -2682,6 +2730,22 @@ export type UserNotificationStatus = components['schemas']['UserNotificationStat
|
|
|
2682
2730
|
* @see {@link components} - The OpenAPI components schema definition
|
|
2683
2731
|
*/
|
|
2684
2732
|
export type UserNotificationSummary = components['schemas']['UserNotificationSummary'];
|
|
2733
|
+
/**
|
|
2734
|
+
* UserPasswordResetEmailResponse
|
|
2735
|
+
*
|
|
2736
|
+
* @remarks
|
|
2737
|
+
* Type alias for the `UserPasswordResetEmailResponse` OpenAPI schema.
|
|
2738
|
+
* This type represents userpasswordresetemailresponse data structures used in API requests and responses.
|
|
2739
|
+
*
|
|
2740
|
+
* @example
|
|
2741
|
+
* ```typescript
|
|
2742
|
+
* const response = await api.getUserPasswordResetEmail();
|
|
2743
|
+
* const item: UserPasswordResetEmail = response.results;
|
|
2744
|
+
* ```
|
|
2745
|
+
*
|
|
2746
|
+
* @see {@link components} - The OpenAPI components schema definition
|
|
2747
|
+
*/
|
|
2748
|
+
export type UserPasswordResetEmail = components['schemas']['UserPasswordResetEmailResponse'];
|
|
2685
2749
|
/**
|
|
2686
2750
|
* UserStatus
|
|
2687
2751
|
*
|
|
@@ -2730,6 +2794,54 @@ export type UserToken = components['schemas']['UserTokenResponse'];
|
|
|
2730
2794
|
* @see {@link components} - The OpenAPI components schema definition
|
|
2731
2795
|
*/
|
|
2732
2796
|
export type UserUpdate = components['schemas']['UserUpdate'];
|
|
2797
|
+
/**
|
|
2798
|
+
* UserVerificationApiResponse
|
|
2799
|
+
*
|
|
2800
|
+
* @remarks
|
|
2801
|
+
* Type alias for the `UserVerificationApiResponse` OpenAPI schema.
|
|
2802
|
+
* This type represents userverificationapiresponse data structures used in API requests and responses.
|
|
2803
|
+
*
|
|
2804
|
+
* @example
|
|
2805
|
+
* ```typescript
|
|
2806
|
+
* const response = await api.getUserVerificationApi();
|
|
2807
|
+
* const item: UserVerificationApi = response.results;
|
|
2808
|
+
* ```
|
|
2809
|
+
*
|
|
2810
|
+
* @see {@link components} - The OpenAPI components schema definition
|
|
2811
|
+
*/
|
|
2812
|
+
export type UserVerificationApi = components['schemas']['UserVerificationApiResponse'];
|
|
2813
|
+
/**
|
|
2814
|
+
* UserVerificationEmailResponse
|
|
2815
|
+
*
|
|
2816
|
+
* @remarks
|
|
2817
|
+
* Type alias for the `UserVerificationEmailResponse` OpenAPI schema.
|
|
2818
|
+
* This type represents userverificationemailresponse data structures used in API requests and responses.
|
|
2819
|
+
*
|
|
2820
|
+
* @example
|
|
2821
|
+
* ```typescript
|
|
2822
|
+
* const response = await api.getUserVerificationEmail();
|
|
2823
|
+
* const item: UserVerificationEmail = response.results;
|
|
2824
|
+
* ```
|
|
2825
|
+
*
|
|
2826
|
+
* @see {@link components} - The OpenAPI components schema definition
|
|
2827
|
+
*/
|
|
2828
|
+
export type UserVerificationEmail = components['schemas']['UserVerificationEmailResponse'];
|
|
2829
|
+
/**
|
|
2830
|
+
* UserVerificationResponse
|
|
2831
|
+
*
|
|
2832
|
+
* @remarks
|
|
2833
|
+
* Type alias for the `UserVerificationResponse` OpenAPI schema.
|
|
2834
|
+
* This type represents userverificationresponse data structures used in API requests and responses.
|
|
2835
|
+
*
|
|
2836
|
+
* @example
|
|
2837
|
+
* ```typescript
|
|
2838
|
+
* const response = await api.getUserVerification();
|
|
2839
|
+
* const item: UserVerification = response.results;
|
|
2840
|
+
* ```
|
|
2841
|
+
*
|
|
2842
|
+
* @see {@link components} - The OpenAPI components schema definition
|
|
2843
|
+
*/
|
|
2844
|
+
export type UserVerification = components['schemas']['UserVerificationResponse'];
|
|
2733
2845
|
/**
|
|
2734
2846
|
* UserWithAttributes
|
|
2735
2847
|
*
|