@opusdns/api 0.77.0 → 0.79.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 -103
- package/src/helpers/keys.ts +245 -1279
- package/src/helpers/requests.d.ts +1 -173
- package/src/helpers/responses.d.ts +1 -334
- package/src/helpers/schemas-arrays.d.ts +1 -29
- package/src/helpers/schemas.d.ts +16 -176
- package/src/openapi.yaml +28 -508
- package/src/schema.d.ts +20 -512
|
@@ -34,179 +34,7 @@ import { operations } from '../schema';
|
|
|
34
34
|
|
|
35
35
|
import { DomainDnssecDataCreateArray, OrganizationAttributeUpdateArray } from './schemas-arrays.d';
|
|
36
36
|
|
|
37
|
-
import {
|
|
38
|
-
|
|
39
|
-
/**
|
|
40
|
-
* Request type for GET AuthClientCredentials endpoint
|
|
41
|
-
*
|
|
42
|
-
* List all API keys
|
|
43
|
-
*
|
|
44
|
-
* @remarks
|
|
45
|
-
* This type defines the complete request structure for the GET AuthClientCredentials endpoint.
|
|
46
|
-
* It includes all parameters (query, path) and request body types as defined in the OpenAPI specification.
|
|
47
|
-
* Use this type to ensure type safety when making API requests to this endpoint.
|
|
48
|
-
*
|
|
49
|
-
* @example
|
|
50
|
-
* Use this type to ensure type safety when making API requests to this endpoint.
|
|
51
|
-
*
|
|
52
|
-
* @path /v1/auth/client_credentials
|
|
53
|
-
* @param status (query) - Optional status to filter the results
|
|
54
|
-
*
|
|
55
|
-
* @see {@link GET_AuthClientCredentials_Request_Query} - Query parameters type
|
|
56
|
-
* @see {@link GET_AuthClientCredentials_Request_Path} - Path parameters type
|
|
57
|
-
* @see {@link GET_AuthClientCredentials_Request_Body} - Request body type
|
|
58
|
-
*/
|
|
59
|
-
export type GET_AuthClientCredentials_Request = {
|
|
60
|
-
parameters: {
|
|
61
|
-
query: operations['list_api_keys_v1_auth_client_credentials_get']['parameters']['query'];
|
|
62
|
-
};
|
|
63
|
-
}
|
|
64
|
-
/**
|
|
65
|
-
* Query parameters for GET /v1/auth/client_credentials
|
|
66
|
-
*
|
|
67
|
-
* @remarks
|
|
68
|
-
* This type defines the query parameters for the GET /v1/auth/client_credentials endpoint.
|
|
69
|
-
* It provides type safety for all query parameters as defined in the OpenAPI specification.
|
|
70
|
-
*
|
|
71
|
-
* @example
|
|
72
|
-
* Use this type to ensure type safety for query parameters.
|
|
73
|
-
*
|
|
74
|
-
* @path /v1/auth/client_credentials
|
|
75
|
-
* @param status (query) - Optional status to filter the results
|
|
76
|
-
*/
|
|
77
|
-
export type GET_AuthClientCredentials_Request_Query = GET_AuthClientCredentials_Request['parameters']['query'];
|
|
78
|
-
|
|
79
|
-
/**
|
|
80
|
-
* Request type for POST AuthClientCredentials endpoint
|
|
81
|
-
*
|
|
82
|
-
* Issue an API key
|
|
83
|
-
*
|
|
84
|
-
* @remarks
|
|
85
|
-
* This type defines the complete request structure for the POST AuthClientCredentials endpoint.
|
|
86
|
-
* It includes all parameters (query, path) and request body types as defined in the OpenAPI specification.
|
|
87
|
-
* Use this type to ensure type safety when making API requests to this endpoint.
|
|
88
|
-
*
|
|
89
|
-
* @example
|
|
90
|
-
* Use this type to ensure type safety when making API requests to this endpoint.
|
|
91
|
-
*
|
|
92
|
-
* @path /v1/auth/client_credentials
|
|
93
|
-
*
|
|
94
|
-
* @see {@link POST_AuthClientCredentials_Request_Query} - Query parameters type
|
|
95
|
-
* @see {@link POST_AuthClientCredentials_Request_Path} - Path parameters type
|
|
96
|
-
* @see {@link POST_AuthClientCredentials_Request_Body} - Request body type
|
|
97
|
-
*/
|
|
98
|
-
export type POST_AuthClientCredentials_Request = {
|
|
99
|
-
requestBody: OrganizationCredentialExtra;
|
|
100
|
-
}
|
|
101
|
-
/**
|
|
102
|
-
* Request body for POST /v1/auth/client_credentials
|
|
103
|
-
*
|
|
104
|
-
* @remarks
|
|
105
|
-
* This type defines the request body structure for the POST /v1/auth/client_credentials endpoint.
|
|
106
|
-
* It provides type safety for the request body as defined in the OpenAPI specification.
|
|
107
|
-
*
|
|
108
|
-
* @example
|
|
109
|
-
* Use this type to ensure type safety for request body structure.
|
|
110
|
-
*
|
|
111
|
-
* @path /v1/auth/client_credentials
|
|
112
|
-
*/
|
|
113
|
-
export type POST_AuthClientCredentials_Request_Body = POST_AuthClientCredentials_Request['requestBody'];
|
|
114
|
-
|
|
115
|
-
/**
|
|
116
|
-
* Request type for DELETE AuthClientCredentialsApiKeyId endpoint
|
|
117
|
-
*
|
|
118
|
-
* Delete an API key
|
|
119
|
-
*
|
|
120
|
-
* @remarks
|
|
121
|
-
* This type defines the complete request structure for the DELETE AuthClientCredentialsApiKeyId endpoint.
|
|
122
|
-
* It includes all parameters (query, path) and request body types as defined in the OpenAPI specification.
|
|
123
|
-
* Use this type to ensure type safety when making API requests to this endpoint.
|
|
124
|
-
*
|
|
125
|
-
* @example
|
|
126
|
-
* Use this type to ensure type safety when making API requests to this endpoint.
|
|
127
|
-
*
|
|
128
|
-
* @path /v1/auth/client_credentials/{api_key_id}
|
|
129
|
-
*
|
|
130
|
-
* @see {@link DELETE_AuthClientCredentialsApiKeyId_Request_Query} - Query parameters type
|
|
131
|
-
* @see {@link DELETE_AuthClientCredentialsApiKeyId_Request_Path} - Path parameters type
|
|
132
|
-
* @see {@link DELETE_AuthClientCredentialsApiKeyId_Request_Body} - Request body type
|
|
133
|
-
*/
|
|
134
|
-
export type DELETE_AuthClientCredentialsApiKeyId_Request = {
|
|
135
|
-
parameters: {
|
|
136
|
-
path: operations['delete_api_key_v1_auth_client_credentials__api_key_id__delete']['parameters']['path'];
|
|
137
|
-
};
|
|
138
|
-
}
|
|
139
|
-
/**
|
|
140
|
-
* Path parameters for DELETE /v1/auth/client_credentials/{api_key_id}
|
|
141
|
-
*
|
|
142
|
-
* @remarks
|
|
143
|
-
* This type defines the path parameters for the DELETE /v1/auth/client_credentials/{api_key_id} endpoint.
|
|
144
|
-
* It provides type safety for all path parameters as defined in the OpenAPI specification.
|
|
145
|
-
*
|
|
146
|
-
* @example
|
|
147
|
-
* Use this type to ensure type safety for path parameters.
|
|
148
|
-
*
|
|
149
|
-
* @path /v1/auth/client_credentials/{api_key_id}
|
|
150
|
-
*/
|
|
151
|
-
export type DELETE_AuthClientCredentialsApiKeyId_Request_Path = DELETE_AuthClientCredentialsApiKeyId_Request['parameters']['path'];
|
|
152
|
-
|
|
153
|
-
/**
|
|
154
|
-
* Request type for POST AuthLogout endpoint
|
|
155
|
-
*
|
|
156
|
-
* Logout
|
|
157
|
-
*
|
|
158
|
-
* @remarks
|
|
159
|
-
* This type defines the complete request structure for the POST AuthLogout endpoint.
|
|
160
|
-
* It includes all parameters (query, path) and request body types as defined in the OpenAPI specification.
|
|
161
|
-
* Use this type to ensure type safety when making API requests to this endpoint.
|
|
162
|
-
*
|
|
163
|
-
* @example
|
|
164
|
-
* Use this type to ensure type safety when making API requests to this endpoint.
|
|
165
|
-
*
|
|
166
|
-
* @path /v1/auth/logout
|
|
167
|
-
*
|
|
168
|
-
* @see {@link POST_AuthLogout_Request_Query} - Query parameters type
|
|
169
|
-
* @see {@link POST_AuthLogout_Request_Path} - Path parameters type
|
|
170
|
-
* @see {@link POST_AuthLogout_Request_Body} - Request body type
|
|
171
|
-
*/
|
|
172
|
-
export type POST_AuthLogout_Request = {
|
|
173
|
-
}
|
|
174
|
-
|
|
175
|
-
/**
|
|
176
|
-
* Request type for POST AuthSignup endpoint
|
|
177
|
-
*
|
|
178
|
-
* Signup
|
|
179
|
-
*
|
|
180
|
-
* @remarks
|
|
181
|
-
* This type defines the complete request structure for the POST AuthSignup endpoint.
|
|
182
|
-
* It includes all parameters (query, path) and request body types as defined in the OpenAPI specification.
|
|
183
|
-
* Use this type to ensure type safety when making API requests to this endpoint.
|
|
184
|
-
*
|
|
185
|
-
* @example
|
|
186
|
-
* Use this type to ensure type safety when making API requests to this endpoint.
|
|
187
|
-
*
|
|
188
|
-
* @path /v1/auth/signup
|
|
189
|
-
*
|
|
190
|
-
* @see {@link POST_AuthSignup_Request_Query} - Query parameters type
|
|
191
|
-
* @see {@link POST_AuthSignup_Request_Path} - Path parameters type
|
|
192
|
-
* @see {@link POST_AuthSignup_Request_Body} - Request body type
|
|
193
|
-
*/
|
|
194
|
-
export type POST_AuthSignup_Request = {
|
|
195
|
-
requestBody: SignupCreate;
|
|
196
|
-
}
|
|
197
|
-
/**
|
|
198
|
-
* Request body for POST /v1/auth/signup
|
|
199
|
-
*
|
|
200
|
-
* @remarks
|
|
201
|
-
* This type defines the request body structure for the POST /v1/auth/signup endpoint.
|
|
202
|
-
* It provides type safety for the request body as defined in the OpenAPI specification.
|
|
203
|
-
*
|
|
204
|
-
* @example
|
|
205
|
-
* Use this type to ensure type safety for request body structure.
|
|
206
|
-
*
|
|
207
|
-
* @path /v1/auth/signup
|
|
208
|
-
*/
|
|
209
|
-
export type POST_AuthSignup_Request_Body = POST_AuthSignup_Request['requestBody'];
|
|
37
|
+
import { 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';
|
|
210
38
|
|
|
211
39
|
/**
|
|
212
40
|
* Request type for POST AuthToken endpoint
|
|
@@ -34,340 +34,7 @@
|
|
|
34
34
|
|
|
35
35
|
import { DomainDnssecDataArray, OrganizationAttribute2Array, CustomerCreditCardPaymentMethodArray, IpRestrictionArray, TldResponseShortArray } from './schemas-arrays.d';
|
|
36
36
|
|
|
37
|
-
import {
|
|
38
|
-
|
|
39
|
-
/**
|
|
40
|
-
* Response types for GET AuthClientCredentials endpoint
|
|
41
|
-
*
|
|
42
|
-
* List all API keys
|
|
43
|
-
*
|
|
44
|
-
* @remarks
|
|
45
|
-
* This type defines all possible response structures for the GET AuthClientCredentials endpoint.
|
|
46
|
-
* Each response code maps to a specific response type as defined in the OpenAPI specification.
|
|
47
|
-
* Use this type to ensure type safety when handling API responses from this endpoint.
|
|
48
|
-
*
|
|
49
|
-
|
|
50
|
-
*
|
|
51
|
-
* @path /v1/auth/client_credentials
|
|
52
|
-
* @param status (query) - Optional status to filter the results
|
|
53
|
-
*
|
|
54
|
-
* @see {@link GET_AuthClientCredentials_Response_200} - 200 response type
|
|
55
|
-
* @see {@link GET_AuthClientCredentials_Response_401} - 401 response type
|
|
56
|
-
* @see {@link GET_AuthClientCredentials_Response_422} - 422 response type
|
|
57
|
-
*
|
|
58
|
-
|
|
59
|
-
*/
|
|
60
|
-
export type GET_AuthClientCredentials_Response = GET_AuthClientCredentials_Response_200 | GET_AuthClientCredentials_Response_401 | GET_AuthClientCredentials_Response_422;
|
|
61
|
-
|
|
62
|
-
/**
|
|
63
|
-
* 200 response for GET AuthClientCredentials endpoint
|
|
64
|
-
*
|
|
65
|
-
* @remarks
|
|
66
|
-
* This type defines the response structure for the 200 status code
|
|
67
|
-
* of the GET AuthClientCredentials endpoint.
|
|
68
|
-
* It provides type safety for handling this specific response as defined in the OpenAPI specification.
|
|
69
|
-
*
|
|
70
|
-
|
|
71
|
-
*
|
|
72
|
-
* @path /v1/auth/client_credentials
|
|
73
|
-
* @param status (query) - Optional status to filter the results
|
|
74
|
-
*
|
|
75
|
-
* @see {@link GET_AuthClientCredentials_Response} - The main response type definition
|
|
76
|
-
* @see {@link Pagination_OrganizationCredential} - The actual schema type definition
|
|
77
|
-
*/
|
|
78
|
-
export type GET_AuthClientCredentials_Response_200 = Pagination_OrganizationCredential
|
|
79
|
-
|
|
80
|
-
/**
|
|
81
|
-
* 401 response for GET AuthClientCredentials endpoint
|
|
82
|
-
*
|
|
83
|
-
* @remarks
|
|
84
|
-
* This type defines the response structure for the 401 status code
|
|
85
|
-
* of the GET AuthClientCredentials endpoint.
|
|
86
|
-
* It provides type safety for handling this specific response as defined in the OpenAPI specification.
|
|
87
|
-
*
|
|
88
|
-
|
|
89
|
-
*
|
|
90
|
-
* @path /v1/auth/client_credentials
|
|
91
|
-
* @param status (query) - Optional status to filter the results
|
|
92
|
-
*
|
|
93
|
-
* @see {@link GET_AuthClientCredentials_Response} - The main response type definition
|
|
94
|
-
* @see {@link Problem} - The actual schema type definition
|
|
95
|
-
*/
|
|
96
|
-
export type GET_AuthClientCredentials_Response_401 = Problem
|
|
97
|
-
|
|
98
|
-
/**
|
|
99
|
-
* 422 response for GET AuthClientCredentials endpoint
|
|
100
|
-
*
|
|
101
|
-
* @remarks
|
|
102
|
-
* This type defines the response structure for the 422 status code
|
|
103
|
-
* of the GET AuthClientCredentials endpoint.
|
|
104
|
-
* It provides type safety for handling this specific response as defined in the OpenAPI specification.
|
|
105
|
-
*
|
|
106
|
-
|
|
107
|
-
*
|
|
108
|
-
* @path /v1/auth/client_credentials
|
|
109
|
-
* @param status (query) - Optional status to filter the results
|
|
110
|
-
*
|
|
111
|
-
* @see {@link GET_AuthClientCredentials_Response} - The main response type definition
|
|
112
|
-
* @see {@link HTTPValidationError} - The actual schema type definition
|
|
113
|
-
*/
|
|
114
|
-
export type GET_AuthClientCredentials_Response_422 = HTTPValidationError
|
|
115
|
-
|
|
116
|
-
/**
|
|
117
|
-
* Response types for POST AuthClientCredentials endpoint
|
|
118
|
-
*
|
|
119
|
-
* Issue an API key
|
|
120
|
-
*
|
|
121
|
-
* @remarks
|
|
122
|
-
* This type defines all possible response structures for the POST AuthClientCredentials endpoint.
|
|
123
|
-
* Each response code maps to a specific response type as defined in the OpenAPI specification.
|
|
124
|
-
* Use this type to ensure type safety when handling API responses from this endpoint.
|
|
125
|
-
*
|
|
126
|
-
|
|
127
|
-
*
|
|
128
|
-
* @path /v1/auth/client_credentials
|
|
129
|
-
*
|
|
130
|
-
* @see {@link POST_AuthClientCredentials_Response_200} - 200 response type
|
|
131
|
-
* @see {@link POST_AuthClientCredentials_Response_401} - 401 response type
|
|
132
|
-
* @see {@link POST_AuthClientCredentials_Response_422} - 422 response type
|
|
133
|
-
*
|
|
134
|
-
|
|
135
|
-
*/
|
|
136
|
-
export type POST_AuthClientCredentials_Response = POST_AuthClientCredentials_Response_200 | POST_AuthClientCredentials_Response_401 | POST_AuthClientCredentials_Response_422;
|
|
137
|
-
|
|
138
|
-
/**
|
|
139
|
-
* 200 response for POST AuthClientCredentials endpoint
|
|
140
|
-
*
|
|
141
|
-
* @remarks
|
|
142
|
-
* This type defines the response structure for the 200 status code
|
|
143
|
-
* of the POST AuthClientCredentials endpoint.
|
|
144
|
-
* It provides type safety for handling this specific response as defined in the OpenAPI specification.
|
|
145
|
-
*
|
|
146
|
-
|
|
147
|
-
*
|
|
148
|
-
* @path /v1/auth/client_credentials
|
|
149
|
-
*
|
|
150
|
-
* @see {@link POST_AuthClientCredentials_Response} - The main response type definition
|
|
151
|
-
* @see {@link OrganizationCredentialCreated} - The actual schema type definition
|
|
152
|
-
*/
|
|
153
|
-
export type POST_AuthClientCredentials_Response_200 = OrganizationCredentialCreated
|
|
154
|
-
|
|
155
|
-
/**
|
|
156
|
-
* 401 response for POST AuthClientCredentials endpoint
|
|
157
|
-
*
|
|
158
|
-
* @remarks
|
|
159
|
-
* This type defines the response structure for the 401 status code
|
|
160
|
-
* of the POST AuthClientCredentials endpoint.
|
|
161
|
-
* It provides type safety for handling this specific response as defined in the OpenAPI specification.
|
|
162
|
-
*
|
|
163
|
-
|
|
164
|
-
*
|
|
165
|
-
* @path /v1/auth/client_credentials
|
|
166
|
-
*
|
|
167
|
-
* @see {@link POST_AuthClientCredentials_Response} - The main response type definition
|
|
168
|
-
* @see {@link Problem} - The actual schema type definition
|
|
169
|
-
*/
|
|
170
|
-
export type POST_AuthClientCredentials_Response_401 = Problem
|
|
171
|
-
|
|
172
|
-
/**
|
|
173
|
-
* 422 response for POST AuthClientCredentials endpoint
|
|
174
|
-
*
|
|
175
|
-
* @remarks
|
|
176
|
-
* This type defines the response structure for the 422 status code
|
|
177
|
-
* of the POST AuthClientCredentials endpoint.
|
|
178
|
-
* It provides type safety for handling this specific response as defined in the OpenAPI specification.
|
|
179
|
-
*
|
|
180
|
-
|
|
181
|
-
*
|
|
182
|
-
* @path /v1/auth/client_credentials
|
|
183
|
-
*
|
|
184
|
-
* @see {@link POST_AuthClientCredentials_Response} - The main response type definition
|
|
185
|
-
* @see {@link HTTPValidationError} - The actual schema type definition
|
|
186
|
-
*/
|
|
187
|
-
export type POST_AuthClientCredentials_Response_422 = HTTPValidationError
|
|
188
|
-
|
|
189
|
-
/**
|
|
190
|
-
* Response types for DELETE AuthClientCredentialsByApiKeyId endpoint
|
|
191
|
-
*
|
|
192
|
-
* Delete an API key
|
|
193
|
-
*
|
|
194
|
-
* @remarks
|
|
195
|
-
* This type defines all possible response structures for the DELETE AuthClientCredentialsByApiKeyId endpoint.
|
|
196
|
-
* Each response code maps to a specific response type as defined in the OpenAPI specification.
|
|
197
|
-
* Use this type to ensure type safety when handling API responses from this endpoint.
|
|
198
|
-
*
|
|
199
|
-
|
|
200
|
-
*
|
|
201
|
-
* @path /v1/auth/client_credentials/{api_key_id}
|
|
202
|
-
*
|
|
203
|
-
* @see {@link DELETE_AuthClientCredentialsByApiKeyId_Response_401} - 401 response type
|
|
204
|
-
* @see {@link DELETE_AuthClientCredentialsByApiKeyId_Response_404} - 404 response type
|
|
205
|
-
* @see {@link DELETE_AuthClientCredentialsByApiKeyId_Response_422} - 422 response type
|
|
206
|
-
*
|
|
207
|
-
|
|
208
|
-
*/
|
|
209
|
-
export type DELETE_AuthClientCredentialsByApiKeyId_Response = DELETE_AuthClientCredentialsByApiKeyId_Response_401 | DELETE_AuthClientCredentialsByApiKeyId_Response_404 | DELETE_AuthClientCredentialsByApiKeyId_Response_422;
|
|
210
|
-
|
|
211
|
-
/**
|
|
212
|
-
* 401 response for DELETE AuthClientCredentialsByApiKeyId endpoint
|
|
213
|
-
*
|
|
214
|
-
* @remarks
|
|
215
|
-
* This type defines the response structure for the 401 status code
|
|
216
|
-
* of the DELETE AuthClientCredentialsByApiKeyId endpoint.
|
|
217
|
-
* It provides type safety for handling this specific response as defined in the OpenAPI specification.
|
|
218
|
-
*
|
|
219
|
-
|
|
220
|
-
*
|
|
221
|
-
* @path /v1/auth/client_credentials/{api_key_id}
|
|
222
|
-
*
|
|
223
|
-
* @see {@link DELETE_AuthClientCredentialsByApiKeyId_Response} - The main response type definition
|
|
224
|
-
* @see {@link Problem} - The actual schema type definition
|
|
225
|
-
*/
|
|
226
|
-
export type DELETE_AuthClientCredentialsByApiKeyId_Response_401 = Problem
|
|
227
|
-
|
|
228
|
-
/**
|
|
229
|
-
* 404 response for DELETE AuthClientCredentialsByApiKeyId endpoint
|
|
230
|
-
*
|
|
231
|
-
* @remarks
|
|
232
|
-
* This type defines the response structure for the 404 status code
|
|
233
|
-
* of the DELETE AuthClientCredentialsByApiKeyId endpoint.
|
|
234
|
-
* It provides type safety for handling this specific response as defined in the OpenAPI specification.
|
|
235
|
-
*
|
|
236
|
-
|
|
237
|
-
*
|
|
238
|
-
* @path /v1/auth/client_credentials/{api_key_id}
|
|
239
|
-
*
|
|
240
|
-
* @see {@link DELETE_AuthClientCredentialsByApiKeyId_Response} - The main response type definition
|
|
241
|
-
* @see {@link Problem} - The actual schema type definition
|
|
242
|
-
*/
|
|
243
|
-
export type DELETE_AuthClientCredentialsByApiKeyId_Response_404 = Problem
|
|
244
|
-
|
|
245
|
-
/**
|
|
246
|
-
* 422 response for DELETE AuthClientCredentialsByApiKeyId endpoint
|
|
247
|
-
*
|
|
248
|
-
* @remarks
|
|
249
|
-
* This type defines the response structure for the 422 status code
|
|
250
|
-
* of the DELETE AuthClientCredentialsByApiKeyId endpoint.
|
|
251
|
-
* It provides type safety for handling this specific response as defined in the OpenAPI specification.
|
|
252
|
-
*
|
|
253
|
-
|
|
254
|
-
*
|
|
255
|
-
* @path /v1/auth/client_credentials/{api_key_id}
|
|
256
|
-
*
|
|
257
|
-
* @see {@link DELETE_AuthClientCredentialsByApiKeyId_Response} - The main response type definition
|
|
258
|
-
* @see {@link HTTPValidationError} - The actual schema type definition
|
|
259
|
-
*/
|
|
260
|
-
export type DELETE_AuthClientCredentialsByApiKeyId_Response_422 = HTTPValidationError
|
|
261
|
-
|
|
262
|
-
/**
|
|
263
|
-
* Response types for POST AuthLogout endpoint
|
|
264
|
-
*
|
|
265
|
-
* Logout
|
|
266
|
-
*
|
|
267
|
-
* @remarks
|
|
268
|
-
* This type defines all possible response structures for the POST AuthLogout endpoint.
|
|
269
|
-
* Each response code maps to a specific response type as defined in the OpenAPI specification.
|
|
270
|
-
* Use this type to ensure type safety when handling API responses from this endpoint.
|
|
271
|
-
*
|
|
272
|
-
|
|
273
|
-
*
|
|
274
|
-
* @path /v1/auth/logout
|
|
275
|
-
*
|
|
276
|
-
* @see {@link POST_AuthLogout_Response_401} - 401 response type
|
|
277
|
-
*
|
|
278
|
-
|
|
279
|
-
*/
|
|
280
|
-
export type POST_AuthLogout_Response = POST_AuthLogout_Response_401;
|
|
281
|
-
|
|
282
|
-
/**
|
|
283
|
-
* 401 response for POST AuthLogout endpoint
|
|
284
|
-
*
|
|
285
|
-
* @remarks
|
|
286
|
-
* This type defines the response structure for the 401 status code
|
|
287
|
-
* of the POST AuthLogout endpoint.
|
|
288
|
-
* It provides type safety for handling this specific response as defined in the OpenAPI specification.
|
|
289
|
-
*
|
|
290
|
-
|
|
291
|
-
*
|
|
292
|
-
* @path /v1/auth/logout
|
|
293
|
-
*
|
|
294
|
-
* @see {@link POST_AuthLogout_Response} - The main response type definition
|
|
295
|
-
* @see {@link Problem} - The actual schema type definition
|
|
296
|
-
*/
|
|
297
|
-
export type POST_AuthLogout_Response_401 = Problem
|
|
298
|
-
|
|
299
|
-
/**
|
|
300
|
-
* Response types for POST AuthSignup endpoint
|
|
301
|
-
*
|
|
302
|
-
* Signup
|
|
303
|
-
*
|
|
304
|
-
* @remarks
|
|
305
|
-
* This type defines all possible response structures for the POST AuthSignup endpoint.
|
|
306
|
-
* Each response code maps to a specific response type as defined in the OpenAPI specification.
|
|
307
|
-
* Use this type to ensure type safety when handling API responses from this endpoint.
|
|
308
|
-
*
|
|
309
|
-
|
|
310
|
-
*
|
|
311
|
-
* @path /v1/auth/signup
|
|
312
|
-
*
|
|
313
|
-
* @see {@link POST_AuthSignup_Response_200} - 200 response type
|
|
314
|
-
* @see {@link POST_AuthSignup_Response_409} - 409 response type
|
|
315
|
-
* @see {@link POST_AuthSignup_Response_422} - 422 response type
|
|
316
|
-
*
|
|
317
|
-
|
|
318
|
-
*/
|
|
319
|
-
export type POST_AuthSignup_Response = POST_AuthSignup_Response_200 | POST_AuthSignup_Response_409 | POST_AuthSignup_Response_422;
|
|
320
|
-
|
|
321
|
-
/**
|
|
322
|
-
* 200 response for POST AuthSignup endpoint
|
|
323
|
-
*
|
|
324
|
-
* @remarks
|
|
325
|
-
* This type defines the response structure for the 200 status code
|
|
326
|
-
* of the POST AuthSignup endpoint.
|
|
327
|
-
* It provides type safety for handling this specific response as defined in the OpenAPI specification.
|
|
328
|
-
*
|
|
329
|
-
|
|
330
|
-
*
|
|
331
|
-
* @path /v1/auth/signup
|
|
332
|
-
*
|
|
333
|
-
* @see {@link POST_AuthSignup_Response} - The main response type definition
|
|
334
|
-
* @see {@link Signup} - The actual schema type definition
|
|
335
|
-
*/
|
|
336
|
-
export type POST_AuthSignup_Response_200 = Signup
|
|
337
|
-
|
|
338
|
-
/**
|
|
339
|
-
* 409 response for POST AuthSignup endpoint
|
|
340
|
-
*
|
|
341
|
-
* @remarks
|
|
342
|
-
* This type defines the response structure for the 409 status code
|
|
343
|
-
* of the POST AuthSignup endpoint.
|
|
344
|
-
* It provides type safety for handling this specific response as defined in the OpenAPI specification.
|
|
345
|
-
*
|
|
346
|
-
|
|
347
|
-
*
|
|
348
|
-
* @path /v1/auth/signup
|
|
349
|
-
*
|
|
350
|
-
* @see {@link POST_AuthSignup_Response} - The main response type definition
|
|
351
|
-
* @see {@link Problem} - The actual schema type definition
|
|
352
|
-
*/
|
|
353
|
-
export type POST_AuthSignup_Response_409 = Problem
|
|
354
|
-
|
|
355
|
-
/**
|
|
356
|
-
* 422 response for POST AuthSignup endpoint
|
|
357
|
-
*
|
|
358
|
-
* @remarks
|
|
359
|
-
* This type defines the response structure for the 422 status code
|
|
360
|
-
* of the POST AuthSignup endpoint.
|
|
361
|
-
* It provides type safety for handling this specific response as defined in the OpenAPI specification.
|
|
362
|
-
*
|
|
363
|
-
|
|
364
|
-
*
|
|
365
|
-
* @path /v1/auth/signup
|
|
366
|
-
*
|
|
367
|
-
* @see {@link POST_AuthSignup_Response} - The main response type definition
|
|
368
|
-
* @see {@link HTTPValidationError} - The actual schema type definition
|
|
369
|
-
*/
|
|
370
|
-
export type POST_AuthSignup_Response_422 = HTTPValidationError
|
|
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, CheckoutSession, WalletCreditResponseWithBalance, GetCurrentAvailablePlans, GetPrices, Pagination_BillingTransaction, BillingTransaction, IpRestriction, Pagination_User, TldSpecification, User, UserWithAttributes, PermissionSet, RelationSet, UserWithRelationPermissions } from './schemas.d';
|
|
371
38
|
|
|
372
39
|
/**
|
|
373
40
|
* Response types for POST AuthToken endpoint
|
|
@@ -21,7 +21,7 @@
|
|
|
21
21
|
* This file is auto-generated from the OpenAPI specification.
|
|
22
22
|
* Do not edit manually.
|
|
23
23
|
*/
|
|
24
|
-
import { DomainDnssecData, DomainDnssecDataCreate, OrganizationAttribute, OrganizationAttributeUpdate, IpRestriction, CustomerCreditCardPaymentMethod, TldResponseShort, RegistryHandleAttributeType, ContactAttributeDefinition, ContactRoleAttributeRequirement, 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,
|
|
24
|
+
import { DomainDnssecData, DomainDnssecDataCreate, OrganizationAttribute, OrganizationAttributeUpdate, IpRestriction, CustomerCreditCardPaymentMethod, TldResponseShort, RegistryHandleAttributeType, ContactAttributeDefinition, ContactRoleAttributeRequirement, 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, Organization, Period, Permission, PremiumAffectsType, Relation, TldBase, PostTransferRequirements, UserAttributeBase, DomainAvailability } from './schemas.d';
|
|
25
25
|
|
|
26
26
|
/**
|
|
27
27
|
* DomainDnssecDataResponse
|
|
@@ -639,20 +639,6 @@ export type EmailForwardAliasArray = EmailForwardAlias[];
|
|
|
639
639
|
* @see {@link EventResponse} - The individual EventResponse type definition
|
|
640
640
|
*/
|
|
641
641
|
export type EventResponseArray = EventResponse[];
|
|
642
|
-
/**
|
|
643
|
-
* OrganizationCredential
|
|
644
|
-
*
|
|
645
|
-
* @remarks
|
|
646
|
-
* Array type for OrganizationCredential objects. Used when the API returns a collection of OrganizationCredential instances.
|
|
647
|
-
*
|
|
648
|
-
* @example
|
|
649
|
-
* ```typescript
|
|
650
|
-
* const items: OrganizationCredentialArray = await api.getOrganizationCredentials();
|
|
651
|
-
* ```
|
|
652
|
-
*
|
|
653
|
-
* @see {@link OrganizationCredential} - The individual OrganizationCredential type definition
|
|
654
|
-
*/
|
|
655
|
-
export type OrganizationCredentialArray = OrganizationCredential[];
|
|
656
642
|
/**
|
|
657
643
|
* Organization
|
|
658
644
|
*
|
|
@@ -723,20 +709,6 @@ export type PremiumAffectsTypeArray = PremiumAffectsType[];
|
|
|
723
709
|
* @see {@link Relation} - The individual Relation type definition
|
|
724
710
|
*/
|
|
725
711
|
export type RelationArray = Relation[];
|
|
726
|
-
/**
|
|
727
|
-
* UserAgreementAcceptance
|
|
728
|
-
*
|
|
729
|
-
* @remarks
|
|
730
|
-
* Array type for UserAgreementAcceptance objects. Used when the API returns a collection of UserAgreementAcceptance instances.
|
|
731
|
-
*
|
|
732
|
-
* @example
|
|
733
|
-
* ```typescript
|
|
734
|
-
* const items: UserAgreementAcceptanceArray = await api.getUserAgreementAcceptances();
|
|
735
|
-
* ```
|
|
736
|
-
*
|
|
737
|
-
* @see {@link UserAgreementAcceptance} - The individual UserAgreementAcceptance type definition
|
|
738
|
-
*/
|
|
739
|
-
export type UserAgreementAcceptanceArray = UserAgreementAcceptance[];
|
|
740
712
|
/**
|
|
741
713
|
* TldBase
|
|
742
714
|
*
|