@opusdns/api 0.9.0 → 0.11.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 +5 -5
- package/src/helpers/constants.ts +2633 -0
- package/src/helpers/index.ts +20 -0
- package/src/helpers/keys.ts +19097 -0
- package/src/helpers/requests.ts +3553 -0
- package/src/helpers/responses.ts +5266 -0
- package/src/helpers/schemas-arrays.ts +711 -0
- package/src/helpers/schemas.ts +2908 -0
- package/src/index.d.ts +2 -0
- package/src/openapi.yaml +959 -3
- package/src/schema.d.ts +1078 -0
- package/src/types/constants.ts +109 -0
- package/src/types/keys.ts +1526 -4
- package/src/types/types.ts +470 -4
|
@@ -0,0 +1,2908 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Direct type aliases for OpenAPI schemas
|
|
3
|
+
*
|
|
4
|
+
* This file contains TypeScript type aliases that directly reference OpenAPI schema definitions.
|
|
5
|
+
* Each type alias provides a clean, developer-friendly name for the corresponding OpenAPI schema.
|
|
6
|
+
* These types are used throughout the API for request/response objects and data structures.
|
|
7
|
+
*
|
|
8
|
+
* @remarks
|
|
9
|
+
* - All types follow the pattern: `TypeName = components['schemas']['SchemaName']`
|
|
10
|
+
* - Type names are automatically generated from OpenAPI schema names
|
|
11
|
+
* - Each type includes documentation from the original OpenAPI schema
|
|
12
|
+
* - These types ensure type safety when working with API data
|
|
13
|
+
*
|
|
14
|
+
* @example
|
|
15
|
+
* ```typescript
|
|
16
|
+
* // Using schema types for API responses
|
|
17
|
+
* const response = await api.getDomain('example.com');
|
|
18
|
+
* const domain: Domain = response.results;
|
|
19
|
+
*
|
|
20
|
+
* const contactsResponse = await api.getContacts();
|
|
21
|
+
* const contacts: Contact[] = contactsResponse.results;
|
|
22
|
+
* ```
|
|
23
|
+
*
|
|
24
|
+
* This file is auto-generated from the OpenAPI specification.
|
|
25
|
+
* Do not edit manually.
|
|
26
|
+
*/
|
|
27
|
+
import { components } from '../schema';
|
|
28
|
+
|
|
29
|
+
/**
|
|
30
|
+
* AllocationMethodType
|
|
31
|
+
*
|
|
32
|
+
* @remarks
|
|
33
|
+
* Type alias for the `AllocationMethodType` OpenAPI schema.
|
|
34
|
+
* This type represents allocationmethodtype data structures used in API requests and responses.
|
|
35
|
+
*
|
|
36
|
+
* @example
|
|
37
|
+
* ```typescript
|
|
38
|
+
* const response = await api.getAllocationMethodType();
|
|
39
|
+
* const item: AllocationMethodType = response.results;
|
|
40
|
+
* ```
|
|
41
|
+
*
|
|
42
|
+
* @see {@link components} - The OpenAPI components schema definition
|
|
43
|
+
*/
|
|
44
|
+
export type AllocationMethodType = components['schemas']['AllocationMethodType'];
|
|
45
|
+
/**
|
|
46
|
+
* AllowedNumberOfNameserverBase
|
|
47
|
+
*
|
|
48
|
+
* @remarks
|
|
49
|
+
* Type alias for the `AllowedNumberOfNameserverBase` OpenAPI schema.
|
|
50
|
+
* This type represents allowednumberofnameserverbase data structures used in API requests and responses.
|
|
51
|
+
*
|
|
52
|
+
* @example
|
|
53
|
+
* ```typescript
|
|
54
|
+
* const response = await api.getAllowedNumberOfNameserverBase();
|
|
55
|
+
* const item: AllowedNumberOfNameserverBase = response.results;
|
|
56
|
+
* ```
|
|
57
|
+
*
|
|
58
|
+
* @see {@link components} - The OpenAPI components schema definition
|
|
59
|
+
*/
|
|
60
|
+
export type AllowedNumberOfNameserverBase = components['schemas']['AllowedNumberOfNameserverBase'];
|
|
61
|
+
/**
|
|
62
|
+
* Body_issue_organization_token_v1_auth_token_post
|
|
63
|
+
*
|
|
64
|
+
* @remarks
|
|
65
|
+
* Type alias for the `Body_issue_organization_token_v1_auth_token_post` OpenAPI schema.
|
|
66
|
+
* This type represents body_issue_organization_token_v1_auth_token_post data structures used in API requests and responses.
|
|
67
|
+
*
|
|
68
|
+
* @example
|
|
69
|
+
* ```typescript
|
|
70
|
+
* const response = await api.getBody_issue_organization_token_v1_auth_token_post();
|
|
71
|
+
* const item: Body_issue_organization_token_v1_auth_token_post = response.results;
|
|
72
|
+
* ```
|
|
73
|
+
*
|
|
74
|
+
* @see {@link components} - The OpenAPI components schema definition
|
|
75
|
+
*/
|
|
76
|
+
export type Body_issue_organization_token_v1_auth_token_post = components['schemas']['Body_issue_organization_token_v1_auth_token_post'];
|
|
77
|
+
/**
|
|
78
|
+
* BulkOperationResponse[EmailForwardBulkDeleteResult]
|
|
79
|
+
*
|
|
80
|
+
* @remarks
|
|
81
|
+
* Type alias for the `BulkOperationResponse_EmailForwardBulkDeleteResult_` OpenAPI schema.
|
|
82
|
+
* This type represents bulkoperationresponse[emailforwardbulkdeleteresult] data structures used in API requests and responses.
|
|
83
|
+
*
|
|
84
|
+
* @example
|
|
85
|
+
* ```typescript
|
|
86
|
+
* const response = await api.getEmailForwardBulkDeleteResult();
|
|
87
|
+
* const item: EmailForwardBulkDeleteResult = response.results;
|
|
88
|
+
* ```
|
|
89
|
+
*
|
|
90
|
+
* @see {@link components} - The OpenAPI components schema definition
|
|
91
|
+
*/
|
|
92
|
+
export type EmailForwardBulkDeleteResult = components['schemas']['BulkOperationResponse_EmailForwardBulkDeleteResult_'];
|
|
93
|
+
/**
|
|
94
|
+
* BulkOperationResponse[EmailForwardBulkUpdateResult]
|
|
95
|
+
*
|
|
96
|
+
* @remarks
|
|
97
|
+
* Type alias for the `BulkOperationResponse_EmailForwardBulkUpdateResult_` OpenAPI schema.
|
|
98
|
+
* This type represents bulkoperationresponse[emailforwardbulkupdateresult] data structures used in API requests and responses.
|
|
99
|
+
*
|
|
100
|
+
* @example
|
|
101
|
+
* ```typescript
|
|
102
|
+
* const response = await api.getEmailForwardBulkUpdateResult();
|
|
103
|
+
* const item: EmailForwardBulkUpdateResult = response.results;
|
|
104
|
+
* ```
|
|
105
|
+
*
|
|
106
|
+
* @see {@link components} - The OpenAPI components schema definition
|
|
107
|
+
*/
|
|
108
|
+
export type EmailForwardBulkUpdateResult = components['schemas']['BulkOperationResponse_EmailForwardBulkUpdateResult_'];
|
|
109
|
+
/**
|
|
110
|
+
* BulkOperationResult
|
|
111
|
+
*
|
|
112
|
+
* @remarks
|
|
113
|
+
* Type alias for the `BulkOperationResult` OpenAPI schema.
|
|
114
|
+
* This type represents bulkoperationresult data structures used in API requests and responses.
|
|
115
|
+
*
|
|
116
|
+
* @example
|
|
117
|
+
* ```typescript
|
|
118
|
+
* const response = await api.getBulkOperationResult();
|
|
119
|
+
* const item: BulkOperationResult = response.results;
|
|
120
|
+
* ```
|
|
121
|
+
*
|
|
122
|
+
* @see {@link components} - The OpenAPI components schema definition
|
|
123
|
+
*/
|
|
124
|
+
export type BulkOperationResult = components['schemas']['BulkOperationResult'];
|
|
125
|
+
/**
|
|
126
|
+
* BulkOperationStatus
|
|
127
|
+
*
|
|
128
|
+
* @remarks
|
|
129
|
+
* Type alias for the `BulkOperationStatus` OpenAPI schema.
|
|
130
|
+
* This type represents bulkoperationstatus data structures used in API requests and responses.
|
|
131
|
+
*
|
|
132
|
+
* @example
|
|
133
|
+
* ```typescript
|
|
134
|
+
* const response = await api.getBulkOperationStatus();
|
|
135
|
+
* const item: BulkOperationStatus = response.results;
|
|
136
|
+
* ```
|
|
137
|
+
*
|
|
138
|
+
* @see {@link components} - The OpenAPI components schema definition
|
|
139
|
+
*/
|
|
140
|
+
export type BulkOperationStatus = components['schemas']['BulkOperationStatus'];
|
|
141
|
+
/**
|
|
142
|
+
* ContactConfigBase
|
|
143
|
+
*
|
|
144
|
+
* @remarks
|
|
145
|
+
* Type alias for the `ContactConfigBase` OpenAPI schema.
|
|
146
|
+
* This type represents contactconfigbase data structures used in API requests and responses.
|
|
147
|
+
*
|
|
148
|
+
* @example
|
|
149
|
+
* ```typescript
|
|
150
|
+
* const response = await api.getContactConfigBase();
|
|
151
|
+
* const item: ContactConfigBase = response.results;
|
|
152
|
+
* ```
|
|
153
|
+
*
|
|
154
|
+
* @see {@link components} - The OpenAPI components schema definition
|
|
155
|
+
*/
|
|
156
|
+
export type ContactConfigBase = components['schemas']['ContactConfigBase'];
|
|
157
|
+
/**
|
|
158
|
+
* ContactCreate
|
|
159
|
+
*
|
|
160
|
+
* @remarks
|
|
161
|
+
* Type alias for the `ContactCreate` OpenAPI schema.
|
|
162
|
+
* This type represents contactcreate data structures used in API requests and responses.
|
|
163
|
+
*
|
|
164
|
+
* @example
|
|
165
|
+
* ```typescript
|
|
166
|
+
* const response = await api.getContactCreate();
|
|
167
|
+
* const item: ContactCreate = response.results;
|
|
168
|
+
* ```
|
|
169
|
+
*
|
|
170
|
+
* @see {@link components} - The OpenAPI components schema definition
|
|
171
|
+
*/
|
|
172
|
+
export type ContactCreate = components['schemas']['ContactCreate'];
|
|
173
|
+
/**
|
|
174
|
+
* ContactIdList
|
|
175
|
+
*
|
|
176
|
+
* @remarks
|
|
177
|
+
* Type alias for the `ContactIdList` OpenAPI schema.
|
|
178
|
+
* This type represents contactidlist data structures used in API requests and responses.
|
|
179
|
+
*
|
|
180
|
+
* @example
|
|
181
|
+
* ```typescript
|
|
182
|
+
* const response = await api.getContactIdList();
|
|
183
|
+
* const item: ContactIdList = response.results;
|
|
184
|
+
* ```
|
|
185
|
+
*
|
|
186
|
+
* @see {@link components} - The OpenAPI components schema definition
|
|
187
|
+
*/
|
|
188
|
+
export type ContactIdList = components['schemas']['ContactIdList'];
|
|
189
|
+
/**
|
|
190
|
+
* ContactResponse
|
|
191
|
+
*
|
|
192
|
+
* @remarks
|
|
193
|
+
* Type alias for the `ContactResponse` OpenAPI schema.
|
|
194
|
+
* This type represents contactresponse data structures used in API requests and responses.
|
|
195
|
+
*
|
|
196
|
+
* @example
|
|
197
|
+
* ```typescript
|
|
198
|
+
* const response = await api.getContact();
|
|
199
|
+
* const item: Contact = response.results;
|
|
200
|
+
* ```
|
|
201
|
+
*
|
|
202
|
+
* @see {@link components} - The OpenAPI components schema definition
|
|
203
|
+
*/
|
|
204
|
+
export type Contact = components['schemas']['ContactResponse'];
|
|
205
|
+
/**
|
|
206
|
+
* ContactRoleType
|
|
207
|
+
*
|
|
208
|
+
* @remarks
|
|
209
|
+
* Type alias for the `ContactRoleType` OpenAPI schema.
|
|
210
|
+
* This type represents contactroletype data structures used in API requests and responses.
|
|
211
|
+
*
|
|
212
|
+
* @example
|
|
213
|
+
* ```typescript
|
|
214
|
+
* const response = await api.getContactRoleType();
|
|
215
|
+
* const item: ContactRoleType = response.results;
|
|
216
|
+
* ```
|
|
217
|
+
*
|
|
218
|
+
* @see {@link components} - The OpenAPI components schema definition
|
|
219
|
+
*/
|
|
220
|
+
export type ContactRoleType = components['schemas']['ContactRoleType'];
|
|
221
|
+
/**
|
|
222
|
+
* ContactSchema
|
|
223
|
+
*
|
|
224
|
+
* @remarks
|
|
225
|
+
* Type alias for the `ContactSchema` OpenAPI schema.
|
|
226
|
+
* This type represents contactschema data structures used in API requests and responses.
|
|
227
|
+
*
|
|
228
|
+
* @example
|
|
229
|
+
* ```typescript
|
|
230
|
+
* const response = await api.getContactSchema();
|
|
231
|
+
* const item: ContactSchema = response.results;
|
|
232
|
+
* ```
|
|
233
|
+
*
|
|
234
|
+
* @see {@link components} - The OpenAPI components schema definition
|
|
235
|
+
*/
|
|
236
|
+
export type ContactSchema = components['schemas']['ContactSchema'];
|
|
237
|
+
/**
|
|
238
|
+
* ContactSortField
|
|
239
|
+
*
|
|
240
|
+
* @remarks
|
|
241
|
+
* Type alias for the `ContactSortField` OpenAPI schema.
|
|
242
|
+
* This type represents contactsortfield data structures used in API requests and responses.
|
|
243
|
+
*
|
|
244
|
+
* @example
|
|
245
|
+
* ```typescript
|
|
246
|
+
* const response = await api.getContactSortField();
|
|
247
|
+
* const item: ContactSortField = response.results;
|
|
248
|
+
* ```
|
|
249
|
+
*
|
|
250
|
+
* @see {@link components} - The OpenAPI components schema definition
|
|
251
|
+
*/
|
|
252
|
+
export type ContactSortField = components['schemas']['ContactSortField'];
|
|
253
|
+
/**
|
|
254
|
+
* ContactVerificationApiResponse
|
|
255
|
+
*
|
|
256
|
+
* @remarks
|
|
257
|
+
* Type alias for the `ContactVerificationApiResponse` OpenAPI schema.
|
|
258
|
+
* This type represents contactverificationapiresponse data structures used in API requests and responses.
|
|
259
|
+
*
|
|
260
|
+
* @example
|
|
261
|
+
* ```typescript
|
|
262
|
+
* const response = await api.getContactVerificationApi();
|
|
263
|
+
* const item: ContactVerificationApi = response.results;
|
|
264
|
+
* ```
|
|
265
|
+
*
|
|
266
|
+
* @see {@link components} - The OpenAPI components schema definition
|
|
267
|
+
*/
|
|
268
|
+
export type ContactVerificationApi = components['schemas']['ContactVerificationApiResponse'];
|
|
269
|
+
/**
|
|
270
|
+
* ContactVerificationEmailResponse
|
|
271
|
+
*
|
|
272
|
+
* @remarks
|
|
273
|
+
* Type alias for the `ContactVerificationEmailResponse` OpenAPI schema.
|
|
274
|
+
* This type represents contactverificationemailresponse data structures used in API requests and responses.
|
|
275
|
+
*
|
|
276
|
+
* @example
|
|
277
|
+
* ```typescript
|
|
278
|
+
* const response = await api.getContactVerificationEmail();
|
|
279
|
+
* const item: ContactVerificationEmail = response.results;
|
|
280
|
+
* ```
|
|
281
|
+
*
|
|
282
|
+
* @see {@link components} - The OpenAPI components schema definition
|
|
283
|
+
*/
|
|
284
|
+
export type ContactVerificationEmail = components['schemas']['ContactVerificationEmailResponse'];
|
|
285
|
+
/**
|
|
286
|
+
* ContactVerificationResponse
|
|
287
|
+
*
|
|
288
|
+
* @remarks
|
|
289
|
+
* Type alias for the `ContactVerificationResponse` OpenAPI schema.
|
|
290
|
+
* This type represents contactverificationresponse data structures used in API requests and responses.
|
|
291
|
+
*
|
|
292
|
+
* @example
|
|
293
|
+
* ```typescript
|
|
294
|
+
* const response = await api.getContactVerification();
|
|
295
|
+
* const item: ContactVerification = response.results;
|
|
296
|
+
* ```
|
|
297
|
+
*
|
|
298
|
+
* @see {@link components} - The OpenAPI components schema definition
|
|
299
|
+
*/
|
|
300
|
+
export type ContactVerification = components['schemas']['ContactVerificationResponse'];
|
|
301
|
+
/**
|
|
302
|
+
* ContactsBase
|
|
303
|
+
*
|
|
304
|
+
* @remarks
|
|
305
|
+
* Type alias for the `ContactsBase` OpenAPI schema.
|
|
306
|
+
* This type represents contactsbase data structures used in API requests and responses.
|
|
307
|
+
*
|
|
308
|
+
* @example
|
|
309
|
+
* ```typescript
|
|
310
|
+
* const response = await api.getContactsBase();
|
|
311
|
+
* const item: ContactsBase = response.results;
|
|
312
|
+
* ```
|
|
313
|
+
*
|
|
314
|
+
* @see {@link components} - The OpenAPI components schema definition
|
|
315
|
+
*/
|
|
316
|
+
export type ContactsBase = components['schemas']['ContactsBase'];
|
|
317
|
+
/**
|
|
318
|
+
* Currency
|
|
319
|
+
*
|
|
320
|
+
* @remarks
|
|
321
|
+
* Type alias for the `Currency` OpenAPI schema.
|
|
322
|
+
* This type represents currency data structures used in API requests and responses.
|
|
323
|
+
*
|
|
324
|
+
* @example
|
|
325
|
+
* ```typescript
|
|
326
|
+
* const response = await api.getCurrency();
|
|
327
|
+
* const item: Currency = response.results;
|
|
328
|
+
* ```
|
|
329
|
+
*
|
|
330
|
+
* @see {@link components} - The OpenAPI components schema definition
|
|
331
|
+
*/
|
|
332
|
+
export type Currency = components['schemas']['Currency'];
|
|
333
|
+
/**
|
|
334
|
+
* DeletePolicyType
|
|
335
|
+
*
|
|
336
|
+
* @remarks
|
|
337
|
+
* Type alias for the `DeletePolicyType` OpenAPI schema.
|
|
338
|
+
* This type represents deletepolicytype data structures used in API requests and responses.
|
|
339
|
+
*
|
|
340
|
+
* @example
|
|
341
|
+
* ```typescript
|
|
342
|
+
* const response = await api.getDeletePolicyType();
|
|
343
|
+
* const item: DeletePolicyType = response.results;
|
|
344
|
+
* ```
|
|
345
|
+
*
|
|
346
|
+
* @see {@link components} - The OpenAPI components schema definition
|
|
347
|
+
*/
|
|
348
|
+
export type DeletePolicyType = components['schemas']['DeletePolicyType'];
|
|
349
|
+
/**
|
|
350
|
+
* DeletedEvent
|
|
351
|
+
*
|
|
352
|
+
* @remarks
|
|
353
|
+
* Type alias for the `DeletedEvent` OpenAPI schema.
|
|
354
|
+
* This type represents deletedevent data structures used in API requests and responses.
|
|
355
|
+
*
|
|
356
|
+
* @example
|
|
357
|
+
* ```typescript
|
|
358
|
+
* const response = await api.getDeletedEvent();
|
|
359
|
+
* const item: DeletedEvent = response.results;
|
|
360
|
+
* ```
|
|
361
|
+
*
|
|
362
|
+
* @see {@link components} - The OpenAPI components schema definition
|
|
363
|
+
*/
|
|
364
|
+
export type DeletedEvent = components['schemas']['DeletedEvent'];
|
|
365
|
+
/**
|
|
366
|
+
* DnsChangeAction
|
|
367
|
+
*
|
|
368
|
+
* @remarks
|
|
369
|
+
* Type alias for the `DnsChangeAction` OpenAPI schema.
|
|
370
|
+
* This type represents dnschangeaction data structures used in API requests and responses.
|
|
371
|
+
*
|
|
372
|
+
* @example
|
|
373
|
+
* ```typescript
|
|
374
|
+
* const response = await api.getDnsChangeAction();
|
|
375
|
+
* const item: DnsChangeAction = response.results;
|
|
376
|
+
* ```
|
|
377
|
+
*
|
|
378
|
+
* @see {@link components} - The OpenAPI components schema definition
|
|
379
|
+
*/
|
|
380
|
+
export type DnsChangeAction = components['schemas']['DnsChangeAction'];
|
|
381
|
+
/**
|
|
382
|
+
* DnsChangeResponse
|
|
383
|
+
*
|
|
384
|
+
* @remarks
|
|
385
|
+
* Type alias for the `DnsChangeResponse` OpenAPI schema.
|
|
386
|
+
* This type represents dnschangeresponse data structures used in API requests and responses.
|
|
387
|
+
*
|
|
388
|
+
* @example
|
|
389
|
+
* ```typescript
|
|
390
|
+
* const response = await api.getDnsChange();
|
|
391
|
+
* const item: DnsChange = response.results;
|
|
392
|
+
* ```
|
|
393
|
+
*
|
|
394
|
+
* @see {@link components} - The OpenAPI components schema definition
|
|
395
|
+
*/
|
|
396
|
+
export type DnsChange = components['schemas']['DnsChangeResponse'];
|
|
397
|
+
/**
|
|
398
|
+
* DnsChangesResponse
|
|
399
|
+
*
|
|
400
|
+
* @remarks
|
|
401
|
+
* Type alias for the `DnsChangesResponse` OpenAPI schema.
|
|
402
|
+
* This type represents dnschangesresponse data structures used in API requests and responses.
|
|
403
|
+
*
|
|
404
|
+
* @example
|
|
405
|
+
* ```typescript
|
|
406
|
+
* const response = await api.getDnsChanges();
|
|
407
|
+
* const item: DnsChanges = response.results;
|
|
408
|
+
* ```
|
|
409
|
+
*
|
|
410
|
+
* @see {@link components} - The OpenAPI components schema definition
|
|
411
|
+
*/
|
|
412
|
+
export type DnsChanges = components['schemas']['DnsChangesResponse'];
|
|
413
|
+
/**
|
|
414
|
+
* DnsConfigurationBase
|
|
415
|
+
*
|
|
416
|
+
* @remarks
|
|
417
|
+
* Type alias for the `DnsConfigurationBase` OpenAPI schema.
|
|
418
|
+
* This type represents dnsconfigurationbase data structures used in API requests and responses.
|
|
419
|
+
*
|
|
420
|
+
* @example
|
|
421
|
+
* ```typescript
|
|
422
|
+
* const response = await api.getDnsConfigurationBase();
|
|
423
|
+
* const item: DnsConfigurationBase = response.results;
|
|
424
|
+
* ```
|
|
425
|
+
*
|
|
426
|
+
* @see {@link components} - The OpenAPI components schema definition
|
|
427
|
+
*/
|
|
428
|
+
export type DnsConfigurationBase = components['schemas']['DnsConfigurationBase'];
|
|
429
|
+
/**
|
|
430
|
+
* DnsRecordCreate
|
|
431
|
+
*
|
|
432
|
+
* @remarks
|
|
433
|
+
* Type alias for the `DnsRecordCreate` OpenAPI schema.
|
|
434
|
+
* This type represents dnsrecordcreate data structures used in API requests and responses.
|
|
435
|
+
*
|
|
436
|
+
* @example
|
|
437
|
+
* ```typescript
|
|
438
|
+
* const response = await api.getDnsRecordCreate();
|
|
439
|
+
* const item: DnsRecordCreate = response.results;
|
|
440
|
+
* ```
|
|
441
|
+
*
|
|
442
|
+
* @see {@link components} - The OpenAPI components schema definition
|
|
443
|
+
*/
|
|
444
|
+
export type DnsRecordCreate = components['schemas']['DnsRecordCreate'];
|
|
445
|
+
/**
|
|
446
|
+
* DnsRecordPatchOp
|
|
447
|
+
*
|
|
448
|
+
* @remarks
|
|
449
|
+
* Type alias for the `DnsRecordPatchOp` OpenAPI schema.
|
|
450
|
+
* This type represents dnsrecordpatchop data structures used in API requests and responses.
|
|
451
|
+
*
|
|
452
|
+
* @example
|
|
453
|
+
* ```typescript
|
|
454
|
+
* const response = await api.getDnsRecordPatchOp();
|
|
455
|
+
* const item: DnsRecordPatchOp = response.results;
|
|
456
|
+
* ```
|
|
457
|
+
*
|
|
458
|
+
* @see {@link components} - The OpenAPI components schema definition
|
|
459
|
+
*/
|
|
460
|
+
export type DnsRecordPatchOp = components['schemas']['DnsRecordPatchOp'];
|
|
461
|
+
/**
|
|
462
|
+
* DnsRecordResponse
|
|
463
|
+
*
|
|
464
|
+
* @remarks
|
|
465
|
+
* Type alias for the `DnsRecordResponse` OpenAPI schema.
|
|
466
|
+
* This type represents dnsrecordresponse data structures used in API requests and responses.
|
|
467
|
+
*
|
|
468
|
+
* @example
|
|
469
|
+
* ```typescript
|
|
470
|
+
* const response = await api.getDnsRecord();
|
|
471
|
+
* const item: DnsRecord = response.results;
|
|
472
|
+
* ```
|
|
473
|
+
*
|
|
474
|
+
* @see {@link components} - The OpenAPI components schema definition
|
|
475
|
+
*/
|
|
476
|
+
export type DnsRecord = components['schemas']['DnsRecordResponse'];
|
|
477
|
+
/**
|
|
478
|
+
* DnsRrsetCreate
|
|
479
|
+
*
|
|
480
|
+
* @remarks
|
|
481
|
+
* Type alias for the `DnsRrsetCreate` OpenAPI schema.
|
|
482
|
+
* This type represents dnsrrsetcreate data structures used in API requests and responses.
|
|
483
|
+
*
|
|
484
|
+
* @example
|
|
485
|
+
* ```typescript
|
|
486
|
+
* const response = await api.getDnsRrsetCreate();
|
|
487
|
+
* const item: DnsRrsetCreate = response.results;
|
|
488
|
+
* ```
|
|
489
|
+
*
|
|
490
|
+
* @see {@link components} - The OpenAPI components schema definition
|
|
491
|
+
*/
|
|
492
|
+
export type DnsRrsetCreate = components['schemas']['DnsRrsetCreate'];
|
|
493
|
+
/**
|
|
494
|
+
* DnsRrsetPatch
|
|
495
|
+
*
|
|
496
|
+
* @remarks
|
|
497
|
+
* Type alias for the `DnsRrsetPatch` OpenAPI schema.
|
|
498
|
+
* This type represents dnsrrsetpatch data structures used in API requests and responses.
|
|
499
|
+
*
|
|
500
|
+
* @example
|
|
501
|
+
* ```typescript
|
|
502
|
+
* const response = await api.getDnsRrsetPatch();
|
|
503
|
+
* const item: DnsRrsetPatch = response.results;
|
|
504
|
+
* ```
|
|
505
|
+
*
|
|
506
|
+
* @see {@link components} - The OpenAPI components schema definition
|
|
507
|
+
*/
|
|
508
|
+
export type DnsRrsetPatch = components['schemas']['DnsRrsetPatch'];
|
|
509
|
+
/**
|
|
510
|
+
* DnsRrsetPatchOp
|
|
511
|
+
*
|
|
512
|
+
* @remarks
|
|
513
|
+
* Type alias for the `DnsRrsetPatchOp` OpenAPI schema.
|
|
514
|
+
* This type represents dnsrrsetpatchop data structures used in API requests and responses.
|
|
515
|
+
*
|
|
516
|
+
* @example
|
|
517
|
+
* ```typescript
|
|
518
|
+
* const response = await api.getDnsRrsetPatchOp();
|
|
519
|
+
* const item: DnsRrsetPatchOp = response.results;
|
|
520
|
+
* ```
|
|
521
|
+
*
|
|
522
|
+
* @see {@link components} - The OpenAPI components schema definition
|
|
523
|
+
*/
|
|
524
|
+
export type DnsRrsetPatchOp = components['schemas']['DnsRrsetPatchOp'];
|
|
525
|
+
/**
|
|
526
|
+
* DnsRrsetResponse
|
|
527
|
+
*
|
|
528
|
+
* @remarks
|
|
529
|
+
* Type alias for the `DnsRrsetResponse` OpenAPI schema.
|
|
530
|
+
* This type represents dnsrrsetresponse data structures used in API requests and responses.
|
|
531
|
+
*
|
|
532
|
+
* @example
|
|
533
|
+
* ```typescript
|
|
534
|
+
* const response = await api.getDnsRrset();
|
|
535
|
+
* const item: DnsRrset = response.results;
|
|
536
|
+
* ```
|
|
537
|
+
*
|
|
538
|
+
* @see {@link components} - The OpenAPI components schema definition
|
|
539
|
+
*/
|
|
540
|
+
export type DnsRrset = components['schemas']['DnsRrsetResponse'];
|
|
541
|
+
/**
|
|
542
|
+
* DnsRrsetType
|
|
543
|
+
*
|
|
544
|
+
* @remarks
|
|
545
|
+
* Type alias for the `DnsRrsetType` OpenAPI schema.
|
|
546
|
+
* This type represents dnsrrsettype data structures used in API requests and responses.
|
|
547
|
+
*
|
|
548
|
+
* @example
|
|
549
|
+
* ```typescript
|
|
550
|
+
* const response = await api.getDnsRrsetType();
|
|
551
|
+
* const item: DnsRrsetType = response.results;
|
|
552
|
+
* ```
|
|
553
|
+
*
|
|
554
|
+
* @see {@link components} - The OpenAPI components schema definition
|
|
555
|
+
*/
|
|
556
|
+
export type DnsRrsetType = components['schemas']['DnsRrsetType'];
|
|
557
|
+
/**
|
|
558
|
+
* DnsRrsetWithOneRecordPatch
|
|
559
|
+
*
|
|
560
|
+
* @remarks
|
|
561
|
+
* Type alias for the `DnsRrsetWithOneRecordPatch` OpenAPI schema.
|
|
562
|
+
* This type represents dnsrrsetwithonerecordpatch data structures used in API requests and responses.
|
|
563
|
+
*
|
|
564
|
+
* @example
|
|
565
|
+
* ```typescript
|
|
566
|
+
* const response = await api.getDnsRrsetWithOneRecordPatch();
|
|
567
|
+
* const item: DnsRrsetWithOneRecordPatch = response.results;
|
|
568
|
+
* ```
|
|
569
|
+
*
|
|
570
|
+
* @see {@link components} - The OpenAPI components schema definition
|
|
571
|
+
*/
|
|
572
|
+
export type DnsRrsetWithOneRecordPatch = components['schemas']['DnsRrsetWithOneRecordPatch'];
|
|
573
|
+
/**
|
|
574
|
+
* DnsZoneCreate
|
|
575
|
+
*
|
|
576
|
+
* @remarks
|
|
577
|
+
* Type alias for the `DnsZoneCreate` OpenAPI schema.
|
|
578
|
+
* This type represents dnszonecreate data structures used in API requests and responses.
|
|
579
|
+
*
|
|
580
|
+
* @example
|
|
581
|
+
* ```typescript
|
|
582
|
+
* const response = await api.getDnsZoneCreate();
|
|
583
|
+
* const item: DnsZoneCreate = response.results;
|
|
584
|
+
* ```
|
|
585
|
+
*
|
|
586
|
+
* @see {@link components} - The OpenAPI components schema definition
|
|
587
|
+
*/
|
|
588
|
+
export type DnsZoneCreate = components['schemas']['DnsZoneCreate'];
|
|
589
|
+
/**
|
|
590
|
+
* DnsZoneRecordsPatchOps
|
|
591
|
+
*
|
|
592
|
+
* @remarks
|
|
593
|
+
* Type alias for the `DnsZoneRecordsPatchOps` OpenAPI schema.
|
|
594
|
+
* This type represents dnszonerecordspatchops data structures used in API requests and responses.
|
|
595
|
+
*
|
|
596
|
+
* @example
|
|
597
|
+
* ```typescript
|
|
598
|
+
* const response = await api.getDnsZoneRecordsPatchOps();
|
|
599
|
+
* const item: DnsZoneRecordsPatchOps = response.results;
|
|
600
|
+
* ```
|
|
601
|
+
*
|
|
602
|
+
* @see {@link components} - The OpenAPI components schema definition
|
|
603
|
+
*/
|
|
604
|
+
export type DnsZoneRecordsPatchOps = components['schemas']['DnsZoneRecordsPatchOps'];
|
|
605
|
+
/**
|
|
606
|
+
* DnsZoneResponse
|
|
607
|
+
*
|
|
608
|
+
* @remarks
|
|
609
|
+
* Type alias for the `DnsZoneResponse` OpenAPI schema.
|
|
610
|
+
* This type represents dnszoneresponse data structures used in API requests and responses.
|
|
611
|
+
*
|
|
612
|
+
* @example
|
|
613
|
+
* ```typescript
|
|
614
|
+
* const response = await api.getDnsZone();
|
|
615
|
+
* const item: DnsZone = response.results;
|
|
616
|
+
* ```
|
|
617
|
+
*
|
|
618
|
+
* @see {@link components} - The OpenAPI components schema definition
|
|
619
|
+
*/
|
|
620
|
+
export type DnsZone = components['schemas']['DnsZoneResponse'];
|
|
621
|
+
/**
|
|
622
|
+
* DnsZoneRrsetsCreate
|
|
623
|
+
*
|
|
624
|
+
* @remarks
|
|
625
|
+
* Type alias for the `DnsZoneRrsetsCreate` OpenAPI schema.
|
|
626
|
+
* This type represents dnszonerrsetscreate data structures used in API requests and responses.
|
|
627
|
+
*
|
|
628
|
+
* @example
|
|
629
|
+
* ```typescript
|
|
630
|
+
* const response = await api.getDnsZoneRrsetsCreate();
|
|
631
|
+
* const item: DnsZoneRrsetsCreate = response.results;
|
|
632
|
+
* ```
|
|
633
|
+
*
|
|
634
|
+
* @see {@link components} - The OpenAPI components schema definition
|
|
635
|
+
*/
|
|
636
|
+
export type DnsZoneRrsetsCreate = components['schemas']['DnsZoneRrsetsCreate'];
|
|
637
|
+
/**
|
|
638
|
+
* DnsZoneRrsetsPatchOps
|
|
639
|
+
*
|
|
640
|
+
* @remarks
|
|
641
|
+
* Type alias for the `DnsZoneRrsetsPatchOps` OpenAPI schema.
|
|
642
|
+
* This type represents dnszonerrsetspatchops data structures used in API requests and responses.
|
|
643
|
+
*
|
|
644
|
+
* @example
|
|
645
|
+
* ```typescript
|
|
646
|
+
* const response = await api.getDnsZoneRrsetsPatchOps();
|
|
647
|
+
* const item: DnsZoneRrsetsPatchOps = response.results;
|
|
648
|
+
* ```
|
|
649
|
+
*
|
|
650
|
+
* @see {@link components} - The OpenAPI components schema definition
|
|
651
|
+
*/
|
|
652
|
+
export type DnsZoneRrsetsPatchOps = components['schemas']['DnsZoneRrsetsPatchOps'];
|
|
653
|
+
/**
|
|
654
|
+
* DnssecAlgorithm
|
|
655
|
+
*
|
|
656
|
+
* @remarks
|
|
657
|
+
* Type alias for the `DnssecAlgorithm` OpenAPI schema.
|
|
658
|
+
* This type represents dnssecalgorithm data structures used in API requests and responses.
|
|
659
|
+
*
|
|
660
|
+
* @example
|
|
661
|
+
* ```typescript
|
|
662
|
+
* const response = await api.getDnssecAlgorithm();
|
|
663
|
+
* const item: DnssecAlgorithm = response.results;
|
|
664
|
+
* ```
|
|
665
|
+
*
|
|
666
|
+
* @see {@link components} - The OpenAPI components schema definition
|
|
667
|
+
*/
|
|
668
|
+
export type DnssecAlgorithm = components['schemas']['DnssecAlgorithm'];
|
|
669
|
+
/**
|
|
670
|
+
* DnssecDigestType
|
|
671
|
+
*
|
|
672
|
+
* @remarks
|
|
673
|
+
* Type alias for the `DnssecDigestType` OpenAPI schema.
|
|
674
|
+
* This type represents dnssecdigesttype data structures used in API requests and responses.
|
|
675
|
+
*
|
|
676
|
+
* @example
|
|
677
|
+
* ```typescript
|
|
678
|
+
* const response = await api.getDnssecDigestType();
|
|
679
|
+
* const item: DnssecDigestType = response.results;
|
|
680
|
+
* ```
|
|
681
|
+
*
|
|
682
|
+
* @see {@link components} - The OpenAPI components schema definition
|
|
683
|
+
*/
|
|
684
|
+
export type DnssecDigestType = components['schemas']['DnssecDigestType'];
|
|
685
|
+
/**
|
|
686
|
+
* DnssecModeType
|
|
687
|
+
*
|
|
688
|
+
* @remarks
|
|
689
|
+
* Type alias for the `DnssecModeType` OpenAPI schema.
|
|
690
|
+
* This type represents dnssecmodetype data structures used in API requests and responses.
|
|
691
|
+
*
|
|
692
|
+
* @example
|
|
693
|
+
* ```typescript
|
|
694
|
+
* const response = await api.getDnssecModeType();
|
|
695
|
+
* const item: DnssecModeType = response.results;
|
|
696
|
+
* ```
|
|
697
|
+
*
|
|
698
|
+
* @see {@link components} - The OpenAPI components schema definition
|
|
699
|
+
*/
|
|
700
|
+
export type DnssecModeType = components['schemas']['DnssecModeType'];
|
|
701
|
+
/**
|
|
702
|
+
* DnssecRecordType
|
|
703
|
+
*
|
|
704
|
+
* @remarks
|
|
705
|
+
* Type alias for the `DnssecRecordType` OpenAPI schema.
|
|
706
|
+
* This type represents dnssecrecordtype data structures used in API requests and responses.
|
|
707
|
+
*
|
|
708
|
+
* @example
|
|
709
|
+
* ```typescript
|
|
710
|
+
* const response = await api.getDnssecRecordType();
|
|
711
|
+
* const item: DnssecRecordType = response.results;
|
|
712
|
+
* ```
|
|
713
|
+
*
|
|
714
|
+
* @see {@link components} - The OpenAPI components schema definition
|
|
715
|
+
*/
|
|
716
|
+
export type DnssecRecordType = components['schemas']['DnssecRecordType'];
|
|
717
|
+
/**
|
|
718
|
+
* DnssecStatus
|
|
719
|
+
*
|
|
720
|
+
* @remarks
|
|
721
|
+
* Type alias for the `DnssecStatus` OpenAPI schema.
|
|
722
|
+
* This type represents dnssecstatus data structures used in API requests and responses.
|
|
723
|
+
*
|
|
724
|
+
* @example
|
|
725
|
+
* ```typescript
|
|
726
|
+
* const response = await api.getDnssecStatus();
|
|
727
|
+
* const item: DnssecStatus = response.results;
|
|
728
|
+
* ```
|
|
729
|
+
*
|
|
730
|
+
* @see {@link components} - The OpenAPI components schema definition
|
|
731
|
+
*/
|
|
732
|
+
export type DnssecStatus = components['schemas']['DnssecStatus'];
|
|
733
|
+
/**
|
|
734
|
+
* DomainAvailability
|
|
735
|
+
*
|
|
736
|
+
* @remarks
|
|
737
|
+
* Type alias for the `DomainAvailability` OpenAPI schema.
|
|
738
|
+
* This type represents domainavailability data structures used in API requests and responses.
|
|
739
|
+
*
|
|
740
|
+
* @example
|
|
741
|
+
* ```typescript
|
|
742
|
+
* const response = await api.getDomainAvailability();
|
|
743
|
+
* const item: DomainAvailability = response.results;
|
|
744
|
+
* ```
|
|
745
|
+
*
|
|
746
|
+
* @see {@link components} - The OpenAPI components schema definition
|
|
747
|
+
*/
|
|
748
|
+
export type DomainAvailability = components['schemas']['DomainAvailability'];
|
|
749
|
+
/**
|
|
750
|
+
* DomainAvailabilityMeta
|
|
751
|
+
*
|
|
752
|
+
* @remarks
|
|
753
|
+
* Type alias for the `DomainAvailabilityMeta` OpenAPI schema.
|
|
754
|
+
* This type represents domainavailabilitymeta data structures used in API requests and responses.
|
|
755
|
+
*
|
|
756
|
+
* @example
|
|
757
|
+
* ```typescript
|
|
758
|
+
* const response = await api.getDomainAvailabilityMeta();
|
|
759
|
+
* const item: DomainAvailabilityMeta = response.results;
|
|
760
|
+
* ```
|
|
761
|
+
*
|
|
762
|
+
* @see {@link components} - The OpenAPI components schema definition
|
|
763
|
+
*/
|
|
764
|
+
export type DomainAvailabilityMeta = components['schemas']['DomainAvailabilityMeta'];
|
|
765
|
+
/**
|
|
766
|
+
* DomainAvailabilityStatus
|
|
767
|
+
*
|
|
768
|
+
* @remarks
|
|
769
|
+
* Type alias for the `DomainAvailabilityStatus` OpenAPI schema.
|
|
770
|
+
* This type represents domainavailabilitystatus data structures used in API requests and responses.
|
|
771
|
+
*
|
|
772
|
+
* @example
|
|
773
|
+
* ```typescript
|
|
774
|
+
* const response = await api.getDomainAvailabilityStatus();
|
|
775
|
+
* const item: DomainAvailabilityStatus = response.results;
|
|
776
|
+
* ```
|
|
777
|
+
*
|
|
778
|
+
* @see {@link components} - The OpenAPI components schema definition
|
|
779
|
+
*/
|
|
780
|
+
export type DomainAvailabilityStatus = components['schemas']['DomainAvailabilityStatus'];
|
|
781
|
+
/**
|
|
782
|
+
* DomainCheckResponse
|
|
783
|
+
*
|
|
784
|
+
* @remarks
|
|
785
|
+
* Type alias for the `DomainCheckResponse` OpenAPI schema.
|
|
786
|
+
* This type represents domaincheckresponse data structures used in API requests and responses.
|
|
787
|
+
*
|
|
788
|
+
* @example
|
|
789
|
+
* ```typescript
|
|
790
|
+
* const response = await api.getDomainCheck();
|
|
791
|
+
* const item: DomainCheck = response.results;
|
|
792
|
+
* ```
|
|
793
|
+
*
|
|
794
|
+
* @see {@link components} - The OpenAPI components schema definition
|
|
795
|
+
*/
|
|
796
|
+
export type DomainCheck = components['schemas']['DomainCheckResponse'];
|
|
797
|
+
/**
|
|
798
|
+
* DomainClientStatus
|
|
799
|
+
*
|
|
800
|
+
* @remarks
|
|
801
|
+
* Type alias for the `DomainClientStatus` OpenAPI schema.
|
|
802
|
+
* This type represents domainclientstatus data structures used in API requests and responses.
|
|
803
|
+
*
|
|
804
|
+
* @example
|
|
805
|
+
* ```typescript
|
|
806
|
+
* const response = await api.getDomainClientStatus();
|
|
807
|
+
* const item: DomainClientStatus = response.results;
|
|
808
|
+
* ```
|
|
809
|
+
*
|
|
810
|
+
* @see {@link components} - The OpenAPI components schema definition
|
|
811
|
+
*/
|
|
812
|
+
export type DomainClientStatus = components['schemas']['DomainClientStatus'];
|
|
813
|
+
/**
|
|
814
|
+
* DomainContactResponse
|
|
815
|
+
*
|
|
816
|
+
* @remarks
|
|
817
|
+
* Type alias for the `DomainContactResponse` OpenAPI schema.
|
|
818
|
+
* This type represents domaincontactresponse data structures used in API requests and responses.
|
|
819
|
+
*
|
|
820
|
+
* @example
|
|
821
|
+
* ```typescript
|
|
822
|
+
* const response = await api.getDomainContact();
|
|
823
|
+
* const item: DomainContact = response.results;
|
|
824
|
+
* ```
|
|
825
|
+
*
|
|
826
|
+
* @see {@link components} - The OpenAPI components schema definition
|
|
827
|
+
*/
|
|
828
|
+
export type DomainContact = components['schemas']['DomainContactResponse'];
|
|
829
|
+
/**
|
|
830
|
+
* DomainContactType
|
|
831
|
+
*
|
|
832
|
+
* @remarks
|
|
833
|
+
* Type alias for the `DomainContactType` OpenAPI schema.
|
|
834
|
+
* This type represents domaincontacttype data structures used in API requests and responses.
|
|
835
|
+
*
|
|
836
|
+
* @example
|
|
837
|
+
* ```typescript
|
|
838
|
+
* const response = await api.getDomainContactType();
|
|
839
|
+
* const item: DomainContactType = response.results;
|
|
840
|
+
* ```
|
|
841
|
+
*
|
|
842
|
+
* @see {@link components} - The OpenAPI components schema definition
|
|
843
|
+
*/
|
|
844
|
+
export type DomainContactType = components['schemas']['DomainContactType'];
|
|
845
|
+
/**
|
|
846
|
+
* DomainCreate
|
|
847
|
+
*
|
|
848
|
+
* @remarks
|
|
849
|
+
* Type alias for the `DomainCreate` OpenAPI schema.
|
|
850
|
+
* This type represents domaincreate data structures used in API requests and responses.
|
|
851
|
+
*
|
|
852
|
+
* @example
|
|
853
|
+
* ```typescript
|
|
854
|
+
* const response = await api.getDomainCreate();
|
|
855
|
+
* const item: DomainCreate = response.results;
|
|
856
|
+
* ```
|
|
857
|
+
*
|
|
858
|
+
* @see {@link components} - The OpenAPI components schema definition
|
|
859
|
+
*/
|
|
860
|
+
export type DomainCreate = components['schemas']['DomainCreate'];
|
|
861
|
+
/**
|
|
862
|
+
* DomainDnssecDataCreate
|
|
863
|
+
*
|
|
864
|
+
* @remarks
|
|
865
|
+
* Type alias for the `DomainDnssecDataCreate` OpenAPI schema.
|
|
866
|
+
* This type represents domaindnssecdatacreate data structures used in API requests and responses.
|
|
867
|
+
*
|
|
868
|
+
* @example
|
|
869
|
+
* ```typescript
|
|
870
|
+
* const response = await api.getDomainDnssecDataCreate();
|
|
871
|
+
* const item: DomainDnssecDataCreate = response.results;
|
|
872
|
+
* ```
|
|
873
|
+
*
|
|
874
|
+
* @see {@link components} - The OpenAPI components schema definition
|
|
875
|
+
*/
|
|
876
|
+
export type DomainDnssecDataCreate = components['schemas']['DomainDnssecDataCreate'];
|
|
877
|
+
/**
|
|
878
|
+
* DomainDnssecDataResponse
|
|
879
|
+
*
|
|
880
|
+
* @remarks
|
|
881
|
+
* Type alias for the `DomainDnssecDataResponse` OpenAPI schema.
|
|
882
|
+
* This type represents domaindnssecdataresponse data structures used in API requests and responses.
|
|
883
|
+
*
|
|
884
|
+
* @example
|
|
885
|
+
* ```typescript
|
|
886
|
+
* const response = await api.getDomainDnssecData();
|
|
887
|
+
* const item: DomainDnssecData = response.results;
|
|
888
|
+
* ```
|
|
889
|
+
*
|
|
890
|
+
* @see {@link components} - The OpenAPI components schema definition
|
|
891
|
+
*/
|
|
892
|
+
export type DomainDnssecData = components['schemas']['DomainDnssecDataResponse'];
|
|
893
|
+
/**
|
|
894
|
+
* DomainLifecycleBase
|
|
895
|
+
*
|
|
896
|
+
* @remarks
|
|
897
|
+
* Type alias for the `DomainLifecycleBase` OpenAPI schema.
|
|
898
|
+
* This type represents domainlifecyclebase data structures used in API requests and responses.
|
|
899
|
+
*
|
|
900
|
+
* @example
|
|
901
|
+
* ```typescript
|
|
902
|
+
* const response = await api.getDomainLifecycleBase();
|
|
903
|
+
* const item: DomainLifecycleBase = response.results;
|
|
904
|
+
* ```
|
|
905
|
+
*
|
|
906
|
+
* @see {@link components} - The OpenAPI components schema definition
|
|
907
|
+
*/
|
|
908
|
+
export type DomainLifecycleBase = components['schemas']['DomainLifecycleBase'];
|
|
909
|
+
/**
|
|
910
|
+
* DomainNameParts
|
|
911
|
+
*
|
|
912
|
+
* @remarks
|
|
913
|
+
* Type alias for the `DomainNameParts` OpenAPI schema.
|
|
914
|
+
* This type represents domainnameparts data structures used in API requests and responses.
|
|
915
|
+
*
|
|
916
|
+
* @example
|
|
917
|
+
* ```typescript
|
|
918
|
+
* const response = await api.getDomainNameParts();
|
|
919
|
+
* const item: DomainNameParts = response.results;
|
|
920
|
+
* ```
|
|
921
|
+
*
|
|
922
|
+
* @see {@link components} - The OpenAPI components schema definition
|
|
923
|
+
*/
|
|
924
|
+
export type DomainNameParts = components['schemas']['DomainNameParts'];
|
|
925
|
+
/**
|
|
926
|
+
* DomainPeriod
|
|
927
|
+
*
|
|
928
|
+
* @remarks
|
|
929
|
+
* Type alias for the `DomainPeriod` OpenAPI schema.
|
|
930
|
+
* This type represents domainperiod data structures used in API requests and responses.
|
|
931
|
+
*
|
|
932
|
+
* @example
|
|
933
|
+
* ```typescript
|
|
934
|
+
* const response = await api.getDomainPeriod();
|
|
935
|
+
* const item: DomainPeriod = response.results;
|
|
936
|
+
* ```
|
|
937
|
+
*
|
|
938
|
+
* @see {@link components} - The OpenAPI components schema definition
|
|
939
|
+
*/
|
|
940
|
+
export type DomainPeriod = components['schemas']['DomainPeriod'];
|
|
941
|
+
/**
|
|
942
|
+
* DomainRenewRequest
|
|
943
|
+
*
|
|
944
|
+
* @remarks
|
|
945
|
+
* Type alias for the `DomainRenewRequest` OpenAPI schema.
|
|
946
|
+
* This type represents domainrenewrequest data structures used in API requests and responses.
|
|
947
|
+
*
|
|
948
|
+
* @example
|
|
949
|
+
* ```typescript
|
|
950
|
+
* const response = await api.getDomainRenewRequest();
|
|
951
|
+
* const item: DomainRenewRequest = response.results;
|
|
952
|
+
* ```
|
|
953
|
+
*
|
|
954
|
+
* @see {@link components} - The OpenAPI components schema definition
|
|
955
|
+
*/
|
|
956
|
+
export type DomainRenewRequest = components['schemas']['DomainRenewRequest'];
|
|
957
|
+
/**
|
|
958
|
+
* DomainRenewResponse
|
|
959
|
+
*
|
|
960
|
+
* @remarks
|
|
961
|
+
* Type alias for the `DomainRenewResponse` OpenAPI schema.
|
|
962
|
+
* This type represents domainrenewresponse data structures used in API requests and responses.
|
|
963
|
+
*
|
|
964
|
+
* @example
|
|
965
|
+
* ```typescript
|
|
966
|
+
* const response = await api.getDomainRenew();
|
|
967
|
+
* const item: DomainRenew = response.results;
|
|
968
|
+
* ```
|
|
969
|
+
*
|
|
970
|
+
* @see {@link components} - The OpenAPI components schema definition
|
|
971
|
+
*/
|
|
972
|
+
export type DomainRenew = components['schemas']['DomainRenewResponse'];
|
|
973
|
+
/**
|
|
974
|
+
* DomainResponse
|
|
975
|
+
*
|
|
976
|
+
* @remarks
|
|
977
|
+
* Type alias for the `DomainResponse` OpenAPI schema.
|
|
978
|
+
* This type represents domainresponse data structures used in API requests and responses.
|
|
979
|
+
*
|
|
980
|
+
* @example
|
|
981
|
+
* ```typescript
|
|
982
|
+
* const response = await api.getDomain();
|
|
983
|
+
* const item: Domain = response.results;
|
|
984
|
+
* ```
|
|
985
|
+
*
|
|
986
|
+
* @see {@link components} - The OpenAPI components schema definition
|
|
987
|
+
*/
|
|
988
|
+
export type Domain = components['schemas']['DomainResponse'];
|
|
989
|
+
/**
|
|
990
|
+
* DomainSearchMeta
|
|
991
|
+
*
|
|
992
|
+
* @remarks
|
|
993
|
+
* Type alias for the `DomainSearchMeta` OpenAPI schema.
|
|
994
|
+
* This type represents domainsearchmeta data structures used in API requests and responses.
|
|
995
|
+
*
|
|
996
|
+
* @example
|
|
997
|
+
* ```typescript
|
|
998
|
+
* const response = await api.getDomainSearchMeta();
|
|
999
|
+
* const item: DomainSearchMeta = response.results;
|
|
1000
|
+
* ```
|
|
1001
|
+
*
|
|
1002
|
+
* @see {@link components} - The OpenAPI components schema definition
|
|
1003
|
+
*/
|
|
1004
|
+
export type DomainSearchMeta = components['schemas']['DomainSearchMeta'];
|
|
1005
|
+
/**
|
|
1006
|
+
* DomainSearchResponse
|
|
1007
|
+
*
|
|
1008
|
+
* @remarks
|
|
1009
|
+
* Type alias for the `DomainSearchResponse` OpenAPI schema.
|
|
1010
|
+
* This type represents domainsearchresponse data structures used in API requests and responses.
|
|
1011
|
+
*
|
|
1012
|
+
* @example
|
|
1013
|
+
* ```typescript
|
|
1014
|
+
* const response = await api.getDomainSearch();
|
|
1015
|
+
* const item: DomainSearch = response.results;
|
|
1016
|
+
* ```
|
|
1017
|
+
*
|
|
1018
|
+
* @see {@link components} - The OpenAPI components schema definition
|
|
1019
|
+
*/
|
|
1020
|
+
export type DomainSearch = components['schemas']['DomainSearchResponse'];
|
|
1021
|
+
/**
|
|
1022
|
+
* DomainSearchSuggestion
|
|
1023
|
+
*
|
|
1024
|
+
* @remarks
|
|
1025
|
+
* Type alias for the `DomainSearchSuggestion` OpenAPI schema.
|
|
1026
|
+
* This type represents domainsearchsuggestion data structures used in API requests and responses.
|
|
1027
|
+
*
|
|
1028
|
+
* @example
|
|
1029
|
+
* ```typescript
|
|
1030
|
+
* const response = await api.getDomainSearchSuggestion();
|
|
1031
|
+
* const item: DomainSearchSuggestion = response.results;
|
|
1032
|
+
* ```
|
|
1033
|
+
*
|
|
1034
|
+
* @see {@link components} - The OpenAPI components schema definition
|
|
1035
|
+
*/
|
|
1036
|
+
export type DomainSearchSuggestion = components['schemas']['DomainSearchSuggestion'];
|
|
1037
|
+
/**
|
|
1038
|
+
* DomainSortField
|
|
1039
|
+
*
|
|
1040
|
+
* @remarks
|
|
1041
|
+
* Type alias for the `DomainSortField` OpenAPI schema.
|
|
1042
|
+
* This type represents domainsortfield data structures used in API requests and responses.
|
|
1043
|
+
*
|
|
1044
|
+
* @example
|
|
1045
|
+
* ```typescript
|
|
1046
|
+
* const response = await api.getDomainSortField();
|
|
1047
|
+
* const item: DomainSortField = response.results;
|
|
1048
|
+
* ```
|
|
1049
|
+
*
|
|
1050
|
+
* @see {@link components} - The OpenAPI components schema definition
|
|
1051
|
+
*/
|
|
1052
|
+
export type DomainSortField = components['schemas']['DomainSortField'];
|
|
1053
|
+
/**
|
|
1054
|
+
* DomainStatus
|
|
1055
|
+
*
|
|
1056
|
+
* @remarks
|
|
1057
|
+
* Type alias for the `DomainStatus` OpenAPI schema.
|
|
1058
|
+
* This type represents domainstatus data structures used in API requests and responses.
|
|
1059
|
+
*
|
|
1060
|
+
* @example
|
|
1061
|
+
* ```typescript
|
|
1062
|
+
* const response = await api.getDomainStatus();
|
|
1063
|
+
* const item: DomainStatus = response.results;
|
|
1064
|
+
* ```
|
|
1065
|
+
*
|
|
1066
|
+
* @see {@link components} - The OpenAPI components schema definition
|
|
1067
|
+
*/
|
|
1068
|
+
export type DomainStatus = components['schemas']['DomainStatus'];
|
|
1069
|
+
/**
|
|
1070
|
+
* DomainStatusesBase
|
|
1071
|
+
*
|
|
1072
|
+
* @remarks
|
|
1073
|
+
* Type alias for the `DomainStatusesBase` OpenAPI schema.
|
|
1074
|
+
* This type represents domainstatusesbase data structures used in API requests and responses.
|
|
1075
|
+
*
|
|
1076
|
+
* @example
|
|
1077
|
+
* ```typescript
|
|
1078
|
+
* const response = await api.getDomainStatusesBase();
|
|
1079
|
+
* const item: DomainStatusesBase = response.results;
|
|
1080
|
+
* ```
|
|
1081
|
+
*
|
|
1082
|
+
* @see {@link components} - The OpenAPI components schema definition
|
|
1083
|
+
*/
|
|
1084
|
+
export type DomainStatusesBase = components['schemas']['DomainStatusesBase'];
|
|
1085
|
+
/**
|
|
1086
|
+
* DomainSummaryData
|
|
1087
|
+
*
|
|
1088
|
+
* @remarks
|
|
1089
|
+
* Type alias for the `DomainSummaryData` OpenAPI schema.
|
|
1090
|
+
* This type represents domainsummarydata data structures used in API requests and responses.
|
|
1091
|
+
*
|
|
1092
|
+
* @example
|
|
1093
|
+
* ```typescript
|
|
1094
|
+
* const response = await api.getDomainSummaryData();
|
|
1095
|
+
* const item: DomainSummaryData = response.results;
|
|
1096
|
+
* ```
|
|
1097
|
+
*
|
|
1098
|
+
* @see {@link components} - The OpenAPI components schema definition
|
|
1099
|
+
*/
|
|
1100
|
+
export type DomainSummaryData = components['schemas']['DomainSummaryData'];
|
|
1101
|
+
/**
|
|
1102
|
+
* DomainSummaryResponse
|
|
1103
|
+
*
|
|
1104
|
+
* @remarks
|
|
1105
|
+
* Type alias for the `DomainSummaryResponse` OpenAPI schema.
|
|
1106
|
+
* This type represents domainsummaryresponse data structures used in API requests and responses.
|
|
1107
|
+
*
|
|
1108
|
+
* @example
|
|
1109
|
+
* ```typescript
|
|
1110
|
+
* const response = await api.getDomainSummary();
|
|
1111
|
+
* const item: DomainSummary = response.results;
|
|
1112
|
+
* ```
|
|
1113
|
+
*
|
|
1114
|
+
* @see {@link components} - The OpenAPI components schema definition
|
|
1115
|
+
*/
|
|
1116
|
+
export type DomainSummary = components['schemas']['DomainSummaryResponse'];
|
|
1117
|
+
/**
|
|
1118
|
+
* DomainTransferIn
|
|
1119
|
+
*
|
|
1120
|
+
* @remarks
|
|
1121
|
+
* Type alias for the `DomainTransferIn` OpenAPI schema.
|
|
1122
|
+
* This type represents domaintransferin data structures used in API requests and responses.
|
|
1123
|
+
*
|
|
1124
|
+
* @example
|
|
1125
|
+
* ```typescript
|
|
1126
|
+
* const response = await api.getDomainTransferIn();
|
|
1127
|
+
* const item: DomainTransferIn = response.results;
|
|
1128
|
+
* ```
|
|
1129
|
+
*
|
|
1130
|
+
* @see {@link components} - The OpenAPI components schema definition
|
|
1131
|
+
*/
|
|
1132
|
+
export type DomainTransferIn = components['schemas']['DomainTransferIn'];
|
|
1133
|
+
/**
|
|
1134
|
+
* DomainUpdate
|
|
1135
|
+
*
|
|
1136
|
+
* @remarks
|
|
1137
|
+
* Type alias for the `DomainUpdate` OpenAPI schema.
|
|
1138
|
+
* This type represents domainupdate data structures used in API requests and responses.
|
|
1139
|
+
*
|
|
1140
|
+
* @example
|
|
1141
|
+
* ```typescript
|
|
1142
|
+
* const response = await api.getDomainUpdate();
|
|
1143
|
+
* const item: DomainUpdate = response.results;
|
|
1144
|
+
* ```
|
|
1145
|
+
*
|
|
1146
|
+
* @see {@link components} - The OpenAPI components schema definition
|
|
1147
|
+
*/
|
|
1148
|
+
export type DomainUpdate = components['schemas']['DomainUpdate'];
|
|
1149
|
+
/**
|
|
1150
|
+
* DomainsExpiringSoon
|
|
1151
|
+
*
|
|
1152
|
+
* @remarks
|
|
1153
|
+
* Type alias for the `DomainsExpiringSoon` OpenAPI schema.
|
|
1154
|
+
* This type represents domainsexpiringsoon data structures used in API requests and responses.
|
|
1155
|
+
*
|
|
1156
|
+
* @example
|
|
1157
|
+
* ```typescript
|
|
1158
|
+
* const response = await api.getDomainsExpiringSoon();
|
|
1159
|
+
* const item: DomainsExpiringSoon = response.results;
|
|
1160
|
+
* ```
|
|
1161
|
+
*
|
|
1162
|
+
* @see {@link components} - The OpenAPI components schema definition
|
|
1163
|
+
*/
|
|
1164
|
+
export type DomainsExpiringSoon = components['schemas']['DomainsExpiringSoon'];
|
|
1165
|
+
/**
|
|
1166
|
+
* EmailForward
|
|
1167
|
+
*
|
|
1168
|
+
* @remarks
|
|
1169
|
+
* Type alias for the `EmailForward` OpenAPI schema.
|
|
1170
|
+
* This type represents emailforward data structures used in API requests and responses.
|
|
1171
|
+
*
|
|
1172
|
+
* @example
|
|
1173
|
+
* ```typescript
|
|
1174
|
+
* const response = await api.getEmailForward();
|
|
1175
|
+
* const item: EmailForward = response.results;
|
|
1176
|
+
* ```
|
|
1177
|
+
*
|
|
1178
|
+
* @see {@link components} - The OpenAPI components schema definition
|
|
1179
|
+
*/
|
|
1180
|
+
export type EmailForward = components['schemas']['EmailForward'];
|
|
1181
|
+
/**
|
|
1182
|
+
* EmailForwardBulkDelete
|
|
1183
|
+
*
|
|
1184
|
+
* @remarks
|
|
1185
|
+
* Type alias for the `EmailForwardBulkDelete` OpenAPI schema.
|
|
1186
|
+
* This type represents emailforwardbulkdelete data structures used in API requests and responses.
|
|
1187
|
+
*
|
|
1188
|
+
* @example
|
|
1189
|
+
* ```typescript
|
|
1190
|
+
* const response = await api.getEmailForwardBulkDelete();
|
|
1191
|
+
* const item: EmailForwardBulkDelete = response.results;
|
|
1192
|
+
* ```
|
|
1193
|
+
*
|
|
1194
|
+
* @see {@link components} - The OpenAPI components schema definition
|
|
1195
|
+
*/
|
|
1196
|
+
export type EmailForwardBulkDelete = components['schemas']['EmailForwardBulkDelete'];
|
|
1197
|
+
/**
|
|
1198
|
+
* EmailForwardBulkUpdate
|
|
1199
|
+
*
|
|
1200
|
+
* @remarks
|
|
1201
|
+
* Type alias for the `EmailForwardBulkUpdate` OpenAPI schema.
|
|
1202
|
+
* This type represents emailforwardbulkupdate data structures used in API requests and responses.
|
|
1203
|
+
*
|
|
1204
|
+
* @example
|
|
1205
|
+
* ```typescript
|
|
1206
|
+
* const response = await api.getEmailForwardBulkUpdate();
|
|
1207
|
+
* const item: EmailForwardBulkUpdate = response.results;
|
|
1208
|
+
* ```
|
|
1209
|
+
*
|
|
1210
|
+
* @see {@link components} - The OpenAPI components schema definition
|
|
1211
|
+
*/
|
|
1212
|
+
export type EmailForwardBulkUpdate = components['schemas']['EmailForwardBulkUpdate'];
|
|
1213
|
+
/**
|
|
1214
|
+
* EmailForwardBulkUpdateItem
|
|
1215
|
+
*
|
|
1216
|
+
* @remarks
|
|
1217
|
+
* Type alias for the `EmailForwardBulkUpdateItem` OpenAPI schema.
|
|
1218
|
+
* This type represents emailforwardbulkupdateitem data structures used in API requests and responses.
|
|
1219
|
+
*
|
|
1220
|
+
* @example
|
|
1221
|
+
* ```typescript
|
|
1222
|
+
* const response = await api.getEmailForwardBulkUpdateItem();
|
|
1223
|
+
* const item: EmailForwardBulkUpdateItem = response.results;
|
|
1224
|
+
* ```
|
|
1225
|
+
*
|
|
1226
|
+
* @see {@link components} - The OpenAPI components schema definition
|
|
1227
|
+
*/
|
|
1228
|
+
export type EmailForwardBulkUpdateItem = components['schemas']['EmailForwardBulkUpdateItem'];
|
|
1229
|
+
/**
|
|
1230
|
+
* EmailForwardCreate
|
|
1231
|
+
*
|
|
1232
|
+
* @remarks
|
|
1233
|
+
* Type alias for the `EmailForwardCreate` OpenAPI schema.
|
|
1234
|
+
* This type represents emailforwardcreate data structures used in API requests and responses.
|
|
1235
|
+
*
|
|
1236
|
+
* @example
|
|
1237
|
+
* ```typescript
|
|
1238
|
+
* const response = await api.getEmailForwardCreate();
|
|
1239
|
+
* const item: EmailForwardCreate = response.results;
|
|
1240
|
+
* ```
|
|
1241
|
+
*
|
|
1242
|
+
* @see {@link components} - The OpenAPI components schema definition
|
|
1243
|
+
*/
|
|
1244
|
+
export type EmailForwardCreate = components['schemas']['EmailForwardCreate'];
|
|
1245
|
+
/**
|
|
1246
|
+
* EmailForwardStatus
|
|
1247
|
+
*
|
|
1248
|
+
* @remarks
|
|
1249
|
+
* Type alias for the `EmailForwardStatus` OpenAPI schema.
|
|
1250
|
+
* This type represents emailforwardstatus data structures used in API requests and responses.
|
|
1251
|
+
*
|
|
1252
|
+
* @example
|
|
1253
|
+
* ```typescript
|
|
1254
|
+
* const response = await api.getEmailForwardStatus();
|
|
1255
|
+
* const item: EmailForwardStatus = response.results;
|
|
1256
|
+
* ```
|
|
1257
|
+
*
|
|
1258
|
+
* @see {@link components} - The OpenAPI components schema definition
|
|
1259
|
+
*/
|
|
1260
|
+
export type EmailForwardStatus = components['schemas']['EmailForwardStatus'];
|
|
1261
|
+
/**
|
|
1262
|
+
* EmailForwardUpdate
|
|
1263
|
+
*
|
|
1264
|
+
* @remarks
|
|
1265
|
+
* Type alias for the `EmailForwardUpdate` OpenAPI schema.
|
|
1266
|
+
* This type represents emailforwardupdate data structures used in API requests and responses.
|
|
1267
|
+
*
|
|
1268
|
+
* @example
|
|
1269
|
+
* ```typescript
|
|
1270
|
+
* const response = await api.getEmailForwardUpdate();
|
|
1271
|
+
* const item: EmailForwardUpdate = response.results;
|
|
1272
|
+
* ```
|
|
1273
|
+
*
|
|
1274
|
+
* @see {@link components} - The OpenAPI components schema definition
|
|
1275
|
+
*/
|
|
1276
|
+
export type EmailForwardUpdate = components['schemas']['EmailForwardUpdate'];
|
|
1277
|
+
/**
|
|
1278
|
+
* EmailVerificationStatus
|
|
1279
|
+
*
|
|
1280
|
+
* @remarks
|
|
1281
|
+
* Type alias for the `EmailVerificationStatus` OpenAPI schema.
|
|
1282
|
+
* This type represents emailverificationstatus data structures used in API requests and responses.
|
|
1283
|
+
*
|
|
1284
|
+
* @example
|
|
1285
|
+
* ```typescript
|
|
1286
|
+
* const response = await api.getEmailVerificationStatus();
|
|
1287
|
+
* const item: EmailVerificationStatus = response.results;
|
|
1288
|
+
* ```
|
|
1289
|
+
*
|
|
1290
|
+
* @see {@link components} - The OpenAPI components schema definition
|
|
1291
|
+
*/
|
|
1292
|
+
export type EmailVerificationStatus = components['schemas']['EmailVerificationStatus'];
|
|
1293
|
+
/**
|
|
1294
|
+
* EppDateTime
|
|
1295
|
+
*
|
|
1296
|
+
* @remarks
|
|
1297
|
+
* Type alias for the `EppDateTime` OpenAPI schema.
|
|
1298
|
+
* This type represents eppdatetime data structures used in API requests and responses.
|
|
1299
|
+
*
|
|
1300
|
+
* @example
|
|
1301
|
+
* ```typescript
|
|
1302
|
+
* const response = await api.getEppDateTime();
|
|
1303
|
+
* const item: EppDateTime = response.results;
|
|
1304
|
+
* ```
|
|
1305
|
+
*
|
|
1306
|
+
* @see {@link components} - The OpenAPI components schema definition
|
|
1307
|
+
*/
|
|
1308
|
+
export type EppDateTime = components['schemas']['EppDateTime'];
|
|
1309
|
+
/**
|
|
1310
|
+
* EventObjectType
|
|
1311
|
+
*
|
|
1312
|
+
* @remarks
|
|
1313
|
+
* Type alias for the `EventObjectType` OpenAPI schema.
|
|
1314
|
+
* This type represents eventobjecttype data structures used in API requests and responses.
|
|
1315
|
+
*
|
|
1316
|
+
* @example
|
|
1317
|
+
* ```typescript
|
|
1318
|
+
* const response = await api.getEventObjectType();
|
|
1319
|
+
* const item: EventObjectType = response.results;
|
|
1320
|
+
* ```
|
|
1321
|
+
*
|
|
1322
|
+
* @see {@link components} - The OpenAPI components schema definition
|
|
1323
|
+
*/
|
|
1324
|
+
export type EventObjectType = components['schemas']['EventObjectType'];
|
|
1325
|
+
/**
|
|
1326
|
+
* EventResponse
|
|
1327
|
+
*
|
|
1328
|
+
* @remarks
|
|
1329
|
+
* Type alias for the `EventResponse` OpenAPI schema.
|
|
1330
|
+
* This type represents eventresponse data structures used in API requests and responses.
|
|
1331
|
+
*
|
|
1332
|
+
* @example
|
|
1333
|
+
* ```typescript
|
|
1334
|
+
* const response = await api.getEventResponse();
|
|
1335
|
+
* const item: EventResponse = response.results;
|
|
1336
|
+
* ```
|
|
1337
|
+
*
|
|
1338
|
+
* @see {@link components} - The OpenAPI components schema definition
|
|
1339
|
+
*/
|
|
1340
|
+
export type EventResponse = components['schemas']['EventResponse'];
|
|
1341
|
+
/**
|
|
1342
|
+
* EventSchema
|
|
1343
|
+
*
|
|
1344
|
+
* @remarks
|
|
1345
|
+
* Type alias for the `EventSchema` OpenAPI schema.
|
|
1346
|
+
* This type represents eventschema data structures used in API requests and responses.
|
|
1347
|
+
*
|
|
1348
|
+
* @example
|
|
1349
|
+
* ```typescript
|
|
1350
|
+
* const response = await api.getEventSchema();
|
|
1351
|
+
* const item: EventSchema = response.results;
|
|
1352
|
+
* ```
|
|
1353
|
+
*
|
|
1354
|
+
* @see {@link components} - The OpenAPI components schema definition
|
|
1355
|
+
*/
|
|
1356
|
+
export type EventSchema = components['schemas']['EventSchema'];
|
|
1357
|
+
/**
|
|
1358
|
+
* EventSubtype
|
|
1359
|
+
*
|
|
1360
|
+
* @remarks
|
|
1361
|
+
* Type alias for the `EventSubtype` OpenAPI schema.
|
|
1362
|
+
* This type represents eventsubtype data structures used in API requests and responses.
|
|
1363
|
+
*
|
|
1364
|
+
* @example
|
|
1365
|
+
* ```typescript
|
|
1366
|
+
* const response = await api.getEventSubtype();
|
|
1367
|
+
* const item: EventSubtype = response.results;
|
|
1368
|
+
* ```
|
|
1369
|
+
*
|
|
1370
|
+
* @see {@link components} - The OpenAPI components schema definition
|
|
1371
|
+
*/
|
|
1372
|
+
export type EventSubtype = components['schemas']['EventSubtype'];
|
|
1373
|
+
/**
|
|
1374
|
+
* EventType
|
|
1375
|
+
*
|
|
1376
|
+
* @remarks
|
|
1377
|
+
* Type alias for the `EventType` OpenAPI schema.
|
|
1378
|
+
* This type represents eventtype data structures used in API requests and responses.
|
|
1379
|
+
*
|
|
1380
|
+
* @example
|
|
1381
|
+
* ```typescript
|
|
1382
|
+
* const response = await api.getEventType();
|
|
1383
|
+
* const item: EventType = response.results;
|
|
1384
|
+
* ```
|
|
1385
|
+
*
|
|
1386
|
+
* @see {@link components} - The OpenAPI components schema definition
|
|
1387
|
+
*/
|
|
1388
|
+
export type EventType = components['schemas']['EventType'];
|
|
1389
|
+
/**
|
|
1390
|
+
* GeneralAvailabilityBase
|
|
1391
|
+
*
|
|
1392
|
+
* @remarks
|
|
1393
|
+
* Type alias for the `GeneralAvailabilityBase` OpenAPI schema.
|
|
1394
|
+
* This type represents generalavailabilitybase data structures used in API requests and responses.
|
|
1395
|
+
*
|
|
1396
|
+
* @example
|
|
1397
|
+
* ```typescript
|
|
1398
|
+
* const response = await api.getGeneralAvailabilityBase();
|
|
1399
|
+
* const item: GeneralAvailabilityBase = response.results;
|
|
1400
|
+
* ```
|
|
1401
|
+
*
|
|
1402
|
+
* @see {@link components} - The OpenAPI components schema definition
|
|
1403
|
+
*/
|
|
1404
|
+
export type GeneralAvailabilityBase = components['schemas']['GeneralAvailabilityBase'];
|
|
1405
|
+
/**
|
|
1406
|
+
* GrantType
|
|
1407
|
+
*
|
|
1408
|
+
* @remarks
|
|
1409
|
+
* Type alias for the `GrantType` OpenAPI schema.
|
|
1410
|
+
* This type represents granttype data structures used in API requests and responses.
|
|
1411
|
+
*
|
|
1412
|
+
* @example
|
|
1413
|
+
* ```typescript
|
|
1414
|
+
* const response = await api.getGrantType();
|
|
1415
|
+
* const item: GrantType = response.results;
|
|
1416
|
+
* ```
|
|
1417
|
+
*
|
|
1418
|
+
* @see {@link components} - The OpenAPI components schema definition
|
|
1419
|
+
*/
|
|
1420
|
+
export type GrantType = components['schemas']['GrantType'];
|
|
1421
|
+
/**
|
|
1422
|
+
* RequestValidationError
|
|
1423
|
+
*
|
|
1424
|
+
* @remarks
|
|
1425
|
+
* Type alias for the `HTTPValidationError` OpenAPI schema.
|
|
1426
|
+
* This type represents requestvalidationerror data structures used in API requests and responses.
|
|
1427
|
+
*
|
|
1428
|
+
* @example
|
|
1429
|
+
* ```typescript
|
|
1430
|
+
* const response = await api.getHTTPValidationError();
|
|
1431
|
+
* const item: HTTPValidationError = response.results;
|
|
1432
|
+
* ```
|
|
1433
|
+
*
|
|
1434
|
+
* @see {@link components} - The OpenAPI components schema definition
|
|
1435
|
+
*/
|
|
1436
|
+
export type HTTPValidationError = components['schemas']['HTTPValidationError'];
|
|
1437
|
+
/**
|
|
1438
|
+
* IdnBase
|
|
1439
|
+
*
|
|
1440
|
+
* @remarks
|
|
1441
|
+
* Type alias for the `IdnBase` OpenAPI schema.
|
|
1442
|
+
* This type represents idnbase data structures used in API requests and responses.
|
|
1443
|
+
*
|
|
1444
|
+
* @example
|
|
1445
|
+
* ```typescript
|
|
1446
|
+
* const response = await api.getIdnBase();
|
|
1447
|
+
* const item: IdnBase = response.results;
|
|
1448
|
+
* ```
|
|
1449
|
+
*
|
|
1450
|
+
* @see {@link components} - The OpenAPI components schema definition
|
|
1451
|
+
*/
|
|
1452
|
+
export type IdnBase = components['schemas']['IdnBase'];
|
|
1453
|
+
/**
|
|
1454
|
+
* IpRestrictionCreate
|
|
1455
|
+
*
|
|
1456
|
+
* @remarks
|
|
1457
|
+
* Type alias for the `IpRestrictionCreate` OpenAPI schema.
|
|
1458
|
+
* This type represents iprestrictioncreate data structures used in API requests and responses.
|
|
1459
|
+
*
|
|
1460
|
+
* @example
|
|
1461
|
+
* ```typescript
|
|
1462
|
+
* const response = await api.getIpRestrictionCreate();
|
|
1463
|
+
* const item: IpRestrictionCreate = response.results;
|
|
1464
|
+
* ```
|
|
1465
|
+
*
|
|
1466
|
+
* @see {@link components} - The OpenAPI components schema definition
|
|
1467
|
+
*/
|
|
1468
|
+
export type IpRestrictionCreate = components['schemas']['IpRestrictionCreate'];
|
|
1469
|
+
/**
|
|
1470
|
+
* IpRestrictionResponse
|
|
1471
|
+
*
|
|
1472
|
+
* @remarks
|
|
1473
|
+
* Type alias for the `IpRestrictionResponse` OpenAPI schema.
|
|
1474
|
+
* This type represents iprestrictionresponse data structures used in API requests and responses.
|
|
1475
|
+
*
|
|
1476
|
+
* @example
|
|
1477
|
+
* ```typescript
|
|
1478
|
+
* const response = await api.getIpRestriction();
|
|
1479
|
+
* const item: IpRestriction = response.results;
|
|
1480
|
+
* ```
|
|
1481
|
+
*
|
|
1482
|
+
* @see {@link components} - The OpenAPI components schema definition
|
|
1483
|
+
*/
|
|
1484
|
+
export type IpRestriction = components['schemas']['IpRestrictionResponse'];
|
|
1485
|
+
/**
|
|
1486
|
+
* IpRestrictionUpdate
|
|
1487
|
+
*
|
|
1488
|
+
* @remarks
|
|
1489
|
+
* Type alias for the `IpRestrictionUpdate` OpenAPI schema.
|
|
1490
|
+
* This type represents iprestrictionupdate data structures used in API requests and responses.
|
|
1491
|
+
*
|
|
1492
|
+
* @example
|
|
1493
|
+
* ```typescript
|
|
1494
|
+
* const response = await api.getIpRestrictionUpdate();
|
|
1495
|
+
* const item: IpRestrictionUpdate = response.results;
|
|
1496
|
+
* ```
|
|
1497
|
+
*
|
|
1498
|
+
* @see {@link components} - The OpenAPI components schema definition
|
|
1499
|
+
*/
|
|
1500
|
+
export type IpRestrictionUpdate = components['schemas']['IpRestrictionUpdate'];
|
|
1501
|
+
/**
|
|
1502
|
+
* JsonValue
|
|
1503
|
+
*
|
|
1504
|
+
* @remarks
|
|
1505
|
+
* Type alias for the `JsonValue` OpenAPI schema.
|
|
1506
|
+
* This type represents jsonvalue data structures used in API requests and responses.
|
|
1507
|
+
*
|
|
1508
|
+
* @example
|
|
1509
|
+
* ```typescript
|
|
1510
|
+
* const response = await api.getJsonValue();
|
|
1511
|
+
* const item: JsonValue = response.results;
|
|
1512
|
+
* ```
|
|
1513
|
+
*
|
|
1514
|
+
* @see {@link components} - The OpenAPI components schema definition
|
|
1515
|
+
*/
|
|
1516
|
+
export type JsonValue = components['schemas']['JsonValue'];
|
|
1517
|
+
/**
|
|
1518
|
+
* LaunchPhaseBase
|
|
1519
|
+
*
|
|
1520
|
+
* @remarks
|
|
1521
|
+
* Type alias for the `LaunchPhaseBase` OpenAPI schema.
|
|
1522
|
+
* This type represents launchphasebase data structures used in API requests and responses.
|
|
1523
|
+
*
|
|
1524
|
+
* @example
|
|
1525
|
+
* ```typescript
|
|
1526
|
+
* const response = await api.getLaunchPhaseBase();
|
|
1527
|
+
* const item: LaunchPhaseBase = response.results;
|
|
1528
|
+
* ```
|
|
1529
|
+
*
|
|
1530
|
+
* @see {@link components} - The OpenAPI components schema definition
|
|
1531
|
+
*/
|
|
1532
|
+
export type LaunchPhaseBase = components['schemas']['LaunchPhaseBase'];
|
|
1533
|
+
/**
|
|
1534
|
+
* LaunchPhaseType
|
|
1535
|
+
*
|
|
1536
|
+
* @remarks
|
|
1537
|
+
* Type alias for the `LaunchPhaseType` OpenAPI schema.
|
|
1538
|
+
* This type represents launchphasetype data structures used in API requests and responses.
|
|
1539
|
+
*
|
|
1540
|
+
* @example
|
|
1541
|
+
* ```typescript
|
|
1542
|
+
* const response = await api.getLaunchPhaseType();
|
|
1543
|
+
* const item: LaunchPhaseType = response.results;
|
|
1544
|
+
* ```
|
|
1545
|
+
*
|
|
1546
|
+
* @see {@link components} - The OpenAPI components schema definition
|
|
1547
|
+
*/
|
|
1548
|
+
export type LaunchPhaseType = components['schemas']['LaunchPhaseType'];
|
|
1549
|
+
/**
|
|
1550
|
+
* LaunchPhasesBase
|
|
1551
|
+
*
|
|
1552
|
+
* @remarks
|
|
1553
|
+
* Type alias for the `LaunchPhasesBase` OpenAPI schema.
|
|
1554
|
+
* This type represents launchphasesbase data structures used in API requests and responses.
|
|
1555
|
+
*
|
|
1556
|
+
* @example
|
|
1557
|
+
* ```typescript
|
|
1558
|
+
* const response = await api.getLaunchPhasesBase();
|
|
1559
|
+
* const item: LaunchPhasesBase = response.results;
|
|
1560
|
+
* ```
|
|
1561
|
+
*
|
|
1562
|
+
* @see {@link components} - The OpenAPI components schema definition
|
|
1563
|
+
*/
|
|
1564
|
+
export type LaunchPhasesBase = components['schemas']['LaunchPhasesBase'];
|
|
1565
|
+
/**
|
|
1566
|
+
* LocalPresenceBase
|
|
1567
|
+
*
|
|
1568
|
+
* @remarks
|
|
1569
|
+
* Type alias for the `LocalPresenceBase` OpenAPI schema.
|
|
1570
|
+
* This type represents localpresencebase data structures used in API requests and responses.
|
|
1571
|
+
*
|
|
1572
|
+
* @example
|
|
1573
|
+
* ```typescript
|
|
1574
|
+
* const response = await api.getLocalPresenceBase();
|
|
1575
|
+
* const item: LocalPresenceBase = response.results;
|
|
1576
|
+
* ```
|
|
1577
|
+
*
|
|
1578
|
+
* @see {@link components} - The OpenAPI components schema definition
|
|
1579
|
+
*/
|
|
1580
|
+
export type LocalPresenceBase = components['schemas']['LocalPresenceBase'];
|
|
1581
|
+
/**
|
|
1582
|
+
* LocalPresenceRequirementType
|
|
1583
|
+
*
|
|
1584
|
+
* @remarks
|
|
1585
|
+
* Type alias for the `LocalPresenceRequirementType` OpenAPI schema.
|
|
1586
|
+
* This type represents localpresencerequirementtype data structures used in API requests and responses.
|
|
1587
|
+
*
|
|
1588
|
+
* @example
|
|
1589
|
+
* ```typescript
|
|
1590
|
+
* const response = await api.getLocalPresenceRequirementType();
|
|
1591
|
+
* const item: LocalPresenceRequirementType = response.results;
|
|
1592
|
+
* ```
|
|
1593
|
+
*
|
|
1594
|
+
* @see {@link components} - The OpenAPI components schema definition
|
|
1595
|
+
*/
|
|
1596
|
+
export type LocalPresenceRequirementType = components['schemas']['LocalPresenceRequirementType'];
|
|
1597
|
+
/**
|
|
1598
|
+
* Nameserver
|
|
1599
|
+
*
|
|
1600
|
+
* @remarks
|
|
1601
|
+
* Type alias for the `Nameserver` OpenAPI schema.
|
|
1602
|
+
* This type represents nameserver data structures used in API requests and responses.
|
|
1603
|
+
*
|
|
1604
|
+
* @example
|
|
1605
|
+
* ```typescript
|
|
1606
|
+
* const response = await api.getNameserver();
|
|
1607
|
+
* const item: Nameserver = response.results;
|
|
1608
|
+
* ```
|
|
1609
|
+
*
|
|
1610
|
+
* @see {@link components} - The OpenAPI components schema definition
|
|
1611
|
+
*/
|
|
1612
|
+
export type Nameserver = components['schemas']['Nameserver'];
|
|
1613
|
+
/**
|
|
1614
|
+
* Notification
|
|
1615
|
+
*
|
|
1616
|
+
* @remarks
|
|
1617
|
+
* Type alias for the `Notification` OpenAPI schema.
|
|
1618
|
+
* This type represents notification data structures used in API requests and responses.
|
|
1619
|
+
*
|
|
1620
|
+
* @example
|
|
1621
|
+
* ```typescript
|
|
1622
|
+
* const response = await api.getNotification();
|
|
1623
|
+
* const item: Notification = response.results;
|
|
1624
|
+
* ```
|
|
1625
|
+
*
|
|
1626
|
+
* @see {@link components} - The OpenAPI components schema definition
|
|
1627
|
+
*/
|
|
1628
|
+
export type Notification = components['schemas']['Notification'];
|
|
1629
|
+
/**
|
|
1630
|
+
* NotificationCreate
|
|
1631
|
+
*
|
|
1632
|
+
* @remarks
|
|
1633
|
+
* Type alias for the `NotificationCreate` OpenAPI schema.
|
|
1634
|
+
* This type represents notificationcreate data structures used in API requests and responses.
|
|
1635
|
+
*
|
|
1636
|
+
* @example
|
|
1637
|
+
* ```typescript
|
|
1638
|
+
* const response = await api.getNotificationCreate();
|
|
1639
|
+
* const item: NotificationCreate = response.results;
|
|
1640
|
+
* ```
|
|
1641
|
+
*
|
|
1642
|
+
* @see {@link components} - The OpenAPI components schema definition
|
|
1643
|
+
*/
|
|
1644
|
+
export type NotificationCreate = components['schemas']['NotificationCreate'];
|
|
1645
|
+
/**
|
|
1646
|
+
* NotificationSummary
|
|
1647
|
+
*
|
|
1648
|
+
* @remarks
|
|
1649
|
+
* Type alias for the `NotificationSummary` OpenAPI schema.
|
|
1650
|
+
* This type represents notificationsummary data structures used in API requests and responses.
|
|
1651
|
+
*
|
|
1652
|
+
* @example
|
|
1653
|
+
* ```typescript
|
|
1654
|
+
* const response = await api.getNotificationSummary();
|
|
1655
|
+
* const item: NotificationSummary = response.results;
|
|
1656
|
+
* ```
|
|
1657
|
+
*
|
|
1658
|
+
* @see {@link components} - The OpenAPI components schema definition
|
|
1659
|
+
*/
|
|
1660
|
+
export type NotificationSummary = components['schemas']['NotificationSummary'];
|
|
1661
|
+
/**
|
|
1662
|
+
* NotificationUpdate
|
|
1663
|
+
*
|
|
1664
|
+
* @remarks
|
|
1665
|
+
* Type alias for the `NotificationUpdate` OpenAPI schema.
|
|
1666
|
+
* This type represents notificationupdate data structures used in API requests and responses.
|
|
1667
|
+
*
|
|
1668
|
+
* @example
|
|
1669
|
+
* ```typescript
|
|
1670
|
+
* const response = await api.getNotificationUpdate();
|
|
1671
|
+
* const item: NotificationUpdate = response.results;
|
|
1672
|
+
* ```
|
|
1673
|
+
*
|
|
1674
|
+
* @see {@link components} - The OpenAPI components schema definition
|
|
1675
|
+
*/
|
|
1676
|
+
export type NotificationUpdate = components['schemas']['NotificationUpdate'];
|
|
1677
|
+
/**
|
|
1678
|
+
* Organization
|
|
1679
|
+
*
|
|
1680
|
+
* @remarks
|
|
1681
|
+
* Type alias for the `Organization` OpenAPI schema.
|
|
1682
|
+
* This type represents organization data structures used in API requests and responses.
|
|
1683
|
+
*
|
|
1684
|
+
* @example
|
|
1685
|
+
* ```typescript
|
|
1686
|
+
* const response = await api.getOrganization();
|
|
1687
|
+
* const item: Organization = response.results;
|
|
1688
|
+
* ```
|
|
1689
|
+
*
|
|
1690
|
+
* @see {@link components} - The OpenAPI components schema definition
|
|
1691
|
+
*/
|
|
1692
|
+
export type Organization = components['schemas']['Organization'];
|
|
1693
|
+
/**
|
|
1694
|
+
* OrganizationAttribute
|
|
1695
|
+
*
|
|
1696
|
+
* @remarks
|
|
1697
|
+
* Type alias for the `OrganizationAttribute` OpenAPI schema.
|
|
1698
|
+
* This type represents organizationattribute data structures used in API requests and responses.
|
|
1699
|
+
*
|
|
1700
|
+
* @example
|
|
1701
|
+
* ```typescript
|
|
1702
|
+
* const response = await api.getOrganizationAttribute();
|
|
1703
|
+
* const item: OrganizationAttribute = response.results;
|
|
1704
|
+
* ```
|
|
1705
|
+
*
|
|
1706
|
+
* @see {@link components} - The OpenAPI components schema definition
|
|
1707
|
+
*/
|
|
1708
|
+
export type OrganizationAttribute = components['schemas']['OrganizationAttribute'];
|
|
1709
|
+
/**
|
|
1710
|
+
* OrganizationAttributeCreate
|
|
1711
|
+
*
|
|
1712
|
+
* @remarks
|
|
1713
|
+
* Type alias for the `OrganizationAttributeCreate` OpenAPI schema.
|
|
1714
|
+
* This type represents organizationattributecreate data structures used in API requests and responses.
|
|
1715
|
+
*
|
|
1716
|
+
* @example
|
|
1717
|
+
* ```typescript
|
|
1718
|
+
* const response = await api.getOrganizationAttributeCreate();
|
|
1719
|
+
* const item: OrganizationAttributeCreate = response.results;
|
|
1720
|
+
* ```
|
|
1721
|
+
*
|
|
1722
|
+
* @see {@link components} - The OpenAPI components schema definition
|
|
1723
|
+
*/
|
|
1724
|
+
export type OrganizationAttributeCreate = components['schemas']['OrganizationAttributeCreate'];
|
|
1725
|
+
/**
|
|
1726
|
+
* OrganizationAttributeResponse
|
|
1727
|
+
*
|
|
1728
|
+
* @remarks
|
|
1729
|
+
* Type alias for the `OrganizationAttributeResponse` OpenAPI schema.
|
|
1730
|
+
* This type represents organizationattributeresponse data structures used in API requests and responses.
|
|
1731
|
+
*
|
|
1732
|
+
* @example
|
|
1733
|
+
* ```typescript
|
|
1734
|
+
* const response = await api.getOrganizationAttribute2();
|
|
1735
|
+
* const item: OrganizationAttribute2 = response.results;
|
|
1736
|
+
* ```
|
|
1737
|
+
*
|
|
1738
|
+
* @see {@link components} - The OpenAPI components schema definition
|
|
1739
|
+
*/
|
|
1740
|
+
export type OrganizationAttribute2 = components['schemas']['OrganizationAttributeResponse'];
|
|
1741
|
+
/**
|
|
1742
|
+
* OrganizationAttributeUpdate
|
|
1743
|
+
*
|
|
1744
|
+
* @remarks
|
|
1745
|
+
* Type alias for the `OrganizationAttributeUpdate` OpenAPI schema.
|
|
1746
|
+
* This type represents organizationattributeupdate data structures used in API requests and responses.
|
|
1747
|
+
*
|
|
1748
|
+
* @example
|
|
1749
|
+
* ```typescript
|
|
1750
|
+
* const response = await api.getOrganizationAttributeUpdate();
|
|
1751
|
+
* const item: OrganizationAttributeUpdate = response.results;
|
|
1752
|
+
* ```
|
|
1753
|
+
*
|
|
1754
|
+
* @see {@link components} - The OpenAPI components schema definition
|
|
1755
|
+
*/
|
|
1756
|
+
export type OrganizationAttributeUpdate = components['schemas']['OrganizationAttributeUpdate'];
|
|
1757
|
+
/**
|
|
1758
|
+
* OrganizationCreate
|
|
1759
|
+
*
|
|
1760
|
+
* @remarks
|
|
1761
|
+
* Type alias for the `OrganizationCreate` OpenAPI schema.
|
|
1762
|
+
* This type represents organizationcreate data structures used in API requests and responses.
|
|
1763
|
+
*
|
|
1764
|
+
* @example
|
|
1765
|
+
* ```typescript
|
|
1766
|
+
* const response = await api.getOrganizationCreate();
|
|
1767
|
+
* const item: OrganizationCreate = response.results;
|
|
1768
|
+
* ```
|
|
1769
|
+
*
|
|
1770
|
+
* @see {@link components} - The OpenAPI components schema definition
|
|
1771
|
+
*/
|
|
1772
|
+
export type OrganizationCreate = components['schemas']['OrganizationCreate'];
|
|
1773
|
+
/**
|
|
1774
|
+
* OrganizationCredential
|
|
1775
|
+
*
|
|
1776
|
+
* @remarks
|
|
1777
|
+
* Type alias for the `OrganizationCredential` OpenAPI schema.
|
|
1778
|
+
* This type represents organizationcredential data structures used in API requests and responses.
|
|
1779
|
+
*
|
|
1780
|
+
* @example
|
|
1781
|
+
* ```typescript
|
|
1782
|
+
* const response = await api.getOrganizationCredential();
|
|
1783
|
+
* const item: OrganizationCredential = response.results;
|
|
1784
|
+
* ```
|
|
1785
|
+
*
|
|
1786
|
+
* @see {@link components} - The OpenAPI components schema definition
|
|
1787
|
+
*/
|
|
1788
|
+
export type OrganizationCredential = components['schemas']['OrganizationCredential'];
|
|
1789
|
+
/**
|
|
1790
|
+
* OrganizationCredentialCreated
|
|
1791
|
+
*
|
|
1792
|
+
* @remarks
|
|
1793
|
+
* Type alias for the `OrganizationCredentialCreated` OpenAPI schema.
|
|
1794
|
+
* This type represents organizationcredentialcreated data structures used in API requests and responses.
|
|
1795
|
+
*
|
|
1796
|
+
* @example
|
|
1797
|
+
* ```typescript
|
|
1798
|
+
* const response = await api.getOrganizationCredentialCreated();
|
|
1799
|
+
* const item: OrganizationCredentialCreated = response.results;
|
|
1800
|
+
* ```
|
|
1801
|
+
*
|
|
1802
|
+
* @see {@link components} - The OpenAPI components schema definition
|
|
1803
|
+
*/
|
|
1804
|
+
export type OrganizationCredentialCreated = components['schemas']['OrganizationCredentialCreated'];
|
|
1805
|
+
/**
|
|
1806
|
+
* OrganizationCredentialExtra
|
|
1807
|
+
*
|
|
1808
|
+
* @remarks
|
|
1809
|
+
* Type alias for the `OrganizationCredentialExtra` OpenAPI schema.
|
|
1810
|
+
* This type represents organizationcredentialextra data structures used in API requests and responses.
|
|
1811
|
+
*
|
|
1812
|
+
* @example
|
|
1813
|
+
* ```typescript
|
|
1814
|
+
* const response = await api.getOrganizationCredentialExtra();
|
|
1815
|
+
* const item: OrganizationCredentialExtra = response.results;
|
|
1816
|
+
* ```
|
|
1817
|
+
*
|
|
1818
|
+
* @see {@link components} - The OpenAPI components schema definition
|
|
1819
|
+
*/
|
|
1820
|
+
export type OrganizationCredentialExtra = components['schemas']['OrganizationCredentialExtra'];
|
|
1821
|
+
/**
|
|
1822
|
+
* OrganizationCredentialStatus
|
|
1823
|
+
*
|
|
1824
|
+
* @remarks
|
|
1825
|
+
* Type alias for the `OrganizationCredentialStatus` OpenAPI schema.
|
|
1826
|
+
* This type represents organizationcredentialstatus data structures used in API requests and responses.
|
|
1827
|
+
*
|
|
1828
|
+
* @example
|
|
1829
|
+
* ```typescript
|
|
1830
|
+
* const response = await api.getOrganizationCredentialStatus();
|
|
1831
|
+
* const item: OrganizationCredentialStatus = response.results;
|
|
1832
|
+
* ```
|
|
1833
|
+
*
|
|
1834
|
+
* @see {@link components} - The OpenAPI components schema definition
|
|
1835
|
+
*/
|
|
1836
|
+
export type OrganizationCredentialStatus = components['schemas']['OrganizationCredentialStatus'];
|
|
1837
|
+
/**
|
|
1838
|
+
* OrganizationStatus
|
|
1839
|
+
*
|
|
1840
|
+
* @remarks
|
|
1841
|
+
* Type alias for the `OrganizationStatus` OpenAPI schema.
|
|
1842
|
+
* This type represents organizationstatus data structures used in API requests and responses.
|
|
1843
|
+
*
|
|
1844
|
+
* @example
|
|
1845
|
+
* ```typescript
|
|
1846
|
+
* const response = await api.getOrganizationStatus();
|
|
1847
|
+
* const item: OrganizationStatus = response.results;
|
|
1848
|
+
* ```
|
|
1849
|
+
*
|
|
1850
|
+
* @see {@link components} - The OpenAPI components schema definition
|
|
1851
|
+
*/
|
|
1852
|
+
export type OrganizationStatus = components['schemas']['OrganizationStatus'];
|
|
1853
|
+
/**
|
|
1854
|
+
* OrganizationTokenResponse
|
|
1855
|
+
*
|
|
1856
|
+
* @remarks
|
|
1857
|
+
* Type alias for the `OrganizationTokenResponse` OpenAPI schema.
|
|
1858
|
+
* This type represents organizationtokenresponse data structures used in API requests and responses.
|
|
1859
|
+
*
|
|
1860
|
+
* @example
|
|
1861
|
+
* ```typescript
|
|
1862
|
+
* const response = await api.getOrganizationToken();
|
|
1863
|
+
* const item: OrganizationToken = response.results;
|
|
1864
|
+
* ```
|
|
1865
|
+
*
|
|
1866
|
+
* @see {@link components} - The OpenAPI components schema definition
|
|
1867
|
+
*/
|
|
1868
|
+
export type OrganizationToken = components['schemas']['OrganizationTokenResponse'];
|
|
1869
|
+
/**
|
|
1870
|
+
* OrganizationUpdate
|
|
1871
|
+
*
|
|
1872
|
+
* @remarks
|
|
1873
|
+
* Type alias for the `OrganizationUpdate` OpenAPI schema.
|
|
1874
|
+
* This type represents organizationupdate data structures used in API requests and responses.
|
|
1875
|
+
*
|
|
1876
|
+
* @example
|
|
1877
|
+
* ```typescript
|
|
1878
|
+
* const response = await api.getOrganizationUpdate();
|
|
1879
|
+
* const item: OrganizationUpdate = response.results;
|
|
1880
|
+
* ```
|
|
1881
|
+
*
|
|
1882
|
+
* @see {@link components} - The OpenAPI components schema definition
|
|
1883
|
+
*/
|
|
1884
|
+
export type OrganizationUpdate = components['schemas']['OrganizationUpdate'];
|
|
1885
|
+
/**
|
|
1886
|
+
* OrganizationWithPlan
|
|
1887
|
+
*
|
|
1888
|
+
* @remarks
|
|
1889
|
+
* Type alias for the `OrganizationWithPlan` OpenAPI schema.
|
|
1890
|
+
* This type represents organizationwithplan data structures used in API requests and responses.
|
|
1891
|
+
*
|
|
1892
|
+
* @example
|
|
1893
|
+
* ```typescript
|
|
1894
|
+
* const response = await api.getOrganizationWithPlan();
|
|
1895
|
+
* const item: OrganizationWithPlan = response.results;
|
|
1896
|
+
* ```
|
|
1897
|
+
*
|
|
1898
|
+
* @see {@link components} - The OpenAPI components schema definition
|
|
1899
|
+
*/
|
|
1900
|
+
export type OrganizationWithPlan = components['schemas']['OrganizationWithPlan'];
|
|
1901
|
+
/**
|
|
1902
|
+
* PaginationMetadata
|
|
1903
|
+
*
|
|
1904
|
+
* @remarks
|
|
1905
|
+
* Type alias for the `PaginationMetadata` OpenAPI schema.
|
|
1906
|
+
* This type represents paginationmetadata data structures used in API requests and responses.
|
|
1907
|
+
*
|
|
1908
|
+
* @example
|
|
1909
|
+
* ```typescript
|
|
1910
|
+
* const response = await api.getPaginationMetadata();
|
|
1911
|
+
* const item: PaginationMetadata = response.results;
|
|
1912
|
+
* ```
|
|
1913
|
+
*
|
|
1914
|
+
* @see {@link components} - The OpenAPI components schema definition
|
|
1915
|
+
*/
|
|
1916
|
+
export type PaginationMetadata = components['schemas']['PaginationMetadata'];
|
|
1917
|
+
/**
|
|
1918
|
+
* Pagination[ContactSchema]
|
|
1919
|
+
*
|
|
1920
|
+
* @remarks
|
|
1921
|
+
* Type alias for the `Pagination_ContactSchema_` OpenAPI schema.
|
|
1922
|
+
* This type represents pagination[contactschema] data structures used in API requests and responses.
|
|
1923
|
+
*
|
|
1924
|
+
* @example
|
|
1925
|
+
* ```typescript
|
|
1926
|
+
* const response = await api.getPagination_ContactSchema();
|
|
1927
|
+
* const item: Pagination_ContactSchema = response.results;
|
|
1928
|
+
* ```
|
|
1929
|
+
*
|
|
1930
|
+
* @see {@link components} - The OpenAPI components schema definition
|
|
1931
|
+
*/
|
|
1932
|
+
export type Pagination_ContactSchema = components['schemas']['Pagination_ContactSchema_'];
|
|
1933
|
+
/**
|
|
1934
|
+
* Pagination[DnsZoneResponse]
|
|
1935
|
+
*
|
|
1936
|
+
* @remarks
|
|
1937
|
+
* Type alias for the `Pagination_DnsZoneResponse_` OpenAPI schema.
|
|
1938
|
+
* This type represents pagination[dnszoneresponse] data structures used in API requests and responses.
|
|
1939
|
+
*
|
|
1940
|
+
* @example
|
|
1941
|
+
* ```typescript
|
|
1942
|
+
* const response = await api.getPagination_DnsZone();
|
|
1943
|
+
* const item: Pagination_DnsZone = response.results;
|
|
1944
|
+
* ```
|
|
1945
|
+
*
|
|
1946
|
+
* @see {@link components} - The OpenAPI components schema definition
|
|
1947
|
+
*/
|
|
1948
|
+
export type Pagination_DnsZone = components['schemas']['Pagination_DnsZoneResponse_'];
|
|
1949
|
+
/**
|
|
1950
|
+
* Pagination[DomainResponse]
|
|
1951
|
+
*
|
|
1952
|
+
* @remarks
|
|
1953
|
+
* Type alias for the `Pagination_DomainResponse_` OpenAPI schema.
|
|
1954
|
+
* This type represents pagination[domainresponse] data structures used in API requests and responses.
|
|
1955
|
+
*
|
|
1956
|
+
* @example
|
|
1957
|
+
* ```typescript
|
|
1958
|
+
* const response = await api.getPagination_Domain();
|
|
1959
|
+
* const item: Pagination_Domain = response.results;
|
|
1960
|
+
* ```
|
|
1961
|
+
*
|
|
1962
|
+
* @see {@link components} - The OpenAPI components schema definition
|
|
1963
|
+
*/
|
|
1964
|
+
export type Pagination_Domain = components['schemas']['Pagination_DomainResponse_'];
|
|
1965
|
+
/**
|
|
1966
|
+
* Pagination[EmailForward]
|
|
1967
|
+
*
|
|
1968
|
+
* @remarks
|
|
1969
|
+
* Type alias for the `Pagination_EmailForward_` OpenAPI schema.
|
|
1970
|
+
* This type represents pagination[emailforward] data structures used in API requests and responses.
|
|
1971
|
+
*
|
|
1972
|
+
* @example
|
|
1973
|
+
* ```typescript
|
|
1974
|
+
* const response = await api.getPagination_EmailForward();
|
|
1975
|
+
* const item: Pagination_EmailForward = response.results;
|
|
1976
|
+
* ```
|
|
1977
|
+
*
|
|
1978
|
+
* @see {@link components} - The OpenAPI components schema definition
|
|
1979
|
+
*/
|
|
1980
|
+
export type Pagination_EmailForward = components['schemas']['Pagination_EmailForward_'];
|
|
1981
|
+
/**
|
|
1982
|
+
* Pagination[EventResponse]
|
|
1983
|
+
*
|
|
1984
|
+
* @remarks
|
|
1985
|
+
* Type alias for the `Pagination_EventResponse_` OpenAPI schema.
|
|
1986
|
+
* This type represents pagination[eventresponse] data structures used in API requests and responses.
|
|
1987
|
+
*
|
|
1988
|
+
* @example
|
|
1989
|
+
* ```typescript
|
|
1990
|
+
* const response = await api.getPagination_Event();
|
|
1991
|
+
* const item: Pagination_Event = response.results;
|
|
1992
|
+
* ```
|
|
1993
|
+
*
|
|
1994
|
+
* @see {@link components} - The OpenAPI components schema definition
|
|
1995
|
+
*/
|
|
1996
|
+
export type Pagination_Event = components['schemas']['Pagination_EventResponse_'];
|
|
1997
|
+
/**
|
|
1998
|
+
* Pagination[OrganizationCredential]
|
|
1999
|
+
*
|
|
2000
|
+
* @remarks
|
|
2001
|
+
* Type alias for the `Pagination_OrganizationCredential_` OpenAPI schema.
|
|
2002
|
+
* This type represents pagination[organizationcredential] data structures used in API requests and responses.
|
|
2003
|
+
*
|
|
2004
|
+
* @example
|
|
2005
|
+
* ```typescript
|
|
2006
|
+
* const response = await api.getPagination_OrganizationCredential();
|
|
2007
|
+
* const item: Pagination_OrganizationCredential = response.results;
|
|
2008
|
+
* ```
|
|
2009
|
+
*
|
|
2010
|
+
* @see {@link components} - The OpenAPI components schema definition
|
|
2011
|
+
*/
|
|
2012
|
+
export type Pagination_OrganizationCredential = components['schemas']['Pagination_OrganizationCredential_'];
|
|
2013
|
+
/**
|
|
2014
|
+
* Pagination[Organization]
|
|
2015
|
+
*
|
|
2016
|
+
* @remarks
|
|
2017
|
+
* Type alias for the `Pagination_Organization_` OpenAPI schema.
|
|
2018
|
+
* This type represents pagination[organization] data structures used in API requests and responses.
|
|
2019
|
+
*
|
|
2020
|
+
* @example
|
|
2021
|
+
* ```typescript
|
|
2022
|
+
* const response = await api.getPagination_Organization();
|
|
2023
|
+
* const item: Pagination_Organization = response.results;
|
|
2024
|
+
* ```
|
|
2025
|
+
*
|
|
2026
|
+
* @see {@link components} - The OpenAPI components schema definition
|
|
2027
|
+
*/
|
|
2028
|
+
export type Pagination_Organization = components['schemas']['Pagination_Organization_'];
|
|
2029
|
+
/**
|
|
2030
|
+
* Pagination[UserNotificationSummary]
|
|
2031
|
+
*
|
|
2032
|
+
* @remarks
|
|
2033
|
+
* Type alias for the `Pagination_UserNotificationSummary_` OpenAPI schema.
|
|
2034
|
+
* This type represents pagination[usernotificationsummary] data structures used in API requests and responses.
|
|
2035
|
+
*
|
|
2036
|
+
* @example
|
|
2037
|
+
* ```typescript
|
|
2038
|
+
* const response = await api.getPagination_UserNotificationSummary();
|
|
2039
|
+
* const item: Pagination_UserNotificationSummary = response.results;
|
|
2040
|
+
* ```
|
|
2041
|
+
*
|
|
2042
|
+
* @see {@link components} - The OpenAPI components schema definition
|
|
2043
|
+
*/
|
|
2044
|
+
export type Pagination_UserNotificationSummary = components['schemas']['Pagination_UserNotificationSummary_'];
|
|
2045
|
+
/**
|
|
2046
|
+
* Pagination[User]
|
|
2047
|
+
*
|
|
2048
|
+
* @remarks
|
|
2049
|
+
* Type alias for the `Pagination_User_` OpenAPI schema.
|
|
2050
|
+
* This type represents pagination[user] data structures used in API requests and responses.
|
|
2051
|
+
*
|
|
2052
|
+
* @example
|
|
2053
|
+
* ```typescript
|
|
2054
|
+
* const response = await api.getPagination_User();
|
|
2055
|
+
* const item: Pagination_User = response.results;
|
|
2056
|
+
* ```
|
|
2057
|
+
*
|
|
2058
|
+
* @see {@link components} - The OpenAPI components schema definition
|
|
2059
|
+
*/
|
|
2060
|
+
export type Pagination_User = components['schemas']['Pagination_User_'];
|
|
2061
|
+
/**
|
|
2062
|
+
* PatchOp
|
|
2063
|
+
*
|
|
2064
|
+
* @remarks
|
|
2065
|
+
* Type alias for the `PatchOp` OpenAPI schema.
|
|
2066
|
+
* This type represents patchop data structures used in API requests and responses.
|
|
2067
|
+
*
|
|
2068
|
+
* @example
|
|
2069
|
+
* ```typescript
|
|
2070
|
+
* const response = await api.getPatchOp();
|
|
2071
|
+
* const item: PatchOp = response.results;
|
|
2072
|
+
* ```
|
|
2073
|
+
*
|
|
2074
|
+
* @see {@link components} - The OpenAPI components schema definition
|
|
2075
|
+
*/
|
|
2076
|
+
export type PatchOp = components['schemas']['PatchOp'];
|
|
2077
|
+
/**
|
|
2078
|
+
* Period
|
|
2079
|
+
*
|
|
2080
|
+
* @remarks
|
|
2081
|
+
* Type alias for the `Period` OpenAPI schema.
|
|
2082
|
+
* This type represents period data structures used in API requests and responses.
|
|
2083
|
+
*
|
|
2084
|
+
* @example
|
|
2085
|
+
* ```typescript
|
|
2086
|
+
* const response = await api.getPeriod();
|
|
2087
|
+
* const item: Period = response.results;
|
|
2088
|
+
* ```
|
|
2089
|
+
*
|
|
2090
|
+
* @see {@link components} - The OpenAPI components schema definition
|
|
2091
|
+
*/
|
|
2092
|
+
export type Period = components['schemas']['Period'];
|
|
2093
|
+
/**
|
|
2094
|
+
* PeriodList
|
|
2095
|
+
*
|
|
2096
|
+
* @remarks
|
|
2097
|
+
* Type alias for the `PeriodList` OpenAPI schema.
|
|
2098
|
+
* This type represents periodlist data structures used in API requests and responses.
|
|
2099
|
+
*
|
|
2100
|
+
* @example
|
|
2101
|
+
* ```typescript
|
|
2102
|
+
* const response = await api.getPeriodList();
|
|
2103
|
+
* const item: PeriodList = response.results;
|
|
2104
|
+
* ```
|
|
2105
|
+
*
|
|
2106
|
+
* @see {@link components} - The OpenAPI components schema definition
|
|
2107
|
+
*/
|
|
2108
|
+
export type PeriodList = components['schemas']['PeriodList'];
|
|
2109
|
+
/**
|
|
2110
|
+
* PeriodUnit
|
|
2111
|
+
*
|
|
2112
|
+
* @remarks
|
|
2113
|
+
* Type alias for the `PeriodUnit` OpenAPI schema.
|
|
2114
|
+
* This type represents periodunit data structures used in API requests and responses.
|
|
2115
|
+
*
|
|
2116
|
+
* @example
|
|
2117
|
+
* ```typescript
|
|
2118
|
+
* const response = await api.getPeriodUnit();
|
|
2119
|
+
* const item: PeriodUnit = response.results;
|
|
2120
|
+
* ```
|
|
2121
|
+
*
|
|
2122
|
+
* @see {@link components} - The OpenAPI components schema definition
|
|
2123
|
+
*/
|
|
2124
|
+
export type PeriodUnit = components['schemas']['PeriodUnit'];
|
|
2125
|
+
/**
|
|
2126
|
+
* Permission
|
|
2127
|
+
*
|
|
2128
|
+
* @remarks
|
|
2129
|
+
* Type alias for the `Permission` OpenAPI schema.
|
|
2130
|
+
* This type represents permission data structures used in API requests and responses.
|
|
2131
|
+
*
|
|
2132
|
+
* @example
|
|
2133
|
+
* ```typescript
|
|
2134
|
+
* const response = await api.getPermission();
|
|
2135
|
+
* const item: Permission = response.results;
|
|
2136
|
+
* ```
|
|
2137
|
+
*
|
|
2138
|
+
* @see {@link components} - The OpenAPI components schema definition
|
|
2139
|
+
*/
|
|
2140
|
+
export type Permission = components['schemas']['Permission'];
|
|
2141
|
+
/**
|
|
2142
|
+
* PermissionSet
|
|
2143
|
+
*
|
|
2144
|
+
* @remarks
|
|
2145
|
+
* Type alias for the `PermissionSet` OpenAPI schema.
|
|
2146
|
+
* This type represents permissionset data structures used in API requests and responses.
|
|
2147
|
+
*
|
|
2148
|
+
* @example
|
|
2149
|
+
* ```typescript
|
|
2150
|
+
* const response = await api.getPermissionSet();
|
|
2151
|
+
* const item: PermissionSet = response.results;
|
|
2152
|
+
* ```
|
|
2153
|
+
*
|
|
2154
|
+
* @see {@link components} - The OpenAPI components schema definition
|
|
2155
|
+
*/
|
|
2156
|
+
export type PermissionSet = components['schemas']['PermissionSet'];
|
|
2157
|
+
/**
|
|
2158
|
+
* PlanRelation
|
|
2159
|
+
*
|
|
2160
|
+
* @remarks
|
|
2161
|
+
* Type alias for the `PlanRelation` OpenAPI schema.
|
|
2162
|
+
* This type represents planrelation data structures used in API requests and responses.
|
|
2163
|
+
*
|
|
2164
|
+
* @example
|
|
2165
|
+
* ```typescript
|
|
2166
|
+
* const response = await api.getPlanRelation();
|
|
2167
|
+
* const item: PlanRelation = response.results;
|
|
2168
|
+
* ```
|
|
2169
|
+
*
|
|
2170
|
+
* @see {@link components} - The OpenAPI components schema definition
|
|
2171
|
+
*/
|
|
2172
|
+
export type PlanRelation = components['schemas']['PlanRelation'];
|
|
2173
|
+
/**
|
|
2174
|
+
* PlanUpdate
|
|
2175
|
+
*
|
|
2176
|
+
* @remarks
|
|
2177
|
+
* Type alias for the `PlanUpdate` OpenAPI schema.
|
|
2178
|
+
* This type represents planupdate data structures used in API requests and responses.
|
|
2179
|
+
*
|
|
2180
|
+
* @example
|
|
2181
|
+
* ```typescript
|
|
2182
|
+
* const response = await api.getPlanUpdate();
|
|
2183
|
+
* const item: PlanUpdate = response.results;
|
|
2184
|
+
* ```
|
|
2185
|
+
*
|
|
2186
|
+
* @see {@link components} - The OpenAPI components schema definition
|
|
2187
|
+
*/
|
|
2188
|
+
export type PlanUpdate = components['schemas']['PlanUpdate'];
|
|
2189
|
+
/**
|
|
2190
|
+
* PostTransferRequirements
|
|
2191
|
+
*
|
|
2192
|
+
* @remarks
|
|
2193
|
+
* Type alias for the `PostTransferRequirements` OpenAPI schema.
|
|
2194
|
+
* This type represents posttransferrequirements data structures used in API requests and responses.
|
|
2195
|
+
*
|
|
2196
|
+
* @example
|
|
2197
|
+
* ```typescript
|
|
2198
|
+
* const response = await api.getPostTransferRequirements();
|
|
2199
|
+
* const item: PostTransferRequirements = response.results;
|
|
2200
|
+
* ```
|
|
2201
|
+
*
|
|
2202
|
+
* @see {@link components} - The OpenAPI components schema definition
|
|
2203
|
+
*/
|
|
2204
|
+
export type PostTransferRequirements = components['schemas']['PostTransferRequirements'];
|
|
2205
|
+
/**
|
|
2206
|
+
* PostalAddressType
|
|
2207
|
+
*
|
|
2208
|
+
* @remarks
|
|
2209
|
+
* Type alias for the `PostalAddressType` OpenAPI schema.
|
|
2210
|
+
* This type represents postaladdresstype data structures used in API requests and responses.
|
|
2211
|
+
*
|
|
2212
|
+
* @example
|
|
2213
|
+
* ```typescript
|
|
2214
|
+
* const response = await api.getPostalAddressType();
|
|
2215
|
+
* const item: PostalAddressType = response.results;
|
|
2216
|
+
* ```
|
|
2217
|
+
*
|
|
2218
|
+
* @see {@link components} - The OpenAPI components schema definition
|
|
2219
|
+
*/
|
|
2220
|
+
export type PostalAddressType = components['schemas']['PostalAddressType'];
|
|
2221
|
+
/**
|
|
2222
|
+
* PremiumAffectsType
|
|
2223
|
+
*
|
|
2224
|
+
* @remarks
|
|
2225
|
+
* Type alias for the `PremiumAffectsType` OpenAPI schema.
|
|
2226
|
+
* This type represents premiumaffectstype data structures used in API requests and responses.
|
|
2227
|
+
*
|
|
2228
|
+
* @example
|
|
2229
|
+
* ```typescript
|
|
2230
|
+
* const response = await api.getPremiumAffectsType();
|
|
2231
|
+
* const item: PremiumAffectsType = response.results;
|
|
2232
|
+
* ```
|
|
2233
|
+
*
|
|
2234
|
+
* @see {@link components} - The OpenAPI components schema definition
|
|
2235
|
+
*/
|
|
2236
|
+
export type PremiumAffectsType = components['schemas']['PremiumAffectsType'];
|
|
2237
|
+
/**
|
|
2238
|
+
* PremiumDomainsBase
|
|
2239
|
+
*
|
|
2240
|
+
* @remarks
|
|
2241
|
+
* Type alias for the `PremiumDomainsBase` OpenAPI schema.
|
|
2242
|
+
* This type represents premiumdomainsbase data structures used in API requests and responses.
|
|
2243
|
+
*
|
|
2244
|
+
* @example
|
|
2245
|
+
* ```typescript
|
|
2246
|
+
* const response = await api.getPremiumDomainsBase();
|
|
2247
|
+
* const item: PremiumDomainsBase = response.results;
|
|
2248
|
+
* ```
|
|
2249
|
+
*
|
|
2250
|
+
* @see {@link components} - The OpenAPI components schema definition
|
|
2251
|
+
*/
|
|
2252
|
+
export type PremiumDomainsBase = components['schemas']['PremiumDomainsBase'];
|
|
2253
|
+
/**
|
|
2254
|
+
* PremiumSourceType
|
|
2255
|
+
*
|
|
2256
|
+
* @remarks
|
|
2257
|
+
* Type alias for the `PremiumSourceType` OpenAPI schema.
|
|
2258
|
+
* This type represents premiumsourcetype data structures used in API requests and responses.
|
|
2259
|
+
*
|
|
2260
|
+
* @example
|
|
2261
|
+
* ```typescript
|
|
2262
|
+
* const response = await api.getPremiumSourceType();
|
|
2263
|
+
* const item: PremiumSourceType = response.results;
|
|
2264
|
+
* ```
|
|
2265
|
+
*
|
|
2266
|
+
* @see {@link components} - The OpenAPI components schema definition
|
|
2267
|
+
*/
|
|
2268
|
+
export type PremiumSourceType = components['schemas']['PremiumSourceType'];
|
|
2269
|
+
/**
|
|
2270
|
+
* Problem
|
|
2271
|
+
*
|
|
2272
|
+
* @remarks
|
|
2273
|
+
* Type alias for the `Problem` OpenAPI schema.
|
|
2274
|
+
* This type represents problem data structures used in API requests and responses.
|
|
2275
|
+
*
|
|
2276
|
+
* @example
|
|
2277
|
+
* ```typescript
|
|
2278
|
+
* const response = await api.getProblem();
|
|
2279
|
+
* const item: Problem = response.results;
|
|
2280
|
+
* ```
|
|
2281
|
+
*
|
|
2282
|
+
* @see {@link components} - The OpenAPI components schema definition
|
|
2283
|
+
*/
|
|
2284
|
+
export type Problem = components['schemas']['Problem'];
|
|
2285
|
+
/**
|
|
2286
|
+
* RdapBase
|
|
2287
|
+
*
|
|
2288
|
+
* @remarks
|
|
2289
|
+
* Type alias for the `RdapBase` OpenAPI schema.
|
|
2290
|
+
* This type represents rdapbase data structures used in API requests and responses.
|
|
2291
|
+
*
|
|
2292
|
+
* @example
|
|
2293
|
+
* ```typescript
|
|
2294
|
+
* const response = await api.getRdapBase();
|
|
2295
|
+
* const item: RdapBase = response.results;
|
|
2296
|
+
* ```
|
|
2297
|
+
*
|
|
2298
|
+
* @see {@link components} - The OpenAPI components schema definition
|
|
2299
|
+
*/
|
|
2300
|
+
export type RdapBase = components['schemas']['RdapBase'];
|
|
2301
|
+
/**
|
|
2302
|
+
* RegistrantChangeType
|
|
2303
|
+
*
|
|
2304
|
+
* @remarks
|
|
2305
|
+
* Type alias for the `RegistrantChangeType` OpenAPI schema.
|
|
2306
|
+
* This type represents registrantchangetype data structures used in API requests and responses.
|
|
2307
|
+
*
|
|
2308
|
+
* @example
|
|
2309
|
+
* ```typescript
|
|
2310
|
+
* const response = await api.getRegistrantChangeType();
|
|
2311
|
+
* const item: RegistrantChangeType = response.results;
|
|
2312
|
+
* ```
|
|
2313
|
+
*
|
|
2314
|
+
* @see {@link components} - The OpenAPI components schema definition
|
|
2315
|
+
*/
|
|
2316
|
+
export type RegistrantChangeType = components['schemas']['RegistrantChangeType'];
|
|
2317
|
+
/**
|
|
2318
|
+
* RegistryLockBase
|
|
2319
|
+
*
|
|
2320
|
+
* @remarks
|
|
2321
|
+
* Type alias for the `RegistryLockBase` OpenAPI schema.
|
|
2322
|
+
* This type represents registrylockbase data structures used in API requests and responses.
|
|
2323
|
+
*
|
|
2324
|
+
* @example
|
|
2325
|
+
* ```typescript
|
|
2326
|
+
* const response = await api.getRegistryLockBase();
|
|
2327
|
+
* const item: RegistryLockBase = response.results;
|
|
2328
|
+
* ```
|
|
2329
|
+
*
|
|
2330
|
+
* @see {@link components} - The OpenAPI components schema definition
|
|
2331
|
+
*/
|
|
2332
|
+
export type RegistryLockBase = components['schemas']['RegistryLockBase'];
|
|
2333
|
+
/**
|
|
2334
|
+
* Relation
|
|
2335
|
+
*
|
|
2336
|
+
* @remarks
|
|
2337
|
+
* Type alias for the `Relation` OpenAPI schema.
|
|
2338
|
+
* This type represents relation data structures used in API requests and responses.
|
|
2339
|
+
*
|
|
2340
|
+
* @example
|
|
2341
|
+
* ```typescript
|
|
2342
|
+
* const response = await api.getRelation();
|
|
2343
|
+
* const item: Relation = response.results;
|
|
2344
|
+
* ```
|
|
2345
|
+
*
|
|
2346
|
+
* @see {@link components} - The OpenAPI components schema definition
|
|
2347
|
+
*/
|
|
2348
|
+
export type Relation = components['schemas']['Relation'];
|
|
2349
|
+
/**
|
|
2350
|
+
* RelationSet
|
|
2351
|
+
*
|
|
2352
|
+
* @remarks
|
|
2353
|
+
* Type alias for the `RelationSet` OpenAPI schema.
|
|
2354
|
+
* This type represents relationset data structures used in API requests and responses.
|
|
2355
|
+
*
|
|
2356
|
+
* @example
|
|
2357
|
+
* ```typescript
|
|
2358
|
+
* const response = await api.getRelationSet();
|
|
2359
|
+
* const item: RelationSet = response.results;
|
|
2360
|
+
* ```
|
|
2361
|
+
*
|
|
2362
|
+
* @see {@link components} - The OpenAPI components schema definition
|
|
2363
|
+
*/
|
|
2364
|
+
export type RelationSet = components['schemas']['RelationSet'];
|
|
2365
|
+
/**
|
|
2366
|
+
* RenewalMode
|
|
2367
|
+
*
|
|
2368
|
+
* @remarks
|
|
2369
|
+
* Type alias for the `RenewalMode` OpenAPI schema.
|
|
2370
|
+
* This type represents renewalmode data structures used in API requests and responses.
|
|
2371
|
+
*
|
|
2372
|
+
* @example
|
|
2373
|
+
* ```typescript
|
|
2374
|
+
* const response = await api.getRenewalMode();
|
|
2375
|
+
* const item: RenewalMode = response.results;
|
|
2376
|
+
* ```
|
|
2377
|
+
*
|
|
2378
|
+
* @see {@link components} - The OpenAPI components schema definition
|
|
2379
|
+
*/
|
|
2380
|
+
export type RenewalMode = components['schemas']['RenewalMode'];
|
|
2381
|
+
/**
|
|
2382
|
+
* ReservedDomainsBase
|
|
2383
|
+
*
|
|
2384
|
+
* @remarks
|
|
2385
|
+
* Type alias for the `ReservedDomainsBase` OpenAPI schema.
|
|
2386
|
+
* This type represents reserveddomainsbase data structures used in API requests and responses.
|
|
2387
|
+
*
|
|
2388
|
+
* @example
|
|
2389
|
+
* ```typescript
|
|
2390
|
+
* const response = await api.getReservedDomainsBase();
|
|
2391
|
+
* const item: ReservedDomainsBase = response.results;
|
|
2392
|
+
* ```
|
|
2393
|
+
*
|
|
2394
|
+
* @see {@link components} - The OpenAPI components schema definition
|
|
2395
|
+
*/
|
|
2396
|
+
export type ReservedDomainsBase = components['schemas']['ReservedDomainsBase'];
|
|
2397
|
+
/**
|
|
2398
|
+
* ReservedSourceType
|
|
2399
|
+
*
|
|
2400
|
+
* @remarks
|
|
2401
|
+
* Type alias for the `ReservedSourceType` OpenAPI schema.
|
|
2402
|
+
* This type represents reservedsourcetype data structures used in API requests and responses.
|
|
2403
|
+
*
|
|
2404
|
+
* @example
|
|
2405
|
+
* ```typescript
|
|
2406
|
+
* const response = await api.getReservedSourceType();
|
|
2407
|
+
* const item: ReservedSourceType = response.results;
|
|
2408
|
+
* ```
|
|
2409
|
+
*
|
|
2410
|
+
* @see {@link components} - The OpenAPI components schema definition
|
|
2411
|
+
*/
|
|
2412
|
+
export type ReservedSourceType = components['schemas']['ReservedSourceType'];
|
|
2413
|
+
/**
|
|
2414
|
+
* SignupCreate
|
|
2415
|
+
*
|
|
2416
|
+
* @remarks
|
|
2417
|
+
* Type alias for the `SignupCreate` OpenAPI schema.
|
|
2418
|
+
* This type represents signupcreate data structures used in API requests and responses.
|
|
2419
|
+
*
|
|
2420
|
+
* @example
|
|
2421
|
+
* ```typescript
|
|
2422
|
+
* const response = await api.getSignupCreate();
|
|
2423
|
+
* const item: SignupCreate = response.results;
|
|
2424
|
+
* ```
|
|
2425
|
+
*
|
|
2426
|
+
* @see {@link components} - The OpenAPI components schema definition
|
|
2427
|
+
*/
|
|
2428
|
+
export type SignupCreate = components['schemas']['SignupCreate'];
|
|
2429
|
+
/**
|
|
2430
|
+
* SldLength
|
|
2431
|
+
*
|
|
2432
|
+
* @remarks
|
|
2433
|
+
* Type alias for the `SldLength` OpenAPI schema.
|
|
2434
|
+
* This type represents sldlength data structures used in API requests and responses.
|
|
2435
|
+
*
|
|
2436
|
+
* @example
|
|
2437
|
+
* ```typescript
|
|
2438
|
+
* const response = await api.getSldLength();
|
|
2439
|
+
* const item: SldLength = response.results;
|
|
2440
|
+
* ```
|
|
2441
|
+
*
|
|
2442
|
+
* @see {@link components} - The OpenAPI components schema definition
|
|
2443
|
+
*/
|
|
2444
|
+
export type SldLength = components['schemas']['SldLength'];
|
|
2445
|
+
/**
|
|
2446
|
+
* SortOrder
|
|
2447
|
+
*
|
|
2448
|
+
* @remarks
|
|
2449
|
+
* Type alias for the `SortOrder` OpenAPI schema.
|
|
2450
|
+
* This type represents sortorder data structures used in API requests and responses.
|
|
2451
|
+
*
|
|
2452
|
+
* @example
|
|
2453
|
+
* ```typescript
|
|
2454
|
+
* const response = await api.getSortOrder();
|
|
2455
|
+
* const item: SortOrder = response.results;
|
|
2456
|
+
* ```
|
|
2457
|
+
*
|
|
2458
|
+
* @see {@link components} - The OpenAPI components schema definition
|
|
2459
|
+
*/
|
|
2460
|
+
export type SortOrder = components['schemas']['SortOrder'];
|
|
2461
|
+
/**
|
|
2462
|
+
* SpiceDbRelationshipUpdate
|
|
2463
|
+
*
|
|
2464
|
+
* @remarks
|
|
2465
|
+
* Type alias for the `SpiceDbRelationshipUpdate` OpenAPI schema.
|
|
2466
|
+
* This type represents spicedbrelationshipupdate data structures used in API requests and responses.
|
|
2467
|
+
*
|
|
2468
|
+
* @example
|
|
2469
|
+
* ```typescript
|
|
2470
|
+
* const response = await api.getSpiceDbRelationshipUpdate();
|
|
2471
|
+
* const item: SpiceDbRelationshipUpdate = response.results;
|
|
2472
|
+
* ```
|
|
2473
|
+
*
|
|
2474
|
+
* @see {@link components} - The OpenAPI components schema definition
|
|
2475
|
+
*/
|
|
2476
|
+
export type SpiceDbRelationshipUpdate = components['schemas']['SpiceDbRelationshipUpdate'];
|
|
2477
|
+
/**
|
|
2478
|
+
* SyncOperationType
|
|
2479
|
+
*
|
|
2480
|
+
* @remarks
|
|
2481
|
+
* Type alias for the `SyncOperationType` OpenAPI schema.
|
|
2482
|
+
* This type represents syncoperationtype data structures used in API requests and responses.
|
|
2483
|
+
*
|
|
2484
|
+
* @example
|
|
2485
|
+
* ```typescript
|
|
2486
|
+
* const response = await api.getSyncOperationType();
|
|
2487
|
+
* const item: SyncOperationType = response.results;
|
|
2488
|
+
* ```
|
|
2489
|
+
*
|
|
2490
|
+
* @see {@link components} - The OpenAPI components schema definition
|
|
2491
|
+
*/
|
|
2492
|
+
export type SyncOperationType = components['schemas']['SyncOperationType'];
|
|
2493
|
+
/**
|
|
2494
|
+
* TLDType
|
|
2495
|
+
*
|
|
2496
|
+
* @remarks
|
|
2497
|
+
* Type alias for the `TLDType` OpenAPI schema.
|
|
2498
|
+
* This type represents tldtype data structures used in API requests and responses.
|
|
2499
|
+
*
|
|
2500
|
+
* @example
|
|
2501
|
+
* ```typescript
|
|
2502
|
+
* const response = await api.getTLDType();
|
|
2503
|
+
* const item: TLDType = response.results;
|
|
2504
|
+
* ```
|
|
2505
|
+
*
|
|
2506
|
+
* @see {@link components} - The OpenAPI components schema definition
|
|
2507
|
+
*/
|
|
2508
|
+
export type TLDType = components['schemas']['TLDType'];
|
|
2509
|
+
/**
|
|
2510
|
+
* TermsOfServiceAccept
|
|
2511
|
+
*
|
|
2512
|
+
* @remarks
|
|
2513
|
+
* Type alias for the `TermsOfServiceAccept` OpenAPI schema.
|
|
2514
|
+
* This type represents termsofserviceaccept data structures used in API requests and responses.
|
|
2515
|
+
*
|
|
2516
|
+
* @example
|
|
2517
|
+
* ```typescript
|
|
2518
|
+
* const response = await api.getTermsOfServiceAccept();
|
|
2519
|
+
* const item: TermsOfServiceAccept = response.results;
|
|
2520
|
+
* ```
|
|
2521
|
+
*
|
|
2522
|
+
* @see {@link components} - The OpenAPI components schema definition
|
|
2523
|
+
*/
|
|
2524
|
+
export type TermsOfServiceAccept = components['schemas']['TermsOfServiceAccept'];
|
|
2525
|
+
/**
|
|
2526
|
+
* TldBase
|
|
2527
|
+
*
|
|
2528
|
+
* @remarks
|
|
2529
|
+
* Type alias for the `TldBase` OpenAPI schema.
|
|
2530
|
+
* This type represents tldbase data structures used in API requests and responses.
|
|
2531
|
+
*
|
|
2532
|
+
* @example
|
|
2533
|
+
* ```typescript
|
|
2534
|
+
* const response = await api.getTldBase();
|
|
2535
|
+
* const item: TldBase = response.results;
|
|
2536
|
+
* ```
|
|
2537
|
+
*
|
|
2538
|
+
* @see {@link components} - The OpenAPI components schema definition
|
|
2539
|
+
*/
|
|
2540
|
+
export type TldBase = components['schemas']['TldBase'];
|
|
2541
|
+
/**
|
|
2542
|
+
* TldResponseShort
|
|
2543
|
+
*
|
|
2544
|
+
* @remarks
|
|
2545
|
+
* Type alias for the `TldResponseShort` OpenAPI schema.
|
|
2546
|
+
* This type represents tldresponseshort data structures used in API requests and responses.
|
|
2547
|
+
*
|
|
2548
|
+
* @example
|
|
2549
|
+
* ```typescript
|
|
2550
|
+
* const response = await api.getTldResponseShort();
|
|
2551
|
+
* const item: TldResponseShort = response.results;
|
|
2552
|
+
* ```
|
|
2553
|
+
*
|
|
2554
|
+
* @see {@link components} - The OpenAPI components schema definition
|
|
2555
|
+
*/
|
|
2556
|
+
export type TldResponseShort = components['schemas']['TldResponseShort'];
|
|
2557
|
+
/**
|
|
2558
|
+
* TldSpecificationResponse
|
|
2559
|
+
*
|
|
2560
|
+
* @remarks
|
|
2561
|
+
* Type alias for the `TldSpecificationResponse` OpenAPI schema.
|
|
2562
|
+
* This type represents tldspecificationresponse data structures used in API requests and responses.
|
|
2563
|
+
*
|
|
2564
|
+
* @example
|
|
2565
|
+
* ```typescript
|
|
2566
|
+
* const response = await api.getTldSpecification();
|
|
2567
|
+
* const item: TldSpecification = response.results;
|
|
2568
|
+
* ```
|
|
2569
|
+
*
|
|
2570
|
+
* @see {@link components} - The OpenAPI components schema definition
|
|
2571
|
+
*/
|
|
2572
|
+
export type TldSpecification = components['schemas']['TldSpecificationResponse'];
|
|
2573
|
+
/**
|
|
2574
|
+
* TrademarkClaimsBase
|
|
2575
|
+
*
|
|
2576
|
+
* @remarks
|
|
2577
|
+
* Type alias for the `TrademarkClaimsBase` OpenAPI schema.
|
|
2578
|
+
* This type represents trademarkclaimsbase data structures used in API requests and responses.
|
|
2579
|
+
*
|
|
2580
|
+
* @example
|
|
2581
|
+
* ```typescript
|
|
2582
|
+
* const response = await api.getTrademarkClaimsBase();
|
|
2583
|
+
* const item: TrademarkClaimsBase = response.results;
|
|
2584
|
+
* ```
|
|
2585
|
+
*
|
|
2586
|
+
* @see {@link components} - The OpenAPI components schema definition
|
|
2587
|
+
*/
|
|
2588
|
+
export type TrademarkClaimsBase = components['schemas']['TrademarkClaimsBase'];
|
|
2589
|
+
/**
|
|
2590
|
+
* TransferAckType
|
|
2591
|
+
*
|
|
2592
|
+
* @remarks
|
|
2593
|
+
* Type alias for the `TransferAckType` OpenAPI schema.
|
|
2594
|
+
* This type represents transferacktype data structures used in API requests and responses.
|
|
2595
|
+
*
|
|
2596
|
+
* @example
|
|
2597
|
+
* ```typescript
|
|
2598
|
+
* const response = await api.getTransferAckType();
|
|
2599
|
+
* const item: TransferAckType = response.results;
|
|
2600
|
+
* ```
|
|
2601
|
+
*
|
|
2602
|
+
* @see {@link components} - The OpenAPI components schema definition
|
|
2603
|
+
*/
|
|
2604
|
+
export type TransferAckType = components['schemas']['TransferAckType'];
|
|
2605
|
+
/**
|
|
2606
|
+
* TransferEvent
|
|
2607
|
+
*
|
|
2608
|
+
* @remarks
|
|
2609
|
+
* Type alias for the `TransferEvent` OpenAPI schema.
|
|
2610
|
+
* This type represents transferevent data structures used in API requests and responses.
|
|
2611
|
+
*
|
|
2612
|
+
* @example
|
|
2613
|
+
* ```typescript
|
|
2614
|
+
* const response = await api.getTransferEvent();
|
|
2615
|
+
* const item: TransferEvent = response.results;
|
|
2616
|
+
* ```
|
|
2617
|
+
*
|
|
2618
|
+
* @see {@link components} - The OpenAPI components schema definition
|
|
2619
|
+
*/
|
|
2620
|
+
export type TransferEvent = components['schemas']['TransferEvent'];
|
|
2621
|
+
/**
|
|
2622
|
+
* TransferPoliciesBase
|
|
2623
|
+
*
|
|
2624
|
+
* @remarks
|
|
2625
|
+
* Type alias for the `TransferPoliciesBase` OpenAPI schema.
|
|
2626
|
+
* This type represents transferpoliciesbase data structures used in API requests and responses.
|
|
2627
|
+
*
|
|
2628
|
+
* @example
|
|
2629
|
+
* ```typescript
|
|
2630
|
+
* const response = await api.getTransferPoliciesBase();
|
|
2631
|
+
* const item: TransferPoliciesBase = response.results;
|
|
2632
|
+
* ```
|
|
2633
|
+
*
|
|
2634
|
+
* @see {@link components} - The OpenAPI components schema definition
|
|
2635
|
+
*/
|
|
2636
|
+
export type TransferPoliciesBase = components['schemas']['TransferPoliciesBase'];
|
|
2637
|
+
/**
|
|
2638
|
+
* User
|
|
2639
|
+
*
|
|
2640
|
+
* @remarks
|
|
2641
|
+
* Type alias for the `User` OpenAPI schema.
|
|
2642
|
+
* This type represents user data structures used in API requests and responses.
|
|
2643
|
+
*
|
|
2644
|
+
* @example
|
|
2645
|
+
* ```typescript
|
|
2646
|
+
* const response = await api.getUser();
|
|
2647
|
+
* const item: User = response.results;
|
|
2648
|
+
* ```
|
|
2649
|
+
*
|
|
2650
|
+
* @see {@link components} - The OpenAPI components schema definition
|
|
2651
|
+
*/
|
|
2652
|
+
export type User = components['schemas']['User'];
|
|
2653
|
+
/**
|
|
2654
|
+
* UserAttributeUpdate
|
|
2655
|
+
*
|
|
2656
|
+
* @remarks
|
|
2657
|
+
* Type alias for the `UserAttributeUpdate` OpenAPI schema.
|
|
2658
|
+
* This type represents userattributeupdate data structures used in API requests and responses.
|
|
2659
|
+
*
|
|
2660
|
+
* @example
|
|
2661
|
+
* ```typescript
|
|
2662
|
+
* const response = await api.getUserAttributeUpdate();
|
|
2663
|
+
* const item: UserAttributeUpdate = response.results;
|
|
2664
|
+
* ```
|
|
2665
|
+
*
|
|
2666
|
+
* @see {@link components} - The OpenAPI components schema definition
|
|
2667
|
+
*/
|
|
2668
|
+
export type UserAttributeUpdate = components['schemas']['UserAttributeUpdate'];
|
|
2669
|
+
/**
|
|
2670
|
+
* UserCreate
|
|
2671
|
+
*
|
|
2672
|
+
* @remarks
|
|
2673
|
+
* Type alias for the `UserCreate` OpenAPI schema.
|
|
2674
|
+
* This type represents usercreate data structures used in API requests and responses.
|
|
2675
|
+
*
|
|
2676
|
+
* @example
|
|
2677
|
+
* ```typescript
|
|
2678
|
+
* const response = await api.getUserCreate();
|
|
2679
|
+
* const item: UserCreate = response.results;
|
|
2680
|
+
* ```
|
|
2681
|
+
*
|
|
2682
|
+
* @see {@link components} - The OpenAPI components schema definition
|
|
2683
|
+
*/
|
|
2684
|
+
export type UserCreate = components['schemas']['UserCreate'];
|
|
2685
|
+
/**
|
|
2686
|
+
* UserNotification
|
|
2687
|
+
*
|
|
2688
|
+
* @remarks
|
|
2689
|
+
* Type alias for the `UserNotification` OpenAPI schema.
|
|
2690
|
+
* This type represents usernotification data structures used in API requests and responses.
|
|
2691
|
+
*
|
|
2692
|
+
* @example
|
|
2693
|
+
* ```typescript
|
|
2694
|
+
* const response = await api.getUserNotification();
|
|
2695
|
+
* const item: UserNotification = response.results;
|
|
2696
|
+
* ```
|
|
2697
|
+
*
|
|
2698
|
+
* @see {@link components} - The OpenAPI components schema definition
|
|
2699
|
+
*/
|
|
2700
|
+
export type UserNotification = components['schemas']['UserNotification'];
|
|
2701
|
+
/**
|
|
2702
|
+
* UserNotificationStatus
|
|
2703
|
+
*
|
|
2704
|
+
* @remarks
|
|
2705
|
+
* Type alias for the `UserNotificationStatus` OpenAPI schema.
|
|
2706
|
+
* This type represents usernotificationstatus data structures used in API requests and responses.
|
|
2707
|
+
*
|
|
2708
|
+
* @example
|
|
2709
|
+
* ```typescript
|
|
2710
|
+
* const response = await api.getUserNotificationStatus();
|
|
2711
|
+
* const item: UserNotificationStatus = response.results;
|
|
2712
|
+
* ```
|
|
2713
|
+
*
|
|
2714
|
+
* @see {@link components} - The OpenAPI components schema definition
|
|
2715
|
+
*/
|
|
2716
|
+
export type UserNotificationStatus = components['schemas']['UserNotificationStatus'];
|
|
2717
|
+
/**
|
|
2718
|
+
* UserNotificationSummary
|
|
2719
|
+
*
|
|
2720
|
+
* @remarks
|
|
2721
|
+
* Type alias for the `UserNotificationSummary` OpenAPI schema.
|
|
2722
|
+
* This type represents usernotificationsummary data structures used in API requests and responses.
|
|
2723
|
+
*
|
|
2724
|
+
* @example
|
|
2725
|
+
* ```typescript
|
|
2726
|
+
* const response = await api.getUserNotificationSummary();
|
|
2727
|
+
* const item: UserNotificationSummary = response.results;
|
|
2728
|
+
* ```
|
|
2729
|
+
*
|
|
2730
|
+
* @see {@link components} - The OpenAPI components schema definition
|
|
2731
|
+
*/
|
|
2732
|
+
export type UserNotificationSummary = components['schemas']['UserNotificationSummary'];
|
|
2733
|
+
/**
|
|
2734
|
+
* UserStatus
|
|
2735
|
+
*
|
|
2736
|
+
* @remarks
|
|
2737
|
+
* Type alias for the `UserStatus` OpenAPI schema.
|
|
2738
|
+
* This type represents userstatus data structures used in API requests and responses.
|
|
2739
|
+
*
|
|
2740
|
+
* @example
|
|
2741
|
+
* ```typescript
|
|
2742
|
+
* const response = await api.getUserStatus();
|
|
2743
|
+
* const item: UserStatus = response.results;
|
|
2744
|
+
* ```
|
|
2745
|
+
*
|
|
2746
|
+
* @see {@link components} - The OpenAPI components schema definition
|
|
2747
|
+
*/
|
|
2748
|
+
export type UserStatus = components['schemas']['UserStatus'];
|
|
2749
|
+
/**
|
|
2750
|
+
* UserTokenResponse
|
|
2751
|
+
*
|
|
2752
|
+
* @remarks
|
|
2753
|
+
* Type alias for the `UserTokenResponse` OpenAPI schema.
|
|
2754
|
+
* This type represents usertokenresponse data structures used in API requests and responses.
|
|
2755
|
+
*
|
|
2756
|
+
* @example
|
|
2757
|
+
* ```typescript
|
|
2758
|
+
* const response = await api.getUserToken();
|
|
2759
|
+
* const item: UserToken = response.results;
|
|
2760
|
+
* ```
|
|
2761
|
+
*
|
|
2762
|
+
* @see {@link components} - The OpenAPI components schema definition
|
|
2763
|
+
*/
|
|
2764
|
+
export type UserToken = components['schemas']['UserTokenResponse'];
|
|
2765
|
+
/**
|
|
2766
|
+
* UserUpdate
|
|
2767
|
+
*
|
|
2768
|
+
* @remarks
|
|
2769
|
+
* Type alias for the `UserUpdate` OpenAPI schema.
|
|
2770
|
+
* This type represents userupdate data structures used in API requests and responses.
|
|
2771
|
+
*
|
|
2772
|
+
* @example
|
|
2773
|
+
* ```typescript
|
|
2774
|
+
* const response = await api.getUserUpdate();
|
|
2775
|
+
* const item: UserUpdate = response.results;
|
|
2776
|
+
* ```
|
|
2777
|
+
*
|
|
2778
|
+
* @see {@link components} - The OpenAPI components schema definition
|
|
2779
|
+
*/
|
|
2780
|
+
export type UserUpdate = components['schemas']['UserUpdate'];
|
|
2781
|
+
/**
|
|
2782
|
+
* UserWithAttributes
|
|
2783
|
+
*
|
|
2784
|
+
* @remarks
|
|
2785
|
+
* Type alias for the `UserWithAttributes` OpenAPI schema.
|
|
2786
|
+
* This type represents userwithattributes data structures used in API requests and responses.
|
|
2787
|
+
*
|
|
2788
|
+
* @example
|
|
2789
|
+
* ```typescript
|
|
2790
|
+
* const response = await api.getUserWithAttributes();
|
|
2791
|
+
* const item: UserWithAttributes = response.results;
|
|
2792
|
+
* ```
|
|
2793
|
+
*
|
|
2794
|
+
* @see {@link components} - The OpenAPI components schema definition
|
|
2795
|
+
*/
|
|
2796
|
+
export type UserWithAttributes = components['schemas']['UserWithAttributes'];
|
|
2797
|
+
/**
|
|
2798
|
+
* UserWithRelationPermissions
|
|
2799
|
+
*
|
|
2800
|
+
* @remarks
|
|
2801
|
+
* Type alias for the `UserWithRelationPermissions` OpenAPI schema.
|
|
2802
|
+
* This type represents userwithrelationpermissions data structures used in API requests and responses.
|
|
2803
|
+
*
|
|
2804
|
+
* @example
|
|
2805
|
+
* ```typescript
|
|
2806
|
+
* const response = await api.getUserWithRelationPermissions();
|
|
2807
|
+
* const item: UserWithRelationPermissions = response.results;
|
|
2808
|
+
* ```
|
|
2809
|
+
*
|
|
2810
|
+
* @see {@link components} - The OpenAPI components schema definition
|
|
2811
|
+
*/
|
|
2812
|
+
export type UserWithRelationPermissions = components['schemas']['UserWithRelationPermissions'];
|
|
2813
|
+
/**
|
|
2814
|
+
* ValidationError
|
|
2815
|
+
*
|
|
2816
|
+
* @remarks
|
|
2817
|
+
* Type alias for the `ValidationError` OpenAPI schema.
|
|
2818
|
+
* This type represents validationerror data structures used in API requests and responses.
|
|
2819
|
+
*
|
|
2820
|
+
* @example
|
|
2821
|
+
* ```typescript
|
|
2822
|
+
* const response = await api.getValidationError();
|
|
2823
|
+
* const item: ValidationError = response.results;
|
|
2824
|
+
* ```
|
|
2825
|
+
*
|
|
2826
|
+
* @see {@link components} - The OpenAPI components schema definition
|
|
2827
|
+
*/
|
|
2828
|
+
export type ValidationError = components['schemas']['ValidationError'];
|
|
2829
|
+
/**
|
|
2830
|
+
* VerificationType
|
|
2831
|
+
*
|
|
2832
|
+
* @remarks
|
|
2833
|
+
* Type alias for the `VerificationType` OpenAPI schema.
|
|
2834
|
+
* This type represents verificationtype data structures used in API requests and responses.
|
|
2835
|
+
*
|
|
2836
|
+
* @example
|
|
2837
|
+
* ```typescript
|
|
2838
|
+
* const response = await api.getVerificationType();
|
|
2839
|
+
* const item: VerificationType = response.results;
|
|
2840
|
+
* ```
|
|
2841
|
+
*
|
|
2842
|
+
* @see {@link components} - The OpenAPI components schema definition
|
|
2843
|
+
*/
|
|
2844
|
+
export type VerificationType = components['schemas']['VerificationType'];
|
|
2845
|
+
/**
|
|
2846
|
+
* WhoisBase
|
|
2847
|
+
*
|
|
2848
|
+
* @remarks
|
|
2849
|
+
* Type alias for the `WhoisBase` OpenAPI schema.
|
|
2850
|
+
* This type represents whoisbase data structures used in API requests and responses.
|
|
2851
|
+
*
|
|
2852
|
+
* @example
|
|
2853
|
+
* ```typescript
|
|
2854
|
+
* const response = await api.getWhoisBase();
|
|
2855
|
+
* const item: WhoisBase = response.results;
|
|
2856
|
+
* ```
|
|
2857
|
+
*
|
|
2858
|
+
* @see {@link components} - The OpenAPI components schema definition
|
|
2859
|
+
*/
|
|
2860
|
+
export type WhoisBase = components['schemas']['WhoisBase'];
|
|
2861
|
+
/**
|
|
2862
|
+
* ZoneSortField
|
|
2863
|
+
*
|
|
2864
|
+
* @remarks
|
|
2865
|
+
* Type alias for the `ZoneSortField` OpenAPI schema.
|
|
2866
|
+
* This type represents zonesortfield data structures used in API requests and responses.
|
|
2867
|
+
*
|
|
2868
|
+
* @example
|
|
2869
|
+
* ```typescript
|
|
2870
|
+
* const response = await api.getZoneSortField();
|
|
2871
|
+
* const item: ZoneSortField = response.results;
|
|
2872
|
+
* ```
|
|
2873
|
+
*
|
|
2874
|
+
* @see {@link components} - The OpenAPI components schema definition
|
|
2875
|
+
*/
|
|
2876
|
+
export type ZoneSortField = components['schemas']['ZoneSortField'];
|
|
2877
|
+
/**
|
|
2878
|
+
* DomainAvailabilityResponse
|
|
2879
|
+
*
|
|
2880
|
+
* @remarks
|
|
2881
|
+
* Type alias for the `common__models__availability__datasource__DomainAvailabilityResponse` OpenAPI schema.
|
|
2882
|
+
* This type represents domainavailabilityresponse data structures used in API requests and responses.
|
|
2883
|
+
*
|
|
2884
|
+
* @example
|
|
2885
|
+
* ```typescript
|
|
2886
|
+
* const response = await api.getDomainAvailabilityList();
|
|
2887
|
+
* const item: DomainAvailabilityList = response.results;
|
|
2888
|
+
* ```
|
|
2889
|
+
*
|
|
2890
|
+
* @see {@link components} - The OpenAPI components schema definition
|
|
2891
|
+
*/
|
|
2892
|
+
export type DomainAvailabilityList = components['schemas']['common__models__availability__datasource__DomainAvailabilityResponse'];
|
|
2893
|
+
/**
|
|
2894
|
+
* DomainAvailabilityResponse
|
|
2895
|
+
*
|
|
2896
|
+
* @remarks
|
|
2897
|
+
* Type alias for the `common__models__domain__domain__DomainAvailabilityResponse` OpenAPI schema.
|
|
2898
|
+
* This type represents domainavailabilityresponse data structures used in API requests and responses.
|
|
2899
|
+
*
|
|
2900
|
+
* @example
|
|
2901
|
+
* ```typescript
|
|
2902
|
+
* const response = await api.getDomainAvailabilityCheck();
|
|
2903
|
+
* const item: DomainAvailabilityCheck = response.results;
|
|
2904
|
+
* ```
|
|
2905
|
+
*
|
|
2906
|
+
* @see {@link components} - The OpenAPI components schema definition
|
|
2907
|
+
*/
|
|
2908
|
+
export type DomainAvailabilityCheck = components['schemas']['common__models__domain__domain__DomainAvailabilityResponse'];
|