@opusdns/api 0.29.0 → 0.31.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.
@@ -3267,6 +3267,96 @@ export type PATCH_OrganizationsOrganizationIdPlan_Request_Path = PATCH_Organizat
3267
3267
  */
3268
3268
  export type PATCH_OrganizationsOrganizationIdPlan_Request_Body = PATCH_OrganizationsOrganizationIdPlan_Request['requestBody'];
3269
3269
 
3270
+ /**
3271
+ * Request type for GET OrganizationsOrganizationIdPlans endpoint
3272
+ *
3273
+ * Get Current Available Plans
3274
+ *
3275
+ * @remarks
3276
+ * This type defines the complete request structure for the GET OrganizationsOrganizationIdPlans endpoint.
3277
+ * It includes all parameters (query, path) and request body types as defined in the OpenAPI specification.
3278
+ * Use this type to ensure type safety when making API requests to this endpoint.
3279
+ *
3280
+ * @example
3281
+ * Use this type to ensure type safety when making API requests to this endpoint.
3282
+ *
3283
+ * @path /v1/organizations/{organization_id}/plans
3284
+ *
3285
+ * @see {@link GET_OrganizationsOrganizationIdPlans_Request_Query} - Query parameters type
3286
+ * @see {@link GET_OrganizationsOrganizationIdPlans_Request_Path} - Path parameters type
3287
+ * @see {@link GET_OrganizationsOrganizationIdPlans_Request_Body} - Request body type
3288
+ */
3289
+ export type GET_OrganizationsOrganizationIdPlans_Request = {
3290
+ parameters: {
3291
+ path: operations['get_current_available_plans_v1_organizations__organization_id__plans_get']['parameters']['path'];
3292
+ };
3293
+ }
3294
+ /**
3295
+ * Path parameters for GET /v1/organizations/{organization_id}/plans
3296
+ *
3297
+ * @remarks
3298
+ * This type defines the path parameters for the GET /v1/organizations/{organization_id}/plans endpoint.
3299
+ * It provides type safety for all path parameters as defined in the OpenAPI specification.
3300
+ *
3301
+ * @example
3302
+ * Use this type to ensure type safety for path parameters.
3303
+ *
3304
+ * @path /v1/organizations/{organization_id}/plans
3305
+ */
3306
+ export type GET_OrganizationsOrganizationIdPlans_Request_Path = GET_OrganizationsOrganizationIdPlans_Request['parameters']['path'];
3307
+
3308
+ /**
3309
+ * Request type for GET OrganizationsOrganizationIdPricingProductTypeProductType endpoint
3310
+ *
3311
+ * Get Pricing Plans
3312
+ *
3313
+ * @remarks
3314
+ * This type defines the complete request structure for the GET OrganizationsOrganizationIdPricingProductTypeProductType endpoint.
3315
+ * It includes all parameters (query, path) and request body types as defined in the OpenAPI specification.
3316
+ * Use this type to ensure type safety when making API requests to this endpoint.
3317
+ *
3318
+ * @example
3319
+ * Use this type to ensure type safety when making API requests to this endpoint.
3320
+ *
3321
+ * @path /v1/organizations/{organization_id}/pricing/product-type/{product_type}
3322
+ *
3323
+ * @see {@link GET_OrganizationsOrganizationIdPricingProductTypeProductType_Request_Query} - Query parameters type
3324
+ * @see {@link GET_OrganizationsOrganizationIdPricingProductTypeProductType_Request_Path} - Path parameters type
3325
+ * @see {@link GET_OrganizationsOrganizationIdPricingProductTypeProductType_Request_Body} - Request body type
3326
+ */
3327
+ export type GET_OrganizationsOrganizationIdPricingProductTypeProductType_Request = {
3328
+ parameters: {
3329
+ query: operations['get_pricing_plans_v1_organizations__organization_id__pricing_product_type__product_type__get']['parameters']['query'];
3330
+ path: operations['get_pricing_plans_v1_organizations__organization_id__pricing_product_type__product_type__get']['parameters']['path'];
3331
+ };
3332
+ }
3333
+ /**
3334
+ * Query parameters for GET /v1/organizations/{organization_id}/pricing/product-type/{product_type}
3335
+ *
3336
+ * @remarks
3337
+ * This type defines the query parameters for the GET /v1/organizations/{organization_id}/pricing/product-type/{product_type} endpoint.
3338
+ * It provides type safety for all query parameters as defined in the OpenAPI specification.
3339
+ *
3340
+ * @example
3341
+ * Use this type to ensure type safety for query parameters.
3342
+ *
3343
+ * @path /v1/organizations/{organization_id}/pricing/product-type/{product_type}
3344
+ */
3345
+ export type GET_OrganizationsOrganizationIdPricingProductTypeProductType_Request_Query = GET_OrganizationsOrganizationIdPricingProductTypeProductType_Request['parameters']['query'];
3346
+ /**
3347
+ * Path parameters for GET /v1/organizations/{organization_id}/pricing/product-type/{product_type}
3348
+ *
3349
+ * @remarks
3350
+ * This type defines the path parameters for the GET /v1/organizations/{organization_id}/pricing/product-type/{product_type} endpoint.
3351
+ * It provides type safety for all path parameters as defined in the OpenAPI specification.
3352
+ *
3353
+ * @example
3354
+ * Use this type to ensure type safety for path parameters.
3355
+ *
3356
+ * @path /v1/organizations/{organization_id}/pricing/product-type/{product_type}
3357
+ */
3358
+ export type GET_OrganizationsOrganizationIdPricingProductTypeProductType_Request_Path = GET_OrganizationsOrganizationIdPricingProductTypeProductType_Request['parameters']['path'];
3359
+
3270
3360
  /**
3271
3361
  * Request type for GET OrganizationsRoles endpoint
3272
3362
  *
@@ -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, DomainCheck, DomainSummary, Pagination_EmailForwardAlias, EmailForwardAlias, Pagination_Event, EventSchema, Pagination_UserNotificationSummary, Notification, UserNotification, Pagination_Organization, Organization, OrganizationWithPlan, 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, DomainCheck, DomainSummary, Pagination_EmailForwardAlias, EmailForwardAlias, Pagination_Event, EventSchema, Pagination_UserNotificationSummary, Notification, UserNotification, Pagination_Organization, Organization, OrganizationWithPlan, GetCurrentAvailablePlans, GetPrices, IpRestriction, Pagination_User, TldSpecification, User, UserWithAttributes, PermissionSet, RelationSet, UserWithRelationPermissions } from './schemas.d';
38
38
 
39
39
  /**
40
40
  * Response types for GET AuthClientCredentials endpoint
@@ -4570,6 +4570,116 @@ export type PATCH_OrganizationsByOrganizationIdPlan_Response_200 = OrganizationW
4570
4570
  */
