@opusdns/api 0.258.0 → 0.259.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 +105 -1
- package/src/helpers/keys.ts +814 -0
- package/src/helpers/requests.d.ts +300 -1
- package/src/helpers/responses.d.ts +649 -1
- package/src/helpers/schemas-arrays.d.ts +29 -1
- package/src/helpers/schemas.d.ts +144 -0
- package/src/openapi.yaml +716 -1
- package/src/schema.d.ts +722 -0
|
@@ -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, 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';
|
|
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, Pagination_Tag, Tag, ObjectTagChanges2, TldSpecification, UserPublic, UserPublicWithAttributes, PermissionSet, RelationSet, UserWithRelationPermissions } from './schemas.d';
|
|
38
38
|
|
|
39
39
|
/**
|
|
40
40
|
* Response types for GET ArchiveEmailForwardLogsAliasesByEmailForwardAliasId endpoint
|
|
@@ -11025,6 +11025,654 @@ export type GET_ReportsByReportIdDownload_Response = GET_ReportsByReportIdDownlo
|
|
|
11025
11025
|
*/
|
|
11026
11026
|
export type GET_ReportsByReportIdDownload_Response_422 = HTTPValidationError
|
|
11027
11027
|
|
|
11028
|
+
/**
|
|
11029
|
+
* Response types for GET Tags endpoint
|
|
11030
|
+
*
|
|
11031
|
+
* List tags
|
|
11032
|
+
* Retrieves a paginated list of tags
|
|
11033
|
+
*
|
|
11034
|
+
* @remarks
|
|
11035
|
+
* This type defines all possible response structures for the GET Tags endpoint.
|
|
11036
|
+
* Each response code maps to a specific response type as defined in the OpenAPI specification.
|
|
11037
|
+
* Use this type to ensure type safety when handling API responses from this endpoint.
|
|
11038
|
+
*
|
|
11039
|
+
|
|
11040
|
+
*
|
|
11041
|
+
* @path /v1/tags
|
|
11042
|
+
* @param tag_types (query) - Filter by tag types (OR semantics)
|
|
11043
|
+
*
|
|
11044
|
+
* @see {@link GET_Tags_Response_200} - 200 response type
|
|
11045
|
+
* @see {@link GET_Tags_Response_401} - 401 response type
|
|
11046
|
+
* @see {@link GET_Tags_Response_422} - 422 response type
|
|
11047
|
+
*
|
|
11048
|
+
|
|
11049
|
+
*/
|
|
11050
|
+
export type GET_Tags_Response = GET_Tags_Response_200 | GET_Tags_Response_401 | GET_Tags_Response_422;
|
|
11051
|
+
|
|
11052
|
+
/**
|
|
11053
|
+
* 200 response for GET Tags endpoint
|
|
11054
|
+
*
|
|
11055
|
+
* @remarks
|
|
11056
|
+
* This type defines the response structure for the 200 status code
|
|
11057
|
+
* of the GET Tags endpoint.
|
|
11058
|
+
* It provides type safety for handling this specific response as defined in the OpenAPI specification.
|
|
11059
|
+
*
|
|
11060
|
+
|
|
11061
|
+
*
|
|
11062
|
+
* @path /v1/tags
|
|
11063
|
+
* @param tag_types (query) - Filter by tag types (OR semantics)
|
|
11064
|
+
*
|
|
11065
|
+
* @see {@link GET_Tags_Response} - The main response type definition
|
|
11066
|
+
* @see {@link Pagination_Tag} - The actual schema type definition
|
|
11067
|
+
*/
|
|
11068
|
+
export type GET_Tags_Response_200 = Pagination_Tag
|
|
11069
|
+
|
|
11070
|
+
/**
|
|
11071
|
+
* 401 response for GET Tags endpoint
|
|
11072
|
+
*
|
|
11073
|
+
* @remarks
|
|
11074
|
+
* This type defines the response structure for the 401 status code
|
|
11075
|
+
* of the GET Tags endpoint.
|
|
11076
|
+
* It provides type safety for handling this specific response as defined in the OpenAPI specification.
|
|
11077
|
+
*
|
|
11078
|
+
|
|
11079
|
+
*
|
|
11080
|
+
* @path /v1/tags
|
|
11081
|
+
* @param tag_types (query) - Filter by tag types (OR semantics)
|
|
11082
|
+
*
|
|
11083
|
+
* @see {@link GET_Tags_Response} - The main response type definition
|
|
11084
|
+
* @see {@link Problem} - The actual schema type definition
|
|
11085
|
+
*/
|
|
11086
|
+
export type GET_Tags_Response_401 = Problem
|
|
11087
|
+
|
|
11088
|
+
/**
|
|
11089
|
+
* 422 response for GET Tags endpoint
|
|
11090
|
+
*
|
|
11091
|
+
* @remarks
|
|
11092
|
+
* This type defines the response structure for the 422 status code
|
|
11093
|
+
* of the GET Tags endpoint.
|
|
11094
|
+
* It provides type safety for handling this specific response as defined in the OpenAPI specification.
|
|
11095
|
+
*
|
|
11096
|
+
|
|
11097
|
+
*
|
|
11098
|
+
* @path /v1/tags
|
|
11099
|
+
* @param tag_types (query) - Filter by tag types (OR semantics)
|
|
11100
|
+
*
|
|
11101
|
+
* @see {@link GET_Tags_Response} - The main response type definition
|
|
11102
|
+
* @see {@link HTTPValidationError} - The actual schema type definition
|
|
11103
|
+
*/
|
|
11104
|
+
export type GET_Tags_Response_422 = HTTPValidationError
|
|
11105
|
+
|
|
11106
|
+
/**
|
|
11107
|
+
* Response types for POST Tags endpoint
|
|
11108
|
+
*
|
|
11109
|
+
* Create a tag
|
|
11110
|
+
* Create a new tag
|
|
11111
|
+
*
|
|
11112
|
+
* @remarks
|
|
11113
|
+
* This type defines all possible response structures for the POST Tags endpoint.
|
|
11114
|
+
* Each response code maps to a specific response type as defined in the OpenAPI specification.
|
|
11115
|
+
* Use this type to ensure type safety when handling API responses from this endpoint.
|
|
11116
|
+
*
|
|
11117
|
+
|
|
11118
|
+
*
|
|
11119
|
+
* @path /v1/tags
|
|
11120
|
+
*
|
|
11121
|
+
* @see {@link POST_Tags_Response_201} - 201 response type
|
|
11122
|
+
* @see {@link POST_Tags_Response_401} - 401 response type
|
|
11123
|
+
* @see {@link POST_Tags_Response_409} - 409 response type
|
|
11124
|
+
* @see {@link POST_Tags_Response_422} - 422 response type
|
|
11125
|
+
*
|
|
11126
|
+
|
|
11127
|
+
*/
|
|
11128
|
+
export type POST_Tags_Response = POST_Tags_Response_201 | POST_Tags_Response_401 | POST_Tags_Response_409 | POST_Tags_Response_422;
|
|
11129
|
+
|
|
11130
|
+
/**
|
|
11131
|
+
* 201 response for POST Tags endpoint
|
|
11132
|
+
*
|
|
11133
|
+
* @remarks
|
|
11134
|
+
* This type defines the response structure for the 201 status code
|
|
11135
|
+
* of the POST Tags endpoint.
|
|
11136
|
+
* It provides type safety for handling this specific response as defined in the OpenAPI specification.
|
|
11137
|
+
*
|
|
11138
|
+
|
|
11139
|
+
*
|
|
11140
|
+
* @path /v1/tags
|
|
11141
|
+
*
|
|
11142
|
+
* @see {@link POST_Tags_Response} - The main response type definition
|
|
11143
|
+
* @see {@link Tag} - The actual schema type definition
|
|
11144
|
+
*/
|
|
11145
|
+
export type POST_Tags_Response_201 = Tag
|
|
11146
|
+
|
|
11147
|
+
/**
|
|
11148
|
+
* 401 response for POST Tags endpoint
|
|
11149
|
+
*
|
|
11150
|
+
* @remarks
|
|
11151
|
+
* This type defines the response structure for the 401 status code
|
|
11152
|
+
* of the POST Tags endpoint.
|
|
11153
|
+
* It provides type safety for handling this specific response as defined in the OpenAPI specification.
|
|
11154
|
+
*
|
|
11155
|
+
|
|
11156
|
+
*
|
|
11157
|
+
* @path /v1/tags
|
|
11158
|
+
*
|
|
11159
|
+
* @see {@link POST_Tags_Response} - The main response type definition
|
|
11160
|
+
* @see {@link Problem} - The actual schema type definition
|
|
11161
|
+
*/
|
|
11162
|
+
export type POST_Tags_Response_401 = Problem
|
|
11163
|
+
|
|
11164
|
+
/**
|
|
11165
|
+
* 409 response for POST Tags endpoint
|
|
11166
|
+
*
|
|
11167
|
+
* @remarks
|
|
11168
|
+
* This type defines the response structure for the 409 status code
|
|
11169
|
+
* of the POST Tags endpoint.
|
|
11170
|
+
* It provides type safety for handling this specific response as defined in the OpenAPI specification.
|
|
11171
|
+
*
|
|
11172
|
+
|
|
11173
|
+
*
|
|
11174
|
+
* @path /v1/tags
|
|
11175
|
+
*
|
|
11176
|
+
* @see {@link POST_Tags_Response} - The main response type definition
|
|
11177
|
+
* @see {@link Problem} - The actual schema type definition
|
|
11178
|
+
*/
|
|
11179
|
+
export type POST_Tags_Response_409 = Problem
|
|
11180
|
+
|
|
11181
|
+
/**
|
|
11182
|
+
* 422 response for POST Tags endpoint
|
|
11183
|
+
*
|
|
11184
|
+
* @remarks
|
|
11185
|
+
* This type defines the response structure for the 422 status code
|
|
11186
|
+
* of the POST Tags endpoint.
|
|
11187
|
+
* It provides type safety for handling this specific response as defined in the OpenAPI specification.
|
|
11188
|
+
*
|
|
11189
|
+
|
|
11190
|
+
*
|
|
11191
|
+
* @path /v1/tags
|
|
11192
|
+
*
|
|
11193
|
+
* @see {@link POST_Tags_Response} - The main response type definition
|
|
11194
|
+
* @see {@link HTTPValidationError} - The actual schema type definition
|
|
11195
|
+
*/
|
|
11196
|
+
export type POST_Tags_Response_422 = HTTPValidationError
|
|
11197
|
+
|
|
11198
|
+
/**
|
|
11199
|
+
* Response types for DELETE TagsByTagId endpoint
|
|
11200
|
+
*
|
|
11201
|
+
* Delete a tag
|
|
11202
|
+
* Delete a tag
|
|
11203
|
+
*
|
|
11204
|
+
* @remarks
|
|
11205
|
+
* This type defines all possible response structures for the DELETE TagsByTagId endpoint.
|
|
11206
|
+
* Each response code maps to a specific response type as defined in the OpenAPI specification.
|
|
11207
|
+
* Use this type to ensure type safety when handling API responses from this endpoint.
|
|
11208
|
+
*
|
|
11209
|
+
|
|
11210
|
+
*
|
|
11211
|
+
* @path /v1/tags/{tag_id}
|
|
11212
|
+
*
|
|
11213
|
+
* @see {@link DELETE_TagsByTagId_Response_401} - 401 response type
|
|
11214
|
+
* @see {@link DELETE_TagsByTagId_Response_404} - 404 response type
|
|
11215
|
+
* @see {@link DELETE_TagsByTagId_Response_422} - 422 response type
|
|
11216
|
+
*
|
|
11217
|
+
|
|
11218
|
+
*/
|
|
11219
|
+
export type DELETE_TagsByTagId_Response = DELETE_TagsByTagId_Response_401 | DELETE_TagsByTagId_Response_404 | DELETE_TagsByTagId_Response_422;
|
|
11220
|
+
|
|
11221
|
+
/**
|
|
11222
|
+
* 401 response for DELETE TagsByTagId endpoint
|
|
11223
|
+
*
|
|
11224
|
+
* @remarks
|
|
11225
|
+
* This type defines the response structure for the 401 status code
|
|
11226
|
+
* of the DELETE TagsByTagId endpoint.
|
|
11227
|
+
* It provides type safety for handling this specific response as defined in the OpenAPI specification.
|
|
11228
|
+
*
|
|
11229
|
+
|
|
11230
|
+
*
|
|
11231
|
+
* @path /v1/tags/{tag_id}
|
|
11232
|
+
*
|
|
11233
|
+
* @see {@link DELETE_TagsByTagId_Response} - The main response type definition
|
|
11234
|
+
* @see {@link Problem} - The actual schema type definition
|
|
11235
|
+
*/
|
|
11236
|
+
export type DELETE_TagsByTagId_Response_401 = Problem
|
|
11237
|
+
|
|
11238
|
+
/**
|
|
11239
|
+
* 404 response for DELETE TagsByTagId endpoint
|
|
11240
|
+
*
|
|
11241
|
+
* @remarks
|
|
11242
|
+
* This type defines the response structure for the 404 status code
|
|
11243
|
+
* of the DELETE TagsByTagId endpoint.
|
|
11244
|
+
* It provides type safety for handling this specific response as defined in the OpenAPI specification.
|
|
11245
|
+
*
|
|
11246
|
+
|
|
11247
|
+
*
|
|
11248
|
+
* @path /v1/tags/{tag_id}
|
|
11249
|
+
*
|
|
11250
|
+
* @see {@link DELETE_TagsByTagId_Response} - The main response type definition
|
|
11251
|
+
* @see {@link Problem} - The actual schema type definition
|
|
11252
|
+
*/
|
|
11253
|
+
export type DELETE_TagsByTagId_Response_404 = Problem
|
|
11254
|
+
|
|
11255
|
+
/**
|
|
11256
|
+
* 422 response for DELETE TagsByTagId endpoint
|
|
11257
|
+
*
|
|
11258
|
+
* @remarks
|
|
11259
|
+
* This type defines the response structure for the 422 status code
|
|
11260
|
+
* of the DELETE TagsByTagId endpoint.
|
|
11261
|
+
* It provides type safety for handling this specific response as defined in the OpenAPI specification.
|
|
11262
|
+
*
|
|
11263
|
+
|
|
11264
|
+
*
|
|
11265
|
+
* @path /v1/tags/{tag_id}
|
|
11266
|
+
*
|
|
11267
|
+
* @see {@link DELETE_TagsByTagId_Response} - The main response type definition
|
|
11268
|
+
* @see {@link HTTPValidationError} - The actual schema type definition
|
|
11269
|
+
*/
|
|
11270
|
+
export type DELETE_TagsByTagId_Response_422 = HTTPValidationError
|
|
11271
|
+
|
|
11272
|
+
/**
|
|
11273
|
+
* Response types for GET TagsByTagId endpoint
|
|
11274
|
+
*
|
|
11275
|
+
* Get a tag
|
|
11276
|
+
* Retrieve a single tag by its ID
|
|
11277
|
+
*
|
|
11278
|
+
* @remarks
|
|
11279
|
+
* This type defines all possible response structures for the GET TagsByTagId endpoint.
|
|
11280
|
+
* Each response code maps to a specific response type as defined in the OpenAPI specification.
|
|
11281
|
+
* Use this type to ensure type safety when handling API responses from this endpoint.
|
|
11282
|
+
*
|
|
11283
|
+
|
|
11284
|
+
*
|
|
11285
|
+
* @path /v1/tags/{tag_id}
|
|
11286
|
+
*
|
|
11287
|
+
* @see {@link GET_TagsByTagId_Response_200} - 200 response type
|
|
11288
|
+
* @see {@link GET_TagsByTagId_Response_401} - 401 response type
|
|
11289
|
+
* @see {@link GET_TagsByTagId_Response_404} - 404 response type
|
|
11290
|
+
* @see {@link GET_TagsByTagId_Response_422} - 422 response type
|
|
11291
|
+
*
|
|
11292
|
+
|
|
11293
|
+
*/
|
|
11294
|
+
export type GET_TagsByTagId_Response = GET_TagsByTagId_Response_200 | GET_TagsByTagId_Response_401 | GET_TagsByTagId_Response_404 | GET_TagsByTagId_Response_422;
|
|
11295
|
+
|
|
11296
|
+
/**
|
|
11297
|
+
* 200 response for GET TagsByTagId endpoint
|
|
11298
|
+
*
|
|
11299
|
+
* @remarks
|
|
11300
|
+
* This type defines the response structure for the 200 status code
|
|
11301
|
+
* of the GET TagsByTagId endpoint.
|
|
11302
|
+
* It provides type safety for handling this specific response as defined in the OpenAPI specification.
|
|
11303
|
+
*
|
|
11304
|
+
|
|
11305
|
+
*
|
|
11306
|
+
* @path /v1/tags/{tag_id}
|
|
11307
|
+
*
|
|
11308
|
+
* @see {@link GET_TagsByTagId_Response} - The main response type definition
|
|
11309
|
+
* @see {@link Tag} - The actual schema type definition
|
|
11310
|
+
*/
|
|
11311
|
+
export type GET_TagsByTagId_Response_200 = Tag
|
|
11312
|
+
|
|
11313
|
+
/**
|
|
11314
|
+
* 401 response for GET TagsByTagId endpoint
|
|
11315
|
+
*
|
|
11316
|
+
* @remarks
|
|
11317
|
+
* This type defines the response structure for the 401 status code
|
|
11318
|
+
* of the GET TagsByTagId endpoint.
|
|
11319
|
+
* It provides type safety for handling this specific response as defined in the OpenAPI specification.
|
|
11320
|
+
*
|
|
11321
|
+
|
|
11322
|
+
*
|
|
11323
|
+
* @path /v1/tags/{tag_id}
|
|
11324
|
+
*
|
|
11325
|
+
* @see {@link GET_TagsByTagId_Response} - The main response type definition
|
|
11326
|
+
* @see {@link Problem} - The actual schema type definition
|
|
11327
|
+
*/
|
|
11328
|
+
export type GET_TagsByTagId_Response_401 = Problem
|
|
11329
|
+
|
|
11330
|
+
/**
|
|
11331
|
+
* 404 response for GET TagsByTagId endpoint
|
|
11332
|
+
*
|
|
11333
|
+
* @remarks
|
|
11334
|
+
* This type defines the response structure for the 404 status code
|
|
11335
|
+
* of the GET TagsByTagId endpoint.
|
|
11336
|
+
* It provides type safety for handling this specific response as defined in the OpenAPI specification.
|
|
11337
|
+
*
|
|
11338
|
+
|
|
11339
|
+
*
|
|
11340
|
+
* @path /v1/tags/{tag_id}
|
|
11341
|
+
*
|
|
11342
|
+
* @see {@link GET_TagsByTagId_Response} - The main response type definition
|
|
11343
|
+
* @see {@link Problem} - The actual schema type definition
|
|
11344
|
+
*/
|
|
11345
|
+
export type GET_TagsByTagId_Response_404 = Problem
|
|
11346
|
+
|
|
11347
|
+
/**
|
|
11348
|
+
* 422 response for GET TagsByTagId endpoint
|
|
11349
|
+
*
|
|
11350
|
+
* @remarks
|
|
11351
|
+
* This type defines the response structure for the 422 status code
|
|
11352
|
+
* of the GET TagsByTagId endpoint.
|
|
11353
|
+
* It provides type safety for handling this specific response as defined in the OpenAPI specification.
|
|
11354
|
+
*
|
|
11355
|
+
|
|
11356
|
+
*
|
|
11357
|
+
* @path /v1/tags/{tag_id}
|
|
11358
|
+
*
|
|
11359
|
+
* @see {@link GET_TagsByTagId_Response} - The main response type definition
|
|
11360
|
+
* @see {@link HTTPValidationError} - The actual schema type definition
|
|
11361
|
+
*/
|
|
11362
|
+
export type GET_TagsByTagId_Response_422 = HTTPValidationError
|
|
11363
|
+
|
|
11364
|
+
/**
|
|
11365
|
+
* Response types for PATCH TagsByTagId endpoint
|
|
11366
|
+
*
|
|
11367
|
+
* Update a tag
|
|
11368
|
+
* Update a tag's label, description, or color
|
|
11369
|
+
*
|
|
11370
|
+
* @remarks
|
|
11371
|
+
* This type defines all possible response structures for the PATCH TagsByTagId endpoint.
|
|
11372
|
+
* Each response code maps to a specific response type as defined in the OpenAPI specification.
|
|
11373
|
+
* Use this type to ensure type safety when handling API responses from this endpoint.
|
|
11374
|
+
*
|
|
11375
|
+
|
|
11376
|
+
*
|
|
11377
|
+
* @path /v1/tags/{tag_id}
|
|
11378
|
+
*
|
|
11379
|
+
* @see {@link PATCH_TagsByTagId_Response_200} - 200 response type
|
|
11380
|
+
* @see {@link PATCH_TagsByTagId_Response_401} - 401 response type
|
|
11381
|
+
* @see {@link PATCH_TagsByTagId_Response_404} - 404 response type
|
|
11382
|
+
* @see {@link PATCH_TagsByTagId_Response_409} - 409 response type
|
|
11383
|
+
* @see {@link PATCH_TagsByTagId_Response_422} - 422 response type
|
|
11384
|
+
*
|
|
11385
|
+
|
|
11386
|
+
*/
|
|
11387
|
+
export type PATCH_TagsByTagId_Response = PATCH_TagsByTagId_Response_200 | PATCH_TagsByTagId_Response_401 | PATCH_TagsByTagId_Response_404 | PATCH_TagsByTagId_Response_409 | PATCH_TagsByTagId_Response_422;
|
|
11388
|
+
|
|
11389
|
+
/**
|
|
11390
|
+
* 200 response for PATCH TagsByTagId endpoint
|
|
11391
|
+
*
|
|
11392
|
+
* @remarks
|
|
11393
|
+
* This type defines the response structure for the 200 status code
|
|
11394
|
+
* of the PATCH TagsByTagId endpoint.
|
|
11395
|
+
* It provides type safety for handling this specific response as defined in the OpenAPI specification.
|
|
11396
|
+
*
|
|
11397
|
+
|
|
11398
|
+
*
|
|
11399
|
+
* @path /v1/tags/{tag_id}
|
|
11400
|
+
*
|
|
11401
|
+
* @see {@link PATCH_TagsByTagId_Response} - The main response type definition
|
|
11402
|
+
* @see {@link Tag} - The actual schema type definition
|
|
11403
|
+
*/
|
|
11404
|
+
export type PATCH_TagsByTagId_Response_200 = Tag
|
|
11405
|
+
|
|
11406
|
+
/**
|
|
11407
|
+
* 401 response for PATCH TagsByTagId endpoint
|
|
11408
|
+
*
|
|
11409
|
+
* @remarks
|
|
11410
|
+
* This type defines the response structure for the 401 status code
|
|
11411
|
+
* of the PATCH TagsByTagId endpoint.
|
|
11412
|
+
* It provides type safety for handling this specific response as defined in the OpenAPI specification.
|
|
11413
|
+
*
|
|
11414
|
+
|
|
11415
|
+
*
|
|
11416
|
+
* @path /v1/tags/{tag_id}
|
|
11417
|
+
*
|
|
11418
|
+
* @see {@link PATCH_TagsByTagId_Response} - The main response type definition
|
|
11419
|
+
* @see {@link Problem} - The actual schema type definition
|
|
11420
|
+
*/
|
|
11421
|
+
export type PATCH_TagsByTagId_Response_401 = Problem
|
|
11422
|
+
|
|
11423
|
+
/**
|
|
11424
|
+
* 404 response for PATCH TagsByTagId endpoint
|
|
11425
|
+
*
|
|
11426
|
+
* @remarks
|
|
11427
|
+
* This type defines the response structure for the 404 status code
|
|
11428
|
+
* of the PATCH TagsByTagId endpoint.
|
|
11429
|
+
* It provides type safety for handling this specific response as defined in the OpenAPI specification.
|
|
11430
|
+
*
|
|
11431
|
+
|
|
11432
|
+
*
|
|
11433
|
+
* @path /v1/tags/{tag_id}
|
|
11434
|
+
*
|
|
11435
|
+
* @see {@link PATCH_TagsByTagId_Response} - The main response type definition
|
|
11436
|
+
* @see {@link Problem} - The actual schema type definition
|
|
11437
|
+
*/
|
|
11438
|
+
export type PATCH_TagsByTagId_Response_404 = Problem
|
|
11439
|
+
|
|
11440
|
+
/**
|
|
11441
|
+
* 409 response for PATCH TagsByTagId endpoint
|
|
11442
|
+
*
|
|
11443
|
+
* @remarks
|
|
11444
|
+
* This type defines the response structure for the 409 status code
|
|
11445
|
+
* of the PATCH TagsByTagId endpoint.
|
|
11446
|
+
* It provides type safety for handling this specific response as defined in the OpenAPI specification.
|
|
11447
|
+
*
|
|
11448
|
+
|
|
11449
|
+
*
|
|
11450
|
+
* @path /v1/tags/{tag_id}
|
|
11451
|
+
*
|
|
11452
|
+
* @see {@link PATCH_TagsByTagId_Response} - The main response type definition
|
|
11453
|
+
* @see {@link Problem} - The actual schema type definition
|
|
11454
|
+
*/
|
|
11455
|
+
export type PATCH_TagsByTagId_Response_409 = Problem
|
|
11456
|
+
|
|
11457
|
+
/**
|
|
11458
|
+
* 422 response for PATCH TagsByTagId endpoint
|
|
11459
|
+
*
|
|
11460
|
+
* @remarks
|
|
11461
|
+
* This type defines the response structure for the 422 status code
|
|
11462
|
+
* of the PATCH TagsByTagId endpoint.
|
|
11463
|
+
* It provides type safety for handling this specific response as defined in the OpenAPI specification.
|
|
11464
|
+
*
|
|
11465
|
+
|
|
11466
|
+
*
|
|
11467
|
+
* @path /v1/tags/{tag_id}
|
|
11468
|
+
*
|
|
11469
|
+
* @see {@link PATCH_TagsByTagId_Response} - The main response type definition
|
|
11470
|
+
* @see {@link HTTPValidationError} - The actual schema type definition
|
|
11471
|
+
*/
|
|
11472
|
+
export type PATCH_TagsByTagId_Response_422 = HTTPValidationError
|
|
11473
|
+
|
|
11474
|
+
/**
|
|
11475
|
+
* Response types for POST TagsByTagIdObjects endpoint
|
|
11476
|
+
*
|
|
11477
|
+
* Tag or untag objects
|
|
11478
|
+
* Add or remove objects from a tag. Objects are matched by the tag's type (e.g. a DOMAIN tag only accepts domain IDs).
|
|
11479
|
+
*
|
|
11480
|
+
* @remarks
|
|
11481
|
+
* This type defines all possible response structures for the POST TagsByTagIdObjects endpoint.
|
|
11482
|
+
* Each response code maps to a specific response type as defined in the OpenAPI specification.
|
|
11483
|
+
* Use this type to ensure type safety when handling API responses from this endpoint.
|
|
11484
|
+
*
|
|
11485
|
+
|
|
11486
|
+
*
|
|
11487
|
+
* @path /v1/tags/{tag_id}/objects
|
|
11488
|
+
*
|
|
11489
|
+
* @see {@link POST_TagsByTagIdObjects_Response_200} - 200 response type
|
|
11490
|
+
* @see {@link POST_TagsByTagIdObjects_Response_401} - 401 response type
|
|
11491
|
+
* @see {@link POST_TagsByTagIdObjects_Response_404} - 404 response type
|
|
11492
|
+
* @see {@link POST_TagsByTagIdObjects_Response_422} - 422 response type
|
|
11493
|
+
*
|
|
11494
|
+
|
|
11495
|
+
*/
|
|
11496
|
+
export type POST_TagsByTagIdObjects_Response = POST_TagsByTagIdObjects_Response_200 | POST_TagsByTagIdObjects_Response_401 | POST_TagsByTagIdObjects_Response_404 | POST_TagsByTagIdObjects_Response_422;
|
|
11497
|
+
|
|
11498
|
+
/**
|
|
11499
|
+
* 200 response for POST TagsByTagIdObjects endpoint
|
|
11500
|
+
*
|
|
11501
|
+
* @remarks
|
|
11502
|
+
* This type defines the response structure for the 200 status code
|
|
11503
|
+
* of the POST TagsByTagIdObjects endpoint.
|
|
11504
|
+
* It provides type safety for handling this specific response as defined in the OpenAPI specification.
|
|
11505
|
+
*
|
|
11506
|
+
|
|
11507
|
+
*
|
|
11508
|
+
* @path /v1/tags/{tag_id}/objects
|
|
11509
|
+
*
|
|
11510
|
+
* @see {@link POST_TagsByTagIdObjects_Response} - The main response type definition
|
|
11511
|
+
* @see {@link ObjectTagChanges2} - The actual schema type definition
|
|
11512
|
+
*/
|
|
11513
|
+
export type POST_TagsByTagIdObjects_Response_200 = ObjectTagChanges2
|
|
11514
|
+
|
|
11515
|
+
/**
|
|
11516
|
+
* 401 response for POST TagsByTagIdObjects endpoint
|
|
11517
|
+
*
|
|
11518
|
+
* @remarks
|
|
11519
|
+
* This type defines the response structure for the 401 status code
|
|
11520
|
+
* of the POST TagsByTagIdObjects endpoint.
|
|
11521
|
+
* It provides type safety for handling this specific response as defined in the OpenAPI specification.
|
|
11522
|
+
*
|
|
11523
|
+
|
|
11524
|
+
*
|
|
11525
|
+
* @path /v1/tags/{tag_id}/objects
|
|
11526
|
+
*
|
|
11527
|
+
* @see {@link POST_TagsByTagIdObjects_Response} - The main response type definition
|
|
11528
|
+
* @see {@link Problem} - The actual schema type definition
|
|
11529
|
+
*/
|
|
11530
|
+
export type POST_TagsByTagIdObjects_Response_401 = Problem
|
|
11531
|
+
|
|
11532
|
+
/**
|
|
11533
|
+
* 404 response for POST TagsByTagIdObjects endpoint
|
|
11534
|
+
*
|
|
11535
|
+
* @remarks
|
|
11536
|
+
* This type defines the response structure for the 404 status code
|
|
11537
|
+
* of the POST TagsByTagIdObjects endpoint.
|
|
11538
|
+
* It provides type safety for handling this specific response as defined in the OpenAPI specification.
|
|
11539
|
+
*
|
|
11540
|
+
|
|
11541
|
+
*
|
|
11542
|
+
* @path /v1/tags/{tag_id}/objects
|
|
11543
|
+
*
|
|
11544
|
+
* @see {@link POST_TagsByTagIdObjects_Response} - The main response type definition
|
|
11545
|
+
* @see {@link Problem} - The actual schema type definition
|
|
11546
|
+
*/
|
|
11547
|
+
export type POST_TagsByTagIdObjects_Response_404 = Problem
|
|
11548
|
+
|
|
11549
|
+
/**
|
|
11550
|
+
* 422 response for POST TagsByTagIdObjects endpoint
|
|
11551
|
+
*
|
|
11552
|
+
* @remarks
|
|
11553
|
+
* This type defines the response structure for the 422 status code
|
|
11554
|
+
* of the POST TagsByTagIdObjects endpoint.
|
|
11555
|
+
* It provides type safety for handling this specific response as defined in the OpenAPI specification.
|
|
11556
|
+
*
|
|
11557
|
+
|
|
11558
|
+
*
|
|
11559
|
+
* @path /v1/tags/{tag_id}/objects
|
|
11560
|
+
*
|
|
11561
|
+
* @see {@link POST_TagsByTagIdObjects_Response} - The main response type definition
|
|
11562
|
+
* @see {@link HTTPValidationError} - The actual schema type definition
|
|
11563
|
+
*/
|
|
11564
|
+
export type POST_TagsByTagIdObjects_Response_422 = HTTPValidationError
|
|
11565
|
+
|
|
11566
|
+
/**
|
|
11567
|
+
* Response types for POST TagsObjects endpoint
|
|
11568
|
+
*
|
|
11569
|
+
* Bulk tag or untag objects
|
|
11570
|
+
* Add, remove, or replace tags on multiple objects at once. 'replace' is mutually exclusive with 'add' and 'remove'.
|
|
11571
|
+
*
|
|
11572
|
+
* @remarks
|
|
11573
|
+
* This type defines all possible response structures for the POST TagsObjects endpoint.
|
|
11574
|
+
* Each response code maps to a specific response type as defined in the OpenAPI specification.
|
|
11575
|
+
* Use this type to ensure type safety when handling API responses from this endpoint.
|
|
11576
|
+
*
|
|
11577
|
+
|
|
11578
|
+
*
|
|
11579
|
+
* @path /v1/tags/objects
|
|
11580
|
+
*
|
|
11581
|
+
* @see {@link POST_TagsObjects_Response_200} - 200 response type
|
|
11582
|
+
* @see {@link POST_TagsObjects_Response_400} - 400 response type
|
|
11583
|
+
* @see {@link POST_TagsObjects_Response_401} - 401 response type
|
|
11584
|
+
* @see {@link POST_TagsObjects_Response_404} - 404 response type
|
|
11585
|
+
* @see {@link POST_TagsObjects_Response_422} - 422 response type
|
|
11586
|
+
*
|
|
11587
|
+
|
|
11588
|
+
*/
|
|
11589
|
+
export type POST_TagsObjects_Response = POST_TagsObjects_Response_200 | POST_TagsObjects_Response_400 | POST_TagsObjects_Response_401 | POST_TagsObjects_Response_404 | POST_TagsObjects_Response_422;
|
|
11590
|
+
|
|
11591
|
+
/**
|
|
11592
|
+
* 200 response for POST TagsObjects endpoint
|
|
11593
|
+
*
|
|
11594
|
+
* @remarks
|
|
11595
|
+
* This type defines the response structure for the 200 status code
|
|
11596
|
+
* of the POST TagsObjects endpoint.
|
|
11597
|
+
* It provides type safety for handling this specific response as defined in the OpenAPI specification.
|
|
11598
|
+
*
|
|
11599
|
+
|
|
11600
|
+
*
|
|
11601
|
+
* @path /v1/tags/objects
|
|
11602
|
+
*
|
|
11603
|
+
* @see {@link POST_TagsObjects_Response} - The main response type definition
|
|
11604
|
+
* @see {@link ObjectTagChanges2} - The actual schema type definition
|
|
11605
|
+
*/
|
|
11606
|
+
export type POST_TagsObjects_Response_200 = ObjectTagChanges2
|
|
11607
|
+
|
|
11608
|
+
/**
|
|
11609
|
+
* 400 response for POST TagsObjects endpoint
|
|
11610
|
+
*
|
|
11611
|
+
* @remarks
|
|
11612
|
+
* This type defines the response structure for the 400 status code
|
|
11613
|
+
* of the POST TagsObjects endpoint.
|
|
11614
|
+
* It provides type safety for handling this specific response as defined in the OpenAPI specification.
|
|
11615
|
+
*
|
|
11616
|
+
|
|
11617
|
+
*
|
|
11618
|
+
* @path /v1/tags/objects
|
|
11619
|
+
*
|
|
11620
|
+
* @see {@link POST_TagsObjects_Response} - The main response type definition
|
|
11621
|
+
* @see {@link Problem} - The actual schema type definition
|
|
11622
|
+
*/
|
|
11623
|
+
export type POST_TagsObjects_Response_400 = Problem
|
|
11624
|
+
|
|
11625
|
+
/**
|
|
11626
|
+
* 401 response for POST TagsObjects endpoint
|
|
11627
|
+
*
|
|
11628
|
+
* @remarks
|
|
11629
|
+
* This type defines the response structure for the 401 status code
|
|
11630
|
+
* of the POST TagsObjects endpoint.
|
|
11631
|
+
* It provides type safety for handling this specific response as defined in the OpenAPI specification.
|
|
11632
|
+
*
|
|
11633
|
+
|
|
11634
|
+
*
|
|
11635
|
+
* @path /v1/tags/objects
|
|
11636
|
+
*
|
|
11637
|
+
* @see {@link POST_TagsObjects_Response} - The main response type definition
|
|
11638
|
+
* @see {@link Problem} - The actual schema type definition
|
|
11639
|
+
*/
|
|
11640
|
+
export type POST_TagsObjects_Response_401 = Problem
|
|
11641
|
+
|
|
11642
|
+
/**
|
|
11643
|
+
* 404 response for POST TagsObjects endpoint
|
|
11644
|
+
*
|
|
11645
|
+
* @remarks
|
|
11646
|
+
* This type defines the response structure for the 404 status code
|
|
11647
|
+
* of the POST TagsObjects endpoint.
|
|
11648
|
+
* It provides type safety for handling this specific response as defined in the OpenAPI specification.
|
|
11649
|
+
*
|
|
11650
|
+
|
|
11651
|
+
*
|
|
11652
|
+
* @path /v1/tags/objects
|
|
11653
|
+
*
|
|
11654
|
+
* @see {@link POST_TagsObjects_Response} - The main response type definition
|
|
11655
|
+
* @see {@link Problem} - The actual schema type definition
|
|
11656
|
+
*/
|
|
11657
|
+
export type POST_TagsObjects_Response_404 = Problem
|
|
11658
|
+
|
|
11659
|
+
/**
|
|
11660
|
+
* 422 response for POST TagsObjects endpoint
|
|
11661
|
+
*
|
|
11662
|
+
* @remarks
|
|
11663
|
+
* This type defines the response structure for the 422 status code
|
|
11664
|
+
* of the POST TagsObjects endpoint.
|
|
11665
|
+
* It provides type safety for handling this specific response as defined in the OpenAPI specification.
|
|
11666
|
+
*
|
|
11667
|
+
|
|
11668
|
+
*
|
|
11669
|
+
* @path /v1/tags/objects
|
|
11670
|
+
*
|
|
11671
|
+
* @see {@link POST_TagsObjects_Response} - The main response type definition
|
|
11672
|
+
* @see {@link HTTPValidationError} - The actual schema type definition
|
|
11673
|
+
*/
|
|
11674
|
+
export type POST_TagsObjects_Response_422 = HTTPValidationError
|
|
11675
|
+
|
|
11028
11676
|
/**
|
|
11029
11677
|
* Response types for GET Tlds endpoint
|
|
11030
11678
|
*
|