@opusdns/api 0.88.0 → 0.89.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 +167 -1
- package/src/helpers/keys.ts +372 -0
- package/src/helpers/requests.d.ts +53 -0
- package/src/helpers/responses.d.ts +57 -1
- package/src/helpers/schemas-arrays.d.ts +15 -1
- package/src/helpers/schemas.d.ts +80 -0
- package/src/openapi.yaml +160 -1
- package/src/schema.d.ts +133 -0
package/package.json
CHANGED
package/src/helpers/constants.ts
CHANGED
|
@@ -21,7 +21,7 @@
|
|
|
21
21
|
* ```
|
|
22
22
|
*/
|
|
23
23
|
|
|
24
|
-
import { AllocationMethodType, AttributeType, BillingTransactionAction, BillingTransactionProductType, BillingTransactionSortField, BillingTransactionStatus, ContactRoleType, ContactSortField, Currency, DeletePolicyType, DnsChangeAction, DnsRrsetType, DnssecAlgorithm, DnssecDigestType, DnssecModeType, DnssecRecordType, DnssecStatus, DomainAttributeKey, DomainAvailabilityStatus, DomainClientStatus, DomainContactType, DomainSortField, DomainStatus, EmailVerificationStatus, EventObjectType, EventSortField, EventSubtype, EventType, GrantType, HttpProtocol, LaunchPhaseType, LocalPresenceRequirementType, OrganizationStatus, PatchOp, PeriodUnit, Permission, PostTransferRequirements, PostalAddressType, PremiumAffectsType, PremiumSourceType, RedirectCode, RegistrantChangeType, RegistryHandleAttributeType, Relation, RenewalMode, ReservedSourceType, SortOrder, SyncOperationType, TLDType, TransferAckType, UserStatus, VerificationType, ZoneSortField } from './schemas';
|
|
24
|
+
import { AllocationMethodType, AttributeType, BillingTransactionAction, BillingTransactionProductType, BillingTransactionSortField, BillingTransactionStatus, ContactRoleType, ContactSortField, Currency, DeletePolicyType, DnsChangeAction, DnsRrsetType, DnssecAlgorithm, DnssecDigestType, DnssecModeType, DnssecRecordType, DnssecStatus, DomainAttributeKey, DomainAvailabilityStatus, DomainClientStatus, DomainContactType, DomainSortField, DomainStatus, EmailVerificationStatus, EventObjectType, EventSortField, EventSubtype, EventType, GrantType, HttpProtocol, InvoiceResponsePaymentStatus, InvoiceResponseStatus, InvoiceResponseType, LaunchPhaseType, LocalPresenceRequirementType, OrganizationStatus, PatchOp, PeriodUnit, Permission, PostTransferRequirements, PostalAddressType, PremiumAffectsType, PremiumSourceType, RedirectCode, RegistrantChangeType, RegistryHandleAttributeType, Relation, RenewalMode, ReservedSourceType, SortOrder, SyncOperationType, TLDType, TransferAckType, UserStatus, VerificationType, ZoneSortField } from './schemas';
|
|
25
25
|
|
|
26
26
|
/**
|
|
27
27
|
* AllocationMethodType. Auto-generated enum for AllocationMethodType
|
|
@@ -1651,6 +1651,172 @@ export const HTTP_PROTOCOL_VALUES = [
|
|
|
1651
1651
|
'https'
|
|
1652
1652
|
] as const satisfies [string, ...string[]] | HttpProtocol[];
|
|
1653
1653
|
|
|
1654
|
+
/**
|
|
1655
|
+
* InvoiceResponsePaymentStatus. Auto-generated enum for InvoiceResponsePaymentStatus
|
|
1656
|
+
*
|
|
1657
|
+
* @remarks
|
|
1658
|
+
* This constant provides both object and array forms for the InvoiceResponsePaymentStatus enum.
|
|
1659
|
+
* The object form allows key-value access, while the array form enables iteration and validation.
|
|
1660
|
+
*
|
|
1661
|
+
* @example
|
|
1662
|
+
* ```typescript
|
|
1663
|
+
* // Using the object form for key-value access
|
|
1664
|
+
* const status = INVOICE_RESPONSE_PAYMENT_STATUS.SUCCESS;
|
|
1665
|
+
*
|
|
1666
|
+
* // Using the array form for iteration
|
|
1667
|
+
* const allStatuses = INVOICE_RESPONSE_PAYMENT_STATUS_VALUES;
|
|
1668
|
+
* console.log(`Available statuses: ${allStatuses.join(', ')}`);
|
|
1669
|
+
* ```
|
|
1670
|
+
*
|
|
1671
|
+
* @see {@link InvoiceResponsePaymentStatus} - The TypeScript type definition
|
|
1672
|
+
*/
|
|
1673
|
+
export const INVOICE_RESPONSE_PAYMENT_STATUS = {
|
|
1674
|
+
PENDING: "pending",
|
|
1675
|
+
FAILED: "failed",
|
|
1676
|
+
SUCCEEDED: "succeeded",
|
|
1677
|
+
} as const satisfies Record<string, InvoiceResponsePaymentStatus>;
|
|
1678
|
+
|
|
1679
|
+
/**
|
|
1680
|
+
* Array of all InvoiceResponsePaymentStatus enum values
|
|
1681
|
+
*
|
|
1682
|
+
* @remarks
|
|
1683
|
+
* This constant provides a array containing all valid InvoiceResponsePaymentStatus enum values.
|
|
1684
|
+
* Useful for iteration, validation, and generating dynamic UI components.
|
|
1685
|
+
*
|
|
1686
|
+
* @example
|
|
1687
|
+
* ```typescript
|
|
1688
|
+
* // Iterating through all values
|
|
1689
|
+
* for (const value of INVOICE_RESPONSE_PAYMENT_STATUS_VALUES) {
|
|
1690
|
+
* console.log(`Processing: ${value}`);
|
|
1691
|
+
* }
|
|
1692
|
+
*
|
|
1693
|
+
* // Validation
|
|
1694
|
+
* const isValid = INVOICE_RESPONSE_PAYMENT_STATUS_VALUES.includes(someValue);
|
|
1695
|
+
* ```
|
|
1696
|
+
*
|
|
1697
|
+
* @see {@link InvoiceResponsePaymentStatus} - The TypeScript type definition
|
|
1698
|
+
* @see {@link INVOICE_RESPONSE_PAYMENT_STATUS} - The object form of this enum
|
|
1699
|
+
*/
|
|
1700
|
+
export const INVOICE_RESPONSE_PAYMENT_STATUS_VALUES = [
|
|
1701
|
+
'pending',
|
|
1702
|
+
'failed',
|
|
1703
|
+
'succeeded'
|
|
1704
|
+
] as const satisfies [string, ...string[]] | InvoiceResponsePaymentStatus[];
|
|
1705
|
+
|
|
1706
|
+
/**
|
|
1707
|
+
* InvoiceResponseStatus. Auto-generated enum for InvoiceResponseStatus
|
|
1708
|
+
*
|
|
1709
|
+
* @remarks
|
|
1710
|
+
* This constant provides both object and array forms for the InvoiceResponseStatus enum.
|
|
1711
|
+
* The object form allows key-value access, while the array form enables iteration and validation.
|
|
1712
|
+
*
|
|
1713
|
+
* @example
|
|
1714
|
+
* ```typescript
|
|
1715
|
+
* // Using the object form for key-value access
|
|
1716
|
+
* const status = INVOICE_RESPONSE_STATUS.SUCCESS;
|
|
1717
|
+
*
|
|
1718
|
+
* // Using the array form for iteration
|
|
1719
|
+
* const allStatuses = INVOICE_RESPONSE_STATUS_VALUES;
|
|
1720
|
+
* console.log(`Available statuses: ${allStatuses.join(', ')}`);
|
|
1721
|
+
* ```
|
|
1722
|
+
*
|
|
1723
|
+
* @see {@link InvoiceResponseStatus} - The TypeScript type definition
|
|
1724
|
+
*/
|
|
1725
|
+
export const INVOICE_RESPONSE_STATUS = {
|
|
1726
|
+
DRAFT: "draft",
|
|
1727
|
+
FINALIZED: "finalized",
|
|
1728
|
+
FAILED: "failed",
|
|
1729
|
+
PENDING: "pending",
|
|
1730
|
+
VOIDED: "voided",
|
|
1731
|
+
} as const satisfies Record<string, InvoiceResponseStatus>;
|
|
1732
|
+
|
|
1733
|
+
/**
|
|
1734
|
+
* Array of all InvoiceResponseStatus enum values
|
|
1735
|
+
*
|
|
1736
|
+
* @remarks
|
|
1737
|
+
* This constant provides a array containing all valid InvoiceResponseStatus enum values.
|
|
1738
|
+
* Useful for iteration, validation, and generating dynamic UI components.
|
|
1739
|
+
*
|
|
1740
|
+
* @example
|
|
1741
|
+
* ```typescript
|
|
1742
|
+
* // Iterating through all values
|
|
1743
|
+
* for (const value of INVOICE_RESPONSE_STATUS_VALUES) {
|
|
1744
|
+
* console.log(`Processing: ${value}`);
|
|
1745
|
+
* }
|
|
1746
|
+
*
|
|
1747
|
+
* // Validation
|
|
1748
|
+
* const isValid = INVOICE_RESPONSE_STATUS_VALUES.includes(someValue);
|
|
1749
|
+
* ```
|
|
1750
|
+
*
|
|
1751
|
+
* @see {@link InvoiceResponseStatus} - The TypeScript type definition
|
|
1752
|
+
* @see {@link INVOICE_RESPONSE_STATUS} - The object form of this enum
|
|
1753
|
+
*/
|
|
1754
|
+
export const INVOICE_RESPONSE_STATUS_VALUES = [
|
|
1755
|
+
'draft',
|
|
1756
|
+
'finalized',
|
|
1757
|
+
'failed',
|
|
1758
|
+
'pending',
|
|
1759
|
+
'voided'
|
|
1760
|
+
] as const satisfies [string, ...string[]] | InvoiceResponseStatus[];
|
|
1761
|
+
|
|
1762
|
+
/**
|
|
1763
|
+
* InvoiceResponseType. Auto-generated enum for InvoiceResponseType
|
|
1764
|
+
*
|
|
1765
|
+
* @remarks
|
|
1766
|
+
* This constant provides both object and array forms for the InvoiceResponseType enum.
|
|
1767
|
+
* The object form allows key-value access, while the array form enables iteration and validation.
|
|
1768
|
+
*
|
|
1769
|
+
* @example
|
|
1770
|
+
* ```typescript
|
|
1771
|
+
* // Using the object form for key-value access
|
|
1772
|
+
* const status = INVOICE_RESPONSE_TYPE.SUCCESS;
|
|
1773
|
+
*
|
|
1774
|
+
* // Using the array form for iteration
|
|
1775
|
+
* const allStatuses = INVOICE_RESPONSE_TYPE_VALUES;
|
|
1776
|
+
* console.log(`Available statuses: ${allStatuses.join(', ')}`);
|
|
1777
|
+
* ```
|
|
1778
|
+
*
|
|
1779
|
+
* @see {@link InvoiceResponseType} - The TypeScript type definition
|
|
1780
|
+
*/
|
|
1781
|
+
export const INVOICE_RESPONSE_TYPE = {
|
|
1782
|
+
SUBSCRIPTION: "subscription",
|
|
1783
|
+
ADD_ON: "add_on",
|
|
1784
|
+
CREDIT: "credit",
|
|
1785
|
+
ONE_OFF: "one_off",
|
|
1786
|
+
ADVANCE_CHARGES: "advance_charges",
|
|
1787
|
+
PROGRESSIVE_BILLING: "progressive_billing",
|
|
1788
|
+
} as const satisfies Record<string, InvoiceResponseType>;
|
|
1789
|
+
|
|
1790
|
+
/**
|
|
1791
|
+
* Array of all InvoiceResponseType enum values
|
|
1792
|
+
*
|
|
1793
|
+
* @remarks
|
|
1794
|
+
* This constant provides a array containing all valid InvoiceResponseType enum values.
|
|
1795
|
+
* Useful for iteration, validation, and generating dynamic UI components.
|
|
1796
|
+
*
|
|
1797
|
+
* @example
|
|
1798
|
+
* ```typescript
|
|
1799
|
+
* // Iterating through all values
|
|
1800
|
+
* for (const value of INVOICE_RESPONSE_TYPE_VALUES) {
|
|
1801
|
+
* console.log(`Processing: ${value}`);
|
|
1802
|
+
* }
|
|
1803
|
+
*
|
|
1804
|
+
* // Validation
|
|
1805
|
+
* const isValid = INVOICE_RESPONSE_TYPE_VALUES.includes(someValue);
|
|
1806
|
+
* ```
|
|
1807
|
+
*
|
|
1808
|
+
* @see {@link InvoiceResponseType} - The TypeScript type definition
|
|
1809
|
+
* @see {@link INVOICE_RESPONSE_TYPE} - The object form of this enum
|
|
1810
|
+
*/
|
|
1811
|
+
export const INVOICE_RESPONSE_TYPE_VALUES = [
|
|
1812
|
+
'subscription',
|
|
1813
|
+
'add_on',
|
|
1814
|
+
'credit',
|
|
1815
|
+
'one_off',
|
|
1816
|
+
'advance_charges',
|
|
1817
|
+
'progressive_billing'
|
|
1818
|
+
] as const satisfies [string, ...string[]] | InvoiceResponseType[];
|
|
1819
|
+
|
|
1654
1820
|
/**
|
|
1655
1821
|
* LaunchPhaseType. Auto-generated enum for LaunchPhaseType
|
|
1656
1822
|
*
|
package/src/helpers/keys.ts
CHANGED
|
@@ -97,6 +97,7 @@ import { GetPrices } from './schemas';
|
|
|
97
97
|
import { HTTPValidationError } from './schemas';
|
|
98
98
|
import { HttpRedirect } from './schemas';
|
|
99
99
|
import { IdnBase } from './schemas';
|
|
100
|
+
import { Invoice } from './schemas';
|
|
100
101
|
import { IpRestrictionCreate } from './schemas';
|
|
101
102
|
import { IpRestriction } from './schemas';
|
|
102
103
|
import { IpRestrictionUpdate } from './schemas';
|
|
@@ -10407,6 +10408,377 @@ export const KEYS_IDN_BASE = [
|
|
|
10407
10408
|
KEY_IDN_BASE_IDN_TABLES,
|
|
10408
10409
|
] as const satisfies (keyof IdnBase)[];
|
|
10409
10410
|
|
|
10411
|
+
/**
|
|
10412
|
+
* Amount
|
|
10413
|
+
*
|
|
10414
|
+
* Total invoice amount
|
|
10415
|
+
*
|
|
10416
|
+
* @type {string}
|
|
10417
|
+
*
|
|
10418
|
+
*
|
|
10419
|
+
* @remarks
|
|
10420
|
+
* This key constant provides type-safe access to the `amount` property of Invoice objects.
|
|
10421
|
+
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
10422
|
+
*
|
|
10423
|
+
* @example
|
|
10424
|
+
* ```typescript
|
|
10425
|
+
* // Direct property access
|
|
10426
|
+
* const value = invoice[KEY_INVOICE_AMOUNT];
|
|
10427
|
+
*
|
|
10428
|
+
* // Dynamic property access
|
|
10429
|
+
* const propertyName = KEY_INVOICE_AMOUNT;
|
|
10430
|
+
* const value = invoice[propertyName];
|
|
10431
|
+
* ```
|
|
10432
|
+
*
|
|
10433
|
+
* @see {@link Invoice} - The TypeScript type definition
|
|
10434
|
+
* @see {@link KEYS_INVOICE} - Array of all keys for this type
|
|
10435
|
+
*/
|
|
10436
|
+
export const KEY_INVOICE_AMOUNT = 'amount' as keyof Invoice;
|
|
10437
|
+
/**
|
|
10438
|
+
* currency property
|
|
10439
|
+
*
|
|
10440
|
+
* Invoice currency
|
|
10441
|
+
*
|
|
10442
|
+
*
|
|
10443
|
+
*
|
|
10444
|
+
* @remarks
|
|
10445
|
+
* This key constant provides type-safe access to the `currency` property of Invoice objects.
|
|
10446
|
+
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
10447
|
+
*
|
|
10448
|
+
* @example
|
|
10449
|
+
* ```typescript
|
|
10450
|
+
* // Direct property access
|
|
10451
|
+
* const value = invoice[KEY_INVOICE_CURRENCY];
|
|
10452
|
+
*
|
|
10453
|
+
* // Dynamic property access
|
|
10454
|
+
* const propertyName = KEY_INVOICE_CURRENCY;
|
|
10455
|
+
* const value = invoice[propertyName];
|
|
10456
|
+
* ```
|
|
10457
|
+
*
|
|
10458
|
+
* @see {@link Invoice} - The TypeScript type definition
|
|
10459
|
+
* @see {@link KEYS_INVOICE} - Array of all keys for this type
|
|
10460
|
+
*/
|
|
10461
|
+
export const KEY_INVOICE_CURRENCY = 'currency' as keyof Invoice;
|
|
10462
|
+
/**
|
|
10463
|
+
* External Id
|
|
10464
|
+
*
|
|
10465
|
+
* Lago ID (external) for this invoice
|
|
10466
|
+
*
|
|
10467
|
+
* @type {string}
|
|
10468
|
+
*
|
|
10469
|
+
*
|
|
10470
|
+
* @remarks
|
|
10471
|
+
* This key constant provides type-safe access to the `external_id` property of Invoice objects.
|
|
10472
|
+
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
10473
|
+
*
|
|
10474
|
+
* @example
|
|
10475
|
+
* ```typescript
|
|
10476
|
+
* // Direct property access
|
|
10477
|
+
* const value = invoice[KEY_INVOICE_EXTERNAL_ID];
|
|
10478
|
+
*
|
|
10479
|
+
* // Dynamic property access
|
|
10480
|
+
* const propertyName = KEY_INVOICE_EXTERNAL_ID;
|
|
10481
|
+
* const value = invoice[propertyName];
|
|
10482
|
+
* ```
|
|
10483
|
+
*
|
|
10484
|
+
* @see {@link Invoice} - The TypeScript type definition
|
|
10485
|
+
* @see {@link KEYS_INVOICE} - Array of all keys for this type
|
|
10486
|
+
*/
|
|
10487
|
+
export const KEY_INVOICE_EXTERNAL_ID = 'external_id' as keyof Invoice;
|
|
10488
|
+
/**
|
|
10489
|
+
* Fees Amount
|
|
10490
|
+
*
|
|
10491
|
+
* Fees amount
|
|
10492
|
+
*
|
|
10493
|
+
* @type {string}
|
|
10494
|
+
*
|
|
10495
|
+
*
|
|
10496
|
+
* @remarks
|
|
10497
|
+
* This key constant provides type-safe access to the `fees_amount` property of Invoice objects.
|
|
10498
|
+
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
10499
|
+
*
|
|
10500
|
+
* @example
|
|
10501
|
+
* ```typescript
|
|
10502
|
+
* // Direct property access
|
|
10503
|
+
* const value = invoice[KEY_INVOICE_FEES_AMOUNT];
|
|
10504
|
+
*
|
|
10505
|
+
* // Dynamic property access
|
|
10506
|
+
* const propertyName = KEY_INVOICE_FEES_AMOUNT;
|
|
10507
|
+
* const value = invoice[propertyName];
|
|
10508
|
+
* ```
|
|
10509
|
+
*
|
|
10510
|
+
* @see {@link Invoice} - The TypeScript type definition
|
|
10511
|
+
* @see {@link KEYS_INVOICE} - Array of all keys for this type
|
|
10512
|
+
*/
|
|
10513
|
+
export const KEY_INVOICE_FEES_AMOUNT = 'fees_amount' as keyof Invoice;
|
|
10514
|
+
/**
|
|
10515
|
+
* File Url
|
|
10516
|
+
*
|
|
10517
|
+
* URL to invoice PDF file
|
|
10518
|
+
*
|
|
10519
|
+
* @type {string}
|
|
10520
|
+
*
|
|
10521
|
+
*
|
|
10522
|
+
* @remarks
|
|
10523
|
+
* This key constant provides type-safe access to the `file_url` property of Invoice objects.
|
|
10524
|
+
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
10525
|
+
*
|
|
10526
|
+
* @example
|
|
10527
|
+
* ```typescript
|
|
10528
|
+
* // Direct property access
|
|
10529
|
+
* const value = invoice[KEY_INVOICE_FILE_URL];
|
|
10530
|
+
*
|
|
10531
|
+
* // Dynamic property access
|
|
10532
|
+
* const propertyName = KEY_INVOICE_FILE_URL;
|
|
10533
|
+
* const value = invoice[propertyName];
|
|
10534
|
+
* ```
|
|
10535
|
+
*
|
|
10536
|
+
* @see {@link Invoice} - The TypeScript type definition
|
|
10537
|
+
* @see {@link KEYS_INVOICE} - Array of all keys for this type
|
|
10538
|
+
*/
|
|
10539
|
+
export const KEY_INVOICE_FILE_URL = 'file_url' as keyof Invoice;
|
|
10540
|
+
/**
|
|
10541
|
+
* invoice_type property
|
|
10542
|
+
*
|
|
10543
|
+
* Invoice type
|
|
10544
|
+
*
|
|
10545
|
+
*
|
|
10546
|
+
*
|
|
10547
|
+
* @remarks
|
|
10548
|
+
* This key constant provides type-safe access to the `invoice_type` property of Invoice objects.
|
|
10549
|
+
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
10550
|
+
*
|
|
10551
|
+
* @example
|
|
10552
|
+
* ```typescript
|
|
10553
|
+
* // Direct property access
|
|
10554
|
+
* const value = invoice[KEY_INVOICE_INVOICE_TYPE];
|
|
10555
|
+
*
|
|
10556
|
+
* // Dynamic property access
|
|
10557
|
+
* const propertyName = KEY_INVOICE_INVOICE_TYPE;
|
|
10558
|
+
* const value = invoice[propertyName];
|
|
10559
|
+
* ```
|
|
10560
|
+
*
|
|
10561
|
+
* @see {@link Invoice} - The TypeScript type definition
|
|
10562
|
+
* @see {@link KEYS_INVOICE} - Array of all keys for this type
|
|
10563
|
+
*/
|
|
10564
|
+
export const KEY_INVOICE_INVOICE_TYPE = 'invoice_type' as keyof Invoice;
|
|
10565
|
+
/**
|
|
10566
|
+
* Issuing Date
|
|
10567
|
+
*
|
|
10568
|
+
* Invoice issuing date
|
|
10569
|
+
*
|
|
10570
|
+
* @type {string}
|
|
10571
|
+
*
|
|
10572
|
+
*
|
|
10573
|
+
* @remarks
|
|
10574
|
+
* This key constant provides type-safe access to the `issuing_date` property of Invoice objects.
|
|
10575
|
+
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
10576
|
+
*
|
|
10577
|
+
* @example
|
|
10578
|
+
* ```typescript
|
|
10579
|
+
* // Direct property access
|
|
10580
|
+
* const value = invoice[KEY_INVOICE_ISSUING_DATE];
|
|
10581
|
+
*
|
|
10582
|
+
* // Dynamic property access
|
|
10583
|
+
* const propertyName = KEY_INVOICE_ISSUING_DATE;
|
|
10584
|
+
* const value = invoice[propertyName];
|
|
10585
|
+
* ```
|
|
10586
|
+
*
|
|
10587
|
+
* @see {@link Invoice} - The TypeScript type definition
|
|
10588
|
+
* @see {@link KEYS_INVOICE} - Array of all keys for this type
|
|
10589
|
+
*/
|
|
10590
|
+
export const KEY_INVOICE_ISSUING_DATE = 'issuing_date' as keyof Invoice;
|
|
10591
|
+
/**
|
|
10592
|
+
* Number
|
|
10593
|
+
*
|
|
10594
|
+
* Invoice number
|
|
10595
|
+
*
|
|
10596
|
+
* @type {string}
|
|
10597
|
+
*
|
|
10598
|
+
*
|
|
10599
|
+
* @remarks
|
|
10600
|
+
* This key constant provides type-safe access to the `number` property of Invoice objects.
|
|
10601
|
+
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
10602
|
+
*
|
|
10603
|
+
* @example
|
|
10604
|
+
* ```typescript
|
|
10605
|
+
* // Direct property access
|
|
10606
|
+
* const value = invoice[KEY_INVOICE_NUMBER];
|
|
10607
|
+
*
|
|
10608
|
+
* // Dynamic property access
|
|
10609
|
+
* const propertyName = KEY_INVOICE_NUMBER;
|
|
10610
|
+
* const value = invoice[propertyName];
|
|
10611
|
+
* ```
|
|
10612
|
+
*
|
|
10613
|
+
* @see {@link Invoice} - The TypeScript type definition
|
|
10614
|
+
* @see {@link KEYS_INVOICE} - Array of all keys for this type
|
|
10615
|
+
*/
|
|
10616
|
+
export const KEY_INVOICE_NUMBER = 'number' as keyof Invoice;
|
|
10617
|
+
/**
|
|
10618
|
+
* Payment Due Date
|
|
10619
|
+
*
|
|
10620
|
+
* Payment due date
|
|
10621
|
+
*
|
|
10622
|
+
* @type {string}
|
|
10623
|
+
*
|
|
10624
|
+
*
|
|
10625
|
+
* @remarks
|
|
10626
|
+
* This key constant provides type-safe access to the `payment_due_date` property of Invoice objects.
|
|
10627
|
+
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
10628
|
+
*
|
|
10629
|
+
* @example
|
|
10630
|
+
* ```typescript
|
|
10631
|
+
* // Direct property access
|
|
10632
|
+
* const value = invoice[KEY_INVOICE_PAYMENT_DUE_DATE];
|
|
10633
|
+
*
|
|
10634
|
+
* // Dynamic property access
|
|
10635
|
+
* const propertyName = KEY_INVOICE_PAYMENT_DUE_DATE;
|
|
10636
|
+
* const value = invoice[propertyName];
|
|
10637
|
+
* ```
|
|
10638
|
+
*
|
|
10639
|
+
* @see {@link Invoice} - The TypeScript type definition
|
|
10640
|
+
* @see {@link KEYS_INVOICE} - Array of all keys for this type
|
|
10641
|
+
*/
|
|
10642
|
+
export const KEY_INVOICE_PAYMENT_DUE_DATE = 'payment_due_date' as keyof Invoice;
|
|
10643
|
+
/**
|
|
10644
|
+
* Payment Overdue
|
|
10645
|
+
*
|
|
10646
|
+
* Whether payment is overdue
|
|
10647
|
+
*
|
|
10648
|
+
* @type {boolean}
|
|
10649
|
+
*
|
|
10650
|
+
*
|
|
10651
|
+
* @remarks
|
|
10652
|
+
* This key constant provides type-safe access to the `payment_overdue` property of Invoice objects.
|
|
10653
|
+
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
10654
|
+
*
|
|
10655
|
+
* @example
|
|
10656
|
+
* ```typescript
|
|
10657
|
+
* // Direct property access
|
|
10658
|
+
* const value = invoice[KEY_INVOICE_PAYMENT_OVERDUE];
|
|
10659
|
+
*
|
|
10660
|
+
* // Dynamic property access
|
|
10661
|
+
* const propertyName = KEY_INVOICE_PAYMENT_OVERDUE;
|
|
10662
|
+
* const value = invoice[propertyName];
|
|
10663
|
+
* ```
|
|
10664
|
+
*
|
|
10665
|
+
* @see {@link Invoice} - The TypeScript type definition
|
|
10666
|
+
* @see {@link KEYS_INVOICE} - Array of all keys for this type
|
|
10667
|
+
*/
|
|
10668
|
+
export const KEY_INVOICE_PAYMENT_OVERDUE = 'payment_overdue' as keyof Invoice;
|
|
10669
|
+
/**
|
|
10670
|
+
* payment_status property
|
|
10671
|
+
*
|
|
10672
|
+
* Payment status
|
|
10673
|
+
*
|
|
10674
|
+
*
|
|
10675
|
+
*
|
|
10676
|
+
* @remarks
|
|
10677
|
+
* This key constant provides type-safe access to the `payment_status` property of Invoice objects.
|
|
10678
|
+
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
10679
|
+
*
|
|
10680
|
+
* @example
|
|
10681
|
+
* ```typescript
|
|
10682
|
+
* // Direct property access
|
|
10683
|
+
* const value = invoice[KEY_INVOICE_PAYMENT_STATUS];
|
|
10684
|
+
*
|
|
10685
|
+
* // Dynamic property access
|
|
10686
|
+
* const propertyName = KEY_INVOICE_PAYMENT_STATUS;
|
|
10687
|
+
* const value = invoice[propertyName];
|
|
10688
|
+
* ```
|
|
10689
|
+
*
|
|
10690
|
+
* @see {@link Invoice} - The TypeScript type definition
|
|
10691
|
+
* @see {@link KEYS_INVOICE} - Array of all keys for this type
|
|
10692
|
+
*/
|
|
10693
|
+
export const KEY_INVOICE_PAYMENT_STATUS = 'payment_status' as keyof Invoice;
|
|
10694
|
+
/**
|
|
10695
|
+
* status property
|
|
10696
|
+
*
|
|
10697
|
+
* Invoice status
|
|
10698
|
+
*
|
|
10699
|
+
*
|
|
10700
|
+
*
|
|
10701
|
+
* @remarks
|
|
10702
|
+
* This key constant provides type-safe access to the `status` property of Invoice objects.
|
|
10703
|
+
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
10704
|
+
*
|
|
10705
|
+
* @example
|
|
10706
|
+
* ```typescript
|
|
10707
|
+
* // Direct property access
|
|
10708
|
+
* const value = invoice[KEY_INVOICE_STATUS];
|
|
10709
|
+
*
|
|
10710
|
+
* // Dynamic property access
|
|
10711
|
+
* const propertyName = KEY_INVOICE_STATUS;
|
|
10712
|
+
* const value = invoice[propertyName];
|
|
10713
|
+
* ```
|
|
10714
|
+
*
|
|
10715
|
+
* @see {@link Invoice} - The TypeScript type definition
|
|
10716
|
+
* @see {@link KEYS_INVOICE} - Array of all keys for this type
|
|
10717
|
+
*/
|
|
10718
|
+
export const KEY_INVOICE_STATUS = 'status' as keyof Invoice;
|
|
10719
|
+
/**
|
|
10720
|
+
* Taxes Amount
|
|
10721
|
+
*
|
|
10722
|
+
* Taxes amount
|
|
10723
|
+
*
|
|
10724
|
+
* @type {string}
|
|
10725
|
+
*
|
|
10726
|
+
*
|
|
10727
|
+
* @remarks
|
|
10728
|
+
* This key constant provides type-safe access to the `taxes_amount` property of Invoice objects.
|
|
10729
|
+
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
10730
|
+
*
|
|
10731
|
+
* @example
|
|
10732
|
+
* ```typescript
|
|
10733
|
+
* // Direct property access
|
|
10734
|
+
* const value = invoice[KEY_INVOICE_TAXES_AMOUNT];
|
|
10735
|
+
*
|
|
10736
|
+
* // Dynamic property access
|
|
10737
|
+
* const propertyName = KEY_INVOICE_TAXES_AMOUNT;
|
|
10738
|
+
* const value = invoice[propertyName];
|
|
10739
|
+
* ```
|
|
10740
|
+
*
|
|
10741
|
+
* @see {@link Invoice} - The TypeScript type definition
|
|
10742
|
+
* @see {@link KEYS_INVOICE} - Array of all keys for this type
|
|
10743
|
+
*/
|
|
10744
|
+
export const KEY_INVOICE_TAXES_AMOUNT = 'taxes_amount' as keyof Invoice;
|
|
10745
|
+
|
|
10746
|
+
/**
|
|
10747
|
+
* Array of all Invoice property keys
|
|
10748
|
+
*
|
|
10749
|
+
* @remarks
|
|
10750
|
+
* This constant provides a readonly array containing all valid property keys for Invoice objects.
|
|
10751
|
+
* Useful for iteration, validation, and generating dynamic UI components.
|
|
10752
|
+
*
|
|
10753
|
+
* @example
|
|
10754
|
+
* ```typescript
|
|
10755
|
+
* // Iterating through all keys
|
|
10756
|
+
* for (const key of KEYS_INVOICE) {
|
|
10757
|
+
* console.log(`Property: ${key}, Value: ${invoice[key]}`);
|
|
10758
|
+
* }
|
|
10759
|
+
*
|
|
10760
|
+
* // Validation
|
|
10761
|
+
* const isValidKey = KEYS_INVOICE.includes(someKey);
|
|
10762
|
+
* ```
|
|
10763
|
+
*
|
|
10764
|
+
* @see {@link Invoice} - The TypeScript type definition
|
|
10765
|
+
*/
|
|
10766
|
+
export const KEYS_INVOICE = [
|
|
10767
|
+
KEY_INVOICE_AMOUNT,
|
|
10768
|
+
KEY_INVOICE_CURRENCY,
|
|
10769
|
+
KEY_INVOICE_EXTERNAL_ID,
|
|
10770
|
+
KEY_INVOICE_FEES_AMOUNT,
|
|
10771
|
+
KEY_INVOICE_FILE_URL,
|
|
10772
|
+
KEY_INVOICE_INVOICE_TYPE,
|
|
10773
|
+
KEY_INVOICE_ISSUING_DATE,
|
|
10774
|
+
KEY_INVOICE_NUMBER,
|
|
10775
|
+
KEY_INVOICE_PAYMENT_DUE_DATE,
|
|
10776
|
+
KEY_INVOICE_PAYMENT_OVERDUE,
|
|
10777
|
+
KEY_INVOICE_PAYMENT_STATUS,
|
|
10778
|
+
KEY_INVOICE_STATUS,
|
|
10779
|
+
KEY_INVOICE_TAXES_AMOUNT,
|
|
10780
|
+
] as const satisfies (keyof Invoice)[];
|
|
10781
|
+
|
|
10410
10782
|
/**
|
|
10411
10783
|
* Ip Network
|
|
10412
10784
|
*
|
|
@@ -3120,6 +3120,59 @@ export type PATCH_OrganizationsOrganizationId_Request_Path = PATCH_Organizations
|
|
|
3120
3120
|
*/
|
|
3121
3121
|
export type PATCH_OrganizationsOrganizationId_Request_Body = PATCH_OrganizationsOrganizationId_Request['requestBody'];
|
|
3122
3122
|
|
|
3123
|
+
/**
|
|
3124
|
+
* Request type for GET OrganizationsOrganizationIdBillingInvoices endpoint
|
|
3125
|
+
*
|
|
3126
|
+
* List all invoices for the organization
|
|
3127
|
+
* Retrieves a paginated list of all invoices for the organization
|
|
3128
|
+
*
|
|
3129
|
+
* @remarks
|
|
3130
|
+
* This type defines the complete request structure for the GET OrganizationsOrganizationIdBillingInvoices endpoint.
|
|
3131
|
+
* It includes all parameters (query, path) and request body types as defined in the OpenAPI specification.
|
|
3132
|
+
* Use this type to ensure type safety when making API requests to this endpoint.
|
|
3133
|
+
*
|
|
3134
|
+
* @example
|
|
3135
|
+
* Use this type to ensure type safety when making API requests to this endpoint.
|
|
3136
|
+
*
|
|
3137
|
+
* @path /v1/organizations/{organization_id}/billing/invoices
|
|
3138
|
+
*
|
|
3139
|
+
* @see {@link GET_OrganizationsOrganizationIdBillingInvoices_Request_Query} - Query parameters type
|
|
3140
|
+
* @see {@link GET_OrganizationsOrganizationIdBillingInvoices_Request_Path} - Path parameters type
|
|
3141
|
+
* @see {@link GET_OrganizationsOrganizationIdBillingInvoices_Request_Body} - Request body type
|
|
3142
|
+
*/
|
|
3143
|
+
export type GET_OrganizationsOrganizationIdBillingInvoices_Request = {
|
|
3144
|
+
parameters: {
|
|
3145
|
+
query: operations['list_invoices_v1_organizations__organization_id__billing_invoices_get']['parameters']['query'];
|
|
3146
|
+
path: operations['list_invoices_v1_organizations__organization_id__billing_invoices_get']['parameters']['path'];
|
|
3147
|
+
};
|
|
3148
|
+
}
|
|
3149
|
+
/**
|
|
3150
|
+
* Query parameters for GET /v1/organizations/{organization_id}/billing/invoices
|
|
3151
|
+
*
|
|
3152
|
+
* @remarks
|
|
3153
|
+
* This type defines the query parameters for the GET /v1/organizations/{organization_id}/billing/invoices endpoint.
|
|
3154
|
+
* It provides type safety for all query parameters as defined in the OpenAPI specification.
|
|
3155
|
+
*
|
|
3156
|
+
* @example
|
|
3157
|
+
* Use this type to ensure type safety for query parameters.
|
|
3158
|
+
*
|
|
3159
|
+
* @path /v1/organizations/{organization_id}/billing/invoices
|
|
3160
|
+
*/
|
|
3161
|
+
export type GET_OrganizationsOrganizationIdBillingInvoices_Request_Query = GET_OrganizationsOrganizationIdBillingInvoices_Request['parameters']['query'];
|
|
3162
|
+
/**
|
|
3163
|
+
* Path parameters for GET /v1/organizations/{organization_id}/billing/invoices
|
|
3164
|
+
*
|
|
3165
|
+
* @remarks
|
|
3166
|
+
* This type defines the path parameters for the GET /v1/organizations/{organization_id}/billing/invoices endpoint.
|
|
3167
|
+
* It provides type safety for all path parameters as defined in the OpenAPI specification.
|
|
3168
|
+
*
|
|
3169
|
+
* @example
|
|
3170
|
+
* Use this type to ensure type safety for path parameters.
|
|
3171
|
+
*
|
|
3172
|
+
* @path /v1/organizations/{organization_id}/billing/invoices
|
|
3173
|
+
*/
|
|
3174
|
+
export type GET_OrganizationsOrganizationIdBillingInvoices_Request_Path = GET_OrganizationsOrganizationIdBillingInvoices_Request['parameters']['path'];
|
|
3175
|
+
|
|
3123
3176
|
/**
|
|
3124
3177
|
* Request type for GET OrganizationsOrganizationIdPricingProductTypeProductType endpoint
|
|
3125
3178
|
*
|
|
@@ -34,7 +34,7 @@
|
|
|
34
34
|
|
|
35
35
|
import { DomainDnssecDataArray, OrganizationAttribute2Array, IpRestrictionArray, TldResponseShortArray } from './schemas-arrays.d';
|
|
36
36
|
|
|
37
|
-
import { Problem, HTTPValidationError, DomainAvailabilityList, Pagination_ContactSchema, ContactSchema, ContactVerification, Contact, Pagination_DnsZone, DnsZone, DnsChanges, DnsZoneSummary, DomainForward, DomainSearch, Pagination_Domain, Domain, DomainRenew, DomainRestore, DomainCheck, DomainSummary, Pagination_EmailForwardAlias, EmailForwardAlias, Pagination_Event, EventSchema, Pagination_Organization, Organization, OrganizationWithBillingData, GetPrices, Pagination_BillingTransaction, BillingTransaction, IpRestriction, Pagination_User, TldSpecification, User, UserWithAttributes, PermissionSet, RelationSet, UserWithRelationPermissions } from './schemas.d';
|
|
37
|
+
import { Problem, HTTPValidationError, DomainAvailabilityList, Pagination_ContactSchema, ContactSchema, ContactVerification, Contact, Pagination_DnsZone, DnsZone, DnsChanges, DnsZoneSummary, DomainForward, DomainSearch, Pagination_Domain, Domain, DomainRenew, DomainRestore, DomainCheck, DomainSummary, Pagination_EmailForwardAlias, EmailForwardAlias, Pagination_Event, EventSchema, Pagination_Organization, Organization, OrganizationWithBillingData, Pagination_Invoice, GetPrices, Pagination_BillingTransaction, BillingTransaction, IpRestriction, Pagination_User, TldSpecification, User, UserWithAttributes, PermissionSet, RelationSet, UserWithRelationPermissions } from './schemas.d';
|
|
38
38
|
|
|
39
39
|
/**
|
|
40
40
|
* Response types for POST AuthToken endpoint
|
|
@@ -4638,6 +4638,62 @@ export type PATCH_OrganizationsByOrganizationId_Response_403 = Problem
|
|
|
4638
4638
|
*/
|
|
4639
4639
|
export type PATCH_OrganizationsByOrganizationId_Response_422 = HTTPValidationError
|
|
4640
4640
|
|
|
4641
|
+
/**
|
|
4642
|
+
* Response types for GET OrganizationsByOrganizationIdBillingInvoices endpoint
|
|
4643
|
+
*
|
|
4644
|
+
* List all invoices for the organization
|
|
4645
|
+
* Retrieves a paginated list of all invoices for the organization
|
|
4646
|
+
*
|
|
4647
|
+
* @remarks
|
|
4648
|
+
* This type defines all possible response structures for the GET OrganizationsByOrganizationIdBillingInvoices endpoint.
|
|
4649
|
+
* Each response code maps to a specific response type as defined in the OpenAPI specification.
|
|
4650
|
+
* Use this type to ensure type safety when handling API responses from this endpoint.
|
|
4651
|
+
*
|
|
4652
|
+
|
|
4653
|
+
*
|
|
4654
|
+
* @path /v1/organizations/{organization_id}/billing/invoices
|
|
4655
|
+
*
|
|
4656
|
+
* @see {@link GET_OrganizationsByOrganizationIdBillingInvoices_Response_200} - 200 response type
|
|
4657
|
+
* @see {@link GET_OrganizationsByOrganizationIdBillingInvoices_Response_422} - 422 response type
|
|
4658
|
+
*
|
|
4659
|
+
|
|
4660
|
+
*/
|
|
4661
|
+
export type GET_OrganizationsByOrganizationIdBillingInvoices_Response = GET_OrganizationsByOrganizationIdBillingInvoices_Response_200 | GET_OrganizationsByOrganizationIdBillingInvoices_Response_422;
|
|
4662
|
+
|
|
4663
|
+
/**
|
|
4664
|
+
* 200 response for GET OrganizationsByOrganizationIdBillingInvoices endpoint
|
|
4665
|
+
*
|
|
4666
|
+
* @remarks
|
|
4667
|
+
* This type defines the response structure for the 200 status code
|
|
4668
|
+
* of the GET OrganizationsByOrganizationIdBillingInvoices endpoint.
|
|
4669
|
+
* It provides type safety for handling this specific response as defined in the OpenAPI specification.
|
|
4670
|
+
*
|
|
4671
|
+
|
|
4672
|
+
*
|
|
4673
|
+
* @path /v1/organizations/{organization_id}/billing/invoices
|
|
4674
|
+
*
|
|
4675
|
+
* @see {@link GET_OrganizationsByOrganizationIdBillingInvoices_Response} - The main response type definition
|
|
4676
|
+
* @see {@link Pagination_Invoice} - The actual schema type definition
|
|
4677
|
+
*/
|
|
4678
|
+
export type GET_OrganizationsByOrganizationIdBillingInvoices_Response_200 = Pagination_Invoice
|
|
4679
|
+
|
|
4680
|
+
/**
|
|
4681
|
+
* 422 response for GET OrganizationsByOrganizationIdBillingInvoices endpoint
|
|
4682
|
+
*
|
|
4683
|
+
* @remarks
|
|
4684
|
+
* This type defines the response structure for the 422 status code
|
|
4685
|
+
* of the GET OrganizationsByOrganizationIdBillingInvoices endpoint.
|
|
4686
|
+
* It provides type safety for handling this specific response as defined in the OpenAPI specification.
|
|
4687
|
+
*
|
|
4688
|
+
|
|
4689
|
+
*
|
|
4690
|
+
* @path /v1/organizations/{organization_id}/billing/invoices
|
|
4691
|
+
*
|
|
4692
|
+
* @see {@link GET_OrganizationsByOrganizationIdBillingInvoices_Response} - The main response type definition
|
|
4693
|
+
* @see {@link HTTPValidationError} - The actual schema type definition
|
|
4694
|
+
*/
|
|
4695
|
+
export type GET_OrganizationsByOrganizationIdBillingInvoices_Response_422 = HTTPValidationError
|
|
4696
|
+
|
|
4641
4697
|
/**
|
|
4642
4698
|
* Response types for GET OrganizationsByOrganizationIdPricingProductTypeByProductType endpoint
|
|
4643
4699
|
*
|
|
@@ -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, RegistryHandleAttributeType, ContactAttributeDefinition, ContactRoleAttributeRequirement, PostalAddressType, ContactConfigBase, DnsChange, DnsRecordCreate, DnsRecord, DnsRrsetCreate, DnsRecordPatchOp, DnsRrset, DnsRrsetPatchOp, DomainAvailabilityCheck, ContactHandle, Nameserver, HttpRedirect, DeletePolicyType, SyncOperationType, DomainContact, DomainSearchSuggestionWithPrice, DomainStatus, DomainClientStatus, PriceInfo, ValidationError, LaunchPhaseBase, LocalPresenceRequirementType, ContactRoleType, OrganizationAttribute2, User, OrganizationAttributeCreate, UserCreate, BillingTransaction, ContactSchema, DnsZone, Domain, EmailForwardAlias, EventResponse, Organization, Period, Permission, PremiumAffectsType, Relation, TldBase, PostTransferRequirements, UserAttributeBase, DomainAvailability } from './schemas.d';
|
|
24
|
+
import { DomainDnssecData, DomainDnssecDataCreate, OrganizationAttribute, OrganizationAttributeUpdate, IpRestriction, TldResponseShort, RegistryHandleAttributeType, ContactAttributeDefinition, ContactRoleAttributeRequirement, PostalAddressType, ContactConfigBase, DnsChange, DnsRecordCreate, DnsRecord, DnsRrsetCreate, DnsRecordPatchOp, DnsRrset, DnsRrsetPatchOp, DomainAvailabilityCheck, ContactHandle, Nameserver, HttpRedirect, DeletePolicyType, SyncOperationType, DomainContact, DomainSearchSuggestionWithPrice, DomainStatus, DomainClientStatus, PriceInfo, ValidationError, LaunchPhaseBase, LocalPresenceRequirementType, ContactRoleType, OrganizationAttribute2, User, OrganizationAttributeCreate, UserCreate, BillingTransaction, ContactSchema, DnsZone, Domain, EmailForwardAlias, EventResponse, Invoice, Organization, Period, Permission, PremiumAffectsType, Relation, TldBase, PostTransferRequirements, UserAttributeBase, DomainAvailability } from './schemas.d';
|
|
25
25
|
|
|
26
26
|
/**
|
|
27
27
|
* DomainDnssecDataResponse
|
|
@@ -625,6 +625,20 @@ export type EmailForwardAliasArray = EmailForwardAlias[];
|
|
|
625
625
|
* @see {@link EventResponse} - The individual EventResponse type definition
|
|
626
626
|
*/
|
|
627
627
|
export type EventResponseArray = EventResponse[];
|
|
628
|
+
/**
|
|
629
|
+
* InvoiceResponse
|
|
630
|
+
*
|
|
631
|
+
* @remarks
|
|
632
|
+
* Array type for InvoiceResponse objects. Used when the API returns a collection of InvoiceResponse instances.
|
|
633
|
+
*
|
|
634
|
+
* @example
|
|
635
|
+
* ```typescript
|
|
636
|
+
* const items: InvoiceArray = await api.getInvoices();
|
|
637
|
+
* ```
|
|
638
|
+
*
|
|
639
|
+
* @see {@link Invoice} - The individual InvoiceResponse type definition
|
|
640
|
+
*/
|
|
641
|
+
export type InvoiceArray = Invoice[];
|
|
628
642
|
/**
|
|
629
643
|
* Organization
|
|
630
644
|
*
|
package/src/helpers/schemas.d.ts
CHANGED
|
@@ -1642,6 +1642,70 @@ export type HttpRedirect = components['schemas']['HttpRedirect'];
|
|
|
1642
1642
|
* @see {@link components} - The OpenAPI components schema definition
|
|
1643
1643
|
*/
|
|
1644
1644
|
export type IdnBase = components['schemas']['IdnBase'];
|
|
1645
|
+
/**
|
|
1646
|
+
* InvoiceResponse
|
|
1647
|
+
*
|
|
1648
|
+
* @remarks
|
|
1649
|
+
* Type alias for the `InvoiceResponse` OpenAPI schema.
|
|
1650
|
+
* This type represents invoiceresponse data structures used in API requests and responses.
|
|
1651
|
+
*
|
|
1652
|
+
* @example
|
|
1653
|
+
* ```typescript
|
|
1654
|
+
* const response = await api.getInvoice();
|
|
1655
|
+
* const item: Invoice = response.results;
|
|
1656
|
+
* ```
|
|
1657
|
+
*
|
|
1658
|
+
* @see {@link components} - The OpenAPI components schema definition
|
|
1659
|
+
*/
|
|
1660
|
+
export type Invoice = components['schemas']['InvoiceResponse'];
|
|
1661
|
+
/**
|
|
1662
|
+
* InvoiceResponsePaymentStatus
|
|
1663
|
+
*
|
|
1664
|
+
* @remarks
|
|
1665
|
+
* Type alias for the `InvoiceResponsePaymentStatus` OpenAPI schema.
|
|
1666
|
+
* This type represents invoiceresponsepaymentstatus data structures used in API requests and responses.
|
|
1667
|
+
*
|
|
1668
|
+
* @example
|
|
1669
|
+
* ```typescript
|
|
1670
|
+
* const response = await api.getInvoiceResponsePaymentStatus();
|
|
1671
|
+
* const item: InvoiceResponsePaymentStatus = response.results;
|
|
1672
|
+
* ```
|
|
1673
|
+
*
|
|
1674
|
+
* @see {@link components} - The OpenAPI components schema definition
|
|
1675
|
+
*/
|
|
1676
|
+
export type InvoiceResponsePaymentStatus = components['schemas']['InvoiceResponsePaymentStatus'];
|
|
1677
|
+
/**
|
|
1678
|
+
* InvoiceResponseStatus
|
|
1679
|
+
*
|
|
1680
|
+
* @remarks
|
|
1681
|
+
* Type alias for the `InvoiceResponseStatus` OpenAPI schema.
|
|
1682
|
+
* This type represents invoiceresponsestatus data structures used in API requests and responses.
|
|
1683
|
+
*
|
|
1684
|
+
* @example
|
|
1685
|
+
* ```typescript
|
|
1686
|
+
* const response = await api.getInvoiceResponseStatus();
|
|
1687
|
+
* const item: InvoiceResponseStatus = response.results;
|
|
1688
|
+
* ```
|
|
1689
|
+
*
|
|
1690
|
+
* @see {@link components} - The OpenAPI components schema definition
|
|
1691
|
+
*/
|
|
1692
|
+
export type InvoiceResponseStatus = components['schemas']['InvoiceResponseStatus'];
|
|
1693
|
+
/**
|
|
1694
|
+
* InvoiceResponseType
|
|
1695
|
+
*
|
|
1696
|
+
* @remarks
|
|
1697
|
+
* Type alias for the `InvoiceResponseType` OpenAPI schema.
|
|
1698
|
+
* This type represents invoiceresponsetype data structures used in API requests and responses.
|
|
1699
|
+
*
|
|
1700
|
+
* @example
|
|
1701
|
+
* ```typescript
|
|
1702
|
+
* const response = await api.getInvoiceResponseType();
|
|
1703
|
+
* const item: InvoiceResponseType = response.results;
|
|
1704
|
+
* ```
|
|
1705
|
+
*
|
|
1706
|
+
* @see {@link components} - The OpenAPI components schema definition
|
|
1707
|
+
*/
|
|
1708
|
+
export type InvoiceResponseType = components['schemas']['InvoiceResponseType'];
|
|
1645
1709
|
/**
|
|
1646
1710
|
* IpRestrictionCreate. Create an IP restriction for an organization.
|
|
1647
1711
|
|
|
@@ -2079,6 +2143,22 @@ export type Pagination_EmailForwardAlias = components['schemas']['Pagination_Ema
|
|
|
2079
2143
|
* @see {@link components} - The OpenAPI components schema definition
|
|
2080
2144
|
*/
|
|
2081
2145
|
export type Pagination_Event = components['schemas']['Pagination_EventResponse_'];
|
|
2146
|
+
/**
|
|
2147
|
+
* Pagination[InvoiceResponse]
|
|
2148
|
+
*
|
|
2149
|
+
* @remarks
|
|
2150
|
+
* Type alias for the `Pagination_InvoiceResponse_` OpenAPI schema.
|
|
2151
|
+
* This type represents pagination[invoiceresponse] data structures used in API requests and responses.
|
|
2152
|
+
*
|
|
2153
|
+
* @example
|
|
2154
|
+
* ```typescript
|
|
2155
|
+
* const response = await api.getPagination_Invoice();
|
|
2156
|
+
* const item: Pagination_Invoice = response.results;
|
|
2157
|
+
* ```
|
|
2158
|
+
*
|
|
2159
|
+
* @see {@link components} - The OpenAPI components schema definition
|
|
2160
|
+
*/
|
|
2161
|
+
export type Pagination_Invoice = components['schemas']['Pagination_InvoiceResponse_'];
|
|
2082
2162
|
/**
|
|
2083
2163
|
* Pagination[Organization]
|
|
2084
2164
|
*
|
package/src/openapi.yaml
CHANGED
|
@@ -2563,6 +2563,100 @@ components:
|
|
|
2563
2563
|
- idn_capable
|
|
2564
2564
|
title: IdnBase
|
|
2565
2565
|
type: object
|
|
2566
|
+
InvoiceResponse:
|
|
2567
|
+
properties:
|
|
2568
|
+
amount:
|
|
2569
|
+
description: Total invoice amount
|
|
2570
|
+
title: Amount
|
|
2571
|
+
type: string
|
|
2572
|
+
currency:
|
|
2573
|
+
$ref: '#/components/schemas/Currency'
|
|
2574
|
+
description: Invoice currency
|
|
2575
|
+
external_id:
|
|
2576
|
+
description: Lago ID (external) for this invoice
|
|
2577
|
+
title: External Id
|
|
2578
|
+
type: string
|
|
2579
|
+
fees_amount:
|
|
2580
|
+
description: Fees amount
|
|
2581
|
+
title: Fees Amount
|
|
2582
|
+
type: string
|
|
2583
|
+
file_url:
|
|
2584
|
+
description: URL to invoice PDF file
|
|
2585
|
+
title: File Url
|
|
2586
|
+
type: string
|
|
2587
|
+
invoice_type:
|
|
2588
|
+
$ref: '#/components/schemas/InvoiceResponseType'
|
|
2589
|
+
description: Invoice type
|
|
2590
|
+
issuing_date:
|
|
2591
|
+
description: Invoice issuing date
|
|
2592
|
+
format: date-time
|
|
2593
|
+
title: Issuing Date
|
|
2594
|
+
type: string
|
|
2595
|
+
number:
|
|
2596
|
+
description: Invoice number
|
|
2597
|
+
title: Number
|
|
2598
|
+
type: string
|
|
2599
|
+
payment_due_date:
|
|
2600
|
+
description: Payment due date
|
|
2601
|
+
format: date-time
|
|
2602
|
+
title: Payment Due Date
|
|
2603
|
+
type: string
|
|
2604
|
+
payment_overdue:
|
|
2605
|
+
description: Whether payment is overdue
|
|
2606
|
+
title: Payment Overdue
|
|
2607
|
+
type: boolean
|
|
2608
|
+
payment_status:
|
|
2609
|
+
$ref: '#/components/schemas/InvoiceResponsePaymentStatus'
|
|
2610
|
+
description: Payment status
|
|
2611
|
+
status:
|
|
2612
|
+
$ref: '#/components/schemas/InvoiceResponseStatus'
|
|
2613
|
+
description: Invoice status
|
|
2614
|
+
taxes_amount:
|
|
2615
|
+
description: Taxes amount
|
|
2616
|
+
title: Taxes Amount
|
|
2617
|
+
type: string
|
|
2618
|
+
required:
|
|
2619
|
+
- external_id
|
|
2620
|
+
- number
|
|
2621
|
+
- issuing_date
|
|
2622
|
+
- payment_due_date
|
|
2623
|
+
- invoice_type
|
|
2624
|
+
- status
|
|
2625
|
+
- payment_status
|
|
2626
|
+
- payment_overdue
|
|
2627
|
+
- currency
|
|
2628
|
+
- amount
|
|
2629
|
+
- fees_amount
|
|
2630
|
+
- taxes_amount
|
|
2631
|
+
- file_url
|
|
2632
|
+
title: InvoiceResponse
|
|
2633
|
+
type: object
|
|
2634
|
+
InvoiceResponsePaymentStatus:
|
|
2635
|
+
enum:
|
|
2636
|
+
- pending
|
|
2637
|
+
- failed
|
|
2638
|
+
- succeeded
|
|
2639
|
+
title: InvoiceResponsePaymentStatus
|
|
2640
|
+
type: string
|
|
2641
|
+
InvoiceResponseStatus:
|
|
2642
|
+
enum:
|
|
2643
|
+
- draft
|
|
2644
|
+
- finalized
|
|
2645
|
+
- failed
|
|
2646
|
+
- pending
|
|
2647
|
+
- voided
|
|
2648
|
+
title: InvoiceResponseStatus
|
|
2649
|
+
type: string
|
|
2650
|
+
InvoiceResponseType:
|
|
2651
|
+
enum:
|
|
2652
|
+
- subscription
|
|
2653
|
+
- add_on
|
|
2654
|
+
- credit
|
|
2655
|
+
- one_off
|
|
2656
|
+
- advance_charges
|
|
2657
|
+
- progressive_billing
|
|
2658
|
+
title: InvoiceResponseType
|
|
2659
|
+
type: string
|
|
2566
2660
|
IpRestrictionCreate:
|
|
2567
2661
|
description: 'Create an IP restriction for an organization.
|
|
2568
2662
|
|
|
@@ -3576,6 +3670,20 @@ components:
|
|
|
3576
3670
|
- pagination
|
|
3577
3671
|
title: Pagination[EventResponse]
|
|
3578
3672
|
type: object
|
|
3673
|
+
Pagination_InvoiceResponse_:
|
|
3674
|
+
properties:
|
|
3675
|
+
pagination:
|
|
3676
|
+
$ref: '#/components/schemas/PaginationMetadata'
|
|
3677
|
+
results:
|
|
3678
|
+
items:
|
|
3679
|
+
$ref: '#/components/schemas/InvoiceResponse'
|
|
3680
|
+
title: Results
|
|
3681
|
+
type: array
|
|
3682
|
+
required:
|
|
3683
|
+
- results
|
|
3684
|
+
- pagination
|
|
3685
|
+
title: Pagination[InvoiceResponse]
|
|
3686
|
+
type: object
|
|
3579
3687
|
Pagination_Organization_:
|
|
3580
3688
|
properties:
|
|
3581
3689
|
pagination:
|
|
@@ -4897,7 +5005,7 @@ info:
|
|
|
4897
5005
|
'
|
|
4898
5006
|
summary: OpusDNS - your gateway to a seamless domain management experience.
|
|
4899
5007
|
title: OpusDNS API
|
|
4900
|
-
version: 2025-10-
|
|
5008
|
+
version: 2025-10-29-093948
|
|
4901
5009
|
x-logo:
|
|
4902
5010
|
altText: OpusDNS API Reference
|
|
4903
5011
|
url: https://d24lr4zqs1tgqh.cloudfront.net/c9505a20-5ae1-406c-b060-d392569caebf.jpg
|
|
@@ -9156,6 +9264,57 @@ paths:
|
|
|
9156
9264
|
summary: Update an organization
|
|
9157
9265
|
tags:
|
|
9158
9266
|
- organization
|
|
9267
|
+
/v1/organizations/{organization_id}/billing/invoices:
|
|
9268
|
+
get:
|
|
9269
|
+
description: Retrieves a paginated list of all invoices for the organization
|
|
9270
|
+
operationId: list_invoices_v1_organizations__organization_id__billing_invoices_get
|
|
9271
|
+
parameters:
|
|
9272
|
+
- in: path
|
|
9273
|
+
name: organization_id
|
|
9274
|
+
required: true
|
|
9275
|
+
schema:
|
|
9276
|
+
examples:
|
|
9277
|
+
- organization_01h45ytscbebyvny4gc8cr8ma2
|
|
9278
|
+
format: typeid
|
|
9279
|
+
pattern: ^organization_[0-7][0-9a-hjkmnpq-tv-z]{25}$
|
|
9280
|
+
title: Organization Id
|
|
9281
|
+
type: string
|
|
9282
|
+
x-typeid-prefix: organization
|
|
9283
|
+
- in: query
|
|
9284
|
+
name: page
|
|
9285
|
+
required: false
|
|
9286
|
+
schema:
|
|
9287
|
+
default: 1
|
|
9288
|
+
minimum: 1
|
|
9289
|
+
title: Page
|
|
9290
|
+
type: integer
|
|
9291
|
+
- in: query
|
|
9292
|
+
name: page_size
|
|
9293
|
+
required: false
|
|
9294
|
+
schema:
|
|
9295
|
+
default: 10
|
|
9296
|
+
maximum: 100
|
|
9297
|
+
minimum: 1
|
|
9298
|
+
title: Page Size
|
|
9299
|
+
type: integer
|
|
9300
|
+
responses:
|
|
9301
|
+
'200':
|
|
9302
|
+
content:
|
|
9303
|
+
application/json:
|
|
9304
|
+
schema:
|
|
9305
|
+
$ref: '#/components/schemas/Pagination_InvoiceResponse_'
|
|
9306
|
+
description: Successful Response
|
|
9307
|
+
'422':
|
|
9308
|
+
content:
|
|
9309
|
+
application/problem+json:
|
|
9310
|
+
schema:
|
|
9311
|
+
$ref: '#/components/schemas/HTTPValidationError'
|
|
9312
|
+
description: Validation Error
|
|
9313
|
+
security:
|
|
9314
|
+
- OAuth2PasswordBearer: []
|
|
9315
|
+
summary: List all invoices for the organization
|
|
9316
|
+
tags:
|
|
9317
|
+
- organization
|
|
9159
9318
|
/v1/organizations/{organization_id}/pricing/product-type/{product_type}:
|
|
9160
9319
|
get:
|
|
9161
9320
|
description: Retrieves pricing data for a specific product type. If a product
|
package/src/schema.d.ts
CHANGED
|
@@ -912,6 +912,26 @@ export interface paths {
|
|
|
912
912
|
patch: operations["update_organization_v1_organizations__organization_id__patch"];
|
|
913
913
|
trace?: never;
|
|
914
914
|
};
|
|
915
|
+
"/v1/organizations/{organization_id}/billing/invoices": {
|
|
916
|
+
parameters: {
|
|
917
|
+
query?: never;
|
|
918
|
+
header?: never;
|
|
919
|
+
path?: never;
|
|
920
|
+
cookie?: never;
|
|
921
|
+
};
|
|
922
|
+
/**
|
|
923
|
+
* List all invoices for the organization
|
|
924
|
+
* @description Retrieves a paginated list of all invoices for the organization
|
|
925
|
+
*/
|
|
926
|
+
get: operations["list_invoices_v1_organizations__organization_id__billing_invoices_get"];
|
|
927
|
+
put?: never;
|
|
928
|
+
post?: never;
|
|
929
|
+
delete?: never;
|
|
930
|
+
options?: never;
|
|
931
|
+
head?: never;
|
|
932
|
+
patch?: never;
|
|
933
|
+
trace?: never;
|
|
934
|
+
};
|
|
915
935
|
"/v1/organizations/{organization_id}/pricing/product-type/{product_type}": {
|
|
916
936
|
parameters: {
|
|
917
937
|
query?: never;
|
|
@@ -2907,6 +2927,79 @@ export interface components {
|
|
|
2907
2927
|
*/
|
|
2908
2928
|
idn_tables?: string[] | null;
|
|
2909
2929
|
};
|
|
2930
|
+
/** InvoiceResponse */
|
|
2931
|
+
InvoiceResponse: {
|
|
2932
|
+
/**
|
|
2933
|
+
* Amount
|
|
2934
|
+
* @description Total invoice amount
|
|
2935
|
+
*/
|
|
2936
|
+
amount: string;
|
|
2937
|
+
/** @description Invoice currency */
|
|
2938
|
+
currency: components["schemas"]["Currency"];
|
|
2939
|
+
/**
|
|
2940
|
+
* External Id
|
|
2941
|
+
* @description Lago ID (external) for this invoice
|
|
2942
|
+
*/
|
|
2943
|
+
external_id: string;
|
|
2944
|
+
/**
|
|
2945
|
+
* Fees Amount
|
|
2946
|
+
* @description Fees amount
|
|
2947
|
+
*/
|
|
2948
|
+
fees_amount: string;
|
|
2949
|
+
/**
|
|
2950
|
+
* File Url
|
|
2951
|
+
* @description URL to invoice PDF file
|
|
2952
|
+
*/
|
|
2953
|
+
file_url: string;
|
|
2954
|
+
/** @description Invoice type */
|
|
2955
|
+
invoice_type: components["schemas"]["InvoiceResponseType"];
|
|
2956
|
+
/**
|
|
2957
|
+
* Issuing Date
|
|
2958
|
+
* Format: date-time
|
|
2959
|
+
* @description Invoice issuing date
|
|
2960
|
+
*/
|
|
2961
|
+
issuing_date: Date;
|
|
2962
|
+
/**
|
|
2963
|
+
* Number
|
|
2964
|
+
* @description Invoice number
|
|
2965
|
+
*/
|
|
2966
|
+
number: string;
|
|
2967
|
+
/**
|
|
2968
|
+
* Payment Due Date
|
|
2969
|
+
* Format: date-time
|
|
2970
|
+
* @description Payment due date
|
|
2971
|
+
*/
|
|
2972
|
+
payment_due_date: Date;
|
|
2973
|
+
/**
|
|
2974
|
+
* Payment Overdue
|
|
2975
|
+
* @description Whether payment is overdue
|
|
2976
|
+
*/
|
|
2977
|
+
payment_overdue: boolean;
|
|
2978
|
+
/** @description Payment status */
|
|
2979
|
+
payment_status: components["schemas"]["InvoiceResponsePaymentStatus"];
|
|
2980
|
+
/** @description Invoice status */
|
|
2981
|
+
status: components["schemas"]["InvoiceResponseStatus"];
|
|
2982
|
+
/**
|
|
2983
|
+
* Taxes Amount
|
|
2984
|
+
* @description Taxes amount
|
|
2985
|
+
*/
|
|
2986
|
+
taxes_amount: string;
|
|
2987
|
+
};
|
|
2988
|
+
/**
|
|
2989
|
+
* InvoiceResponsePaymentStatus
|
|
2990
|
+
* @enum {string}
|
|
2991
|
+
*/
|
|
2992
|
+
InvoiceResponsePaymentStatus: "pending" | "failed" | "succeeded";
|
|
2993
|
+
/**
|
|
2994
|
+
* InvoiceResponseStatus
|
|
2995
|
+
* @enum {string}
|
|
2996
|
+
*/
|
|
2997
|
+
InvoiceResponseStatus: "draft" | "finalized" | "failed" | "pending" | "voided";
|
|
2998
|
+
/**
|
|
2999
|
+
* InvoiceResponseType
|
|
3000
|
+
* @enum {string}
|
|
3001
|
+
*/
|
|
3002
|
+
InvoiceResponseType: "subscription" | "add_on" | "credit" | "one_off" | "advance_charges" | "progressive_billing";
|
|
2910
3003
|
/**
|
|
2911
3004
|
* IpRestrictionCreate
|
|
2912
3005
|
* @description Create an IP restriction for an organization.
|
|
@@ -3591,6 +3684,12 @@ export interface components {
|
|
|
3591
3684
|
/** Results */
|
|
3592
3685
|
results: components["schemas"]["EventResponse"][];
|
|
3593
3686
|
};
|
|
3687
|
+
/** Pagination[InvoiceResponse] */
|
|
3688
|
+
Pagination_InvoiceResponse_: {
|
|
3689
|
+
pagination: components["schemas"]["PaginationMetadata"];
|
|
3690
|
+
/** Results */
|
|
3691
|
+
results: components["schemas"]["InvoiceResponse"][];
|
|
3692
|
+
};
|
|
3594
3693
|
/** Pagination[Organization] */
|
|
3595
3694
|
Pagination_Organization_: {
|
|
3596
3695
|
pagination: components["schemas"]["PaginationMetadata"];
|
|
@@ -8243,6 +8342,40 @@ export interface operations {
|
|
|
8243
8342
|
};
|
|
8244
8343
|
};
|
|
8245
8344
|
};
|
|
8345
|
+
list_invoices_v1_organizations__organization_id__billing_invoices_get: {
|
|
8346
|
+
parameters: {
|
|
8347
|
+
query?: {
|
|
8348
|
+
page?: number;
|
|
8349
|
+
page_size?: number;
|
|
8350
|
+
};
|
|
8351
|
+
header?: never;
|
|
8352
|
+
path: {
|
|
8353
|
+
organization_id: TypeId<"organization">;
|
|
8354
|
+
};
|
|
8355
|
+
cookie?: never;
|
|
8356
|
+
};
|
|
8357
|
+
requestBody?: never;
|
|
8358
|
+
responses: {
|
|
8359
|
+
/** @description Successful Response */
|
|
8360
|
+
200: {
|
|
8361
|
+
headers: {
|
|
8362
|
+
[name: string]: unknown;
|
|
8363
|
+
};
|
|
8364
|
+
content: {
|
|
8365
|
+
"application/json": components["schemas"]["Pagination_InvoiceResponse_"];
|
|
8366
|
+
};
|
|
8367
|
+
};
|
|
8368
|
+
/** @description Validation Error */
|
|
8369
|
+
422: {
|
|
8370
|
+
headers: {
|
|
8371
|
+
[name: string]: unknown;
|
|
8372
|
+
};
|
|
8373
|
+
content: {
|
|
8374
|
+
"application/problem+json": components["schemas"]["HTTPValidationError"];
|
|
8375
|
+
};
|
|
8376
|
+
};
|
|
8377
|
+
};
|
|
8378
|
+
};
|
|
8246
8379
|
get_pricing_plans_v1_organizations__organization_id__pricing_product_type__product_type__get: {
|
|
8247
8380
|
parameters: {
|
|
8248
8381
|
query?: {
|