4571
4571
  export type PATCH_OrganizationsByOrganizationIdPlan_Response_422 = HTTPValidationError
4572
4572
 
4573
+ /**
4574
+ * Response types for GET OrganizationsByOrganizationIdPlans endpoint
4575
+ *
4576
+ * Get Current Available Plans
4577
+ *
4578
+ * @remarks
4579
+ * This type defines all possible response structures for the GET OrganizationsByOrganizationIdPlans endpoint.
4580
+ * Each response code maps to a specific response type as defined in the OpenAPI specification.
4581
+ * Use this type to ensure type safety when handling API responses from this endpoint.
4582
+ *
4583
+
4584
+ *
4585
+ * @path /v1/organizations/{organization_id}/plans
4586
+ *
4587
+ * @see {@link GET_OrganizationsByOrganizationIdPlans_Response_200} - 200 response type
4588
+ * @see {@link GET_OrganizationsByOrganizationIdPlans_Response_422} - 422 response type
4589
+ *
4590
+
4591
+ */
4592
+ export type GET_OrganizationsByOrganizationIdPlans_Response = GET_OrganizationsByOrganizationIdPlans_Response_200 | GET_OrganizationsByOrganizationIdPlans_Response_422;
4593
+
4594
+ /**
4595
+ * 200 response for GET OrganizationsByOrganizationIdPlans endpoint
4596
+ *
4597
+ * @remarks
4598
+ * This type defines the response structure for the 200 status code
4599
+ * of the GET OrganizationsByOrganizationIdPlans endpoint.
4600
+ * It provides type safety for handling this specific response as defined in the OpenAPI specification.
4601
+ *
4602
+
4603
+ *
4604
+ * @path /v1/organizations/{organization_id}/plans
4605
+ *
4606
+ * @see {@link GET_OrganizationsByOrganizationIdPlans_Response} - The main response type definition
4607
+ * @see {@link GetCurrentAvailablePlans} - The actual schema type definition
4608
+ */
4609
+ export type GET_OrganizationsByOrganizationIdPlans_Response_200 = GetCurrentAvailablePlans
4610
+
4611
+ /**
4612
+ * 422 response for GET OrganizationsByOrganizationIdPlans endpoint
4613
+ *
4614
+ * @remarks
4615
+ * This type defines the response structure for the 422 status code
4616
+ * of the GET OrganizationsByOrganizationIdPlans endpoint.
4617
+ * It provides type safety for handling this specific response as defined in the OpenAPI specification.
4618
+ *
4619
+
4620
+ *
4621
+ * @path /v1/organizations/{organization_id}/plans
4622
+ *
4623
+ * @see {@link GET_OrganizationsByOrganizationIdPlans_Response} - The main response type definition
4624
+ * @see {@link HTTPValidationError} - The actual schema type definition
4625
+ */
4626
+ export type GET_OrganizationsByOrganizationIdPlans_Response_422 = HTTPValidationError
4627
+
4628
+ /**
4629
+ * Response types for GET OrganizationsByOrganizationIdPricingProductTypeByProductType endpoint
4630
+ *
4631
+ * Get Pricing Plans
4632
+ *
4633
+ * @remarks
4634
+ * This type defines all possible response structures for the GET OrganizationsByOrganizationIdPricingProductTypeByProductType endpoint.
4635
+ * Each response code maps to a specific response type as defined in the OpenAPI specification.
4636
+ * Use this type to ensure type safety when handling API responses from this endpoint.
4637
+ *
4638
+
4639
+ *
4640
+ * @path /v1/organizations/{organization_id}/pricing/product-type/{product_type}
4641
+ *
4642
+ * @see {@link GET_OrganizationsByOrganizationIdPricingProductTypeByProductType_Response_200} - 200 response type
4643
+ * @see {@link GET_OrganizationsByOrganizationIdPricingProductTypeByProductType_Response_422} - 422 response type
4644
+ *
4645
+
4646
+ */
4647
+ export type GET_OrganizationsByOrganizationIdPricingProductTypeByProductType_Response = GET_OrganizationsByOrganizationIdPricingProductTypeByProductType_Response_200 | GET_OrganizationsByOrganizationIdPricingProductTypeByProductType_Response_422;
4648
+
4649
+ /**
4650
+ * 200 response for GET OrganizationsByOrganizationIdPricingProductTypeByProductType endpoint
4651
+ *
4652
+ * @remarks
4653
+ * This type defines the response structure for the 200 status code
4654
+ * of the GET OrganizationsByOrganizationIdPricingProductTypeByProductType endpoint.
4655
+ * It provides type safety for handling this specific response as defined in the OpenAPI specification.
4656
+ *
4657
+
4658
+ *
4659
+ * @path /v1/organizations/{organization_id}/pricing/product-type/{product_type}
4660
+ *
4661
+ * @see {@link GET_OrganizationsByOrganizationIdPricingProductTypeByProductType_Response} - The main response type definition
4662
+ * @see {@link GetPrices} - The actual schema type definition
4663
+ */
4664
+ export type GET_OrganizationsByOrganizationIdPricingProductTypeByProductType_Response_200 = GetPrices
4665
+
4666
+ /**
4667
+ * 422 response for GET OrganizationsByOrganizationIdPricingProductTypeByProductType endpoint
4668
+ *
4669
+ * @remarks
4670
+ * This type defines the response structure for the 422 status code
4671
+ * of the GET OrganizationsByOrganizationIdPricingProductTypeByProductType endpoint.
4672
+ * It provides type safety for handling this specific response as defined in the OpenAPI specification.
4673
+ *
4674
+
4675
+ *
4676
+ * @path /v1/organizations/{organization_id}/pricing/product-type/{product_type}
4677
+ *
4678
+ * @see {@link GET_OrganizationsByOrganizationIdPricingProductTypeByProductType_Response} - The main response type definition
4679
+ * @see {@link HTTPValidationError} - The actual schema type definition
4680
+ */
4681
+ export type GET_OrganizationsByOrganizationIdPricingProductTypeByProductType_Response_422 = HTTPValidationError
4682
+
4573
4683
  /**
4574
4684
  * Response types for GET OrganizationsIpRestrictions endpoint
4575
4685
  *
@@ -5068,11 +5178,29 @@ export type POST_Users_Response_422 = HTTPValidationError
5068
5178
  *
5069
5179
  * @path /v1/users/{user_id}
5070
5180
  *
5181
+ * @see {@link DELETE_UsersByUserId_Response_409} - 409 response type
5071
5182
  * @see {@link DELETE_UsersByUserId_Response_422} - 422 response type
5072
5183
  *
5073
5184
 
5074
5185
  */
