@opusdns/api 0.80.0 → 0.81.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 +1 -53
- package/src/helpers/keys.ts +29 -870
- package/src/helpers/requests.d.ts +2 -317
- package/src/helpers/responses.d.ts +2 -376
- package/src/helpers/schemas-arrays.d.ts +1 -29
- package/src/helpers/schemas.d.ts +0 -144
- package/src/openapi.yaml +14 -461
- package/src/schema.d.ts +2 -518
|
@@ -32,9 +32,9 @@
|
|
|
32
32
|
|
|
33
33
|
|
|
34
34
|
|
|
35
|
-
import { DomainDnssecDataArray, OrganizationAttribute2Array,
|
|
35
|
+
import { DomainDnssecDataArray, OrganizationAttribute2Array, IpRestrictionArray, TldResponseShortArray } from './schemas-arrays.d';
|
|
36
36
|
|
|
37
|
-
import { Problem, HTTPValidationError, 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,
|
|
37
|
+
import { Problem, HTTPValidationError, 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, 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 POST AuthToken endpoint
|
|
@@ -3981,380 +3981,6 @@ export type PATCH_OrganizationsByOrganizationId_Response_200 = Organization
|
|
|
3981
3981
|
*/
|
|
3982
3982
|
export type PATCH_OrganizationsByOrganizationId_Response_422 = HTTPValidationError
|
|
3983
3983
|
|
|
3984
|
-
/**
|
|
3985
|
-
* Response types for POST OrganizationsByOrganizationIdBillingCheckoutSessions endpoint
|
|
3986
|
-
*
|
|
3987
|
-
* Create checkout session
|
|
3988
|
-
* Create a checkout session for the organization
|
|
3989
|
-
*
|
|
3990
|
-
* @remarks
|
|
3991
|
-
* This type defines all possible response structures for the POST OrganizationsByOrganizationIdBillingCheckoutSessions endpoint.
|
|
3992
|
-
* Each response code maps to a specific response type as defined in the OpenAPI specification.
|
|
3993
|
-
* Use this type to ensure type safety when handling API responses from this endpoint.
|
|
3994
|
-
*
|
|
3995
|
-
|
|
3996
|
-
*
|
|
3997
|
-
* @path /v1/organizations/{organization_id}/billing/checkout-sessions
|
|
3998
|
-
*
|
|
3999
|
-
* @see {@link POST_OrganizationsByOrganizationIdBillingCheckoutSessions_Response_200} - 200 response type
|
|
4000
|
-
* @see {@link POST_OrganizationsByOrganizationIdBillingCheckoutSessions_Response_422} - 422 response type
|
|
4001
|
-
*
|
|
4002
|
-
|
|
4003
|
-
*/
|
|
4004
|
-
export type POST_OrganizationsByOrganizationIdBillingCheckoutSessions_Response = POST_OrganizationsByOrganizationIdBillingCheckoutSessions_Response_200 | POST_OrganizationsByOrganizationIdBillingCheckoutSessions_Response_422;
|
|
4005
|
-
|
|
4006
|
-
/**
|
|
4007
|
-
* 200 response for POST OrganizationsByOrganizationIdBillingCheckoutSessions endpoint
|
|
4008
|
-
*
|
|
4009
|
-
* @remarks
|
|
4010
|
-
* This type defines the response structure for the 200 status code
|
|
4011
|
-
* of the POST OrganizationsByOrganizationIdBillingCheckoutSessions endpoint.
|
|
4012
|
-
* It provides type safety for handling this specific response as defined in the OpenAPI specification.
|
|
4013
|
-
*
|
|
4014
|
-
|
|
4015
|
-
*
|
|
4016
|
-
* @path /v1/organizations/{organization_id}/billing/checkout-sessions
|
|
4017
|
-
*
|
|
4018
|
-
* @see {@link POST_OrganizationsByOrganizationIdBillingCheckoutSessions_Response} - The main response type definition
|
|
4019
|
-
* @see {@link CheckoutSession} - The actual schema type definition
|
|
4020
|
-
*/
|
|
4021
|
-
export type POST_OrganizationsByOrganizationIdBillingCheckoutSessions_Response_200 = CheckoutSession
|
|
4022
|
-
|
|
4023
|
-
/**
|
|
4024
|
-
* 422 response for POST OrganizationsByOrganizationIdBillingCheckoutSessions endpoint
|
|
4025
|
-
*
|
|
4026
|
-
* @remarks
|
|
4027
|
-
* This type defines the response structure for the 422 status code
|
|
4028
|
-
* of the POST OrganizationsByOrganizationIdBillingCheckoutSessions endpoint.
|
|
4029
|
-
* It provides type safety for handling this specific response as defined in the OpenAPI specification.
|
|
4030
|
-
*
|
|
4031
|
-
|
|
4032
|
-
*
|
|
4033
|
-
* @path /v1/organizations/{organization_id}/billing/checkout-sessions
|
|
4034
|
-
*
|
|
4035
|
-
* @see {@link POST_OrganizationsByOrganizationIdBillingCheckoutSessions_Response} - The main response type definition
|
|
4036
|
-
* @see {@link HTTPValidationError} - The actual schema type definition
|
|
4037
|
-
*/
|
|
4038
|
-
export type POST_OrganizationsByOrganizationIdBillingCheckoutSessions_Response_422 = HTTPValidationError
|
|
4039
|
-
|
|
4040
|
-
/**
|
|
4041
|
-
* Response types for GET OrganizationsByOrganizationIdBillingPaymentMethods endpoint
|
|
4042
|
-
*
|
|
4043
|
-
* List all payment methods
|
|
4044
|
-
* List all available payment methods for the organization
|
|
4045
|
-
*
|
|
4046
|
-
* @remarks
|
|
4047
|
-
* This type defines all possible response structures for the GET OrganizationsByOrganizationIdBillingPaymentMethods endpoint.
|
|
4048
|
-
* Each response code maps to a specific response type as defined in the OpenAPI specification.
|
|
4049
|
-
* Use this type to ensure type safety when handling API responses from this endpoint.
|
|
4050
|
-
*
|
|
4051
|
-
|
|
4052
|
-
*
|
|
4053
|
-
* @path /v1/organizations/{organization_id}/billing/payment-methods
|
|
4054
|
-
*
|
|
4055
|
-
* @see {@link GET_OrganizationsByOrganizationIdBillingPaymentMethods_Response_200} - 200 response type
|
|
4056
|
-
* @see {@link GET_OrganizationsByOrganizationIdBillingPaymentMethods_Response_422} - 422 response type
|
|
4057
|
-
*
|
|
4058
|
-
|
|
4059
|
-
*/
|
|
4060
|
-
export type GET_OrganizationsByOrganizationIdBillingPaymentMethods_Response = GET_OrganizationsByOrganizationIdBillingPaymentMethods_Response_200 | GET_OrganizationsByOrganizationIdBillingPaymentMethods_Response_422;
|
|
4061
|
-
|
|
4062
|
-
/**
|
|
4063
|
-
* 200 response for GET OrganizationsByOrganizationIdBillingPaymentMethods endpoint
|
|
4064
|
-
*
|
|
4065
|
-
* @remarks
|
|
4066
|
-
* This type defines the response structure for the 200 status code
|
|
4067
|
-
* of the GET OrganizationsByOrganizationIdBillingPaymentMethods endpoint.
|
|
4068
|
-
* It provides type safety for handling this specific response as defined in the OpenAPI specification.
|
|
4069
|
-
*
|
|
4070
|
-
|
|
4071
|
-
*
|
|
4072
|
-
* @path /v1/organizations/{organization_id}/billing/payment-methods
|
|
4073
|
-
*
|
|
4074
|
-
* @see {@link GET_OrganizationsByOrganizationIdBillingPaymentMethods_Response} - The main response type definition
|
|
4075
|
-
* @see {@link CustomerCreditCardPaymentMethod} - The actual schema type definition
|
|
4076
|
-
*/
|
|
4077
|
-
export type GET_OrganizationsByOrganizationIdBillingPaymentMethods_Response_200 = CustomerCreditCardPaymentMethodArray
|
|
4078
|
-
|
|
4079
|
-
/**
|
|
4080
|
-
* 422 response for GET OrganizationsByOrganizationIdBillingPaymentMethods endpoint
|
|
4081
|
-
*
|
|
4082
|
-
* @remarks
|
|
4083
|
-
* This type defines the response structure for the 422 status code
|
|
4084
|
-
* of the GET OrganizationsByOrganizationIdBillingPaymentMethods endpoint.
|
|
4085
|
-
* It provides type safety for handling this specific response as defined in the OpenAPI specification.
|
|
4086
|
-
*
|
|
4087
|
-
|
|
4088
|
-
*
|
|
4089
|
-
* @path /v1/organizations/{organization_id}/billing/payment-methods
|
|
4090
|
-
*
|
|
4091
|
-
* @see {@link GET_OrganizationsByOrganizationIdBillingPaymentMethods_Response} - The main response type definition
|
|
4092
|
-
* @see {@link HTTPValidationError} - The actual schema type definition
|
|
4093
|
-
*/
|
|
4094
|
-
export type GET_OrganizationsByOrganizationIdBillingPaymentMethods_Response_422 = HTTPValidationError
|
|
4095
|
-
|
|
4096
|
-
/**
|
|
4097
|
-
* Response types for DELETE OrganizationsByOrganizationIdBillingPaymentMethodsByPaymentMethodId endpoint
|
|
4098
|
-
*
|
|
4099
|
-
* Delete a payment method
|
|
4100
|
-
* Delete a payment method for the organization
|
|
4101
|
-
*
|
|
4102
|
-
* @remarks
|
|
4103
|
-
* This type defines all possible response structures for the DELETE OrganizationsByOrganizationIdBillingPaymentMethodsByPaymentMethodId endpoint.
|
|
4104
|
-
* Each response code maps to a specific response type as defined in the OpenAPI specification.
|
|
4105
|
-
* Use this type to ensure type safety when handling API responses from this endpoint.
|
|
4106
|
-
*
|
|
4107
|
-
|
|
4108
|
-
*
|
|
4109
|
-
* @path /v1/organizations/{organization_id}/billing/payment-methods/{payment_method_id}
|
|
4110
|
-
*
|
|
4111
|
-
* @see {@link DELETE_OrganizationsByOrganizationIdBillingPaymentMethodsByPaymentMethodId_Response_422} - 422 response type
|
|
4112
|
-
*
|
|
4113
|
-
|
|
4114
|
-
*/
|
|
4115
|
-
export type DELETE_OrganizationsByOrganizationIdBillingPaymentMethodsByPaymentMethodId_Response = DELETE_OrganizationsByOrganizationIdBillingPaymentMethodsByPaymentMethodId_Response_422;
|
|
4116
|
-
|
|
4117
|
-
/**
|
|
4118
|
-
* 422 response for DELETE OrganizationsByOrganizationIdBillingPaymentMethodsByPaymentMethodId endpoint
|
|
4119
|
-
*
|
|
4120
|
-
* @remarks
|
|
4121
|
-
* This type defines the response structure for the 422 status code
|
|
4122
|
-
* of the DELETE OrganizationsByOrganizationIdBillingPaymentMethodsByPaymentMethodId endpoint.
|
|
4123
|
-
* It provides type safety for handling this specific response as defined in the OpenAPI specification.
|
|
4124
|
-
*
|
|
4125
|
-
|
|
4126
|
-
*
|
|
4127
|
-
* @path /v1/organizations/{organization_id}/billing/payment-methods/{payment_method_id}
|
|
4128
|
-
*
|
|
4129
|
-
* @see {@link DELETE_OrganizationsByOrganizationIdBillingPaymentMethodsByPaymentMethodId_Response} - The main response type definition
|
|
4130
|
-
* @see {@link HTTPValidationError} - The actual schema type definition
|
|
4131
|
-
*/
|
|
4132
|
-
export type DELETE_OrganizationsByOrganizationIdBillingPaymentMethodsByPaymentMethodId_Response_422 = HTTPValidationError
|
|
4133
|
-
|
|
4134
|
-
/**
|
|
4135
|
-
* Response types for PATCH OrganizationsByOrganizationIdBillingPaymentMethodsByPaymentMethodIdDefault endpoint
|
|
4136
|
-
*
|
|
4137
|
-
* Set payment method as default
|
|
4138
|
-
* Set the provided payment method as default for the specified organization
|
|
4139
|
-
*
|
|
4140
|
-
* @remarks
|
|
4141
|
-
* This type defines all possible response structures for the PATCH OrganizationsByOrganizationIdBillingPaymentMethodsByPaymentMethodIdDefault endpoint.
|
|
4142
|
-
* Each response code maps to a specific response type as defined in the OpenAPI specification.
|
|
4143
|
-
* Use this type to ensure type safety when handling API responses from this endpoint.
|
|
4144
|
-
*
|
|
4145
|
-
|
|
4146
|
-
*
|
|
4147
|
-
* @path /v1/organizations/{organization_id}/billing/payment-methods/{payment_method_id}/default
|
|
4148
|
-
*
|
|
4149
|
-
* @see {@link PATCH_OrganizationsByOrganizationIdBillingPaymentMethodsByPaymentMethodIdDefault_Response_200} - 200 response type
|
|
4150
|
-
* @see {@link PATCH_OrganizationsByOrganizationIdBillingPaymentMethodsByPaymentMethodIdDefault_Response_422} - 422 response type
|
|
4151
|
-
*
|
|
4152
|
-
|
|
4153
|
-
*/
|
|
4154
|
-
export type PATCH_OrganizationsByOrganizationIdBillingPaymentMethodsByPaymentMethodIdDefault_Response = PATCH_OrganizationsByOrganizationIdBillingPaymentMethodsByPaymentMethodIdDefault_Response_200 | PATCH_OrganizationsByOrganizationIdBillingPaymentMethodsByPaymentMethodIdDefault_Response_422;
|
|
4155
|
-
|
|
4156
|
-
/**
|
|
4157
|
-
* 200 response for PATCH OrganizationsByOrganizationIdBillingPaymentMethodsByPaymentMethodIdDefault endpoint
|
|
4158
|
-
*
|
|
4159
|
-
* @remarks
|
|
4160
|
-
* This type defines the response structure for the 200 status code
|
|
4161
|
-
* of the PATCH OrganizationsByOrganizationIdBillingPaymentMethodsByPaymentMethodIdDefault endpoint.
|
|
4162
|
-
* It provides type safety for handling this specific response as defined in the OpenAPI specification.
|
|
4163
|
-
*
|
|
4164
|
-
|
|
4165
|
-
*
|
|
4166
|
-
* @path /v1/organizations/{organization_id}/billing/payment-methods/{payment_method_id}/default
|
|
4167
|
-
*
|
|
4168
|
-
* @see {@link PATCH_OrganizationsByOrganizationIdBillingPaymentMethodsByPaymentMethodIdDefault_Response} - The main response type definition
|
|
4169
|
-
* @see {@link CustomerCreditCardPaymentMethod} - The actual schema type definition
|
|
4170
|
-
*/
|
|
4171
|
-
export type PATCH_OrganizationsByOrganizationIdBillingPaymentMethodsByPaymentMethodIdDefault_Response_200 = CustomerCreditCardPaymentMethodArray
|
|
4172
|
-
|
|
4173
|
-
/**
|
|
4174
|
-
* 422 response for PATCH OrganizationsByOrganizationIdBillingPaymentMethodsByPaymentMethodIdDefault endpoint
|
|
4175
|
-
*
|
|
4176
|
-
* @remarks
|
|
4177
|
-
* This type defines the response structure for the 422 status code
|
|
4178
|
-
* of the PATCH OrganizationsByOrganizationIdBillingPaymentMethodsByPaymentMethodIdDefault endpoint.
|
|
4179
|
-
* It provides type safety for handling this specific response as defined in the OpenAPI specification.
|
|
4180
|
-
*
|
|
4181
|
-
|
|
4182
|
-
*
|
|
4183
|
-
* @path /v1/organizations/{organization_id}/billing/payment-methods/{payment_method_id}/default
|
|
4184
|
-
*
|
|
4185
|
-
* @see {@link PATCH_OrganizationsByOrganizationIdBillingPaymentMethodsByPaymentMethodIdDefault_Response} - The main response type definition
|
|
4186
|
-
* @see {@link HTTPValidationError} - The actual schema type definition
|
|
4187
|
-
*/
|
|
4188
|
-
export type PATCH_OrganizationsByOrganizationIdBillingPaymentMethodsByPaymentMethodIdDefault_Response_422 = HTTPValidationError
|
|
4189
|
-
|
|
4190
|
-
/**
|
|
4191
|
-
* Response types for POST OrganizationsByOrganizationIdBillingWalletCredits endpoint
|
|
4192
|
-
*
|
|
4193
|
-
* Credit wallet
|
|
4194
|
-
* Credit the organization's wallet using the provided amount and payment method
|
|
4195
|
-
*
|
|
4196
|
-
* @remarks
|
|
4197
|
-
* This type defines all possible response structures for the POST OrganizationsByOrganizationIdBillingWalletCredits endpoint.
|
|
4198
|
-
* Each response code maps to a specific response type as defined in the OpenAPI specification.
|
|
4199
|
-
* Use this type to ensure type safety when handling API responses from this endpoint.
|
|
4200
|
-
*
|
|
4201
|
-
|
|
4202
|
-
*
|
|
4203
|
-
* @path /v1/organizations/{organization_id}/billing/wallet/credits
|
|
4204
|
-
*
|
|
4205
|
-
* @see {@link POST_OrganizationsByOrganizationIdBillingWalletCredits_Response_200} - 200 response type
|
|
4206
|
-
* @see {@link POST_OrganizationsByOrganizationIdBillingWalletCredits_Response_422} - 422 response type
|
|
4207
|
-
*
|
|
4208
|
-
|
|
4209
|
-
*/
|
|
4210
|
-
export type POST_OrganizationsByOrganizationIdBillingWalletCredits_Response = POST_OrganizationsByOrganizationIdBillingWalletCredits_Response_200 | POST_OrganizationsByOrganizationIdBillingWalletCredits_Response_422;
|
|
4211
|
-
|
|
4212
|
-
/**
|
|
4213
|
-
* 200 response for POST OrganizationsByOrganizationIdBillingWalletCredits endpoint
|
|
4214
|
-
*
|
|
4215
|
-
* @remarks
|
|
4216
|
-
* This type defines the response structure for the 200 status code
|
|
4217
|
-
* of the POST OrganizationsByOrganizationIdBillingWalletCredits endpoint.
|
|
4218
|
-
* It provides type safety for handling this specific response as defined in the OpenAPI specification.
|
|
4219
|
-
*
|
|
4220
|
-
|
|
4221
|
-
*
|
|
4222
|
-
* @path /v1/organizations/{organization_id}/billing/wallet/credits
|
|
4223
|
-
*
|
|
4224
|
-
* @see {@link POST_OrganizationsByOrganizationIdBillingWalletCredits_Response} - The main response type definition
|
|
4225
|
-
* @see {@link WalletCreditResponseWithBalance} - The actual schema type definition
|
|
4226
|
-
*/
|
|
4227
|
-
export type POST_OrganizationsByOrganizationIdBillingWalletCredits_Response_200 = WalletCreditResponseWithBalance
|
|
4228
|
-
|
|
4229
|
-
/**
|
|
4230
|
-
* 422 response for POST OrganizationsByOrganizationIdBillingWalletCredits endpoint
|
|
4231
|
-
*
|
|
4232
|
-
* @remarks
|
|
4233
|
-
* This type defines the response structure for the 422 status code
|
|
4234
|
-
* of the POST OrganizationsByOrganizationIdBillingWalletCredits endpoint.
|
|
4235
|
-
* It provides type safety for handling this specific response as defined in the OpenAPI specification.
|
|
4236
|
-
*
|
|
4237
|
-
|
|
4238
|
-
*
|
|
4239
|
-
* @path /v1/organizations/{organization_id}/billing/wallet/credits
|
|
4240
|
-
*
|
|
4241
|
-
* @see {@link POST_OrganizationsByOrganizationIdBillingWalletCredits_Response} - The main response type definition
|
|
4242
|
-
* @see {@link HTTPValidationError} - The actual schema type definition
|
|
4243
|
-
*/
|
|
4244
|
-
export type POST_OrganizationsByOrganizationIdBillingWalletCredits_Response_422 = HTTPValidationError
|
|
4245
|
-
|
|
4246
|
-
/**
|
|
4247
|
-
* Response types for PATCH OrganizationsByOrganizationIdPlan endpoint
|
|
4248
|
-
*
|
|
4249
|
-
* Update organization plan
|
|
4250
|
-
* Changes the plan for an organization
|
|
4251
|
-
*
|
|
4252
|
-
* @remarks
|
|
4253
|
-
* This type defines all possible response structures for the PATCH OrganizationsByOrganizationIdPlan endpoint.
|
|
4254
|
-
* Each response code maps to a specific response type as defined in the OpenAPI specification.
|
|
4255
|
-
* Use this type to ensure type safety when handling API responses from this endpoint.
|
|
4256
|
-
*
|
|
4257
|
-
|
|
4258
|
-
*
|
|
4259
|
-
* @path /v1/organizations/{organization_id}/plan
|
|
4260
|
-
*
|
|
4261
|
-
* @see {@link PATCH_OrganizationsByOrganizationIdPlan_Response_200} - 200 response type
|
|
4262
|
-
* @see {@link PATCH_OrganizationsByOrganizationIdPlan_Response_422} - 422 response type
|
|
4263
|
-
*
|
|
4264
|
-
|
|
4265
|
-
*/
|
|
4266
|
-
export type PATCH_OrganizationsByOrganizationIdPlan_Response = PATCH_OrganizationsByOrganizationIdPlan_Response_200 | PATCH_OrganizationsByOrganizationIdPlan_Response_422;
|
|
4267
|
-
|
|
4268
|
-
/**
|
|
4269
|
-
* 200 response for PATCH OrganizationsByOrganizationIdPlan endpoint
|
|
4270
|
-
*
|
|
4271
|
-
* @remarks
|
|
4272
|
-
* This type defines the response structure for the 200 status code
|
|
4273
|
-
* of the PATCH OrganizationsByOrganizationIdPlan endpoint.
|
|
4274
|
-
* It provides type safety for handling this specific response as defined in the OpenAPI specification.
|
|
4275
|
-
*
|
|
4276
|
-
|
|
4277
|
-
*
|
|
4278
|
-
* @path /v1/organizations/{organization_id}/plan
|
|
4279
|
-
*
|
|
4280
|
-
* @see {@link PATCH_OrganizationsByOrganizationIdPlan_Response} - The main response type definition
|
|
4281
|
-
* @see {@link OrganizationWithBillingData} - The actual schema type definition
|
|
4282
|
-
*/
|
|
4283
|
-
export type PATCH_OrganizationsByOrganizationIdPlan_Response_200 = OrganizationWithBillingData
|
|
4284
|
-
|
|
4285
|
-
/**
|
|
4286
|
-
* 422 response for PATCH OrganizationsByOrganizationIdPlan endpoint
|
|
4287
|
-
*
|
|
4288
|
-
* @remarks
|
|
4289
|
-
* This type defines the response structure for the 422 status code
|
|
4290
|
-
* of the PATCH OrganizationsByOrganizationIdPlan endpoint.
|
|
4291
|
-
* It provides type safety for handling this specific response as defined in the OpenAPI specification.
|
|
4292
|
-
*
|
|
4293
|
-
|
|
4294
|
-
*
|
|
4295
|
-
* @path /v1/organizations/{organization_id}/plan
|
|
4296
|
-
*
|
|
4297
|
-
* @see {@link PATCH_OrganizationsByOrganizationIdPlan_Response} - The main response type definition
|
|
4298
|
-
* @see {@link HTTPValidationError} - The actual schema type definition
|
|
4299
|
-
*/
|
|
4300
|
-
export type PATCH_OrganizationsByOrganizationIdPlan_Response_422 = HTTPValidationError
|
|
4301
|
-
|
|
4302
|
-
/**
|
|
4303
|
-
* Response types for GET OrganizationsByOrganizationIdPlans endpoint
|
|
4304
|
-
*
|
|
4305
|
-
* Get plans for an organization
|
|
4306
|
-
* Retrieves a list of plans for an organization
|
|
4307
|
-
*
|
|
4308
|
-
* @remarks
|
|
4309
|
-
* This type defines all possible response structures for the GET OrganizationsByOrganizationIdPlans endpoint.
|
|
4310
|
-
* Each response code maps to a specific response type as defined in the OpenAPI specification.
|
|
4311
|
-
* Use this type to ensure type safety when handling API responses from this endpoint.
|
|
4312
|
-
*
|
|
4313
|
-
|
|
4314
|
-
*
|
|
4315
|
-
* @path /v1/organizations/{organization_id}/plans
|
|
4316
|
-
*
|
|
4317
|
-
* @see {@link GET_OrganizationsByOrganizationIdPlans_Response_200} - 200 response type
|
|
4318
|
-
* @see {@link GET_OrganizationsByOrganizationIdPlans_Response_422} - 422 response type
|
|
4319
|
-
*
|
|
4320
|
-
|
|
4321
|
-
*/
|
|
4322
|
-
export type GET_OrganizationsByOrganizationIdPlans_Response = GET_OrganizationsByOrganizationIdPlans_Response_200 | GET_OrganizationsByOrganizationIdPlans_Response_422;
|
|
4323
|
-
|
|
4324
|
-
/**
|
|
4325
|
-
* 200 response for GET OrganizationsByOrganizationIdPlans endpoint
|
|
4326
|
-
*
|
|
4327
|
-
* @remarks
|
|
4328
|
-
* This type defines the response structure for the 200 status code
|
|
4329
|
-
* of the GET OrganizationsByOrganizationIdPlans endpoint.
|
|
4330
|
-
* It provides type safety for handling this specific response as defined in the OpenAPI specification.
|
|
4331
|
-
*
|
|
4332
|
-
|
|
4333
|
-
*
|
|
4334
|
-
* @path /v1/organizations/{organization_id}/plans
|
|
4335
|
-
*
|
|
4336
|
-
* @see {@link GET_OrganizationsByOrganizationIdPlans_Response} - The main response type definition
|
|
4337
|
-
* @see {@link GetCurrentAvailablePlans} - The actual schema type definition
|
|
4338
|
-
*/
|
|
4339
|
-
export type GET_OrganizationsByOrganizationIdPlans_Response_200 = GetCurrentAvailablePlans
|
|
4340
|
-
|
|
4341
|
-
/**
|
|
4342
|
-
* 422 response for GET OrganizationsByOrganizationIdPlans endpoint
|
|
4343
|
-
*
|
|
4344
|
-
* @remarks
|
|
4345
|
-
* This type defines the response structure for the 422 status code
|
|
4346
|
-
* of the GET OrganizationsByOrganizationIdPlans endpoint.
|
|
4347
|
-
* It provides type safety for handling this specific response as defined in the OpenAPI specification.
|
|
4348
|
-
*
|
|
4349
|
-
|
|
4350
|
-
*
|
|
4351
|
-
* @path /v1/organizations/{organization_id}/plans
|
|
4352
|
-
*
|
|
4353
|
-
* @see {@link GET_OrganizationsByOrganizationIdPlans_Response} - The main response type definition
|
|
4354
|
-
* @see {@link HTTPValidationError} - The actual schema type definition
|
|
4355
|
-
*/
|
|
4356
|
-
export type GET_OrganizationsByOrganizationIdPlans_Response_422 = HTTPValidationError
|
|
4357
|
-
|
|
4358
3984
|
/**
|
|
4359
3985
|
* Response types for GET OrganizationsByOrganizationIdPricingProductTypeByProductType endpoint
|
|
4360
3986
|
*
|
|
@@ -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,
|
|
24
|
+
import { DomainDnssecData, DomainDnssecDataCreate, OrganizationAttribute, OrganizationAttributeUpdate, IpRestriction, TldResponseShort, RegistryHandleAttributeType, ContactAttributeDefinition, ContactRoleAttributeRequirement, PostalAddressType, ContactConfigBase, DnsChange, DnsRecordCreate, DnsRecord, DnsRrsetCreate, DnsRecordPatchOp, DnsRrset, DnsRrsetPatchOp, DomainAvailabilityCheck, ContactHandle, Nameserver, DeletePolicyType, SyncOperationType, DomainContact, DomainSearchSuggestionWithPrice, DomainStatus, DomainClientStatus, PriceInfo, ValidationError, LaunchPhaseBase, LocalPresenceRequirementType, ContactRoleType, OrganizationAttribute2, User, OrganizationAttributeCreate, UserCreate, BillingTransaction, ContactSchema, DnsZone, Domain, EmailForwardAlias, EventResponse, Organization, Period, Permission, PremiumAffectsType, Relation, TldBase, PostTransferRequirements, UserAttributeBase, DomainAvailability } from './schemas.d';
|
|
25
25
|
|
|
26
26
|
/**
|
|
27
27
|
* DomainDnssecDataResponse
|
|
@@ -93,20 +93,6 @@ 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[];
|
|
110
96
|
/**
|
|
111
97
|
* TldResponseShort
|
|
112
98
|
*
|
|
@@ -415,20 +401,6 @@ export type DomainStatusArray = DomainStatus[];
|
|
|
415
401
|
* @see {@link DomainClientStatus} - The individual DomainClientStatus type definition
|
|
416
402
|
*/
|
|
417
403
|
export type DomainClientStatusArray = DomainClientStatus[];
|
|
418
|
-
/**
|
|
419
|
-
* PlanInfo
|
|
420
|
-
*
|
|
421
|
-
* @remarks
|
|
422
|
-
* Array type for PlanInfo objects. Used when the API returns a collection of PlanInfo instances.
|
|
423
|
-
*
|
|
424
|
-
* @example
|
|
425
|
-
* ```typescript
|
|
426
|
-
* const items: PlanInfoArray = await api.getPlanInfos();
|
|
427
|
-
* ```
|
|
428
|
-
*
|
|
429
|
-
* @see {@link PlanInfo} - The individual PlanInfo type definition
|
|
430
|
-
*/
|
|
431
|
-
export type PlanInfoArray = PlanInfo[];
|
|
432
404
|
/**
|
|
433
405
|
* PriceInfo
|
|
434
406
|
*
|
package/src/helpers/schemas.d.ts
CHANGED
|
@@ -186,38 +186,6 @@ export type BillingTransactionSortField = components['schemas']['BillingTransact
|
|
|
186
186
|
* @see {@link components} - The OpenAPI components schema definition
|
|
187
187
|
*/
|
|
188
188
|
export type BillingTransactionStatus = components['schemas']['BillingTransactionStatus'];
|
|
189
|
-
/**
|
|
190
|
-
* CheckoutSessionRequest
|
|
191
|
-
*
|
|
192
|
-
* @remarks
|
|
193
|
-
* Type alias for the `CheckoutSessionRequest` OpenAPI schema.
|
|
194
|
-
* This type represents checkoutsessionrequest data structures used in API requests and responses.
|
|
195
|
-
*
|
|
196
|
-
* @example
|
|
197
|
-
* ```typescript
|
|
198
|
-
* const response = await api.getCheckoutSessionRequest();
|
|
199
|
-
* const item: CheckoutSessionRequest = response.results;
|
|
200
|
-
* ```
|
|
201
|
-
*
|
|
202
|
-
* @see {@link components} - The OpenAPI components schema definition
|
|
203
|
-
*/
|
|
204
|
-
export type CheckoutSessionRequest = components['schemas']['CheckoutSessionRequest'];
|
|
205
|
-
/**
|
|
206
|
-
* CheckoutSessionResponse
|
|
207
|
-
*
|
|
208
|
-
* @remarks
|
|
209
|
-
* Type alias for the `CheckoutSessionResponse` OpenAPI schema.
|
|
210
|
-
* This type represents checkoutsessionresponse data structures used in API requests and responses.
|
|
211
|
-
*
|
|
212
|
-
* @example
|
|
213
|
-
* ```typescript
|
|
214
|
-
* const response = await api.getCheckoutSession();
|
|
215
|
-
* const item: CheckoutSession = response.results;
|
|
216
|
-
* ```
|
|
217
|
-
*
|
|
218
|
-
* @see {@link components} - The OpenAPI components schema definition
|
|
219
|
-
*/
|
|
220
|
-
export type CheckoutSession = components['schemas']['CheckoutSessionResponse'];
|
|
221
189
|
/**
|
|
222
190
|
* ContactAttributeDefinition. Definition of a possible attribute for a TLD.
|
|
223
191
|
*
|
|
@@ -458,22 +426,6 @@ export type ContactsBase = components['schemas']['ContactsBase'];
|
|
|
458
426
|
* @see {@link components} - The OpenAPI components schema definition
|
|
459
427
|
*/
|
|
460
428
|
export type Currency = components['schemas']['Currency'];
|
|
461
|
-
/**
|
|
462
|
-
* CustomerCreditCardPaymentMethod
|
|
463
|
-
*
|
|
464
|
-
* @remarks
|
|
465
|
-
* Type alias for the `CustomerCreditCardPaymentMethod` OpenAPI schema.
|
|
466
|
-
* This type represents customercreditcardpaymentmethod data structures used in API requests and responses.
|
|
467
|
-
*
|
|
468
|
-
* @example
|
|
469
|
-
* ```typescript
|
|
470
|
-
* const response = await api.getCustomerCreditCardPaymentMethod();
|
|
471
|
-
* const item: CustomerCreditCardPaymentMethod = response.results;
|
|
472
|
-
* ```
|
|
473
|
-
*
|
|
474
|
-
* @see {@link components} - The OpenAPI components schema definition
|
|
475
|
-
*/
|
|
476
|
-
export type CustomerCreditCardPaymentMethod = components['schemas']['CustomerCreditCardPaymentMethod'];
|
|
477
429
|
/**
|
|
478
430
|
* DeletePolicyType
|
|
479
431
|
*
|
|
@@ -1546,22 +1498,6 @@ export type EventType = components['schemas']['EventType'];
|
|
|
1546
1498
|
* @see {@link components} - The OpenAPI components schema definition
|
|
1547
1499
|
*/
|
|
1548
1500
|
export type GeneralAvailabilityBase = components['schemas']['GeneralAvailabilityBase'];
|
|
1549
|
-
/**
|
|
1550
|
-
* GetCurrentAvailablePlansResponse
|
|
1551
|
-
*
|
|
1552
|
-
* @remarks
|
|
1553
|
-
* Type alias for the `GetCurrentAvailablePlansResponse` OpenAPI schema.
|
|
1554
|
-
* This type represents getcurrentavailableplansresponse data structures used in API requests and responses.
|
|
1555
|
-
*
|
|
1556
|
-
* @example
|
|
1557
|
-
* ```typescript
|
|
1558
|
-
* const response = await api.getGetCurrentAvailablePlans();
|
|
1559
|
-
* const item: GetCurrentAvailablePlans = response.results;
|
|
1560
|
-
* ```
|
|
1561
|
-
*
|
|
1562
|
-
* @see {@link components} - The OpenAPI components schema definition
|
|
1563
|
-
*/
|
|
1564
|
-
export type GetCurrentAvailablePlans = components['schemas']['GetCurrentAvailablePlansResponse'];
|
|
1565
1501
|
/**
|
|
1566
1502
|
* GetPricesResponse
|
|
1567
1503
|
*
|
|
@@ -2207,38 +2143,6 @@ export type Permission = components['schemas']['Permission'];
|
|
|
2207
2143
|
* @see {@link components} - The OpenAPI components schema definition
|
|
2208
2144
|
*/
|
|
2209
2145
|
export type PermissionSet = components['schemas']['PermissionSet'];
|
|
2210
|
-
/**
|
|
2211
|
-
* PlanIdRequest
|
|
2212
|
-
*
|
|
2213
|
-
* @remarks
|
|
2214
|
-
* Type alias for the `PlanIdRequest` OpenAPI schema.
|
|
2215
|
-
* This type represents planidrequest data structures used in API requests and responses.
|
|
2216
|
-
*
|
|
2217
|
-
* @example
|
|
2218
|
-
* ```typescript
|
|
2219
|
-
* const response = await api.getPlanIdRequest();
|
|
2220
|
-
* const item: PlanIdRequest = response.results;
|
|
2221
|
-
* ```
|
|
2222
|
-
*
|
|
2223
|
-
* @see {@link components} - The OpenAPI components schema definition
|
|
2224
|
-
*/
|
|
2225
|
-
export type PlanIdRequest = components['schemas']['PlanIdRequest'];
|
|
2226
|
-
/**
|
|
2227
|
-
* PlanInfo
|
|
2228
|
-
*
|
|
2229
|
-
* @remarks
|
|
2230
|
-
* Type alias for the `PlanInfo` OpenAPI schema.
|
|
2231
|
-
* This type represents planinfo data structures used in API requests and responses.
|
|
2232
|
-
*
|
|
2233
|
-
* @example
|
|
2234
|
-
* ```typescript
|
|
2235
|
-
* const response = await api.getPlanInfo();
|
|
2236
|
-
* const item: PlanInfo = response.results;
|
|
2237
|
-
* ```
|
|
2238
|
-
*
|
|
2239
|
-
* @see {@link components} - The OpenAPI components schema definition
|
|
2240
|
-
*/
|
|
2241
|
-
export type PlanInfo = components['schemas']['PlanInfo'];
|
|
2242
2146
|
/**
|
|
2243
2147
|
* PostTransferRequirements
|
|
2244
2148
|
*
|
|
@@ -2879,54 +2783,6 @@ export type ValidationError = components['schemas']['ValidationError'];
|
|
|
2879
2783
|
* @see {@link components} - The OpenAPI components schema definition
|
|
2880
2784
|
*/
|
|
2881
2785
|
export type VerificationType = components['schemas']['VerificationType'];
|
|
2882
|
-
/**
|
|
2883
|
-
* WalletCreditRequest
|
|
2884
|
-
*
|
|
2885
|
-
* @remarks
|
|
2886
|
-
* Type alias for the `WalletCreditRequest` OpenAPI schema.
|
|
2887
|
-
* This type represents walletcreditrequest data structures used in API requests and responses.
|
|
2888
|
-
*
|
|
2889
|
-
* @example
|
|
2890
|
-
* ```typescript
|
|
2891
|
-
* const response = await api.getWalletCreditRequest();
|
|
2892
|
-
* const item: WalletCreditRequest = response.results;
|
|
2893
|
-
* ```
|
|
2894
|
-
*
|
|
2895
|
-
* @see {@link components} - The OpenAPI components schema definition
|
|
2896
|
-
*/
|
|
2897
|
-
export type WalletCreditRequest = components['schemas']['WalletCreditRequest'];
|
|
2898
|
-
/**
|
|
2899
|
-
* WalletCreditResponseStatus
|
|
2900
|
-
*
|
|
2901
|
-
* @remarks
|
|
2902
|
-
* Type alias for the `WalletCreditResponseStatus` OpenAPI schema.
|
|
2903
|
-
* This type represents walletcreditresponsestatus data structures used in API requests and responses.
|
|
2904
|
-
*
|
|
2905
|
-
* @example
|
|
2906
|
-
* ```typescript
|
|
2907
|
-
* const response = await api.getWalletCreditResponseStatus();
|
|
2908
|
-
* const item: WalletCreditResponseStatus = response.results;
|
|
2909
|
-
* ```
|
|
2910
|
-
*
|
|
2911
|
-
* @see {@link components} - The OpenAPI components schema definition
|
|
2912
|
-
*/
|
|
2913
|
-
export type WalletCreditResponseStatus = components['schemas']['WalletCreditResponseStatus'];
|
|
2914
|
-
/**
|
|
2915
|
-
* WalletCreditResponseWithBalance
|
|
2916
|
-
*
|
|
2917
|
-
* @remarks
|
|
2918
|
-
* Type alias for the `WalletCreditResponseWithBalance` OpenAPI schema.
|
|
2919
|
-
* This type represents walletcreditresponsewithbalance data structures used in API requests and responses.
|
|
2920
|
-
*
|
|
2921
|
-
* @example
|
|
2922
|
-
* ```typescript
|
|
2923
|
-
* const response = await api.getWalletCreditResponseWithBalance();
|
|
2924
|
-
* const item: WalletCreditResponseWithBalance = response.results;
|
|
2925
|
-
* ```
|
|
2926
|
-
*
|
|
2927
|
-
* @see {@link components} - The OpenAPI components schema definition
|
|
2928
|
-
*/
|
|
2929
|
-
export type WalletCreditResponseWithBalance = components['schemas']['WalletCreditResponseWithBalance'];
|
|
2930
2786
|
/**
|
|
2931
2787
|
* WhoisBase
|
|
2932
2788
|
*
|