@opusdns/api 0.71.0 → 0.73.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/package.json +1 -1
- package/src/helpers/keys.ts +108 -52
- package/src/openapi.yaml +22 -8
- package/src/schema.d.ts +21 -7
package/package.json
CHANGED
package/src/helpers/keys.ts
CHANGED
|
@@ -34,7 +34,6 @@ import { BillingMetadata } from './schemas';
|
|
|
34
34
|
import { BillingPlan } from './schemas';
|
|
35
35
|
import { BillingTransaction } from './schemas';
|
|
36
36
|
import { Body_issue_organization_token_v1_auth_token_post } from './schemas';
|
|
37
|
-
import { CheckoutSessionRequest } from './schemas';
|
|
38
37
|
import { CheckoutSession } from './schemas';
|
|
39
38
|
import { ContactAttributeDefinition } from './schemas';
|
|
40
39
|
import { ContactConfigBase } from './schemas';
|
|
@@ -518,6 +517,32 @@ export const KEYS_BILLING_PLAN = [
|
|
|
518
517
|
* @see {@link KEYS_BILLING_TRANSACTION} - Array of all keys for this type
|
|
519
518
|
*/
|
|
520
519
|
export const KEY_BILLING_TRANSACTION_ACTION = 'action' as keyof BillingTransaction;
|
|
520
|
+
/**
|
|
521
|
+
* Amount
|
|
522
|
+
*
|
|
523
|
+
* The amount of the transaction including VAT
|
|
524
|
+
*
|
|
525
|
+
* @type {string}
|
|
526
|
+
*
|
|
527
|
+
*
|
|
528
|
+
* @remarks
|
|
529
|
+
* This key constant provides type-safe access to the `amount` property of BillingTransaction objects.
|
|
530
|
+
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
531
|
+
*
|
|
532
|
+
* @example
|
|
533
|
+
* ```typescript
|
|
534
|
+
* // Direct property access
|
|
535
|
+
* const value = billingtransaction[KEY_BILLING_TRANSACTION_AMOUNT];
|
|
536
|
+
*
|
|
537
|
+
* // Dynamic property access
|
|
538
|
+
* const propertyName = KEY_BILLING_TRANSACTION_AMOUNT;
|
|
539
|
+
* const value = billingtransaction[propertyName];
|
|
540
|
+
* ```
|
|
541
|
+
*
|
|
542
|
+
* @see {@link BillingTransaction} - The TypeScript type definition
|
|
543
|
+
* @see {@link KEYS_BILLING_TRANSACTION} - Array of all keys for this type
|
|
544
|
+
*/
|
|
545
|
+
export const KEY_BILLING_TRANSACTION_AMOUNT = 'amount' as keyof BillingTransaction;
|
|
521
546
|
/**
|
|
522
547
|
* Billing Transaction Id
|
|
523
548
|
*
|
|
@@ -594,6 +619,32 @@ export const KEY_BILLING_TRANSACTION_COMPLETED_ON = 'completed_on' as keyof Bill
|
|
|
594
619
|
* @see {@link KEYS_BILLING_TRANSACTION} - Array of all keys for this type
|
|
595
620
|
*/
|
|
596
621
|
export const KEY_BILLING_TRANSACTION_CREATED_ON = 'created_on' as keyof BillingTransaction;
|
|
622
|
+
/**
|
|
623
|
+
* Price
|
|
624
|
+
*
|
|
625
|
+
* The price of the product without sales tax
|
|
626
|
+
*
|
|
627
|
+
* @type {string}
|
|
628
|
+
*
|
|
629
|
+
*
|
|
630
|
+
* @remarks
|
|
631
|
+
* This key constant provides type-safe access to the `price` property of BillingTransaction objects.
|
|
632
|
+
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
633
|
+
*
|
|
634
|
+
* @example
|
|
635
|
+
* ```typescript
|
|
636
|
+
* // Direct property access
|
|
637
|
+
* const value = billingtransaction[KEY_BILLING_TRANSACTION_PRICE];
|
|
638
|
+
*
|
|
639
|
+
* // Dynamic property access
|
|
640
|
+
* const propertyName = KEY_BILLING_TRANSACTION_PRICE;
|
|
641
|
+
* const value = billingtransaction[propertyName];
|
|
642
|
+
* ```
|
|
643
|
+
*
|
|
644
|
+
* @see {@link BillingTransaction} - The TypeScript type definition
|
|
645
|
+
* @see {@link KEYS_BILLING_TRANSACTION} - Array of all keys for this type
|
|
646
|
+
*/
|
|
647
|
+
export const KEY_BILLING_TRANSACTION_PRICE = 'price' as keyof BillingTransaction;
|
|
597
648
|
/**
|
|
598
649
|
* Product Reference
|
|
599
650
|
*
|
|
@@ -669,6 +720,58 @@ export const KEY_BILLING_TRANSACTION_PRODUCT_TYPE = 'product_type' as keyof Bill
|
|
|
669
720
|
* @see {@link KEYS_BILLING_TRANSACTION} - Array of all keys for this type
|
|
670
721
|
*/
|
|
671
722
|
export const KEY_BILLING_TRANSACTION_STATUS = 'status' as keyof BillingTransaction;
|
|
723
|
+
/**
|
|
724
|
+
* Tax Amount
|
|
725
|
+
*
|
|
726
|
+
* The tax amount of the transaction
|
|
727
|
+
*
|
|
728
|
+
* @type {string}
|
|
729
|
+
*
|
|
730
|
+
*
|
|
731
|
+
* @remarks
|
|
732
|
+
* This key constant provides type-safe access to the `tax_amount` property of BillingTransaction objects.
|
|
733
|
+
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
734
|
+
*
|
|
735
|
+
* @example
|
|
736
|
+
* ```typescript
|
|
737
|
+
* // Direct property access
|
|
738
|
+
* const value = billingtransaction[KEY_BILLING_TRANSACTION_TAX_AMOUNT];
|
|
739
|
+
*
|
|
740
|
+
* // Dynamic property access
|
|
741
|
+
* const propertyName = KEY_BILLING_TRANSACTION_TAX_AMOUNT;
|
|
742
|
+
* const value = billingtransaction[propertyName];
|
|
743
|
+
* ```
|
|
744
|
+
*
|
|
745
|
+
* @see {@link BillingTransaction} - The TypeScript type definition
|
|
746
|
+
* @see {@link KEYS_BILLING_TRANSACTION} - Array of all keys for this type
|
|
747
|
+
*/
|
|
748
|
+
export const KEY_BILLING_TRANSACTION_TAX_AMOUNT = 'tax_amount' as keyof BillingTransaction;
|
|
749
|
+
/**
|
|
750
|
+
* Tax Rate
|
|
751
|
+
*
|
|
752
|
+
* The tax rate of the transaction
|
|
753
|
+
*
|
|
754
|
+
* @type {string}
|
|
755
|
+
*
|
|
756
|
+
*
|
|
757
|
+
* @remarks
|
|
758
|
+
* This key constant provides type-safe access to the `tax_rate` property of BillingTransaction objects.
|
|
759
|
+
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
760
|
+
*
|
|
761
|
+
* @example
|
|
762
|
+
* ```typescript
|
|
763
|
+
* // Direct property access
|
|
764
|
+
* const value = billingtransaction[KEY_BILLING_TRANSACTION_TAX_RATE];
|
|
765
|
+
*
|
|
766
|
+
* // Dynamic property access
|
|
767
|
+
* const propertyName = KEY_BILLING_TRANSACTION_TAX_RATE;
|
|
768
|
+
* const value = billingtransaction[propertyName];
|
|
769
|
+
* ```
|
|
770
|
+
*
|
|
771
|
+
* @see {@link BillingTransaction} - The TypeScript type definition
|
|
772
|
+
* @see {@link KEYS_BILLING_TRANSACTION} - Array of all keys for this type
|
|
773
|
+
*/
|
|
774
|
+
export const KEY_BILLING_TRANSACTION_TAX_RATE = 'tax_rate' as keyof BillingTransaction;
|
|
672
775
|
/**
|
|
673
776
|
* Updated On
|
|
674
777
|
*
|
|
@@ -718,12 +821,16 @@ export const KEY_BILLING_TRANSACTION_UPDATED_ON = 'updated_on' as keyof BillingT
|
|
|
718
821
|
*/
|
|
719
822
|
export const KEYS_BILLING_TRANSACTION = [
|
|
720
823
|
KEY_BILLING_TRANSACTION_ACTION,
|
|
824
|
+
KEY_BILLING_TRANSACTION_AMOUNT,
|
|
721
825
|
KEY_BILLING_TRANSACTION_BILLING_TRANSACTION_ID,
|
|
722
826
|
KEY_BILLING_TRANSACTION_COMPLETED_ON,
|
|
723
827
|
KEY_BILLING_TRANSACTION_CREATED_ON,
|
|
828
|
+
KEY_BILLING_TRANSACTION_PRICE,
|
|
724
829
|
KEY_BILLING_TRANSACTION_PRODUCT_REFERENCE,
|
|
725
830
|
KEY_BILLING_TRANSACTION_PRODUCT_TYPE,
|
|
726
831
|
KEY_BILLING_TRANSACTION_STATUS,
|
|
832
|
+
KEY_BILLING_TRANSACTION_TAX_AMOUNT,
|
|
833
|
+
KEY_BILLING_TRANSACTION_TAX_RATE,
|
|
727
834
|
KEY_BILLING_TRANSACTION_UPDATED_ON,
|
|
728
835
|
] as const satisfies (keyof BillingTransaction)[];
|
|
729
836
|
|
|
@@ -881,57 +988,6 @@ export const KEYS_BODY_ISSUE_ORGANIZATION_TOKEN_V1_AUTH_TOKEN_POST = [
|
|
|
881
988
|
KEY_BODY_ISSUE_ORGANIZATION_TOKEN_V1_AUTH_TOKEN_POST_USERNAME,
|
|
882
989
|
] as const satisfies (keyof Body_issue_organization_token_v1_auth_token_post)[];
|
|
883
990
|
|
|
884
|
-
/**
|
|
885
|
-
* Return Url
|
|
886
|
-
*
|
|
887
|
-
* Return URL that will be used
|
|
888
|
-
*
|
|
889
|
-
* @type {string}
|
|
890
|
-
*
|
|
891
|
-
*
|
|
892
|
-
* @remarks
|
|
893
|
-
* This key constant provides type-safe access to the `return_url` property of CheckoutSessionRequest objects.
|
|
894
|
-
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
895
|
-
*
|
|
896
|
-
* @example
|
|
897
|
-
* ```typescript
|
|
898
|
-
* // Direct property access
|
|
899
|
-
* const value = checkoutsessionrequest[KEY_CHECKOUT_SESSION_REQUEST_RETURN_URL];
|
|
900
|
-
*
|
|
901
|
-
* // Dynamic property access
|
|
902
|
-
* const propertyName = KEY_CHECKOUT_SESSION_REQUEST_RETURN_URL;
|
|
903
|
-
* const value = checkoutsessionrequest[propertyName];
|
|
904
|
-
* ```
|
|
905
|
-
*
|
|
906
|
-
* @see {@link CheckoutSessionRequest} - The TypeScript type definition
|
|
907
|
-
* @see {@link KEYS_CHECKOUT_SESSION_REQUEST} - Array of all keys for this type
|
|
908
|
-
*/
|
|
909
|
-
export const KEY_CHECKOUT_SESSION_REQUEST_RETURN_URL = 'return_url' as keyof CheckoutSessionRequest;
|
|
910
|
-
|
|
911
|
-
/**
|
|
912
|
-
* Array of all CheckoutSessionRequest property keys
|
|
913
|
-
*
|
|
914
|
-
* @remarks
|
|
915
|
-
* This constant provides a readonly array containing all valid property keys for CheckoutSessionRequest objects.
|
|
916
|
-
* Useful for iteration, validation, and generating dynamic UI components.
|
|
917
|
-
*
|
|
918
|
-
* @example
|
|
919
|
-
* ```typescript
|
|
920
|
-
* // Iterating through all keys
|
|
921
|
-
* for (const key of KEYS_CHECKOUT_SESSION_REQUEST) {
|
|
922
|
-
* console.log(`Property: ${key}, Value: ${checkoutsessionrequest[key]}`);
|
|
923
|
-
* }
|
|
924
|
-
*
|
|
925
|
-
* // Validation
|
|
926
|
-
* const isValidKey = KEYS_CHECKOUT_SESSION_REQUEST.includes(someKey);
|
|
927
|
-
* ```
|
|
928
|
-
*
|
|
929
|
-
* @see {@link CheckoutSessionRequest} - The TypeScript type definition
|
|
930
|
-
*/
|
|
931
|
-
export const KEYS_CHECKOUT_SESSION_REQUEST = [
|
|
932
|
-
KEY_CHECKOUT_SESSION_REQUEST_RETURN_URL,
|
|
933
|
-
] as const satisfies (keyof CheckoutSessionRequest)[];
|
|
934
|
-
|
|
935
991
|
/**
|
|
936
992
|
* Session Client Secret
|
|
937
993
|
*
|
package/src/openapi.yaml
CHANGED
|
@@ -114,6 +114,10 @@ components:
|
|
|
114
114
|
action:
|
|
115
115
|
$ref: '#/components/schemas/BillingTransactionAction'
|
|
116
116
|
description: The action performed in the transaction
|
|
117
|
+
amount:
|
|
118
|
+
description: The amount of the transaction including VAT
|
|
119
|
+
title: Amount
|
|
120
|
+
type: string
|
|
117
121
|
billing_transaction_id:
|
|
118
122
|
examples:
|
|
119
123
|
- billing_transaction_01h45ytscbebyvny4gc8cr8ma2
|
|
@@ -134,6 +138,10 @@ components:
|
|
|
134
138
|
format: date-time
|
|
135
139
|
title: Created On
|
|
136
140
|
type: string
|
|
141
|
+
price:
|
|
142
|
+
description: The price of the product without sales tax
|
|
143
|
+
title: Price
|
|
144
|
+
type: string
|
|
137
145
|
product_reference:
|
|
138
146
|
anyOf:
|
|
139
147
|
- minLength: 1
|
|
@@ -148,6 +156,14 @@ components:
|
|
|
148
156
|
$ref: '#/components/schemas/BillingTransactionStatus'
|
|
149
157
|
default: pending
|
|
150
158
|
description: The status of the transaction
|
|
159
|
+
tax_amount:
|
|
160
|
+
description: The tax amount of the transaction
|
|
161
|
+
title: Tax Amount
|
|
162
|
+
type: string
|
|
163
|
+
tax_rate:
|
|
164
|
+
description: The tax rate of the transaction
|
|
165
|
+
title: Tax Rate
|
|
166
|
+
type: string
|
|
151
167
|
updated_on:
|
|
152
168
|
description: The date/time the transaction was updated
|
|
153
169
|
format: date-time
|
|
@@ -157,6 +173,10 @@ components:
|
|
|
157
173
|
- product_type
|
|
158
174
|
- product_reference
|
|
159
175
|
- action
|
|
176
|
+
- amount
|
|
177
|
+
- price
|
|
178
|
+
- tax_rate
|
|
179
|
+
- tax_amount
|
|
160
180
|
title: BillingTransactionResponse
|
|
161
181
|
type: object
|
|
162
182
|
BillingTransactionSortField:
|
|
@@ -213,13 +233,7 @@ components:
|
|
|
213
233
|
title: Body_issue_organization_token_v1_auth_token_post
|
|
214
234
|
type: object
|
|
215
235
|
CheckoutSessionRequest:
|
|
216
|
-
properties:
|
|
217
|
-
return_url:
|
|
218
|
-
description: Return URL that will be used
|
|
219
|
-
title: Return Url
|
|
220
|
-
type: string
|
|
221
|
-
required:
|
|
222
|
-
- return_url
|
|
236
|
+
properties: {}
|
|
223
237
|
title: CheckoutSessionRequest
|
|
224
238
|
type: object
|
|
225
239
|
CheckoutSessionResponse:
|
|
@@ -5196,7 +5210,7 @@ info:
|
|
|
5196
5210
|
'
|
|
5197
5211
|
summary: OpusDNS - your gateway to a seamless domain management experience.
|
|
5198
5212
|
title: OpusDNS API
|
|
5199
|
-
version: 2025-09-29-
|
|
5213
|
+
version: 2025-09-29-110334
|
|
5200
5214
|
x-logo:
|
|
5201
5215
|
altText: OpusDNS API Reference
|
|
5202
5216
|
url: https://d24lr4zqs1tgqh.cloudfront.net/c9505a20-5ae1-406c-b060-d392569caebf.jpg
|
package/src/schema.d.ts
CHANGED
|
@@ -1385,6 +1385,11 @@ export interface components {
|
|
|
1385
1385
|
BillingTransactionResponse: {
|
|
1386
1386
|
/** @description The action performed in the transaction */
|
|
1387
1387
|
action: components["schemas"]["BillingTransactionAction"];
|
|
1388
|
+
/**
|
|
1389
|
+
* Amount
|
|
1390
|
+
* @description The amount of the transaction including VAT
|
|
1391
|
+
*/
|
|
1392
|
+
amount: string;
|
|
1388
1393
|
/**
|
|
1389
1394
|
* Billing Transaction Id
|
|
1390
1395
|
* Format: typeid
|
|
@@ -1401,6 +1406,11 @@ export interface components {
|
|
|
1401
1406
|
* @description The date/time the transaction was created
|
|
1402
1407
|
*/
|
|
1403
1408
|
created_on?: Date;
|
|
1409
|
+
/**
|
|
1410
|
+
* Price
|
|
1411
|
+
* @description The price of the product without sales tax
|
|
1412
|
+
*/
|
|
1413
|
+
price: string;
|
|
1404
1414
|
/**
|
|
1405
1415
|
* Product Reference
|
|
1406
1416
|
* @description The reference of the product
|
|
@@ -1413,6 +1423,16 @@ export interface components {
|
|
|
1413
1423
|
* @default pending
|
|
1414
1424
|
*/
|
|
1415
1425
|
status: components["schemas"]["BillingTransactionStatus"];
|
|
1426
|
+
/**
|
|
1427
|
+
* Tax Amount
|
|
1428
|
+
* @description The tax amount of the transaction
|
|
1429
|
+
*/
|
|
1430
|
+
tax_amount: string;
|
|
1431
|
+
/**
|
|
1432
|
+
* Tax Rate
|
|
1433
|
+
* @description The tax rate of the transaction
|
|
1434
|
+
*/
|
|
1435
|
+
tax_rate: string;
|
|
1416
1436
|
/**
|
|
1417
1437
|
* Updated On
|
|
1418
1438
|
* Format: date-time
|
|
@@ -1456,13 +1476,7 @@ export interface components {
|
|
|
1456
1476
|
username?: string | null;
|
|
1457
1477
|
};
|
|
1458
1478
|
/** CheckoutSessionRequest */
|
|
1459
|
-
CheckoutSessionRequest:
|
|
1460
|
-
/**
|
|
1461
|
-
* Return Url
|
|
1462
|
-
* @description Return URL that will be used
|
|
1463
|
-
*/
|
|
1464
|
-
return_url: string;
|
|
1465
|
-
};
|
|
1479
|
+
CheckoutSessionRequest: Record<string, never>;
|
|
1466
1480
|
/** CheckoutSessionResponse */
|
|
1467
1481
|
CheckoutSessionResponse: {
|
|
1468
1482
|
/**
|