5075
- export type DELETE_UsersByUserId_Response = DELETE_UsersByUserId_Response_422;
5186
+ export type DELETE_UsersByUserId_Response = DELETE_UsersByUserId_Response_409 | DELETE_UsersByUserId_Response_422;
5187
+
5188
+ /**
5189
+ * 409 response for DELETE UsersByUserId endpoint
5190
+ *
5191
+ * @remarks
5192
+ * This type defines the response structure for the 409 status code
5193
+ * of the DELETE UsersByUserId endpoint.
5194
+ * It provides type safety for handling this specific response as defined in the OpenAPI specification.
5195
+ *
5196
+
5197
+ *
5198
+ * @path /v1/users/{user_id}
5199
+ *
5200
+ * @see {@link DELETE_UsersByUserId_Response} - The main response type definition
5201
+ * @see {@link Problem} - The actual schema type definition
5202
+ */
5203
+ export type DELETE_UsersByUserId_Response_409 = Problem
5076
5204
 
5077
5205
  /**
5078
5206
  * 422 response for DELETE UsersByUserId endpoint
@@ -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, Nameserver, DeletePolicyType, SyncOperationType, DomainContact, DomainSearchSuggestion, DomainStatus, DomainClientStatus, ValidationError, LaunchPhaseBase, LocalPresenceRequirementType, ContactRoleType, OrganizationAttribute2, User, OrganizationAttributeCreate, UserCreate, ContactSchema, DnsZone, Domain, EmailForwardAlias, EventResponse, OrganizationCredential, Organization, UserNotificationSummary, Period, Permission, PremiumAffectsType, Relation, 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, Nameserver, DeletePolicyType, SyncOperationType, DomainContact, DomainSearchSuggestion, DomainStatus, DomainClientStatus, PlanInfo, PriceInfo, ValidationError, LaunchPhaseBase, LocalPresenceRequirementType, ContactRoleType, OrganizationAttribute2, User, OrganizationAttributeCreate, UserCreate, ContactSchema, DnsZone, Domain, EmailForwardAlias, EventResponse, OrganizationCredential, Organization, UserNotificationSummary, Period, Permission, PremiumAffectsType, Relation, TldBase, PostTransferRequirements, UserAttributeBase, DomainAvailability } from './schemas.d';
25
25
 
26
26
  /**
27
27
  * DomainDnssecDataResponse
@@ -345,6 +345,34 @@ export type DomainStatusArray = DomainStatus[];
345
345
  * @see {@link DomainClientStatus} - The individual DomainClientStatus type definition
346
346
  */
