@opusdns/api 0.32.0 → 0.34.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 +1375 -203
- package/src/helpers/requests.d.ts +411 -1
- package/src/helpers/responses.d.ts +736 -5
- package/src/helpers/schemas.d.ts +134 -6
- package/src/openapi.yaml +771 -14
- package/src/schema.d.ts +892 -26
package/src/helpers/schemas.d.ts
CHANGED
|
@@ -58,6 +58,38 @@ export type AllocationMethodType = components['schemas']['AllocationMethodType']
|
|
|
58
58
|
* @see {@link components} - The OpenAPI components schema definition
|
|
59
59
|
*/
|
|
60
60
|
export type AllowedNumberOfNameserverBase = components['schemas']['AllowedNumberOfNameserverBase'];
|
|
61
|
+
/**
|
|
62
|
+
* BillingMetadata
|
|
63
|
+
*
|
|
64
|
+
* @remarks
|
|
65
|
+
* Type alias for the `BillingMetadata` OpenAPI schema.
|
|
66
|
+
* This type represents billingmetadata data structures used in API requests and responses.
|
|
67
|
+
*
|
|
68
|
+
* @example
|
|
69
|
+
* ```typescript
|
|
70
|
+
* const response = await api.getBillingMetadata();
|
|
71
|
+
* const item: BillingMetadata = response.results;
|
|
72
|
+
* ```
|
|
73
|
+
*
|
|
74
|
+
* @see {@link components} - The OpenAPI components schema definition
|
|
75
|
+
*/
|
|
76
|
+
export type BillingMetadata = components['schemas']['BillingMetadata'];
|
|
77
|
+
/**
|
|
78
|
+
* BillingPlan
|
|
79
|
+
*
|
|
80
|
+
* @remarks
|
|
81
|
+
* Type alias for the `BillingPlan` OpenAPI schema.
|
|
82
|
+
* This type represents billingplan data structures used in API requests and responses.
|
|
83
|
+
*
|
|
84
|
+
* @example
|
|
85
|
+
* ```typescript
|
|
86
|
+
* const response = await api.getBillingPlan();
|
|
87
|
+
* const item: BillingPlan = response.results;
|
|
88
|
+
* ```
|
|
89
|
+
*
|
|
90
|
+
* @see {@link components} - The OpenAPI components schema definition
|
|
91
|
+
*/
|
|
92
|
+
export type BillingPlan = components['schemas']['BillingPlan'];
|
|
61
93
|
/**
|
|
62
94
|
* BillingTransactionAction
|
|
63
95
|
*
|
|
@@ -1819,21 +1851,21 @@ export type OrganizationToken = components['schemas']['OrganizationTokenResponse
|
|
|
1819
1851
|
*/
|
|
1820
1852
|
export type OrganizationUpdate = components['schemas']['OrganizationUpdate'];
|
|
1821
1853
|
/**
|
|
1822
|
-
*
|
|
1854
|
+
* OrganizationWithBillingData
|
|
1823
1855
|
*
|
|
1824
1856
|
* @remarks
|
|
1825
|
-
* Type alias for the `
|
|
1826
|
-
* This type represents
|
|
1857
|
+
* Type alias for the `OrganizationWithBillingData` OpenAPI schema.
|
|
1858
|
+
* This type represents organizationwithbillingdata data structures used in API requests and responses.
|
|
1827
1859
|
*
|
|
1828
1860
|
* @example
|
|
1829
1861
|
* ```typescript
|
|
1830
|
-
* const response = await api.
|
|
1831
|
-
* const item:
|
|
1862
|
+
* const response = await api.getOrganizationWithBillingData();
|
|
1863
|
+
* const item: OrganizationWithBillingData = response.results;
|
|
1832
1864
|
* ```
|
|
1833
1865
|
*
|
|
1834
1866
|
* @see {@link components} - The OpenAPI components schema definition
|
|
1835
1867
|
*/
|
|
1836
|
-
export type
|
|
1868
|
+
export type OrganizationWithBillingData = components['schemas']['OrganizationWithBillingData'];
|
|
1837
1869
|
/**
|
|
1838
1870
|
* PaginationMetadata
|
|
1839
1871
|
*
|
|
@@ -1994,6 +2026,22 @@ export type Pagination_UserNotificationSummary = components['schemas']['Paginati
|
|
|
1994
2026
|
* @see {@link components} - The OpenAPI components schema definition
|
|
1995
2027
|
*/
|
|
1996
2028
|
export type Pagination_User = components['schemas']['Pagination_User_'];
|
|
2029
|
+
/**
|
|
2030
|
+
* PasswordUpdate
|
|
2031
|
+
*
|
|
2032
|
+
* @remarks
|
|
2033
|
+
* Type alias for the `PasswordUpdate` OpenAPI schema.
|
|
2034
|
+
* This type represents passwordupdate data structures used in API requests and responses.
|
|
2035
|
+
*
|
|
2036
|
+
* @example
|
|
2037
|
+
* ```typescript
|
|
2038
|
+
* const response = await api.getPasswordUpdate();
|
|
2039
|
+
* const item: PasswordUpdate = response.results;
|
|
2040
|
+
* ```
|
|
2041
|
+
*
|
|
2042
|
+
* @see {@link components} - The OpenAPI components schema definition
|
|
2043
|
+
*/
|
|
2044
|
+
export type PasswordUpdate = components['schemas']['PasswordUpdate'];
|
|
1997
2045
|
/**
|
|
1998
2046
|
* PatchOp
|
|
1999
2047
|
*
|
|
@@ -2458,6 +2506,22 @@ export type SortOrder = components['schemas']['SortOrder'];
|
|
|
2458
2506
|
* @see {@link components} - The OpenAPI components schema definition
|
|
2459
2507
|
*/
|
|
2460
2508
|
export type SpiceDbRelationshipUpdate = components['schemas']['SpiceDbRelationshipUpdate'];
|
|
2509
|
+
/**
|
|
2510
|
+
* StartPasswordReset
|
|
2511
|
+
*
|
|
2512
|
+
* @remarks
|
|
2513
|
+
* Type alias for the `StartPasswordReset` OpenAPI schema.
|
|
2514
|
+
* This type represents startpasswordreset data structures used in API requests and responses.
|
|
2515
|
+
*
|
|
2516
|
+
* @example
|
|
2517
|
+
* ```typescript
|
|
2518
|
+
* const response = await api.getStartPasswordReset();
|
|
2519
|
+
* const item: StartPasswordReset = response.results;
|
|
2520
|
+
* ```
|
|
2521
|
+
*
|
|
2522
|
+
* @see {@link components} - The OpenAPI components schema definition
|
|
2523
|
+
*/
|
|
2524
|
+
export type StartPasswordReset = components['schemas']['StartPasswordReset'];
|
|
2461
2525
|
/**
|
|
2462
2526
|
* SyncOperationType
|
|
2463
2527
|
*
|
|
@@ -2698,6 +2762,22 @@ export type UserNotificationStatus = components['schemas']['UserNotificationStat
|
|
|
2698
2762
|
* @see {@link components} - The OpenAPI components schema definition
|
|
2699
2763
|
*/
|
|
2700
2764
|
export type UserNotificationSummary = components['schemas']['UserNotificationSummary'];
|
|
2765
|
+
/**
|
|
2766
|
+
* UserPasswordResetEmailResponse
|
|
2767
|
+
*
|
|
2768
|
+
* @remarks
|
|
2769
|
+
* Type alias for the `UserPasswordResetEmailResponse` OpenAPI schema.
|
|
2770
|
+
* This type represents userpasswordresetemailresponse data structures used in API requests and responses.
|
|
2771
|
+
*
|
|
2772
|
+
* @example
|
|
2773
|
+
* ```typescript
|
|
2774
|
+
* const response = await api.getUserPasswordResetEmail();
|
|
2775
|
+
* const item: UserPasswordResetEmail = response.results;
|
|
2776
|
+
* ```
|
|
2777
|
+
*
|
|
2778
|
+
* @see {@link components} - The OpenAPI components schema definition
|
|
2779
|
+
*/
|
|
2780
|
+
export type UserPasswordResetEmail = components['schemas']['UserPasswordResetEmailResponse'];
|
|
2701
2781
|
/**
|
|
2702
2782
|
* UserStatus
|
|
2703
2783
|
*
|
|
@@ -2746,6 +2826,54 @@ export type UserToken = components['schemas']['UserTokenResponse'];
|
|
|
2746
2826
|
* @see {@link components} - The OpenAPI components schema definition
|
|
2747
2827
|
*/
|
|
2748
2828
|
export type UserUpdate = components['schemas']['UserUpdate'];
|
|
2829
|
+
/**
|
|
2830
|
+
* UserVerificationApiResponse
|
|
2831
|
+
*
|
|
2832
|
+
* @remarks
|
|
2833
|
+
* Type alias for the `UserVerificationApiResponse` OpenAPI schema.
|
|
2834
|
+
* This type represents userverificationapiresponse data structures used in API requests and responses.
|
|
2835
|
+
*
|
|
2836
|
+
* @example
|
|
2837
|
+
* ```typescript
|
|
2838
|
+
* const response = await api.getUserVerificationApi();
|
|
2839
|
+
* const item: UserVerificationApi = response.results;
|
|
2840
|
+
* ```
|
|
2841
|
+
*
|
|
2842
|
+
* @see {@link components} - The OpenAPI components schema definition
|
|
2843
|
+
*/
|
|
2844
|
+
export type UserVerificationApi = components['schemas']['UserVerificationApiResponse'];
|
|
2845
|
+
/**
|
|
2846
|
+
* UserVerificationEmailResponse
|
|
2847
|
+
*
|
|
2848
|
+
* @remarks
|
|
2849
|
+
* Type alias for the `UserVerificationEmailResponse` OpenAPI schema.
|
|
2850
|
+
* This type represents userverificationemailresponse data structures used in API requests and responses.
|
|
2851
|
+
*
|
|
2852
|
+
* @example
|
|
2853
|
+
* ```typescript
|
|
2854
|
+
* const response = await api.getUserVerificationEmail();
|
|
2855
|
+
* const item: UserVerificationEmail = response.results;
|
|
2856
|
+
* ```
|
|
2857
|
+
*
|
|
2858
|
+
* @see {@link components} - The OpenAPI components schema definition
|
|
2859
|
+
*/
|
|
2860
|
+
export type UserVerificationEmail = components['schemas']['UserVerificationEmailResponse'];
|
|
2861
|
+
/**
|
|
2862
|
+
* UserVerificationResponse
|
|
2863
|
+
*
|
|
2864
|
+
* @remarks
|
|
2865
|
+
* Type alias for the `UserVerificationResponse` OpenAPI schema.
|
|
2866
|
+
* This type represents userverificationresponse data structures used in API requests and responses.
|
|
2867
|
+
*
|
|
2868
|
+
* @example
|
|
2869
|
+
* ```typescript
|
|
2870
|
+
* const response = await api.getUserVerification();
|
|
2871
|
+
* const item: UserVerification = response.results;
|
|
2872
|
+
* ```
|
|
2873
|
+
*
|
|
2874
|
+
* @see {@link components} - The OpenAPI components schema definition
|
|
2875
|
+
*/
|
|
2876
|
+
export type UserVerification = components['schemas']['UserVerificationResponse'];
|
|
2749
2877
|
/**
|
|
2750
2878
|
* UserWithAttributes
|
|
2751
2879
|
*
|