@opusdns/api 0.8.0 → 0.10.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.
@@ -0,0 +1,3493 @@
1
+ /**
2
+ * Request parameter types for OpusDNS API endpoints
3
+ *
4
+ * This file contains TypeScript types for API request parameters, bodies, and path parameters.
5
+ * Each type is derived from the OpenAPI operation specification and provides type safety for API calls.
6
+ * These types ensure that request parameters match the expected API contract.
7
+ *
8
+ * @remarks
9
+ * - Request types follow the pattern: `METHOD_EndpointName_V1_Request`
10
+ * - Parameter types are available as: `METHOD_EndpointName_V1_Request_Parameters_Query`, `METHOD_EndpointName_V1_Request_Parameters_Path`
11
+ * - Request body types are available as: `METHOD_EndpointName_V1_Request_RequestBody`
12
+ * - All types include comprehensive parameter descriptions from the OpenAPI specification
13
+ * - These types ensure type safety when making API requests
14
+ *
15
+ * @example
16
+ * ```typescript
17
+ * // Using request types for API calls
18
+ * const params: GET_Domains_V1_Request_Parameters_Query = {
19
+ * limit: 10,
20
+ * offset: 0
21
+ * };
22
+ *
23
+ * const body: POST_Domains_V1_Request_RequestBody = {
24
+ * domain: 'example.com',
25
+ * period: 1
26
+ * };
27
+ * ```
28
+ *
29
+ * This file is auto-generated from the OpenAPI specification.
30
+ * Do not edit manually.
31
+ */
32
+
33
+ import { operations, components } from '../schema';
34
+
35
+ import { DomainDnssecDataCreateArray, OrganizationAttributeUpdateArray } from './schemas-arrays';
36
+
37
+ import { OrganizationCredentialExtra, SignupCreate, ContactCreate, DnsZoneCreate, DnsZoneRecordsPatchOps, DnsZoneRrsetsPatchOps, DnsZoneRrsetsCreate, DomainCreate, DomainUpdate, DomainRenewRequest, DomainTransferIn, EmailForwardCreate, EmailForwardBulkDelete, EmailForwardBulkUpdate, EmailForwardUpdate, NotificationCreate, NotificationUpdate, OrganizationCreate, IpRestrictionCreate, IpRestrictionUpdate, OrganizationUpdate, PlanUpdate, UserCreate, TermsOfServiceAccept, UserUpdate, SpiceDbRelationshipUpdate } from './schemas';
38
+
39
+ /**
40
+ * Request type for GET AuthClientCredentials endpoint
41
+ *
42
+ * List Api Keys
43
+ *
44
+ * @remarks
45
+ * This type defines the complete request structure for the GET AuthClientCredentials endpoint.
46
+ * It includes all parameters (query, path) and request body types as defined in the OpenAPI specification.
47
+ * Use this type to ensure type safety when making API requests to this endpoint.
48
+ *
49
+ * @example
50
+ * Use this type to ensure type safety when making API requests to this endpoint.
51
+ *
52
+ * @path /v1/auth/client_credentials
53
+ * @param status (query) - Optional status to filter the results
54
+ *
55
+ * @see {@link GET_AuthClientCredentials_V1_Request_Parameters_Query} - Query parameters type
56
+ * @see {@link GET_AuthClientCredentials_V1_Request_Parameters_Path} - Path parameters type
57
+ * @see {@link GET_AuthClientCredentials_V1_Request_RequestBody} - Request body type
58
+ */
59
+ export type GET_AuthClientCredentials_V1_Request = {
60
+ parameters: {
61
+ query: operations['list_api_keys_v1_auth_client_credentials_get']['parameters']['query'];
62
+ };
63
+ }
64
+ /**
65
+ * Query parameters for GET /v1/auth/client_credentials
66
+ *
67
+ * @remarks
68
+ * This type defines the query parameters for the GET /v1/auth/client_credentials endpoint.
69
+ * It provides type safety for all query parameters as defined in the OpenAPI specification.
70
+ *
71
+ * @example
72
+ * Use this type to ensure type safety for query parameters.
73
+ *
74
+ * @path /v1/auth/client_credentials
75
+ * @param status (query) - Optional status to filter the results
76
+ */
77
+ export type GET_AuthClientCredentials_V1_Request_Parameters_Query = GET_AuthClientCredentials_V1_Request['parameters']['query'];
78
+
79
+ /**
80
+ * Request type for POST AuthClientCredentials endpoint
81
+ *
82
+ * Issue Api Key
83
+ *
84
+ * @remarks
85
+ * This type defines the complete request structure for the POST AuthClientCredentials endpoint.
86
+ * It includes all parameters (query, path) and request body types as defined in the OpenAPI specification.
87
+ * Use this type to ensure type safety when making API requests to this endpoint.
88
+ *
89
+ * @example
90
+ * Use this type to ensure type safety when making API requests to this endpoint.
91
+ *
92
+ * @path /v1/auth/client_credentials
93
+ *
94
+ * @see {@link POST_AuthClientCredentials_V1_Request_Parameters_Query} - Query parameters type
95
+ * @see {@link POST_AuthClientCredentials_V1_Request_Parameters_Path} - Path parameters type
96
+ * @see {@link POST_AuthClientCredentials_V1_Request_RequestBody} - Request body type
97
+ */
98
+ export type POST_AuthClientCredentials_V1_Request = {
99
+ requestBody: OrganizationCredentialExtra;
100
+ }
101
+ /**
102
+ * Request body for POST /v1/auth/client_credentials
103
+ *
104
+ * @remarks
105
+ * This type defines the request body structure for the POST /v1/auth/client_credentials endpoint.
106
+ * It provides type safety for the request body as defined in the OpenAPI specification.
107
+ *
108
+ * @example
109
+ * Use this type to ensure type safety for request body structure.
110
+ *
111
+ * @path /v1/auth/client_credentials
112
+ */
113
+ export type POST_AuthClientCredentials_V1_Request_RequestBody = POST_AuthClientCredentials_V1_Request['requestBody'];
114
+
115
+ /**
116
+ * Request type for DELETE AuthClientCredentialsApiKeyId endpoint
117
+ *
118
+ * Delete Api Key
119
+ *
120
+ * @remarks
121
+ * This type defines the complete request structure for the DELETE AuthClientCredentialsApiKeyId endpoint.
122
+ * It includes all parameters (query, path) and request body types as defined in the OpenAPI specification.
123
+ * Use this type to ensure type safety when making API requests to this endpoint.
124
+ *
125
+ * @example
126
+ * Use this type to ensure type safety when making API requests to this endpoint.
127
+ *
128
+ * @path /v1/auth/client_credentials/{api_key_id}
129
+ *
130
+ * @see {@link DELETE_AuthClientCredentialsApiKeyId_V1_Request_Parameters_Query} - Query parameters type
131
+ * @see {@link DELETE_AuthClientCredentialsApiKeyId_V1_Request_Parameters_Path} - Path parameters type
132
+ * @see {@link DELETE_AuthClientCredentialsApiKeyId_V1_Request_RequestBody} - Request body type
133
+ */
134
+ export type DELETE_AuthClientCredentialsApiKeyId_V1_Request = {
135
+ parameters: {
136
+ path: operations['delete_api_key_v1_auth_client_credentials__api_key_id__delete']['parameters']['path'];
137
+ };
138
+ }
139
+ /**
140
+ * Path parameters for DELETE /v1/auth/client_credentials/{api_key_id}
141
+ *
142
+ * @remarks
143
+ * This type defines the path parameters for the DELETE /v1/auth/client_credentials/{api_key_id} endpoint.
144
+ * It provides type safety for all path parameters as defined in the OpenAPI specification.
145
+ *
146
+ * @example
147
+ * Use this type to ensure type safety for path parameters.
148
+ *
149
+ * @path /v1/auth/client_credentials/{api_key_id}
150
+ */
151
+ export type DELETE_AuthClientCredentialsApiKeyId_V1_Request_Parameters_Path = DELETE_AuthClientCredentialsApiKeyId_V1_Request['parameters']['path'];
152
+
153
+ /**
154
+ * Request type for POST AuthLogout endpoint
155
+ *
156
+ * Logout
157
+ *
158
+ * @remarks
159
+ * This type defines the complete request structure for the POST AuthLogout endpoint.
160
+ * It includes all parameters (query, path) and request body types as defined in the OpenAPI specification.
161
+ * Use this type to ensure type safety when making API requests to this endpoint.
162
+ *
163
+ * @example
164
+ * Use this type to ensure type safety when making API requests to this endpoint.
165
+ *
166
+ * @path /v1/auth/logout
167
+ *
168
+ * @see {@link POST_AuthLogout_V1_Request_Parameters_Query} - Query parameters type
169
+ * @see {@link POST_AuthLogout_V1_Request_Parameters_Path} - Path parameters type
170
+ * @see {@link POST_AuthLogout_V1_Request_RequestBody} - Request body type
171
+ */
172
+ export type POST_AuthLogout_V1_Request = {
173
+ }
174
+
175
+ /**
176
+ * Request type for POST AuthSignup endpoint
177
+ *
178
+ * Signup
179
+ *
180
+ * @remarks
181
+ * This type defines the complete request structure for the POST AuthSignup endpoint.
182
+ * It includes all parameters (query, path) and request body types as defined in the OpenAPI specification.
183
+ * Use this type to ensure type safety when making API requests to this endpoint.
184
+ *
185
+ * @example
186
+ * Use this type to ensure type safety when making API requests to this endpoint.
187
+ *
188
+ * @path /v1/auth/signup
189
+ *
190
+ * @see {@link POST_AuthSignup_V1_Request_Parameters_Query} - Query parameters type
191
+ * @see {@link POST_AuthSignup_V1_Request_Parameters_Path} - Path parameters type
192
+ * @see {@link POST_AuthSignup_V1_Request_RequestBody} - Request body type
193
+ */
194
+ export type POST_AuthSignup_V1_Request = {
195
+ requestBody: SignupCreate;
196
+ }
197
+ /**
198
+ * Request body for POST /v1/auth/signup
199
+ *
200
+ * @remarks
201
+ * This type defines the request body structure for the POST /v1/auth/signup endpoint.
202
+ * It provides type safety for the request body as defined in the OpenAPI specification.
203
+ *
204
+ * @example
205
+ * Use this type to ensure type safety for request body structure.
206
+ *
207
+ * @path /v1/auth/signup
208
+ */
209
+ export type POST_AuthSignup_V1_Request_RequestBody = POST_AuthSignup_V1_Request['requestBody'];
210
+
211
+ /**
212
+ * Request type for POST AuthToken endpoint
213
+ *
214
+ * Issue Organization Token
215
+ *
216
+ * @remarks
217
+ * This type defines the complete request structure for the POST AuthToken endpoint.
218
+ * It includes all parameters (query, path) and request body types as defined in the OpenAPI specification.
219
+ * Use this type to ensure type safety when making API requests to this endpoint.
220
+ *
221
+ * @example
222
+ * Use this type to ensure type safety when making API requests to this endpoint.
223
+ *
224
+ * @path /v1/auth/token
225
+ *
226
+ * @see {@link POST_AuthToken_V1_Request_Parameters_Query} - Query parameters type
227
+ * @see {@link POST_AuthToken_V1_Request_Parameters_Path} - Path parameters type
228
+ * @see {@link POST_AuthToken_V1_Request_RequestBody} - Request body type
229
+ */
230
+ export type POST_AuthToken_V1_Request = {
231
+ }
232
+
233
+ /**
234
+ * Request type for GET Availability endpoint
235
+ *
236
+ * Bulk Availability
237
+ * Check the availability of one or more domains.
238
+ *
239
+ * @remarks
240
+ * This type defines the complete request structure for the GET Availability endpoint.
241
+ * It includes all parameters (query, path) and request body types as defined in the OpenAPI specification.
242
+ * Use this type to ensure type safety when making API requests to this endpoint.
243
+ *
244
+ * @example
245
+ * Use this type to ensure type safety when making API requests to this endpoint.
246
+ *
247
+ * @path /v1/availability
248
+ * @param domains (query) -
249
+ Specify one or more domains to check for availability.
250
+
251
+ *
252
+ * @see {@link GET_Availability_V1_Request_Parameters_Query} - Query parameters type
253
+ * @see {@link GET_Availability_V1_Request_Parameters_Path} - Path parameters type
254
+ * @see {@link GET_Availability_V1_Request_RequestBody} - Request body type
255
+ */
256
+ export type GET_Availability_V1_Request = {
257
+ parameters: {
258
+ query: operations['bulk_availability_v1_availability_get']['parameters']['query'];
259
+ };
260
+ }
261
+ /**
262
+ * Query parameters for GET /v1/availability
263
+ *
264
+ * @remarks
265
+ * This type defines the query parameters for the GET /v1/availability endpoint.
266
+ * It provides type safety for all query parameters as defined in the OpenAPI specification.
267
+ *
268
+ * @example
269
+ * Use this type to ensure type safety for query parameters.
270
+ *
271
+ * @path /v1/availability
272
+ * @param domains (query) -
273
+ Specify one or more domains to check for availability.
274
+
275
+ */
276
+ export type GET_Availability_V1_Request_Parameters_Query = GET_Availability_V1_Request['parameters']['query'];
277
+
278
+ /**
279
+ * Request type for GET AvailabilityStream endpoint
280
+ *
281
+ * Stream Availability
282
+ * Stream domain availability results using Server-Sent Events (SSE) until the `done` event is received.
283
+ *
284
+ * @remarks
285
+ * This type defines the complete request structure for the GET AvailabilityStream endpoint.
286
+ * It includes all parameters (query, path) and request body types as defined in the OpenAPI specification.
287
+ * Use this type to ensure type safety when making API requests to this endpoint.
288
+ *
289
+ * @example
290
+ * Use this type to ensure type safety when making API requests to this endpoint.
291
+ *
292
+ * @path /v1/availability/stream
293
+ * @param domains (query) -
294
+ Specify one or more domains to check for availability.
295
+
296
+ *
297
+ * @see {@link GET_AvailabilityStream_V1_Request_Parameters_Query} - Query parameters type
298
+ * @see {@link GET_AvailabilityStream_V1_Request_Parameters_Path} - Path parameters type
299
+ * @see {@link GET_AvailabilityStream_V1_Request_RequestBody} - Request body type
300
+ */
301
+ export type GET_AvailabilityStream_V1_Request = {
302
+ parameters: {
303
+ query: operations['stream_availability_v1_availability_stream_get']['parameters']['query'];
304
+ };
305
+ }
306
+ /**
307
+ * Query parameters for GET /v1/availability/stream
308
+ *
309
+ * @remarks
310
+ * This type defines the query parameters for the GET /v1/availability/stream endpoint.
311
+ * It provides type safety for all query parameters as defined in the OpenAPI specification.
312
+ *
313
+ * @example
314
+ * Use this type to ensure type safety for query parameters.
315
+ *
316
+ * @path /v1/availability/stream
317
+ * @param domains (query) -
318
+ Specify one or more domains to check for availability.
319
+
320
+ */
321
+ export type GET_AvailabilityStream_V1_Request_Parameters_Query = GET_AvailabilityStream_V1_Request['parameters']['query'];
322
+
323
+ /**
324
+ * Request type for GET Contacts endpoint
325
+ *
326
+ * Get Contacts
327
+ * List all contacts
328
+ *
329
+ * @remarks
330
+ * This type defines the complete request structure for the GET Contacts endpoint.
331
+ * It includes all parameters (query, path) and request body types as defined in the OpenAPI specification.
332
+ * Use this type to ensure type safety when making API requests to this endpoint.
333
+ *
334
+ * @example
335
+ * Use this type to ensure type safety when making API requests to this endpoint.
336
+ *
337
+ * @path /v1/contacts
338
+ *
339
+ * @see {@link GET_Contacts_V1_Request_Parameters_Query} - Query parameters type
340
+ * @see {@link GET_Contacts_V1_Request_Parameters_Path} - Path parameters type
341
+ * @see {@link GET_Contacts_V1_Request_RequestBody} - Request body type
342
+ */
343
+ export type GET_Contacts_V1_Request = {
344
+ parameters: {
345
+ query: operations['get_contacts_v1_contacts_get']['parameters']['query'];
346
+ };
347
+ }
348
+ /**
349
+ * Query parameters for GET /v1/contacts
350
+ *
351
+ * @remarks
352
+ * This type defines the query parameters for the GET /v1/contacts endpoint.
353
+ * It provides type safety for all query parameters as defined in the OpenAPI specification.
354
+ *
355
+ * @example
356
+ * Use this type to ensure type safety for query parameters.
357
+ *
358
+ * @path /v1/contacts
359
+ */
360
+ export type GET_Contacts_V1_Request_Parameters_Query = GET_Contacts_V1_Request['parameters']['query'];
361
+
362
+ /**
363
+ * Request type for POST Contacts endpoint
364
+ *
365
+ * Create Contact
366
+ * Create a contact
367
+ *
368
+ * @remarks
369
+ * This type defines the complete request structure for the POST Contacts endpoint.
370
+ * It includes all parameters (query, path) and request body types as defined in the OpenAPI specification.
371
+ * Use this type to ensure type safety when making API requests to this endpoint.
372
+ *
373
+ * @example
374
+ * Use this type to ensure type safety when making API requests to this endpoint.
375
+ *
376
+ * @path /v1/contacts
377
+ *
378
+ * @see {@link POST_Contacts_V1_Request_Parameters_Query} - Query parameters type
379
+ * @see {@link POST_Contacts_V1_Request_Parameters_Path} - Path parameters type
380
+ * @see {@link POST_Contacts_V1_Request_RequestBody} - Request body type
381
+ */
382
+ export type POST_Contacts_V1_Request = {
383
+ requestBody: ContactCreate;
384
+ }
385
+ /**
386
+ * Request body for POST /v1/contacts
387
+ *
388
+ * @remarks
389
+ * This type defines the request body structure for the POST /v1/contacts endpoint.
390
+ * It provides type safety for the request body as defined in the OpenAPI specification.
391
+ *
392
+ * @example
393
+ * Use this type to ensure type safety for request body structure.
394
+ *
395
+ * @path /v1/contacts
396
+ */
397
+ export type POST_Contacts_V1_Request_RequestBody = POST_Contacts_V1_Request['requestBody'];
398
+
399
+ /**
400
+ * Request type for DELETE ContactsContactId endpoint
401
+ *
402
+ * Delete Contact
403
+ * Delete a contact
404
+ *
405
+ * @remarks
406
+ * This type defines the complete request structure for the DELETE ContactsContactId endpoint.
407
+ * It includes all parameters (query, path) and request body types as defined in the OpenAPI specification.
408
+ * Use this type to ensure type safety when making API requests to this endpoint.
409
+ *
410
+ * @example
411
+ * Use this type to ensure type safety when making API requests to this endpoint.
412
+ *
413
+ * @path /v1/contacts/{contact_id}
414
+ *
415
+ * @see {@link DELETE_ContactsContactId_V1_Request_Parameters_Query} - Query parameters type
416
+ * @see {@link DELETE_ContactsContactId_V1_Request_Parameters_Path} - Path parameters type
417
+ * @see {@link DELETE_ContactsContactId_V1_Request_RequestBody} - Request body type
418
+ */
419
+ export type DELETE_ContactsContactId_V1_Request = {
420
+ parameters: {
421
+ path: operations['delete_contact_v1_contacts__contact_id__delete']['parameters']['path'];
422
+ };
423
+ }
424
+ /**
425
+ * Path parameters for DELETE /v1/contacts/{contact_id}
426
+ *
427
+ * @remarks
428
+ * This type defines the path parameters for the DELETE /v1/contacts/{contact_id} endpoint.
429
+ * It provides type safety for all path parameters as defined in the OpenAPI specification.
430
+ *
431
+ * @example
432
+ * Use this type to ensure type safety for path parameters.
433
+ *
434
+ * @path /v1/contacts/{contact_id}
435
+ */
436
+ export type DELETE_ContactsContactId_V1_Request_Parameters_Path = DELETE_ContactsContactId_V1_Request['parameters']['path'];
437
+
438
+ /**
439
+ * Request type for GET ContactsContactId endpoint
440
+ *
441
+ * Get Contact
442
+ * Retrieve a contact
443
+ *
444
+ * @remarks
445
+ * This type defines the complete request structure for the GET ContactsContactId endpoint.
446
+ * It includes all parameters (query, path) and request body types as defined in the OpenAPI specification.
447
+ * Use this type to ensure type safety when making API requests to this endpoint.
448
+ *
449
+ * @example
450
+ * Use this type to ensure type safety when making API requests to this endpoint.
451
+ *
452
+ * @path /v1/contacts/{contact_id}
453
+ *
454
+ * @see {@link GET_ContactsContactId_V1_Request_Parameters_Query} - Query parameters type
455
+ * @see {@link GET_ContactsContactId_V1_Request_Parameters_Path} - Path parameters type
456
+ * @see {@link GET_ContactsContactId_V1_Request_RequestBody} - Request body type
457
+ */
458
+ export type GET_ContactsContactId_V1_Request = {
459
+ parameters: {
460
+ path: operations['get_contact_v1_contacts__contact_id__get']['parameters']['path'];
461
+ };
462
+ }
463
+ /**
464
+ * Path parameters for GET /v1/contacts/{contact_id}
465
+ *
466
+ * @remarks
467
+ * This type defines the path parameters for the GET /v1/contacts/{contact_id} endpoint.
468
+ * It provides type safety for all path parameters as defined in the OpenAPI specification.
469
+ *
470
+ * @example
471
+ * Use this type to ensure type safety for path parameters.
472
+ *
473
+ * @path /v1/contacts/{contact_id}
474
+ */
475
+ export type GET_ContactsContactId_V1_Request_Parameters_Path = GET_ContactsContactId_V1_Request['parameters']['path'];
476
+
477
+ /**
478
+ * Request type for DELETE ContactsContactIdVerification endpoint
479
+ *
480
+ * Cancel Verification
481
+ * Delete contact verification
482
+ *
483
+ * @remarks
484
+ * This type defines the complete request structure for the DELETE ContactsContactIdVerification endpoint.
485
+ * It includes all parameters (query, path) and request body types as defined in the OpenAPI specification.
486
+ * Use this type to ensure type safety when making API requests to this endpoint.
487
+ *
488
+ * @example
489
+ * Use this type to ensure type safety when making API requests to this endpoint.
490
+ *
491
+ * @path /v1/contacts/{contact_id}/verification
492
+ *
493
+ * @see {@link DELETE_ContactsContactIdVerification_V1_Request_Parameters_Query} - Query parameters type
494
+ * @see {@link DELETE_ContactsContactIdVerification_V1_Request_Parameters_Path} - Path parameters type
495
+ * @see {@link DELETE_ContactsContactIdVerification_V1_Request_RequestBody} - Request body type
496
+ */
497
+ export type DELETE_ContactsContactIdVerification_V1_Request = {
498
+ parameters: {
499
+ path: operations['cancel_verification_v1_contacts__contact_id__verification_delete']['parameters']['path'];
500
+ };
501
+ }
502
+ /**
503
+ * Path parameters for DELETE /v1/contacts/{contact_id}/verification
504
+ *
505
+ * @remarks
506
+ * This type defines the path parameters for the DELETE /v1/contacts/{contact_id}/verification endpoint.
507
+ * It provides type safety for all path parameters as defined in the OpenAPI specification.
508
+ *
509
+ * @example
510
+ * Use this type to ensure type safety for path parameters.
511
+ *
512
+ * @path /v1/contacts/{contact_id}/verification
513
+ */
514
+ export type DELETE_ContactsContactIdVerification_V1_Request_Parameters_Path = DELETE_ContactsContactIdVerification_V1_Request['parameters']['path'];
515
+
516
+ /**
517
+ * Request type for GET ContactsContactIdVerification endpoint
518
+ *
519
+ * Get Verification Status
520
+ * Retrieve contact verification
521
+ *
522
+ * @remarks
523
+ * This type defines the complete request structure for the GET ContactsContactIdVerification endpoint.
524
+ * It includes all parameters (query, path) and request body types as defined in the OpenAPI specification.
525
+ * Use this type to ensure type safety when making API requests to this endpoint.
526
+ *
527
+ * @example
528
+ * Use this type to ensure type safety when making API requests to this endpoint.
529
+ *
530
+ * @path /v1/contacts/{contact_id}/verification
531
+ *
532
+ * @see {@link GET_ContactsContactIdVerification_V1_Request_Parameters_Query} - Query parameters type
533
+ * @see {@link GET_ContactsContactIdVerification_V1_Request_Parameters_Path} - Path parameters type
534
+ * @see {@link GET_ContactsContactIdVerification_V1_Request_RequestBody} - Request body type
535
+ */
536
+ export type GET_ContactsContactIdVerification_V1_Request = {
537
+ parameters: {
538
+ path: operations['get_verification_status_v1_contacts__contact_id__verification_get']['parameters']['path'];
539
+ };
540
+ }
541
+ /**
542
+ * Path parameters for GET /v1/contacts/{contact_id}/verification
543
+ *
544
+ * @remarks
545
+ * This type defines the path parameters for the GET /v1/contacts/{contact_id}/verification endpoint.
546
+ * It provides type safety for all path parameters as defined in the OpenAPI specification.
547
+ *
548
+ * @example
549
+ * Use this type to ensure type safety for path parameters.
550
+ *
551
+ * @path /v1/contacts/{contact_id}/verification
552
+ */
553
+ export type GET_ContactsContactIdVerification_V1_Request_Parameters_Path = GET_ContactsContactIdVerification_V1_Request['parameters']['path'];
554
+
555
+ /**
556
+ * Request type for POST ContactsContactIdVerification endpoint
557
+ *
558
+ * Start Contact Verification
559
+ * Start contact verification
560
+ *
561
+ * @remarks
562
+ * This type defines the complete request structure for the POST ContactsContactIdVerification endpoint.
563
+ * It includes all parameters (query, path) and request body types as defined in the OpenAPI specification.
564
+ * Use this type to ensure type safety when making API requests to this endpoint.
565
+ *
566
+ * @example
567
+ * Use this type to ensure type safety when making API requests to this endpoint.
568
+ *
569
+ * @path /v1/contacts/{contact_id}/verification
570
+ *
571
+ * @see {@link POST_ContactsContactIdVerification_V1_Request_Parameters_Query} - Query parameters type
572
+ * @see {@link POST_ContactsContactIdVerification_V1_Request_Parameters_Path} - Path parameters type
573
+ * @see {@link POST_ContactsContactIdVerification_V1_Request_RequestBody} - Request body type
574
+ */
575
+ export type POST_ContactsContactIdVerification_V1_Request = {
576
+ parameters: {
577
+ query: operations['start_contact_verification_v1_contacts__contact_id__verification_post']['parameters']['query'];
578
+ path: operations['start_contact_verification_v1_contacts__contact_id__verification_post']['parameters']['path'];
579
+ };
580
+ }
581
+ /**
582
+ * Query parameters for POST /v1/contacts/{contact_id}/verification
583
+ *
584
+ * @remarks
585
+ * This type defines the query parameters for the POST /v1/contacts/{contact_id}/verification endpoint.
586
+ * It provides type safety for all query parameters as defined in the OpenAPI specification.
587
+ *
588
+ * @example
589
+ * Use this type to ensure type safety for query parameters.
590
+ *
591
+ * @path /v1/contacts/{contact_id}/verification
592
+ */
593
+ export type POST_ContactsContactIdVerification_V1_Request_Parameters_Query = POST_ContactsContactIdVerification_V1_Request['parameters']['query'];
594
+ /**
595
+ * Path parameters for POST /v1/contacts/{contact_id}/verification
596
+ *
597
+ * @remarks
598
+ * This type defines the path parameters for the POST /v1/contacts/{contact_id}/verification endpoint.
599
+ * It provides type safety for all path parameters as defined in the OpenAPI specification.
600
+ *
601
+ * @example
602
+ * Use this type to ensure type safety for path parameters.
603
+ *
604
+ * @path /v1/contacts/{contact_id}/verification
605
+ */
606
+ export type POST_ContactsContactIdVerification_V1_Request_Parameters_Path = POST_ContactsContactIdVerification_V1_Request['parameters']['path'];
607
+
608
+ /**
609
+ * Request type for PUT ContactsContactIdVerification endpoint
610
+ *
611
+ * Update Verification
612
+ * Complete contact verification
613
+ *
614
+ * @remarks
615
+ * This type defines the complete request structure for the PUT ContactsContactIdVerification endpoint.
616
+ * It includes all parameters (query, path) and request body types as defined in the OpenAPI specification.
617
+ * Use this type to ensure type safety when making API requests to this endpoint.
618
+ *
619
+ * @example
620
+ * Use this type to ensure type safety when making API requests to this endpoint.
621
+ *
622
+ * @path /v1/contacts/{contact_id}/verification
623
+ *
624
+ * @see {@link PUT_ContactsContactIdVerification_V1_Request_Parameters_Query} - Query parameters type
625
+ * @see {@link PUT_ContactsContactIdVerification_V1_Request_Parameters_Path} - Path parameters type
626
+ * @see {@link PUT_ContactsContactIdVerification_V1_Request_RequestBody} - Request body type
627
+ */
628
+ export type PUT_ContactsContactIdVerification_V1_Request = {
629
+ parameters: {
630
+ query: operations['update_verification_v1_contacts__contact_id__verification_put']['parameters']['query'];
631
+ path: operations['update_verification_v1_contacts__contact_id__verification_put']['parameters']['path'];
632
+ };
633
+ }
634
+ /**
635
+ * Query parameters for PUT /v1/contacts/{contact_id}/verification
636
+ *
637
+ * @remarks
638
+ * This type defines the query parameters for the PUT /v1/contacts/{contact_id}/verification endpoint.
639
+ * It provides type safety for all query parameters as defined in the OpenAPI specification.
640
+ *
641
+ * @example
642
+ * Use this type to ensure type safety for query parameters.
643
+ *
644
+ * @path /v1/contacts/{contact_id}/verification
645
+ */
646
+ export type PUT_ContactsContactIdVerification_V1_Request_Parameters_Query = PUT_ContactsContactIdVerification_V1_Request['parameters']['query'];
647
+ /**
648
+ * Path parameters for PUT /v1/contacts/{contact_id}/verification
649
+ *
650
+ * @remarks
651
+ * This type defines the path parameters for the PUT /v1/contacts/{contact_id}/verification endpoint.
652
+ * It provides type safety for all path parameters as defined in the OpenAPI specification.
653
+ *
654
+ * @example
655
+ * Use this type to ensure type safety for path parameters.
656
+ *
657
+ * @path /v1/contacts/{contact_id}/verification
658
+ */
659
+ export type PUT_ContactsContactIdVerification_V1_Request_Parameters_Path = PUT_ContactsContactIdVerification_V1_Request['parameters']['path'];
660
+
661
+ /**
662
+ * Request type for GET ContactsVerification endpoint
663
+ *
664
+ * Get Verification By Token
665
+ * Retrieve contact verification
666
+ *
667
+ * @remarks
668
+ * This type defines the complete request structure for the GET ContactsVerification endpoint.
669
+ * It includes all parameters (query, path) and request body types as defined in the OpenAPI specification.
670
+ * Use this type to ensure type safety when making API requests to this endpoint.
671
+ *
672
+ * @example
673
+ * Use this type to ensure type safety when making API requests to this endpoint.
674
+ *
675
+ * @path /v1/contacts/verification
676
+ *
677
+ * @see {@link GET_ContactsVerification_V1_Request_Parameters_Query} - Query parameters type
678
+ * @see {@link GET_ContactsVerification_V1_Request_Parameters_Path} - Path parameters type
679
+ * @see {@link GET_ContactsVerification_V1_Request_RequestBody} - Request body type
680
+ */
681
+ export type GET_ContactsVerification_V1_Request = {
682
+ parameters: {
683
+ query: operations['get_verification_by_token_v1_contacts_verification_get']['parameters']['query'];
684
+ };
685
+ }
686
+ /**
687
+ * Query parameters for GET /v1/contacts/verification
688
+ *
689
+ * @remarks
690
+ * This type defines the query parameters for the GET /v1/contacts/verification endpoint.
691
+ * It provides type safety for all query parameters as defined in the OpenAPI specification.
692
+ *
693
+ * @example
694
+ * Use this type to ensure type safety for query parameters.
695
+ *
696
+ * @path /v1/contacts/verification
697
+ */
698
+ export type GET_ContactsVerification_V1_Request_Parameters_Query = GET_ContactsVerification_V1_Request['parameters']['query'];
699
+
700
+ /**
701
+ * Request type for PUT ContactsVerification endpoint
702
+ *
703
+ * Update Verification By Token
704
+ * Complete contact verification
705
+ *
706
+ * @remarks
707
+ * This type defines the complete request structure for the PUT ContactsVerification endpoint.
708
+ * It includes all parameters (query, path) and request body types as defined in the OpenAPI specification.
709
+ * Use this type to ensure type safety when making API requests to this endpoint.
710
+ *
711
+ * @example
712
+ * Use this type to ensure type safety when making API requests to this endpoint.
713
+ *
714
+ * @path /v1/contacts/verification
715
+ *
716
+ * @see {@link PUT_ContactsVerification_V1_Request_Parameters_Query} - Query parameters type
717
+ * @see {@link PUT_ContactsVerification_V1_Request_Parameters_Path} - Path parameters type
718
+ * @see {@link PUT_ContactsVerification_V1_Request_RequestBody} - Request body type
719
+ */
720
+ export type PUT_ContactsVerification_V1_Request = {
721
+ parameters: {
722
+ query: operations['update_verification_by_token_v1_contacts_verification_put']['parameters']['query'];
723
+ };
724
+ }
725
+ /**
726
+ * Query parameters for PUT /v1/contacts/verification
727
+ *
728
+ * @remarks
729
+ * This type defines the query parameters for the PUT /v1/contacts/verification endpoint.
730
+ * It provides type safety for all query parameters as defined in the OpenAPI specification.
731
+ *
732
+ * @example
733
+ * Use this type to ensure type safety for query parameters.
734
+ *
735
+ * @path /v1/contacts/verification
736
+ */
737
+ export type PUT_ContactsVerification_V1_Request_Parameters_Query = PUT_ContactsVerification_V1_Request['parameters']['query'];
738
+
739
+ /**
740
+ * Request type for GET ContactsVerify endpoint
741
+ *
742
+ * Email Verify Contact
743
+ *
744
+ * @remarks
745
+ * This type defines the complete request structure for the GET ContactsVerify endpoint.
746
+ * It includes all parameters (query, path) and request body types as defined in the OpenAPI specification.
747
+ * Use this type to ensure type safety when making API requests to this endpoint.
748
+ *
749
+ * @example
750
+ * Use this type to ensure type safety when making API requests to this endpoint.
751
+ *
752
+ * @path /v1/contacts/verify
753
+ *
754
+ * @see {@link GET_ContactsVerify_V1_Request_Parameters_Query} - Query parameters type
755
+ * @see {@link GET_ContactsVerify_V1_Request_Parameters_Path} - Path parameters type
756
+ * @see {@link GET_ContactsVerify_V1_Request_RequestBody} - Request body type
757
+ */
758
+ export type GET_ContactsVerify_V1_Request = {
759
+ parameters: {
760
+ query: operations['email_verify_contact_v1_contacts_verify_get']['parameters']['query'];
761
+ };
762
+ }
763
+ /**
764
+ * Query parameters for GET /v1/contacts/verify
765
+ *
766
+ * @remarks
767
+ * This type defines the query parameters for the GET /v1/contacts/verify endpoint.
768
+ * It provides type safety for all query parameters as defined in the OpenAPI specification.
769
+ *
770
+ * @example
771
+ * Use this type to ensure type safety for query parameters.
772
+ *
773
+ * @path /v1/contacts/verify
774
+ */
775
+ export type GET_ContactsVerify_V1_Request_Parameters_Query = GET_ContactsVerify_V1_Request['parameters']['query'];
776
+
777
+ /**
778
+ * Request type for GET Dns endpoint
779
+ *
780
+ * List Zones
781
+ *
782
+ * @remarks
783
+ * This type defines the complete request structure for the GET Dns endpoint.
784
+ * It includes all parameters (query, path) and request body types as defined in the OpenAPI specification.
785
+ * Use this type to ensure type safety when making API requests to this endpoint.
786
+ *
787
+ * @example
788
+ * Use this type to ensure type safety when making API requests to this endpoint.
789
+ *
790
+ * @path /v1/dns
791
+ *
792
+ * @see {@link GET_Dns_V1_Request_Parameters_Query} - Query parameters type
793
+ * @see {@link GET_Dns_V1_Request_Parameters_Path} - Path parameters type
794
+ * @see {@link GET_Dns_V1_Request_RequestBody} - Request body type
795
+ */
796
+ export type GET_Dns_V1_Request = {
797
+ parameters: {
798
+ query: operations['list_zones_v1_dns_get']['parameters']['query'];
799
+ };
800
+ }
801
+ /**
802
+ * Query parameters for GET /v1/dns
803
+ *
804
+ * @remarks
805
+ * This type defines the query parameters for the GET /v1/dns endpoint.
806
+ * It provides type safety for all query parameters as defined in the OpenAPI specification.
807
+ *
808
+ * @example
809
+ * Use this type to ensure type safety for query parameters.
810
+ *
811
+ * @path /v1/dns
812
+ */
813
+ export type GET_Dns_V1_Request_Parameters_Query = GET_Dns_V1_Request['parameters']['query'];
814
+
815
+ /**
816
+ * Request type for POST Dns endpoint
817
+ *
818
+ * Create Zone
819
+ *
820
+ * @remarks
821
+ * This type defines the complete request structure for the POST Dns endpoint.
822
+ * It includes all parameters (query, path) and request body types as defined in the OpenAPI specification.
823
+ * Use this type to ensure type safety when making API requests to this endpoint.
824
+ *
825
+ * @example
826
+ * Use this type to ensure type safety when making API requests to this endpoint.
827
+ *
828
+ * @path /v1/dns
829
+ *
830
+ * @see {@link POST_Dns_V1_Request_Parameters_Query} - Query parameters type
831
+ * @see {@link POST_Dns_V1_Request_Parameters_Path} - Path parameters type
832
+ * @see {@link POST_Dns_V1_Request_RequestBody} - Request body type
833
+ */
834
+ export type POST_Dns_V1_Request = {
835
+ requestBody: DnsZoneCreate;
836
+ }
837
+ /**
838
+ * Request body for POST /v1/dns
839
+ *
840
+ * @remarks
841
+ * This type defines the request body structure for the POST /v1/dns endpoint.
842
+ * It provides type safety for the request body as defined in the OpenAPI specification.
843
+ *
844
+ * @example
845
+ * Use this type to ensure type safety for request body structure.
846
+ *
847
+ * @path /v1/dns
848
+ */
849
+ export type POST_Dns_V1_Request_RequestBody = POST_Dns_V1_Request['requestBody'];
850
+
851
+ /**
852
+ * Request type for DELETE DnsZoneName endpoint
853
+ *
854
+ * Delete Zone
855
+ *
856
+ * @remarks
857
+ * This type defines the complete request structure for the DELETE DnsZoneName endpoint.
858
+ * It includes all parameters (query, path) and request body types as defined in the OpenAPI specification.
859
+ * Use this type to ensure type safety when making API requests to this endpoint.
860
+ *
861
+ * @example
862
+ * Use this type to ensure type safety when making API requests to this endpoint.
863
+ *
864
+ * @path /v1/dns/{zone_name}
865
+ * @param zone_name (path) - DNS zone name (trailing dot optional)
866
+ *
867
+ * @see {@link DELETE_DnsZoneName_V1_Request_Parameters_Query} - Query parameters type
868
+ * @see {@link DELETE_DnsZoneName_V1_Request_Parameters_Path} - Path parameters type
869
+ * @see {@link DELETE_DnsZoneName_V1_Request_RequestBody} - Request body type
870
+ */
871
+ export type DELETE_DnsZoneName_V1_Request = {
872
+ parameters: {
873
+ path: operations['delete_zone_v1_dns__zone_name__delete']['parameters']['path'];
874
+ };
875
+ }
876
+ /**
877
+ * Path parameters for DELETE /v1/dns/{zone_name}
878
+ *
879
+ * @remarks
880
+ * This type defines the path parameters for the DELETE /v1/dns/{zone_name} endpoint.
881
+ * It provides type safety for all path parameters as defined in the OpenAPI specification.
882
+ *
883
+ * @example
884
+ * Use this type to ensure type safety for path parameters.
885
+ *
886
+ * @path /v1/dns/{zone_name}
887
+ * @param zone_name (path) - DNS zone name (trailing dot optional)
888
+ */
889
+ export type DELETE_DnsZoneName_V1_Request_Parameters_Path = DELETE_DnsZoneName_V1_Request['parameters']['path'];
890
+
891
+ /**
892
+ * Request type for GET DnsZoneName endpoint
893
+ *
894
+ * Get Zone
895
+ *
896
+ * @remarks
897
+ * This type defines the complete request structure for the GET DnsZoneName endpoint.
898
+ * It includes all parameters (query, path) and request body types as defined in the OpenAPI specification.
899
+ * Use this type to ensure type safety when making API requests to this endpoint.
900
+ *
901
+ * @example
902
+ * Use this type to ensure type safety when making API requests to this endpoint.
903
+ *
904
+ * @path /v1/dns/{zone_name}
905
+ * @param zone_name (path) - DNS zone name (trailing dot optional)
906
+ *
907
+ * @see {@link GET_DnsZoneName_V1_Request_Parameters_Query} - Query parameters type
908
+ * @see {@link GET_DnsZoneName_V1_Request_Parameters_Path} - Path parameters type
909
+ * @see {@link GET_DnsZoneName_V1_Request_RequestBody} - Request body type
910
+ */
911
+ export type GET_DnsZoneName_V1_Request = {
912
+ parameters: {
913
+ path: operations['get_zone_v1_dns__zone_name__get']['parameters']['path'];
914
+ };
915
+ }
916
+ /**
917
+ * Path parameters for GET /v1/dns/{zone_name}
918
+ *
919
+ * @remarks
920
+ * This type defines the path parameters for the GET /v1/dns/{zone_name} endpoint.
921
+ * It provides type safety for all path parameters as defined in the OpenAPI specification.
922
+ *
923
+ * @example
924
+ * Use this type to ensure type safety for path parameters.
925
+ *
926
+ * @path /v1/dns/{zone_name}
927
+ * @param zone_name (path) - DNS zone name (trailing dot optional)
928
+ */
929
+ export type GET_DnsZoneName_V1_Request_Parameters_Path = GET_DnsZoneName_V1_Request['parameters']['path'];
930
+
931
+ /**
932
+ * Request type for POST DnsZoneNameDnssecDisable endpoint
933
+ *
934
+ * Disable Dnssec
935
+ *
936
+ * @remarks
937
+ * This type defines the complete request structure for the POST DnsZoneNameDnssecDisable endpoint.
938
+ * It includes all parameters (query, path) and request body types as defined in the OpenAPI specification.
939
+ * Use this type to ensure type safety when making API requests to this endpoint.
940
+ *
941
+ * @example
942
+ * Use this type to ensure type safety when making API requests to this endpoint.
943
+ *
944
+ * @path /v1/dns/{zone_name}/dnssec/disable
945
+ * @param zone_name (path) - DNS zone name (trailing dot optional)
946
+ *
947
+ * @see {@link POST_DnsZoneNameDnssecDisable_V1_Request_Parameters_Query} - Query parameters type
948
+ * @see {@link POST_DnsZoneNameDnssecDisable_V1_Request_Parameters_Path} - Path parameters type
949
+ * @see {@link POST_DnsZoneNameDnssecDisable_V1_Request_RequestBody} - Request body type
950
+ */
951
+ export type POST_DnsZoneNameDnssecDisable_V1_Request = {
952
+ parameters: {
953
+ path: operations['disable_dnssec_v1_dns__zone_name__dnssec_disable_post']['parameters']['path'];
954
+ };
955
+ }
956
+ /**
957
+ * Path parameters for POST /v1/dns/{zone_name}/dnssec/disable
958
+ *
959
+ * @remarks
960
+ * This type defines the path parameters for the POST /v1/dns/{zone_name}/dnssec/disable endpoint.
961
+ * It provides type safety for all path parameters as defined in the OpenAPI specification.
962
+ *
963
+ * @example
964
+ * Use this type to ensure type safety for path parameters.
965
+ *
966
+ * @path /v1/dns/{zone_name}/dnssec/disable
967
+ * @param zone_name (path) - DNS zone name (trailing dot optional)
968
+ */
969
+ export type POST_DnsZoneNameDnssecDisable_V1_Request_Parameters_Path = POST_DnsZoneNameDnssecDisable_V1_Request['parameters']['path'];
970
+
971
+ /**
972
+ * Request type for POST DnsZoneNameDnssecEnable endpoint
973
+ *
974
+ * Enable Dnssec
975
+ *
976
+ * @remarks
977
+ * This type defines the complete request structure for the POST DnsZoneNameDnssecEnable endpoint.
978
+ * It includes all parameters (query, path) and request body types as defined in the OpenAPI specification.
979
+ * Use this type to ensure type safety when making API requests to this endpoint.
980
+ *
981
+ * @example
982
+ * Use this type to ensure type safety when making API requests to this endpoint.
983
+ *
984
+ * @path /v1/dns/{zone_name}/dnssec/enable
985
+ * @param zone_name (path) - DNS zone name (trailing dot optional)
986
+ *
987
+ * @see {@link POST_DnsZoneNameDnssecEnable_V1_Request_Parameters_Query} - Query parameters type
988
+ * @see {@link POST_DnsZoneNameDnssecEnable_V1_Request_Parameters_Path} - Path parameters type
989
+ * @see {@link POST_DnsZoneNameDnssecEnable_V1_Request_RequestBody} - Request body type
990
+ */
991
+ export type POST_DnsZoneNameDnssecEnable_V1_Request = {
992
+ parameters: {
993
+ path: operations['enable_dnssec_v1_dns__zone_name__dnssec_enable_post']['parameters']['path'];
994
+ };
995
+ }
996
+ /**
997
+ * Path parameters for POST /v1/dns/{zone_name}/dnssec/enable
998
+ *
999
+ * @remarks
1000
+ * This type defines the path parameters for the POST /v1/dns/{zone_name}/dnssec/enable endpoint.
1001
+ * It provides type safety for all path parameters as defined in the OpenAPI specification.
1002
+ *
1003
+ * @example
1004
+ * Use this type to ensure type safety for path parameters.
1005
+ *
1006
+ * @path /v1/dns/{zone_name}/dnssec/enable
1007
+ * @param zone_name (path) - DNS zone name (trailing dot optional)
1008
+ */
1009
+ export type POST_DnsZoneNameDnssecEnable_V1_Request_Parameters_Path = POST_DnsZoneNameDnssecEnable_V1_Request['parameters']['path'];
1010
+
1011
+ /**
1012
+ * Request type for PATCH DnsZoneNameRecords endpoint
1013
+ *
1014
+ * Patch Zone Records
1015
+ *
1016
+ * @remarks
1017
+ * This type defines the complete request structure for the PATCH DnsZoneNameRecords endpoint.
1018
+ * It includes all parameters (query, path) and request body types as defined in the OpenAPI specification.
1019
+ * Use this type to ensure type safety when making API requests to this endpoint.
1020
+ *
1021
+ * @example
1022
+ * Use this type to ensure type safety when making API requests to this endpoint.
1023
+ *
1024
+ * @path /v1/dns/{zone_name}/records
1025
+ * @param zone_name (path) - DNS zone name (trailing dot optional)
1026
+ *
1027
+ * @see {@link PATCH_DnsZoneNameRecords_V1_Request_Parameters_Query} - Query parameters type
1028
+ * @see {@link PATCH_DnsZoneNameRecords_V1_Request_Parameters_Path} - Path parameters type
1029
+ * @see {@link PATCH_DnsZoneNameRecords_V1_Request_RequestBody} - Request body type
1030
+ */
1031
+ export type PATCH_DnsZoneNameRecords_V1_Request = {
1032
+ parameters: {
1033
+ path: operations['patch_zone_records_v1_dns__zone_name__records_patch']['parameters']['path'];
1034
+ };
1035
+ requestBody: DnsZoneRecordsPatchOps;
1036
+ }
1037
+ /**
1038
+ * Path parameters for PATCH /v1/dns/{zone_name}/records
1039
+ *
1040
+ * @remarks
1041
+ * This type defines the path parameters for the PATCH /v1/dns/{zone_name}/records endpoint.
1042
+ * It provides type safety for all path parameters as defined in the OpenAPI specification.
1043
+ *
1044
+ * @example
1045
+ * Use this type to ensure type safety for path parameters.
1046
+ *
1047
+ * @path /v1/dns/{zone_name}/records
1048
+ * @param zone_name (path) - DNS zone name (trailing dot optional)
1049
+ */
1050
+ export type PATCH_DnsZoneNameRecords_V1_Request_Parameters_Path = PATCH_DnsZoneNameRecords_V1_Request['parameters']['path'];
1051
+ /**
1052
+ * Request body for PATCH /v1/dns/{zone_name}/records
1053
+ *
1054
+ * @remarks
1055
+ * This type defines the request body structure for the PATCH /v1/dns/{zone_name}/records endpoint.
1056
+ * It provides type safety for the request body as defined in the OpenAPI specification.
1057
+ *
1058
+ * @example
1059
+ * Use this type to ensure type safety for request body structure.
1060
+ *
1061
+ * @path /v1/dns/{zone_name}/records
1062
+ */
1063
+ export type PATCH_DnsZoneNameRecords_V1_Request_RequestBody = PATCH_DnsZoneNameRecords_V1_Request['requestBody'];
1064
+
1065
+ /**
1066
+ * Request type for PATCH DnsZoneNameRrsets endpoint
1067
+ *
1068
+ * Patch Zone Rrsets
1069
+ *
1070
+ * @remarks
1071
+ * This type defines the complete request structure for the PATCH DnsZoneNameRrsets endpoint.
1072
+ * It includes all parameters (query, path) and request body types as defined in the OpenAPI specification.
1073
+ * Use this type to ensure type safety when making API requests to this endpoint.
1074
+ *
1075
+ * @example
1076
+ * Use this type to ensure type safety when making API requests to this endpoint.
1077
+ *
1078
+ * @path /v1/dns/{zone_name}/rrsets
1079
+ * @param zone_name (path) - DNS zone name (trailing dot optional)
1080
+ *
1081
+ * @see {@link PATCH_DnsZoneNameRrsets_V1_Request_Parameters_Query} - Query parameters type
1082
+ * @see {@link PATCH_DnsZoneNameRrsets_V1_Request_Parameters_Path} - Path parameters type
1083
+ * @see {@link PATCH_DnsZoneNameRrsets_V1_Request_RequestBody} - Request body type
1084
+ */
1085
+ export type PATCH_DnsZoneNameRrsets_V1_Request = {
1086
+ parameters: {
1087
+ path: operations['patch_zone_rrsets_v1_dns__zone_name__rrsets_patch']['parameters']['path'];
1088
+ };
1089
+ requestBody: DnsZoneRrsetsPatchOps;
1090
+ }
1091
+ /**
1092
+ * Path parameters for PATCH /v1/dns/{zone_name}/rrsets
1093
+ *
1094
+ * @remarks
1095
+ * This type defines the path parameters for the PATCH /v1/dns/{zone_name}/rrsets endpoint.
1096
+ * It provides type safety for all path parameters as defined in the OpenAPI specification.
1097
+ *
1098
+ * @example
1099
+ * Use this type to ensure type safety for path parameters.
1100
+ *
1101
+ * @path /v1/dns/{zone_name}/rrsets
1102
+ * @param zone_name (path) - DNS zone name (trailing dot optional)
1103
+ */
1104
+ export type PATCH_DnsZoneNameRrsets_V1_Request_Parameters_Path = PATCH_DnsZoneNameRrsets_V1_Request['parameters']['path'];
1105
+ /**
1106
+ * Request body for PATCH /v1/dns/{zone_name}/rrsets
1107
+ *
1108
+ * @remarks
1109
+ * This type defines the request body structure for the PATCH /v1/dns/{zone_name}/rrsets endpoint.
1110
+ * It provides type safety for the request body as defined in the OpenAPI specification.
1111
+ *
1112
+ * @example
1113
+ * Use this type to ensure type safety for request body structure.
1114
+ *
1115
+ * @path /v1/dns/{zone_name}/rrsets
1116
+ */
1117
+ export type PATCH_DnsZoneNameRrsets_V1_Request_RequestBody = PATCH_DnsZoneNameRrsets_V1_Request['requestBody'];
1118
+
1119
+ /**
1120
+ * Request type for PUT DnsZoneNameRrsets endpoint
1121
+ *
1122
+ * Update Zone Rrsets
1123
+ *
1124
+ * @remarks
1125
+ * This type defines the complete request structure for the PUT DnsZoneNameRrsets endpoint.
1126
+ * It includes all parameters (query, path) and request body types as defined in the OpenAPI specification.
1127
+ * Use this type to ensure type safety when making API requests to this endpoint.
1128
+ *
1129
+ * @example
1130
+ * Use this type to ensure type safety when making API requests to this endpoint.
1131
+ *
1132
+ * @path /v1/dns/{zone_name}/rrsets
1133
+ * @param zone_name (path) - DNS zone name (trailing dot optional)
1134
+ *
1135
+ * @see {@link PUT_DnsZoneNameRrsets_V1_Request_Parameters_Query} - Query parameters type
1136
+ * @see {@link PUT_DnsZoneNameRrsets_V1_Request_Parameters_Path} - Path parameters type
1137
+ * @see {@link PUT_DnsZoneNameRrsets_V1_Request_RequestBody} - Request body type
1138
+ */
1139
+ export type PUT_DnsZoneNameRrsets_V1_Request = {
1140
+ parameters: {
1141
+ path: operations['update_zone_rrsets_v1_dns__zone_name__rrsets_put']['parameters']['path'];
1142
+ };
1143
+ requestBody: DnsZoneRrsetsCreate;
1144
+ }
1145
+ /**
1146
+ * Path parameters for PUT /v1/dns/{zone_name}/rrsets
1147
+ *
1148
+ * @remarks
1149
+ * This type defines the path parameters for the PUT /v1/dns/{zone_name}/rrsets endpoint.
1150
+ * It provides type safety for all path parameters as defined in the OpenAPI specification.
1151
+ *
1152
+ * @example
1153
+ * Use this type to ensure type safety for path parameters.
1154
+ *
1155
+ * @path /v1/dns/{zone_name}/rrsets
1156
+ * @param zone_name (path) - DNS zone name (trailing dot optional)
1157
+ */
1158
+ export type PUT_DnsZoneNameRrsets_V1_Request_Parameters_Path = PUT_DnsZoneNameRrsets_V1_Request['parameters']['path'];
1159
+ /**
1160
+ * Request body for PUT /v1/dns/{zone_name}/rrsets
1161
+ *
1162
+ * @remarks
1163
+ * This type defines the request body structure for the PUT /v1/dns/{zone_name}/rrsets endpoint.
1164
+ * It provides type safety for the request body as defined in the OpenAPI specification.
1165
+ *
1166
+ * @example
1167
+ * Use this type to ensure type safety for request body structure.
1168
+ *
1169
+ * @path /v1/dns/{zone_name}/rrsets
1170
+ */
1171
+ export type PUT_DnsZoneNameRrsets_V1_Request_RequestBody = PUT_DnsZoneNameRrsets_V1_Request['requestBody'];
1172
+
1173
+ /**
1174
+ * Request type for GET DomainSearchSuggest endpoint
1175
+ *
1176
+ * Suggest
1177
+ *
1178
+ * @remarks
1179
+ * This type defines the complete request structure for the GET DomainSearchSuggest endpoint.
1180
+ * It includes all parameters (query, path) and request body types as defined in the OpenAPI specification.
1181
+ * Use this type to ensure type safety when making API requests to this endpoint.
1182
+ *
1183
+ * @example
1184
+ * Use this type to ensure type safety when making API requests to this endpoint.
1185
+ *
1186
+ * @path /v1/domain-search/suggest
1187
+ * @param query (query) - The primary keyword or phrase for the domain search
1188
+ * @param tlds (query) -
1189
+ Specify one or more TLDs to include in the search.
1190
+
1191
+ * @param limit (query) - The maximum number of domain suggestions to return
1192
+ * @param premium (query) - Whether to include premium domains in the suggestions
1193
+ *
1194
+ * @see {@link GET_DomainSearchSuggest_V1_Request_Parameters_Query} - Query parameters type
1195
+ * @see {@link GET_DomainSearchSuggest_V1_Request_Parameters_Path} - Path parameters type
1196
+ * @see {@link GET_DomainSearchSuggest_V1_Request_RequestBody} - Request body type
1197
+ */
1198
+ export type GET_DomainSearchSuggest_V1_Request = {
1199
+ parameters: {
1200
+ query: operations['suggest_v1_domain_search_suggest_get']['parameters']['query'];
1201
+ };
1202
+ }
1203
+ /**
1204
+ * Query parameters for GET /v1/domain-search/suggest
1205
+ *
1206
+ * @remarks
1207
+ * This type defines the query parameters for the GET /v1/domain-search/suggest endpoint.
1208
+ * It provides type safety for all query parameters as defined in the OpenAPI specification.
1209
+ *
1210
+ * @example
1211
+ * Use this type to ensure type safety for query parameters.
1212
+ *
1213
+ * @path /v1/domain-search/suggest
1214
+ * @param query (query) - The primary keyword or phrase for the domain search
1215
+ * @param tlds (query) -
1216
+ Specify one or more TLDs to include in the search.
1217
+
1218
+ * @param limit (query) - The maximum number of domain suggestions to return
1219
+ * @param premium (query) - Whether to include premium domains in the suggestions
1220
+ */
1221
+ export type GET_DomainSearchSuggest_V1_Request_Parameters_Query = GET_DomainSearchSuggest_V1_Request['parameters']['query'];
1222
+
1223
+ /**
1224
+ * Request type for GET Domains endpoint
1225
+ *
1226
+ * List all domains
1227
+ * Retrieves a paginated list of all domains
1228
+ *
1229
+ * @remarks
1230
+ * This type defines the complete request structure for the GET Domains endpoint.
1231
+ * It includes all parameters (query, path) and request body types as defined in the OpenAPI specification.
1232
+ * Use this type to ensure type safety when making API requests to this endpoint.
1233
+ *
1234
+ * @example
1235
+ * Use this type to ensure type safety when making API requests to this endpoint.
1236
+ *
1237
+ * @path /v1/domains
1238
+ *
1239
+ * @see {@link GET_Domains_V1_Request_Parameters_Query} - Query parameters type
1240
+ * @see {@link GET_Domains_V1_Request_Parameters_Path} - Path parameters type
1241
+ * @see {@link GET_Domains_V1_Request_RequestBody} - Request body type
1242
+ */
1243
+ export type GET_Domains_V1_Request = {
1244
+ parameters: {
1245
+ query: operations['get_domains_v1_domains_get']['parameters']['query'];
1246
+ };
1247
+ }
1248
+ /**
1249
+ * Query parameters for GET /v1/domains
1250
+ *
1251
+ * @remarks
1252
+ * This type defines the query parameters for the GET /v1/domains endpoint.
1253
+ * It provides type safety for all query parameters as defined in the OpenAPI specification.
1254
+ *
1255
+ * @example
1256
+ * Use this type to ensure type safety for query parameters.
1257
+ *
1258
+ * @path /v1/domains
1259
+ */
1260
+ export type GET_Domains_V1_Request_Parameters_Query = GET_Domains_V1_Request['parameters']['query'];
1261
+
1262
+ /**
1263
+ * Request type for POST Domains endpoint
1264
+ *
1265
+ * Create a domain
1266
+ * Registers a new domain
1267
+ *
1268
+ * @remarks
1269
+ * This type defines the complete request structure for the POST Domains endpoint.
1270
+ * It includes all parameters (query, path) and request body types as defined in the OpenAPI specification.
1271
+ * Use this type to ensure type safety when making API requests to this endpoint.
1272
+ *
1273
+ * @example
1274
+ * Use this type to ensure type safety when making API requests to this endpoint.
1275
+ *
1276
+ * @path /v1/domains
1277
+ *
1278
+ * @see {@link POST_Domains_V1_Request_Parameters_Query} - Query parameters type
1279
+ * @see {@link POST_Domains_V1_Request_Parameters_Path} - Path parameters type
1280
+ * @see {@link POST_Domains_V1_Request_RequestBody} - Request body type
1281
+ */
1282
+ export type POST_Domains_V1_Request = {
1283
+ requestBody: DomainCreate;
1284
+ }
1285
+ /**
1286
+ * Request body for POST /v1/domains
1287
+ *
1288
+ * @remarks
1289
+ * This type defines the request body structure for the POST /v1/domains endpoint.
1290
+ * It provides type safety for the request body as defined in the OpenAPI specification.
1291
+ *
1292
+ * @example
1293
+ * Use this type to ensure type safety for request body structure.
1294
+ *
1295
+ * @path /v1/domains
1296
+ */
1297
+ export type POST_Domains_V1_Request_RequestBody = POST_Domains_V1_Request['requestBody'];
1298
+
1299
+ /**
1300
+ * Request type for GET DomainsCheck endpoint
1301
+ *
1302
+ * Check domain availability
1303
+ *
1304
+ * @remarks
1305
+ * This type defines the complete request structure for the GET DomainsCheck endpoint.
1306
+ * It includes all parameters (query, path) and request body types as defined in the OpenAPI specification.
1307
+ * Use this type to ensure type safety when making API requests to this endpoint.
1308
+ *
1309
+ * @example
1310
+ * Use this type to ensure type safety when making API requests to this endpoint.
1311
+ *
1312
+ * @path /v1/domains/check
1313
+ * @param domains (query) -
1314
+ Specify one or more domains to check for availability.
1315
+
1316
+ *
1317
+ * @see {@link GET_DomainsCheck_V1_Request_Parameters_Query} - Query parameters type
1318
+ * @see {@link GET_DomainsCheck_V1_Request_Parameters_Path} - Path parameters type
1319
+ * @see {@link GET_DomainsCheck_V1_Request_RequestBody} - Request body type
1320
+ */
1321
+ export type GET_DomainsCheck_V1_Request = {
1322
+ parameters: {
1323
+ query: operations['epp_check_domain_v1_domains_check_get']['parameters']['query'];
1324
+ };
1325
+ }
1326
+ /**
1327
+ * Query parameters for GET /v1/domains/check
1328
+ *
1329
+ * @remarks
1330
+ * This type defines the query parameters for the GET /v1/domains/check endpoint.
1331
+ * It provides type safety for all query parameters as defined in the OpenAPI specification.
1332
+ *
1333
+ * @example
1334
+ * Use this type to ensure type safety for query parameters.
1335
+ *
1336
+ * @path /v1/domains/check
1337
+ * @param domains (query) -
1338
+ Specify one or more domains to check for availability.
1339
+
1340
+ */
1341
+ export type GET_DomainsCheck_V1_Request_Parameters_Query = GET_DomainsCheck_V1_Request['parameters']['query'];
1342
+
1343
+ /**
1344
+ * Request type for DELETE DomainsDomainReference endpoint
1345
+ *
1346
+ * Delete a domain
1347
+ * Initiates the deletion process for a domain. The domain will be marked for deletion
1348
+ and will enter a redemption period during which it may be restored.
1349
+ *
1350
+ * @remarks
1351
+ * This type defines the complete request structure for the DELETE DomainsDomainReference endpoint.
1352
+ * It includes all parameters (query, path) and request body types as defined in the OpenAPI specification.
1353
+ * Use this type to ensure type safety when making API requests to this endpoint.
1354
+ *
1355
+ * @example
1356
+ * Use this type to ensure type safety when making API requests to this endpoint.
1357
+ *
1358
+ * @path /v1/domains/{domain_reference}
1359
+ *
1360
+ * @see {@link DELETE_DomainsDomainReference_V1_Request_Parameters_Query} - Query parameters type
1361
+ * @see {@link DELETE_DomainsDomainReference_V1_Request_Parameters_Path} - Path parameters type
1362
+ * @see {@link DELETE_DomainsDomainReference_V1_Request_RequestBody} - Request body type
1363
+ */
1364
+ export type DELETE_DomainsDomainReference_V1_Request = {
1365
+ parameters: {
1366
+ path: operations['delete_domain_v1_domains__domain_reference__delete']['parameters']['path'];
1367
+ };
1368
+ }
1369
+ /**
1370
+ * Path parameters for DELETE /v1/domains/{domain_reference}
1371
+ *
1372
+ * @remarks
1373
+ * This type defines the path parameters for the DELETE /v1/domains/{domain_reference} endpoint.
1374
+ * It provides type safety for all path parameters as defined in the OpenAPI specification.
1375
+ *
1376
+ * @example
1377
+ * Use this type to ensure type safety for path parameters.
1378
+ *
1379
+ * @path /v1/domains/{domain_reference}
1380
+ */
1381
+ export type DELETE_DomainsDomainReference_V1_Request_Parameters_Path = DELETE_DomainsDomainReference_V1_Request['parameters']['path'];
1382
+
1383
+ /**
1384
+ * Request type for GET DomainsDomainReference endpoint
1385
+ *
1386
+ * Retrieve a domain
1387
+ * Retrieves a single domain by either its name or id
1388
+ *
1389
+ * @remarks
1390
+ * This type defines the complete request structure for the GET DomainsDomainReference endpoint.
1391
+ * It includes all parameters (query, path) and request body types as defined in the OpenAPI specification.
1392
+ * Use this type to ensure type safety when making API requests to this endpoint.
1393
+ *
1394
+ * @example
1395
+ * Use this type to ensure type safety when making API requests to this endpoint.
1396
+ *
1397
+ * @path /v1/domains/{domain_reference}
1398
+ *
1399
+ * @see {@link GET_DomainsDomainReference_V1_Request_Parameters_Query} - Query parameters type
1400
+ * @see {@link GET_DomainsDomainReference_V1_Request_Parameters_Path} - Path parameters type
1401
+ * @see {@link GET_DomainsDomainReference_V1_Request_RequestBody} - Request body type
1402
+ */
1403
+ export type GET_DomainsDomainReference_V1_Request = {
1404
+ parameters: {
1405
+ path: operations['get_domain_v1_domains__domain_reference__get']['parameters']['path'];
1406
+ };
1407
+ }
1408
+ /**
1409
+ * Path parameters for GET /v1/domains/{domain_reference}
1410
+ *
1411
+ * @remarks
1412
+ * This type defines the path parameters for the GET /v1/domains/{domain_reference} endpoint.
1413
+ * It provides type safety for all path parameters as defined in the OpenAPI specification.
1414
+ *
1415
+ * @example
1416
+ * Use this type to ensure type safety for path parameters.
1417
+ *
1418
+ * @path /v1/domains/{domain_reference}
1419
+ */
1420
+ export type GET_DomainsDomainReference_V1_Request_Parameters_Path = GET_DomainsDomainReference_V1_Request['parameters']['path'];
1421
+
1422
+ /**
1423
+ * Request type for PATCH DomainsDomainReference endpoint
1424
+ *
1425
+ * Update a domain
1426
+ * Updates various attributes of an existing domain. Only the fields provided in the request
1427
+ will be updated; all other fields will remain unchanged. <br>
1428
+ Providing `clientTransferProhibited` as a status will set the `transfer_lock` property
1429
+ *
1430
+ * @remarks
1431
+ * This type defines the complete request structure for the PATCH DomainsDomainReference endpoint.
1432
+ * It includes all parameters (query, path) and request body types as defined in the OpenAPI specification.
1433
+ * Use this type to ensure type safety when making API requests to this endpoint.
1434
+ *
1435
+ * @example
1436
+ * Use this type to ensure type safety when making API requests to this endpoint.
1437
+ *
1438
+ * @path /v1/domains/{domain_reference}
1439
+ *
1440
+ * @see {@link PATCH_DomainsDomainReference_V1_Request_Parameters_Query} - Query parameters type
1441
+ * @see {@link PATCH_DomainsDomainReference_V1_Request_Parameters_Path} - Path parameters type
1442
+ * @see {@link PATCH_DomainsDomainReference_V1_Request_RequestBody} - Request body type
1443
+ */
1444
+ export type PATCH_DomainsDomainReference_V1_Request = {
1445
+ parameters: {
1446
+ path: operations['update_domain_v1_domains__domain_reference__patch']['parameters']['path'];
1447
+ };
1448
+ requestBody: DomainUpdate;
1449
+ }
1450
+ /**
1451
+ * Path parameters for PATCH /v1/domains/{domain_reference}
1452
+ *
1453
+ * @remarks
1454
+ * This type defines the path parameters for the PATCH /v1/domains/{domain_reference} endpoint.
1455
+ * It provides type safety for all path parameters as defined in the OpenAPI specification.
1456
+ *
1457
+ * @example
1458
+ * Use this type to ensure type safety for path parameters.
1459
+ *
1460
+ * @path /v1/domains/{domain_reference}
1461
+ */
1462
+ export type PATCH_DomainsDomainReference_V1_Request_Parameters_Path = PATCH_DomainsDomainReference_V1_Request['parameters']['path'];
1463
+ /**
1464
+ * Request body for PATCH /v1/domains/{domain_reference}
1465
+ *
1466
+ * @remarks
1467
+ * This type defines the request body structure for the PATCH /v1/domains/{domain_reference} endpoint.
1468
+ * It provides type safety for the request body as defined in the OpenAPI specification.
1469
+ *
1470
+ * @example
1471
+ * Use this type to ensure type safety for request body structure.
1472
+ *
1473
+ * @path /v1/domains/{domain_reference}
1474
+ */
1475
+ export type PATCH_DomainsDomainReference_V1_Request_RequestBody = PATCH_DomainsDomainReference_V1_Request['requestBody'];
1476
+
1477
+ /**
1478
+ * Request type for DELETE DomainsDomainReferenceDnssec endpoint
1479
+ *
1480
+ * Delete DNSSEC data
1481
+ * Removes all DNSSEC data for a domain
1482
+ *
1483
+ * @remarks
1484
+ * This type defines the complete request structure for the DELETE DomainsDomainReferenceDnssec endpoint.
1485
+ * It includes all parameters (query, path) and request body types as defined in the OpenAPI specification.
1486
+ * Use this type to ensure type safety when making API requests to this endpoint.
1487
+ *
1488
+ * @example
1489
+ * Use this type to ensure type safety when making API requests to this endpoint.
1490
+ *
1491
+ * @path /v1/domains/{domain_reference}/dnssec
1492
+ *
1493
+ * @see {@link DELETE_DomainsDomainReferenceDnssec_V1_Request_Parameters_Query} - Query parameters type
1494
+ * @see {@link DELETE_DomainsDomainReferenceDnssec_V1_Request_Parameters_Path} - Path parameters type
1495
+ * @see {@link DELETE_DomainsDomainReferenceDnssec_V1_Request_RequestBody} - Request body type
1496
+ */
1497
+ export type DELETE_DomainsDomainReferenceDnssec_V1_Request = {
1498
+ parameters: {
1499
+ path: operations['delete_dnssec_v1_domains__domain_reference__dnssec_delete']['parameters']['path'];
1500
+ };
1501
+ }
1502
+ /**
1503
+ * Path parameters for DELETE /v1/domains/{domain_reference}/dnssec
1504
+ *
1505
+ * @remarks
1506
+ * This type defines the path parameters for the DELETE /v1/domains/{domain_reference}/dnssec endpoint.
1507
+ * It provides type safety for all path parameters as defined in the OpenAPI specification.
1508
+ *
1509
+ * @example
1510
+ * Use this type to ensure type safety for path parameters.
1511
+ *
1512
+ * @path /v1/domains/{domain_reference}/dnssec
1513
+ */
1514
+ export type DELETE_DomainsDomainReferenceDnssec_V1_Request_Parameters_Path = DELETE_DomainsDomainReferenceDnssec_V1_Request['parameters']['path'];
1515
+
1516
+ /**
1517
+ * Request type for GET DomainsDomainReferenceDnssec endpoint
1518
+ *
1519
+ * Retrieve DNSSEC data
1520
+ * Fetches all DNSSEC records associated with the specified domain.
1521
+ *
1522
+ * @remarks
1523
+ * This type defines the complete request structure for the GET DomainsDomainReferenceDnssec endpoint.
1524
+ * It includes all parameters (query, path) and request body types as defined in the OpenAPI specification.
1525
+ * Use this type to ensure type safety when making API requests to this endpoint.
1526
+ *
1527
+ * @example
1528
+ * Use this type to ensure type safety when making API requests to this endpoint.
1529
+ *
1530
+ * @path /v1/domains/{domain_reference}/dnssec
1531
+ *
1532
+ * @see {@link GET_DomainsDomainReferenceDnssec_V1_Request_Parameters_Query} - Query parameters type
1533
+ * @see {@link GET_DomainsDomainReferenceDnssec_V1_Request_Parameters_Path} - Path parameters type
1534
+ * @see {@link GET_DomainsDomainReferenceDnssec_V1_Request_RequestBody} - Request body type
1535
+ */
1536
+ export type GET_DomainsDomainReferenceDnssec_V1_Request = {
1537
+ parameters: {
1538
+ path: operations['get_dnssec_v1_domains__domain_reference__dnssec_get']['parameters']['path'];
1539
+ };
1540
+ }
1541
+ /**
1542
+ * Path parameters for GET /v1/domains/{domain_reference}/dnssec
1543
+ *
1544
+ * @remarks
1545
+ * This type defines the path parameters for the GET /v1/domains/{domain_reference}/dnssec endpoint.
1546
+ * It provides type safety for all path parameters as defined in the OpenAPI specification.
1547
+ *
1548
+ * @example
1549
+ * Use this type to ensure type safety for path parameters.
1550
+ *
1551
+ * @path /v1/domains/{domain_reference}/dnssec
1552
+ */
1553
+ export type GET_DomainsDomainReferenceDnssec_V1_Request_Parameters_Path = GET_DomainsDomainReferenceDnssec_V1_Request['parameters']['path'];
1554
+
1555
+ /**
1556
+ * Request type for PUT DomainsDomainReferenceDnssec endpoint
1557
+ *
1558
+ * Update DNSSEC data
1559
+ * Replaces all existing DNSSEC records for the domain with the provided records.
1560
+ *
1561
+ * @remarks
1562
+ * This type defines the complete request structure for the PUT DomainsDomainReferenceDnssec endpoint.
1563
+ * It includes all parameters (query, path) and request body types as defined in the OpenAPI specification.
1564
+ * Use this type to ensure type safety when making API requests to this endpoint.
1565
+ *
1566
+ * @example
1567
+ * Use this type to ensure type safety when making API requests to this endpoint.
1568
+ *
1569
+ * @path /v1/domains/{domain_reference}/dnssec
1570
+ *
1571
+ * @see {@link PUT_DomainsDomainReferenceDnssec_V1_Request_Parameters_Query} - Query parameters type
1572
+ * @see {@link PUT_DomainsDomainReferenceDnssec_V1_Request_Parameters_Path} - Path parameters type
1573
+ * @see {@link PUT_DomainsDomainReferenceDnssec_V1_Request_RequestBody} - Request body type
1574
+ */
1575
+ export type PUT_DomainsDomainReferenceDnssec_V1_Request = {
1576
+ parameters: {
1577
+ path: operations['create_or_update_dnssec_v1_domains__domain_reference__dnssec_put']['parameters']['path'];
1578
+ };
1579
+ requestBody: DomainDnssecDataCreateArray;
1580
+ }
1581
+ /**
1582
+ * Path parameters for PUT /v1/domains/{domain_reference}/dnssec
1583
+ *
1584
+ * @remarks
1585
+ * This type defines the path parameters for the PUT /v1/domains/{domain_reference}/dnssec endpoint.
1586
+ * It provides type safety for all path parameters as defined in the OpenAPI specification.
1587
+ *
1588
+ * @example
1589
+ * Use this type to ensure type safety for path parameters.
1590
+ *
1591
+ * @path /v1/domains/{domain_reference}/dnssec
1592
+ */
1593
+ export type PUT_DomainsDomainReferenceDnssec_V1_Request_Parameters_Path = PUT_DomainsDomainReferenceDnssec_V1_Request['parameters']['path'];
1594
+ /**
1595
+ * Request body for PUT /v1/domains/{domain_reference}/dnssec
1596
+ *
1597
+ * @remarks
1598
+ * This type defines the request body structure for the PUT /v1/domains/{domain_reference}/dnssec endpoint.
1599
+ * It provides type safety for the request body as defined in the OpenAPI specification.
1600
+ *
1601
+ * @example
1602
+ * Use this type to ensure type safety for request body structure.
1603
+ *
1604
+ * @path /v1/domains/{domain_reference}/dnssec
1605
+ */
1606
+ export type PUT_DomainsDomainReferenceDnssec_V1_Request_RequestBody = PUT_DomainsDomainReferenceDnssec_V1_Request['requestBody'];
1607
+
1608
+ /**
1609
+ * Request type for POST DomainsDomainReferenceRenew endpoint
1610
+ *
1611
+ * Renew a domain
1612
+ * Extends the registration period of an existing domain. The renewal period is added
1613
+ to the current expiration date of the domain.
1614
+ *
1615
+ * @remarks
1616
+ * This type defines the complete request structure for the POST DomainsDomainReferenceRenew endpoint.
1617
+ * It includes all parameters (query, path) and request body types as defined in the OpenAPI specification.
1618
+ * Use this type to ensure type safety when making API requests to this endpoint.
1619
+ *
1620
+ * @example
1621
+ * Use this type to ensure type safety when making API requests to this endpoint.
1622
+ *
1623
+ * @path /v1/domains/{domain_reference}/renew
1624
+ *
1625
+ * @see {@link POST_DomainsDomainReferenceRenew_V1_Request_Parameters_Query} - Query parameters type
1626
+ * @see {@link POST_DomainsDomainReferenceRenew_V1_Request_Parameters_Path} - Path parameters type
1627
+ * @see {@link POST_DomainsDomainReferenceRenew_V1_Request_RequestBody} - Request body type
1628
+ */
1629
+ export type POST_DomainsDomainReferenceRenew_V1_Request = {
1630
+ parameters: {
1631
+ path: operations['renew_domain_v1_domains__domain_reference__renew_post']['parameters']['path'];
1632
+ };
1633
+ requestBody: DomainRenewRequest;
1634
+ }
1635
+ /**
1636
+ * Path parameters for POST /v1/domains/{domain_reference}/renew
1637
+ *
1638
+ * @remarks
1639
+ * This type defines the path parameters for the POST /v1/domains/{domain_reference}/renew endpoint.
1640
+ * It provides type safety for all path parameters as defined in the OpenAPI specification.
1641
+ *
1642
+ * @example
1643
+ * Use this type to ensure type safety for path parameters.
1644
+ *
1645
+ * @path /v1/domains/{domain_reference}/renew
1646
+ */
1647
+ export type POST_DomainsDomainReferenceRenew_V1_Request_Parameters_Path = POST_DomainsDomainReferenceRenew_V1_Request['parameters']['path'];
1648
+ /**
1649
+ * Request body for POST /v1/domains/{domain_reference}/renew
1650
+ *
1651
+ * @remarks
1652
+ * This type defines the request body structure for the POST /v1/domains/{domain_reference}/renew endpoint.
1653
+ * It provides type safety for the request body as defined in the OpenAPI specification.
1654
+ *
1655
+ * @example
1656
+ * Use this type to ensure type safety for request body structure.
1657
+ *
1658
+ * @path /v1/domains/{domain_reference}/renew
1659
+ */
1660
+ export type POST_DomainsDomainReferenceRenew_V1_Request_RequestBody = POST_DomainsDomainReferenceRenew_V1_Request['requestBody'];
1661
+
1662
+ /**
1663
+ * Request type for DELETE DomainsDomainReferenceTransfer endpoint
1664
+ *
1665
+ * Cancel a domain transfer
1666
+ * This will cancel the in-progress domain transfer and delete the domain object
1667
+ *
1668
+ * @remarks
1669
+ * This type defines the complete request structure for the DELETE DomainsDomainReferenceTransfer endpoint.
1670
+ * It includes all parameters (query, path) and request body types as defined in the OpenAPI specification.
1671
+ * Use this type to ensure type safety when making API requests to this endpoint.
1672
+ *
1673
+ * @example
1674
+ * Use this type to ensure type safety when making API requests to this endpoint.
1675
+ *
1676
+ * @path /v1/domains/{domain_reference}/transfer
1677
+ *
1678
+ * @see {@link DELETE_DomainsDomainReferenceTransfer_V1_Request_Parameters_Query} - Query parameters type
1679
+ * @see {@link DELETE_DomainsDomainReferenceTransfer_V1_Request_Parameters_Path} - Path parameters type
1680
+ * @see {@link DELETE_DomainsDomainReferenceTransfer_V1_Request_RequestBody} - Request body type
1681
+ */
1682
+ export type DELETE_DomainsDomainReferenceTransfer_V1_Request = {
1683
+ parameters: {
1684
+ path: operations['cancel_domain_transfer_v1_domains__domain_reference__transfer_delete']['parameters']['path'];
1685
+ };
1686
+ }
1687
+ /**
1688
+ * Path parameters for DELETE /v1/domains/{domain_reference}/transfer
1689
+ *
1690
+ * @remarks
1691
+ * This type defines the path parameters for the DELETE /v1/domains/{domain_reference}/transfer endpoint.
1692
+ * It provides type safety for all path parameters as defined in the OpenAPI specification.
1693
+ *
1694
+ * @example
1695
+ * Use this type to ensure type safety for path parameters.
1696
+ *
1697
+ * @path /v1/domains/{domain_reference}/transfer
1698
+ */
1699
+ export type DELETE_DomainsDomainReferenceTransfer_V1_Request_Parameters_Path = DELETE_DomainsDomainReferenceTransfer_V1_Request['parameters']['path'];
1700
+
1701
+ /**
1702
+ * Request type for GET DomainsSummary endpoint
1703
+ *
1704
+ * Get domain summary
1705
+ * Retrieves a summary of domains including counts by status, TLD, and expiration timeframes
1706
+ *
1707
+ * @remarks
1708
+ * This type defines the complete request structure for the GET DomainsSummary endpoint.
1709
+ * It includes all parameters (query, path) and request body types as defined in the OpenAPI specification.
1710
+ * Use this type to ensure type safety when making API requests to this endpoint.
1711
+ *
1712
+ * @example
1713
+ * Use this type to ensure type safety when making API requests to this endpoint.
1714
+ *
1715
+ * @path /v1/domains/summary
1716
+ *
1717
+ * @see {@link GET_DomainsSummary_V1_Request_Parameters_Query} - Query parameters type
1718
+ * @see {@link GET_DomainsSummary_V1_Request_Parameters_Path} - Path parameters type
1719
+ * @see {@link GET_DomainsSummary_V1_Request_RequestBody} - Request body type
1720
+ */
1721
+ export type GET_DomainsSummary_V1_Request = {
1722
+ }
1723
+
1724
+ /**
1725
+ * Request type for POST DomainsTransfer endpoint
1726
+ *
1727
+ * Transfer a domain
1728
+ * Start the transfer process for a domain <br>
1729
+ The domain will be in state `pending_transfer` until the transfer is completed.
1730
+ This process can take up to 5 days, until the transfer is approved
1731
+ *
1732
+ * @remarks
1733
+ * This type defines the complete request structure for the POST DomainsTransfer endpoint.
1734
+ * It includes all parameters (query, path) and request body types as defined in the OpenAPI specification.
1735
+ * Use this type to ensure type safety when making API requests to this endpoint.
1736
+ *
1737
+ * @example
1738
+ * Use this type to ensure type safety when making API requests to this endpoint.
1739
+ *
1740
+ * @path /v1/domains/transfer
1741
+ *
1742
+ * @see {@link POST_DomainsTransfer_V1_Request_Parameters_Query} - Query parameters type
1743
+ * @see {@link POST_DomainsTransfer_V1_Request_Parameters_Path} - Path parameters type
1744
+ * @see {@link POST_DomainsTransfer_V1_Request_RequestBody} - Request body type
1745
+ */
1746
+ export type POST_DomainsTransfer_V1_Request = {
1747
+ requestBody: DomainTransferIn;
1748
+ }
1749
+ /**
1750
+ * Request body for POST /v1/domains/transfer
1751
+ *
1752
+ * @remarks
1753
+ * This type defines the request body structure for the POST /v1/domains/transfer endpoint.
1754
+ * It provides type safety for the request body as defined in the OpenAPI specification.
1755
+ *
1756
+ * @example
1757
+ * Use this type to ensure type safety for request body structure.
1758
+ *
1759
+ * @path /v1/domains/transfer
1760
+ */
1761
+ export type POST_DomainsTransfer_V1_Request_RequestBody = POST_DomainsTransfer_V1_Request['requestBody'];
1762
+
1763
+ /**
1764
+ * Request type for GET EmailForwards endpoint
1765
+ *
1766
+ * List Email Forwards
1767
+ *
1768
+ * @remarks
1769
+ * This type defines the complete request structure for the GET EmailForwards endpoint.
1770
+ * It includes all parameters (query, path) and request body types as defined in the OpenAPI specification.
1771
+ * Use this type to ensure type safety when making API requests to this endpoint.
1772
+ *
1773
+ * @example
1774
+ * Use this type to ensure type safety when making API requests to this endpoint.
1775
+ *
1776
+ * @path /v1/email-forwards
1777
+ * @param status (query) - Optional status to filter the results
1778
+ * @param source_address (query) - Optional source address to filter the results
1779
+ * @param target_address (query) - Optional target address to filter the results
1780
+ *
1781
+ * @see {@link GET_EmailForwards_V1_Request_Parameters_Query} - Query parameters type
1782
+ * @see {@link GET_EmailForwards_V1_Request_Parameters_Path} - Path parameters type
1783
+ * @see {@link GET_EmailForwards_V1_Request_RequestBody} - Request body type
1784
+ */
1785
+ export type GET_EmailForwards_V1_Request = {
1786
+ parameters: {
1787
+ query: operations['list_email_forwards_v1_email_forwards_get']['parameters']['query'];
1788
+ };
1789
+ }
1790
+ /**
1791
+ * Query parameters for GET /v1/email-forwards
1792
+ *
1793
+ * @remarks
1794
+ * This type defines the query parameters for the GET /v1/email-forwards endpoint.
1795
+ * It provides type safety for all query parameters as defined in the OpenAPI specification.
1796
+ *
1797
+ * @example
1798
+ * Use this type to ensure type safety for query parameters.
1799
+ *
1800
+ * @path /v1/email-forwards
1801
+ * @param status (query) - Optional status to filter the results
1802
+ * @param source_address (query) - Optional source address to filter the results
1803
+ * @param target_address (query) - Optional target address to filter the results
1804
+ */
1805
+ export type GET_EmailForwards_V1_Request_Parameters_Query = GET_EmailForwards_V1_Request['parameters']['query'];
1806
+
1807
+ /**
1808
+ * Request type for POST EmailForwards endpoint
1809
+ *
1810
+ * Create Email Forward
1811
+ *
1812
+ * @remarks
1813
+ * This type defines the complete request structure for the POST EmailForwards endpoint.
1814
+ * It includes all parameters (query, path) and request body types as defined in the OpenAPI specification.
1815
+ * Use this type to ensure type safety when making API requests to this endpoint.
1816
+ *
1817
+ * @example
1818
+ * Use this type to ensure type safety when making API requests to this endpoint.
1819
+ *
1820
+ * @path /v1/email-forwards
1821
+ *
1822
+ * @see {@link POST_EmailForwards_V1_Request_Parameters_Query} - Query parameters type
1823
+ * @see {@link POST_EmailForwards_V1_Request_Parameters_Path} - Path parameters type
1824
+ * @see {@link POST_EmailForwards_V1_Request_RequestBody} - Request body type
1825
+ */
1826
+ export type POST_EmailForwards_V1_Request = {
1827
+ requestBody: EmailForwardCreate;
1828
+ }
1829
+ /**
1830
+ * Request body for POST /v1/email-forwards
1831
+ *
1832
+ * @remarks
1833
+ * This type defines the request body structure for the POST /v1/email-forwards endpoint.
1834
+ * It provides type safety for the request body as defined in the OpenAPI specification.
1835
+ *
1836
+ * @example
1837
+ * Use this type to ensure type safety for request body structure.
1838
+ *
1839
+ * @path /v1/email-forwards
1840
+ */
1841
+ export type POST_EmailForwards_V1_Request_RequestBody = POST_EmailForwards_V1_Request['requestBody'];
1842
+
1843
+ /**
1844
+ * Request type for POST EmailForwardsBulkDelete endpoint
1845
+ *
1846
+ * Bulk Delete Email Forwards
1847
+ *
1848
+ * @remarks
1849
+ * This type defines the complete request structure for the POST EmailForwardsBulkDelete endpoint.
1850
+ * It includes all parameters (query, path) and request body types as defined in the OpenAPI specification.
1851
+ * Use this type to ensure type safety when making API requests to this endpoint.
1852
+ *
1853
+ * @example
1854
+ * Use this type to ensure type safety when making API requests to this endpoint.
1855
+ *
1856
+ * @path /v1/email-forwards/bulk-delete
1857
+ *
1858
+ * @see {@link POST_EmailForwardsBulkDelete_V1_Request_Parameters_Query} - Query parameters type
1859
+ * @see {@link POST_EmailForwardsBulkDelete_V1_Request_Parameters_Path} - Path parameters type
1860
+ * @see {@link POST_EmailForwardsBulkDelete_V1_Request_RequestBody} - Request body type
1861
+ */
1862
+ export type POST_EmailForwardsBulkDelete_V1_Request = {
1863
+ requestBody: EmailForwardBulkDelete;
1864
+ }
1865
+ /**
1866
+ * Request body for POST /v1/email-forwards/bulk-delete
1867
+ *
1868
+ * @remarks
1869
+ * This type defines the request body structure for the POST /v1/email-forwards/bulk-delete endpoint.
1870
+ * It provides type safety for the request body as defined in the OpenAPI specification.
1871
+ *
1872
+ * @example
1873
+ * Use this type to ensure type safety for request body structure.
1874
+ *
1875
+ * @path /v1/email-forwards/bulk-delete
1876
+ */
1877
+ export type POST_EmailForwardsBulkDelete_V1_Request_RequestBody = POST_EmailForwardsBulkDelete_V1_Request['requestBody'];
1878
+
1879
+ /**
1880
+ * Request type for PATCH EmailForwardsBulkUpdate endpoint
1881
+ *
1882
+ * Bulk Update Email Forwards
1883
+ *
1884
+ * @remarks
1885
+ * This type defines the complete request structure for the PATCH EmailForwardsBulkUpdate endpoint.
1886
+ * It includes all parameters (query, path) and request body types as defined in the OpenAPI specification.
1887
+ * Use this type to ensure type safety when making API requests to this endpoint.
1888
+ *
1889
+ * @example
1890
+ * Use this type to ensure type safety when making API requests to this endpoint.
1891
+ *
1892
+ * @path /v1/email-forwards/bulk-update
1893
+ *
1894
+ * @see {@link PATCH_EmailForwardsBulkUpdate_V1_Request_Parameters_Query} - Query parameters type
1895
+ * @see {@link PATCH_EmailForwardsBulkUpdate_V1_Request_Parameters_Path} - Path parameters type
1896
+ * @see {@link PATCH_EmailForwardsBulkUpdate_V1_Request_RequestBody} - Request body type
1897
+ */
1898
+ export type PATCH_EmailForwardsBulkUpdate_V1_Request = {
1899
+ requestBody: EmailForwardBulkUpdate;
1900
+ }
1901
+ /**
1902
+ * Request body for PATCH /v1/email-forwards/bulk-update
1903
+ *
1904
+ * @remarks
1905
+ * This type defines the request body structure for the PATCH /v1/email-forwards/bulk-update endpoint.
1906
+ * It provides type safety for the request body as defined in the OpenAPI specification.
1907
+ *
1908
+ * @example
1909
+ * Use this type to ensure type safety for request body structure.
1910
+ *
1911
+ * @path /v1/email-forwards/bulk-update
1912
+ */
1913
+ export type PATCH_EmailForwardsBulkUpdate_V1_Request_RequestBody = PATCH_EmailForwardsBulkUpdate_V1_Request['requestBody'];
1914
+
1915
+ /**
1916
+ * Request type for DELETE EmailForwardsEmailForwardId endpoint
1917
+ *
1918
+ * Delete Email Forward
1919
+ *
1920
+ * @remarks
1921
+ * This type defines the complete request structure for the DELETE EmailForwardsEmailForwardId endpoint.
1922
+ * It includes all parameters (query, path) and request body types as defined in the OpenAPI specification.
1923
+ * Use this type to ensure type safety when making API requests to this endpoint.
1924
+ *
1925
+ * @example
1926
+ * Use this type to ensure type safety when making API requests to this endpoint.
1927
+ *
1928
+ * @path /v1/email-forwards/{email_forward_id}
1929
+ *
1930
+ * @see {@link DELETE_EmailForwardsEmailForwardId_V1_Request_Parameters_Query} - Query parameters type
1931
+ * @see {@link DELETE_EmailForwardsEmailForwardId_V1_Request_Parameters_Path} - Path parameters type
1932
+ * @see {@link DELETE_EmailForwardsEmailForwardId_V1_Request_RequestBody} - Request body type
1933
+ */
1934
+ export type DELETE_EmailForwardsEmailForwardId_V1_Request = {
1935
+ parameters: {
1936
+ path: operations['delete_email_forward_v1_email_forwards__email_forward_id__delete']['parameters']['path'];
1937
+ };
1938
+ }
1939
+ /**
1940
+ * Path parameters for DELETE /v1/email-forwards/{email_forward_id}
1941
+ *
1942
+ * @remarks
1943
+ * This type defines the path parameters for the DELETE /v1/email-forwards/{email_forward_id} endpoint.
1944
+ * It provides type safety for all path parameters as defined in the OpenAPI specification.
1945
+ *
1946
+ * @example
1947
+ * Use this type to ensure type safety for path parameters.
1948
+ *
1949
+ * @path /v1/email-forwards/{email_forward_id}
1950
+ */
1951
+ export type DELETE_EmailForwardsEmailForwardId_V1_Request_Parameters_Path = DELETE_EmailForwardsEmailForwardId_V1_Request['parameters']['path'];
1952
+
1953
+ /**
1954
+ * Request type for GET EmailForwardsEmailForwardId endpoint
1955
+ *
1956
+ * Get Email Forward
1957
+ *
1958
+ * @remarks
1959
+ * This type defines the complete request structure for the GET EmailForwardsEmailForwardId endpoint.
1960
+ * It includes all parameters (query, path) and request body types as defined in the OpenAPI specification.
1961
+ * Use this type to ensure type safety when making API requests to this endpoint.
1962
+ *
1963
+ * @example
1964
+ * Use this type to ensure type safety when making API requests to this endpoint.
1965
+ *
1966
+ * @path /v1/email-forwards/{email_forward_id}
1967
+ *
1968
+ * @see {@link GET_EmailForwardsEmailForwardId_V1_Request_Parameters_Query} - Query parameters type
1969
+ * @see {@link GET_EmailForwardsEmailForwardId_V1_Request_Parameters_Path} - Path parameters type
1970
+ * @see {@link GET_EmailForwardsEmailForwardId_V1_Request_RequestBody} - Request body type
1971
+ */
1972
+ export type GET_EmailForwardsEmailForwardId_V1_Request = {
1973
+ parameters: {
1974
+ path: operations['get_email_forward_v1_email_forwards__email_forward_id__get']['parameters']['path'];
1975
+ };
1976
+ }
1977
+ /**
1978
+ * Path parameters for GET /v1/email-forwards/{email_forward_id}
1979
+ *
1980
+ * @remarks
1981
+ * This type defines the path parameters for the GET /v1/email-forwards/{email_forward_id} endpoint.
1982
+ * It provides type safety for all path parameters as defined in the OpenAPI specification.
1983
+ *
1984
+ * @example
1985
+ * Use this type to ensure type safety for path parameters.
1986
+ *
1987
+ * @path /v1/email-forwards/{email_forward_id}
1988
+ */
1989
+ export type GET_EmailForwardsEmailForwardId_V1_Request_Parameters_Path = GET_EmailForwardsEmailForwardId_V1_Request['parameters']['path'];
1990
+
1991
+ /**
1992
+ * Request type for PATCH EmailForwardsEmailForwardId endpoint
1993
+ *
1994
+ * Update Email Forward
1995
+ *
1996
+ * @remarks
1997
+ * This type defines the complete request structure for the PATCH EmailForwardsEmailForwardId endpoint.
1998
+ * It includes all parameters (query, path) and request body types as defined in the OpenAPI specification.
1999
+ * Use this type to ensure type safety when making API requests to this endpoint.
2000
+ *
2001
+ * @example
2002
+ * Use this type to ensure type safety when making API requests to this endpoint.
2003
+ *
2004
+ * @path /v1/email-forwards/{email_forward_id}
2005
+ *
2006
+ * @see {@link PATCH_EmailForwardsEmailForwardId_V1_Request_Parameters_Query} - Query parameters type
2007
+ * @see {@link PATCH_EmailForwardsEmailForwardId_V1_Request_Parameters_Path} - Path parameters type
2008
+ * @see {@link PATCH_EmailForwardsEmailForwardId_V1_Request_RequestBody} - Request body type
2009
+ */
2010
+ export type PATCH_EmailForwardsEmailForwardId_V1_Request = {
2011
+ parameters: {
2012
+ path: operations['update_email_forward_v1_email_forwards__email_forward_id__patch']['parameters']['path'];
2013
+ };
2014
+ requestBody: EmailForwardUpdate;
2015
+ }
2016
+ /**
2017
+ * Path parameters for PATCH /v1/email-forwards/{email_forward_id}
2018
+ *
2019
+ * @remarks
2020
+ * This type defines the path parameters for the PATCH /v1/email-forwards/{email_forward_id} endpoint.
2021
+ * It provides type safety for all path parameters as defined in the OpenAPI specification.
2022
+ *
2023
+ * @example
2024
+ * Use this type to ensure type safety for path parameters.
2025
+ *
2026
+ * @path /v1/email-forwards/{email_forward_id}
2027
+ */
2028
+ export type PATCH_EmailForwardsEmailForwardId_V1_Request_Parameters_Path = PATCH_EmailForwardsEmailForwardId_V1_Request['parameters']['path'];
2029
+ /**
2030
+ * Request body for PATCH /v1/email-forwards/{email_forward_id}
2031
+ *
2032
+ * @remarks
2033
+ * This type defines the request body structure for the PATCH /v1/email-forwards/{email_forward_id} endpoint.
2034
+ * It provides type safety for the request body as defined in the OpenAPI specification.
2035
+ *
2036
+ * @example
2037
+ * Use this type to ensure type safety for request body structure.
2038
+ *
2039
+ * @path /v1/email-forwards/{email_forward_id}
2040
+ */
2041
+ export type PATCH_EmailForwardsEmailForwardId_V1_Request_RequestBody = PATCH_EmailForwardsEmailForwardId_V1_Request['requestBody'];
2042
+
2043
+ /**
2044
+ * Request type for GET Event endpoint
2045
+ *
2046
+ * Get Events
2047
+ *
2048
+ * @remarks
2049
+ * This type defines the complete request structure for the GET Event endpoint.
2050
+ * It includes all parameters (query, path) and request body types as defined in the OpenAPI specification.
2051
+ * Use this type to ensure type safety when making API requests to this endpoint.
2052
+ *
2053
+ * @example
2054
+ * Use this type to ensure type safety when making API requests to this endpoint.
2055
+ *
2056
+ * @path /v1/event
2057
+ *
2058
+ * @see {@link GET_Event_V1_Request_Parameters_Query} - Query parameters type
2059
+ * @see {@link GET_Event_V1_Request_Parameters_Path} - Path parameters type
2060
+ * @see {@link GET_Event_V1_Request_RequestBody} - Request body type
2061
+ */
2062
+ export type GET_Event_V1_Request = {
2063
+ parameters: {
2064
+ query: operations['get_events_v1_event_get']['parameters']['query'];
2065
+ };
2066
+ }
2067
+ /**
2068
+ * Query parameters for GET /v1/event
2069
+ *
2070
+ * @remarks
2071
+ * This type defines the query parameters for the GET /v1/event endpoint.
2072
+ * It provides type safety for all query parameters as defined in the OpenAPI specification.
2073
+ *
2074
+ * @example
2075
+ * Use this type to ensure type safety for query parameters.
2076
+ *
2077
+ * @path /v1/event
2078
+ */
2079
+ export type GET_Event_V1_Request_Parameters_Query = GET_Event_V1_Request['parameters']['query'];
2080
+
2081
+ /**
2082
+ * Request type for GET EventEventId endpoint
2083
+ *
2084
+ * Get Event
2085
+ *
2086
+ * @remarks
2087
+ * This type defines the complete request structure for the GET EventEventId endpoint.
2088
+ * It includes all parameters (query, path) and request body types as defined in the OpenAPI specification.
2089
+ * Use this type to ensure type safety when making API requests to this endpoint.
2090
+ *
2091
+ * @example
2092
+ * Use this type to ensure type safety when making API requests to this endpoint.
2093
+ *
2094
+ * @path /v1/event/{event_id}
2095
+ *
2096
+ * @see {@link GET_EventEventId_V1_Request_Parameters_Query} - Query parameters type
2097
+ * @see {@link GET_EventEventId_V1_Request_Parameters_Path} - Path parameters type
2098
+ * @see {@link GET_EventEventId_V1_Request_RequestBody} - Request body type
2099
+ */
2100
+ export type GET_EventEventId_V1_Request = {
2101
+ parameters: {
2102
+ path: operations['get_event_v1_event__event_id__get']['parameters']['path'];
2103
+ };
2104
+ }
2105
+ /**
2106
+ * Path parameters for GET /v1/event/{event_id}
2107
+ *
2108
+ * @remarks
2109
+ * This type defines the path parameters for the GET /v1/event/{event_id} endpoint.
2110
+ * It provides type safety for all path parameters as defined in the OpenAPI specification.
2111
+ *
2112
+ * @example
2113
+ * Use this type to ensure type safety for path parameters.
2114
+ *
2115
+ * @path /v1/event/{event_id}
2116
+ */
2117
+ export type GET_EventEventId_V1_Request_Parameters_Path = GET_EventEventId_V1_Request['parameters']['path'];
2118
+
2119
+ /**
2120
+ * Request type for PATCH EventEventId endpoint
2121
+ *
2122
+ * Acknowledge Event
2123
+ *
2124
+ * @remarks
2125
+ * This type defines the complete request structure for the PATCH EventEventId endpoint.
2126
+ * It includes all parameters (query, path) and request body types as defined in the OpenAPI specification.
2127
+ * Use this type to ensure type safety when making API requests to this endpoint.
2128
+ *
2129
+ * @example
2130
+ * Use this type to ensure type safety when making API requests to this endpoint.
2131
+ *
2132
+ * @path /v1/event/{event_id}
2133
+ *
2134
+ * @see {@link PATCH_EventEventId_V1_Request_Parameters_Query} - Query parameters type
2135
+ * @see {@link PATCH_EventEventId_V1_Request_Parameters_Path} - Path parameters type
2136
+ * @see {@link PATCH_EventEventId_V1_Request_RequestBody} - Request body type
2137
+ */
2138
+ export type PATCH_EventEventId_V1_Request = {
2139
+ parameters: {
2140
+ path: operations['acknowledge_event_v1_event__event_id__patch']['parameters']['path'];
2141
+ };
2142
+ }
2143
+ /**
2144
+ * Path parameters for PATCH /v1/event/{event_id}
2145
+ *
2146
+ * @remarks
2147
+ * This type defines the path parameters for the PATCH /v1/event/{event_id} endpoint.
2148
+ * It provides type safety for all path parameters as defined in the OpenAPI specification.
2149
+ *
2150
+ * @example
2151
+ * Use this type to ensure type safety for path parameters.
2152
+ *
2153
+ * @path /v1/event/{event_id}
2154
+ */
2155
+ export type PATCH_EventEventId_V1_Request_Parameters_Path = PATCH_EventEventId_V1_Request['parameters']['path'];
2156
+
2157
+ /**
2158
+ * Request type for GET Notifications endpoint
2159
+ *
2160
+ * List Notifications
2161
+ *
2162
+ * @remarks
2163
+ * This type defines the complete request structure for the GET Notifications endpoint.
2164
+ * It includes all parameters (query, path) and request body types as defined in the OpenAPI specification.
2165
+ * Use this type to ensure type safety when making API requests to this endpoint.
2166
+ *
2167
+ * @example
2168
+ * Use this type to ensure type safety when making API requests to this endpoint.
2169
+ *
2170
+ * @path /v1/notifications
2171
+ *
2172
+ * @see {@link GET_Notifications_V1_Request_Parameters_Query} - Query parameters type
2173
+ * @see {@link GET_Notifications_V1_Request_Parameters_Path} - Path parameters type
2174
+ * @see {@link GET_Notifications_V1_Request_RequestBody} - Request body type
2175
+ */
2176
+ export type GET_Notifications_V1_Request = {
2177
+ parameters: {
2178
+ query: operations['list_notifications_v1_notifications_get']['parameters']['query'];
2179
+ };
2180
+ }
2181
+ /**
2182
+ * Query parameters for GET /v1/notifications
2183
+ *
2184
+ * @remarks
2185
+ * This type defines the query parameters for the GET /v1/notifications endpoint.
2186
+ * It provides type safety for all query parameters as defined in the OpenAPI specification.
2187
+ *
2188
+ * @example
2189
+ * Use this type to ensure type safety for query parameters.
2190
+ *
2191
+ * @path /v1/notifications
2192
+ */
2193
+ export type GET_Notifications_V1_Request_Parameters_Query = GET_Notifications_V1_Request['parameters']['query'];
2194
+
2195
+ /**
2196
+ * Request type for POST Notifications endpoint
2197
+ *
2198
+ * Create Notification
2199
+ *
2200
+ * @remarks
2201
+ * This type defines the complete request structure for the POST Notifications endpoint.
2202
+ * It includes all parameters (query, path) and request body types as defined in the OpenAPI specification.
2203
+ * Use this type to ensure type safety when making API requests to this endpoint.
2204
+ *
2205
+ * @example
2206
+ * Use this type to ensure type safety when making API requests to this endpoint.
2207
+ *
2208
+ * @path /v1/notifications
2209
+ *
2210
+ * @see {@link POST_Notifications_V1_Request_Parameters_Query} - Query parameters type
2211
+ * @see {@link POST_Notifications_V1_Request_Parameters_Path} - Path parameters type
2212
+ * @see {@link POST_Notifications_V1_Request_RequestBody} - Request body type
2213
+ */
2214
+ export type POST_Notifications_V1_Request = {
2215
+ requestBody: NotificationCreate;
2216
+ }
2217
+ /**
2218
+ * Request body for POST /v1/notifications
2219
+ *
2220
+ * @remarks
2221
+ * This type defines the request body structure for the POST /v1/notifications endpoint.
2222
+ * It provides type safety for the request body as defined in the OpenAPI specification.
2223
+ *
2224
+ * @example
2225
+ * Use this type to ensure type safety for request body structure.
2226
+ *
2227
+ * @path /v1/notifications
2228
+ */
2229
+ export type POST_Notifications_V1_Request_RequestBody = POST_Notifications_V1_Request['requestBody'];
2230
+
2231
+ /**
2232
+ * Request type for DELETE NotificationsNotificationId endpoint
2233
+ *
2234
+ * Delete Notification
2235
+ *
2236
+ * @remarks
2237
+ * This type defines the complete request structure for the DELETE NotificationsNotificationId endpoint.
2238
+ * It includes all parameters (query, path) and request body types as defined in the OpenAPI specification.
2239
+ * Use this type to ensure type safety when making API requests to this endpoint.
2240
+ *
2241
+ * @example
2242
+ * Use this type to ensure type safety when making API requests to this endpoint.
2243
+ *
2244
+ * @path /v1/notifications/{notification_id}
2245
+ *
2246
+ * @see {@link DELETE_NotificationsNotificationId_V1_Request_Parameters_Query} - Query parameters type
2247
+ * @see {@link DELETE_NotificationsNotificationId_V1_Request_Parameters_Path} - Path parameters type
2248
+ * @see {@link DELETE_NotificationsNotificationId_V1_Request_RequestBody} - Request body type
2249
+ */
2250
+ export type DELETE_NotificationsNotificationId_V1_Request = {
2251
+ parameters: {
2252
+ path: operations['delete_notification_v1_notifications__notification_id__delete']['parameters']['path'];
2253
+ };
2254
+ }
2255
+ /**
2256
+ * Path parameters for DELETE /v1/notifications/{notification_id}
2257
+ *
2258
+ * @remarks
2259
+ * This type defines the path parameters for the DELETE /v1/notifications/{notification_id} endpoint.
2260
+ * It provides type safety for all path parameters as defined in the OpenAPI specification.
2261
+ *
2262
+ * @example
2263
+ * Use this type to ensure type safety for path parameters.
2264
+ *
2265
+ * @path /v1/notifications/{notification_id}
2266
+ */
2267
+ export type DELETE_NotificationsNotificationId_V1_Request_Parameters_Path = DELETE_NotificationsNotificationId_V1_Request['parameters']['path'];
2268
+
2269
+ /**
2270
+ * Request type for GET NotificationsNotificationId endpoint
2271
+ *
2272
+ * Get Notification
2273
+ *
2274
+ * @remarks
2275
+ * This type defines the complete request structure for the GET NotificationsNotificationId endpoint.
2276
+ * It includes all parameters (query, path) and request body types as defined in the OpenAPI specification.
2277
+ * Use this type to ensure type safety when making API requests to this endpoint.
2278
+ *
2279
+ * @example
2280
+ * Use this type to ensure type safety when making API requests to this endpoint.
2281
+ *
2282
+ * @path /v1/notifications/{notification_id}
2283
+ *
2284
+ * @see {@link GET_NotificationsNotificationId_V1_Request_Parameters_Query} - Query parameters type
2285
+ * @see {@link GET_NotificationsNotificationId_V1_Request_Parameters_Path} - Path parameters type
2286
+ * @see {@link GET_NotificationsNotificationId_V1_Request_RequestBody} - Request body type
2287
+ */
2288
+ export type GET_NotificationsNotificationId_V1_Request = {
2289
+ parameters: {
2290
+ query: operations['get_notification_v1_notifications__notification_id__get']['parameters']['query'];
2291
+ path: operations['get_notification_v1_notifications__notification_id__get']['parameters']['path'];
2292
+ };
2293
+ }
2294
+ /**
2295
+ * Query parameters for GET /v1/notifications/{notification_id}
2296
+ *
2297
+ * @remarks
2298
+ * This type defines the query parameters for the GET /v1/notifications/{notification_id} endpoint.
2299
+ * It provides type safety for all query parameters as defined in the OpenAPI specification.
2300
+ *
2301
+ * @example
2302
+ * Use this type to ensure type safety for query parameters.
2303
+ *
2304
+ * @path /v1/notifications/{notification_id}
2305
+ */
2306
+ export type GET_NotificationsNotificationId_V1_Request_Parameters_Query = GET_NotificationsNotificationId_V1_Request['parameters']['query'];
2307
+ /**
2308
+ * Path parameters for GET /v1/notifications/{notification_id}
2309
+ *
2310
+ * @remarks
2311
+ * This type defines the path parameters for the GET /v1/notifications/{notification_id} endpoint.
2312
+ * It provides type safety for all path parameters as defined in the OpenAPI specification.
2313
+ *
2314
+ * @example
2315
+ * Use this type to ensure type safety for path parameters.
2316
+ *
2317
+ * @path /v1/notifications/{notification_id}
2318
+ */
2319
+ export type GET_NotificationsNotificationId_V1_Request_Parameters_Path = GET_NotificationsNotificationId_V1_Request['parameters']['path'];
2320
+
2321
+ /**
2322
+ * Request type for PUT NotificationsNotificationId endpoint
2323
+ *
2324
+ * Update Notification
2325
+ *
2326
+ * @remarks
2327
+ * This type defines the complete request structure for the PUT NotificationsNotificationId endpoint.
2328
+ * It includes all parameters (query, path) and request body types as defined in the OpenAPI specification.
2329
+ * Use this type to ensure type safety when making API requests to this endpoint.
2330
+ *
2331
+ * @example
2332
+ * Use this type to ensure type safety when making API requests to this endpoint.
2333
+ *
2334
+ * @path /v1/notifications/{notification_id}
2335
+ *
2336
+ * @see {@link PUT_NotificationsNotificationId_V1_Request_Parameters_Query} - Query parameters type
2337
+ * @see {@link PUT_NotificationsNotificationId_V1_Request_Parameters_Path} - Path parameters type
2338
+ * @see {@link PUT_NotificationsNotificationId_V1_Request_RequestBody} - Request body type
2339
+ */
2340
+ export type PUT_NotificationsNotificationId_V1_Request = {
2341
+ parameters: {
2342
+ path: operations['update_notification_v1_notifications__notification_id__put']['parameters']['path'];
2343
+ };
2344
+ requestBody: NotificationUpdate;
2345
+ }
2346
+ /**
2347
+ * Path parameters for PUT /v1/notifications/{notification_id}
2348
+ *
2349
+ * @remarks
2350
+ * This type defines the path parameters for the PUT /v1/notifications/{notification_id} endpoint.
2351
+ * It provides type safety for all path parameters as defined in the OpenAPI specification.
2352
+ *
2353
+ * @example
2354
+ * Use this type to ensure type safety for path parameters.
2355
+ *
2356
+ * @path /v1/notifications/{notification_id}
2357
+ */
2358
+ export type PUT_NotificationsNotificationId_V1_Request_Parameters_Path = PUT_NotificationsNotificationId_V1_Request['parameters']['path'];
2359
+ /**
2360
+ * Request body for PUT /v1/notifications/{notification_id}
2361
+ *
2362
+ * @remarks
2363
+ * This type defines the request body structure for the PUT /v1/notifications/{notification_id} endpoint.
2364
+ * It provides type safety for the request body as defined in the OpenAPI specification.
2365
+ *
2366
+ * @example
2367
+ * Use this type to ensure type safety for request body structure.
2368
+ *
2369
+ * @path /v1/notifications/{notification_id}
2370
+ */
2371
+ export type PUT_NotificationsNotificationId_V1_Request_RequestBody = PUT_NotificationsNotificationId_V1_Request['requestBody'];
2372
+
2373
+ /**
2374
+ * Request type for PATCH NotificationsNotificationIdRead endpoint
2375
+ *
2376
+ * Update Notification Read
2377
+ *
2378
+ * @remarks
2379
+ * This type defines the complete request structure for the PATCH NotificationsNotificationIdRead endpoint.
2380
+ * It includes all parameters (query, path) and request body types as defined in the OpenAPI specification.
2381
+ * Use this type to ensure type safety when making API requests to this endpoint.
2382
+ *
2383
+ * @example
2384
+ * Use this type to ensure type safety when making API requests to this endpoint.
2385
+ *
2386
+ * @path /v1/notifications/{notification_id}/read
2387
+ *
2388
+ * @see {@link PATCH_NotificationsNotificationIdRead_V1_Request_Parameters_Query} - Query parameters type
2389
+ * @see {@link PATCH_NotificationsNotificationIdRead_V1_Request_Parameters_Path} - Path parameters type
2390
+ * @see {@link PATCH_NotificationsNotificationIdRead_V1_Request_RequestBody} - Request body type
2391
+ */
2392
+ export type PATCH_NotificationsNotificationIdRead_V1_Request = {
2393
+ parameters: {
2394
+ path: operations['update_notification_read_v1_notifications__notification_id__read_patch']['parameters']['path'];
2395
+ };
2396
+ }
2397
+ /**
2398
+ * Path parameters for PATCH /v1/notifications/{notification_id}/read
2399
+ *
2400
+ * @remarks
2401
+ * This type defines the path parameters for the PATCH /v1/notifications/{notification_id}/read endpoint.
2402
+ * It provides type safety for all path parameters as defined in the OpenAPI specification.
2403
+ *
2404
+ * @example
2405
+ * Use this type to ensure type safety for path parameters.
2406
+ *
2407
+ * @path /v1/notifications/{notification_id}/read
2408
+ */
2409
+ export type PATCH_NotificationsNotificationIdRead_V1_Request_Parameters_Path = PATCH_NotificationsNotificationIdRead_V1_Request['parameters']['path'];
2410
+
2411
+ /**
2412
+ * Request type for GET Organizations endpoint
2413
+ *
2414
+ * List Organizations
2415
+ *
2416
+ * @remarks
2417
+ * This type defines the complete request structure for the GET Organizations endpoint.
2418
+ * It includes all parameters (query, path) and request body types as defined in the OpenAPI specification.
2419
+ * Use this type to ensure type safety when making API requests to this endpoint.
2420
+ *
2421
+ * @example
2422
+ * Use this type to ensure type safety when making API requests to this endpoint.
2423
+ *
2424
+ * @path /v1/organizations
2425
+ *
2426
+ * @see {@link GET_Organizations_V1_Request_Parameters_Query} - Query parameters type
2427
+ * @see {@link GET_Organizations_V1_Request_Parameters_Path} - Path parameters type
2428
+ * @see {@link GET_Organizations_V1_Request_RequestBody} - Request body type
2429
+ */
2430
+ export type GET_Organizations_V1_Request = {
2431
+ parameters: {
2432
+ query: operations['list_organizations_v1_organizations_get']['parameters']['query'];
2433
+ };
2434
+ }
2435
+ /**
2436
+ * Query parameters for GET /v1/organizations
2437
+ *
2438
+ * @remarks
2439
+ * This type defines the query parameters for the GET /v1/organizations endpoint.
2440
+ * It provides type safety for all query parameters as defined in the OpenAPI specification.
2441
+ *
2442
+ * @example
2443
+ * Use this type to ensure type safety for query parameters.
2444
+ *
2445
+ * @path /v1/organizations
2446
+ */
2447
+ export type GET_Organizations_V1_Request_Parameters_Query = GET_Organizations_V1_Request['parameters']['query'];
2448
+
2449
+ /**
2450
+ * Request type for POST Organizations endpoint
2451
+ *
2452
+ * Create Organization
2453
+ *
2454
+ * @remarks
2455
+ * This type defines the complete request structure for the POST Organizations endpoint.
2456
+ * It includes all parameters (query, path) and request body types as defined in the OpenAPI specification.
2457
+ * Use this type to ensure type safety when making API requests to this endpoint.
2458
+ *
2459
+ * @example
2460
+ * Use this type to ensure type safety when making API requests to this endpoint.
2461
+ *
2462
+ * @path /v1/organizations
2463
+ *
2464
+ * @see {@link POST_Organizations_V1_Request_Parameters_Query} - Query parameters type
2465
+ * @see {@link POST_Organizations_V1_Request_Parameters_Path} - Path parameters type
2466
+ * @see {@link POST_Organizations_V1_Request_RequestBody} - Request body type
2467
+ */
2468
+ export type POST_Organizations_V1_Request = {
2469
+ requestBody: OrganizationCreate;
2470
+ }
2471
+ /**
2472
+ * Request body for POST /v1/organizations
2473
+ *
2474
+ * @remarks
2475
+ * This type defines the request body structure for the POST /v1/organizations endpoint.
2476
+ * It provides type safety for the request body as defined in the OpenAPI specification.
2477
+ *
2478
+ * @example
2479
+ * Use this type to ensure type safety for request body structure.
2480
+ *
2481
+ * @path /v1/organizations
2482
+ */
2483
+ export type POST_Organizations_V1_Request_RequestBody = POST_Organizations_V1_Request['requestBody'];
2484
+
2485
+ /**
2486
+ * Request type for GET OrganizationsAttributes endpoint
2487
+ *
2488
+ * Get Attributes
2489
+ *
2490
+ * @remarks
2491
+ * This type defines the complete request structure for the GET OrganizationsAttributes endpoint.
2492
+ * It includes all parameters (query, path) and request body types as defined in the OpenAPI specification.
2493
+ * Use this type to ensure type safety when making API requests to this endpoint.
2494
+ *
2495
+ * @example
2496
+ * Use this type to ensure type safety when making API requests to this endpoint.
2497
+ *
2498
+ * @path /v1/organizations/attributes
2499
+ * @param keys (query) - Optional list of attribute keys to filter
2500
+ *
2501
+ * @see {@link GET_OrganizationsAttributes_V1_Request_Parameters_Query} - Query parameters type
2502
+ * @see {@link GET_OrganizationsAttributes_V1_Request_Parameters_Path} - Path parameters type
2503
+ * @see {@link GET_OrganizationsAttributes_V1_Request_RequestBody} - Request body type
2504
+ */
2505
+ export type GET_OrganizationsAttributes_V1_Request = {
2506
+ parameters: {
2507
+ query: operations['get_attributes_v1_organizations_attributes_get']['parameters']['query'];
2508
+ };
2509
+ }
2510
+ /**
2511
+ * Query parameters for GET /v1/organizations/attributes
2512
+ *
2513
+ * @remarks
2514
+ * This type defines the query parameters for the GET /v1/organizations/attributes endpoint.
2515
+ * It provides type safety for all query parameters as defined in the OpenAPI specification.
2516
+ *
2517
+ * @example
2518
+ * Use this type to ensure type safety for query parameters.
2519
+ *
2520
+ * @path /v1/organizations/attributes
2521
+ * @param keys (query) - Optional list of attribute keys to filter
2522
+ */
2523
+ export type GET_OrganizationsAttributes_V1_Request_Parameters_Query = GET_OrganizationsAttributes_V1_Request['parameters']['query'];
2524
+
2525
+ /**
2526
+ * Request type for PATCH OrganizationsAttributes endpoint
2527
+ *
2528
+ * Update Attributes
2529
+ *
2530
+ * @remarks
2531
+ * This type defines the complete request structure for the PATCH OrganizationsAttributes endpoint.
2532
+ * It includes all parameters (query, path) and request body types as defined in the OpenAPI specification.
2533
+ * Use this type to ensure type safety when making API requests to this endpoint.
2534
+ *
2535
+ * @example
2536
+ * Use this type to ensure type safety when making API requests to this endpoint.
2537
+ *
2538
+ * @path /v1/organizations/attributes
2539
+ *
2540
+ * @see {@link PATCH_OrganizationsAttributes_V1_Request_Parameters_Query} - Query parameters type
2541
+ * @see {@link PATCH_OrganizationsAttributes_V1_Request_Parameters_Path} - Path parameters type
2542
+ * @see {@link PATCH_OrganizationsAttributes_V1_Request_RequestBody} - Request body type
2543
+ */
2544
+ export type PATCH_OrganizationsAttributes_V1_Request = {
2545
+ parameters: {
2546
+ query: operations['update_attributes_v1_organizations_attributes_patch']['parameters']['query'];
2547
+ };
2548
+ requestBody: OrganizationAttributeUpdateArray;
2549
+ }
2550
+ /**
2551
+ * Query parameters for PATCH /v1/organizations/attributes
2552
+ *
2553
+ * @remarks
2554
+ * This type defines the query parameters for the PATCH /v1/organizations/attributes endpoint.
2555
+ * It provides type safety for all query parameters as defined in the OpenAPI specification.
2556
+ *
2557
+ * @example
2558
+ * Use this type to ensure type safety for query parameters.
2559
+ *
2560
+ * @path /v1/organizations/attributes
2561
+ */
2562
+ export type PATCH_OrganizationsAttributes_V1_Request_Parameters_Query = PATCH_OrganizationsAttributes_V1_Request['parameters']['query'];
2563
+ /**
2564
+ * Request body for PATCH /v1/organizations/attributes
2565
+ *
2566
+ * @remarks
2567
+ * This type defines the request body structure for the PATCH /v1/organizations/attributes endpoint.
2568
+ * It provides type safety for the request body as defined in the OpenAPI specification.
2569
+ *
2570
+ * @example
2571
+ * Use this type to ensure type safety for request body structure.
2572
+ *
2573
+ * @path /v1/organizations/attributes
2574
+ */
2575
+ export type PATCH_OrganizationsAttributes_V1_Request_RequestBody = PATCH_OrganizationsAttributes_V1_Request['requestBody'];
2576
+
2577
+ /**
2578
+ * Request type for GET OrganizationsAttributesOrganizationId endpoint
2579
+ *
2580
+ * Get Attributes
2581
+ *
2582
+ * @remarks
2583
+ * This type defines the complete request structure for the GET OrganizationsAttributesOrganizationId endpoint.
2584
+ * It includes all parameters (query, path) and request body types as defined in the OpenAPI specification.
2585
+ * Use this type to ensure type safety when making API requests to this endpoint.
2586
+ *
2587
+ * @example
2588
+ * Use this type to ensure type safety when making API requests to this endpoint.
2589
+ *
2590
+ * @path /v1/organizations/attributes/{organization_id}
2591
+ * @param keys (query) - Optional list of attribute keys to filter
2592
+ *
2593
+ * @see {@link GET_OrganizationsAttributesOrganizationId_V1_Request_Parameters_Query} - Query parameters type
2594
+ * @see {@link GET_OrganizationsAttributesOrganizationId_V1_Request_Parameters_Path} - Path parameters type
2595
+ * @see {@link GET_OrganizationsAttributesOrganizationId_V1_Request_RequestBody} - Request body type
2596
+ */
2597
+ export type GET_OrganizationsAttributesOrganizationId_V1_Request = {
2598
+ parameters: {
2599
+ query: operations['get_attributes_v1_organizations_attributes__organization_id__get']['parameters']['query'];
2600
+ path: operations['get_attributes_v1_organizations_attributes__organization_id__get']['parameters']['path'];
2601
+ };
2602
+ }
2603
+ /**
2604
+ * Query parameters for GET /v1/organizations/attributes/{organization_id}
2605
+ *
2606
+ * @remarks
2607
+ * This type defines the query parameters for the GET /v1/organizations/attributes/{organization_id} endpoint.
2608
+ * It provides type safety for all query parameters as defined in the OpenAPI specification.
2609
+ *
2610
+ * @example
2611
+ * Use this type to ensure type safety for query parameters.
2612
+ *
2613
+ * @path /v1/organizations/attributes/{organization_id}
2614
+ * @param keys (query) - Optional list of attribute keys to filter
2615
+ */
2616
+ export type GET_OrganizationsAttributesOrganizationId_V1_Request_Parameters_Query = GET_OrganizationsAttributesOrganizationId_V1_Request['parameters']['query'];
2617
+ /**
2618
+ * Path parameters for GET /v1/organizations/attributes/{organization_id}
2619
+ *
2620
+ * @remarks
2621
+ * This type defines the path parameters for the GET /v1/organizations/attributes/{organization_id} endpoint.
2622
+ * It provides type safety for all path parameters as defined in the OpenAPI specification.
2623
+ *
2624
+ * @example
2625
+ * Use this type to ensure type safety for path parameters.
2626
+ *
2627
+ * @path /v1/organizations/attributes/{organization_id}
2628
+ */
2629
+ export type GET_OrganizationsAttributesOrganizationId_V1_Request_Parameters_Path = GET_OrganizationsAttributesOrganizationId_V1_Request['parameters']['path'];
2630
+
2631
+ /**
2632
+ * Request type for PATCH OrganizationsAttributesOrganizationId endpoint
2633
+ *
2634
+ * Update Attributes
2635
+ *
2636
+ * @remarks
2637
+ * This type defines the complete request structure for the PATCH OrganizationsAttributesOrganizationId endpoint.
2638
+ * It includes all parameters (query, path) and request body types as defined in the OpenAPI specification.
2639
+ * Use this type to ensure type safety when making API requests to this endpoint.
2640
+ *
2641
+ * @example
2642
+ * Use this type to ensure type safety when making API requests to this endpoint.
2643
+ *
2644
+ * @path /v1/organizations/attributes/{organization_id}
2645
+ *
2646
+ * @see {@link PATCH_OrganizationsAttributesOrganizationId_V1_Request_Parameters_Query} - Query parameters type
2647
+ * @see {@link PATCH_OrganizationsAttributesOrganizationId_V1_Request_Parameters_Path} - Path parameters type
2648
+ * @see {@link PATCH_OrganizationsAttributesOrganizationId_V1_Request_RequestBody} - Request body type
2649
+ */
2650
+ export type PATCH_OrganizationsAttributesOrganizationId_V1_Request = {
2651
+ parameters: {
2652
+ path: operations['update_attributes_v1_organizations_attributes__organization_id__patch']['parameters']['path'];
2653
+ };
2654
+ requestBody: OrganizationAttributeUpdateArray;
2655
+ }
2656
+ /**
2657
+ * Path parameters for PATCH /v1/organizations/attributes/{organization_id}
2658
+ *
2659
+ * @remarks
2660
+ * This type defines the path parameters for the PATCH /v1/organizations/attributes/{organization_id} endpoint.
2661
+ * It provides type safety for all path parameters as defined in the OpenAPI specification.
2662
+ *
2663
+ * @example
2664
+ * Use this type to ensure type safety for path parameters.
2665
+ *
2666
+ * @path /v1/organizations/attributes/{organization_id}
2667
+ */
2668
+ export type PATCH_OrganizationsAttributesOrganizationId_V1_Request_Parameters_Path = PATCH_OrganizationsAttributesOrganizationId_V1_Request['parameters']['path'];
2669
+ /**
2670
+ * Request body for PATCH /v1/organizations/attributes/{organization_id}
2671
+ *
2672
+ * @remarks
2673
+ * This type defines the request body structure for the PATCH /v1/organizations/attributes/{organization_id} endpoint.
2674
+ * It provides type safety for the request body as defined in the OpenAPI specification.
2675
+ *
2676
+ * @example
2677
+ * Use this type to ensure type safety for request body structure.
2678
+ *
2679
+ * @path /v1/organizations/attributes/{organization_id}
2680
+ */
2681
+ export type PATCH_OrganizationsAttributesOrganizationId_V1_Request_RequestBody = PATCH_OrganizationsAttributesOrganizationId_V1_Request['requestBody'];
2682
+
2683
+ /**
2684
+ * Request type for GET OrganizationsIpRestrictions endpoint
2685
+ *
2686
+ * List Ip Restrictions
2687
+ * Get all IP restrictions for the organization
2688
+ *
2689
+ * @remarks
2690
+ * This type defines the complete request structure for the GET OrganizationsIpRestrictions endpoint.
2691
+ * It includes all parameters (query, path) and request body types as defined in the OpenAPI specification.
2692
+ * Use this type to ensure type safety when making API requests to this endpoint.
2693
+ *
2694
+ * @example
2695
+ * Use this type to ensure type safety when making API requests to this endpoint.
2696
+ *
2697
+ * @path /v1/organizations/ip-restrictions
2698
+ *
2699
+ * @see {@link GET_OrganizationsIpRestrictions_V1_Request_Parameters_Query} - Query parameters type
2700
+ * @see {@link GET_OrganizationsIpRestrictions_V1_Request_Parameters_Path} - Path parameters type
2701
+ * @see {@link GET_OrganizationsIpRestrictions_V1_Request_RequestBody} - Request body type
2702
+ */
2703
+ export type GET_OrganizationsIpRestrictions_V1_Request = {
2704
+ }
2705
+
2706
+ /**
2707
+ * Request type for POST OrganizationsIpRestrictions endpoint
2708
+ *
2709
+ * Create Ip Restriction
2710
+ * Create a new IP restriction for the organization
2711
+ *
2712
+ * @remarks
2713
+ * This type defines the complete request structure for the POST OrganizationsIpRestrictions endpoint.
2714
+ * It includes all parameters (query, path) and request body types as defined in the OpenAPI specification.
2715
+ * Use this type to ensure type safety when making API requests to this endpoint.
2716
+ *
2717
+ * @example
2718
+ * Use this type to ensure type safety when making API requests to this endpoint.
2719
+ *
2720
+ * @path /v1/organizations/ip-restrictions
2721
+ *
2722
+ * @see {@link POST_OrganizationsIpRestrictions_V1_Request_Parameters_Query} - Query parameters type
2723
+ * @see {@link POST_OrganizationsIpRestrictions_V1_Request_Parameters_Path} - Path parameters type
2724
+ * @see {@link POST_OrganizationsIpRestrictions_V1_Request_RequestBody} - Request body type
2725
+ */
2726
+ export type POST_OrganizationsIpRestrictions_V1_Request = {
2727
+ requestBody: IpRestrictionCreate;
2728
+ }
2729
+ /**
2730
+ * Request body for POST /v1/organizations/ip-restrictions
2731
+ *
2732
+ * @remarks
2733
+ * This type defines the request body structure for the POST /v1/organizations/ip-restrictions endpoint.
2734
+ * It provides type safety for the request body as defined in the OpenAPI specification.
2735
+ *
2736
+ * @example
2737
+ * Use this type to ensure type safety for request body structure.
2738
+ *
2739
+ * @path /v1/organizations/ip-restrictions
2740
+ */
2741
+ export type POST_OrganizationsIpRestrictions_V1_Request_RequestBody = POST_OrganizationsIpRestrictions_V1_Request['requestBody'];
2742
+
2743
+ /**
2744
+ * Request type for DELETE OrganizationsIpRestrictionsIpRestrictionId endpoint
2745
+ *
2746
+ * Delete Ip Restriction
2747
+ * Delete an IP restriction
2748
+ *
2749
+ * @remarks
2750
+ * This type defines the complete request structure for the DELETE OrganizationsIpRestrictionsIpRestrictionId endpoint.
2751
+ * It includes all parameters (query, path) and request body types as defined in the OpenAPI specification.
2752
+ * Use this type to ensure type safety when making API requests to this endpoint.
2753
+ *
2754
+ * @example
2755
+ * Use this type to ensure type safety when making API requests to this endpoint.
2756
+ *
2757
+ * @path /v1/organizations/ip-restrictions/{ip_restriction_id}
2758
+ *
2759
+ * @see {@link DELETE_OrganizationsIpRestrictionsIpRestrictionId_V1_Request_Parameters_Query} - Query parameters type
2760
+ * @see {@link DELETE_OrganizationsIpRestrictionsIpRestrictionId_V1_Request_Parameters_Path} - Path parameters type
2761
+ * @see {@link DELETE_OrganizationsIpRestrictionsIpRestrictionId_V1_Request_RequestBody} - Request body type
2762
+ */
2763
+ export type DELETE_OrganizationsIpRestrictionsIpRestrictionId_V1_Request = {
2764
+ parameters: {
2765
+ path: operations['delete_ip_restriction_v1_organizations_ip_restrictions__ip_restriction_id__delete']['parameters']['path'];
2766
+ };
2767
+ }
2768
+ /**
2769
+ * Path parameters for DELETE /v1/organizations/ip-restrictions/{ip_restriction_id}
2770
+ *
2771
+ * @remarks
2772
+ * This type defines the path parameters for the DELETE /v1/organizations/ip-restrictions/{ip_restriction_id} endpoint.
2773
+ * It provides type safety for all path parameters as defined in the OpenAPI specification.
2774
+ *
2775
+ * @example
2776
+ * Use this type to ensure type safety for path parameters.
2777
+ *
2778
+ * @path /v1/organizations/ip-restrictions/{ip_restriction_id}
2779
+ */
2780
+ export type DELETE_OrganizationsIpRestrictionsIpRestrictionId_V1_Request_Parameters_Path = DELETE_OrganizationsIpRestrictionsIpRestrictionId_V1_Request['parameters']['path'];
2781
+
2782
+ /**
2783
+ * Request type for GET OrganizationsIpRestrictionsIpRestrictionId endpoint
2784
+ *
2785
+ * Get Ip Restriction
2786
+ * Get a specific IP restriction by ID
2787
+ *
2788
+ * @remarks
2789
+ * This type defines the complete request structure for the GET OrganizationsIpRestrictionsIpRestrictionId endpoint.
2790
+ * It includes all parameters (query, path) and request body types as defined in the OpenAPI specification.
2791
+ * Use this type to ensure type safety when making API requests to this endpoint.
2792
+ *
2793
+ * @example
2794
+ * Use this type to ensure type safety when making API requests to this endpoint.
2795
+ *
2796
+ * @path /v1/organizations/ip-restrictions/{ip_restriction_id}
2797
+ *
2798
+ * @see {@link GET_OrganizationsIpRestrictionsIpRestrictionId_V1_Request_Parameters_Query} - Query parameters type
2799
+ * @see {@link GET_OrganizationsIpRestrictionsIpRestrictionId_V1_Request_Parameters_Path} - Path parameters type
2800
+ * @see {@link GET_OrganizationsIpRestrictionsIpRestrictionId_V1_Request_RequestBody} - Request body type
2801
+ */
2802
+ export type GET_OrganizationsIpRestrictionsIpRestrictionId_V1_Request = {
2803
+ parameters: {
2804
+ path: operations['get_ip_restriction_v1_organizations_ip_restrictions__ip_restriction_id__get']['parameters']['path'];
2805
+ };
2806
+ }
2807
+ /**
2808
+ * Path parameters for GET /v1/organizations/ip-restrictions/{ip_restriction_id}
2809
+ *
2810
+ * @remarks
2811
+ * This type defines the path parameters for the GET /v1/organizations/ip-restrictions/{ip_restriction_id} endpoint.
2812
+ * It provides type safety for all path parameters as defined in the OpenAPI specification.
2813
+ *
2814
+ * @example
2815
+ * Use this type to ensure type safety for path parameters.
2816
+ *
2817
+ * @path /v1/organizations/ip-restrictions/{ip_restriction_id}
2818
+ */
2819
+ export type GET_OrganizationsIpRestrictionsIpRestrictionId_V1_Request_Parameters_Path = GET_OrganizationsIpRestrictionsIpRestrictionId_V1_Request['parameters']['path'];
2820
+
2821
+ /**
2822
+ * Request type for PATCH OrganizationsIpRestrictionsIpRestrictionId endpoint
2823
+ *
2824
+ * Update Ip Restriction
2825
+ * Update an IP restriction
2826
+ *
2827
+ * @remarks
2828
+ * This type defines the complete request structure for the PATCH OrganizationsIpRestrictionsIpRestrictionId endpoint.
2829
+ * It includes all parameters (query, path) and request body types as defined in the OpenAPI specification.
2830
+ * Use this type to ensure type safety when making API requests to this endpoint.
2831
+ *
2832
+ * @example
2833
+ * Use this type to ensure type safety when making API requests to this endpoint.
2834
+ *
2835
+ * @path /v1/organizations/ip-restrictions/{ip_restriction_id}
2836
+ *
2837
+ * @see {@link PATCH_OrganizationsIpRestrictionsIpRestrictionId_V1_Request_Parameters_Query} - Query parameters type
2838
+ * @see {@link PATCH_OrganizationsIpRestrictionsIpRestrictionId_V1_Request_Parameters_Path} - Path parameters type
2839
+ * @see {@link PATCH_OrganizationsIpRestrictionsIpRestrictionId_V1_Request_RequestBody} - Request body type
2840
+ */
2841
+ export type PATCH_OrganizationsIpRestrictionsIpRestrictionId_V1_Request = {
2842
+ parameters: {
2843
+ path: operations['update_ip_restriction_v1_organizations_ip_restrictions__ip_restriction_id__patch']['parameters']['path'];
2844
+ };
2845
+ requestBody: IpRestrictionUpdate;
2846
+ }
2847
+ /**
2848
+ * Path parameters for PATCH /v1/organizations/ip-restrictions/{ip_restriction_id}
2849
+ *
2850
+ * @remarks
2851
+ * This type defines the path parameters for the PATCH /v1/organizations/ip-restrictions/{ip_restriction_id} endpoint.
2852
+ * It provides type safety for all path parameters as defined in the OpenAPI specification.
2853
+ *
2854
+ * @example
2855
+ * Use this type to ensure type safety for path parameters.
2856
+ *
2857
+ * @path /v1/organizations/ip-restrictions/{ip_restriction_id}
2858
+ */
2859
+ export type PATCH_OrganizationsIpRestrictionsIpRestrictionId_V1_Request_Parameters_Path = PATCH_OrganizationsIpRestrictionsIpRestrictionId_V1_Request['parameters']['path'];
2860
+ /**
2861
+ * Request body for PATCH /v1/organizations/ip-restrictions/{ip_restriction_id}
2862
+ *
2863
+ * @remarks
2864
+ * This type defines the request body structure for the PATCH /v1/organizations/ip-restrictions/{ip_restriction_id} endpoint.
2865
+ * It provides type safety for the request body as defined in the OpenAPI specification.
2866
+ *
2867
+ * @example
2868
+ * Use this type to ensure type safety for request body structure.
2869
+ *
2870
+ * @path /v1/organizations/ip-restrictions/{ip_restriction_id}
2871
+ */
2872
+ export type PATCH_OrganizationsIpRestrictionsIpRestrictionId_V1_Request_RequestBody = PATCH_OrganizationsIpRestrictionsIpRestrictionId_V1_Request['requestBody'];
2873
+
2874
+ /**
2875
+ * Request type for DELETE OrganizationsOrganizationId endpoint
2876
+ *
2877
+ * Delete User
2878
+ *
2879
+ * @remarks
2880
+ * This type defines the complete request structure for the DELETE OrganizationsOrganizationId endpoint.
2881
+ * It includes all parameters (query, path) and request body types as defined in the OpenAPI specification.
2882
+ * Use this type to ensure type safety when making API requests to this endpoint.
2883
+ *
2884
+ * @example
2885
+ * Use this type to ensure type safety when making API requests to this endpoint.
2886
+ *
2887
+ * @path /v1/organizations/{organization_id}
2888
+ *
2889
+ * @see {@link DELETE_OrganizationsOrganizationId_V1_Request_Parameters_Query} - Query parameters type
2890
+ * @see {@link DELETE_OrganizationsOrganizationId_V1_Request_Parameters_Path} - Path parameters type
2891
+ * @see {@link DELETE_OrganizationsOrganizationId_V1_Request_RequestBody} - Request body type
2892
+ */
2893
+ export type DELETE_OrganizationsOrganizationId_V1_Request = {
2894
+ parameters: {
2895
+ path: operations['delete_user_v1_organizations__organization_id__delete']['parameters']['path'];
2896
+ };
2897
+ }
2898
+ /**
2899
+ * Path parameters for DELETE /v1/organizations/{organization_id}
2900
+ *
2901
+ * @remarks
2902
+ * This type defines the path parameters for the DELETE /v1/organizations/{organization_id} endpoint.
2903
+ * It provides type safety for all path parameters as defined in the OpenAPI specification.
2904
+ *
2905
+ * @example
2906
+ * Use this type to ensure type safety for path parameters.
2907
+ *
2908
+ * @path /v1/organizations/{organization_id}
2909
+ */
2910
+ export type DELETE_OrganizationsOrganizationId_V1_Request_Parameters_Path = DELETE_OrganizationsOrganizationId_V1_Request['parameters']['path'];
2911
+
2912
+ /**
2913
+ * Request type for GET OrganizationsOrganizationId endpoint
2914
+ *
2915
+ * Get Organization
2916
+ *
2917
+ * @remarks
2918
+ * This type defines the complete request structure for the GET OrganizationsOrganizationId endpoint.
2919
+ * It includes all parameters (query, path) and request body types as defined in the OpenAPI specification.
2920
+ * Use this type to ensure type safety when making API requests to this endpoint.
2921
+ *
2922
+ * @example
2923
+ * Use this type to ensure type safety when making API requests to this endpoint.
2924
+ *
2925
+ * @path /v1/organizations/{organization_id}
2926
+ *
2927
+ * @see {@link GET_OrganizationsOrganizationId_V1_Request_Parameters_Query} - Query parameters type
2928
+ * @see {@link GET_OrganizationsOrganizationId_V1_Request_Parameters_Path} - Path parameters type
2929
+ * @see {@link GET_OrganizationsOrganizationId_V1_Request_RequestBody} - Request body type
2930
+ */
2931
+ export type GET_OrganizationsOrganizationId_V1_Request = {
2932
+ parameters: {
2933
+ path: operations['get_organization_v1_organizations__organization_id__get']['parameters']['path'];
2934
+ };
2935
+ }
2936
+ /**
2937
+ * Path parameters for GET /v1/organizations/{organization_id}
2938
+ *
2939
+ * @remarks
2940
+ * This type defines the path parameters for the GET /v1/organizations/{organization_id} endpoint.
2941
+ * It provides type safety for all path parameters as defined in the OpenAPI specification.
2942
+ *
2943
+ * @example
2944
+ * Use this type to ensure type safety for path parameters.
2945
+ *
2946
+ * @path /v1/organizations/{organization_id}
2947
+ */
2948
+ export type GET_OrganizationsOrganizationId_V1_Request_Parameters_Path = GET_OrganizationsOrganizationId_V1_Request['parameters']['path'];
2949
+
2950
+ /**
2951
+ * Request type for PATCH OrganizationsOrganizationId endpoint
2952
+ *
2953
+ * Update Organization
2954
+ *
2955
+ * @remarks
2956
+ * This type defines the complete request structure for the PATCH OrganizationsOrganizationId endpoint.
2957
+ * It includes all parameters (query, path) and request body types as defined in the OpenAPI specification.
2958
+ * Use this type to ensure type safety when making API requests to this endpoint.
2959
+ *
2960
+ * @example
2961
+ * Use this type to ensure type safety when making API requests to this endpoint.
2962
+ *
2963
+ * @path /v1/organizations/{organization_id}
2964
+ *
2965
+ * @see {@link PATCH_OrganizationsOrganizationId_V1_Request_Parameters_Query} - Query parameters type
2966
+ * @see {@link PATCH_OrganizationsOrganizationId_V1_Request_Parameters_Path} - Path parameters type
2967
+ * @see {@link PATCH_OrganizationsOrganizationId_V1_Request_RequestBody} - Request body type
2968
+ */
2969
+ export type PATCH_OrganizationsOrganizationId_V1_Request = {
2970
+ parameters: {
2971
+ path: operations['update_organization_v1_organizations__organization_id__patch']['parameters']['path'];
2972
+ };
2973
+ requestBody: OrganizationUpdate;
2974
+ }
2975
+ /**
2976
+ * Path parameters for PATCH /v1/organizations/{organization_id}
2977
+ *
2978
+ * @remarks
2979
+ * This type defines the path parameters for the PATCH /v1/organizations/{organization_id} endpoint.
2980
+ * It provides type safety for all path parameters as defined in the OpenAPI specification.
2981
+ *
2982
+ * @example
2983
+ * Use this type to ensure type safety for path parameters.
2984
+ *
2985
+ * @path /v1/organizations/{organization_id}
2986
+ */
2987
+ export type PATCH_OrganizationsOrganizationId_V1_Request_Parameters_Path = PATCH_OrganizationsOrganizationId_V1_Request['parameters']['path'];
2988
+ /**
2989
+ * Request body for PATCH /v1/organizations/{organization_id}
2990
+ *
2991
+ * @remarks
2992
+ * This type defines the request body structure for the PATCH /v1/organizations/{organization_id} endpoint.
2993
+ * It provides type safety for the request body as defined in the OpenAPI specification.
2994
+ *
2995
+ * @example
2996
+ * Use this type to ensure type safety for request body structure.
2997
+ *
2998
+ * @path /v1/organizations/{organization_id}
2999
+ */
3000
+ export type PATCH_OrganizationsOrganizationId_V1_Request_RequestBody = PATCH_OrganizationsOrganizationId_V1_Request['requestBody'];
3001
+
3002
+ /**
3003
+ * Request type for PATCH OrganizationsOrganizationIdPlan endpoint
3004
+ *
3005
+ * Change Plan
3006
+ *
3007
+ * @remarks
3008
+ * This type defines the complete request structure for the PATCH OrganizationsOrganizationIdPlan endpoint.
3009
+ * It includes all parameters (query, path) and request body types as defined in the OpenAPI specification.
3010
+ * Use this type to ensure type safety when making API requests to this endpoint.
3011
+ *
3012
+ * @example
3013
+ * Use this type to ensure type safety when making API requests to this endpoint.
3014
+ *
3015
+ * @path /v1/organizations/{organization_id}/plan
3016
+ *
3017
+ * @see {@link PATCH_OrganizationsOrganizationIdPlan_V1_Request_Parameters_Query} - Query parameters type
3018
+ * @see {@link PATCH_OrganizationsOrganizationIdPlan_V1_Request_Parameters_Path} - Path parameters type
3019
+ * @see {@link PATCH_OrganizationsOrganizationIdPlan_V1_Request_RequestBody} - Request body type
3020
+ */
3021
+ export type PATCH_OrganizationsOrganizationIdPlan_V1_Request = {
3022
+ parameters: {
3023
+ path: operations['change_plan_v1_organizations__organization_id__plan_patch']['parameters']['path'];
3024
+ };
3025
+ requestBody: PlanUpdate;
3026
+ }
3027
+ /**
3028
+ * Path parameters for PATCH /v1/organizations/{organization_id}/plan
3029
+ *
3030
+ * @remarks
3031
+ * This type defines the path parameters for the PATCH /v1/organizations/{organization_id}/plan endpoint.
3032
+ * It provides type safety for all path parameters as defined in the OpenAPI specification.
3033
+ *
3034
+ * @example
3035
+ * Use this type to ensure type safety for path parameters.
3036
+ *
3037
+ * @path /v1/organizations/{organization_id}/plan
3038
+ */
3039
+ export type PATCH_OrganizationsOrganizationIdPlan_V1_Request_Parameters_Path = PATCH_OrganizationsOrganizationIdPlan_V1_Request['parameters']['path'];
3040
+ /**
3041
+ * Request body for PATCH /v1/organizations/{organization_id}/plan
3042
+ *
3043
+ * @remarks
3044
+ * This type defines the request body structure for the PATCH /v1/organizations/{organization_id}/plan endpoint.
3045
+ * It provides type safety for the request body as defined in the OpenAPI specification.
3046
+ *
3047
+ * @example
3048
+ * Use this type to ensure type safety for request body structure.
3049
+ *
3050
+ * @path /v1/organizations/{organization_id}/plan
3051
+ */
3052
+ export type PATCH_OrganizationsOrganizationIdPlan_V1_Request_RequestBody = PATCH_OrganizationsOrganizationIdPlan_V1_Request['requestBody'];
3053
+
3054
+ /**
3055
+ * Request type for GET OrganizationsRoles endpoint
3056
+ *
3057
+ * List Roles
3058
+ *
3059
+ * @remarks
3060
+ * This type defines the complete request structure for the GET OrganizationsRoles endpoint.
3061
+ * It includes all parameters (query, path) and request body types as defined in the OpenAPI specification.
3062
+ * Use this type to ensure type safety when making API requests to this endpoint.
3063
+ *
3064
+ * @example
3065
+ * Use this type to ensure type safety when making API requests to this endpoint.
3066
+ *
3067
+ * @path /v1/organizations/roles
3068
+ *
3069
+ * @see {@link GET_OrganizationsRoles_V1_Request_Parameters_Query} - Query parameters type
3070
+ * @see {@link GET_OrganizationsRoles_V1_Request_Parameters_Path} - Path parameters type
3071
+ * @see {@link GET_OrganizationsRoles_V1_Request_RequestBody} - Request body type
3072
+ */
3073
+ export type GET_OrganizationsRoles_V1_Request = {
3074
+ }
3075
+
3076
+ /**
3077
+ * Request type for GET OrganizationsUsers endpoint
3078
+ *
3079
+ * List Users
3080
+ *
3081
+ * @remarks
3082
+ * This type defines the complete request structure for the GET OrganizationsUsers endpoint.
3083
+ * It includes all parameters (query, path) and request body types as defined in the OpenAPI specification.
3084
+ * Use this type to ensure type safety when making API requests to this endpoint.
3085
+ *
3086
+ * @example
3087
+ * Use this type to ensure type safety when making API requests to this endpoint.
3088
+ *
3089
+ * @path /v1/organizations/users
3090
+ *
3091
+ * @see {@link GET_OrganizationsUsers_V1_Request_Parameters_Query} - Query parameters type
3092
+ * @see {@link GET_OrganizationsUsers_V1_Request_Parameters_Path} - Path parameters type
3093
+ * @see {@link GET_OrganizationsUsers_V1_Request_RequestBody} - Request body type
3094
+ */
3095
+ export type GET_OrganizationsUsers_V1_Request = {
3096
+ parameters: {
3097
+ query: operations['list_users_v1_organizations_users_get']['parameters']['query'];
3098
+ };
3099
+ }
3100
+ /**
3101
+ * Query parameters for GET /v1/organizations/users
3102
+ *
3103
+ * @remarks
3104
+ * This type defines the query parameters for the GET /v1/organizations/users endpoint.
3105
+ * It provides type safety for all query parameters as defined in the OpenAPI specification.
3106
+ *
3107
+ * @example
3108
+ * Use this type to ensure type safety for query parameters.
3109
+ *
3110
+ * @path /v1/organizations/users
3111
+ */
3112
+ export type GET_OrganizationsUsers_V1_Request_Parameters_Query = GET_OrganizationsUsers_V1_Request['parameters']['query'];
3113
+
3114
+ /**
3115
+ * Request type for POST Users endpoint
3116
+ *
3117
+ * Create User
3118
+ *
3119
+ * @remarks
3120
+ * This type defines the complete request structure for the POST Users endpoint.
3121
+ * It includes all parameters (query, path) and request body types as defined in the OpenAPI specification.
3122
+ * Use this type to ensure type safety when making API requests to this endpoint.
3123
+ *
3124
+ * @example
3125
+ * Use this type to ensure type safety when making API requests to this endpoint.
3126
+ *
3127
+ * @path /v1/users
3128
+ *
3129
+ * @see {@link POST_Users_V1_Request_Parameters_Query} - Query parameters type
3130
+ * @see {@link POST_Users_V1_Request_Parameters_Path} - Path parameters type
3131
+ * @see {@link POST_Users_V1_Request_RequestBody} - Request body type
3132
+ */
3133
+ export type POST_Users_V1_Request = {
3134
+ requestBody: UserCreate;
3135
+ }
3136
+ /**
3137
+ * Request body for POST /v1/users
3138
+ *
3139
+ * @remarks
3140
+ * This type defines the request body structure for the POST /v1/users endpoint.
3141
+ * It provides type safety for the request body as defined in the OpenAPI specification.
3142
+ *
3143
+ * @example
3144
+ * Use this type to ensure type safety for request body structure.
3145
+ *
3146
+ * @path /v1/users
3147
+ */
3148
+ export type POST_Users_V1_Request_RequestBody = POST_Users_V1_Request['requestBody'];
3149
+
3150
+ /**
3151
+ * Request type for POST UsersAcceptTos endpoint
3152
+ *
3153
+ * Tos Sign
3154
+ *
3155
+ * @remarks
3156
+ * This type defines the complete request structure for the POST UsersAcceptTos endpoint.
3157
+ * It includes all parameters (query, path) and request body types as defined in the OpenAPI specification.
3158
+ * Use this type to ensure type safety when making API requests to this endpoint.
3159
+ *
3160
+ * @example
3161
+ * Use this type to ensure type safety when making API requests to this endpoint.
3162
+ *
3163
+ * @path /v1/users/accept-tos
3164
+ *
3165
+ * @see {@link POST_UsersAcceptTos_V1_Request_Parameters_Query} - Query parameters type
3166
+ * @see {@link POST_UsersAcceptTos_V1_Request_Parameters_Path} - Path parameters type
3167
+ * @see {@link POST_UsersAcceptTos_V1_Request_RequestBody} - Request body type
3168
+ */
3169
+ export type POST_UsersAcceptTos_V1_Request = {
3170
+ requestBody: TermsOfServiceAccept;
3171
+ }
3172
+ /**
3173
+ * Request body for POST /v1/users/accept-tos
3174
+ *
3175
+ * @remarks
3176
+ * This type defines the request body structure for the POST /v1/users/accept-tos endpoint.
3177
+ * It provides type safety for the request body as defined in the OpenAPI specification.
3178
+ *
3179
+ * @example
3180
+ * Use this type to ensure type safety for request body structure.
3181
+ *
3182
+ * @path /v1/users/accept-tos
3183
+ */
3184
+ export type POST_UsersAcceptTos_V1_Request_RequestBody = POST_UsersAcceptTos_V1_Request['requestBody'];
3185
+
3186
+ /**
3187
+ * Request type for GET UsersMe endpoint
3188
+ *
3189
+ * Get Current User
3190
+ *
3191
+ * @remarks
3192
+ * This type defines the complete request structure for the GET UsersMe endpoint.
3193
+ * It includes all parameters (query, path) and request body types as defined in the OpenAPI specification.
3194
+ * Use this type to ensure type safety when making API requests to this endpoint.
3195
+ *
3196
+ * @example
3197
+ * Use this type to ensure type safety when making API requests to this endpoint.
3198
+ *
3199
+ * @path /v1/users/me
3200
+ *
3201
+ * @see {@link GET_UsersMe_V1_Request_Parameters_Query} - Query parameters type
3202
+ * @see {@link GET_UsersMe_V1_Request_Parameters_Path} - Path parameters type
3203
+ * @see {@link GET_UsersMe_V1_Request_RequestBody} - Request body type
3204
+ */
3205
+ export type GET_UsersMe_V1_Request = {
3206
+ parameters: {
3207
+ query: operations['get_current_user_v1_users_me_get']['parameters']['query'];
3208
+ };
3209
+ }
3210
+ /**
3211
+ * Query parameters for GET /v1/users/me
3212
+ *
3213
+ * @remarks
3214
+ * This type defines the query parameters for the GET /v1/users/me endpoint.
3215
+ * It provides type safety for all query parameters as defined in the OpenAPI specification.
3216
+ *
3217
+ * @example
3218
+ * Use this type to ensure type safety for query parameters.
3219
+ *
3220
+ * @path /v1/users/me
3221
+ */
3222
+ export type GET_UsersMe_V1_Request_Parameters_Query = GET_UsersMe_V1_Request['parameters']['query'];
3223
+
3224
+ /**
3225
+ * Request type for DELETE UsersUserId endpoint
3226
+ *
3227
+ * Delete User
3228
+ *
3229
+ * @remarks
3230
+ * This type defines the complete request structure for the DELETE UsersUserId endpoint.
3231
+ * It includes all parameters (query, path) and request body types as defined in the OpenAPI specification.
3232
+ * Use this type to ensure type safety when making API requests to this endpoint.
3233
+ *
3234
+ * @example
3235
+ * Use this type to ensure type safety when making API requests to this endpoint.
3236
+ *
3237
+ * @path /v1/users/{user_id}
3238
+ *
3239
+ * @see {@link DELETE_UsersUserId_V1_Request_Parameters_Query} - Query parameters type
3240
+ * @see {@link DELETE_UsersUserId_V1_Request_Parameters_Path} - Path parameters type
3241
+ * @see {@link DELETE_UsersUserId_V1_Request_RequestBody} - Request body type
3242
+ */
3243
+ export type DELETE_UsersUserId_V1_Request = {
3244
+ parameters: {
3245
+ path: operations['delete_user_v1_users__user_id__delete']['parameters']['path'];
3246
+ };
3247
+ }
3248
+ /**
3249
+ * Path parameters for DELETE /v1/users/{user_id}
3250
+ *
3251
+ * @remarks
3252
+ * This type defines the path parameters for the DELETE /v1/users/{user_id} endpoint.
3253
+ * It provides type safety for all path parameters as defined in the OpenAPI specification.
3254
+ *
3255
+ * @example
3256
+ * Use this type to ensure type safety for path parameters.
3257
+ *
3258
+ * @path /v1/users/{user_id}
3259
+ */
3260
+ export type DELETE_UsersUserId_V1_Request_Parameters_Path = DELETE_UsersUserId_V1_Request['parameters']['path'];
3261
+
3262
+ /**
3263
+ * Request type for GET UsersUserId endpoint
3264
+ *
3265
+ * Get User
3266
+ *
3267
+ * @remarks
3268
+ * This type defines the complete request structure for the GET UsersUserId endpoint.
3269
+ * It includes all parameters (query, path) and request body types as defined in the OpenAPI specification.
3270
+ * Use this type to ensure type safety when making API requests to this endpoint.
3271
+ *
3272
+ * @example
3273
+ * Use this type to ensure type safety when making API requests to this endpoint.
3274
+ *
3275
+ * @path /v1/users/{user_id}
3276
+ *
3277
+ * @see {@link GET_UsersUserId_V1_Request_Parameters_Query} - Query parameters type
3278
+ * @see {@link GET_UsersUserId_V1_Request_Parameters_Path} - Path parameters type
3279
+ * @see {@link GET_UsersUserId_V1_Request_RequestBody} - Request body type
3280
+ */
3281
+ export type GET_UsersUserId_V1_Request = {
3282
+ parameters: {
3283
+ query: operations['get_user_v1_users__user_id__get']['parameters']['query'];
3284
+ path: operations['get_user_v1_users__user_id__get']['parameters']['path'];
3285
+ };
3286
+ }
3287
+ /**
3288
+ * Query parameters for GET /v1/users/{user_id}
3289
+ *
3290
+ * @remarks
3291
+ * This type defines the query parameters for the GET /v1/users/{user_id} endpoint.
3292
+ * It provides type safety for all query parameters as defined in the OpenAPI specification.
3293
+ *
3294
+ * @example
3295
+ * Use this type to ensure type safety for query parameters.
3296
+ *
3297
+ * @path /v1/users/{user_id}
3298
+ */
3299
+ export type GET_UsersUserId_V1_Request_Parameters_Query = GET_UsersUserId_V1_Request['parameters']['query'];
3300
+ /**
3301
+ * Path parameters for GET /v1/users/{user_id}
3302
+ *
3303
+ * @remarks
3304
+ * This type defines the path parameters for the GET /v1/users/{user_id} endpoint.
3305
+ * It provides type safety for all path parameters as defined in the OpenAPI specification.
3306
+ *
3307
+ * @example
3308
+ * Use this type to ensure type safety for path parameters.
3309
+ *
3310
+ * @path /v1/users/{user_id}
3311
+ */
3312
+ export type GET_UsersUserId_V1_Request_Parameters_Path = GET_UsersUserId_V1_Request['parameters']['path'];
3313
+
3314
+ /**
3315
+ * Request type for PATCH UsersUserId endpoint
3316
+ *
3317
+ * Update User
3318
+ *
3319
+ * @remarks
3320
+ * This type defines the complete request structure for the PATCH UsersUserId endpoint.
3321
+ * It includes all parameters (query, path) and request body types as defined in the OpenAPI specification.
3322
+ * Use this type to ensure type safety when making API requests to this endpoint.
3323
+ *
3324
+ * @example
3325
+ * Use this type to ensure type safety when making API requests to this endpoint.
3326
+ *
3327
+ * @path /v1/users/{user_id}
3328
+ *
3329
+ * @see {@link PATCH_UsersUserId_V1_Request_Parameters_Query} - Query parameters type
3330
+ * @see {@link PATCH_UsersUserId_V1_Request_Parameters_Path} - Path parameters type
3331
+ * @see {@link PATCH_UsersUserId_V1_Request_RequestBody} - Request body type
3332
+ */
3333
+ export type PATCH_UsersUserId_V1_Request = {
3334
+ parameters: {
3335
+ path: operations['update_user_v1_users__user_id__patch']['parameters']['path'];
3336
+ };
3337
+ requestBody: UserUpdate;
3338
+ }
3339
+ /**
3340
+ * Path parameters for PATCH /v1/users/{user_id}
3341
+ *
3342
+ * @remarks
3343
+ * This type defines the path parameters for the PATCH /v1/users/{user_id} endpoint.
3344
+ * It provides type safety for all path parameters as defined in the OpenAPI specification.
3345
+ *
3346
+ * @example
3347
+ * Use this type to ensure type safety for path parameters.
3348
+ *
3349
+ * @path /v1/users/{user_id}
3350
+ */
3351
+ export type PATCH_UsersUserId_V1_Request_Parameters_Path = PATCH_UsersUserId_V1_Request['parameters']['path'];
3352
+ /**
3353
+ * Request body for PATCH /v1/users/{user_id}
3354
+ *
3355
+ * @remarks
3356
+ * This type defines the request body structure for the PATCH /v1/users/{user_id} endpoint.
3357
+ * It provides type safety for the request body as defined in the OpenAPI specification.
3358
+ *
3359
+ * @example
3360
+ * Use this type to ensure type safety for request body structure.
3361
+ *
3362
+ * @path /v1/users/{user_id}
3363
+ */
3364
+ export type PATCH_UsersUserId_V1_Request_RequestBody = PATCH_UsersUserId_V1_Request['requestBody'];
3365
+
3366
+ /**
3367
+ * Request type for GET UsersUserIdPermissions endpoint
3368
+ *
3369
+ * Get User Permissions
3370
+ *
3371
+ * @remarks
3372
+ * This type defines the complete request structure for the GET UsersUserIdPermissions endpoint.
3373
+ * It includes all parameters (query, path) and request body types as defined in the OpenAPI specification.
3374
+ * Use this type to ensure type safety when making API requests to this endpoint.
3375
+ *
3376
+ * @example
3377
+ * Use this type to ensure type safety when making API requests to this endpoint.
3378
+ *
3379
+ * @path /v1/users/{user_id}/permissions
3380
+ *
3381
+ * @see {@link GET_UsersUserIdPermissions_V1_Request_Parameters_Query} - Query parameters type
3382
+ * @see {@link GET_UsersUserIdPermissions_V1_Request_Parameters_Path} - Path parameters type
3383
+ * @see {@link GET_UsersUserIdPermissions_V1_Request_RequestBody} - Request body type
3384
+ */
3385
+ export type GET_UsersUserIdPermissions_V1_Request = {
3386
+ parameters: {
3387
+ path: operations['get_user_permissions_v1_users__user_id__permissions_get']['parameters']['path'];
3388
+ };
3389
+ }
3390
+ /**
3391
+ * Path parameters for GET /v1/users/{user_id}/permissions
3392
+ *
3393
+ * @remarks
3394
+ * This type defines the path parameters for the GET /v1/users/{user_id}/permissions endpoint.
3395
+ * It provides type safety for all path parameters as defined in the OpenAPI specification.
3396
+ *
3397
+ * @example
3398
+ * Use this type to ensure type safety for path parameters.
3399
+ *
3400
+ * @path /v1/users/{user_id}/permissions
3401
+ */
3402
+ export type GET_UsersUserIdPermissions_V1_Request_Parameters_Path = GET_UsersUserIdPermissions_V1_Request['parameters']['path'];
3403
+
3404
+ /**
3405
+ * Request type for GET UsersUserIdRoles endpoint
3406
+ *
3407
+ * List Roles
3408
+ *
3409
+ * @remarks
3410
+ * This type defines the complete request structure for the GET UsersUserIdRoles endpoint.
3411
+ * It includes all parameters (query, path) and request body types as defined in the OpenAPI specification.
3412
+ * Use this type to ensure type safety when making API requests to this endpoint.
3413
+ *
3414
+ * @example
3415
+ * Use this type to ensure type safety when making API requests to this endpoint.
3416
+ *
3417
+ * @path /v1/users/{user_id}/roles
3418
+ *
3419
+ * @see {@link GET_UsersUserIdRoles_V1_Request_Parameters_Query} - Query parameters type
3420
+ * @see {@link GET_UsersUserIdRoles_V1_Request_Parameters_Path} - Path parameters type
3421
+ * @see {@link GET_UsersUserIdRoles_V1_Request_RequestBody} - Request body type
3422
+ */
3423
+ export type GET_UsersUserIdRoles_V1_Request = {
3424
+ parameters: {
3425
+ path: operations['list_roles_v1_users__user_id__roles_get']['parameters']['path'];
3426
+ };
3427
+ }
3428
+ /**
3429
+ * Path parameters for GET /v1/users/{user_id}/roles
3430
+ *
3431
+ * @remarks
3432
+ * This type defines the path parameters for the GET /v1/users/{user_id}/roles endpoint.
3433
+ * It provides type safety for all path parameters as defined in the OpenAPI specification.
3434
+ *
3435
+ * @example
3436
+ * Use this type to ensure type safety for path parameters.
3437
+ *
3438
+ * @path /v1/users/{user_id}/roles
3439
+ */
3440
+ export type GET_UsersUserIdRoles_V1_Request_Parameters_Path = GET_UsersUserIdRoles_V1_Request['parameters']['path'];
3441
+
3442
+ /**
3443
+ * Request type for PATCH UsersUserIdRoles endpoint
3444
+ *
3445
+ * Update User Relations
3446
+ *
3447
+ * @remarks
3448
+ * This type defines the complete request structure for the PATCH UsersUserIdRoles endpoint.
3449
+ * It includes all parameters (query, path) and request body types as defined in the OpenAPI specification.
3450
+ * Use this type to ensure type safety when making API requests to this endpoint.
3451
+ *
3452
+ * @example
3453
+ * Use this type to ensure type safety when making API requests to this endpoint.
3454
+ *
3455
+ * @path /v1/users/{user_id}/roles
3456
+ *
3457
+ * @see {@link PATCH_UsersUserIdRoles_V1_Request_Parameters_Query} - Query parameters type
3458
+ * @see {@link PATCH_UsersUserIdRoles_V1_Request_Parameters_Path} - Path parameters type
3459
+ * @see {@link PATCH_UsersUserIdRoles_V1_Request_RequestBody} - Request body type
3460
+ */
3461
+ export type PATCH_UsersUserIdRoles_V1_Request = {
3462
+ parameters: {
3463
+ path: operations['update_user_relations_v1_users__user_id__roles_patch']['parameters']['path'];
3464
+ };
3465
+ requestBody: SpiceDbRelationshipUpdate;
3466
+ }
3467
+ /**
3468
+ * Path parameters for PATCH /v1/users/{user_id}/roles
3469
+ *
3470
+ * @remarks
3471
+ * This type defines the path parameters for the PATCH /v1/users/{user_id}/roles endpoint.
3472
+ * It provides type safety for all path parameters as defined in the OpenAPI specification.
3473
+ *
3474
+ * @example
3475
+ * Use this type to ensure type safety for path parameters.
3476
+ *
3477
+ * @path /v1/users/{user_id}/roles
3478
+ */
3479
+ export type PATCH_UsersUserIdRoles_V1_Request_Parameters_Path = PATCH_UsersUserIdRoles_V1_Request['parameters']['path'];
3480
+ /**
3481
+ * Request body for PATCH /v1/users/{user_id}/roles
3482
+ *
3483
+ * @remarks
3484
+ * This type defines the request body structure for the PATCH /v1/users/{user_id}/roles endpoint.
3485
+ * It provides type safety for the request body as defined in the OpenAPI specification.
3486
+ *
3487
+ * @example
3488
+ * Use this type to ensure type safety for request body structure.
3489
+ *
3490
+ * @path /v1/users/{user_id}/roles
3491
+ */
3492
+ export type PATCH_UsersUserIdRoles_V1_Request_RequestBody = PATCH_UsersUserIdRoles_V1_Request['requestBody'];
3493
+