347
347
  export type DomainClientStatusArray = DomainClientStatus[];
348
+ /**
349
+ * PlanInfo
350
+ *
351
+ * @remarks
352
+ * Array type for PlanInfo objects. Used when the API returns a collection of PlanInfo instances.
353
+ *
354
+ * @example
355
+ * ```typescript
356
+ * const items: PlanInfoArray = await api.getPlanInfos();
357
+ * ```
358
+ *
359
+ * @see {@link PlanInfo} - The individual PlanInfo type definition
360
+ */
361
+ export type PlanInfoArray = PlanInfo[];
362
+ /**
363
+ * PriceInfo
364
+ *
365
+ * @remarks
366
+ * Array type for PriceInfo objects. Used when the API returns a collection of PriceInfo instances.
367
+ *
368
+ * @example
369
+ * ```typescript
370
+ * const items: PriceInfoArray = await api.getPriceInfos();
371
+ * ```
372
+ *
373
+ * @see {@link PriceInfo} - The individual PriceInfo type definition
374
+ */
375
+ export type PriceInfoArray = PriceInfo[];
348
376
  /**
349
377
  * ValidationError
350
378
  *
@@ -58,6 +58,38 @@ export type AllocationMethodType = components['schemas']['AllocationMethodType']
58
58
  * @see {@link components} - The OpenAPI components schema definition
59
59
  */
