@opusdns/api 0.28.0 → 0.30.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/package.json +1 -1
- package/src/helpers/constants.ts +113 -1
- package/src/helpers/keys.ts +467 -0
- package/src/helpers/requests.d.ts +166 -0
- package/src/helpers/responses.d.ts +239 -1
- package/src/helpers/schemas-arrays.d.ts +29 -1
- package/src/helpers/schemas.d.ts +96 -0
- package/src/openapi.yaml +296 -1
- package/src/schema.d.ts +302 -0
|
@@ -1663,6 +1663,82 @@ export type PUT_DomainsDomainReferenceDnssec_Request_Path = PUT_DomainsDomainRef
|
|
|
1663
1663
|
*/
|
|
1664
1664
|
export type PUT_DomainsDomainReferenceDnssec_Request_Body = PUT_DomainsDomainReferenceDnssec_Request['requestBody'];
|
|
1665
1665
|
|
|
1666
|
+
/**
|
|
1667
|
+
* Request type for POST DomainsDomainReferenceDnssecDisable endpoint
|
|
1668
|
+
*
|
|
1669
|
+
* Disable DNSSEC for domains using our nameservers
|
|
1670
|
+
*
|
|
1671
|
+
* @remarks
|
|
1672
|
+
* This type defines the complete request structure for the POST DomainsDomainReferenceDnssecDisable endpoint.
|
|
1673
|
+
* It includes all parameters (query, path) and request body types as defined in the OpenAPI specification.
|
|
1674
|
+
* Use this type to ensure type safety when making API requests to this endpoint.
|
|
1675
|
+
*
|
|
1676
|
+
* @example
|
|
1677
|
+
* Use this type to ensure type safety when making API requests to this endpoint.
|
|
1678
|
+
*
|
|
1679
|
+
* @path /v1/domains/{domain_reference}/dnssec/disable
|
|
1680
|
+
*
|
|
1681
|
+
* @see {@link POST_DomainsDomainReferenceDnssecDisable_Request_Query} - Query parameters type
|
|
1682
|
+
* @see {@link POST_DomainsDomainReferenceDnssecDisable_Request_Path} - Path parameters type
|
|
1683
|
+
* @see {@link POST_DomainsDomainReferenceDnssecDisable_Request_Body} - Request body type
|
|
1684
|
+
*/
|
|
1685
|
+
export type POST_DomainsDomainReferenceDnssecDisable_Request = {
|
|
1686
|
+
parameters: {
|
|
1687
|
+
path: operations['disable_and_unpublish_dnssec_records_v1_domains__domain_reference__dnssec_disable_post']['parameters']['path'];
|
|
1688
|
+
};
|
|
1689
|
+
}
|
|
1690
|
+
/**
|
|
1691
|
+
* Path parameters for POST /v1/domains/{domain_reference}/dnssec/disable
|
|
1692
|
+
*
|
|
1693
|
+
* @remarks
|
|
1694
|
+
* This type defines the path parameters for the POST /v1/domains/{domain_reference}/dnssec/disable endpoint.
|
|
1695
|
+
* It provides type safety for all path parameters as defined in the OpenAPI specification.
|
|
1696
|
+
*
|
|
1697
|
+
* @example
|
|
1698
|
+
* Use this type to ensure type safety for path parameters.
|
|
1699
|
+
*
|
|
1700
|
+
* @path /v1/domains/{domain_reference}/dnssec/disable
|
|
1701
|
+
*/
|
|
1702
|
+
export type POST_DomainsDomainReferenceDnssecDisable_Request_Path = POST_DomainsDomainReferenceDnssecDisable_Request['parameters']['path'];
|
|
1703
|
+
|
|
1704
|
+
/**
|
|
1705
|
+
* Request type for POST DomainsDomainReferenceDnssecEnable endpoint
|
|
1706
|
+
*
|
|
1707
|
+
* Enable DNSSEC for domains using our nameservers
|
|
1708
|
+
*
|
|
1709
|
+
* @remarks
|
|
1710
|
+
* This type defines the complete request structure for the POST DomainsDomainReferenceDnssecEnable endpoint.
|
|
1711
|
+
* It includes all parameters (query, path) and request body types as defined in the OpenAPI specification.
|
|
1712
|
+
* Use this type to ensure type safety when making API requests to this endpoint.
|
|
1713
|
+
*
|
|
1714
|
+
* @example
|
|
1715
|
+
* Use this type to ensure type safety when making API requests to this endpoint.
|
|
1716
|
+
*
|
|
1717
|
+
* @path /v1/domains/{domain_reference}/dnssec/enable
|
|
1718
|
+
*
|
|
1719
|
+
* @see {@link POST_DomainsDomainReferenceDnssecEnable_Request_Query} - Query parameters type
|
|
1720
|
+
* @see {@link POST_DomainsDomainReferenceDnssecEnable_Request_Path} - Path parameters type
|
|
1721
|
+
* @see {@link POST_DomainsDomainReferenceDnssecEnable_Request_Body} - Request body type
|
|
1722
|
+
*/
|
|
1723
|
+
export type POST_DomainsDomainReferenceDnssecEnable_Request = {
|
|
1724
|
+
parameters: {
|
|
1725
|
+
path: operations['enable_and_publish_dnssec_records_v1_domains__domain_reference__dnssec_enable_post']['parameters']['path'];
|
|
1726
|
+
};
|
|
1727
|
+
}
|
|
1728
|
+
/**
|
|
1729
|
+
* Path parameters for POST /v1/domains/{domain_reference}/dnssec/enable
|
|
1730
|
+
*
|
|
1731
|
+
* @remarks
|
|
1732
|
+
* This type defines the path parameters for the POST /v1/domains/{domain_reference}/dnssec/enable endpoint.
|
|
1733
|
+
* It provides type safety for all path parameters as defined in the OpenAPI specification.
|
|
1734
|
+
*
|
|
1735
|
+
* @example
|
|
1736
|
+
* Use this type to ensure type safety for path parameters.
|
|
1737
|
+
*
|
|
1738
|
+
* @path /v1/domains/{domain_reference}/dnssec/enable
|
|
1739
|
+
*/
|
|
1740
|
+
export type POST_DomainsDomainReferenceDnssecEnable_Request_Path = POST_DomainsDomainReferenceDnssecEnable_Request['parameters']['path'];
|
|
1741
|
+
|
|
1666
1742
|
/**
|
|
1667
1743
|
* Request type for POST DomainsDomainReferenceRenew endpoint
|
|
1668
1744
|
*
|
|
@@ -3191,6 +3267,96 @@ export type PATCH_OrganizationsOrganizationIdPlan_Request_Path = PATCH_Organizat
|
|
|
3191
3267
|
*/
|
|
3192
3268
|
export type PATCH_OrganizationsOrganizationIdPlan_Request_Body = PATCH_OrganizationsOrganizationIdPlan_Request['requestBody'];
|
|
3193
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
|
+
|
|
3194
3360
|
/**
|
|
3195
3361
|
* Request type for GET OrganizationsRoles endpoint
|
|
3196
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
|
|
@@ -2678,6 +2678,134 @@ export type PUT_DomainsByDomainReferenceDnssec_Response_404 = Problem
|
|
|
2678
2678
|
*/
|
|
2679
2679
|
export type PUT_DomainsByDomainReferenceDnssec_Response_422 = HTTPValidationError
|
|
2680
2680
|
|
|
2681
|
+
/**
|
|
2682
|
+
* Response types for POST DomainsByDomainReferenceDnssecDisable endpoint
|
|
2683
|
+
*
|
|
2684
|
+
* Disable DNSSEC for domains using our nameservers
|
|
2685
|
+
*
|
|
2686
|
+
* @remarks
|
|
2687
|
+
* This type defines all possible response structures for the POST DomainsByDomainReferenceDnssecDisable endpoint.
|
|
2688
|
+
* Each response code maps to a specific response type as defined in the OpenAPI specification.
|
|
2689
|
+
* Use this type to ensure type safety when handling API responses from this endpoint.
|
|
2690
|
+
*
|
|
2691
|
+
|
|
2692
|
+
*
|
|
2693
|
+
* @path /v1/domains/{domain_reference}/dnssec/disable
|
|
2694
|
+
*
|
|
2695
|
+
* @see {@link POST_DomainsByDomainReferenceDnssecDisable_Response_404} - 404 response type
|
|
2696
|
+
* @see {@link POST_DomainsByDomainReferenceDnssecDisable_Response_422} - 422 response type
|
|
2697
|
+
*
|
|
2698
|
+
|
|
2699
|
+
*/
|
|
2700
|
+
export type POST_DomainsByDomainReferenceDnssecDisable_Response = POST_DomainsByDomainReferenceDnssecDisable_Response_404 | POST_DomainsByDomainReferenceDnssecDisable_Response_422;
|
|
2701
|
+
|
|
2702
|
+
/**
|
|
2703
|
+
* 404 response for POST DomainsByDomainReferenceDnssecDisable endpoint
|
|
2704
|
+
*
|
|
2705
|
+
* @remarks
|
|
2706
|
+
* This type defines the response structure for the 404 status code
|
|
2707
|
+
* of the POST DomainsByDomainReferenceDnssecDisable endpoint.
|
|
2708
|
+
* It provides type safety for handling this specific response as defined in the OpenAPI specification.
|
|
2709
|
+
*
|
|
2710
|
+
|
|
2711
|
+
*
|
|
2712
|
+
* @path /v1/domains/{domain_reference}/dnssec/disable
|
|
2713
|
+
*
|
|
2714
|
+
* @see {@link POST_DomainsByDomainReferenceDnssecDisable_Response} - The main response type definition
|
|
2715
|
+
* @see {@link Problem} - The actual schema type definition
|
|
2716
|
+
*/
|
|
2717
|
+
export type POST_DomainsByDomainReferenceDnssecDisable_Response_404 = Problem
|
|
2718
|
+
|
|
2719
|
+
/**
|
|
2720
|
+
* 422 response for POST DomainsByDomainReferenceDnssecDisable endpoint
|
|
2721
|
+
*
|
|
2722
|
+
* @remarks
|
|
2723
|
+
* This type defines the response structure for the 422 status code
|
|
2724
|
+
* of the POST DomainsByDomainReferenceDnssecDisable endpoint.
|
|
2725
|
+
* It provides type safety for handling this specific response as defined in the OpenAPI specification.
|
|
2726
|
+
*
|
|
2727
|
+
|
|
2728
|
+
*
|
|
2729
|
+
* @path /v1/domains/{domain_reference}/dnssec/disable
|
|
2730
|
+
*
|
|
2731
|
+
* @see {@link POST_DomainsByDomainReferenceDnssecDisable_Response} - The main response type definition
|
|
2732
|
+
* @see {@link HTTPValidationError} - The actual schema type definition
|
|
2733
|
+
*/
|
|
2734
|
+
export type POST_DomainsByDomainReferenceDnssecDisable_Response_422 = HTTPValidationError
|
|
2735
|
+
|
|
2736
|
+
/**
|
|
2737
|
+
* Response types for POST DomainsByDomainReferenceDnssecEnable endpoint
|
|
2738
|
+
*
|
|
2739
|
+
* Enable DNSSEC for domains using our nameservers
|
|
2740
|
+
*
|
|
2741
|
+
* @remarks
|
|
2742
|
+
* This type defines all possible response structures for the POST DomainsByDomainReferenceDnssecEnable endpoint.
|
|
2743
|
+
* Each response code maps to a specific response type as defined in the OpenAPI specification.
|
|
2744
|
+
* Use this type to ensure type safety when handling API responses from this endpoint.
|
|
2745
|
+
*
|
|
2746
|
+
|
|
2747
|
+
*
|
|
2748
|
+
* @path /v1/domains/{domain_reference}/dnssec/enable
|
|
2749
|
+
*
|
|
2750
|
+
* @see {@link POST_DomainsByDomainReferenceDnssecEnable_Response_200} - 200 response type
|
|
2751
|
+
* @see {@link POST_DomainsByDomainReferenceDnssecEnable_Response_404} - 404 response type
|
|
2752
|
+
* @see {@link POST_DomainsByDomainReferenceDnssecEnable_Response_422} - 422 response type
|
|
2753
|
+
*
|
|
2754
|
+
|
|
2755
|
+
*/
|
|
2756
|
+
export type POST_DomainsByDomainReferenceDnssecEnable_Response = POST_DomainsByDomainReferenceDnssecEnable_Response_200 | POST_DomainsByDomainReferenceDnssecEnable_Response_404 | POST_DomainsByDomainReferenceDnssecEnable_Response_422;
|
|
2757
|
+
|
|
2758
|
+
/**
|
|
2759
|
+
* 200 response for POST DomainsByDomainReferenceDnssecEnable endpoint
|
|
2760
|
+
*
|
|
2761
|
+
* @remarks
|
|
2762
|
+
* This type defines the response structure for the 200 status code
|
|
2763
|
+
* of the POST DomainsByDomainReferenceDnssecEnable endpoint.
|
|
2764
|
+
* It provides type safety for handling this specific response as defined in the OpenAPI specification.
|
|
2765
|
+
*
|
|
2766
|
+
|
|
2767
|
+
*
|
|
2768
|
+
* @path /v1/domains/{domain_reference}/dnssec/enable
|
|
2769
|
+
*
|
|
2770
|
+
* @see {@link POST_DomainsByDomainReferenceDnssecEnable_Response} - The main response type definition
|
|
2771
|
+
* @see {@link DomainDnssecData} - The actual schema type definition
|
|
2772
|
+
*/
|
|
2773
|
+
export type POST_DomainsByDomainReferenceDnssecEnable_Response_200 = DomainDnssecDataArray
|
|
2774
|
+
|
|
2775
|
+
/**
|
|
2776
|
+
* 404 response for POST DomainsByDomainReferenceDnssecEnable endpoint
|
|
2777
|
+
*
|
|
2778
|
+
* @remarks
|
|
2779
|
+
* This type defines the response structure for the 404 status code
|
|
2780
|
+
* of the POST DomainsByDomainReferenceDnssecEnable endpoint.
|
|
2781
|
+
* It provides type safety for handling this specific response as defined in the OpenAPI specification.
|
|
2782
|
+
*
|
|
2783
|
+
|
|
2784
|
+
*
|
|
2785
|
+
* @path /v1/domains/{domain_reference}/dnssec/enable
|
|
2786
|
+
*
|
|
2787
|
+
* @see {@link POST_DomainsByDomainReferenceDnssecEnable_Response} - The main response type definition
|
|
2788
|
+
* @see {@link Problem} - The actual schema type definition
|
|
2789
|
+
*/
|
|
2790
|
+
export type POST_DomainsByDomainReferenceDnssecEnable_Response_404 = Problem
|
|
2791
|
+
|
|
2792
|
+
/**
|
|
2793
|
+
* 422 response for POST DomainsByDomainReferenceDnssecEnable endpoint
|
|
2794
|
+
*
|
|
2795
|
+
* @remarks
|
|
2796
|
+
* This type defines the response structure for the 422 status code
|
|
2797
|
+
* of the POST DomainsByDomainReferenceDnssecEnable endpoint.
|
|
2798
|
+
* It provides type safety for handling this specific response as defined in the OpenAPI specification.
|
|
2799
|
+
*
|
|
2800
|
+
|
|
2801
|
+
*
|
|
2802
|
+
* @path /v1/domains/{domain_reference}/dnssec/enable
|
|
2803
|
+
*
|
|
2804
|
+
* @see {@link POST_DomainsByDomainReferenceDnssecEnable_Response} - The main response type definition
|
|
2805
|
+
* @see {@link HTTPValidationError} - The actual schema type definition
|
|
2806
|
+
*/
|
|
2807
|
+
export type POST_DomainsByDomainReferenceDnssecEnable_Response_422 = HTTPValidationError
|
|
2808
|
+
|
|
2681
2809
|
/**
|
|
2682
2810
|
* Response types for POST DomainsByDomainReferenceRenew endpoint
|
|
2683
2811
|
*
|
|
@@ -4442,6 +4570,116 @@ export type PATCH_OrganizationsByOrganizationIdPlan_Response_200 = OrganizationW
|
|
|
4442
4570
|
*/
|
|
4443
4571
|
export type PATCH_OrganizationsByOrganizationIdPlan_Response_422 = HTTPValidationError
|
|
4444
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
|
+
|
|
4445
4683
|
/**
|
|
4446
4684
|
* Response types for GET OrganizationsIpRestrictions endpoint
|
|
4447
4685
|
*
|
|
@@ -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
|
*
|
package/src/helpers/schemas.d.ts
CHANGED
|
@@ -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
|
*
|