@opusdns/api 0.70.0 → 0.72.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 CHANGED
@@ -8,7 +8,7 @@
8
8
  "typescript": "^5.8.2"
9
9
  },
10
10
  "name": "@opusdns/api",
11
- "version": "0.70.0",
11
+ "version": "0.72.0",
12
12
  "description": "TypeScript types for the OpusDNS OpenAPI specification",
13
13
  "main": "./src/index.ts",
14
14
  "module": "./src/index.ts",
@@ -518,6 +518,32 @@ export const KEYS_BILLING_PLAN = [
518
518
  * @see {@link KEYS_BILLING_TRANSACTION} - Array of all keys for this type
519
519
  */
520
520
  export const KEY_BILLING_TRANSACTION_ACTION = 'action' as keyof BillingTransaction;
521
+ /**
522
+ * Amount
523
+ *
524
+ * The amount of the transaction including VAT
525
+ *
526
+ * @type {string}
527
+ *
528
+ *
529
+ * @remarks
530
+ * This key constant provides type-safe access to the `amount` property of BillingTransaction objects.
531
+ * Use this constant when you need to access properties dynamically or ensure type safety.
532
+ *
533
+ * @example
534
+ * ```typescript
535
+ * // Direct property access
536
+ * const value = billingtransaction[KEY_BILLING_TRANSACTION_AMOUNT];
537
+ *
538
+ * // Dynamic property access
539
+ * const propertyName = KEY_BILLING_TRANSACTION_AMOUNT;
540
+ * const value = billingtransaction[propertyName];
541
+ * ```
542
+ *
543
+ * @see {@link BillingTransaction} - The TypeScript type definition
544
+ * @see {@link KEYS_BILLING_TRANSACTION} - Array of all keys for this type
545
+ */
546
+ export const KEY_BILLING_TRANSACTION_AMOUNT = 'amount' as keyof BillingTransaction;
521
547
  /**
522
548
  * Billing Transaction Id
523
549
  *
@@ -594,6 +620,32 @@ export const KEY_BILLING_TRANSACTION_COMPLETED_ON = 'completed_on' as keyof Bill
594
620
  * @see {@link KEYS_BILLING_TRANSACTION} - Array of all keys for this type
595
621
  */
596
622
  export const KEY_BILLING_TRANSACTION_CREATED_ON = 'created_on' as keyof BillingTransaction;
623
+ /**
624
+ * Price
625
+ *
626
+ * The price of the product without sales tax
627
+ *
628
+ * @type {string}
629
+ *
630
+ *
631
+ * @remarks
632
+ * This key constant provides type-safe access to the `price` property of BillingTransaction objects.
633
+ * Use this constant when you need to access properties dynamically or ensure type safety.
634
+ *
635
+ * @example
636
+ * ```typescript
637
+ * // Direct property access
638
+ * const value = billingtransaction[KEY_BILLING_TRANSACTION_PRICE];
639
+ *
640
+ * // Dynamic property access
641
+ * const propertyName = KEY_BILLING_TRANSACTION_PRICE;
642
+ * const value = billingtransaction[propertyName];
643
+ * ```
644
+ *
645
+ * @see {@link BillingTransaction} - The TypeScript type definition
646
+ * @see {@link KEYS_BILLING_TRANSACTION} - Array of all keys for this type
647
+ */
648
+ export const KEY_BILLING_TRANSACTION_PRICE = 'price' as keyof BillingTransaction;
597
649
  /**
598
650
  * Product Reference
599
651
  *
@@ -669,6 +721,58 @@ export const KEY_BILLING_TRANSACTION_PRODUCT_TYPE = 'product_type' as keyof Bill
669
721
  * @see {@link KEYS_BILLING_TRANSACTION} - Array of all keys for this type
670
722
  */
671
723
  export const KEY_BILLING_TRANSACTION_STATUS = 'status' as keyof BillingTransaction;
724
+ /**
725
+ * Tax Amount
726
+ *
727
+ * The tax amount of the transaction
728
+ *
729
+ * @type {string}
730
+ *
731
+ *
732
+ * @remarks
733
+ * This key constant provides type-safe access to the `tax_amount` property of BillingTransaction objects.
734
+ * Use this constant when you need to access properties dynamically or ensure type safety.
735
+ *
736
+ * @example
737
+ * ```typescript
738
+ * // Direct property access
739
+ * const value = billingtransaction[KEY_BILLING_TRANSACTION_TAX_AMOUNT];
740
+ *
741
+ * // Dynamic property access
742
+ * const propertyName = KEY_BILLING_TRANSACTION_TAX_AMOUNT;
743
+ * const value = billingtransaction[propertyName];
744
+ * ```
745
+ *
746
+ * @see {@link BillingTransaction} - The TypeScript type definition
747
+ * @see {@link KEYS_BILLING_TRANSACTION} - Array of all keys for this type
748
+ */
749
+ export const KEY_BILLING_TRANSACTION_TAX_AMOUNT = 'tax_amount' as keyof BillingTransaction;
750
+ /**
751
+ * Tax Rate
752
+ *
753
+ * The tax rate of the transaction
754
+ *
755
+ * @type {string}
756
+ *
757
+ *
758
+ * @remarks
759
+ * This key constant provides type-safe access to the `tax_rate` property of BillingTransaction objects.
760
+ * Use this constant when you need to access properties dynamically or ensure type safety.
761
+ *
762
+ * @example
763
+ * ```typescript
764
+ * // Direct property access
765
+ * const value = billingtransaction[KEY_BILLING_TRANSACTION_TAX_RATE];
766
+ *
767
+ * // Dynamic property access
768
+ * const propertyName = KEY_BILLING_TRANSACTION_TAX_RATE;
769
+ * const value = billingtransaction[propertyName];
770
+ * ```
771
+ *
772
+ * @see {@link BillingTransaction} - The TypeScript type definition
773
+ * @see {@link KEYS_BILLING_TRANSACTION} - Array of all keys for this type
774
+ */
775
+ export const KEY_BILLING_TRANSACTION_TAX_RATE = 'tax_rate' as keyof BillingTransaction;
672
776
  /**
673
777
  * Updated On
674
778
  *
@@ -718,12 +822,16 @@ export const KEY_BILLING_TRANSACTION_UPDATED_ON = 'updated_on' as keyof BillingT
718
822
  */
719
823
  export const KEYS_BILLING_TRANSACTION = [
720
824
  KEY_BILLING_TRANSACTION_ACTION,
825
+ KEY_BILLING_TRANSACTION_AMOUNT,
721
826
  KEY_BILLING_TRANSACTION_BILLING_TRANSACTION_ID,
722
827
  KEY_BILLING_TRANSACTION_COMPLETED_ON,
723
828
  KEY_BILLING_TRANSACTION_CREATED_ON,
829
+ KEY_BILLING_TRANSACTION_PRICE,
724
830
  KEY_BILLING_TRANSACTION_PRODUCT_REFERENCE,
725
831
  KEY_BILLING_TRANSACTION_PRODUCT_TYPE,
726
832
  KEY_BILLING_TRANSACTION_STATUS,
833
+ KEY_BILLING_TRANSACTION_TAX_AMOUNT,
834
+ KEY_BILLING_TRANSACTION_TAX_RATE,
727
835
  KEY_BILLING_TRANSACTION_UPDATED_ON,
728
836
  ] as const satisfies (keyof BillingTransaction)[];
729
837
 
@@ -1248,7 +1248,7 @@ export type GET_DomainSearchSuggest_Request_Query = GET_DomainSearchSuggest_Requ
1248
1248
  * Use this type to ensure type safety when making API requests to this endpoint.
1249
1249
  *
1250
1250
  * @path /v1/domains
1251
- * @param statuses (query) - Filter domains by registry status. Can be specified multiple times (union of all provided values).
1251
+ * @param registry_statuses (query) - Filter domains by registry status. Can be specified multiple times (union of all provided values).
1252
1252
  *
1253
1253
  * @see {@link GET_Domains_Request_Query} - Query parameters type
1254
1254
  * @see {@link GET_Domains_Request_Path} - Path parameters type
@@ -1270,7 +1270,7 @@ export type GET_Domains_Request = {
1270
1270
  * Use this type to ensure type safety for query parameters.
1271
1271
  *
1272
1272
  * @path /v1/domains
1273
- * @param statuses (query) - Filter domains by registry status. Can be specified multiple times (union of all provided values).
1273
+ * @param registry_statuses (query) - Filter domains by registry status. Can be specified multiple times (union of all provided values).
1274
1274
  */
1275
1275
  export type GET_Domains_Request_Query = GET_Domains_Request['parameters']['query'];
1276
1276
 
@@ -2120,7 +2120,7 @@ export type GET_DomainSearchSuggest_Response_502 = Problem
2120
2120
 
2121
2121
  *
2122
2122
  * @path /v1/domains
2123
- * @param statuses (query) - Filter domains by registry status. Can be specified multiple times (union of all provided values).
2123
+ * @param registry_statuses (query) - Filter domains by registry status. Can be specified multiple times (union of all provided values).
2124
2124
  *
2125
2125
  * @see {@link GET_Domains_Response_200} - 200 response type
2126
2126
  * @see {@link GET_Domains_Response_422} - 422 response type
@@ -2140,7 +2140,7 @@ export type GET_Domains_Response = GET_Domains_Response_200 | GET_Domains_Respon
2140
2140
 
2141
2141
  *
2142
2142
  * @path /v1/domains
2143
- * @param statuses (query) - Filter domains by registry status. Can be specified multiple times (union of all provided values).
2143
+ * @param registry_statuses (query) - Filter domains by registry status. Can be specified multiple times (union of all provided values).
2144
2144
  *
2145
2145
  * @see {@link GET_Domains_Response} - The main response type definition
2146
2146
  * @see {@link Pagination_Domain} - The actual schema type definition
@@ -2158,7 +2158,7 @@ export type GET_Domains_Response_200 = Pagination_Domain
2158
2158
 
2159
2159
  *
2160
2160
  * @path /v1/domains
2161
- * @param statuses (query) - Filter domains by registry status. Can be specified multiple times (union of all provided values).
2161
+ * @param registry_statuses (query) - Filter domains by registry status. Can be specified multiple times (union of all provided values).
2162
2162
  *
2163
2163
  * @see {@link GET_Domains_Response} - The main response type definition
2164
2164
  * @see {@link HTTPValidationError} - The actual schema type definition
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:
@@ -5196,7 +5216,7 @@ info:
5196
5216
  '
5197
5217
  summary: OpusDNS - your gateway to a seamless domain management experience.
5198
5218
  title: OpusDNS API
5199
- version: 2025-09-29-074010
5219
+ version: 2025-09-29-103012
5200
5220
  x-logo:
5201
5221
  altText: OpusDNS API Reference
5202
5222
  url: https://d24lr4zqs1tgqh.cloudfront.net/c9505a20-5ae1-406c-b060-d392569caebf.jpg
@@ -6962,7 +6982,7 @@ paths:
6962
6982
  - description: Filter domains by registry status. Can be specified multiple
6963
6983
  times (union of all provided values).
6964
6984
  in: query
6965
- name: statuses
6985
+ name: registry_statuses
6966
6986
  required: false
6967
6987
  schema:
6968
6988
  anyOf:
@@ -6972,7 +6992,7 @@ paths:
6972
6992
  - type: 'null'
6973
6993
  description: Filter domains by registry status. Can be specified multiple
6974
6994
  times (union of all provided values).
6975
- title: Statuses
6995
+ title: Registry Statuses
6976
6996
  - in: query
6977
6997
  name: page
6978
6998
  required: false
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
@@ -6264,7 +6284,7 @@ export interface operations {
6264
6284
  registered_after?: Date | null;
6265
6285
  registered_before?: Date | null;
6266
6286
  /** @description Filter domains by registry status. Can be specified multiple times (union of all provided values). */
6267
- statuses?: string[] | null;
6287
+ registry_statuses?: string[] | null;
6268
6288
  page?: number;
6269
6289
  page_size?: number;
6270
6290
  };