60
60
  export type AllowedNumberOfNameserverBase = components['schemas']['AllowedNumberOfNameserverBase'];
61
+ /**
62
+ * BillingTransactionAction
63
+ *
64
+ * @remarks
65
+ * Type alias for the `BillingTransactionAction` OpenAPI schema.
66
+ * This type represents billingtransactionaction data structures used in API requests and responses.
67
+ *
68
+ * @example
69
+ * ```typescript
70
+ * const response = await api.getBillingTransactionAction();
71
+ * const item: BillingTransactionAction = response.results;
72
+ * ```
73
+ *
74
+ * @see {@link components} - The OpenAPI components schema definition
75
+ */
76
+ export type BillingTransactionAction = components['schemas']['BillingTransactionAction'];
77
+ /**
78
+ * BillingTransactionProductType
79
+ *
80
+ * @remarks
81
+ * Type alias for the `BillingTransactionProductType` OpenAPI schema.
82
+ * This type represents billingtransactionproducttype data structures used in API requests and responses.
83
+ *
84
+ * @example
85
+ * ```typescript
86
+ * const response = await api.getBillingTransactionProductType();
87
+ * const item: BillingTransactionProductType = response.results;
88
+ * ```
89
+ *
90
+ * @see {@link components} - The OpenAPI components schema definition
91
+ */
92
+ export type BillingTransactionProductType = components['schemas']['BillingTransactionProductType'];
61
93
  /**
62
94
  * Body_issue_organization_token_v1_auth_token_post
63
95
  *
@@ -1258,6 +1290,38 @@ export type EventType = components['schemas']['EventType'];
1258
1290
  * @see {@link components} - The OpenAPI components schema definition
1259
1291
  */
1260
1292
  export type GeneralAvailabilityBase = components['schemas']['GeneralAvailabilityBase'];
