@opusdns/api 0.62.0 → 0.64.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 +51 -57
- package/src/helpers/keys.ts +605 -50
- package/src/helpers/requests.d.ts +220 -2
- package/src/helpers/responses.d.ts +259 -2
- package/src/helpers/schemas-arrays.d.ts +15 -1
- package/src/helpers/schemas.d.ts +108 -28
- package/src/openapi.yaml +325 -18
- package/src/schema.d.ts +354 -11
|
@@ -34,7 +34,7 @@ import { operations } from '../schema';
|
|
|
34
34
|
|
|
35
35
|
import { DomainDnssecDataCreateArray, OrganizationAttributeUpdateArray } from './schemas-arrays.d';
|
|
36
36
|
|
|
37
|
-
import { OrganizationCredentialExtra, SignupCreate, ContactCreate, DnsZoneCreate, DnsZoneRecordsPatchOps, DnsZoneRrsetsPatchOps, DnsZoneRrsetsCreate, DomainCreate, DomainUpdate, DomainRenewRequest, DomainRestoreRequest, DomainTransferIn, EmailForwardAlias, EmailForwardAliasUpdate, OrganizationCreate, IpRestrictionCreate, IpRestrictionUpdate, OrganizationUpdate,
|
|
37
|
+
import { OrganizationCredentialExtra, SignupCreate, ContactCreate, DnsZoneCreate, DnsZoneRecordsPatchOps, DnsZoneRrsetsPatchOps, DnsZoneRrsetsCreate, DomainCreate, DomainUpdate, DomainRenewRequest, DomainRestoreRequest, DomainTransferIn, EmailForwardAlias, EmailForwardAliasUpdate, OrganizationCreate, IpRestrictionCreate, IpRestrictionUpdate, OrganizationUpdate, CheckoutSessionRequest, WalletCreditRequest, PlanIdRequest, UserCreate, PasswordUpdate, UserUpdate, SpiceDbRelationshipUpdate } from './schemas.d';
|
|
38
38
|
|
|
39
39
|
/**
|
|
40
40
|
* Request type for GET AuthClientCredentials endpoint
|
|
@@ -2991,6 +2991,224 @@ export type PATCH_OrganizationsOrganizationId_Request_Path = PATCH_Organizations
|
|
|
2991
2991
|
*/
|
|
2992
2992
|
export type PATCH_OrganizationsOrganizationId_Request_Body = PATCH_OrganizationsOrganizationId_Request['requestBody'];
|
|
2993
2993
|
|
|
2994
|
+
/**
|
|
2995
|
+
* Request type for POST OrganizationsOrganizationIdBillingCheckoutSessions endpoint
|
|
2996
|
+
*
|
|
2997
|
+
* Get Checkout Session
|
|
2998
|
+
*
|
|
2999
|
+
* @remarks
|
|
3000
|
+
* This type defines the complete request structure for the POST OrganizationsOrganizationIdBillingCheckoutSessions endpoint.
|
|
3001
|
+
* It includes all parameters (query, path) and request body types as defined in the OpenAPI specification.
|
|
3002
|
+
* Use this type to ensure type safety when making API requests to this endpoint.
|
|
3003
|
+
*
|
|
3004
|
+
* @example
|
|
3005
|
+
* Use this type to ensure type safety when making API requests to this endpoint.
|
|
3006
|
+
*
|
|
3007
|
+
* @path /v1/organizations/{organization_id}/billing/checkout-sessions
|
|
3008
|
+
*
|
|
3009
|
+
* @see {@link POST_OrganizationsOrganizationIdBillingCheckoutSessions_Request_Query} - Query parameters type
|
|
3010
|
+
* @see {@link POST_OrganizationsOrganizationIdBillingCheckoutSessions_Request_Path} - Path parameters type
|
|
3011
|
+
* @see {@link POST_OrganizationsOrganizationIdBillingCheckoutSessions_Request_Body} - Request body type
|
|
3012
|
+
*/
|
|
3013
|
+
export type POST_OrganizationsOrganizationIdBillingCheckoutSessions_Request = {
|
|
3014
|
+
parameters: {
|
|
3015
|
+
path: operations['get_checkout_session_v1_organizations__organization_id__billing_checkout_sessions_post']['parameters']['path'];
|
|
3016
|
+
};
|
|
3017
|
+
requestBody: CheckoutSessionRequest;
|
|
3018
|
+
}
|
|
3019
|
+
/**
|
|
3020
|
+
* Path parameters for POST /v1/organizations/{organization_id}/billing/checkout-sessions
|
|
3021
|
+
*
|
|
3022
|
+
* @remarks
|
|
3023
|
+
* This type defines the path parameters for the POST /v1/organizations/{organization_id}/billing/checkout-sessions endpoint.
|
|
3024
|
+
* It provides type safety for all path parameters as defined in the OpenAPI specification.
|
|
3025
|
+
*
|
|
3026
|
+
* @example
|
|
3027
|
+
* Use this type to ensure type safety for path parameters.
|
|
3028
|
+
*
|
|
3029
|
+
* @path /v1/organizations/{organization_id}/billing/checkout-sessions
|
|
3030
|
+
*/
|
|
3031
|
+
export type POST_OrganizationsOrganizationIdBillingCheckoutSessions_Request_Path = POST_OrganizationsOrganizationIdBillingCheckoutSessions_Request['parameters']['path'];
|
|
3032
|
+
/**
|
|
3033
|
+
* Request body for POST /v1/organizations/{organization_id}/billing/checkout-sessions
|
|
3034
|
+
*
|
|
3035
|
+
* @remarks
|
|
3036
|
+
* This type defines the request body structure for the POST /v1/organizations/{organization_id}/billing/checkout-sessions endpoint.
|
|
3037
|
+
* It provides type safety for the request body as defined in the OpenAPI specification.
|
|
3038
|
+
*
|
|
3039
|
+
* @example
|
|
3040
|
+
* Use this type to ensure type safety for request body structure.
|
|
3041
|
+
*
|
|
3042
|
+
* @path /v1/organizations/{organization_id}/billing/checkout-sessions
|
|
3043
|
+
*/
|
|
3044
|
+
export type POST_OrganizationsOrganizationIdBillingCheckoutSessions_Request_Body = POST_OrganizationsOrganizationIdBillingCheckoutSessions_Request['requestBody'];
|
|
3045
|
+
|
|
3046
|
+
/**
|
|
3047
|
+
* Request type for GET OrganizationsOrganizationIdBillingPaymentMethods endpoint
|
|
3048
|
+
*
|
|
3049
|
+
* List Payment Methods
|
|
3050
|
+
*
|
|
3051
|
+
* @remarks
|
|
3052
|
+
* This type defines the complete request structure for the GET OrganizationsOrganizationIdBillingPaymentMethods endpoint.
|
|
3053
|
+
* It includes all parameters (query, path) and request body types as defined in the OpenAPI specification.
|
|
3054
|
+
* Use this type to ensure type safety when making API requests to this endpoint.
|
|
3055
|
+
*
|
|
3056
|
+
* @example
|
|
3057
|
+
* Use this type to ensure type safety when making API requests to this endpoint.
|
|
3058
|
+
*
|
|
3059
|
+
* @path /v1/organizations/{organization_id}/billing/payment-methods
|
|
3060
|
+
*
|
|
3061
|
+
* @see {@link GET_OrganizationsOrganizationIdBillingPaymentMethods_Request_Query} - Query parameters type
|
|
3062
|
+
* @see {@link GET_OrganizationsOrganizationIdBillingPaymentMethods_Request_Path} - Path parameters type
|
|
3063
|
+
* @see {@link GET_OrganizationsOrganizationIdBillingPaymentMethods_Request_Body} - Request body type
|
|
3064
|
+
*/
|
|
3065
|
+
export type GET_OrganizationsOrganizationIdBillingPaymentMethods_Request = {
|
|
3066
|
+
parameters: {
|
|
3067
|
+
path: operations['list_payment_methods_v1_organizations__organization_id__billing_payment_methods_get']['parameters']['path'];
|
|
3068
|
+
};
|
|
3069
|
+
}
|
|
3070
|
+
/**
|
|
3071
|
+
* Path parameters for GET /v1/organizations/{organization_id}/billing/payment-methods
|
|
3072
|
+
*
|
|
3073
|
+
* @remarks
|
|
3074
|
+
* This type defines the path parameters for the GET /v1/organizations/{organization_id}/billing/payment-methods endpoint.
|
|
3075
|
+
* It provides type safety for all path parameters as defined in the OpenAPI specification.
|
|
3076
|
+
*
|
|
3077
|
+
* @example
|
|
3078
|
+
* Use this type to ensure type safety for path parameters.
|
|
3079
|
+
*
|
|
3080
|
+
* @path /v1/organizations/{organization_id}/billing/payment-methods
|
|
3081
|
+
*/
|
|
3082
|
+
export type GET_OrganizationsOrganizationIdBillingPaymentMethods_Request_Path = GET_OrganizationsOrganizationIdBillingPaymentMethods_Request['parameters']['path'];
|
|
3083
|
+
|
|
3084
|
+
/**
|
|
3085
|
+
* Request type for DELETE OrganizationsOrganizationIdBillingPaymentMethodsPaymentMethodId endpoint
|
|
3086
|
+
*
|
|
3087
|
+
* Delete Payment Method
|
|
3088
|
+
*
|
|
3089
|
+
* @remarks
|
|
3090
|
+
* This type defines the complete request structure for the DELETE OrganizationsOrganizationIdBillingPaymentMethodsPaymentMethodId endpoint.
|
|
3091
|
+
* It includes all parameters (query, path) and request body types as defined in the OpenAPI specification.
|
|
3092
|
+
* Use this type to ensure type safety when making API requests to this endpoint.
|
|
3093
|
+
*
|
|
3094
|
+
* @example
|
|
3095
|
+
* Use this type to ensure type safety when making API requests to this endpoint.
|
|
3096
|
+
*
|
|
3097
|
+
* @path /v1/organizations/{organization_id}/billing/payment-methods/{payment_method_id}
|
|
3098
|
+
*
|
|
3099
|
+
* @see {@link DELETE_OrganizationsOrganizationIdBillingPaymentMethodsPaymentMethodId_Request_Query} - Query parameters type
|
|
3100
|
+
* @see {@link DELETE_OrganizationsOrganizationIdBillingPaymentMethodsPaymentMethodId_Request_Path} - Path parameters type
|
|
3101
|
+
* @see {@link DELETE_OrganizationsOrganizationIdBillingPaymentMethodsPaymentMethodId_Request_Body} - Request body type
|
|
3102
|
+
*/
|
|
3103
|
+
export type DELETE_OrganizationsOrganizationIdBillingPaymentMethodsPaymentMethodId_Request = {
|
|
3104
|
+
parameters: {
|
|
3105
|
+
path: operations['delete_payment_method_v1_organizations__organization_id__billing_payment_methods__payment_method_id__delete']['parameters']['path'];
|
|
3106
|
+
};
|
|
3107
|
+
}
|
|
3108
|
+
/**
|
|
3109
|
+
* Path parameters for DELETE /v1/organizations/{organization_id}/billing/payment-methods/{payment_method_id}
|
|
3110
|
+
*
|
|
3111
|
+
* @remarks
|
|
3112
|
+
* This type defines the path parameters for the DELETE /v1/organizations/{organization_id}/billing/payment-methods/{payment_method_id} endpoint.
|
|
3113
|
+
* It provides type safety for all path parameters as defined in the OpenAPI specification.
|
|
3114
|
+
*
|
|
3115
|
+
* @example
|
|
3116
|
+
* Use this type to ensure type safety for path parameters.
|
|
3117
|
+
*
|
|
3118
|
+
* @path /v1/organizations/{organization_id}/billing/payment-methods/{payment_method_id}
|
|
3119
|
+
*/
|
|
3120
|
+
export type DELETE_OrganizationsOrganizationIdBillingPaymentMethodsPaymentMethodId_Request_Path = DELETE_OrganizationsOrganizationIdBillingPaymentMethodsPaymentMethodId_Request['parameters']['path'];
|
|
3121
|
+
|
|
3122
|
+
/**
|
|
3123
|
+
* Request type for PATCH OrganizationsOrganizationIdBillingPaymentMethodsPaymentMethodIdDefault endpoint
|
|
3124
|
+
*
|
|
3125
|
+
* Update Default Payment Method
|
|
3126
|
+
*
|
|
3127
|
+
* @remarks
|
|
3128
|
+
* This type defines the complete request structure for the PATCH OrganizationsOrganizationIdBillingPaymentMethodsPaymentMethodIdDefault endpoint.
|
|
3129
|
+
* It includes all parameters (query, path) and request body types as defined in the OpenAPI specification.
|
|
3130
|
+
* Use this type to ensure type safety when making API requests to this endpoint.
|
|
3131
|
+
*
|
|
3132
|
+
* @example
|
|
3133
|
+
* Use this type to ensure type safety when making API requests to this endpoint.
|
|
3134
|
+
*
|
|
3135
|
+
* @path /v1/organizations/{organization_id}/billing/payment-methods/{payment_method_id}/default
|
|
3136
|
+
*
|
|
3137
|
+
* @see {@link PATCH_OrganizationsOrganizationIdBillingPaymentMethodsPaymentMethodIdDefault_Request_Query} - Query parameters type
|
|
3138
|
+
* @see {@link PATCH_OrganizationsOrganizationIdBillingPaymentMethodsPaymentMethodIdDefault_Request_Path} - Path parameters type
|
|
3139
|
+
* @see {@link PATCH_OrganizationsOrganizationIdBillingPaymentMethodsPaymentMethodIdDefault_Request_Body} - Request body type
|
|
3140
|
+
*/
|
|
3141
|
+
export type PATCH_OrganizationsOrganizationIdBillingPaymentMethodsPaymentMethodIdDefault_Request = {
|
|
3142
|
+
parameters: {
|
|
3143
|
+
path: operations['update_default_payment_method_v1_organizations__organization_id__billing_payment_methods__payment_method_id__default_patch']['parameters']['path'];
|
|
3144
|
+
};
|
|
3145
|
+
}
|
|
3146
|
+
/**
|
|
3147
|
+
* Path parameters for PATCH /v1/organizations/{organization_id}/billing/payment-methods/{payment_method_id}/default
|
|
3148
|
+
*
|
|
3149
|
+
* @remarks
|
|
3150
|
+
* This type defines the path parameters for the PATCH /v1/organizations/{organization_id}/billing/payment-methods/{payment_method_id}/default endpoint.
|
|
3151
|
+
* It provides type safety for all path parameters as defined in the OpenAPI specification.
|
|
3152
|
+
*
|
|
3153
|
+
* @example
|
|
3154
|
+
* Use this type to ensure type safety for path parameters.
|
|
3155
|
+
*
|
|
3156
|
+
* @path /v1/organizations/{organization_id}/billing/payment-methods/{payment_method_id}/default
|
|
3157
|
+
*/
|
|
3158
|
+
export type PATCH_OrganizationsOrganizationIdBillingPaymentMethodsPaymentMethodIdDefault_Request_Path = PATCH_OrganizationsOrganizationIdBillingPaymentMethodsPaymentMethodIdDefault_Request['parameters']['path'];
|
|
3159
|
+
|
|
3160
|
+
/**
|
|
3161
|
+
* Request type for POST OrganizationsOrganizationIdBillingWalletCredits endpoint
|
|
3162
|
+
*
|
|
3163
|
+
* Credit Wallet
|
|
3164
|
+
*
|
|
3165
|
+
* @remarks
|
|
3166
|
+
* This type defines the complete request structure for the POST OrganizationsOrganizationIdBillingWalletCredits endpoint.
|
|
3167
|
+
* It includes all parameters (query, path) and request body types as defined in the OpenAPI specification.
|
|
3168
|
+
* Use this type to ensure type safety when making API requests to this endpoint.
|
|
3169
|
+
*
|
|
3170
|
+
* @example
|
|
3171
|
+
* Use this type to ensure type safety when making API requests to this endpoint.
|
|
3172
|
+
*
|
|
3173
|
+
* @path /v1/organizations/{organization_id}/billing/wallet/credits
|
|
3174
|
+
*
|
|
3175
|
+
* @see {@link POST_OrganizationsOrganizationIdBillingWalletCredits_Request_Query} - Query parameters type
|
|
3176
|
+
* @see {@link POST_OrganizationsOrganizationIdBillingWalletCredits_Request_Path} - Path parameters type
|
|
3177
|
+
* @see {@link POST_OrganizationsOrganizationIdBillingWalletCredits_Request_Body} - Request body type
|
|
3178
|
+
*/
|
|
3179
|
+
export type POST_OrganizationsOrganizationIdBillingWalletCredits_Request = {
|
|
3180
|
+
parameters: {
|
|
3181
|
+
path: operations['credit_wallet_v1_organizations__organization_id__billing_wallet_credits_post']['parameters']['path'];
|
|
3182
|
+
};
|
|
3183
|
+
requestBody: WalletCreditRequest;
|
|
3184
|
+
}
|
|
3185
|
+
/**
|
|
3186
|
+
* Path parameters for POST /v1/organizations/{organization_id}/billing/wallet/credits
|
|
3187
|
+
*
|
|
3188
|
+
* @remarks
|
|
3189
|
+
* This type defines the path parameters for the POST /v1/organizations/{organization_id}/billing/wallet/credits endpoint.
|
|
3190
|
+
* It provides type safety for all path parameters as defined in the OpenAPI specification.
|
|
3191
|
+
*
|
|
3192
|
+
* @example
|
|
3193
|
+
* Use this type to ensure type safety for path parameters.
|
|
3194
|
+
*
|
|
3195
|
+
* @path /v1/organizations/{organization_id}/billing/wallet/credits
|
|
3196
|
+
*/
|
|
3197
|
+
export type POST_OrganizationsOrganizationIdBillingWalletCredits_Request_Path = POST_OrganizationsOrganizationIdBillingWalletCredits_Request['parameters']['path'];
|
|
3198
|
+
/**
|
|
3199
|
+
* Request body for POST /v1/organizations/{organization_id}/billing/wallet/credits
|
|
3200
|
+
*
|
|
3201
|
+
* @remarks
|
|
3202
|
+
* This type defines the request body structure for the POST /v1/organizations/{organization_id}/billing/wallet/credits endpoint.
|
|
3203
|
+
* It provides type safety for the request body as defined in the OpenAPI specification.
|
|
3204
|
+
*
|
|
3205
|
+
* @example
|
|
3206
|
+
* Use this type to ensure type safety for request body structure.
|
|
3207
|
+
*
|
|
3208
|
+
* @path /v1/organizations/{organization_id}/billing/wallet/credits
|
|
3209
|
+
*/
|
|
3210
|
+
export type POST_OrganizationsOrganizationIdBillingWalletCredits_Request_Body = POST_OrganizationsOrganizationIdBillingWalletCredits_Request['requestBody'];
|
|
3211
|
+
|
|
2994
3212
|
/**
|
|
2995
3213
|
* Request type for PATCH OrganizationsOrganizationIdPlan endpoint
|
|
2996
3214
|
*
|
|
@@ -3014,7 +3232,7 @@ export type PATCH_OrganizationsOrganizationIdPlan_Request = {
|
|
|
3014
3232
|
parameters: {
|
|
3015
3233
|
path: operations['change_plan_v1_organizations__organization_id__plan_patch']['parameters']['path'];
|
|
3016
3234
|
};
|
|
3017
|
-
requestBody:
|
|
3235
|
+
requestBody: PlanIdRequest;
|
|
3018
3236
|
}
|
|
3019
3237
|
/**
|
|
3020
3238
|
* Path parameters for PATCH /v1/organizations/{organization_id}/plan
|
|
@@ -32,9 +32,9 @@
|
|
|
32
32
|
|
|
33
33
|
|
|
34
34
|
|
|
35
|
-
import { DomainDnssecDataArray, OrganizationAttribute2Array, IpRestrictionArray, TldResponseShortArray } from './schemas-arrays.d';
|
|
35
|
+
import { DomainDnssecDataArray, OrganizationAttribute2Array, CustomerCreditCardPaymentMethodArray, 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, Pagination_BillingTransaction, BillingTransaction, 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, CheckoutSession, WalletCreditResponseWithBalance, 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
|
|
@@ -4296,6 +4296,263 @@ export type PATCH_OrganizationsByOrganizationId_Response_200 = Organization
|
|
|
4296
4296
|
*/
|
|
4297
4297
|
export type PATCH_OrganizationsByOrganizationId_Response_422 = HTTPValidationError
|
|
4298
4298
|
|
|
4299
|
+
/**
|
|
4300
|
+
* Response types for POST OrganizationsByOrganizationIdBillingCheckoutSessions endpoint
|
|
4301
|
+
*
|
|
4302
|
+
* Get Checkout Session
|
|
4303
|
+
*
|
|
4304
|
+
* @remarks
|
|
4305
|
+
* This type defines all possible response structures for the POST OrganizationsByOrganizationIdBillingCheckoutSessions endpoint.
|
|
4306
|
+
* Each response code maps to a specific response type as defined in the OpenAPI specification.
|
|
4307
|
+
* Use this type to ensure type safety when handling API responses from this endpoint.
|
|
4308
|
+
*
|
|
4309
|
+
|
|
4310
|
+
*
|
|
4311
|
+
* @path /v1/organizations/{organization_id}/billing/checkout-sessions
|
|
4312
|
+
*
|
|
4313
|
+
* @see {@link POST_OrganizationsByOrganizationIdBillingCheckoutSessions_Response_200} - 200 response type
|
|
4314
|
+
* @see {@link POST_OrganizationsByOrganizationIdBillingCheckoutSessions_Response_422} - 422 response type
|
|
4315
|
+
*
|
|
4316
|
+
|
|
4317
|
+
*/
|
|
4318
|
+
export type POST_OrganizationsByOrganizationIdBillingCheckoutSessions_Response = POST_OrganizationsByOrganizationIdBillingCheckoutSessions_Response_200 | POST_OrganizationsByOrganizationIdBillingCheckoutSessions_Response_422;
|
|
4319
|
+
|
|
4320
|
+
/**
|
|
4321
|
+
* 200 response for POST OrganizationsByOrganizationIdBillingCheckoutSessions endpoint
|
|
4322
|
+
*
|
|
4323
|
+
* @remarks
|
|
4324
|
+
* This type defines the response structure for the 200 status code
|
|
4325
|
+
* of the POST OrganizationsByOrganizationIdBillingCheckoutSessions endpoint.
|
|
4326
|
+
* It provides type safety for handling this specific response as defined in the OpenAPI specification.
|
|
4327
|
+
*
|
|
4328
|
+
|
|
4329
|
+
*
|
|
4330
|
+
* @path /v1/organizations/{organization_id}/billing/checkout-sessions
|
|
4331
|
+
*
|
|
4332
|
+
* @see {@link POST_OrganizationsByOrganizationIdBillingCheckoutSessions_Response} - The main response type definition
|
|
4333
|
+
* @see {@link CheckoutSession} - The actual schema type definition
|
|
4334
|
+
*/
|
|
4335
|
+
export type POST_OrganizationsByOrganizationIdBillingCheckoutSessions_Response_200 = CheckoutSession
|
|
4336
|
+
|
|
4337
|
+
/**
|
|
4338
|
+
* 422 response for POST OrganizationsByOrganizationIdBillingCheckoutSessions endpoint
|
|
4339
|
+
*
|
|
4340
|
+
* @remarks
|
|
4341
|
+
* This type defines the response structure for the 422 status code
|
|
4342
|
+
* of the POST OrganizationsByOrganizationIdBillingCheckoutSessions endpoint.
|
|
4343
|
+
* It provides type safety for handling this specific response as defined in the OpenAPI specification.
|
|
4344
|
+
*
|
|
4345
|
+
|
|
4346
|
+
*
|
|
4347
|
+
* @path /v1/organizations/{organization_id}/billing/checkout-sessions
|
|
4348
|
+
*
|
|
4349
|
+
* @see {@link POST_OrganizationsByOrganizationIdBillingCheckoutSessions_Response} - The main response type definition
|
|
4350
|
+
* @see {@link HTTPValidationError} - The actual schema type definition
|
|
4351
|
+
*/
|
|
4352
|
+
export type POST_OrganizationsByOrganizationIdBillingCheckoutSessions_Response_422 = HTTPValidationError
|
|
4353
|
+
|
|
4354
|
+
/**
|
|
4355
|
+
* Response types for GET OrganizationsByOrganizationIdBillingPaymentMethods endpoint
|
|
4356
|
+
*
|
|
4357
|
+
* List Payment Methods
|
|
4358
|
+
*
|
|
4359
|
+
* @remarks
|
|
4360
|
+
* This type defines all possible response structures for the GET OrganizationsByOrganizationIdBillingPaymentMethods endpoint.
|
|
4361
|
+
* Each response code maps to a specific response type as defined in the OpenAPI specification.
|
|
4362
|
+
* Use this type to ensure type safety when handling API responses from this endpoint.
|
|
4363
|
+
*
|
|
4364
|
+
|
|
4365
|
+
*
|
|
4366
|
+
* @path /v1/organizations/{organization_id}/billing/payment-methods
|
|
4367
|
+
*
|
|
4368
|
+
* @see {@link GET_OrganizationsByOrganizationIdBillingPaymentMethods_Response_200} - 200 response type
|
|
4369
|
+
* @see {@link GET_OrganizationsByOrganizationIdBillingPaymentMethods_Response_422} - 422 response type
|
|
4370
|
+
*
|
|
4371
|
+
|
|
4372
|
+
*/
|
|
4373
|
+
export type GET_OrganizationsByOrganizationIdBillingPaymentMethods_Response = GET_OrganizationsByOrganizationIdBillingPaymentMethods_Response_200 | GET_OrganizationsByOrganizationIdBillingPaymentMethods_Response_422;
|
|
4374
|
+
|
|
4375
|
+
/**
|
|
4376
|
+
* 200 response for GET OrganizationsByOrganizationIdBillingPaymentMethods endpoint
|
|
4377
|
+
*
|
|
4378
|
+
* @remarks
|
|
4379
|
+
* This type defines the response structure for the 200 status code
|
|
4380
|
+
* of the GET OrganizationsByOrganizationIdBillingPaymentMethods endpoint.
|
|
4381
|
+
* It provides type safety for handling this specific response as defined in the OpenAPI specification.
|
|
4382
|
+
*
|
|
4383
|
+
|
|
4384
|
+
*
|
|
4385
|
+
* @path /v1/organizations/{organization_id}/billing/payment-methods
|
|
4386
|
+
*
|
|
4387
|
+
* @see {@link GET_OrganizationsByOrganizationIdBillingPaymentMethods_Response} - The main response type definition
|
|
4388
|
+
* @see {@link CustomerCreditCardPaymentMethod} - The actual schema type definition
|
|
4389
|
+
*/
|
|
4390
|
+
export type GET_OrganizationsByOrganizationIdBillingPaymentMethods_Response_200 = CustomerCreditCardPaymentMethodArray
|
|
4391
|
+
|
|
4392
|
+
/**
|
|
4393
|
+
* 422 response for GET OrganizationsByOrganizationIdBillingPaymentMethods endpoint
|
|
4394
|
+
*
|
|
4395
|
+
* @remarks
|
|
4396
|
+
* This type defines the response structure for the 422 status code
|
|
4397
|
+
* of the GET OrganizationsByOrganizationIdBillingPaymentMethods endpoint.
|
|
4398
|
+
* It provides type safety for handling this specific response as defined in the OpenAPI specification.
|
|
4399
|
+
*
|
|
4400
|
+
|
|
4401
|
+
*
|
|
4402
|
+
* @path /v1/organizations/{organization_id}/billing/payment-methods
|
|
4403
|
+
*
|
|
4404
|
+
* @see {@link GET_OrganizationsByOrganizationIdBillingPaymentMethods_Response} - The main response type definition
|
|
4405
|
+
* @see {@link HTTPValidationError} - The actual schema type definition
|
|
4406
|
+
*/
|
|
4407
|
+
export type GET_OrganizationsByOrganizationIdBillingPaymentMethods_Response_422 = HTTPValidationError
|
|
4408
|
+
|
|
4409
|
+
/**
|
|
4410
|
+
* Response types for DELETE OrganizationsByOrganizationIdBillingPaymentMethodsByPaymentMethodId endpoint
|
|
4411
|
+
*
|
|
4412
|
+
* Delete Payment Method
|
|
4413
|
+
*
|
|
4414
|
+
* @remarks
|
|
4415
|
+
* This type defines all possible response structures for the DELETE OrganizationsByOrganizationIdBillingPaymentMethodsByPaymentMethodId endpoint.
|
|
4416
|
+
* Each response code maps to a specific response type as defined in the OpenAPI specification.
|
|
4417
|
+
* Use this type to ensure type safety when handling API responses from this endpoint.
|
|
4418
|
+
*
|
|
4419
|
+
|
|
4420
|
+
*
|
|
4421
|
+
* @path /v1/organizations/{organization_id}/billing/payment-methods/{payment_method_id}
|
|
4422
|
+
*
|
|
4423
|
+
* @see {@link DELETE_OrganizationsByOrganizationIdBillingPaymentMethodsByPaymentMethodId_Response_422} - 422 response type
|
|
4424
|
+
*
|
|
4425
|
+
|
|
4426
|
+
*/
|
|
4427
|
+
export type DELETE_OrganizationsByOrganizationIdBillingPaymentMethodsByPaymentMethodId_Response = DELETE_OrganizationsByOrganizationIdBillingPaymentMethodsByPaymentMethodId_Response_422;
|
|
4428
|
+
|
|
4429
|
+
/**
|
|
4430
|
+
* 422 response for DELETE OrganizationsByOrganizationIdBillingPaymentMethodsByPaymentMethodId endpoint
|
|
4431
|
+
*
|
|
4432
|
+
* @remarks
|
|
4433
|
+
* This type defines the response structure for the 422 status code
|
|
4434
|
+
* of the DELETE OrganizationsByOrganizationIdBillingPaymentMethodsByPaymentMethodId endpoint.
|
|
4435
|
+
* It provides type safety for handling this specific response as defined in the OpenAPI specification.
|
|
4436
|
+
*
|
|
4437
|
+
|
|
4438
|
+
*
|
|
4439
|
+
* @path /v1/organizations/{organization_id}/billing/payment-methods/{payment_method_id}
|
|
4440
|
+
*
|
|
4441
|
+
* @see {@link DELETE_OrganizationsByOrganizationIdBillingPaymentMethodsByPaymentMethodId_Response} - The main response type definition
|
|
4442
|
+
* @see {@link HTTPValidationError} - The actual schema type definition
|
|
4443
|
+
*/
|
|
4444
|
+
export type DELETE_OrganizationsByOrganizationIdBillingPaymentMethodsByPaymentMethodId_Response_422 = HTTPValidationError
|
|
4445
|
+
|
|
4446
|
+
/**
|
|
4447
|
+
* Response types for PATCH OrganizationsByOrganizationIdBillingPaymentMethodsByPaymentMethodIdDefault endpoint
|
|
4448
|
+
*
|
|
4449
|
+
* Update Default Payment Method
|
|
4450
|
+
*
|
|
4451
|
+
* @remarks
|
|
4452
|
+
* This type defines all possible response structures for the PATCH OrganizationsByOrganizationIdBillingPaymentMethodsByPaymentMethodIdDefault endpoint.
|
|
4453
|
+
* Each response code maps to a specific response type as defined in the OpenAPI specification.
|
|
4454
|
+
* Use this type to ensure type safety when handling API responses from this endpoint.
|
|
4455
|
+
*
|
|
4456
|
+
|
|
4457
|
+
*
|
|
4458
|
+
* @path /v1/organizations/{organization_id}/billing/payment-methods/{payment_method_id}/default
|
|
4459
|
+
*
|
|
4460
|
+
* @see {@link PATCH_OrganizationsByOrganizationIdBillingPaymentMethodsByPaymentMethodIdDefault_Response_200} - 200 response type
|
|
4461
|
+
* @see {@link PATCH_OrganizationsByOrganizationIdBillingPaymentMethodsByPaymentMethodIdDefault_Response_422} - 422 response type
|
|
4462
|
+
*
|
|
4463
|
+
|
|
4464
|
+
*/
|
|
4465
|
+
export type PATCH_OrganizationsByOrganizationIdBillingPaymentMethodsByPaymentMethodIdDefault_Response = PATCH_OrganizationsByOrganizationIdBillingPaymentMethodsByPaymentMethodIdDefault_Response_200 | PATCH_OrganizationsByOrganizationIdBillingPaymentMethodsByPaymentMethodIdDefault_Response_422;
|
|
4466
|
+
|
|
4467
|
+
/**
|
|
4468
|
+
* 200 response for PATCH OrganizationsByOrganizationIdBillingPaymentMethodsByPaymentMethodIdDefault endpoint
|
|
4469
|
+
*
|
|
4470
|
+
* @remarks
|
|
4471
|
+
* This type defines the response structure for the 200 status code
|
|
4472
|
+
* of the PATCH OrganizationsByOrganizationIdBillingPaymentMethodsByPaymentMethodIdDefault endpoint.
|
|
4473
|
+
* It provides type safety for handling this specific response as defined in the OpenAPI specification.
|
|
4474
|
+
*
|
|
4475
|
+
|
|
4476
|
+
*
|
|
4477
|
+
* @path /v1/organizations/{organization_id}/billing/payment-methods/{payment_method_id}/default
|
|
4478
|
+
*
|
|
4479
|
+
* @see {@link PATCH_OrganizationsByOrganizationIdBillingPaymentMethodsByPaymentMethodIdDefault_Response} - The main response type definition
|
|
4480
|
+
* @see {@link CustomerCreditCardPaymentMethod} - The actual schema type definition
|
|
4481
|
+
*/
|
|
4482
|
+
export type PATCH_OrganizationsByOrganizationIdBillingPaymentMethodsByPaymentMethodIdDefault_Response_200 = CustomerCreditCardPaymentMethodArray
|
|
4483
|
+
|
|
4484
|
+
/**
|
|
4485
|
+
* 422 response for PATCH OrganizationsByOrganizationIdBillingPaymentMethodsByPaymentMethodIdDefault endpoint
|
|
4486
|
+
*
|
|
4487
|
+
* @remarks
|
|
4488
|
+
* This type defines the response structure for the 422 status code
|
|
4489
|
+
* of the PATCH OrganizationsByOrganizationIdBillingPaymentMethodsByPaymentMethodIdDefault endpoint.
|
|
4490
|
+
* It provides type safety for handling this specific response as defined in the OpenAPI specification.
|
|
4491
|
+
*
|
|
4492
|
+
|
|
4493
|
+
*
|
|
4494
|
+
* @path /v1/organizations/{organization_id}/billing/payment-methods/{payment_method_id}/default
|
|
4495
|
+
*
|
|
4496
|
+
* @see {@link PATCH_OrganizationsByOrganizationIdBillingPaymentMethodsByPaymentMethodIdDefault_Response} - The main response type definition
|
|
4497
|
+
* @see {@link HTTPValidationError} - The actual schema type definition
|
|
4498
|
+
*/
|
|
4499
|
+
export type PATCH_OrganizationsByOrganizationIdBillingPaymentMethodsByPaymentMethodIdDefault_Response_422 = HTTPValidationError
|
|
4500
|
+
|
|
4501
|
+
/**
|
|
4502
|
+
* Response types for POST OrganizationsByOrganizationIdBillingWalletCredits endpoint
|
|
4503
|
+
*
|
|
4504
|
+
* Credit Wallet
|
|
4505
|
+
*
|
|
4506
|
+
* @remarks
|
|
4507
|
+
* This type defines all possible response structures for the POST OrganizationsByOrganizationIdBillingWalletCredits endpoint.
|
|
4508
|
+
* Each response code maps to a specific response type as defined in the OpenAPI specification.
|
|
4509
|
+
* Use this type to ensure type safety when handling API responses from this endpoint.
|
|
4510
|
+
*
|
|
4511
|
+
|
|
4512
|
+
*
|
|
4513
|
+
* @path /v1/organizations/{organization_id}/billing/wallet/credits
|
|
4514
|
+
*
|
|
4515
|
+
* @see {@link POST_OrganizationsByOrganizationIdBillingWalletCredits_Response_200} - 200 response type
|
|
4516
|
+
* @see {@link POST_OrganizationsByOrganizationIdBillingWalletCredits_Response_422} - 422 response type
|
|
4517
|
+
*
|
|
4518
|
+
|
|
4519
|
+
*/
|
|
4520
|
+
export type POST_OrganizationsByOrganizationIdBillingWalletCredits_Response = POST_OrganizationsByOrganizationIdBillingWalletCredits_Response_200 | POST_OrganizationsByOrganizationIdBillingWalletCredits_Response_422;
|
|
4521
|
+
|
|
4522
|
+
/**
|
|
4523
|
+
* 200 response for POST OrganizationsByOrganizationIdBillingWalletCredits endpoint
|
|
4524
|
+
*
|
|
4525
|
+
* @remarks
|
|
4526
|
+
* This type defines the response structure for the 200 status code
|
|
4527
|
+
* of the POST OrganizationsByOrganizationIdBillingWalletCredits endpoint.
|
|
4528
|
+
* It provides type safety for handling this specific response as defined in the OpenAPI specification.
|
|
4529
|
+
*
|
|
4530
|
+
|
|
4531
|
+
*
|
|
4532
|
+
* @path /v1/organizations/{organization_id}/billing/wallet/credits
|
|
4533
|
+
*
|
|
4534
|
+
* @see {@link POST_OrganizationsByOrganizationIdBillingWalletCredits_Response} - The main response type definition
|
|
4535
|
+
* @see {@link WalletCreditResponseWithBalance} - The actual schema type definition
|
|
4536
|
+
*/
|
|
4537
|
+
export type POST_OrganizationsByOrganizationIdBillingWalletCredits_Response_200 = WalletCreditResponseWithBalance
|
|
4538
|
+
|
|
4539
|
+
/**
|
|
4540
|
+
* 422 response for POST OrganizationsByOrganizationIdBillingWalletCredits endpoint
|
|
4541
|
+
*
|
|
4542
|
+
* @remarks
|
|
4543
|
+
* This type defines the response structure for the 422 status code
|
|
4544
|
+
* of the POST OrganizationsByOrganizationIdBillingWalletCredits endpoint.
|
|
4545
|
+
* It provides type safety for handling this specific response as defined in the OpenAPI specification.
|
|
4546
|
+
*
|
|
4547
|
+
|
|
4548
|
+
*
|
|
4549
|
+
* @path /v1/organizations/{organization_id}/billing/wallet/credits
|
|
4550
|
+
*
|
|
4551
|
+
* @see {@link POST_OrganizationsByOrganizationIdBillingWalletCredits_Response} - The main response type definition
|
|
4552
|
+
* @see {@link HTTPValidationError} - The actual schema type definition
|
|
4553
|
+
*/
|
|
4554
|
+
export type POST_OrganizationsByOrganizationIdBillingWalletCredits_Response_422 = HTTPValidationError
|
|
4555
|
+
|
|
4299
4556
|
/**
|
|
4300
4557
|
* Response types for PATCH OrganizationsByOrganizationIdPlan endpoint
|
|
4301
4558
|
*
|
|
@@ -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, BillingTransaction, 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, CustomerCreditCardPaymentMethod, 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
|
|
@@ -93,6 +93,20 @@ export type OrganizationAttributeUpdateArray = OrganizationAttributeUpdate[];
|
|
|
93
93
|
* @see {@link IpRestriction} - The individual IpRestrictionResponse type definition
|
|
94
94
|
*/
|
|
95
95
|
export type IpRestrictionArray = IpRestriction[];
|
|
96
|
+
/**
|
|
97
|
+
* CustomerCreditCardPaymentMethod
|
|
98
|
+
*
|
|
99
|
+
* @remarks
|
|
100
|
+
* Array type for CustomerCreditCardPaymentMethod objects. Used when the API returns a collection of CustomerCreditCardPaymentMethod instances.
|
|
101
|
+
*
|
|
102
|
+
* @example
|
|
103
|
+
* ```typescript
|
|
104
|
+
* const items: CustomerCreditCardPaymentMethodArray = await api.getCustomerCreditCardPaymentMethods();
|
|
105
|
+
* ```
|
|
106
|
+
*
|
|
107
|
+
* @see {@link CustomerCreditCardPaymentMethod} - The individual CustomerCreditCardPaymentMethod type definition
|
|
108
|
+
*/
|
|
109
|
+
export type CustomerCreditCardPaymentMethodArray = CustomerCreditCardPaymentMethod[];
|
|
96
110
|
/**
|
|
97
111
|
* TldResponseShort
|
|
98
112
|
*
|