@opusdns/api 0.61.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 CHANGED
@@ -8,7 +8,7 @@
8
8
  "typescript": "^5.8.2"
9
9
  },
10
10
  "name": "@opusdns/api",
11
- "version": "0.61.0",
11
+ "version": "0.62.0",
12
12
  "description": "TypeScript types for the OpusDNS OpenAPI specification",
13
13
  "main": "./src/index.ts",
14
14
  "module": "./src/index.ts",
@@ -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
  *
@@ -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';
@@ -484,6 +485,240 @@ export const KEYS_BILLING_PLAN = [
484
485
  KEY_BILLING_PLAN_TYPE,
485
486
  ] as const satisfies (keyof BillingPlan)[];
486
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
+
487
722
  /**
488
723
  * Client Id
489
724
  *
@@ -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
  *
@@ -34,7 +34,7 @@
34
34
 
35
35
  import { DomainDnssecDataArray, OrganizationAttribute2Array, IpRestrictionArray, TldResponseShortArray } from './schemas-arrays.d';
36
36
 
37
- import { Pagination_OrganizationCredential, Problem, HTTPValidationError, OrganizationCredentialCreated, DomainAvailabilityList, Pagination_ContactSchema, ContactSchema, ContactVerification, Contact, Pagination_DnsZone, DnsZone, DnsChanges, DnsZoneSummary, DomainSearch, Pagination_Domain, Domain, DomainRenew, DomainRestore, DomainCheck, DomainSummary, Pagination_EmailForwardAlias, EmailForwardAlias, Pagination_Event, EventSchema, Pagination_Organization, Organization, OrganizationWithBillingData, GetCurrentAvailablePlans, GetPrices, IpRestriction, Pagination_User, TldSpecification, User, UserWithAttributes, PermissionSet, RelationSet, UserWithRelationPermissions } from './schemas.d';
37
+ import { Pagination_OrganizationCredential, Problem, HTTPValidationError, OrganizationCredentialCreated, DomainAvailabilityList, Pagination_ContactSchema, ContactSchema, ContactVerification, Contact, Pagination_DnsZone, DnsZone, DnsChanges, DnsZoneSummary, DomainSearch, Pagination_Domain, Domain, DomainRenew, DomainRestore, DomainCheck, DomainSummary, Pagination_EmailForwardAlias, EmailForwardAlias, Pagination_Event, EventSchema, Pagination_Organization, Organization, OrganizationWithBillingData, GetCurrentAvailablePlans, 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 GET AuthClientCredentials endpoint
@@ -4461,6 +4461,116 @@ export type GET_OrganizationsByOrganizationIdPricingProductTypeByProductType_Res
4461
4461
  */
4462
4462
  export type GET_OrganizationsByOrganizationIdPricingProductTypeByProductType_Response_422 = HTTPValidationError
4463
4463
 