1293
+ /**
1294
+ * GetCurrentAvailablePlansResponse
1295
+ *
1296
+ * @remarks
1297
+ * Type alias for the `GetCurrentAvailablePlansResponse` OpenAPI schema.
1298
+ * This type represents getcurrentavailableplansresponse data structures used in API requests and responses.
1299
+ *
1300
+ * @example
1301
+ * ```typescript
1302
+ * const response = await api.getGetCurrentAvailablePlans();
1303
+ * const item: GetCurrentAvailablePlans = response.results;
1304
+ * ```
1305
+ *
1306
+ * @see {@link components} - The OpenAPI components schema definition
1307
+ */
1308
+ export type GetCurrentAvailablePlans = components['schemas']['GetCurrentAvailablePlansResponse'];
1309
+ /**
1310
+ * GetPricesResponse
1311
+ *
1312
+ * @remarks
1313
+ * Type alias for the `GetPricesResponse` OpenAPI schema.
1314
+ * This type represents getpricesresponse data structures used in API requests and responses.
1315
+ *
1316
+ * @example
1317
+ * ```typescript
1318
+ * const response = await api.getGetPrices();
1319
+ * const item: GetPrices = response.results;
1320
+ * ```
1321
+ *
1322
+ * @see {@link components} - The OpenAPI components schema definition
1323
+ */
1324
+ export type GetPrices = components['schemas']['GetPricesResponse'];
1261
1325
  /**
1262
1326
  * GrantType
1263
1327
  *
@@ -2010,6 +2074,22 @@ export type Permission = components['schemas']['Permission'];
2010
2074
  * @see {@link components} - The OpenAPI components schema definition
2011
2075
  */
2012
2076
  export type PermissionSet = components['schemas']['PermissionSet'];
2077
+ /**
2078
+ * PlanInfo
2079
+ *
2080
+ * @remarks
2081
+ * Type alias for the `PlanInfo` OpenAPI schema.
2082
+ * This type represents planinfo data structures used in API requests and responses.
2083
+ *
2084
+ * @example
2085
+ * ```typescript
2086
+ * const response = await api.getPlanInfo();
2087
+ * const item: PlanInfo = response.results;
2088
+ * ```
2089
+ *
2090
+ * @see {@link components} - The OpenAPI components schema definition
2091
+ */
2092
+ export type PlanInfo = components['schemas']['PlanInfo'];
2013
2093
  /**
2014
2094
  * PlanRelation
2015
2095
  *
@@ -2122,6 +2202,22 @@ export type PremiumDomainsBase = components['schemas']['PremiumDomainsBase'];
2122
2202
  * @see {@link components} - The OpenAPI components schema definition
2123
2203
  */
2124
2204
  export type PremiumSourceType = components['schemas']['PremiumSourceType'];
