@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 @@
|
|
|
34
34
|
|
|
35
35
|
import { DomainDnssecDataArray, OrganizationAttribute2Array, IpRestrictionArray, TldResponseShortArray } from './schemas-arrays.d';
|
|
36
36
|
|
|
37
|
-
import { Pagination_EmailForwardLog, HTTPValidationError, Pagination_ObjectLog, Pagination_RequestHistory, Problem, DomainAvailabilityList, Pagination_Contact, ContactSchema, Pagination_ContactAttributeSet, ContactAttributeSet, Contact, ContactAttributeLink, ContactVerification, Pagination_DnsZone, DnsZone, DnsChanges, DomainForwardZone, EmailForwardZone, Pagination_DomainForwardZone, Pagination_EmailForwardZone, DnsZoneSummary, Pagination_DomainForward, DomainForward, DomainForwardSet, DomainForwardMetrics, DomainForwardBrowserStats, DomainForwardGeoStats, DomainForwardPlatformStats, DomainForwardReferrerStats, DomainForwardStatusCodeStats, DomainForwardMetricsTimeSeries, DomainForwardUserAgentStats, DomainForwardVisitsByKey, DomainSearch, Pagination_Domain, Domain, DomainRenew, DomainRestore, DomainCheck, DomainSummary, DomainWithdraw, RequestAuthcode, DomainTransit, RequestAuthcode2, Pagination_EmailForward, EmailForward, EmailForwardAlias, EmailForwardMetrics, Pagination_Event, EventSchema, Pagination_Organization, Organization, OrganizationWithBillingData, Pagination_Invoice, GetPrices, Pagination_BillingTransaction, BillingTransaction, IpRestriction, Pagination_UserPublic, Pagination_Parking, ParkingMetrics, ParkingTotalMetrics, ParkingSignup, ParkingSignupStatus, TldSpecification, UserPublic, UserPublicWithAttributes, PermissionSet, RelationSet, UserWithRelationPermissions } from './schemas.d';
|
|
37
|
+
import { Pagination_EmailForwardLog, HTTPValidationError, Pagination_ObjectLog, Pagination_RequestHistory, Problem, DomainAvailabilityList, Pagination_Contact, ContactSchema, Pagination_ContactAttributeSet, ContactAttributeSet, Contact, ContactAttributeLink, ContactVerification, Pagination_DnsZone, DnsZone, DnsChanges, DomainForwardZone, EmailForwardZone, Pagination_DomainForwardZone, Pagination_EmailForwardZone, DnsZoneSummary, Pagination_DomainForward, DomainForward, DomainForwardSet, DomainForwardMetrics, DomainForwardBrowserStats, DomainForwardGeoStats, DomainForwardPlatformStats, DomainForwardReferrerStats, DomainForwardStatusCodeStats, DomainForwardMetricsTimeSeries, DomainForwardUserAgentStats, DomainForwardVisitsByKey, DomainSearch, Pagination_Domain, Domain, DomainRenew, DomainRestore, DomainCheck, DomainSummary, DomainWithdraw, RequestAuthcode, DomainTransit, RequestAuthcode2, Pagination_EmailForward, EmailForward, EmailForwardAlias, EmailForwardMetrics, Pagination_Event, EventSchema, Job, Pagination_JobBatchMetadata, CreateJobBatch, JobBatchStatus, Pagination_Job, Pagination_Organization, Organization, OrganizationWithBillingData, Pagination_Invoice, GetPrices, Pagination_BillingTransaction, BillingTransaction, IpRestriction, Pagination_UserPublic, Pagination_Parking, ParkingMetrics, ParkingTotalMetrics, ParkingSignup, ParkingSignupStatus, PublicReportListRes, PublicReportRes, TldSpecification, UserPublic, UserPublicWithAttributes, PermissionSet, RelationSet, UserWithRelationPermissions } from './schemas.d';
|
|
38
38
|
|
|
39
39
|
/**
|
|
40
40
|
* Response types for GET ArchiveEmailForwardLogsAliasesByEmailForwardAliasId endpoint
|
|
@@ -7851,6 +7851,812 @@ export type PATCH_EventsByEventId_Response_404 = Problem
|
|
|
7851
7851
|
*/
|
|
7852
7852
|
export type PATCH_EventsByEventId_Response_422 = HTTPValidationError
|
|
7853
7853
|
|
|
7854
|
+
/**
|
|
7855
|
+
* Response types for DELETE JobByJobId endpoint
|
|
7856
|
+
*
|
|
7857
|
+
* Delete (cancel) a queued job
|
|
7858
|
+
*
|
|
7859
|
+
* @remarks
|
|
7860
|
+
* This type defines all possible response structures for the DELETE JobByJobId endpoint.
|
|
7861
|
+
* Each response code maps to a specific response type as defined in the OpenAPI specification.
|
|
7862
|
+
* Use this type to ensure type safety when handling API responses from this endpoint.
|
|
7863
|
+
*
|
|
7864
|
+
|
|
7865
|
+
*
|
|
7866
|
+
* @path /v1/job/{job_id}
|
|
7867
|
+
* @param job_id (path) - Job ID
|
|
7868
|
+
*
|
|
7869
|
+
* @see {@link DELETE_JobByJobId_Response_404} - 404 response type
|
|
7870
|
+
* @see {@link DELETE_JobByJobId_Response_422} - 422 response type
|
|
7871
|
+
*
|
|
7872
|
+
|
|
7873
|
+
*/
|
|
7874
|
+
export type DELETE_JobByJobId_Response = DELETE_JobByJobId_Response_404 | DELETE_JobByJobId_Response_422;
|
|
7875
|
+
|
|
7876
|
+
/**
|
|
7877
|
+
* 404 response for DELETE JobByJobId endpoint
|
|
7878
|
+
*
|
|
7879
|
+
* @remarks
|
|
7880
|
+
* This type defines the response structure for the 404 status code
|
|
7881
|
+
* of the DELETE JobByJobId endpoint.
|
|
7882
|
+
* It provides type safety for handling this specific response as defined in the OpenAPI specification.
|
|
7883
|
+
*
|
|
7884
|
+
|
|
7885
|
+
*
|
|
7886
|
+
* @path /v1/job/{job_id}
|
|
7887
|
+
* @param job_id (path) - Job ID
|
|
7888
|
+
*
|
|
7889
|
+
* @see {@link DELETE_JobByJobId_Response} - The main response type definition
|
|
7890
|
+
* @see {@link Problem} - The actual schema type definition
|
|
7891
|
+
*/
|
|
7892
|
+
export type DELETE_JobByJobId_Response_404 = Problem
|
|
7893
|
+
|
|
7894
|
+
/**
|
|
7895
|
+
* 422 response for DELETE JobByJobId endpoint
|
|
7896
|
+
*
|
|
7897
|
+
* @remarks
|
|
7898
|
+
* This type defines the response structure for the 422 status code
|
|
7899
|
+
* of the DELETE JobByJobId endpoint.
|
|
7900
|
+
* It provides type safety for handling this specific response as defined in the OpenAPI specification.
|
|
7901
|
+
*
|
|
7902
|
+
|
|
7903
|
+
*
|
|
7904
|
+
* @path /v1/job/{job_id}
|
|
7905
|
+
* @param job_id (path) - Job ID
|
|
7906
|
+
*
|
|
7907
|
+
* @see {@link DELETE_JobByJobId_Response} - The main response type definition
|
|
7908
|
+
* @see {@link HTTPValidationError} - The actual schema type definition
|
|
7909
|
+
*/
|
|
7910
|
+
export type DELETE_JobByJobId_Response_422 = HTTPValidationError
|
|
7911
|
+
|
|
7912
|
+
/**
|
|
7913
|
+
* Response types for GET JobByJobId endpoint
|
|
7914
|
+
*
|
|
7915
|
+
* Get individual job details
|
|
7916
|
+
*
|
|
7917
|
+
* @remarks
|
|
7918
|
+
* This type defines all possible response structures for the GET JobByJobId endpoint.
|
|
7919
|
+
* Each response code maps to a specific response type as defined in the OpenAPI specification.
|
|
7920
|
+
* Use this type to ensure type safety when handling API responses from this endpoint.
|
|
7921
|
+
*
|
|
7922
|
+
|
|
7923
|
+
*
|
|
7924
|
+
* @path /v1/job/{job_id}
|
|
7925
|
+
* @param job_id (path) - Job ID
|
|
7926
|
+
*
|
|
7927
|
+
* @see {@link GET_JobByJobId_Response_200} - 200 response type
|
|
7928
|
+
* @see {@link GET_JobByJobId_Response_404} - 404 response type
|
|
7929
|
+
* @see {@link GET_JobByJobId_Response_422} - 422 response type
|
|
7930
|
+
*
|
|
7931
|
+
|
|
7932
|
+
*/
|
|
7933
|
+
export type GET_JobByJobId_Response = GET_JobByJobId_Response_200 | GET_JobByJobId_Response_404 | GET_JobByJobId_Response_422;
|
|
7934
|
+
|
|
7935
|
+
/**
|
|
7936
|
+
* 200 response for GET JobByJobId endpoint
|
|
7937
|
+
*
|
|
7938
|
+
* @remarks
|
|
7939
|
+
* This type defines the response structure for the 200 status code
|
|
7940
|
+
* of the GET JobByJobId endpoint.
|
|
7941
|
+
* It provides type safety for handling this specific response as defined in the OpenAPI specification.
|
|
7942
|
+
*
|
|
7943
|
+
|
|
7944
|
+
*
|
|
7945
|
+
* @path /v1/job/{job_id}
|
|
7946
|
+
* @param job_id (path) - Job ID
|
|
7947
|
+
*
|
|
7948
|
+
* @see {@link GET_JobByJobId_Response} - The main response type definition
|
|
7949
|
+
* @see {@link Job} - The actual schema type definition
|
|
7950
|
+
*/
|
|
7951
|
+
export type GET_JobByJobId_Response_200 = Job
|
|
7952
|
+
|
|
7953
|
+
/**
|
|
7954
|
+
* 404 response for GET JobByJobId endpoint
|
|
7955
|
+
*
|
|
7956
|
+
* @remarks
|
|
7957
|
+
* This type defines the response structure for the 404 status code
|
|
7958
|
+
* of the GET JobByJobId endpoint.
|
|
7959
|
+
* It provides type safety for handling this specific response as defined in the OpenAPI specification.
|
|
7960
|
+
*
|
|
7961
|
+
|
|
7962
|
+
*
|
|
7963
|
+
* @path /v1/job/{job_id}
|
|
7964
|
+
* @param job_id (path) - Job ID
|
|
7965
|
+
*
|
|
7966
|
+
* @see {@link GET_JobByJobId_Response} - The main response type definition
|
|
7967
|
+
* @see {@link Problem} - The actual schema type definition
|
|
7968
|
+
*/
|
|
7969
|
+
export type GET_JobByJobId_Response_404 = Problem
|
|
7970
|
+
|
|
7971
|
+
/**
|
|
7972
|
+
* 422 response for GET JobByJobId endpoint
|
|
7973
|
+
*
|
|
7974
|
+
* @remarks
|
|
7975
|
+
* This type defines the response structure for the 422 status code
|
|
7976
|
+
* of the GET JobByJobId endpoint.
|
|
7977
|
+
* It provides type safety for handling this specific response as defined in the OpenAPI specification.
|
|
7978
|
+
*
|
|
7979
|
+
|
|
7980
|
+
*
|
|
7981
|
+
* @path /v1/job/{job_id}
|
|
7982
|
+
* @param job_id (path) - Job ID
|
|
7983
|
+
*
|
|
7984
|
+
* @see {@link GET_JobByJobId_Response} - The main response type definition
|
|
7985
|
+
* @see {@link HTTPValidationError} - The actual schema type definition
|
|
7986
|
+
*/
|
|
7987
|
+
export type GET_JobByJobId_Response_422 = HTTPValidationError
|
|
7988
|
+
|
|
7989
|
+
/**
|
|
7990
|
+
* Response types for POST JobByJobIdPause endpoint
|
|
7991
|
+
*
|
|
7992
|
+
* Pause a job
|
|
7993
|
+
*
|
|
7994
|
+
* @remarks
|
|
7995
|
+
* This type defines all possible response structures for the POST JobByJobIdPause endpoint.
|
|
7996
|
+
* Each response code maps to a specific response type as defined in the OpenAPI specification.
|
|
7997
|
+
* Use this type to ensure type safety when handling API responses from this endpoint.
|
|
7998
|
+
*
|
|
7999
|
+
|
|
8000
|
+
*
|
|
8001
|
+
* @path /v1/job/{job_id}/pause
|
|
8002
|
+
* @param job_id (path) - Job ID
|
|
8003
|
+
*
|
|
8004
|
+
* @see {@link POST_JobByJobIdPause_Response_404} - 404 response type
|
|
8005
|
+
* @see {@link POST_JobByJobIdPause_Response_422} - 422 response type
|
|
8006
|
+
*
|
|
8007
|
+
|
|
8008
|
+
*/
|
|
8009
|
+
export type POST_JobByJobIdPause_Response = POST_JobByJobIdPause_Response_404 | POST_JobByJobIdPause_Response_422;
|
|
8010
|
+
|
|
8011
|
+
/**
|
|
8012
|
+
* 404 response for POST JobByJobIdPause endpoint
|
|
8013
|
+
*
|
|
8014
|
+
* @remarks
|
|
8015
|
+
* This type defines the response structure for the 404 status code
|
|
8016
|
+
* of the POST JobByJobIdPause endpoint.
|
|
8017
|
+
* It provides type safety for handling this specific response as defined in the OpenAPI specification.
|
|
8018
|
+
*
|
|
8019
|
+
|
|
8020
|
+
*
|
|
8021
|
+
* @path /v1/job/{job_id}/pause
|
|
8022
|
+
* @param job_id (path) - Job ID
|
|
8023
|
+
*
|
|
8024
|
+
* @see {@link POST_JobByJobIdPause_Response} - The main response type definition
|
|
8025
|
+
* @see {@link Problem} - The actual schema type definition
|
|
8026
|
+
*/
|
|
8027
|
+
export type POST_JobByJobIdPause_Response_404 = Problem
|
|
8028
|
+
|
|
8029
|
+
/**
|
|
8030
|
+
* 422 response for POST JobByJobIdPause endpoint
|
|
8031
|
+
*
|
|
8032
|
+
* @remarks
|
|
8033
|
+
* This type defines the response structure for the 422 status code
|
|
8034
|
+
* of the POST JobByJobIdPause endpoint.
|
|
8035
|
+
* It provides type safety for handling this specific response as defined in the OpenAPI specification.
|
|
8036
|
+
*
|
|
8037
|
+
|
|
8038
|
+
*
|
|
8039
|
+
* @path /v1/job/{job_id}/pause
|
|
8040
|
+
* @param job_id (path) - Job ID
|
|
8041
|
+
*
|
|
8042
|
+
* @see {@link POST_JobByJobIdPause_Response} - The main response type definition
|
|
8043
|
+
* @see {@link HTTPValidationError} - The actual schema type definition
|
|
8044
|
+
*/
|
|
8045
|
+
export type POST_JobByJobIdPause_Response_422 = HTTPValidationError
|
|
8046
|
+
|
|
8047
|
+
/**
|
|
8048
|
+
* Response types for POST JobByJobIdResume endpoint
|
|
8049
|
+
*
|
|
8050
|
+
* Resume a paused job
|
|
8051
|
+
*
|
|
8052
|
+
* @remarks
|
|
8053
|
+
* This type defines all possible response structures for the POST JobByJobIdResume endpoint.
|
|
8054
|
+
* Each response code maps to a specific response type as defined in the OpenAPI specification.
|
|
8055
|
+
* Use this type to ensure type safety when handling API responses from this endpoint.
|
|
8056
|
+
*
|
|
8057
|
+
|
|
8058
|
+
*
|
|
8059
|
+
* @path /v1/job/{job_id}/resume
|
|
8060
|
+
* @param job_id (path) - Job ID
|
|
8061
|
+
*
|
|
8062
|
+
* @see {@link POST_JobByJobIdResume_Response_200} - 200 response type
|
|
8063
|
+
* @see {@link POST_JobByJobIdResume_Response_404} - 404 response type
|
|
8064
|
+
* @see {@link POST_JobByJobIdResume_Response_422} - 422 response type
|
|
8065
|
+
*
|
|
8066
|
+
|
|
8067
|
+
*/
|
|
8068
|
+
export type POST_JobByJobIdResume_Response = POST_JobByJobIdResume_Response_200 | POST_JobByJobIdResume_Response_404 | POST_JobByJobIdResume_Response_422;
|
|
8069
|
+
|
|
8070
|
+
/**
|
|
8071
|
+
* 200 response for POST JobByJobIdResume endpoint
|
|
8072
|
+
*
|
|
8073
|
+
* @remarks
|
|
8074
|
+
* This type defines the response structure for the 200 status code
|
|
8075
|
+
* of the POST JobByJobIdResume endpoint.
|
|
8076
|
+
* It provides type safety for handling this specific response as defined in the OpenAPI specification.
|
|
8077
|
+
*
|
|
8078
|
+
|
|
8079
|
+
*
|
|
8080
|
+
* @path /v1/job/{job_id}/resume
|
|
8081
|
+
* @param job_id (path) - Job ID
|
|
8082
|
+
*
|
|
8083
|
+
* @see {@link POST_JobByJobIdResume_Response} - The main response type definition
|
|
8084
|
+
* @see {@link Job} - The actual schema type definition
|
|
8085
|
+
*/
|
|
8086
|
+
export type POST_JobByJobIdResume_Response_200 = Job
|
|
8087
|
+
|
|
8088
|
+
/**
|
|
8089
|
+
* 404 response for POST JobByJobIdResume endpoint
|
|
8090
|
+
*
|
|
8091
|
+
* @remarks
|
|
8092
|
+
* This type defines the response structure for the 404 status code
|
|
8093
|
+
* of the POST JobByJobIdResume endpoint.
|
|
8094
|
+
* It provides type safety for handling this specific response as defined in the OpenAPI specification.
|
|
8095
|
+
*
|
|
8096
|
+
|
|
8097
|
+
*
|
|
8098
|
+
* @path /v1/job/{job_id}/resume
|
|
8099
|
+
* @param job_id (path) - Job ID
|
|
8100
|
+
*
|
|
8101
|
+
* @see {@link POST_JobByJobIdResume_Response} - The main response type definition
|
|
8102
|
+
* @see {@link Problem} - The actual schema type definition
|
|
8103
|
+
*/
|
|
8104
|
+
export type POST_JobByJobIdResume_Response_404 = Problem
|
|
8105
|
+
|
|
8106
|
+
/**
|
|
8107
|
+
* 422 response for POST JobByJobIdResume endpoint
|
|
8108
|
+
*
|
|
8109
|
+
* @remarks
|
|
8110
|
+
* This type defines the response structure for the 422 status code
|
|
8111
|
+
* of the POST JobByJobIdResume endpoint.
|
|
8112
|
+
* It provides type safety for handling this specific response as defined in the OpenAPI specification.
|
|
8113
|
+
*
|
|
8114
|
+
|
|
8115
|
+
*
|
|
8116
|
+
* @path /v1/job/{job_id}/resume
|
|
8117
|
+
* @param job_id (path) - Job ID
|
|
8118
|
+
*
|
|
8119
|
+
* @see {@link POST_JobByJobIdResume_Response} - The main response type definition
|
|
8120
|
+
* @see {@link HTTPValidationError} - The actual schema type definition
|
|
8121
|
+
*/
|
|
8122
|
+
export type POST_JobByJobIdResume_Response_422 = HTTPValidationError
|
|
8123
|
+
|
|
8124
|
+
/**
|
|
8125
|
+
* Response types for GET Jobs endpoint
|
|
8126
|
+
*
|
|
8127
|
+
* List batches for organization
|
|
8128
|
+
*
|
|
8129
|
+
* @remarks
|
|
8130
|
+
* This type defines all possible response structures for the GET Jobs endpoint.
|
|
8131
|
+
* Each response code maps to a specific response type as defined in the OpenAPI specification.
|
|
8132
|
+
* Use this type to ensure type safety when handling API responses from this endpoint.
|
|
8133
|
+
*
|
|
8134
|
+
|
|
8135
|
+
*
|
|
8136
|
+
* @path /v1/jobs
|
|
8137
|
+
* @param status (query) - Filter by batch status (pending or complete)
|
|
8138
|
+
* @param sort_by (query) - Sort field
|
|
8139
|
+
* @param sort_order (query) - Sort order
|
|
8140
|
+
*
|
|
8141
|
+
* @see {@link GET_Jobs_Response_200} - 200 response type
|
|
8142
|
+
* @see {@link GET_Jobs_Response_422} - 422 response type
|
|
8143
|
+
*
|
|
8144
|
+
|
|
8145
|
+
*/
|
|
8146
|
+
export type GET_Jobs_Response = GET_Jobs_Response_200 | GET_Jobs_Response_422;
|
|
8147
|
+
|
|
8148
|
+
/**
|
|
8149
|
+
* 200 response for GET Jobs endpoint
|
|
8150
|
+
*
|
|
8151
|
+
* @remarks
|
|
8152
|
+
* This type defines the response structure for the 200 status code
|
|
8153
|
+
* of the GET Jobs endpoint.
|
|
8154
|
+
* It provides type safety for handling this specific response as defined in the OpenAPI specification.
|
|
8155
|
+
*
|
|
8156
|
+
|
|
8157
|
+
*
|
|
8158
|
+
* @path /v1/jobs
|
|
8159
|
+
* @param status (query) - Filter by batch status (pending or complete)
|
|
8160
|
+
* @param sort_by (query) - Sort field
|
|
8161
|
+
* @param sort_order (query) - Sort order
|
|
8162
|
+
*
|
|
8163
|
+
* @see {@link GET_Jobs_Response} - The main response type definition
|
|
8164
|
+
* @see {@link Pagination_JobBatchMetadata} - The actual schema type definition
|
|
8165
|
+
*/
|
|
8166
|
+
export type GET_Jobs_Response_200 = Pagination_JobBatchMetadata
|
|
8167
|
+
|
|
8168
|
+
/**
|
|
8169
|
+
* 422 response for GET Jobs endpoint
|
|
8170
|
+
*
|
|
8171
|
+
* @remarks
|
|
8172
|
+
* This type defines the response structure for the 422 status code
|
|
8173
|
+
* of the GET Jobs endpoint.
|
|
8174
|
+
* It provides type safety for handling this specific response as defined in the OpenAPI specification.
|
|
8175
|
+
*
|
|
8176
|
+
|
|
8177
|
+
*
|
|
8178
|
+
* @path /v1/jobs
|
|
8179
|
+
* @param status (query) - Filter by batch status (pending or complete)
|
|
8180
|
+
* @param sort_by (query) - Sort field
|
|
8181
|
+
* @param sort_order (query) - Sort order
|
|
8182
|
+
*
|
|
8183
|
+
* @see {@link GET_Jobs_Response} - The main response type definition
|
|
8184
|
+
* @see {@link HTTPValidationError} - The actual schema type definition
|
|
8185
|
+
*/
|
|
8186
|
+
export type GET_Jobs_Response_422 = HTTPValidationError
|
|
8187
|
+
|
|
8188
|
+
/**
|
|
8189
|
+
* Response types for POST Jobs endpoint
|
|
8190
|
+
*
|
|
8191
|
+
* Create a batch of commands for async execution
|
|
8192
|
+
*
|
|
8193
|
+
* @remarks
|
|
8194
|
+
* This type defines all possible response structures for the POST Jobs endpoint.
|
|
8195
|
+
* Each response code maps to a specific response type as defined in the OpenAPI specification.
|
|
8196
|
+
* Use this type to ensure type safety when handling API responses from this endpoint.
|
|
8197
|
+
*
|
|
8198
|
+
|
|
8199
|
+
*
|
|
8200
|
+
* @path /v1/jobs
|
|
8201
|
+
*
|
|
8202
|
+
* @see {@link POST_Jobs_Response_201} - 201 response type
|
|
8203
|
+
* @see {@link POST_Jobs_Response_400} - 400 response type
|
|
8204
|
+
* @see {@link POST_Jobs_Response_422} - 422 response type
|
|
8205
|
+
* @see {@link POST_Jobs_Response_503} - 503 response type
|
|
8206
|
+
*
|
|
8207
|
+
|
|
8208
|
+
*/
|
|
8209
|
+
export type POST_Jobs_Response = POST_Jobs_Response_201 | POST_Jobs_Response_400 | POST_Jobs_Response_422 | POST_Jobs_Response_503;
|
|
8210
|
+
|
|
8211
|
+
/**
|
|
8212
|
+
* 201 response for POST Jobs endpoint
|
|
8213
|
+
*
|
|
8214
|
+
* @remarks
|
|
8215
|
+
* This type defines the response structure for the 201 status code
|
|
8216
|
+
* of the POST Jobs endpoint.
|
|
8217
|
+
* It provides type safety for handling this specific response as defined in the OpenAPI specification.
|
|
8218
|
+
*
|
|
8219
|
+
|
|
8220
|
+
*
|
|
8221
|
+
* @path /v1/jobs
|
|
8222
|
+
*
|
|
8223
|
+
* @see {@link POST_Jobs_Response} - The main response type definition
|
|
8224
|
+
* @see {@link CreateJobBatch} - The actual schema type definition
|
|
8225
|
+
*/
|
|
8226
|
+
export type POST_Jobs_Response_201 = CreateJobBatch
|
|
8227
|
+
|
|
8228
|
+
/**
|
|
8229
|
+
* 400 response for POST Jobs endpoint
|
|
8230
|
+
*
|
|
8231
|
+
* @remarks
|
|
8232
|
+
* This type defines the response structure for the 400 status code
|
|
8233
|
+
* of the POST Jobs endpoint.
|
|
8234
|
+
* It provides type safety for handling this specific response as defined in the OpenAPI specification.
|
|
8235
|
+
*
|
|
8236
|
+
|
|
8237
|
+
*
|
|
8238
|
+
* @path /v1/jobs
|
|
8239
|
+
*
|
|
8240
|
+
* @see {@link POST_Jobs_Response} - The main response type definition
|
|
8241
|
+
* @see {@link Problem} - The actual schema type definition
|
|
8242
|
+
*/
|
|
8243
|
+
export type POST_Jobs_Response_400 = Problem
|
|
8244
|
+
|
|
8245
|
+
/**
|
|
8246
|
+
* 422 response for POST Jobs endpoint
|
|
8247
|
+
*
|
|
8248
|
+
* @remarks
|
|
8249
|
+
* This type defines the response structure for the 422 status code
|
|
8250
|
+
* of the POST Jobs endpoint.
|
|
8251
|
+
* It provides type safety for handling this specific response as defined in the OpenAPI specification.
|
|
8252
|
+
*
|
|
8253
|
+
|
|
8254
|
+
*
|
|
8255
|
+
* @path /v1/jobs
|
|
8256
|
+
*
|
|
8257
|
+
* @see {@link POST_Jobs_Response} - The main response type definition
|
|
8258
|
+
* @see {@link HTTPValidationError} - The actual schema type definition
|
|
8259
|
+
*/
|
|
8260
|
+
export type POST_Jobs_Response_422 = HTTPValidationError
|
|
8261
|
+
|
|
8262
|
+
/**
|
|
8263
|
+
* 503 response for POST Jobs endpoint
|
|
8264
|
+
*
|
|
8265
|
+
* @remarks
|
|
8266
|
+
* This type defines the response structure for the 503 status code
|
|
8267
|
+
* of the POST Jobs endpoint.
|
|
8268
|
+
* It provides type safety for handling this specific response as defined in the OpenAPI specification.
|
|
8269
|
+
*
|
|
8270
|
+
|
|
8271
|
+
*
|
|
8272
|
+
* @path /v1/jobs
|
|
8273
|
+
*
|
|
8274
|
+
* @see {@link POST_Jobs_Response} - The main response type definition
|
|
8275
|
+
* @see {@link Problem} - The actual schema type definition
|
|
8276
|
+
*/
|
|
8277
|
+
export type POST_Jobs_Response_503 = Problem
|
|
8278
|
+
|
|
8279
|
+
/**
|
|
8280
|
+
* Response types for DELETE JobsByBatchId endpoint
|
|
8281
|
+
*
|
|
8282
|
+
* Delete (cancel) all queued jobs in a batch
|
|
8283
|
+
*
|
|
8284
|
+
* @remarks
|
|
8285
|
+
* This type defines all possible response structures for the DELETE JobsByBatchId endpoint.
|
|
8286
|
+
* Each response code maps to a specific response type as defined in the OpenAPI specification.
|
|
8287
|
+
* Use this type to ensure type safety when handling API responses from this endpoint.
|
|
8288
|
+
*
|
|
8289
|
+
|
|
8290
|
+
*
|
|
8291
|
+
* @path /v1/jobs/{batch_id}
|
|
8292
|
+
* @param batch_id (path) - Batch ID
|
|
8293
|
+
*
|
|
8294
|
+
* @see {@link DELETE_JobsByBatchId_Response_404} - 404 response type
|
|
8295
|
+
* @see {@link DELETE_JobsByBatchId_Response_422} - 422 response type
|
|
8296
|
+
*
|
|
8297
|
+
|
|
8298
|
+
*/
|
|
8299
|
+
export type DELETE_JobsByBatchId_Response = DELETE_JobsByBatchId_Response_404 | DELETE_JobsByBatchId_Response_422;
|
|
8300
|
+
|
|
8301
|
+
/**
|
|
8302
|
+
* 404 response for DELETE JobsByBatchId endpoint
|
|
8303
|
+
*
|
|
8304
|
+
* @remarks
|
|
8305
|
+
* This type defines the response structure for the 404 status code
|
|
8306
|
+
* of the DELETE JobsByBatchId endpoint.
|
|
8307
|
+
* It provides type safety for handling this specific response as defined in the OpenAPI specification.
|
|
8308
|
+
*
|
|
8309
|
+
|
|
8310
|
+
*
|
|
8311
|
+
* @path /v1/jobs/{batch_id}
|
|
8312
|
+
* @param batch_id (path) - Batch ID
|
|
8313
|
+
*
|
|
8314
|
+
* @see {@link DELETE_JobsByBatchId_Response} - The main response type definition
|
|
8315
|
+
* @see {@link Problem} - The actual schema type definition
|
|
8316
|
+
*/
|
|
8317
|
+
export type DELETE_JobsByBatchId_Response_404 = Problem
|
|
8318
|
+
|
|
8319
|
+
/**
|
|
8320
|
+
* 422 response for DELETE JobsByBatchId endpoint
|
|
8321
|
+
*
|
|
8322
|
+
* @remarks
|
|
8323
|
+
* This type defines the response structure for the 422 status code
|
|
8324
|
+
* of the DELETE JobsByBatchId endpoint.
|
|
8325
|
+
* It provides type safety for handling this specific response as defined in the OpenAPI specification.
|
|
8326
|
+
*
|
|
8327
|
+
|
|
8328
|
+
*
|
|
8329
|
+
* @path /v1/jobs/{batch_id}
|
|
8330
|
+
* @param batch_id (path) - Batch ID
|
|
8331
|
+
*
|
|
8332
|
+
* @see {@link DELETE_JobsByBatchId_Response} - The main response type definition
|
|
8333
|
+
* @see {@link HTTPValidationError} - The actual schema type definition
|
|
8334
|
+
*/
|
|
8335
|
+
export type DELETE_JobsByBatchId_Response_422 = HTTPValidationError
|
|
8336
|
+
|
|
8337
|
+
/**
|
|
8338
|
+
* Response types for GET JobsByBatchId endpoint
|
|
8339
|
+
*
|
|
8340
|
+
* Get batch details and execution status
|
|
8341
|
+
*
|
|
8342
|
+
* @remarks
|
|
8343
|
+
* This type defines all possible response structures for the GET JobsByBatchId endpoint.
|
|
8344
|
+
* Each response code maps to a specific response type as defined in the OpenAPI specification.
|
|
8345
|
+
* Use this type to ensure type safety when handling API responses from this endpoint.
|
|
8346
|
+
*
|
|
8347
|
+
|
|
8348
|
+
*
|
|
8349
|
+
* @path /v1/jobs/{batch_id}
|
|
8350
|
+
* @param batch_id (path) - Batch ID
|
|
8351
|
+
*
|
|
8352
|
+
* @see {@link GET_JobsByBatchId_Response_200} - 200 response type
|
|
8353
|
+
* @see {@link GET_JobsByBatchId_Response_404} - 404 response type
|
|
8354
|
+
* @see {@link GET_JobsByBatchId_Response_422} - 422 response type
|
|
8355
|
+
* @see {@link GET_JobsByBatchId_Response_503} - 503 response type
|
|
8356
|
+
*
|
|
8357
|
+
|
|
8358
|
+
*/
|
|
8359
|
+
export type GET_JobsByBatchId_Response = GET_JobsByBatchId_Response_200 | GET_JobsByBatchId_Response_404 | GET_JobsByBatchId_Response_422 | GET_JobsByBatchId_Response_503;
|
|
8360
|
+
|
|
8361
|
+
/**
|
|
8362
|
+
* 200 response for GET JobsByBatchId endpoint
|
|
8363
|
+
*
|
|
8364
|
+
* @remarks
|
|
8365
|
+
* This type defines the response structure for the 200 status code
|
|
8366
|
+
* of the GET JobsByBatchId endpoint.
|
|
8367
|
+
* It provides type safety for handling this specific response as defined in the OpenAPI specification.
|
|
8368
|
+
*
|
|
8369
|
+
|
|
8370
|
+
*
|
|
8371
|
+
* @path /v1/jobs/{batch_id}
|
|
8372
|
+
* @param batch_id (path) - Batch ID
|
|
8373
|
+
*
|
|
8374
|
+
* @see {@link GET_JobsByBatchId_Response} - The main response type definition
|
|
8375
|
+
* @see {@link JobBatchStatus} - The actual schema type definition
|
|
8376
|
+
*/
|
|
8377
|
+
export type GET_JobsByBatchId_Response_200 = JobBatchStatus
|
|
8378
|
+
|
|
8379
|
+
/**
|
|
8380
|
+
* 404 response for GET JobsByBatchId endpoint
|
|
8381
|
+
*
|
|
8382
|
+
* @remarks
|
|
8383
|
+
* This type defines the response structure for the 404 status code
|
|
8384
|
+
* of the GET JobsByBatchId endpoint.
|
|
8385
|
+
* It provides type safety for handling this specific response as defined in the OpenAPI specification.
|
|
8386
|
+
*
|
|
8387
|
+
|
|
8388
|
+
*
|
|
8389
|
+
* @path /v1/jobs/{batch_id}
|
|
8390
|
+
* @param batch_id (path) - Batch ID
|
|
8391
|
+
*
|
|
8392
|
+
* @see {@link GET_JobsByBatchId_Response} - The main response type definition
|
|
8393
|
+
* @see {@link Problem} - The actual schema type definition
|
|
8394
|
+
*/
|
|
8395
|
+
export type GET_JobsByBatchId_Response_404 = Problem
|
|
8396
|
+
|
|
8397
|
+
/**
|
|
8398
|
+
* 422 response for GET JobsByBatchId endpoint
|
|
8399
|
+
*
|
|
8400
|
+
* @remarks
|
|
8401
|
+
* This type defines the response structure for the 422 status code
|
|
8402
|
+
* of the GET JobsByBatchId endpoint.
|
|
8403
|
+
* It provides type safety for handling this specific response as defined in the OpenAPI specification.
|
|
8404
|
+
*
|
|
8405
|
+
|
|
8406
|
+
*
|
|
8407
|
+
* @path /v1/jobs/{batch_id}
|
|
8408
|
+
* @param batch_id (path) - Batch ID
|
|
8409
|
+
*
|
|
8410
|
+
* @see {@link GET_JobsByBatchId_Response} - The main response type definition
|
|
8411
|
+
* @see {@link HTTPValidationError} - The actual schema type definition
|
|
8412
|
+
*/
|
|
8413
|
+
export type GET_JobsByBatchId_Response_422 = HTTPValidationError
|
|
8414
|
+
|
|
8415
|
+
/**
|
|
8416
|
+
* 503 response for GET JobsByBatchId endpoint
|
|
8417
|
+
*
|
|
8418
|
+
* @remarks
|
|
8419
|
+
* This type defines the response structure for the 503 status code
|
|
8420
|
+
* of the GET JobsByBatchId endpoint.
|
|
8421
|
+
* It provides type safety for handling this specific response as defined in the OpenAPI specification.
|
|
8422
|
+
*
|
|
8423
|
+
|
|
8424
|
+
*
|
|
8425
|
+
* @path /v1/jobs/{batch_id}
|
|
8426
|
+
* @param batch_id (path) - Batch ID
|
|
8427
|
+
*
|
|
8428
|
+
* @see {@link GET_JobsByBatchId_Response} - The main response type definition
|
|
8429
|
+
* @see {@link Problem} - The actual schema type definition
|
|
8430
|
+
*/
|
|
8431
|
+
export type GET_JobsByBatchId_Response_503 = Problem
|
|
8432
|
+
|
|
8433
|
+
/**
|
|
8434
|
+
* Response types for GET JobsByBatchIdJobs endpoint
|
|
8435
|
+
*
|
|
8436
|
+
* Get individual jobs within a batch
|
|
8437
|
+
*
|
|
8438
|
+
* @remarks
|
|
8439
|
+
* This type defines all possible response structures for the GET JobsByBatchIdJobs endpoint.
|
|
8440
|
+
* Each response code maps to a specific response type as defined in the OpenAPI specification.
|
|
8441
|
+
* Use this type to ensure type safety when handling API responses from this endpoint.
|
|
8442
|
+
*
|
|
8443
|
+
|
|
8444
|
+
*
|
|
8445
|
+
* @path /v1/jobs/{batch_id}/jobs
|
|
8446
|
+
* @param batch_id (path) - Batch ID
|
|
8447
|
+
* @param status (query) - Filter by job status (repeatable)
|
|
8448
|
+
* @param sort_by (query) - Sort field
|
|
8449
|
+
* @param sort_order (query) - Sort order
|
|
8450
|
+
*
|
|
8451
|
+
* @see {@link GET_JobsByBatchIdJobs_Response_200} - 200 response type
|
|
8452
|
+
* @see {@link GET_JobsByBatchIdJobs_Response_404} - 404 response type
|
|
8453
|
+
* @see {@link GET_JobsByBatchIdJobs_Response_422} - 422 response type
|
|
8454
|
+
* @see {@link GET_JobsByBatchIdJobs_Response_503} - 503 response type
|
|
8455
|
+
*
|
|
8456
|
+
|
|
8457
|
+
*/
|
|
8458
|
+
export type GET_JobsByBatchIdJobs_Response = GET_JobsByBatchIdJobs_Response_200 | GET_JobsByBatchIdJobs_Response_404 | GET_JobsByBatchIdJobs_Response_422 | GET_JobsByBatchIdJobs_Response_503;
|
|
8459
|
+
|
|
8460
|
+
/**
|
|
8461
|
+
* 200 response for GET JobsByBatchIdJobs endpoint
|
|
8462
|
+
*
|
|
8463
|
+
* @remarks
|
|
8464
|
+
* This type defines the response structure for the 200 status code
|
|
8465
|
+
* of the GET JobsByBatchIdJobs endpoint.
|
|
8466
|
+
* It provides type safety for handling this specific response as defined in the OpenAPI specification.
|
|
8467
|
+
*
|
|
8468
|
+
|
|
8469
|
+
*
|
|
8470
|
+
* @path /v1/jobs/{batch_id}/jobs
|
|
8471
|
+
* @param batch_id (path) - Batch ID
|
|
8472
|
+
* @param status (query) - Filter by job status (repeatable)
|
|
8473
|
+
* @param sort_by (query) - Sort field
|
|
8474
|
+
* @param sort_order (query) - Sort order
|
|
8475
|
+
*
|
|
8476
|
+
* @see {@link GET_JobsByBatchIdJobs_Response} - The main response type definition
|
|
8477
|
+
* @see {@link Pagination_Job} - The actual schema type definition
|
|
8478
|
+
*/
|
|
8479
|
+
export type GET_JobsByBatchIdJobs_Response_200 = Pagination_Job
|
|
8480
|
+
|
|
8481
|
+
/**
|
|
8482
|
+
* 404 response for GET JobsByBatchIdJobs endpoint
|
|
8483
|
+
*
|
|
8484
|
+
* @remarks
|
|
8485
|
+
* This type defines the response structure for the 404 status code
|
|
8486
|
+
* of the GET JobsByBatchIdJobs endpoint.
|
|
8487
|
+
* It provides type safety for handling this specific response as defined in the OpenAPI specification.
|
|
8488
|
+
*
|
|
8489
|
+
|
|
8490
|
+
*
|
|
8491
|
+
* @path /v1/jobs/{batch_id}/jobs
|
|
8492
|
+
* @param batch_id (path) - Batch ID
|
|
8493
|
+
* @param status (query) - Filter by job status (repeatable)
|
|
8494
|
+
* @param sort_by (query) - Sort field
|
|
8495
|
+
* @param sort_order (query) - Sort order
|
|
8496
|
+
*
|
|
8497
|
+
* @see {@link GET_JobsByBatchIdJobs_Response} - The main response type definition
|
|
8498
|
+
* @see {@link Problem} - The actual schema type definition
|
|
8499
|
+
*/
|
|
8500
|
+
export type GET_JobsByBatchIdJobs_Response_404 = Problem
|
|
8501
|
+
|
|
8502
|
+
/**
|
|
8503
|
+
* 422 response for GET JobsByBatchIdJobs endpoint
|
|
8504
|
+
*
|
|
8505
|
+
* @remarks
|
|
8506
|
+
* This type defines the response structure for the 422 status code
|
|
8507
|
+
* of the GET JobsByBatchIdJobs endpoint.
|
|
8508
|
+
* It provides type safety for handling this specific response as defined in the OpenAPI specification.
|
|
8509
|
+
*
|
|
8510
|
+
|
|
8511
|
+
*
|
|
8512
|
+
* @path /v1/jobs/{batch_id}/jobs
|
|
8513
|
+
* @param batch_id (path) - Batch ID
|
|
8514
|
+
* @param status (query) - Filter by job status (repeatable)
|
|
8515
|
+
* @param sort_by (query) - Sort field
|
|
8516
|
+
* @param sort_order (query) - Sort order
|
|
8517
|
+
*
|
|
8518
|
+
* @see {@link GET_JobsByBatchIdJobs_Response} - The main response type definition
|
|
8519
|
+
* @see {@link HTTPValidationError} - The actual schema type definition
|
|
8520
|
+
*/
|
|
8521
|
+
export type GET_JobsByBatchIdJobs_Response_422 = HTTPValidationError
|
|
8522
|
+
|
|
8523
|
+
/**
|
|
8524
|
+
* 503 response for GET JobsByBatchIdJobs endpoint
|
|
8525
|
+
*
|
|
8526
|
+
* @remarks
|
|
8527
|
+
* This type defines the response structure for the 503 status code
|
|
8528
|
+
* of the GET JobsByBatchIdJobs endpoint.
|
|
8529
|
+
* It provides type safety for handling this specific response as defined in the OpenAPI specification.
|
|
8530
|
+
*
|
|
8531
|
+
|
|
8532
|
+
*
|
|
8533
|
+
* @path /v1/jobs/{batch_id}/jobs
|
|
8534
|
+
* @param batch_id (path) - Batch ID
|
|
8535
|
+
* @param status (query) - Filter by job status (repeatable)
|
|
8536
|
+
* @param sort_by (query) - Sort field
|
|
8537
|
+
* @param sort_order (query) - Sort order
|
|
8538
|
+
*
|
|
8539
|
+
* @see {@link GET_JobsByBatchIdJobs_Response} - The main response type definition
|
|
8540
|
+
* @see {@link Problem} - The actual schema type definition
|
|
8541
|
+
*/
|
|
8542
|
+
export type GET_JobsByBatchIdJobs_Response_503 = Problem
|
|
8543
|
+
|
|
8544
|
+
/**
|
|
8545
|
+
* Response types for POST JobsByBatchIdPause endpoint
|
|
8546
|
+
*
|
|
8547
|
+
* Pause all eligible jobs in a batch
|
|
8548
|
+
*
|
|
8549
|
+
* @remarks
|
|
8550
|
+
* This type defines all possible response structures for the POST JobsByBatchIdPause endpoint.
|
|
8551
|
+
* Each response code maps to a specific response type as defined in the OpenAPI specification.
|
|
8552
|
+
* Use this type to ensure type safety when handling API responses from this endpoint.
|
|
8553
|
+
*
|
|
8554
|
+
|
|
8555
|
+
*
|
|
8556
|
+
* @path /v1/jobs/{batch_id}/pause
|
|
8557
|
+
* @param batch_id (path) - Batch ID
|
|
8558
|
+
*
|
|
8559
|
+
* @see {@link POST_JobsByBatchIdPause_Response_404} - 404 response type
|
|
8560
|
+
* @see {@link POST_JobsByBatchIdPause_Response_422} - 422 response type
|
|
8561
|
+
*
|
|
8562
|
+
|
|
8563
|
+
*/
|
|
8564
|
+
export type POST_JobsByBatchIdPause_Response = POST_JobsByBatchIdPause_Response_404 | POST_JobsByBatchIdPause_Response_422;
|
|
8565
|
+
|
|
8566
|
+
/**
|
|
8567
|
+
* 404 response for POST JobsByBatchIdPause endpoint
|
|
8568
|
+
*
|
|
8569
|
+
* @remarks
|
|
8570
|
+
* This type defines the response structure for the 404 status code
|
|
8571
|
+
* of the POST JobsByBatchIdPause endpoint.
|
|
8572
|
+
* It provides type safety for handling this specific response as defined in the OpenAPI specification.
|
|
8573
|
+
*
|
|
8574
|
+
|
|
8575
|
+
*
|
|
8576
|
+
* @path /v1/jobs/{batch_id}/pause
|
|
8577
|
+
* @param batch_id (path) - Batch ID
|
|
8578
|
+
*
|
|
8579
|
+
* @see {@link POST_JobsByBatchIdPause_Response} - The main response type definition
|
|
8580
|
+
* @see {@link Problem} - The actual schema type definition
|
|
8581
|
+
*/
|
|
8582
|
+
export type POST_JobsByBatchIdPause_Response_404 = Problem
|
|
8583
|
+
|
|
8584
|
+
/**
|
|
8585
|
+
* 422 response for POST JobsByBatchIdPause endpoint
|
|
8586
|
+
*
|
|
8587
|
+
* @remarks
|
|
8588
|
+
* This type defines the response structure for the 422 status code
|
|
8589
|
+
* of the POST JobsByBatchIdPause endpoint.
|
|
8590
|
+
* It provides type safety for handling this specific response as defined in the OpenAPI specification.
|
|
8591
|
+
*
|
|
8592
|
+
|
|
8593
|
+
*
|
|
8594
|
+
* @path /v1/jobs/{batch_id}/pause
|
|
8595
|
+
* @param batch_id (path) - Batch ID
|
|
8596
|
+
*
|
|
8597
|
+
* @see {@link POST_JobsByBatchIdPause_Response} - The main response type definition
|
|
8598
|
+
* @see {@link HTTPValidationError} - The actual schema type definition
|
|
8599
|
+
*/
|
|
8600
|
+
export type POST_JobsByBatchIdPause_Response_422 = HTTPValidationError
|
|
8601
|
+
|
|
8602
|
+
/**
|
|
8603
|
+
* Response types for POST JobsByBatchIdResume endpoint
|
|
8604
|
+
*
|
|
8605
|
+
* Resume all paused jobs in a batch
|
|
8606
|
+
*
|
|
8607
|
+
* @remarks
|
|
8608
|
+
* This type defines all possible response structures for the POST JobsByBatchIdResume endpoint.
|
|
8609
|
+
* Each response code maps to a specific response type as defined in the OpenAPI specification.
|
|
8610
|
+
* Use this type to ensure type safety when handling API responses from this endpoint.
|
|
8611
|
+
*
|
|
8612
|
+
|
|
8613
|
+
*
|
|
8614
|
+
* @path /v1/jobs/{batch_id}/resume
|
|
8615
|
+
* @param batch_id (path) - Batch ID
|
|
8616
|
+
*
|
|
8617
|
+
* @see {@link POST_JobsByBatchIdResume_Response_404} - 404 response type
|
|
8618
|
+
* @see {@link POST_JobsByBatchIdResume_Response_422} - 422 response type
|
|
8619
|
+
*
|
|
8620
|
+
|
|
8621
|
+
*/
|
|
8622
|
+
export type POST_JobsByBatchIdResume_Response = POST_JobsByBatchIdResume_Response_404 | POST_JobsByBatchIdResume_Response_422;
|
|
8623
|
+
|
|
8624
|
+
/**
|
|
8625
|
+
* 404 response for POST JobsByBatchIdResume endpoint
|
|
8626
|
+
*
|
|
8627
|
+
* @remarks
|
|
8628
|
+
* This type defines the response structure for the 404 status code
|
|
8629
|
+
* of the POST JobsByBatchIdResume endpoint.
|
|
8630
|
+
* It provides type safety for handling this specific response as defined in the OpenAPI specification.
|
|
8631
|
+
*
|
|
8632
|
+
|
|
8633
|
+
*
|
|
8634
|
+
* @path /v1/jobs/{batch_id}/resume
|
|
8635
|
+
* @param batch_id (path) - Batch ID
|
|
8636
|
+
*
|
|
8637
|
+
* @see {@link POST_JobsByBatchIdResume_Response} - The main response type definition
|
|
8638
|
+
* @see {@link Problem} - The actual schema type definition
|
|
8639
|
+
*/
|
|
8640
|
+
export type POST_JobsByBatchIdResume_Response_404 = Problem
|
|
8641
|
+
|
|
8642
|
+
/**
|
|
8643
|
+
* 422 response for POST JobsByBatchIdResume endpoint
|
|
8644
|
+
*
|
|
8645
|
+
* @remarks
|
|
8646
|
+
* This type defines the response structure for the 422 status code
|
|
8647
|
+
* of the POST JobsByBatchIdResume endpoint.
|
|
8648
|
+
* It provides type safety for handling this specific response as defined in the OpenAPI specification.
|
|
8649
|
+
*
|
|
8650
|
+
|
|
8651
|
+
*
|
|
8652
|
+
* @path /v1/jobs/{batch_id}/resume
|
|
8653
|
+
* @param batch_id (path) - Batch ID
|
|
8654
|
+
*
|
|
8655
|
+
* @see {@link POST_JobsByBatchIdResume_Response} - The main response type definition
|
|
8656
|
+
* @see {@link HTTPValidationError} - The actual schema type definition
|
|
8657
|
+
*/
|
|
8658
|
+
export type POST_JobsByBatchIdResume_Response_422 = HTTPValidationError
|
|
8659
|
+
|
|
7854
8660
|
/**
|
|
7855
8661
|
* Response types for GET Organizations endpoint
|
|
7856
8662
|
*
|
|
@@ -10103,6 +10909,190 @@ export type GET_ParkingSignupStatus_Response_403 = Problem
|
|
|
10103
10909
|
*/
|
|
10104
10910
|
export type GET_ParkingSignupStatus_Response_422 = HTTPValidationError
|
|
10105
10911
|
|
|
10912
|
+
/**
|
|
10913
|
+
* Response types for GET Reports endpoint
|
|
10914
|
+
*
|
|
10915
|
+
* List Reports
|
|
10916
|
+
*
|
|
10917
|
+
* @remarks
|
|
10918
|
+
* This type defines all possible response structures for the GET Reports endpoint.
|
|
10919
|
+
* Each response code maps to a specific response type as defined in the OpenAPI specification.
|
|
10920
|
+
* Use this type to ensure type safety when handling API responses from this endpoint.
|
|
10921
|
+
*
|
|
10922
|
+
|
|
10923
|
+
*
|
|
10924
|
+
* @path /v1/reports
|
|
10925
|
+
*
|
|
10926
|
+
* @see {@link GET_Reports_Response_200} - 200 response type
|
|
10927
|
+
* @see {@link GET_Reports_Response_422} - 422 response type
|
|
10928
|
+
*
|
|
10929
|
+
|
|
10930
|
+
*/
|
|
10931
|
+
export type GET_Reports_Response = GET_Reports_Response_200 | GET_Reports_Response_422;
|
|
10932
|
+
|
|
10933
|
+
/**
|
|
10934
|
+
* 200 response for GET Reports endpoint
|
|
10935
|
+
*
|
|
10936
|
+
* @remarks
|
|
10937
|
+
* This type defines the response structure for the 200 status code
|
|
10938
|
+
* of the GET Reports endpoint.
|
|
10939
|
+
* It provides type safety for handling this specific response as defined in the OpenAPI specification.
|
|
10940
|
+
*
|
|
10941
|
+
|
|
10942
|
+
*
|
|
10943
|
+
* @path /v1/reports
|
|
10944
|
+
*
|
|
10945
|
+
* @see {@link GET_Reports_Response} - The main response type definition
|
|
10946
|
+
* @see {@link PublicReportListRes} - The actual schema type definition
|
|
10947
|
+
*/
|
|
10948
|
+
export type GET_Reports_Response_200 = PublicReportListRes
|
|
10949
|
+
|
|
10950
|
+
/**
|
|
10951
|
+
* 422 response for GET Reports endpoint
|
|
10952
|
+
*
|
|
10953
|
+
* @remarks
|
|
10954
|
+
* This type defines the response structure for the 422 status code
|
|
10955
|
+
* of the GET Reports endpoint.
|
|
10956
|
+
* It provides type safety for handling this specific response as defined in the OpenAPI specification.
|
|
10957
|
+
*
|
|
10958
|
+
|
|
10959
|
+
*
|
|
10960
|
+
* @path /v1/reports
|
|
10961
|
+
*
|
|
10962
|
+
* @see {@link GET_Reports_Response} - The main response type definition
|
|
10963
|
+
* @see {@link HTTPValidationError} - The actual schema type definition
|
|
10964
|
+
*/
|
|
10965
|
+
export type GET_Reports_Response_422 = HTTPValidationError
|
|
10966
|
+
|
|
10967
|
+
/**
|
|
10968
|
+
* Response types for POST Reports endpoint
|
|
10969
|
+
*
|
|
10970
|
+
* Create Report
|
|
10971
|
+
*
|
|
10972
|
+
* @remarks
|
|
10973
|
+
* This type defines all possible response structures for the POST Reports endpoint.
|
|
10974
|
+
* Each response code maps to a specific response type as defined in the OpenAPI specification.
|
|
10975
|
+
* Use this type to ensure type safety when handling API responses from this endpoint.
|
|
10976
|
+
*
|
|
10977
|
+
|
|
10978
|
+
*
|
|
10979
|
+
* @path /v1/reports
|
|
10980
|
+
*
|
|
10981
|
+
* @see {@link POST_Reports_Response_422} - 422 response type
|
|
10982
|
+
*
|
|
10983
|
+
|
|
10984
|
+
*/
|
|
10985
|
+
export type POST_Reports_Response = POST_Reports_Response_422;
|
|
10986
|
+
|
|
10987
|
+
/**
|
|
10988
|
+
* 422 response for POST Reports endpoint
|
|
10989
|
+
*
|
|
10990
|
+
* @remarks
|
|
10991
|
+
* This type defines the response structure for the 422 status code
|
|
10992
|
+
* of the POST Reports endpoint.
|
|
10993
|
+
* It provides type safety for handling this specific response as defined in the OpenAPI specification.
|
|
10994
|
+
*
|
|
10995
|
+
|
|
10996
|
+
*
|
|
10997
|
+
* @path /v1/reports
|
|
10998
|
+
*
|
|
10999
|
+
* @see {@link POST_Reports_Response} - The main response type definition
|
|
11000
|
+
* @see {@link HTTPValidationError} - The actual schema type definition
|
|
11001
|
+
*/
|
|
11002
|
+
export type POST_Reports_Response_422 = HTTPValidationError
|
|
11003
|
+
|
|
11004
|
+
/**
|
|
11005
|
+
* Response types for GET ReportsByReportId endpoint
|
|
11006
|
+
*
|
|
11007
|
+
* Get Report
|
|
11008
|
+
*
|
|
11009
|
+
* @remarks
|
|
11010
|
+
* This type defines all possible response structures for the GET ReportsByReportId endpoint.
|
|
11011
|
+
* Each response code maps to a specific response type as defined in the OpenAPI specification.
|
|
11012
|
+
* Use this type to ensure type safety when handling API responses from this endpoint.
|
|
11013
|
+
*
|
|
11014
|
+
|
|
11015
|
+
*
|
|
11016
|
+
* @path /v1/reports/{report_id}
|
|
11017
|
+
*
|
|
11018
|
+
* @see {@link GET_ReportsByReportId_Response_200} - 200 response type
|
|
11019
|
+
* @see {@link GET_ReportsByReportId_Response_422} - 422 response type
|
|
11020
|
+
*
|
|
11021
|
+
|
|
11022
|
+
*/
|
|
11023
|
+
export type GET_ReportsByReportId_Response = GET_ReportsByReportId_Response_200 | GET_ReportsByReportId_Response_422;
|
|
11024
|
+
|
|
11025
|
+
/**
|
|
11026
|
+
* 200 response for GET ReportsByReportId endpoint
|
|
11027
|
+
*
|
|
11028
|
+
* @remarks
|
|
11029
|
+
* This type defines the response structure for the 200 status code
|
|
11030
|
+
* of the GET ReportsByReportId endpoint.
|
|
11031
|
+
* It provides type safety for handling this specific response as defined in the OpenAPI specification.
|
|
11032
|
+
*
|
|
11033
|
+
|
|
11034
|
+
*
|
|
11035
|
+
* @path /v1/reports/{report_id}
|
|
11036
|
+
*
|
|
11037
|
+
* @see {@link GET_ReportsByReportId_Response} - The main response type definition
|
|
11038
|
+
* @see {@link PublicReportRes} - The actual schema type definition
|
|
11039
|
+
*/
|
|
11040
|
+
export type GET_ReportsByReportId_Response_200 = PublicReportRes
|
|
11041
|
+
|
|
11042
|
+
/**
|
|
11043
|
+
* 422 response for GET ReportsByReportId endpoint
|
|
11044
|
+
*
|
|
11045
|
+
* @remarks
|
|
11046
|
+
* This type defines the response structure for the 422 status code
|
|
11047
|
+
* of the GET ReportsByReportId endpoint.
|
|
11048
|
+
* It provides type safety for handling this specific response as defined in the OpenAPI specification.
|
|
11049
|
+
*
|
|
11050
|
+
|
|
11051
|
+
*
|
|
11052
|
+
* @path /v1/reports/{report_id}
|
|
11053
|
+
*
|
|
11054
|
+
* @see {@link GET_ReportsByReportId_Response} - The main response type definition
|
|
11055
|
+
* @see {@link HTTPValidationError} - The actual schema type definition
|
|
11056
|
+
*/
|
|
11057
|
+
export type GET_ReportsByReportId_Response_422 = HTTPValidationError
|
|
11058
|
+
|
|
11059
|
+
/**
|
|
11060
|
+
* Response types for GET ReportsByReportIdDownload endpoint
|
|
11061
|
+
*
|
|
11062
|
+
* Download Report
|
|
11063
|
+
*
|
|
11064
|
+
* @remarks
|
|
11065
|
+
* This type defines all possible response structures for the GET ReportsByReportIdDownload endpoint.
|
|
11066
|
+
* Each response code maps to a specific response type as defined in the OpenAPI specification.
|
|
11067
|
+
* Use this type to ensure type safety when handling API responses from this endpoint.
|
|
11068
|
+
*
|
|
11069
|
+
|
|
11070
|
+
*
|
|
11071
|
+
* @path /v1/reports/{report_id}/download
|
|
11072
|
+
*
|
|
11073
|
+
* @see {@link GET_ReportsByReportIdDownload_Response_422} - 422 response type
|
|
11074
|
+
*
|
|
11075
|
+
|
|
11076
|
+
*/
|
|
11077
|
+
export type GET_ReportsByReportIdDownload_Response = GET_ReportsByReportIdDownload_Response_422;
|
|
11078
|
+
|
|
11079
|
+
/**
|
|
11080
|
+
* 422 response for GET ReportsByReportIdDownload endpoint
|
|
11081
|
+
*
|
|
11082
|
+
* @remarks
|
|
11083
|
+
* This type defines the response structure for the 422 status code
|
|
11084
|
+
* of the GET ReportsByReportIdDownload endpoint.
|
|
11085
|
+
* It provides type safety for handling this specific response as defined in the OpenAPI specification.
|
|
11086
|
+
*
|
|
11087
|
+
|
|
11088
|
+
*
|
|
11089
|
+
* @path /v1/reports/{report_id}/download
|
|
11090
|
+
*
|
|
11091
|
+
* @see {@link GET_ReportsByReportIdDownload_Response} - The main response type definition
|
|
11092
|
+
* @see {@link HTTPValidationError} - The actual schema type definition
|
|
11093
|
+
*/
|
|
11094
|
+
export type GET_ReportsByReportIdDownload_Response_422 = HTTPValidationError
|
|
11095
|
+
|
|
10106
11096
|
/**
|
|
10107
11097
|
* Response types for GET Tlds endpoint
|
|
10108
11098
|
*
|