@opusdns/api 0.227.0 → 0.229.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/package.json +1 -1
- package/src/helpers/constants.ts +322 -98
- package/src/helpers/keys.ts +17785 -7651
- package/src/helpers/requests.d.ts +611 -1
- package/src/helpers/responses.d.ts +991 -1
- package/src/helpers/schemas-arrays.d.ts +272 -6
- package/src/helpers/schemas.d.ts +2368 -976
- package/src/openapi.yaml +5183 -1561
- package/src/schema.d.ts +2731 -222
|
@@ -34,7 +34,7 @@ import { operations } from '../schema';
|
|
|
34
34
|
|
|
35
35
|
import { DomainDnssecDataCreateArray, OrganizationAttributeUpdateArray } from './schemas-arrays.d';
|
|
36
36
|
|
|
37
|
-
import { DomainAvailabilityRequest, ContactCreate, ContactAttributeSetCreate, ContactAttributeSetUpdate, DnsZoneCreate, DnsZoneRecordsPatchOps, DnsZoneRrsetsPatchOps, DnsZoneRrsetsCreate, DomainForwardPatchOps, DomainForwardCreateRequest, DomainForwardSetCreateRequest, DomainForwardSetRequest, DomainCreate, DomainUpdate, DomainRenewRequest, DomainRestoreRequest, DomainWithdrawRequest, DomainTransitRequest, DomainTransferIn, EmailForwardCreate, EmailForwardAliasCreate, EmailForwardAliasUpdate, OrganizationCreate, IpRestrictionCreate, IpRestrictionUpdate, OrganizationUpdate, ParkingSignupRequest, UserCreate, PasswordUpdate, UserUpdate, SpiceDbRelationshipUpdate } from './schemas.d';
|
|
37
|
+
import { DomainAvailabilityRequest, ContactCreate, ContactAttributeSetCreate, ContactAttributeSetUpdate, DnsZoneCreate, DnsZoneRecordsPatchOps, DnsZoneRrsetsPatchOps, DnsZoneRrsetsCreate, DomainForwardPatchOps, DomainForwardCreateRequest, DomainForwardSetCreateRequest, DomainForwardSetRequest, DomainCreate, DomainUpdate, DomainRenewRequest, DomainRestoreRequest, DomainWithdrawRequest, DomainTransitRequest, DomainTransferIn, EmailForwardCreate, EmailForwardAliasCreate, EmailForwardAliasUpdate, JobBatchRequest, OrganizationCreate, IpRestrictionCreate, IpRestrictionUpdate, OrganizationUpdate, ParkingSignupRequest, UserCreate, PasswordUpdate, UserUpdate, SpiceDbRelationshipUpdate } from './schemas.d';
|
|
38
38
|
|
|
39
39
|
/**
|
|
40
40
|
* Request type for GET ArchiveEmailForwardLogsAliasesEmailForwardAliasId endpoint
|
|
@@ -4007,6 +4007,466 @@ export type PATCH_EventsEventId_Request = {
|
|
|
4007
4007
|
*/
|
|
4008
4008
|
export type PATCH_EventsEventId_Request_Path = PATCH_EventsEventId_Request['parameters']['path'];
|
|
4009
4009
|
|
|
4010
|
+
/**
|
|
4011
|
+
* Request type for DELETE JobJobId endpoint
|
|
4012
|
+
*
|
|
4013
|
+
* Delete (cancel) a queued job
|
|
4014
|
+
*
|
|
4015
|
+
* @remarks
|
|
4016
|
+
* This type defines the complete request structure for the DELETE JobJobId endpoint.
|
|
4017
|
+
* It includes all parameters (query, path) and request body types as defined in the OpenAPI specification.
|
|
4018
|
+
* Use this type to ensure type safety when making API requests to this endpoint.
|
|
4019
|
+
*
|
|
4020
|
+
* @example
|
|
4021
|
+
* Use this type to ensure type safety when making API requests to this endpoint.
|
|
4022
|
+
*
|
|
4023
|
+
* @path /v1/job/{job_id}
|
|
4024
|
+
* @param job_id (path) - Job ID
|
|
4025
|
+
*
|
|
4026
|
+
* @see {@link DELETE_JobJobId_Request_Query} - Query parameters type
|
|
4027
|
+
* @see {@link DELETE_JobJobId_Request_Path} - Path parameters type
|
|
4028
|
+
* @see {@link DELETE_JobJobId_Request_Body} - Request body type
|
|
4029
|
+
*/
|
|
4030
|
+
export type DELETE_JobJobId_Request = {
|
|
4031
|
+
parameters: {
|
|
4032
|
+
path: operations['delete_job_v1_job__job_id__delete']['parameters']['path'];
|
|
4033
|
+
};
|
|
4034
|
+
}
|
|
4035
|
+
/**
|
|
4036
|
+
* Path parameters for DELETE /v1/job/{job_id}
|
|
4037
|
+
*
|
|
4038
|
+
* @remarks
|
|
4039
|
+
* This type defines the path parameters for the DELETE /v1/job/{job_id} endpoint.
|
|
4040
|
+
* It provides type safety for all path parameters as defined in the OpenAPI specification.
|
|
4041
|
+
*
|
|
4042
|
+
* @example
|
|
4043
|
+
* Use this type to ensure type safety for path parameters.
|
|
4044
|
+
*
|
|
4045
|
+
* @path /v1/job/{job_id}
|
|
4046
|
+
* @param job_id (path) - Job ID
|
|
4047
|
+
*/
|
|
4048
|
+
export type DELETE_JobJobId_Request_Path = DELETE_JobJobId_Request['parameters']['path'];
|
|
4049
|
+
|
|
4050
|
+
/**
|
|
4051
|
+
* Request type for GET JobJobId endpoint
|
|
4052
|
+
*
|
|
4053
|
+
* Get individual job details
|
|
4054
|
+
*
|
|
4055
|
+
* @remarks
|
|
4056
|
+
* This type defines the complete request structure for the GET JobJobId endpoint.
|
|
4057
|
+
* It includes all parameters (query, path) and request body types as defined in the OpenAPI specification.
|
|
4058
|
+
* Use this type to ensure type safety when making API requests to this endpoint.
|
|
4059
|
+
*
|
|
4060
|
+
* @example
|
|
4061
|
+
* Use this type to ensure type safety when making API requests to this endpoint.
|
|
4062
|
+
*
|
|
4063
|
+
* @path /v1/job/{job_id}
|
|
4064
|
+
* @param job_id (path) - Job ID
|
|
4065
|
+
*
|
|
4066
|
+
* @see {@link GET_JobJobId_Request_Query} - Query parameters type
|
|
4067
|
+
* @see {@link GET_JobJobId_Request_Path} - Path parameters type
|
|
4068
|
+
* @see {@link GET_JobJobId_Request_Body} - Request body type
|
|
4069
|
+
*/
|
|
4070
|
+
export type GET_JobJobId_Request = {
|
|
4071
|
+
parameters: {
|
|
4072
|
+
path: operations['get_job_v1_job__job_id__get']['parameters']['path'];
|
|
4073
|
+
};
|
|
4074
|
+
}
|
|
4075
|
+
/**
|
|
4076
|
+
* Path parameters for GET /v1/job/{job_id}
|
|
4077
|
+
*
|
|
4078
|
+
* @remarks
|
|
4079
|
+
* This type defines the path parameters for the GET /v1/job/{job_id} endpoint.
|
|
4080
|
+
* It provides type safety for all path parameters as defined in the OpenAPI specification.
|
|
4081
|
+
*
|
|
4082
|
+
* @example
|
|
4083
|
+
* Use this type to ensure type safety for path parameters.
|
|
4084
|
+
*
|
|
4085
|
+
* @path /v1/job/{job_id}
|
|
4086
|
+
* @param job_id (path) - Job ID
|
|
4087
|
+
*/
|
|
4088
|
+
export type GET_JobJobId_Request_Path = GET_JobJobId_Request['parameters']['path'];
|
|
4089
|
+
|
|
4090
|
+
/**
|
|
4091
|
+
* Request type for POST JobJobIdPause endpoint
|
|
4092
|
+
*
|
|
4093
|
+
* Pause a job
|
|
4094
|
+
*
|
|
4095
|
+
* @remarks
|
|
4096
|
+
* This type defines the complete request structure for the POST JobJobIdPause endpoint.
|
|
4097
|
+
* It includes all parameters (query, path) and request body types as defined in the OpenAPI specification.
|
|
4098
|
+
* Use this type to ensure type safety when making API requests to this endpoint.
|
|
4099
|
+
*
|
|
4100
|
+
* @example
|
|
4101
|
+
* Use this type to ensure type safety when making API requests to this endpoint.
|
|
4102
|
+
*
|
|
4103
|
+
* @path /v1/job/{job_id}/pause
|
|
4104
|
+
* @param job_id (path) - Job ID
|
|
4105
|
+
*
|
|
4106
|
+
* @see {@link POST_JobJobIdPause_Request_Query} - Query parameters type
|
|
4107
|
+
* @see {@link POST_JobJobIdPause_Request_Path} - Path parameters type
|
|
4108
|
+
* @see {@link POST_JobJobIdPause_Request_Body} - Request body type
|
|
4109
|
+
*/
|
|
4110
|
+
export type POST_JobJobIdPause_Request = {
|
|
4111
|
+
parameters: {
|
|
4112
|
+
path: operations['pause_job_v1_job__job_id__pause_post']['parameters']['path'];
|
|
4113
|
+
};
|
|
4114
|
+
}
|
|
4115
|
+
/**
|
|
4116
|
+
* Path parameters for POST /v1/job/{job_id}/pause
|
|
4117
|
+
*
|
|
4118
|
+
* @remarks
|
|
4119
|
+
* This type defines the path parameters for the POST /v1/job/{job_id}/pause endpoint.
|
|
4120
|
+
* It provides type safety for all path parameters as defined in the OpenAPI specification.
|
|
4121
|
+
*
|
|
4122
|
+
* @example
|
|
4123
|
+
* Use this type to ensure type safety for path parameters.
|
|
4124
|
+
*
|
|
4125
|
+
* @path /v1/job/{job_id}/pause
|
|
4126
|
+
* @param job_id (path) - Job ID
|
|
4127
|
+
*/
|
|
4128
|
+
export type POST_JobJobIdPause_Request_Path = POST_JobJobIdPause_Request['parameters']['path'];
|
|
4129
|
+
|
|
4130
|
+
/**
|
|
4131
|
+
* Request type for POST JobJobIdResume endpoint
|
|
4132
|
+
*
|
|
4133
|
+
* Resume a paused job
|
|
4134
|
+
*
|
|
4135
|
+
* @remarks
|
|
4136
|
+
* This type defines the complete request structure for the POST JobJobIdResume endpoint.
|
|
4137
|
+
* It includes all parameters (query, path) and request body types as defined in the OpenAPI specification.
|
|
4138
|
+
* Use this type to ensure type safety when making API requests to this endpoint.
|
|
4139
|
+
*
|
|
4140
|
+
* @example
|
|
4141
|
+
* Use this type to ensure type safety when making API requests to this endpoint.
|
|
4142
|
+
*
|
|
4143
|
+
* @path /v1/job/{job_id}/resume
|
|
4144
|
+
* @param job_id (path) - Job ID
|
|
4145
|
+
*
|
|
4146
|
+
* @see {@link POST_JobJobIdResume_Request_Query} - Query parameters type
|
|
4147
|
+
* @see {@link POST_JobJobIdResume_Request_Path} - Path parameters type
|
|
4148
|
+
* @see {@link POST_JobJobIdResume_Request_Body} - Request body type
|
|
4149
|
+
*/
|
|
4150
|
+
export type POST_JobJobIdResume_Request = {
|
|
4151
|
+
parameters: {
|
|
4152
|
+
path: operations['resume_job_v1_job__job_id__resume_post']['parameters']['path'];
|
|
4153
|
+
};
|
|
4154
|
+
}
|
|
4155
|
+
/**
|
|
4156
|
+
* Path parameters for POST /v1/job/{job_id}/resume
|
|
4157
|
+
*
|
|
4158
|
+
* @remarks
|
|
4159
|
+
* This type defines the path parameters for the POST /v1/job/{job_id}/resume endpoint.
|
|
4160
|
+
* It provides type safety for all path parameters as defined in the OpenAPI specification.
|
|
4161
|
+
*
|
|
4162
|
+
* @example
|
|
4163
|
+
* Use this type to ensure type safety for path parameters.
|
|
4164
|
+
*
|
|
4165
|
+
* @path /v1/job/{job_id}/resume
|
|
4166
|
+
* @param job_id (path) - Job ID
|
|
4167
|
+
*/
|
|
4168
|
+
export type POST_JobJobIdResume_Request_Path = POST_JobJobIdResume_Request['parameters']['path'];
|
|
4169
|
+
|
|
4170
|
+
/**
|
|
4171
|
+
* Request type for GET Jobs endpoint
|
|
4172
|
+
*
|
|
4173
|
+
* List batches for organization
|
|
4174
|
+
*
|
|
4175
|
+
* @remarks
|
|
4176
|
+
* This type defines the complete request structure for the GET Jobs endpoint.
|
|
4177
|
+
* It includes all parameters (query, path) and request body types as defined in the OpenAPI specification.
|
|
4178
|
+
* Use this type to ensure type safety when making API requests to this endpoint.
|
|
4179
|
+
*
|
|
4180
|
+
* @example
|
|
4181
|
+
* Use this type to ensure type safety when making API requests to this endpoint.
|
|
4182
|
+
*
|
|
4183
|
+
* @path /v1/jobs
|
|
4184
|
+
* @param status (query) - Filter by batch status (pending or complete)
|
|
4185
|
+
* @param sort_by (query) - Sort field
|
|
4186
|
+
* @param sort_order (query) - Sort order
|
|
4187
|
+
*
|
|
4188
|
+
* @see {@link GET_Jobs_Request_Query} - Query parameters type
|
|
4189
|
+
* @see {@link GET_Jobs_Request_Path} - Path parameters type
|
|
4190
|
+
* @see {@link GET_Jobs_Request_Body} - Request body type
|
|
4191
|
+
*/
|
|
4192
|
+
export type GET_Jobs_Request = {
|
|
4193
|
+
parameters: {
|
|
4194
|
+
query: operations['list_batches_v1_jobs_get']['parameters']['query'];
|
|
4195
|
+
};
|
|
4196
|
+
}
|
|
4197
|
+
/**
|
|
4198
|
+
* Query parameters for GET /v1/jobs
|
|
4199
|
+
*
|
|
4200
|
+
* @remarks
|
|
4201
|
+
* This type defines the query parameters for the GET /v1/jobs endpoint.
|
|
4202
|
+
* It provides type safety for all query parameters as defined in the OpenAPI specification.
|
|
4203
|
+
*
|
|
4204
|
+
* @example
|
|
4205
|
+
* Use this type to ensure type safety for query parameters.
|
|
4206
|
+
*
|
|
4207
|
+
* @path /v1/jobs
|
|
4208
|
+
* @param status (query) - Filter by batch status (pending or complete)
|
|
4209
|
+
* @param sort_by (query) - Sort field
|
|
4210
|
+
* @param sort_order (query) - Sort order
|
|
4211
|
+
*/
|
|
4212
|
+
export type GET_Jobs_Request_Query = GET_Jobs_Request['parameters']['query'];
|
|
4213
|
+
|
|
4214
|
+
/**
|
|
4215
|
+
* Request type for POST Jobs endpoint
|
|
4216
|
+
*
|
|
4217
|
+
* Create a batch of commands for async execution
|
|
4218
|
+
*
|
|
4219
|
+
* @remarks
|
|
4220
|
+
* This type defines the complete request structure for the POST Jobs endpoint.
|
|
4221
|
+
* It includes all parameters (query, path) and request body types as defined in the OpenAPI specification.
|
|
4222
|
+
* Use this type to ensure type safety when making API requests to this endpoint.
|
|
4223
|
+
*
|
|
4224
|
+
* @example
|
|
4225
|
+
* Use this type to ensure type safety when making API requests to this endpoint.
|
|
4226
|
+
*
|
|
4227
|
+
* @path /v1/jobs
|
|
4228
|
+
*
|
|
4229
|
+
* @see {@link POST_Jobs_Request_Query} - Query parameters type
|
|
4230
|
+
* @see {@link POST_Jobs_Request_Path} - Path parameters type
|
|
4231
|
+
* @see {@link POST_Jobs_Request_Body} - Request body type
|
|
4232
|
+
*/
|
|
4233
|
+
export type POST_Jobs_Request = {
|
|
4234
|
+
requestBody: JobBatchRequest;
|
|
4235
|
+
}
|
|
4236
|
+
/**
|
|
4237
|
+
* Request body for POST /v1/jobs
|
|
4238
|
+
*
|
|
4239
|
+
* @remarks
|
|
4240
|
+
* This type defines the request body structure for the POST /v1/jobs endpoint.
|
|
4241
|
+
* It provides type safety for the request body as defined in the OpenAPI specification.
|
|
4242
|
+
*
|
|
4243
|
+
* @example
|
|
4244
|
+
* Use this type to ensure type safety for request body structure.
|
|
4245
|
+
*
|
|
4246
|
+
* @path /v1/jobs
|
|
4247
|
+
*/
|
|
4248
|
+
export type POST_Jobs_Request_Body = POST_Jobs_Request['requestBody'];
|
|
4249
|
+
|
|
4250
|
+
/**
|
|
4251
|
+
* Request type for DELETE JobsBatchId endpoint
|
|
4252
|
+
*
|
|
4253
|
+
* Delete (cancel) all queued jobs in a batch
|
|
4254
|
+
*
|
|
4255
|
+
* @remarks
|
|
4256
|
+
* This type defines the complete request structure for the DELETE JobsBatchId endpoint.
|
|
4257
|
+
* It includes all parameters (query, path) and request body types as defined in the OpenAPI specification.
|
|
4258
|
+
* Use this type to ensure type safety when making API requests to this endpoint.
|
|
4259
|
+
*
|
|
4260
|
+
* @example
|
|
4261
|
+
* Use this type to ensure type safety when making API requests to this endpoint.
|
|
4262
|
+
*
|
|
4263
|
+
* @path /v1/jobs/{batch_id}
|
|
4264
|
+
* @param batch_id (path) - Batch ID
|
|
4265
|
+
*
|
|
4266
|
+
* @see {@link DELETE_JobsBatchId_Request_Query} - Query parameters type
|
|
4267
|
+
* @see {@link DELETE_JobsBatchId_Request_Path} - Path parameters type
|
|
4268
|
+
* @see {@link DELETE_JobsBatchId_Request_Body} - Request body type
|
|
4269
|
+
*/
|
|
4270
|
+
export type DELETE_JobsBatchId_Request = {
|
|
4271
|
+
parameters: {
|
|
4272
|
+
path: operations['delete_batch_v1_jobs__batch_id__delete']['parameters']['path'];
|
|
4273
|
+
};
|
|
4274
|
+
}
|
|
4275
|
+
/**
|
|
4276
|
+
* Path parameters for DELETE /v1/jobs/{batch_id}
|
|
4277
|
+
*
|
|
4278
|
+
* @remarks
|
|
4279
|
+
* This type defines the path parameters for the DELETE /v1/jobs/{batch_id} endpoint.
|
|
4280
|
+
* It provides type safety for all path parameters as defined in the OpenAPI specification.
|
|
4281
|
+
*
|
|
4282
|
+
* @example
|
|
4283
|
+
* Use this type to ensure type safety for path parameters.
|
|
4284
|
+
*
|
|
4285
|
+
* @path /v1/jobs/{batch_id}
|
|
4286
|
+
* @param batch_id (path) - Batch ID
|
|
4287
|
+
*/
|
|
4288
|
+
export type DELETE_JobsBatchId_Request_Path = DELETE_JobsBatchId_Request['parameters']['path'];
|
|
4289
|
+
|
|
4290
|
+
/**
|
|
4291
|
+
* Request type for GET JobsBatchId endpoint
|
|
4292
|
+
*
|
|
4293
|
+
* Get batch details and execution status
|
|
4294
|
+
*
|
|
4295
|
+
* @remarks
|
|
4296
|
+
* This type defines the complete request structure for the GET JobsBatchId endpoint.
|
|
4297
|
+
* It includes all parameters (query, path) and request body types as defined in the OpenAPI specification.
|
|
4298
|
+
* Use this type to ensure type safety when making API requests to this endpoint.
|
|
4299
|
+
*
|
|
4300
|
+
* @example
|
|
4301
|
+
* Use this type to ensure type safety when making API requests to this endpoint.
|
|
4302
|
+
*
|
|
4303
|
+
* @path /v1/jobs/{batch_id}
|
|
4304
|
+
* @param batch_id (path) - Batch ID
|
|
4305
|
+
*
|
|
4306
|
+
* @see {@link GET_JobsBatchId_Request_Query} - Query parameters type
|
|
4307
|
+
* @see {@link GET_JobsBatchId_Request_Path} - Path parameters type
|
|
4308
|
+
* @see {@link GET_JobsBatchId_Request_Body} - Request body type
|
|
4309
|
+
*/
|
|
4310
|
+
export type GET_JobsBatchId_Request = {
|
|
4311
|
+
parameters: {
|
|
4312
|
+
path: operations['get_batch_v1_jobs__batch_id__get']['parameters']['path'];
|
|
4313
|
+
};
|
|
4314
|
+
}
|
|
4315
|
+
/**
|
|
4316
|
+
* Path parameters for GET /v1/jobs/{batch_id}
|
|
4317
|
+
*
|
|
4318
|
+
* @remarks
|
|
4319
|
+
* This type defines the path parameters for the GET /v1/jobs/{batch_id} endpoint.
|
|
4320
|
+
* It provides type safety for all path parameters as defined in the OpenAPI specification.
|
|
4321
|
+
*
|
|
4322
|
+
* @example
|
|
4323
|
+
* Use this type to ensure type safety for path parameters.
|
|
4324
|
+
*
|
|
4325
|
+
* @path /v1/jobs/{batch_id}
|
|
4326
|
+
* @param batch_id (path) - Batch ID
|
|
4327
|
+
*/
|
|
4328
|
+
export type GET_JobsBatchId_Request_Path = GET_JobsBatchId_Request['parameters']['path'];
|
|
4329
|
+
|
|
4330
|
+
/**
|
|
4331
|
+
* Request type for GET JobsBatchIdJobs endpoint
|
|
4332
|
+
*
|
|
4333
|
+
* Get individual jobs within a batch
|
|
4334
|
+
*
|
|
4335
|
+
* @remarks
|
|
4336
|
+
* This type defines the complete request structure for the GET JobsBatchIdJobs endpoint.
|
|
4337
|
+
* It includes all parameters (query, path) and request body types as defined in the OpenAPI specification.
|
|
4338
|
+
* Use this type to ensure type safety when making API requests to this endpoint.
|
|
4339
|
+
*
|
|
4340
|
+
* @example
|
|
4341
|
+
* Use this type to ensure type safety when making API requests to this endpoint.
|
|
4342
|
+
*
|
|
4343
|
+
* @path /v1/jobs/{batch_id}/jobs
|
|
4344
|
+
* @param batch_id (path) - Batch ID
|
|
4345
|
+
* @param status (query) - Filter by job status (repeatable)
|
|
4346
|
+
* @param sort_by (query) - Sort field
|
|
4347
|
+
* @param sort_order (query) - Sort order
|
|
4348
|
+
*
|
|
4349
|
+
* @see {@link GET_JobsBatchIdJobs_Request_Query} - Query parameters type
|
|
4350
|
+
* @see {@link GET_JobsBatchIdJobs_Request_Path} - Path parameters type
|
|
4351
|
+
* @see {@link GET_JobsBatchIdJobs_Request_Body} - Request body type
|
|
4352
|
+
*/
|
|
4353
|
+
export type GET_JobsBatchIdJobs_Request = {
|
|
4354
|
+
parameters: {
|
|
4355
|
+
query: operations['get_batch_jobs_v1_jobs__batch_id__jobs_get']['parameters']['query'];
|
|
4356
|
+
path: operations['get_batch_jobs_v1_jobs__batch_id__jobs_get']['parameters']['path'];
|
|
4357
|
+
};
|
|
4358
|
+
}
|
|
4359
|
+
/**
|
|
4360
|
+
* Query parameters for GET /v1/jobs/{batch_id}/jobs
|
|
4361
|
+
*
|
|
4362
|
+
* @remarks
|
|
4363
|
+
* This type defines the query parameters for the GET /v1/jobs/{batch_id}/jobs endpoint.
|
|
4364
|
+
* It provides type safety for all query parameters as defined in the OpenAPI specification.
|
|
4365
|
+
*
|
|
4366
|
+
* @example
|
|
4367
|
+
* Use this type to ensure type safety for query parameters.
|
|
4368
|
+
*
|
|
4369
|
+
* @path /v1/jobs/{batch_id}/jobs
|
|
4370
|
+
* @param status (query) - Filter by job status (repeatable)
|
|
4371
|
+
* @param sort_by (query) - Sort field
|
|
4372
|
+
* @param sort_order (query) - Sort order
|
|
4373
|
+
*/
|
|
4374
|
+
export type GET_JobsBatchIdJobs_Request_Query = GET_JobsBatchIdJobs_Request['parameters']['query'];
|
|
4375
|
+
/**
|
|
4376
|
+
* Path parameters for GET /v1/jobs/{batch_id}/jobs
|
|
4377
|
+
*
|
|
4378
|
+
* @remarks
|
|
4379
|
+
* This type defines the path parameters for the GET /v1/jobs/{batch_id}/jobs endpoint.
|
|
4380
|
+
* It provides type safety for all path parameters as defined in the OpenAPI specification.
|
|
4381
|
+
*
|
|
4382
|
+
* @example
|
|
4383
|
+
* Use this type to ensure type safety for path parameters.
|
|
4384
|
+
*
|
|
4385
|
+
* @path /v1/jobs/{batch_id}/jobs
|
|
4386
|
+
* @param batch_id (path) - Batch ID
|
|
4387
|
+
*/
|
|
4388
|
+
export type GET_JobsBatchIdJobs_Request_Path = GET_JobsBatchIdJobs_Request['parameters']['path'];
|
|
4389
|
+
|
|
4390
|
+
/**
|
|
4391
|
+
* Request type for POST JobsBatchIdPause endpoint
|
|
4392
|
+
*
|
|
4393
|
+
* Pause all eligible jobs in a batch
|
|
4394
|
+
*
|
|
4395
|
+
* @remarks
|
|
4396
|
+
* This type defines the complete request structure for the POST JobsBatchIdPause endpoint.
|
|
4397
|
+
* It includes all parameters (query, path) and request body types as defined in the OpenAPI specification.
|
|
4398
|
+
* Use this type to ensure type safety when making API requests to this endpoint.
|
|
4399
|
+
*
|
|
4400
|
+
* @example
|
|
4401
|
+
* Use this type to ensure type safety when making API requests to this endpoint.
|
|
4402
|
+
*
|
|
4403
|
+
* @path /v1/jobs/{batch_id}/pause
|
|
4404
|
+
* @param batch_id (path) - Batch ID
|
|
4405
|
+
*
|
|
4406
|
+
* @see {@link POST_JobsBatchIdPause_Request_Query} - Query parameters type
|
|
4407
|
+
* @see {@link POST_JobsBatchIdPause_Request_Path} - Path parameters type
|
|
4408
|
+
* @see {@link POST_JobsBatchIdPause_Request_Body} - Request body type
|
|
4409
|
+
*/
|
|
4410
|
+
export type POST_JobsBatchIdPause_Request = {
|
|
4411
|
+
parameters: {
|
|
4412
|
+
path: operations['pause_batch_v1_jobs__batch_id__pause_post']['parameters']['path'];
|
|
4413
|
+
};
|
|
4414
|
+
}
|
|
4415
|
+
/**
|
|
4416
|
+
* Path parameters for POST /v1/jobs/{batch_id}/pause
|
|
4417
|
+
*
|
|
4418
|
+
* @remarks
|
|
4419
|
+
* This type defines the path parameters for the POST /v1/jobs/{batch_id}/pause endpoint.
|
|
4420
|
+
* It provides type safety for all path parameters as defined in the OpenAPI specification.
|
|
4421
|
+
*
|
|
4422
|
+
* @example
|
|
4423
|
+
* Use this type to ensure type safety for path parameters.
|
|
4424
|
+
*
|
|
4425
|
+
* @path /v1/jobs/{batch_id}/pause
|
|
4426
|
+
* @param batch_id (path) - Batch ID
|
|
4427
|
+
*/
|
|
4428
|
+
export type POST_JobsBatchIdPause_Request_Path = POST_JobsBatchIdPause_Request['parameters']['path'];
|
|
4429
|
+
|
|
4430
|
+
/**
|
|
4431
|
+
* Request type for POST JobsBatchIdResume endpoint
|
|
4432
|
+
*
|
|
4433
|
+
* Resume all paused jobs in a batch
|
|
4434
|
+
*
|
|
4435
|
+
* @remarks
|
|
4436
|
+
* This type defines the complete request structure for the POST JobsBatchIdResume endpoint.
|
|
4437
|
+
* It includes all parameters (query, path) and request body types as defined in the OpenAPI specification.
|
|
4438
|
+
* Use this type to ensure type safety when making API requests to this endpoint.
|
|
4439
|
+
*
|
|
4440
|
+
* @example
|
|
4441
|
+
* Use this type to ensure type safety when making API requests to this endpoint.
|
|
4442
|
+
*
|
|
4443
|
+
* @path /v1/jobs/{batch_id}/resume
|
|
4444
|
+
* @param batch_id (path) - Batch ID
|
|
4445
|
+
*
|
|
4446
|
+
* @see {@link POST_JobsBatchIdResume_Request_Query} - Query parameters type
|
|
4447
|
+
* @see {@link POST_JobsBatchIdResume_Request_Path} - Path parameters type
|
|
4448
|
+
* @see {@link POST_JobsBatchIdResume_Request_Body} - Request body type
|
|
4449
|
+
*/
|
|
4450
|
+
export type POST_JobsBatchIdResume_Request = {
|
|
4451
|
+
parameters: {
|
|
4452
|
+
path: operations['resume_batch_v1_jobs__batch_id__resume_post']['parameters']['path'];
|
|
4453
|
+
};
|
|
4454
|
+
}
|
|
4455
|
+
/**
|
|
4456
|
+
* Path parameters for POST /v1/jobs/{batch_id}/resume
|
|
4457
|
+
*
|
|
4458
|
+
* @remarks
|
|
4459
|
+
* This type defines the path parameters for the POST /v1/jobs/{batch_id}/resume endpoint.
|
|
4460
|
+
* It provides type safety for all path parameters as defined in the OpenAPI specification.
|
|
4461
|
+
*
|
|
4462
|
+
* @example
|
|
4463
|
+
* Use this type to ensure type safety for path parameters.
|
|
4464
|
+
*
|
|
4465
|
+
* @path /v1/jobs/{batch_id}/resume
|
|
4466
|
+
* @param batch_id (path) - Batch ID
|
|
4467
|
+
*/
|
|
4468
|
+
export type POST_JobsBatchIdResume_Request_Path = POST_JobsBatchIdResume_Request['parameters']['path'];
|
|
4469
|
+
|
|
4010
4470
|
/**
|
|
4011
4471
|
* Request type for GET Organizations endpoint
|
|
4012
4472
|
*
|
|
@@ -5072,6 +5532,156 @@ export type POST_ParkingSignup_Request_Body = POST_ParkingSignup_Request['reques
|
|
|
5072
5532
|
export type GET_ParkingSignupStatus_Request = {
|
|
5073
5533
|
}
|
|
5074
5534
|
|
|
5535
|
+
/**
|
|
5536
|
+
* Request type for GET Reports endpoint
|
|
5537
|
+
*
|
|
5538
|
+
* List Reports
|
|
5539
|
+
*
|
|
5540
|
+
* @remarks
|
|
5541
|
+
* This type defines the complete request structure for the GET Reports endpoint.
|
|
5542
|
+
* It includes all parameters (query, path) and request body types as defined in the OpenAPI specification.
|
|
5543
|
+
* Use this type to ensure type safety when making API requests to this endpoint.
|
|
5544
|
+
*
|
|
5545
|
+
* @example
|
|
5546
|
+
* Use this type to ensure type safety when making API requests to this endpoint.
|
|
5547
|
+
*
|
|
5548
|
+
* @path /v1/reports
|
|
5549
|
+
*
|
|
5550
|
+
* @see {@link GET_Reports_Request_Query} - Query parameters type
|
|
5551
|
+
* @see {@link GET_Reports_Request_Path} - Path parameters type
|
|
5552
|
+
* @see {@link GET_Reports_Request_Body} - Request body type
|
|
5553
|
+
*/
|
|
5554
|
+
export type GET_Reports_Request = {
|
|
5555
|
+
parameters: {
|
|
5556
|
+
query: operations['list_reports_v1_reports_get']['parameters']['query'];
|
|
5557
|
+
};
|
|
5558
|
+
}
|
|
5559
|
+
/**
|
|
5560
|
+
* Query parameters for GET /v1/reports
|
|
5561
|
+
*
|
|
5562
|
+
* @remarks
|
|
5563
|
+
* This type defines the query parameters for the GET /v1/reports endpoint.
|
|
5564
|
+
* It provides type safety for all query parameters as defined in the OpenAPI specification.
|
|
5565
|
+
*
|
|
5566
|
+
* @example
|
|
5567
|
+
* Use this type to ensure type safety for query parameters.
|
|
5568
|
+
*
|
|
5569
|
+
* @path /v1/reports
|
|
5570
|
+
*/
|
|
5571
|
+
export type GET_Reports_Request_Query = GET_Reports_Request['parameters']['query'];
|
|
5572
|
+
|
|
5573
|
+
/**
|
|
5574
|
+
* Request type for POST Reports endpoint
|
|
5575
|
+
*
|
|
5576
|
+
* Create Report
|
|
5577
|
+
*
|
|
5578
|
+
* @remarks
|
|
5579
|
+
* This type defines the complete request structure for the POST Reports endpoint.
|
|
5580
|
+
* It includes all parameters (query, path) and request body types as defined in the OpenAPI specification.
|
|
5581
|
+
* Use this type to ensure type safety when making API requests to this endpoint.
|
|
5582
|
+
*
|
|
5583
|
+
* @example
|
|
5584
|
+
* Use this type to ensure type safety when making API requests to this endpoint.
|
|
5585
|
+
*
|
|
5586
|
+
* @path /v1/reports
|
|
5587
|
+
*
|
|
5588
|
+
* @see {@link POST_Reports_Request_Query} - Query parameters type
|
|
5589
|
+
* @see {@link POST_Reports_Request_Path} - Path parameters type
|
|
5590
|
+
* @see {@link POST_Reports_Request_Body} - Request body type
|
|
5591
|
+
*/
|
|
5592
|
+
export type POST_Reports_Request = {
|
|
5593
|
+
requestBody: unknown;
|
|
5594
|
+
}
|
|
5595
|
+
/**
|
|
5596
|
+
* Request body for POST /v1/reports
|
|
5597
|
+
*
|
|
5598
|
+
* @remarks
|
|
5599
|
+
* This type defines the request body structure for the POST /v1/reports endpoint.
|
|
5600
|
+
* It provides type safety for the request body as defined in the OpenAPI specification.
|
|
5601
|
+
*
|
|
5602
|
+
* @example
|
|
5603
|
+
* Use this type to ensure type safety for request body structure.
|
|
5604
|
+
*
|
|
5605
|
+
* @path /v1/reports
|
|
5606
|
+
*/
|
|
5607
|
+
export type POST_Reports_Request_Body = POST_Reports_Request['requestBody'];
|
|
5608
|
+
|
|
5609
|
+
/**
|
|
5610
|
+
* Request type for GET ReportsReportId endpoint
|
|
5611
|
+
*
|
|
5612
|
+
* Get Report
|
|
5613
|
+
*
|
|
5614
|
+
* @remarks
|
|
5615
|
+
* This type defines the complete request structure for the GET ReportsReportId endpoint.
|
|
5616
|
+
* It includes all parameters (query, path) and request body types as defined in the OpenAPI specification.
|
|
5617
|
+
* Use this type to ensure type safety when making API requests to this endpoint.
|
|
5618
|
+
*
|
|
5619
|
+
* @example
|
|
5620
|
+
* Use this type to ensure type safety when making API requests to this endpoint.
|
|
5621
|
+
*
|
|
5622
|
+
* @path /v1/reports/{report_id}
|
|
5623
|
+
*
|
|
5624
|
+
* @see {@link GET_ReportsReportId_Request_Query} - Query parameters type
|
|
5625
|
+
* @see {@link GET_ReportsReportId_Request_Path} - Path parameters type
|
|
5626
|
+
* @see {@link GET_ReportsReportId_Request_Body} - Request body type
|
|
5627
|
+
*/
|
|
5628
|
+
export type GET_ReportsReportId_Request = {
|
|
5629
|
+
parameters: {
|
|
5630
|
+
path: operations['get_report_v1_reports__report_id__get']['parameters']['path'];
|
|
5631
|
+
};
|
|
5632
|
+
}
|
|
5633
|
+
/**
|
|
5634
|
+
* Path parameters for GET /v1/reports/{report_id}
|
|
5635
|
+
*
|
|
5636
|
+
* @remarks
|
|
5637
|
+
* This type defines the path parameters for the GET /v1/reports/{report_id} endpoint.
|
|
5638
|
+
* It provides type safety for all path parameters as defined in the OpenAPI specification.
|
|
5639
|
+
*
|
|
5640
|
+
* @example
|
|
5641
|
+
* Use this type to ensure type safety for path parameters.
|
|
5642
|
+
*
|
|
5643
|
+
* @path /v1/reports/{report_id}
|
|
5644
|
+
*/
|
|
5645
|
+
export type GET_ReportsReportId_Request_Path = GET_ReportsReportId_Request['parameters']['path'];
|
|
5646
|
+
|
|
5647
|
+
/**
|
|
5648
|
+
* Request type for GET ReportsReportIdDownload endpoint
|
|
5649
|
+
*
|
|
5650
|
+
* Download Report
|
|
5651
|
+
*
|
|
5652
|
+
* @remarks
|
|
5653
|
+
* This type defines the complete request structure for the GET ReportsReportIdDownload endpoint.
|
|
5654
|
+
* It includes all parameters (query, path) and request body types as defined in the OpenAPI specification.
|
|
5655
|
+
* Use this type to ensure type safety when making API requests to this endpoint.
|
|
5656
|
+
*
|
|
5657
|
+
* @example
|
|
5658
|
+
* Use this type to ensure type safety when making API requests to this endpoint.
|
|
5659
|
+
*
|
|
5660
|
+
* @path /v1/reports/{report_id}/download
|
|
5661
|
+
*
|
|
5662
|
+
* @see {@link GET_ReportsReportIdDownload_Request_Query} - Query parameters type
|
|
5663
|
+
* @see {@link GET_ReportsReportIdDownload_Request_Path} - Path parameters type
|
|
5664
|
+
* @see {@link GET_ReportsReportIdDownload_Request_Body} - Request body type
|
|
5665
|
+
*/
|
|
5666
|
+
export type GET_ReportsReportIdDownload_Request = {
|
|
5667
|
+
parameters: {
|
|
5668
|
+
path: operations['download_report_v1_reports__report_id__download_get']['parameters']['path'];
|
|
5669
|
+
};
|
|
5670
|
+
}
|
|
5671
|
+
/**
|
|
5672
|
+
* Path parameters for GET /v1/reports/{report_id}/download
|
|
5673
|
+
*
|
|
5674
|
+
* @remarks
|
|
5675
|
+
* This type defines the path parameters for the GET /v1/reports/{report_id}/download endpoint.
|
|
5676
|
+
* It provides type safety for all path parameters as defined in the OpenAPI specification.
|
|
5677
|
+
*
|
|
5678
|
+
* @example
|
|
5679
|
+
* Use this type to ensure type safety for path parameters.
|
|
5680
|
+
*
|
|
5681
|
+
* @path /v1/reports/{report_id}/download
|
|
5682
|
+
*/
|
|
5683
|
+
export type GET_ReportsReportIdDownload_Request_Path = GET_ReportsReportIdDownload_Request['parameters']['path'];
|
|
5684
|
+
|
|
5075
5685
|
/**
|
|
5076
5686
|
* Request type for GET Tlds endpoint
|
|
5077
5687
|
*
|