2205
+ /**
2206
+ * PriceInfo
2207
+ *
2208
+ * @remarks
2209
+ * Type alias for the `PriceInfo` OpenAPI schema.
2210
+ * This type represents priceinfo data structures used in API requests and responses.
2211
+ *
2212
+ * @example
2213
+ * ```typescript
2214
+ * const response = await api.getPriceInfo();
2215
+ * const item: PriceInfo = response.results;
2216
+ * ```
2217
+ *
2218
+ * @see {@link components} - The OpenAPI components schema definition
2219
+ */
2220
+ export type PriceInfo = components['schemas']['PriceInfo'];
2125
2221
  /**
2126
2222
  * Problem
2127
2223
  *
package/src/openapi.yaml CHANGED
@@ -23,6 +23,24 @@ components:
23
23
  - max
24
24
  title: AllowedNumberOfNameserverBase
25
25
  type: object
26
+ BillingTransactionAction:
27
+ enum:
28
+ - create
29
+ - transfer
30
+ - renew
31
+ - restore
32
+ - trade
33
+ - application
34
+ title: BillingTransactionAction
35
+ type: string
36
+ BillingTransactionProductType:
37
+ enum:
38
+ - domain
39
+ - zone
40
+ - email_forward
41
+ - domain_forward
42
+ title: BillingTransactionProductType
43
+ type: string
26
44
  Body_issue_organization_token_v1_auth_token_post:
27
45
  properties:
28
46
  client_id:
@@ -2085,6 +2103,35 @@ components:
2085
2103
  - start_date
2086
2104
  title: GeneralAvailabilityBase
2087
2105
  type: object
2106
+ GetCurrentAvailablePlansResponse:
2107
+ properties:
2108
+ current_plan:
2109
+ anyOf:
2110
+ - $ref: '#/components/schemas/PlanInfo'
2111
+ - type: 'null'
2112
+ description: Current active plan for the customer
2113
+ plans:
2114
+ description: List of available plans
2115
+ items:
2116
+ $ref: '#/components/schemas/PlanInfo'
2117
+ title: Plans
2118
+ type: array
2119
+ required:
2120
+ - plans
2121
+ title: GetCurrentAvailablePlansResponse
2122
+ type: object
2123
+ GetPricesResponse:
2124
+ properties:
2125
+ prices:
2126
+ description: List of prices
2127
+ items:
2128
+ $ref: '#/components/schemas/PriceInfo'
2129
+ title: Prices
2130
+ type: array
2131
+ required:
2132
+ - prices
2133
+ title: GetPricesResponse
2134
+ type: object
2088
2135
  GrantType:
2089
2136
  enum:
2090
2137
  - client_credentials
@@ -3582,6 +3629,44 @@ components:
3582
3629
  type: array
3583
3630
  title: PermissionSet
3584
3631
  type: object
3632
+ PlanInfo:
3633
+ properties:
3634
+ amount:
3635
+ description: Base price
3636
+ title: Amount
3637
+ type: number
3638
+ currency:
3639
+ description: Currency code
3640
+ title: Currency
3641
+ type: string
3642
+ name:
3643
+ anyOf:
3644
+ - type: string
3645
+ - type: 'null'
3646
+ description: Plan display name
3647
+ title: Name
3648
+ plan_id:
3649
+ description: Unique plan identifier
3650
+ title: Plan Id
3651
+ type: string
3652
+ plan_level:
3653
+ anyOf:
3654
+ - type: string
3655
+ - type: 'null'
3656
+ description: Plan level such as 'premium' or 'starter'
3657
+ title: Plan Level
3658
+ plan_type:
3659
+ anyOf:
3660
+ - type: string
3661
+ - type: 'null'
3662
+ description: Plan type or billing interval
3663
+ title: Plan Type
3664
+ required:
3665
+ - plan_id
3666
+ - currency
3667
+ - amount
3668
+ title: PlanInfo
3669
+ type: object
3585
3670
  PlanRelation:
3586
3671
  enum:
3587
3672
  - basic_plan
@@ -3646,6 +3731,33 @@ components:
3646
3731
  - manual
3647
3732
  title: PremiumSourceType
3648
3733
  type: string
3734
+ PriceInfo:
3735
+ properties:
3736
+ currency:
3737
+ title: Currency
3738
+ type: string
3739
+ price:
3740
+ title: Price
3741
+ type: string
3742
+ product_action:
3743
+ anyOf:
3744
+ - type: string
3745
+ - type: 'null'
3746
+ title: Product Action
3747
+ product_class:
3748
+ anyOf:
3749
+ - type: string
3750
+ - type: 'null'
3751
+ title: Product Class
3752
+ product_type:
3753
+ title: Product Type
3754
+ type: string
3755
+ required:
3756
+ - product_type
3757
+ - price
3758
+ - currency
3759
+ title: PriceInfo
3760
+ type: object
3649
3761
  Problem:
3650
3762
  properties:
3651
3763
  detail:
@@ -4798,7 +4910,7 @@ info:
4798
4910
  '
4799
4911
  summary: OpusDNS - your gateway to a seamless domain management experience.
4800
4912
  title: OpusDNS API
4801
- version: 2025-08-30-003827
4913
+ version: 2025-09-05-075426
4802
4914
  x-logo:
4803
4915
  altText: OpusDNS API Reference
4804
4916
  url: https://d24lr4zqs1tgqh.cloudfront.net/c9505a20-5ae1-406c-b060-d392569caebf.jpg
@@ -8571,6 +8683,93 @@ paths:
8571
8683
  summary: Change Plan
8572
8684
  tags:
8573
8685
  - organization
8686
+ /v1/organizations/{organization_id}/plans:
8687
+ get:
8688
+ operationId: get_current_available_plans_v1_organizations__organization_id__plans_get
8689
+ parameters:
8690
+ - in: path
8691
+ name: organization_id
8692
+ required: true
8693
+ schema:
8694
+ examples:
8695
+ - organization_01h45ytscbebyvny4gc8cr8ma2
8696
+ format: typeid
8697
+ pattern: ^organization_[0-7][0-9a-hjkmnpq-tv-z]{25}$
8698
+ title: Organization Id
8699
+ type: string
8700
+ x-typeid-prefix: organization
8701
+ responses:
8702
+ '200':
8703
+ content:
8704
+ application/json:
8705
+ schema:
8706
+ $ref: '#/components/schemas/GetCurrentAvailablePlansResponse'
8707
+ description: Successful Response
8708
+ '422':
8709
+ content:
8710
+ application/problem+json:
8711
+ schema:
8712
+ $ref: '#/components/schemas/HTTPValidationError'
8713
+ description: Validation Error
8714
+ security:
8715
+ - OAuth2PasswordBearer: []
8716
+ summary: Get Current Available Plans
8717
+ tags:
8718
+ - organization
8719
+ /v1/organizations/{organization_id}/pricing/product-type/{product_type}:
8720
+ get:
8721
+ operationId: get_pricing_plans_v1_organizations__organization_id__pricing_product_type__product_type__get
8722
+ parameters:
8723
+ - in: path
8724
+ name: organization_id
8725
+ required: true
8726
+ schema:
8727
+ examples:
8728
+ - organization_01h45ytscbebyvny4gc8cr8ma2
8729
+ format: typeid
8730
+ pattern: ^organization_[0-7][0-9a-hjkmnpq-tv-z]{25}$
8731
+ title: Organization Id
8732
+ type: string
8733
+ x-typeid-prefix: organization
8734
+ - in: path
8735
+ name: product_type
8736
+ required: true
8737
+ schema:
8738
+ $ref: '#/components/schemas/BillingTransactionProductType'
8739
+ - in: query
8740
+ name: product_action
8741
+ required: false
8742
+ schema:
8743
+ anyOf:
8744
+ - $ref: '#/components/schemas/BillingTransactionAction'
8745
+ - type: 'null'
8746
+ title: Product Action
8747
+ - in: query
8748
+ name: product_class
8749
+ required: false
8750
+ schema:
8751
+ anyOf:
8752
+ - type: string
8753
+ - type: 'null'
8754
+ title: Product Class
8755
+ responses:
8756
+ '200':
8757
+ content:
8758
+ application/json:
8759
+ schema:
8760
+ $ref: '#/components/schemas/GetPricesResponse'
8761
+ description: Successful Response
8762
+ '422':
8763
+ content:
8764
+ application/problem+json:
8765
+ schema:
8766
+ $ref: '#/components/schemas/HTTPValidationError'
8767
+ description: Validation Error
8768
+ security:
8769
+ - OAuth2PasswordBearer: []
8770
+ summary: Get Pricing Plans
8771
+ tags:
8772
+ - organization
8574
8773
  /v1/tlds/portfolio:
8575
8774
  get:
8576
8775
  operationId: get_tld_portfolio_v1_tlds_portfolio_get
@@ -8706,6 +8905,18 @@ paths:
8706
8905
  responses:
8707
8906
  '204':
8708
8907
  description: Successful Response
8908
+ '409':
8909
+ content:
8910
+ application/problem+json:
8911
+ example:
8912
+ code: ERROR_USER_IS_LAST_ADMIN
8913
+ detail: User is the last admin for the organization
8914
+ status: 409
8915
+ title: User Management Error
8916
+ type: user-is-last-admin
8917
+ schema:
8918
+ $ref: '#/components/schemas/Problem'
8919
+ description: Conflict
8709
8920
  '422':
8710
8921
  content:
8711
8922
  application/problem+json: