@opusdns/api 0.61.0 → 0.63.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 +161 -1
- package/src/helpers/keys.ts +788 -0
- package/src/helpers/requests.d.ts +309 -1
- package/src/helpers/responses.d.ts +369 -2
- package/src/helpers/schemas-arrays.d.ts +29 -1
- package/src/helpers/schemas.d.ts +160 -0
- package/src/openapi.yaml +570 -1
- package/src/schema.d.ts +510 -0
package/package.json
CHANGED
package/src/helpers/constants.ts
CHANGED
|
@@ -21,7 +21,7 @@
|
|
|
21
21
|
* ```
|
|
22
22
|
*/
|
|
23
23
|
|
|
24
|
-
import { AgreementType, AllocationMethodType, BillingTransactionAction, BillingTransactionProductType, ContactRoleType, ContactSortField, Currency, DeletePolicyType, DnsChangeAction, DnsRrsetType, DnssecAlgorithm, DnssecDigestType, DnssecModeType, DnssecRecordType, DnssecStatus, DomainAvailabilityStatus, DomainClientStatus, DomainContactType, DomainSortField, DomainStatus, EmailVerificationStatus, EventObjectType, EventSubtype, EventType, GrantType, LaunchPhaseType, LocalPresenceRequirementType, OrganizationCredentialStatus, OrganizationStatus, PatchOp, PeriodUnit, Permission, PlanRelation, PostTransferRequirements, PostalAddressType, PremiumAffectsType, PremiumSourceType, RegistrantChangeType, RegistryHandleAttributeType, Relation, RenewalMode, ReservedSourceType, SortOrder, SyncOperationType, TLDType, TransferAckType, UserStatus, VerificationType, ZoneSortField } from './schemas';
|
|
24
|
+
import { AgreementType, AllocationMethodType, BillingTransactionAction, BillingTransactionProductType, BillingTransactionSortField, BillingTransactionStatus, ContactRoleType, ContactSortField, Currency, DeletePolicyType, DnsChangeAction, DnsRrsetType, DnssecAlgorithm, DnssecDigestType, DnssecModeType, DnssecRecordType, DnssecStatus, DomainAvailabilityStatus, DomainClientStatus, DomainContactType, DomainSortField, DomainStatus, EmailVerificationStatus, EventObjectType, EventSubtype, EventType, GrantType, LaunchPhaseType, LocalPresenceRequirementType, OrganizationCredentialStatus, OrganizationStatus, PatchOp, PeriodUnit, Permission, PlanRelation, PostTransferRequirements, PostalAddressType, PremiumAffectsType, PremiumSourceType, RegistrantChangeType, RegistryHandleAttributeType, Relation, RenewalMode, ReservedSourceType, SortOrder, SyncOperationType, TLDType, TransferAckType, UserStatus, VerificationType, WalletCreditResponseStatus, ZoneSortField } from './schemas';
|
|
25
25
|
|
|
26
26
|
/**
|
|
27
27
|
* AgreementType. Auto-generated enum for AgreementType
|
|
@@ -239,6 +239,116 @@ export const BILLING_TRANSACTION_PRODUCT_TYPE_VALUES = [
|
|
|
239
239
|
'domain_forward'
|
|
240
240
|
] as const satisfies [string, ...string[]] | BillingTransactionProductType[];
|
|
241
241
|
|
|
242
|
+
/**
|
|
243
|
+
* BillingTransactionSortField. Auto-generated enum for BillingTransactionSortField
|
|
244
|
+
*
|
|
245
|
+
* @remarks
|
|
246
|
+
* This constant provides both object and array forms for the BillingTransactionSortField enum.
|
|
247
|
+
* The object form allows key-value access, while the array form enables iteration and validation.
|
|
248
|
+
*
|
|
249
|
+
* @example
|
|
250
|
+
* ```typescript
|
|
251
|
+
* // Using the object form for key-value access
|
|
252
|
+
* const status = BILLING_TRANSACTION_SORT_FIELD.SUCCESS;
|
|
253
|
+
*
|
|
254
|
+
* // Using the array form for iteration
|
|
255
|
+
* const allStatuses = BILLING_TRANSACTION_SORT_FIELD_VALUES;
|
|
256
|
+
* console.log(`Available statuses: ${allStatuses.join(', ')}`);
|
|
257
|
+
* ```
|
|
258
|
+
*
|
|
259
|
+
* @see {@link BillingTransactionSortField} - The TypeScript type definition
|
|
260
|
+
*/
|
|
261
|
+
export const BILLING_TRANSACTION_SORT_FIELD = {
|
|
262
|
+
PRODUCT_TYPE: "product_type",
|
|
263
|
+
ACTION: "action",
|
|
264
|
+
STATUS: "status",
|
|
265
|
+
CREATED_ON: "created_on",
|
|
266
|
+
COMPLETED_ON: "completed_on",
|
|
267
|
+
} as const satisfies Record<string, BillingTransactionSortField>;
|
|
268
|
+
|
|
269
|
+
/**
|
|
270
|
+
* Array of all BillingTransactionSortField enum values
|
|
271
|
+
*
|
|
272
|
+
* @remarks
|
|
273
|
+
* This constant provides a array containing all valid BillingTransactionSortField enum values.
|
|
274
|
+
* Useful for iteration, validation, and generating dynamic UI components.
|
|
275
|
+
*
|
|
276
|
+
* @example
|
|
277
|
+
* ```typescript
|
|
278
|
+
* // Iterating through all values
|
|
279
|
+
* for (const value of BILLING_TRANSACTION_SORT_FIELD_VALUES) {
|
|
280
|
+
* console.log(`Processing: ${value}`);
|
|
281
|
+
* }
|
|
282
|
+
*
|
|
283
|
+
* // Validation
|
|
284
|
+
* const isValid = BILLING_TRANSACTION_SORT_FIELD_VALUES.includes(someValue);
|
|
285
|
+
* ```
|
|
286
|
+
*
|
|
287
|
+
* @see {@link BillingTransactionSortField} - The TypeScript type definition
|
|
288
|
+
* @see {@link BILLING_TRANSACTION_SORT_FIELD} - The object form of this enum
|
|
289
|
+
*/
|
|
290
|
+
export const BILLING_TRANSACTION_SORT_FIELD_VALUES = [
|
|
291
|
+
'product_type',
|
|
292
|
+
'action',
|
|
293
|
+
'status',
|
|
294
|
+
'created_on',
|
|
295
|
+
'completed_on'
|
|
296
|
+
] as const satisfies [string, ...string[]] | BillingTransactionSortField[];
|
|
297
|
+
|
|
298
|
+
/**
|
|
299
|
+
* BillingTransactionStatus. Auto-generated enum for BillingTransactionStatus
|
|
300
|
+
*
|
|
301
|
+
* @remarks
|
|
302
|
+
* This constant provides both object and array forms for the BillingTransactionStatus enum.
|
|
303
|
+
* The object form allows key-value access, while the array form enables iteration and validation.
|
|
304
|
+
*
|
|
305
|
+
* @example
|
|
306
|
+
* ```typescript
|
|
307
|
+
* // Using the object form for key-value access
|
|
308
|
+
* const status = BILLING_TRANSACTION_STATUS.SUCCESS;
|
|
309
|
+
*
|
|
310
|
+
* // Using the array form for iteration
|
|
311
|
+
* const allStatuses = BILLING_TRANSACTION_STATUS_VALUES;
|
|
312
|
+
* console.log(`Available statuses: ${allStatuses.join(', ')}`);
|
|
313
|
+
* ```
|
|
314
|
+
*
|
|
315
|
+
* @see {@link BillingTransactionStatus} - The TypeScript type definition
|
|
316
|
+
*/
|
|
317
|
+
export const BILLING_TRANSACTION_STATUS = {
|
|
318
|
+
PENDING: "pending",
|
|
319
|
+
SUCCEEDED: "succeeded",
|
|
320
|
+
FAILED: "failed",
|
|
321
|
+
CANCELED: "canceled",
|
|
322
|
+
} as const satisfies Record<string, BillingTransactionStatus>;
|
|
323
|
+
|
|
324
|
+
/**
|
|
325
|
+
* Array of all BillingTransactionStatus enum values
|
|
326
|
+
*
|
|
327
|
+
* @remarks
|
|
328
|
+
* This constant provides a array containing all valid BillingTransactionStatus enum values.
|
|
329
|
+
* Useful for iteration, validation, and generating dynamic UI components.
|
|
330
|
+
*
|
|
331
|
+
* @example
|
|
332
|
+
* ```typescript
|
|
333
|
+
* // Iterating through all values
|
|
334
|
+
* for (const value of BILLING_TRANSACTION_STATUS_VALUES) {
|
|
335
|
+
* console.log(`Processing: ${value}`);
|
|
336
|
+
* }
|
|
337
|
+
*
|
|
338
|
+
* // Validation
|
|
339
|
+
* const isValid = BILLING_TRANSACTION_STATUS_VALUES.includes(someValue);
|
|
340
|
+
* ```
|
|
341
|
+
*
|
|
342
|
+
* @see {@link BillingTransactionStatus} - The TypeScript type definition
|
|
343
|
+
* @see {@link BILLING_TRANSACTION_STATUS} - The object form of this enum
|
|
344
|
+
*/
|
|
345
|
+
export const BILLING_TRANSACTION_STATUS_VALUES = [
|
|
346
|
+
'pending',
|
|
347
|
+
'succeeded',
|
|
348
|
+
'failed',
|
|
349
|
+
'canceled'
|
|
350
|
+
] as const satisfies [string, ...string[]] | BillingTransactionStatus[];
|
|
351
|
+
|
|
242
352
|
/**
|
|
243
353
|
* ContactRoleType. Auto-generated enum for ContactRoleType
|
|
244
354
|
*
|
|
@@ -2665,6 +2775,56 @@ export const VERIFICATION_TYPE_VALUES = [
|
|
|
2665
2775
|
'email'
|
|
2666
2776
|
] as const satisfies [string, ...string[]] | VerificationType[];
|
|
2667
2777
|
|
|
2778
|
+
/**
|
|
2779
|
+
* WalletCreditResponseStatus. Auto-generated enum for WalletCreditResponseStatus
|
|
2780
|
+
*
|
|
2781
|
+
* @remarks
|
|
2782
|
+
* This constant provides both object and array forms for the WalletCreditResponseStatus enum.
|
|
2783
|
+
* The object form allows key-value access, while the array form enables iteration and validation.
|
|
2784
|
+
*
|
|
2785
|
+
* @example
|
|
2786
|
+
* ```typescript
|
|
2787
|
+
* // Using the object form for key-value access
|
|
2788
|
+
* const status = WALLET_CREDIT_RESPONSE_STATUS.SUCCESS;
|
|
2789
|
+
*
|
|
2790
|
+
* // Using the array form for iteration
|
|
2791
|
+
* const allStatuses = WALLET_CREDIT_RESPONSE_STATUS_VALUES;
|
|
2792
|
+
* console.log(`Available statuses: ${allStatuses.join(', ')}`);
|
|
2793
|
+
* ```
|
|
2794
|
+
*
|
|
2795
|
+
* @see {@link WalletCreditResponseStatus} - The TypeScript type definition
|
|
2796
|
+
*/
|
|
2797
|
+
export const WALLET_CREDIT_RESPONSE_STATUS = {
|
|
2798
|
+
SUCCESS: "success",
|
|
2799
|
+
FAILED: "failed",
|
|
2800
|
+
} as const satisfies Record<string, WalletCreditResponseStatus>;
|
|
2801
|
+
|
|
2802
|
+
/**
|
|
2803
|
+
* Array of all WalletCreditResponseStatus enum values
|
|
2804
|
+
*
|
|
2805
|
+
* @remarks
|
|
2806
|
+
* This constant provides a array containing all valid WalletCreditResponseStatus enum values.
|
|
2807
|
+
* Useful for iteration, validation, and generating dynamic UI components.
|
|
2808
|
+
*
|
|
2809
|
+
* @example
|
|
2810
|
+
* ```typescript
|
|
2811
|
+
* // Iterating through all values
|
|
2812
|
+
* for (const value of WALLET_CREDIT_RESPONSE_STATUS_VALUES) {
|
|
2813
|
+
* console.log(`Processing: ${value}`);
|
|
2814
|
+
* }
|
|
2815
|
+
*
|
|
2816
|
+
* // Validation
|
|
2817
|
+
* const isValid = WALLET_CREDIT_RESPONSE_STATUS_VALUES.includes(someValue);
|
|
2818
|
+
* ```
|
|
2819
|
+
*
|
|
2820
|
+
* @see {@link WalletCreditResponseStatus} - The TypeScript type definition
|
|
2821
|
+
* @see {@link WALLET_CREDIT_RESPONSE_STATUS} - The object form of this enum
|
|
2822
|
+
*/
|
|
2823
|
+
export const WALLET_CREDIT_RESPONSE_STATUS_VALUES = [
|
|
2824
|
+
'success',
|
|
2825
|
+
'failed'
|
|
2826
|
+
] as const satisfies [string, ...string[]] | WalletCreditResponseStatus[];
|
|
2827
|
+
|
|
2668
2828
|
/**
|
|
2669
2829
|
* ZoneSortField. Auto-generated enum for ZoneSortField
|
|
2670
2830
|
*
|