4464
+ /**
4465
+ * Response types for GET OrganizationsByOrganizationIdTransactions endpoint
4466
+ *
4467
+ * Get transactions for an organization
4468
+ *
4469
+ * @remarks
4470
+ * This type defines all possible response structures for the GET OrganizationsByOrganizationIdTransactions endpoint.
4471
+ * Each response code maps to a specific response type as defined in the OpenAPI specification.
4472
+ * Use this type to ensure type safety when handling API responses from this endpoint.
4473
+ *
4474
+
4475
+ *
4476
+ * @path /v1/organizations/{organization_id}/transactions
4477
+ *
4478
+ * @see {@link GET_OrganizationsByOrganizationIdTransactions_Response_200} - 200 response type
4479
+ * @see {@link GET_OrganizationsByOrganizationIdTransactions_Response_422} - 422 response type
4480
+ *
4481
+
4482
+ */
4483
+ export type GET_OrganizationsByOrganizationIdTransactions_Response = GET_OrganizationsByOrganizationIdTransactions_Response_200 | GET_OrganizationsByOrganizationIdTransactions_Response_422;
4484
+
4485
+ /**
4486
+ * 200 response for GET OrganizationsByOrganizationIdTransactions endpoint
4487
+ *
4488
+ * @remarks
4489
+ * This type defines the response structure for the 200 status code
4490
+ * of the GET OrganizationsByOrganizationIdTransactions endpoint.
4491
+ * It provides type safety for handling this specific response as defined in the OpenAPI specification.
4492
+ *
4493
+
4494
+ *
4495
+ * @path /v1/organizations/{organization_id}/transactions
4496
+ *
4497
+ * @see {@link GET_OrganizationsByOrganizationIdTransactions_Response} - The main response type definition
4498
+ * @see {@link Pagination_BillingTransaction} - The actual schema type definition
4499
+ */
4500
+ export type GET_OrganizationsByOrganizationIdTransactions_Response_200 = Pagination_BillingTransaction
4501
+
4502
+ /**
4503
+ * 422 response for GET OrganizationsByOrganizationIdTransactions endpoint
4504
+ *
4505
+ * @remarks
4506
+ * This type defines the response structure for the 422 status code
4507
+ * of the GET OrganizationsByOrganizationIdTransactions endpoint.
4508
+ * It provides type safety for handling this specific response as defined in the OpenAPI specification.
4509
+ *
4510
+
4511
+ *
4512
+ * @path /v1/organizations/{organization_id}/transactions
4513
+ *
4514
+ * @see {@link GET_OrganizationsByOrganizationIdTransactions_Response} - The main response type definition
4515
+ * @see {@link HTTPValidationError} - The actual schema type definition
4516
+ */
4517
+ export type GET_OrganizationsByOrganizationIdTransactions_Response_422 = HTTPValidationError
4518
+
4519
+ /**
4520
+ * Response types for GET OrganizationsByOrganizationIdTransactionsByTransactionId endpoint
4521
+ *
4522
+ * Get a specific transaction for an organization
4523
+ *
4524
+ * @remarks
4525
+ * This type defines all possible response structures for the GET OrganizationsByOrganizationIdTransactionsByTransactionId endpoint.
4526
+ * Each response code maps to a specific response type as defined in the OpenAPI specification.
4527
+ * Use this type to ensure type safety when handling API responses from this endpoint.
4528
+ *
4529
+
4530
+ *
4531
+ * @path /v1/organizations/{organization_id}/transactions/{transaction_id}
4532
+ *
4533
+ * @see {@link GET_OrganizationsByOrganizationIdTransactionsByTransactionId_Response_200} - 200 response type
4534
+ * @see {@link GET_OrganizationsByOrganizationIdTransactionsByTransactionId_Response_422} - 422 response type
4535
+ *
4536
+
4537
+ */
4538
+ export type GET_OrganizationsByOrganizationIdTransactionsByTransactionId_Response = GET_OrganizationsByOrganizationIdTransactionsByTransactionId_Response_200 | GET_OrganizationsByOrganizationIdTransactionsByTransactionId_Response_422;
4539
+
4540
+ /**
4541
+ * 200 response for GET OrganizationsByOrganizationIdTransactionsByTransactionId endpoint
4542
+ *
4543
+ * @remarks
4544
+ * This type defines the response structure for the 200 status code
4545
+ * of the GET OrganizationsByOrganizationIdTransactionsByTransactionId endpoint.
4546
+ * It provides type safety for handling this specific response as defined in the OpenAPI specification.
4547
+ *
4548
+
4549
+ *
4550
+ * @path /v1/organizations/{organization_id}/transactions/{transaction_id}
4551
+ *
4552
+ * @see {@link GET_OrganizationsByOrganizationIdTransactionsByTransactionId_Response} - The main response type definition
4553
+ * @see {@link BillingTransaction} - The actual schema type definition
4554
+ */
4555
+ export type GET_OrganizationsByOrganizationIdTransactionsByTransactionId_Response_200 = BillingTransaction
4556
+
4557
+ /**
4558
+ * 422 response for GET OrganizationsByOrganizationIdTransactionsByTransactionId endpoint
4559
+ *
4560
+ * @remarks
4561
+ * This type defines the response structure for the 422 status code
4562
+ * of the GET OrganizationsByOrganizationIdTransactionsByTransactionId endpoint.
4563
+ * It provides type safety for handling this specific response as defined in the OpenAPI specification.
4564
+ *
4565
+
4566
+ *
4567
+ * @path /v1/organizations/{organization_id}/transactions/{transaction_id}
4568
+ *
4569
+ * @see {@link GET_OrganizationsByOrganizationIdTransactionsByTransactionId_Response} - The main response type definition
4570
+ * @see {@link HTTPValidationError} - The actual schema type definition
4571
+ */
4572
+ export type GET_OrganizationsByOrganizationIdTransactionsByTransactionId_Response_422 = HTTPValidationError
4573
+
4464
4574
  /**
4465
4575
  * Response types for GET OrganizationsIpRestrictions endpoint
4466
4576
  *
@@ -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, PostalAddressType, ContactConfigBase, DnsChange, DnsRecordCreate, DnsRecord, DnsRrsetCreate, DnsRecordPatchOp, DnsRrset, DnsRrsetPatchOp, DomainAvailabilityCheck, ContactHandle, Nameserver, DeletePolicyType, SyncOperationType, DomainContact, DomainSearchSuggestionWithPrice, DomainStatus, DomainClientStatus, PlanInfo, PriceInfo, ValidationError, LaunchPhaseBase, LocalPresenceRequirementType, ContactRoleType, OrganizationAttribute2, User, OrganizationAttributeCreate, UserCreate, ContactSchema, DnsZone, Domain, EmailForwardAlias, EventResponse, OrganizationCredential, Organization, Period, Permission, PremiumAffectsType, Relation, UserAgreementAcceptance, TldBase, PostTransferRequirements, UserAttributeBase, DomainAvailability } from './schemas.d';
24
+ import { DomainDnssecData, DomainDnssecDataCreate, OrganizationAttribute, OrganizationAttributeUpdate, IpRestriction, TldResponseShort, PostalAddressType, ContactConfigBase, DnsChange, DnsRecordCreate, DnsRecord, DnsRrsetCreate, DnsRecordPatchOp, DnsRrset, DnsRrsetPatchOp, DomainAvailabilityCheck, ContactHandle, Nameserver, DeletePolicyType, SyncOperationType, DomainContact, DomainSearchSuggestionWithPrice, DomainStatus, DomainClientStatus, PlanInfo, PriceInfo, ValidationError, LaunchPhaseBase, LocalPresenceRequirementType, ContactRoleType, OrganizationAttribute2, User, OrganizationAttributeCreate, UserCreate, BillingTransaction, ContactSchema, DnsZone, Domain, EmailForwardAlias, EventResponse, OrganizationCredential, Organization, Period, Permission, PremiumAffectsType, Relation, UserAgreementAcceptance, TldBase, PostTransferRequirements, UserAttributeBase, DomainAvailability } from './schemas.d';
25
25
 
26
26
  /**
27
27
  * DomainDnssecDataResponse
@@ -499,6 +499,20 @@ export type OrganizationAttributeCreateArray = OrganizationAttributeCreate[];
499
499
  * @see {@link UserCreate} - The individual UserCreate type definition
500
500
  */
501
501
  export type UserCreateArray = UserCreate[];
502
+ /**
503
+ * BillingTransactionResponse
504
+ *
505
+ * @remarks
506
+ * Array type for BillingTransactionResponse objects. Used when the API returns a collection of BillingTransactionResponse instances.
507
+ *
508
+ * @example
509
+ * ```typescript
510
+ * const items: BillingTransactionArray = await api.getBillingTransactions();
511
+ * ```
512
+ *
513
+ * @see {@link BillingTransaction} - The individual BillingTransactionResponse type definition
514
+ */
515
+ export type BillingTransactionArray = BillingTransaction[];
502
516
  /**
503
517
  * ContactSchema
504
518
  *
@@ -138,6 +138,54 @@ export type BillingTransactionAction = components['schemas']['BillingTransaction
138
138
  * @see {@link components} - The OpenAPI components schema definition
139
139
  */
140
140
  export type BillingTransactionProductType = components['schemas']['BillingTransactionProductType'];
141
+ /**
142
+ * BillingTransactionResponse
143
+ *
144
+ * @remarks
145
+ * Type alias for the `BillingTransactionResponse` OpenAPI schema.
146
+ * This type represents billingtransactionresponse data structures used in API requests and responses.
147
+ *
148
+ * @example
149
+ * ```typescript
150
+ * const response = await api.getBillingTransaction();
151
+ * const item: BillingTransaction = response.results;
152
+ * ```
153
+ *
154
+ * @see {@link components} - The OpenAPI components schema definition
155
+ */
156
+ export type BillingTransaction = components['schemas']['BillingTransactionResponse'];
157
+ /**
158
+ * BillingTransactionSortField
159
+ *
160
+ * @remarks
161
+ * Type alias for the `BillingTransactionSortField` OpenAPI schema.
162
+ * This type represents billingtransactionsortfield data structures used in API requests and responses.
163
+ *
164
+ * @example
165
+ * ```typescript
166
+ * const response = await api.getBillingTransactionSortField();
167
+ * const item: BillingTransactionSortField = response.results;
168
+ * ```
169
+ *
170
+ * @see {@link components} - The OpenAPI components schema definition
171
+ */
172
+ export type BillingTransactionSortField = components['schemas']['BillingTransactionSortField'];
173
+ /**
174
+ * BillingTransactionStatus
175
+ *
176
+ * @remarks
177
+ * Type alias for the `BillingTransactionStatus` OpenAPI schema.
178
+ * This type represents billingtransactionstatus data structures used in API requests and responses.
179
+ *
180
+ * @example
181
+ * ```typescript
182
+ * const response = await api.getBillingTransactionStatus();
183
+ * const item: BillingTransactionStatus = response.results;
184
+ * ```
185
+ *
186
+ * @see {@link components} - The OpenAPI components schema definition
187
+ */
188
+ export type BillingTransactionStatus = components['schemas']['BillingTransactionStatus'];
141
189
  /**
142
190
  * Body_issue_organization_token_v1_auth_token_post
143
191
  *
@@ -1903,6 +1951,22 @@ export type OrganizationWithBillingData = components['schemas']['OrganizationWit
1903
1951
  * @see {@link components} - The OpenAPI components schema definition
1904
1952
  */
