@opusdns/api 0.54.0 → 0.56.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 +1 -51
- package/src/helpers/keys.ts +3061 -5172
- package/src/helpers/requests.d.ts +1 -569
- package/src/helpers/responses.d.ts +38 -916
- package/src/helpers/schemas-arrays.d.ts +1 -15
- package/src/helpers/schemas.d.ts +0 -208
- package/src/openapi.yaml +127 -1224
- package/src/schema.d.ts +122 -1289
|
@@ -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
|
*
|
|
@@ -2607,22 +2527,6 @@ export type SortOrder = components['schemas']['SortOrder'];
|
|
|
2607
2527
|
* @see {@link components} - The OpenAPI components schema definition
|
|
2608
2528
|
*/
|
|
2609
2529
|
export type SpiceDbRelationshipUpdate = components['schemas']['SpiceDbRelationshipUpdate'];
|
|
2610
|
-
/**
|
|
2611
|
-
* StartPasswordReset
|
|
2612
|
-
*
|
|
2613
|
-
* @remarks
|
|
2614
|
-
* Type alias for the `StartPasswordReset` OpenAPI schema.
|
|
2615
|
-
* This type represents startpasswordreset data structures used in API requests and responses.
|
|
2616
|
-
*
|
|
2617
|
-
* @example
|
|
2618
|
-
* ```typescript
|
|
2619
|
-
* const response = await api.getStartPasswordReset();
|
|
2620
|
-
* const item: StartPasswordReset = response.results;
|
|
2621
|
-
* ```
|
|
2622
|
-
*
|
|
2623
|
-
* @see {@link components} - The OpenAPI components schema definition
|
|
2624
|
-
*/
|
|
2625
|
-
export type StartPasswordReset = components['schemas']['StartPasswordReset'];
|
|
2626
2530
|
/**
|
|
2627
2531
|
* SyncOperationType
|
|
2628
2532
|
*
|
|
@@ -2831,70 +2735,6 @@ export type UserAttributeBase = components['schemas']['UserAttributeBase'];
|
|
|
2831
2735
|
* @see {@link components} - The OpenAPI components schema definition
|
|
2832
2736
|
*/
|
|
2833
2737
|
export type UserCreate = components['schemas']['UserCreate'];
|
|
2834
|
-
/**
|
|
2835
|
-
* UserNotification
|
|
2836
|
-
*
|
|
2837
|
-
* @remarks
|
|
2838
|
-
* Type alias for the `UserNotification` OpenAPI schema.
|
|
2839
|
-
* This type represents usernotification data structures used in API requests and responses.
|
|
2840
|
-
*
|
|
2841
|
-
* @example
|
|
2842
|
-
* ```typescript
|
|
2843
|
-
* const response = await api.getUserNotification();
|
|
2844
|
-
* const item: UserNotification = response.results;
|
|
2845
|
-
* ```
|
|
2846
|
-
*
|
|
2847
|
-
* @see {@link components} - The OpenAPI components schema definition
|
|
2848
|
-
*/
|
|
2849
|
-
export type UserNotification = components['schemas']['UserNotification'];
|
|
2850
|
-
/**
|
|
2851
|
-
* UserNotificationStatus
|
|
2852
|
-
*
|
|
2853
|
-
* @remarks
|
|
2854
|
-
* Type alias for the `UserNotificationStatus` OpenAPI schema.
|
|
2855
|
-
* This type represents usernotificationstatus data structures used in API requests and responses.
|
|
2856
|
-
*
|
|
2857
|
-
* @example
|
|
2858
|
-
* ```typescript
|
|
2859
|
-
* const response = await api.getUserNotificationStatus();
|
|
2860
|
-
* const item: UserNotificationStatus = response.results;
|
|
2861
|
-
* ```
|
|
2862
|
-
*
|
|
2863
|
-
* @see {@link components} - The OpenAPI components schema definition
|
|
2864
|
-
*/
|
|
2865
|
-
export type UserNotificationStatus = components['schemas']['UserNotificationStatus'];
|
|
2866
|
-
/**
|
|
2867
|
-
* UserNotificationSummary
|
|
2868
|
-
*
|
|
2869
|
-
* @remarks
|
|
2870
|
-
* Type alias for the `UserNotificationSummary` OpenAPI schema.
|
|
2871
|
-
* This type represents usernotificationsummary data structures used in API requests and responses.
|
|
2872
|
-
*
|
|
2873
|
-
* @example
|
|
2874
|
-
* ```typescript
|
|
2875
|
-
* const response = await api.getUserNotificationSummary();
|
|
2876
|
-
* const item: UserNotificationSummary = response.results;
|
|
2877
|
-
* ```
|
|
2878
|
-
*
|
|
2879
|
-
* @see {@link components} - The OpenAPI components schema definition
|
|
2880
|
-
*/
|
|
2881
|
-
export type UserNotificationSummary = components['schemas']['UserNotificationSummary'];
|
|
2882
|
-
/**
|
|
2883
|
-
* UserPasswordResetEmailResponse
|
|
2884
|
-
*
|
|
2885
|
-
* @remarks
|
|
2886
|
-
* Type alias for the `UserPasswordResetEmailResponse` OpenAPI schema.
|
|
2887
|
-
* This type represents userpasswordresetemailresponse data structures used in API requests and responses.
|
|
2888
|
-
*
|
|
2889
|
-
* @example
|
|
2890
|
-
* ```typescript
|
|
2891
|
-
* const response = await api.getUserPasswordResetEmail();
|
|
2892
|
-
* const item: UserPasswordResetEmail = response.results;
|
|
2893
|
-
* ```
|
|
2894
|
-
*
|
|
2895
|
-
* @see {@link components} - The OpenAPI components schema definition
|
|
2896
|
-
*/
|
|
2897
|
-
export type UserPasswordResetEmail = components['schemas']['UserPasswordResetEmailResponse'];
|
|
2898
2738
|
/**
|
|
2899
2739
|
* UserStatus
|
|
2900
2740
|
*
|
|
@@ -2943,54 +2783,6 @@ export type UserToken = components['schemas']['UserTokenResponse'];
|
|
|
2943
2783
|
* @see {@link components} - The OpenAPI components schema definition
|
|
2944
2784
|
*/
|
|
2945
2785
|
export type UserUpdate = components['schemas']['UserUpdate'];
|
|
2946
|
-
/**
|
|
2947
|
-
* UserVerificationApiResponse
|
|
2948
|
-
*
|
|
2949
|
-
* @remarks
|
|
2950
|
-
* Type alias for the `UserVerificationApiResponse` OpenAPI schema.
|
|
2951
|
-
* This type represents userverificationapiresponse data structures used in API requests and responses.
|
|
2952
|
-
*
|
|
2953
|
-
* @example
|
|
2954
|
-
* ```typescript
|
|
2955
|
-
* const response = await api.getUserVerificationApi();
|
|
2956
|
-
* const item: UserVerificationApi = response.results;
|
|
2957
|
-
* ```
|
|
2958
|
-
*
|
|
2959
|
-
* @see {@link components} - The OpenAPI components schema definition
|
|
2960
|
-
*/
|
|
2961
|
-
export type UserVerificationApi = components['schemas']['UserVerificationApiResponse'];
|
|
2962
|
-
/**
|
|
2963
|
-
* UserVerificationEmailResponse
|
|
2964
|
-
*
|
|
2965
|
-
* @remarks
|
|
2966
|
-
* Type alias for the `UserVerificationEmailResponse` OpenAPI schema.
|
|
2967
|
-
* This type represents userverificationemailresponse data structures used in API requests and responses.
|
|
2968
|
-
*
|
|
2969
|
-
* @example
|
|
2970
|
-
* ```typescript
|
|
2971
|
-
* const response = await api.getUserVerificationEmail();
|
|
2972
|
-
* const item: UserVerificationEmail = response.results;
|
|
2973
|
-
* ```
|
|
2974
|
-
*
|
|
2975
|
-
* @see {@link components} - The OpenAPI components schema definition
|
|
2976
|
-
*/
|
|
2977
|
-
export type UserVerificationEmail = components['schemas']['UserVerificationEmailResponse'];
|
|
2978
|
-
/**
|
|
2979
|
-
* UserVerificationResponse
|
|
2980
|
-
*
|
|
2981
|
-
* @remarks
|
|
2982
|
-
* Type alias for the `UserVerificationResponse` OpenAPI schema.
|
|
2983
|
-
* This type represents userverificationresponse data structures used in API requests and responses.
|
|
2984
|
-
*
|
|
2985
|
-
* @example
|
|
2986
|
-
* ```typescript
|
|
2987
|
-
* const response = await api.getUserVerification();
|
|
2988
|
-
* const item: UserVerification = response.results;
|
|
2989
|
-
* ```
|
|
2990
|
-
*
|
|
2991
|
-
* @see {@link components} - The OpenAPI components schema definition
|
|
2992
|
-
*/
|
|
2993
|
-
export type UserVerification = components['schemas']['UserVerificationResponse'];
|
|
2994
2786
|
/**
|
|
2995
2787
|
* UserWithAttributes
|
|
2996
2788
|
*
|