@opusdns/api 0.60.0 → 0.62.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 +111 -1
- package/src/helpers/keys.ts +320 -33
- package/src/helpers/requests.d.ts +90 -0
- package/src/helpers/responses.d.ts +111 -1
- package/src/helpers/schemas-arrays.d.ts +15 -1
- package/src/helpers/schemas.d.ts +80 -0
- package/src/openapi.yaml +275 -11
- package/src/schema.d.ts +177 -10
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, 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
|
*
|
package/src/helpers/keys.ts
CHANGED
|
@@ -32,6 +32,7 @@
|
|
|
32
32
|
import { AllowedNumberOfNameserverBase } from './schemas';
|
|
33
33
|
import { BillingMetadata } from './schemas';
|
|
34
34
|
import { BillingPlan } from './schemas';
|
|
35
|
+
import { BillingTransaction } from './schemas';
|
|
35
36
|
import { Body_issue_organization_token_v1_auth_token_post } from './schemas';
|
|
36
37
|
import { ContactConfigBase } from './schemas';
|
|
37
38
|
import { ContactCreate } from './schemas';
|
|
@@ -120,6 +121,7 @@ import { PlanInfo } from './schemas';
|
|
|
120
121
|
import { PlanUpdate } from './schemas';
|
|
121
122
|
import { PremiumDomainsBase } from './schemas';
|
|
122
123
|
import { PriceInfo } from './schemas';
|
|
124
|
+
import { PricingPeriod } from './schemas';
|
|
123
125
|
import { Problem } from './schemas';
|
|
124
126
|
import { RdapBase } from './schemas';
|
|
125
127
|
import { RegistryLockBase } from './schemas';
|
|
@@ -483,6 +485,240 @@ export const KEYS_BILLING_PLAN = [
|
|
|
483
485
|
KEY_BILLING_PLAN_TYPE,
|
|
484
486
|
] as const satisfies (keyof BillingPlan)[];
|
|
485
487
|
|
|
488
|
+
/**
|
|
489
|
+
* action property
|
|
490
|
+
*
|
|
491
|
+
* The action performed in the transaction
|
|
492
|
+
*
|
|
493
|
+
*
|
|
494
|
+
*
|
|
495
|
+
* @remarks
|
|
496
|
+
* This key constant provides type-safe access to the `action` property of BillingTransaction objects.
|
|
497
|
+
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
498
|
+
*
|
|
499
|
+
* @example
|
|
500
|
+
* ```typescript
|
|
501
|
+
* // Direct property access
|
|
502
|
+
* const value = billingtransaction[KEY_BILLING_TRANSACTION_ACTION];
|
|
503
|
+
*
|
|
504
|
+
* // Dynamic property access
|
|
505
|
+
* const propertyName = KEY_BILLING_TRANSACTION_ACTION;
|
|
506
|
+
* const value = billingtransaction[propertyName];
|
|
507
|
+
* ```
|
|
508
|
+
*
|
|
509
|
+
* @see {@link BillingTransaction} - The TypeScript type definition
|
|
510
|
+
* @see {@link KEYS_BILLING_TRANSACTION} - Array of all keys for this type
|
|
511
|
+
*/
|
|
512
|
+
export const KEY_BILLING_TRANSACTION_ACTION = 'action' as keyof BillingTransaction;
|
|
513
|
+
/**
|
|
514
|
+
* Billing Transaction Id
|
|
515
|
+
*
|
|
516
|
+
*
|
|
517
|
+
* @type {string}
|
|
518
|
+
*
|
|
519
|
+
*
|
|
520
|
+
* @remarks
|
|
521
|
+
* This key constant provides type-safe access to the `billing_transaction_id` property of BillingTransaction objects.
|
|
522
|
+
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
523
|
+
*
|
|
524
|
+
* @example
|
|
525
|
+
* ```typescript
|
|
526
|
+
* // Direct property access
|
|
527
|
+
* const value = billingtransaction[KEY_BILLING_TRANSACTION_BILLING_TRANSACTION_ID];
|
|
528
|
+
*
|
|
529
|
+
* // Dynamic property access
|
|
530
|
+
* const propertyName = KEY_BILLING_TRANSACTION_BILLING_TRANSACTION_ID;
|
|
531
|
+
* const value = billingtransaction[propertyName];
|
|
532
|
+
* ```
|
|
533
|
+
*
|
|
534
|
+
* @see {@link BillingTransaction} - The TypeScript type definition
|
|
535
|
+
* @see {@link KEYS_BILLING_TRANSACTION} - Array of all keys for this type
|
|
536
|
+
*/
|
|
537
|
+
export const KEY_BILLING_TRANSACTION_BILLING_TRANSACTION_ID = 'billing_transaction_id' as keyof BillingTransaction;
|
|
538
|
+
/**
|
|
539
|
+
* Completed On
|
|
540
|
+
*
|
|
541
|
+
* The date/time the transaction completed
|
|
542
|
+
*
|
|
543
|
+
*
|
|
544
|
+
*
|
|
545
|
+
* @remarks
|
|
546
|
+
* This key constant provides type-safe access to the `completed_on` property of BillingTransaction objects.
|
|
547
|
+
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
548
|
+
*
|
|
549
|
+
* @example
|
|
550
|
+
* ```typescript
|
|
551
|
+
* // Direct property access
|
|
552
|
+
* const value = billingtransaction[KEY_BILLING_TRANSACTION_COMPLETED_ON];
|
|
553
|
+
*
|
|
554
|
+
* // Dynamic property access
|
|
555
|
+
* const propertyName = KEY_BILLING_TRANSACTION_COMPLETED_ON;
|
|
556
|
+
* const value = billingtransaction[propertyName];
|
|
557
|
+
* ```
|
|
558
|
+
*
|
|
559
|
+
* @see {@link BillingTransaction} - The TypeScript type definition
|
|
560
|
+
* @see {@link KEYS_BILLING_TRANSACTION} - Array of all keys for this type
|
|
561
|
+
*/
|
|
562
|
+
export const KEY_BILLING_TRANSACTION_COMPLETED_ON = 'completed_on' as keyof BillingTransaction;
|
|
563
|
+
/**
|
|
564
|
+
* Created On
|
|
565
|
+
*
|
|
566
|
+
* The date/time the transaction was created
|
|
567
|
+
*
|
|
568
|
+
* @type {string}
|
|
569
|
+
*
|
|
570
|
+
*
|
|
571
|
+
* @remarks
|
|
572
|
+
* This key constant provides type-safe access to the `created_on` property of BillingTransaction objects.
|
|
573
|
+
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
574
|
+
*
|
|
575
|
+
* @example
|
|
576
|
+
* ```typescript
|
|
577
|
+
* // Direct property access
|
|
578
|
+
* const value = billingtransaction[KEY_BILLING_TRANSACTION_CREATED_ON];
|
|
579
|
+
*
|
|
580
|
+
* // Dynamic property access
|
|
581
|
+
* const propertyName = KEY_BILLING_TRANSACTION_CREATED_ON;
|
|
582
|
+
* const value = billingtransaction[propertyName];
|
|
583
|
+
* ```
|
|
584
|
+
*
|
|
585
|
+
* @see {@link BillingTransaction} - The TypeScript type definition
|
|
586
|
+
* @see {@link KEYS_BILLING_TRANSACTION} - Array of all keys for this type
|
|
587
|
+
*/
|
|
588
|
+
export const KEY_BILLING_TRANSACTION_CREATED_ON = 'created_on' as keyof BillingTransaction;
|
|
589
|
+
/**
|
|
590
|
+
* Product Reference
|
|
591
|
+
*
|
|
592
|
+
* The reference of the product
|
|
593
|
+
*
|
|
594
|
+
*
|
|
595
|
+
*
|
|
596
|
+
* @remarks
|
|
597
|
+
* This key constant provides type-safe access to the `product_reference` property of BillingTransaction objects.
|
|
598
|
+
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
599
|
+
*
|
|
600
|
+
* @example
|
|
601
|
+
* ```typescript
|
|
602
|
+
* // Direct property access
|
|
603
|
+
* const value = billingtransaction[KEY_BILLING_TRANSACTION_PRODUCT_REFERENCE];
|
|
604
|
+
*
|
|
605
|
+
* // Dynamic property access
|
|
606
|
+
* const propertyName = KEY_BILLING_TRANSACTION_PRODUCT_REFERENCE;
|
|
607
|
+
* const value = billingtransaction[propertyName];
|
|
608
|
+
* ```
|
|
609
|
+
*
|
|
610
|
+
* @see {@link BillingTransaction} - The TypeScript type definition
|
|
611
|
+
* @see {@link KEYS_BILLING_TRANSACTION} - Array of all keys for this type
|
|
612
|
+
*/
|
|
613
|
+
export const KEY_BILLING_TRANSACTION_PRODUCT_REFERENCE = 'product_reference' as keyof BillingTransaction;
|
|
614
|
+
/**
|
|
615
|
+
* product_type property
|
|
616
|
+
*
|
|
617
|
+
* The type of product
|
|
618
|
+
*
|
|
619
|
+
*
|
|
620
|
+
*
|
|
621
|
+
* @remarks
|
|
622
|
+
* This key constant provides type-safe access to the `product_type` property of BillingTransaction objects.
|
|
623
|
+
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
624
|
+
*
|
|
625
|
+
* @example
|
|
626
|
+
* ```typescript
|
|
627
|
+
* // Direct property access
|
|
628
|
+
* const value = billingtransaction[KEY_BILLING_TRANSACTION_PRODUCT_TYPE];
|
|
629
|
+
*
|
|
630
|
+
* // Dynamic property access
|
|
631
|
+
* const propertyName = KEY_BILLING_TRANSACTION_PRODUCT_TYPE;
|
|
632
|
+
* const value = billingtransaction[propertyName];
|
|
633
|
+
* ```
|
|
634
|
+
*
|
|
635
|
+
* @see {@link BillingTransaction} - The TypeScript type definition
|
|
636
|
+
* @see {@link KEYS_BILLING_TRANSACTION} - Array of all keys for this type
|
|
637
|
+
*/
|
|
638
|
+
export const KEY_BILLING_TRANSACTION_PRODUCT_TYPE = 'product_type' as keyof BillingTransaction;
|
|
639
|
+
/**
|
|
640
|
+
* status property
|
|
641
|
+
*
|
|
642
|
+
* The status of the transaction
|
|
643
|
+
*
|
|
644
|
+
*
|
|
645
|
+
*
|
|
646
|
+
* @remarks
|
|
647
|
+
* This key constant provides type-safe access to the `status` property of BillingTransaction objects.
|
|
648
|
+
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
649
|
+
*
|
|
650
|
+
* @example
|
|
651
|
+
* ```typescript
|
|
652
|
+
* // Direct property access
|
|
653
|
+
* const value = billingtransaction[KEY_BILLING_TRANSACTION_STATUS];
|
|
654
|
+
*
|
|
655
|
+
* // Dynamic property access
|
|
656
|
+
* const propertyName = KEY_BILLING_TRANSACTION_STATUS;
|
|
657
|
+
* const value = billingtransaction[propertyName];
|
|
658
|
+
* ```
|
|
659
|
+
*
|
|
660
|
+
* @see {@link BillingTransaction} - The TypeScript type definition
|
|
661
|
+
* @see {@link KEYS_BILLING_TRANSACTION} - Array of all keys for this type
|
|
662
|
+
*/
|
|
663
|
+
export const KEY_BILLING_TRANSACTION_STATUS = 'status' as keyof BillingTransaction;
|
|
664
|
+
/**
|
|
665
|
+
* Updated On
|
|
666
|
+
*
|
|
667
|
+
* The date/time the transaction was updated
|
|
668
|
+
*
|
|
669
|
+
* @type {string}
|
|
670
|
+
*
|
|
671
|
+
*
|
|
672
|
+
* @remarks
|
|
673
|
+
* This key constant provides type-safe access to the `updated_on` property of BillingTransaction objects.
|
|
674
|
+
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
675
|
+
*
|
|
676
|
+
* @example
|
|
677
|
+
* ```typescript
|
|
678
|
+
* // Direct property access
|
|
679
|
+
* const value = billingtransaction[KEY_BILLING_TRANSACTION_UPDATED_ON];
|
|
680
|
+
*
|
|
681
|
+
* // Dynamic property access
|
|
682
|
+
* const propertyName = KEY_BILLING_TRANSACTION_UPDATED_ON;
|
|
683
|
+
* const value = billingtransaction[propertyName];
|
|
684
|
+
* ```
|
|
685
|
+
*
|
|
686
|
+
* @see {@link BillingTransaction} - The TypeScript type definition
|
|
687
|
+
* @see {@link KEYS_BILLING_TRANSACTION} - Array of all keys for this type
|
|
688
|
+
*/
|
|
689
|
+
export const KEY_BILLING_TRANSACTION_UPDATED_ON = 'updated_on' as keyof BillingTransaction;
|
|
690
|
+
|
|
691
|
+
/**
|
|
692
|
+
* Array of all BillingTransaction property keys
|
|
693
|
+
*
|
|
694
|
+
* @remarks
|
|
695
|
+
* This constant provides a readonly array containing all valid property keys for BillingTransaction objects.
|
|
696
|
+
* Useful for iteration, validation, and generating dynamic UI components.
|
|
697
|
+
*
|
|
698
|
+
* @example
|
|
699
|
+
* ```typescript
|
|
700
|
+
* // Iterating through all keys
|
|
701
|
+
* for (const key of KEYS_BILLING_TRANSACTION) {
|
|
702
|
+
* console.log(`Property: ${key}, Value: ${billingtransaction[key]}`);
|
|
703
|
+
* }
|
|
704
|
+
*
|
|
705
|
+
* // Validation
|
|
706
|
+
* const isValidKey = KEYS_BILLING_TRANSACTION.includes(someKey);
|
|
707
|
+
* ```
|
|
708
|
+
*
|
|
709
|
+
* @see {@link BillingTransaction} - The TypeScript type definition
|
|
710
|
+
*/
|
|
711
|
+
export const KEYS_BILLING_TRANSACTION = [
|
|
712
|
+
KEY_BILLING_TRANSACTION_ACTION,
|
|
713
|
+
KEY_BILLING_TRANSACTION_BILLING_TRANSACTION_ID,
|
|
714
|
+
KEY_BILLING_TRANSACTION_COMPLETED_ON,
|
|
715
|
+
KEY_BILLING_TRANSACTION_CREATED_ON,
|
|
716
|
+
KEY_BILLING_TRANSACTION_PRODUCT_REFERENCE,
|
|
717
|
+
KEY_BILLING_TRANSACTION_PRODUCT_TYPE,
|
|
718
|
+
KEY_BILLING_TRANSACTION_STATUS,
|
|
719
|
+
KEY_BILLING_TRANSACTION_UPDATED_ON,
|
|
720
|
+
] as const satisfies (keyof BillingTransaction)[];
|
|
721
|
+
|
|
486
722
|
/**
|
|
487
723
|
* Client Id
|
|
488
724
|
*
|
|
@@ -14317,55 +14553,30 @@ export const KEYS_PREMIUM_DOMAINS_BASE = [
|
|
|
14317
14553
|
*/
|
|
14318
14554
|
export const KEY_PRICE_INFO_CURRENCY = 'currency' as keyof PriceInfo;
|
|
14319
14555
|
/**
|
|
14320
|
-
*
|
|
14321
|
-
*
|
|
14322
|
-
* Period unit: 'y' (year), 'm' (month), 'd' (day)
|
|
14323
|
-
*
|
|
14324
|
-
*
|
|
14325
|
-
*
|
|
14326
|
-
* @remarks
|
|
14327
|
-
* This key constant provides type-safe access to the `period_unit` property of PriceInfo objects.
|
|
14328
|
-
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
14329
|
-
*
|
|
14330
|
-
* @example
|
|
14331
|
-
* ```typescript
|
|
14332
|
-
* // Direct property access
|
|
14333
|
-
* const value = priceinfo[KEY_PRICE_INFO_PERIOD_UNIT];
|
|
14334
|
-
*
|
|
14335
|
-
* // Dynamic property access
|
|
14336
|
-
* const propertyName = KEY_PRICE_INFO_PERIOD_UNIT;
|
|
14337
|
-
* const value = priceinfo[propertyName];
|
|
14338
|
-
* ```
|
|
14339
|
-
*
|
|
14340
|
-
* @see {@link PriceInfo} - The TypeScript type definition
|
|
14341
|
-
* @see {@link KEYS_PRICE_INFO} - Array of all keys for this type
|
|
14342
|
-
*/
|
|
14343
|
-
export const KEY_PRICE_INFO_PERIOD_UNIT = 'period_unit' as keyof PriceInfo;
|
|
14344
|
-
/**
|
|
14345
|
-
* Period Value
|
|
14556
|
+
* period property
|
|
14346
14557
|
*
|
|
14347
|
-
*
|
|
14558
|
+
* Pricing period (e.g., 1 year, 2 months)
|
|
14348
14559
|
*
|
|
14349
14560
|
*
|
|
14350
14561
|
*
|
|
14351
14562
|
* @remarks
|
|
14352
|
-
* This key constant provides type-safe access to the `
|
|
14563
|
+
* This key constant provides type-safe access to the `period` property of PriceInfo objects.
|
|
14353
14564
|
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
14354
14565
|
*
|
|
14355
14566
|
* @example
|
|
14356
14567
|
* ```typescript
|
|
14357
14568
|
* // Direct property access
|
|
14358
|
-
* const value = priceinfo[
|
|
14569
|
+
* const value = priceinfo[KEY_PRICE_INFO_PERIOD];
|
|
14359
14570
|
*
|
|
14360
14571
|
* // Dynamic property access
|
|
14361
|
-
* const propertyName =
|
|
14572
|
+
* const propertyName = KEY_PRICE_INFO_PERIOD;
|
|
14362
14573
|
* const value = priceinfo[propertyName];
|
|
14363
14574
|
* ```
|
|
14364
14575
|
*
|
|
14365
14576
|
* @see {@link PriceInfo} - The TypeScript type definition
|
|
14366
14577
|
* @see {@link KEYS_PRICE_INFO} - Array of all keys for this type
|
|
14367
14578
|
*/
|
|
14368
|
-
export const
|
|
14579
|
+
export const KEY_PRICE_INFO_PERIOD = 'period' as keyof PriceInfo;
|
|
14369
14580
|
/**
|
|
14370
14581
|
* Price
|
|
14371
14582
|
*
|
|
@@ -14487,14 +14698,90 @@ export const KEY_PRICE_INFO_PRODUCT_TYPE = 'product_type' as keyof PriceInfo;
|
|
|
14487
14698
|
*/
|
|
14488
14699
|
export const KEYS_PRICE_INFO = [
|
|
14489
14700
|
KEY_PRICE_INFO_CURRENCY,
|
|
14490
|
-
|
|
14491
|
-
KEY_PRICE_INFO_PERIOD_VALUE,
|
|
14701
|
+
KEY_PRICE_INFO_PERIOD,
|
|
14492
14702
|
KEY_PRICE_INFO_PRICE,
|
|
14493
14703
|
KEY_PRICE_INFO_PRODUCT_ACTION,
|
|
14494
14704
|
KEY_PRICE_INFO_PRODUCT_CLASS,
|
|
14495
14705
|
KEY_PRICE_INFO_PRODUCT_TYPE,
|
|
14496
14706
|
] as const satisfies (keyof PriceInfo)[];
|
|
14497
14707
|
|
|
14708
|
+
/**
|
|
14709
|
+
* unit property
|
|
14710
|
+
*
|
|
14711
|
+
* The unit of the period
|
|
14712
|
+
*
|
|
14713
|
+
*
|
|
14714
|
+
*
|
|
14715
|
+
* @remarks
|
|
14716
|
+
* This key constant provides type-safe access to the `unit` property of PricingPeriod objects.
|
|
14717
|
+
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
14718
|
+
*
|
|
14719
|
+
* @example
|
|
14720
|
+
* ```typescript
|
|
14721
|
+
* // Direct property access
|
|
14722
|
+
* const value = pricingperiod[KEY_PRICING_PERIOD_UNIT];
|
|
14723
|
+
*
|
|
14724
|
+
* // Dynamic property access
|
|
14725
|
+
* const propertyName = KEY_PRICING_PERIOD_UNIT;
|
|
14726
|
+
* const value = pricingperiod[propertyName];
|
|
14727
|
+
* ```
|
|
14728
|
+
*
|
|
14729
|
+
* @see {@link PricingPeriod} - The TypeScript type definition
|
|
14730
|
+
* @see {@link KEYS_PRICING_PERIOD} - Array of all keys for this type
|
|
14731
|
+
*/
|
|
14732
|
+
export const KEY_PRICING_PERIOD_UNIT = 'unit' as keyof PricingPeriod;
|
|
14733
|
+
/**
|
|
14734
|
+
* Value
|
|
14735
|
+
*
|
|
14736
|
+
* Amount of time in the unit
|
|
14737
|
+
*
|
|
14738
|
+
* @type {integer}
|
|
14739
|
+
*
|
|
14740
|
+
*
|
|
14741
|
+
* @remarks
|
|
14742
|
+
* This key constant provides type-safe access to the `value` property of PricingPeriod objects.
|
|
14743
|
+
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
14744
|
+
*
|
|
14745
|
+
* @example
|
|
14746
|
+
* ```typescript
|
|
14747
|
+
* // Direct property access
|
|
14748
|
+
* const value = pricingperiod[KEY_PRICING_PERIOD_VALUE];
|
|
14749
|
+
*
|
|
14750
|
+
* // Dynamic property access
|
|
14751
|
+
* const propertyName = KEY_PRICING_PERIOD_VALUE;
|
|
14752
|
+
* const value = pricingperiod[propertyName];
|
|
14753
|
+
* ```
|
|
14754
|
+
*
|
|
14755
|
+
* @see {@link PricingPeriod} - The TypeScript type definition
|
|
14756
|
+
* @see {@link KEYS_PRICING_PERIOD} - Array of all keys for this type
|
|
14757
|
+
*/
|
|
14758
|
+
export const KEY_PRICING_PERIOD_VALUE = 'value' as keyof PricingPeriod;
|
|
14759
|
+
|
|
14760
|
+
/**
|
|
14761
|
+
* Array of all PricingPeriod property keys
|
|
14762
|
+
*
|
|
14763
|
+
* @remarks
|
|
14764
|
+
* This constant provides a readonly array containing all valid property keys for PricingPeriod objects.
|
|
14765
|
+
* Useful for iteration, validation, and generating dynamic UI components.
|
|
14766
|
+
*
|
|
14767
|
+
* @example
|
|
14768
|
+
* ```typescript
|
|
14769
|
+
* // Iterating through all keys
|
|
14770
|
+
* for (const key of KEYS_PRICING_PERIOD) {
|
|
14771
|
+
* console.log(`Property: ${key}, Value: ${pricingperiod[key]}`);
|
|
14772
|
+
* }
|
|
14773
|
+
*
|
|
14774
|
+
* // Validation
|
|
14775
|
+
* const isValidKey = KEYS_PRICING_PERIOD.includes(someKey);
|
|
14776
|
+
* ```
|
|
14777
|
+
*
|
|
14778
|
+
* @see {@link PricingPeriod} - The TypeScript type definition
|
|
14779
|
+
*/
|
|
14780
|
+
export const KEYS_PRICING_PERIOD = [
|
|
14781
|
+
KEY_PRICING_PERIOD_UNIT,
|
|
14782
|
+
KEY_PRICING_PERIOD_VALUE,
|
|
14783
|
+
] as const satisfies (keyof PricingPeriod)[];
|
|
14784
|
+
|
|
14498
14785
|
/**
|
|
14499
14786
|
* Problem detail
|
|
14500
14787
|
*
|
|
@@ -3133,6 +3133,96 @@ export type GET_OrganizationsOrganizationIdPricingProductTypeProductType_Request
|
|
|
3133
3133
|
*/
|
|
3134
3134
|
export type GET_OrganizationsOrganizationIdPricingProductTypeProductType_Request_Path = GET_OrganizationsOrganizationIdPricingProductTypeProductType_Request['parameters']['path'];
|
|
3135
3135
|
|
|
3136
|
+
/**
|
|
3137
|
+
* Request type for GET OrganizationsOrganizationIdTransactions endpoint
|
|
3138
|
+
*
|
|
3139
|
+
* Get transactions for an organization
|
|
3140
|
+
*
|
|
3141
|
+
* @remarks
|
|
3142
|
+
* This type defines the complete request structure for the GET OrganizationsOrganizationIdTransactions endpoint.
|
|
3143
|
+
* It includes all parameters (query, path) and request body types as defined in the OpenAPI specification.
|
|
3144
|
+
* Use this type to ensure type safety when making API requests to this endpoint.
|
|
3145
|
+
*
|
|
3146
|
+
* @example
|
|
3147
|
+
* Use this type to ensure type safety when making API requests to this endpoint.
|
|
3148
|
+
*
|
|
3149
|
+
* @path /v1/organizations/{organization_id}/transactions
|
|
3150
|
+
*
|
|
3151
|
+
* @see {@link GET_OrganizationsOrganizationIdTransactions_Request_Query} - Query parameters type
|
|
3152
|
+
* @see {@link GET_OrganizationsOrganizationIdTransactions_Request_Path} - Path parameters type
|
|
3153
|
+
* @see {@link GET_OrganizationsOrganizationIdTransactions_Request_Body} - Request body type
|
|
3154
|
+
*/
|
|
3155
|
+
export type GET_OrganizationsOrganizationIdTransactions_Request = {
|
|
3156
|
+
parameters: {
|
|
3157
|
+
query: operations['get_transactions_v1_organizations__organization_id__transactions_get']['parameters']['query'];
|
|
3158
|
+
path: operations['get_transactions_v1_organizations__organization_id__transactions_get']['parameters']['path'];
|
|
3159
|
+
};
|
|
3160
|
+
}
|
|
3161
|
+
/**
|
|
3162
|
+
* Query parameters for GET /v1/organizations/{organization_id}/transactions
|
|
3163
|
+
*
|
|
3164
|
+
* @remarks
|
|
3165
|
+
* This type defines the query parameters for the GET /v1/organizations/{organization_id}/transactions endpoint.
|
|
3166
|
+
* It provides type safety for all query parameters as defined in the OpenAPI specification.
|
|
3167
|
+
*
|
|
3168
|
+
* @example
|
|
3169
|
+
* Use this type to ensure type safety for query parameters.
|
|
3170
|
+
*
|
|
3171
|
+
* @path /v1/organizations/{organization_id}/transactions
|
|
3172
|
+
*/
|
|
3173
|
+
export type GET_OrganizationsOrganizationIdTransactions_Request_Query = GET_OrganizationsOrganizationIdTransactions_Request['parameters']['query'];
|
|
3174
|
+
/**
|
|
3175
|
+
* Path parameters for GET /v1/organizations/{organization_id}/transactions
|
|
3176
|
+
*
|
|
3177
|
+
* @remarks
|
|
3178
|
+
* This type defines the path parameters for the GET /v1/organizations/{organization_id}/transactions endpoint.
|
|
3179
|
+
* It provides type safety for all path parameters as defined in the OpenAPI specification.
|
|
3180
|
+
*
|
|
3181
|
+
* @example
|
|
3182
|
+
* Use this type to ensure type safety for path parameters.
|
|
3183
|
+
*
|
|
3184
|
+
* @path /v1/organizations/{organization_id}/transactions
|
|
3185
|
+
*/
|
|
3186
|
+
export type GET_OrganizationsOrganizationIdTransactions_Request_Path = GET_OrganizationsOrganizationIdTransactions_Request['parameters']['path'];
|
|
3187
|
+
|
|
3188
|
+
/**
|
|
3189
|
+
* Request type for GET OrganizationsOrganizationIdTransactionsTransactionId endpoint
|
|
3190
|
+
*
|
|
3191
|
+
* Get a specific transaction for an organization
|
|
3192
|
+
*
|
|
3193
|
+
* @remarks
|
|
3194
|
+
* This type defines the complete request structure for the GET OrganizationsOrganizationIdTransactionsTransactionId endpoint.
|
|
3195
|
+
* It includes all parameters (query, path) and request body types as defined in the OpenAPI specification.
|
|
3196
|
+
* Use this type to ensure type safety when making API requests to this endpoint.
|
|
3197
|
+
*
|
|
3198
|
+
* @example
|
|
3199
|
+
* Use this type to ensure type safety when making API requests to this endpoint.
|
|
3200
|
+
*
|
|
3201
|
+
* @path /v1/organizations/{organization_id}/transactions/{transaction_id}
|
|
3202
|
+
*
|
|
3203
|
+
* @see {@link GET_OrganizationsOrganizationIdTransactionsTransactionId_Request_Query} - Query parameters type
|
|
3204
|
+
* @see {@link GET_OrganizationsOrganizationIdTransactionsTransactionId_Request_Path} - Path parameters type
|
|
3205
|
+
* @see {@link GET_OrganizationsOrganizationIdTransactionsTransactionId_Request_Body} - Request body type
|
|
3206
|
+
*/
|
|
3207
|
+
export type GET_OrganizationsOrganizationIdTransactionsTransactionId_Request = {
|
|
3208
|
+
parameters: {
|
|
3209
|
+
path: operations['get_transaction_v1_organizations__organization_id__transactions__transaction_id__get']['parameters']['path'];
|
|
3210
|
+
};
|
|
3211
|
+
}
|
|
3212
|
+
/**
|
|
3213
|
+
* Path parameters for GET /v1/organizations/{organization_id}/transactions/{transaction_id}
|
|
3214
|
+
*
|
|
3215
|
+
* @remarks
|
|
3216
|
+
* This type defines the path parameters for the GET /v1/organizations/{organization_id}/transactions/{transaction_id} endpoint.
|
|
3217
|
+
* It provides type safety for all path parameters as defined in the OpenAPI specification.
|
|
3218
|
+
*
|
|
3219
|
+
* @example
|
|
3220
|
+
* Use this type to ensure type safety for path parameters.
|
|
3221
|
+
*
|
|
3222
|
+
* @path /v1/organizations/{organization_id}/transactions/{transaction_id}
|
|
3223
|
+
*/
|
|
3224
|
+
export type GET_OrganizationsOrganizationIdTransactionsTransactionId_Request_Path = GET_OrganizationsOrganizationIdTransactionsTransactionId_Request['parameters']['path'];
|
|
3225
|
+
|
|
3136
3226
|
/**
|
|
3137
3227
|
* Request type for GET OrganizationsRoles endpoint
|
|
3138
3228
|
*
|