1905
1953
  export type PaginationMetadata = components['schemas']['PaginationMetadata'];
1954
+ /**
1955
+ * Pagination[BillingTransactionResponse]
1956
+ *
1957
+ * @remarks
1958
+ * Type alias for the `Pagination_BillingTransactionResponse_` OpenAPI schema.
1959
+ * This type represents pagination[billingtransactionresponse] data structures used in API requests and responses.
1960
+ *
1961
+ * @example
1962
+ * ```typescript
1963
+ * const response = await api.getPagination_BillingTransaction();
1964
+ * const item: Pagination_BillingTransaction = response.results;
1965
+ * ```
1966
+ *
1967
+ * @see {@link components} - The OpenAPI components schema definition
1968
+ */
1969
+ export type Pagination_BillingTransaction = components['schemas']['Pagination_BillingTransactionResponse_'];
1906
1970
  /**
1907
1971
  * Pagination[ContactSchema]
1908
1972
  *
package/src/openapi.yaml CHANGED
@@ -101,6 +101,73 @@ components:
101
101
  - domain_forward
102
102
  title: BillingTransactionProductType
103
103
  type: string
104
+ BillingTransactionResponse:
105
+ properties:
106
+ action:
107
+ $ref: '#/components/schemas/BillingTransactionAction'
108
+ description: The action performed in the transaction
109
+ billing_transaction_id:
110
+ examples:
111
+ - billing_transaction_01h45ytscbebyvny4gc8cr8ma2
112
+ format: typeid
113
+ pattern: ^billing_transaction_[0-7][0-9a-hjkmnpq-tv-z]{25}$
114
+ title: Billing Transaction Id
115
+ type: string
116
+ x-typeid-prefix: billing_transaction
117
+ completed_on:
118
+ anyOf:
119
+ - format: date-time
120
+ type: string
121
+ - type: 'null'
122
+ description: The date/time the transaction completed
123
+ title: Completed On
124
+ created_on:
125
+ description: The date/time the transaction was created
126
+ format: date-time
127
+ title: Created On
128
+ type: string
129
+ product_reference:
130
+ anyOf:
131
+ - minLength: 1
132
+ type: string
133
+ - type: 'null'
134
+ description: The reference of the product
135
+ title: Product Reference
136
+ product_type:
137
+ $ref: '#/components/schemas/BillingTransactionProductType'
138
+ description: The type of product
139
+ status:
140
+ $ref: '#/components/schemas/BillingTransactionStatus'
141
+ default: pending
142
+ description: The status of the transaction
143
+ updated_on:
144
+ description: The date/time the transaction was updated
145
+ format: date-time
146
+ title: Updated On
147
+ type: string
148
+ required:
149
+ - product_type
150
+ - product_reference
151
+ - action
152
+ title: BillingTransactionResponse
153
+ type: object
154
+ BillingTransactionSortField:
155
+ enum:
156
+ - product_type
157
+ - action
158
+ - status
159
+ - created_on
160
+ - completed_on
161
+ title: BillingTransactionSortField
162
+ type: string
163
+ BillingTransactionStatus:
164
+ enum:
165
+ - pending
166
+ - succeeded
167
+ - failed
168
+ - canceled
169
+ title: BillingTransactionStatus
170
+ type: string
104
171
  Body_issue_organization_token_v1_auth_token_post:
105
172
  properties:
106
173
  client_id:
@@ -3444,6 +3511,20 @@ components:
3444
3511
  - has_previous_page
3445
3512
  title: PaginationMetadata
3446
3513
  type: object
3514
+ Pagination_BillingTransactionResponse_:
3515
+ properties:
3516
+ pagination:
3517
+ $ref: '#/components/schemas/PaginationMetadata'
3518
+ results:
3519
+ items:
3520
+ $ref: '#/components/schemas/BillingTransactionResponse'
3521
+ title: Results
3522
+ type: array
3523
+ required:
3524
+ - results
3525
+ - pagination
3526
+ title: Pagination[BillingTransactionResponse]
3527
+ type: object
3447
3528
  Pagination_ContactSchema_:
3448
3529
  properties:
3449
3530
  pagination:
@@ -4928,7 +5009,7 @@ info:
4928
5009
  '
4929
5010
  summary: OpusDNS - your gateway to a seamless domain management experience.
4930
5011
  title: OpusDNS API
4931
- version: 2025-09-22-215413
5012
+ version: 2025-09-24-153436
4932
5013
  x-logo:
4933
5014
  altText: OpusDNS API Reference
4934
5015
  url: https://d24lr4zqs1tgqh.cloudfront.net/c9505a20-5ae1-406c-b060-d392569caebf.jpg
@@ -8662,6 +8743,181 @@ paths:
8662
8743
  summary: Get Pricing Plans
8663
8744
  tags:
8664
8745
  - organization
8746
+ /v1/organizations/{organization_id}/transactions:
8747
+ get:
8748
+ operationId: get_transactions_v1_organizations__organization_id__transactions_get
8749
+ parameters:
8750
+ - in: path
8751
+ name: organization_id
8752
+ required: true
8753
+ schema:
8754
+ examples:
8755
+ - organization_01h45ytscbebyvny4gc8cr8ma2
8756
+ format: typeid
8757
+ pattern: ^organization_[0-7][0-9a-hjkmnpq-tv-z]{25}$
8758
+ title: Organization Id
8759
+ type: string
8760
+ x-typeid-prefix: organization
8761
+ - in: query
8762
+ name: sort_by
8763
+ required: false
8764
+ schema:
8765
+ $ref: '#/components/schemas/BillingTransactionSortField'
8766
+ default: created_on
8767
+ - in: query
8768
+ name: sort_order
8769
+ required: false
8770
+ schema:
8771
+ $ref: '#/components/schemas/SortOrder'
8772
+ default: desc
8773
+ - in: query
8774
+ name: product_reference
8775
+ required: false
8776
+ schema:
8777
+ anyOf:
8778
+ - minLength: 1
8779
+ type: string
8780
+ - type: 'null'
8781
+ title: Product Reference
8782
+ - in: query
8783
+ name: product_type
8784
+ required: false
8785
+ schema:
8786
+ anyOf:
8787
+ - $ref: '#/components/schemas/BillingTransactionProductType'
8788
+ - type: 'null'
8789
+ title: Product Type
8790
+ - in: query
8791
+ name: action
8792
+ required: false
8793
+ schema:
8794
+ anyOf:
8795
+ - $ref: '#/components/schemas/BillingTransactionAction'
8796
+ - type: 'null'
8797
+ title: Action
8798
+ - in: query
8799
+ name: status
8800
+ required: false
8801
+ schema:
8802
+ anyOf:
8803
+ - $ref: '#/components/schemas/BillingTransactionStatus'
8804
+ - type: 'null'
8805
+ title: Status
8806
+ - in: query
8807
+ name: created_after
8808
+ required: false
8809
+ schema:
8810
+ anyOf:
8811
+ - format: date-time
8812
+ type: string
8813
+ - type: 'null'
8814
+ title: Created After
8815
+ - in: query
8816
+ name: created_before
8817
+ required: false
8818
+ schema:
8819
+ anyOf:
8820
+ - format: date-time
8821
+ type: string
8822
+ - type: 'null'
8823
+ title: Created Before
8824
+ - in: query
8825
+ name: completed_after
8826
+ required: false
8827
+ schema:
8828
+ anyOf:
8829
+ - format: date-time
8830
+ type: string
8831
+ - type: 'null'
8832
+ title: Completed After
8833
+ - in: query
8834
+ name: completed_before
8835
+ required: false
8836
+ schema:
8837
+ anyOf:
8838
+ - format: date-time
8839
+ type: string
8840
+ - type: 'null'
8841
+ title: Completed Before
8842
+ - in: query
8843
+ name: page
8844
+ required: false
8845
+ schema:
8846
+ default: 1
8847
+ minimum: 1
8848
+ title: Page
8849
+ type: integer
8850
+ - in: query
8851
+ name: page_size
8852
+ required: false
8853
+ schema:
8854
+ default: 10
8855
+ maximum: 100
8856
+ minimum: 1
8857
+ title: Page Size
8858
+ type: integer
8859
+ responses:
8860
+ '200':
8861
+ content:
8862
+ application/json:
8863
+ schema:
8864
+ $ref: '#/components/schemas/Pagination_BillingTransactionResponse_'
8865
+ description: Successful Response
8866
+ '422':
8867
+ content:
8868
+ application/problem+json:
8869
+ schema:
8870
+ $ref: '#/components/schemas/HTTPValidationError'
8871
+ description: Validation Error
8872
+ security:
8873
+ - OAuth2PasswordBearer: []
8874
+ summary: Get transactions for an organization
8875
+ tags:
8876
+ - organization
8877
+ /v1/organizations/{organization_id}/transactions/{transaction_id}:
8878
+ get:
8879
+ operationId: get_transaction_v1_organizations__organization_id__transactions__transaction_id__get
8880
+ parameters:
8881
+ - in: path
8882
+ name: organization_id
8883
+ required: true
8884
+ schema:
8885
+ examples:
8886
+ - organization_01h45ytscbebyvny4gc8cr8ma2
8887
+ format: typeid
8888
+ pattern: ^organization_[0-7][0-9a-hjkmnpq-tv-z]{25}$
8889
+ title: Organization Id
8890
+ type: string
8891
+ x-typeid-prefix: organization
8892
+ - in: path
8893
+ name: transaction_id
8894
+ required: true
8895
+ schema:
8896
+ examples:
8897
+ - billing_transaction_01h45ytscbebyvny4gc8cr8ma2
8898
+ format: typeid
8899
+ pattern: ^billing_transaction_[0-7][0-9a-hjkmnpq-tv-z]{25}$
8900
+ title: Transaction Id
8901
+ type: string
8902
+ x-typeid-prefix: billing_transaction
8903
+ responses:
8904
+ '200':
8905
+ content:
8906
+ application/json:
8907
+ schema:
8908
+ $ref: '#/components/schemas/BillingTransactionResponse'
8909
+ description: Successful Response
8910
+ '422':
8911
+ content:
8912
+ application/problem+json:
8913
+ schema:
8914
+ $ref: '#/components/schemas/HTTPValidationError'
8915
+ description: Validation Error
8916
+ security:
8917
+ - OAuth2PasswordBearer: []
8918
+ summary: Get a specific transaction for an organization
8919
+ tags:
8920
+ - organization
8665
8921
  /v1/tlds/portfolio:
8666
8922
  get:
8667
8923
  operationId: get_tld_portfolio_v1_tlds_portfolio_get
package/src/schema.d.ts CHANGED
@@ -951,6 +951,40 @@ export interface paths {
951
951
  patch?: never;
952
952
  trace?: never;
953
953
  };
954
+ "/v1/organizations/{organization_id}/transactions": {
955
+ parameters: {
956
+ query?: never;
957
+ header?: never;
958
+ path?: never;
959
+ cookie?: never;
960
+ };
961
+ /** Get transactions for an organization */
962
+ get: operations["get_transactions_v1_organizations__organization_id__transactions_get"];
963
+ put?: never;
964
+ post?: never;
965
+ delete?: never;
966
+ options?: never;
967
+ head?: never;
968
+ patch?: never;
969
+ trace?: never;
970
+ };
971
+ "/v1/organizations/{organization_id}/transactions/{transaction_id}": {
972
+ parameters: {
973
+ query?: never;
974
+ header?: never;
975
+ path?: never;
976
+ cookie?: never;
977
+ };
978
+ /** Get a specific transaction for an organization */
979
+ get: operations["get_transaction_v1_organizations__organization_id__transactions__transaction_id__get"];
980
+ put?: never;
981
+ post?: never;
982
+ delete?: never;
983
+ options?: never;
984
+ head?: never;
985
+ patch?: never;
986
+ trace?: never;
987
+ };
954
988
  "/v1/tlds/portfolio": {
955
989
  parameters: {
956
990
  query?: never;
@@ -1170,6 +1204,55 @@ export interface components {
1170
1204
  * @enum {string}
1171
1205
  */
1172
1206
  BillingTransactionProductType: "domain" | "zones" | "email_forward" | "domain_forward";
1207
+ /** BillingTransactionResponse */
1208
+ BillingTransactionResponse: {
1209
+ /** @description The action performed in the transaction */
1210
+ action: components["schemas"]["BillingTransactionAction"];
1211
+ /**
1212
+ * Billing Transaction Id
1213
+ * Format: typeid
1214
+ */
1215
+ billing_transaction_id?: TypeId<"billing_transaction">;
1216
+ /**
1217
+ * Completed On
1218
+ * @description The date/time the transaction completed
1219
+ */
1220
+ completed_on?: Date | null;
1221
+ /**
1222
+ * Created On
1223
+ * Format: date-time
1224
+ * @description The date/time the transaction was created
1225
+ */
1226
+ created_on?: Date;
1227
+ /**
1228
+ * Product Reference
1229
+ * @description The reference of the product
1230
+ */
1231
+ product_reference: string | null;
1232
+ /** @description The type of product */
1233
+ product_type: components["schemas"]["BillingTransactionProductType"];
1234
+ /**
1235
+ * @description The status of the transaction
1236
+ * @default pending
1237
+ */
1238
+ status: components["schemas"]["BillingTransactionStatus"];
1239
+ /**
1240
+ * Updated On
1241
+ * Format: date-time
1242
+ * @description The date/time the transaction was updated
1243
+ */
1244
+ updated_on?: Date;
1245
+ };
1246
+ /**
1247
+ * BillingTransactionSortField
1248
+ * @enum {string}
1249
+ */
1250
+ BillingTransactionSortField: "product_type" | "action" | "status" | "created_on" | "completed_on";
1251
+ /**
1252
+ * BillingTransactionStatus
1253
+ * @enum {string}
1254
+ */
1255
+ BillingTransactionStatus: "pending" | "succeeded" | "failed" | "canceled";
1173
1256
  /** Body_issue_organization_token_v1_auth_token_post */
1174
1257
  Body_issue_organization_token_v1_auth_token_post: {
1175
1258
  /**
@@ -3379,6 +3462,12 @@ export interface components {
3379
3462
  /** Total Pages */
3380
3463
  total_pages: number;
3381
3464
  };
3465
+ /** Pagination[BillingTransactionResponse] */
3466
+ Pagination_BillingTransactionResponse_: {
3467
+ pagination: components["schemas"]["PaginationMetadata"];
3468
+ /** Results */
3469
+ results: components["schemas"]["BillingTransactionResponse"][];
3470
+ };
3382
3471
  /** Pagination[ContactSchema] */
3383
3472
  Pagination_ContactSchema_: {
3384
3473
  pagination: components["schemas"]["PaginationMetadata"];
@@ -7664,6 +7753,82 @@ export interface operations {
7664
7753
  };
7665
7754
  };
7666
7755
  };
7756
+ get_transactions_v1_organizations__organization_id__transactions_get: {
7757
+ parameters: {
7758
+ query?: {
7759
+ sort_by?: components["schemas"]["BillingTransactionSortField"];
7760
+ sort_order?: components["schemas"]["SortOrder"];
7761
+ product_reference?: string | null;
7762
+ product_type?: components["schemas"]["BillingTransactionProductType"] | null;
7763
+ action?: components["schemas"]["BillingTransactionAction"] | null;
7764
+ status?: components["schemas"]["BillingTransactionStatus"] | null;
7765
+ created_after?: Date | null;
7766
+ created_before?: Date | null;
7767
+ completed_after?: Date | null;
7768
+ completed_before?: Date | null;
7769
+ page?: number;
7770
+ page_size?: number;
7771
+ };
7772
+ header?: never;
7773
+ path: {
7774
+ organization_id: TypeId<"organization">;
7775
+ };
7776
+ cookie?: never;
7777
+ };
7778
+ requestBody?: never;
7779
+ responses: {
7780
+ /** @description Successful Response */
7781
+ 200: {
7782
+ headers: {
7783
+ [name: string]: unknown;
7784
+ };
7785
+ content: {
7786
+ "application/json": components["schemas"]["Pagination_BillingTransactionResponse_"];
7787
+ };
7788
+ };
7789
+ /** @description Validation Error */
7790
+ 422: {
7791
+ headers: {
7792
+ [name: string]: unknown;
7793
+ };
7794
+ content: {
7795
+ "application/problem+json": components["schemas"]["HTTPValidationError"];
7796
+ };
7797
+ };
7798
+ };
7799
+ };
7800
+ get_transaction_v1_organizations__organization_id__transactions__transaction_id__get: {
7801
+ parameters: {
7802
+ query?: never;
7803
+ header?: never;
7804
+ path: {
7805
+ organization_id: TypeId<"organization">;
7806
+ transaction_id: TypeId<"billing_transaction">;
7807
+ };
7808
+ cookie?: never;
7809
+ };
7810
+ requestBody?: never;
7811
+ responses: {
7812
+ /** @description Successful Response */
7813
+ 200: {
7814
+ headers: {
7815
+ [name: string]: unknown;
7816
+ };
7817
+ content: {
7818
+ "application/json": components["schemas"]["BillingTransactionResponse"];
7819
+ };
7820
+ };
7821
+ /** @description Validation Error */
7822
+ 422: {
7823
+ headers: {
7824
+ [name: string]: unknown;
7825
+ };
7826
+ content: {
7827
+ "application/problem+json": components["schemas"]["HTTPValidationError"];
7828
+ };
7829
+ };
7830
+ };
7831
+ };
7667
7832
  get_tld_portfolio_v1_tlds_portfolio_get: {
7668
7833
  parameters: {
7669
7834
  query?: never;