@opusdns/api 0.282.0 → 0.284.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/README.md +33 -0
- package/package.json +3 -2
- package/src/helpers/constants.ts +163 -1
- package/src/helpers/keys.ts +10189 -8422
- package/src/helpers/requests.d.ts +682 -4
- package/src/helpers/responses.d.ts +1652 -5
- package/src/helpers/schemas-arrays.d.ts +57 -1
- package/src/helpers/schemas.d.ts +272 -0
- package/src/openapi.yaml +1636 -22
- package/src/schema.d.ts +1666 -14
|
@@ -34,7 +34,1634 @@
|
|
|
34
34
|
|
|
35
35
|
import { DomainDnssecDataArray, OrganizationAttribute2Array, IpRestrictionArray, TldResponseShortArray } from './schemas-arrays.d';
|
|
36
36
|
|
|
37
|
-
import {
|
|
37
|
+
import { Context, Problem, HTTPValidationError, ConversationList, Conversation, ContextList, MessageList, Message, MemoryFactList, MemoryFact, Pagination_EmailForwardLog, Pagination_ObjectLog, Pagination_RequestHistory, 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
|
+
|
|
39
|
+
/**
|
|
40
|
+
* Response types for GET AiConciergeContextsByContextId endpoint
|
|
41
|
+
*
|
|
42
|
+
* Get a context entry
|
|
43
|
+
*
|
|
44
|
+
* @remarks
|
|
45
|
+
* This type defines all possible response structures for the GET AiConciergeContextsByContextId endpoint.
|
|
46
|
+
* Each response code maps to a specific response type as defined in the OpenAPI specification.
|
|
47
|
+
* Use this type to ensure type safety when handling API responses from this endpoint.
|
|
48
|
+
*
|
|
49
|
+
|
|
50
|
+
*
|
|
51
|
+
* @path /v1/ai-concierge/contexts/{context_id}
|
|
52
|
+
*
|
|
53
|
+
* @see {@link GET_AiConciergeContextsByContextId_Response_200} - 200 response type
|
|
54
|
+
* @see {@link GET_AiConciergeContextsByContextId_Response_401} - 401 response type
|
|
55
|
+
* @see {@link GET_AiConciergeContextsByContextId_Response_404} - 404 response type
|
|
56
|
+
* @see {@link GET_AiConciergeContextsByContextId_Response_422} - 422 response type
|
|
57
|
+
* @see {@link GET_AiConciergeContextsByContextId_Response_502} - 502 response type
|
|
58
|
+
*
|
|
59
|
+
|
|
60
|
+
*/
|
|
61
|
+
export type GET_AiConciergeContextsByContextId_Response = GET_AiConciergeContextsByContextId_Response_200 | GET_AiConciergeContextsByContextId_Response_401 | GET_AiConciergeContextsByContextId_Response_404 | GET_AiConciergeContextsByContextId_Response_422 | GET_AiConciergeContextsByContextId_Response_502;
|
|
62
|
+
|
|
63
|
+
/**
|
|
64
|
+
* 200 response for GET AiConciergeContextsByContextId endpoint
|
|
65
|
+
*
|
|
66
|
+
* @remarks
|
|
67
|
+
* This type defines the response structure for the 200 status code
|
|
68
|
+
* of the GET AiConciergeContextsByContextId endpoint.
|
|
69
|
+
* It provides type safety for handling this specific response as defined in the OpenAPI specification.
|
|
70
|
+
*
|
|
71
|
+
|
|
72
|
+
*
|
|
73
|
+
* @path /v1/ai-concierge/contexts/{context_id}
|
|
74
|
+
*
|
|
75
|
+
* @see {@link GET_AiConciergeContextsByContextId_Response} - The main response type definition
|
|
76
|
+
* @see {@link Context} - The actual schema type definition
|
|
77
|
+
*/
|
|
78
|
+
export type GET_AiConciergeContextsByContextId_Response_200 = Context
|
|
79
|
+
|
|
80
|
+
/**
|
|
81
|
+
* 401 response for GET AiConciergeContextsByContextId endpoint
|
|
82
|
+
*
|
|
83
|
+
* @remarks
|
|
84
|
+
* This type defines the response structure for the 401 status code
|
|
85
|
+
* of the GET AiConciergeContextsByContextId endpoint.
|
|
86
|
+
* It provides type safety for handling this specific response as defined in the OpenAPI specification.
|
|
87
|
+
*
|
|
88
|
+
|
|
89
|
+
*
|
|
90
|
+
* @path /v1/ai-concierge/contexts/{context_id}
|
|
91
|
+
*
|
|
92
|
+
* @see {@link GET_AiConciergeContextsByContextId_Response} - The main response type definition
|
|
93
|
+
* @see {@link Problem} - The actual schema type definition
|
|
94
|
+
*/
|
|
95
|
+
export type GET_AiConciergeContextsByContextId_Response_401 = Problem
|
|
96
|
+
|
|
97
|
+
/**
|
|
98
|
+
* 404 response for GET AiConciergeContextsByContextId endpoint
|
|
99
|
+
*
|
|
100
|
+
* @remarks
|
|
101
|
+
* This type defines the response structure for the 404 status code
|
|
102
|
+
* of the GET AiConciergeContextsByContextId endpoint.
|
|
103
|
+
* It provides type safety for handling this specific response as defined in the OpenAPI specification.
|
|
104
|
+
*
|
|
105
|
+
|
|
106
|
+
*
|
|
107
|
+
* @path /v1/ai-concierge/contexts/{context_id}
|
|
108
|
+
*
|
|
109
|
+
* @see {@link GET_AiConciergeContextsByContextId_Response} - The main response type definition
|
|
110
|
+
* @see {@link Problem} - The actual schema type definition
|
|
111
|
+
*/
|
|
112
|
+
export type GET_AiConciergeContextsByContextId_Response_404 = Problem
|
|
113
|
+
|
|
114
|
+
/**
|
|
115
|
+
* 422 response for GET AiConciergeContextsByContextId endpoint
|
|
116
|
+
*
|
|
117
|
+
* @remarks
|
|
118
|
+
* This type defines the response structure for the 422 status code
|
|
119
|
+
* of the GET AiConciergeContextsByContextId endpoint.
|
|
120
|
+
* It provides type safety for handling this specific response as defined in the OpenAPI specification.
|
|
121
|
+
*
|
|
122
|
+
|
|
123
|
+
*
|
|
124
|
+
* @path /v1/ai-concierge/contexts/{context_id}
|
|
125
|
+
*
|
|
126
|
+
* @see {@link GET_AiConciergeContextsByContextId_Response} - The main response type definition
|
|
127
|
+
* @see {@link HTTPValidationError} - The actual schema type definition
|
|
128
|
+
*/
|
|
129
|
+
export type GET_AiConciergeContextsByContextId_Response_422 = HTTPValidationError
|
|
130
|
+
|
|
131
|
+
/**
|
|
132
|
+
* 502 response for GET AiConciergeContextsByContextId endpoint
|
|
133
|
+
*
|
|
134
|
+
* @remarks
|
|
135
|
+
* This type defines the response structure for the 502 status code
|
|
136
|
+
* of the GET AiConciergeContextsByContextId endpoint.
|
|
137
|
+
* It provides type safety for handling this specific response as defined in the OpenAPI specification.
|
|
138
|
+
*
|
|
139
|
+
|
|
140
|
+
*
|
|
141
|
+
* @path /v1/ai-concierge/contexts/{context_id}
|
|
142
|
+
*
|
|
143
|
+
* @see {@link GET_AiConciergeContextsByContextId_Response} - The main response type definition
|
|
144
|
+
* @see {@link Problem} - The actual schema type definition
|
|
145
|
+
*/
|
|
146
|
+
export type GET_AiConciergeContextsByContextId_Response_502 = Problem
|
|
147
|
+
|
|
148
|
+
/**
|
|
149
|
+
* Response types for GET AiConciergeConversations endpoint
|
|
150
|
+
*
|
|
151
|
+
* List AI Concierge conversations
|
|
152
|
+
* List the authenticated organization's AI Concierge conversations.
|
|
153
|
+
*
|
|
154
|
+
* @remarks
|
|
155
|
+
* This type defines all possible response structures for the GET AiConciergeConversations endpoint.
|
|
156
|
+
* Each response code maps to a specific response type as defined in the OpenAPI specification.
|
|
157
|
+
* Use this type to ensure type safety when handling API responses from this endpoint.
|
|
158
|
+
*
|
|
159
|
+
|
|
160
|
+
*
|
|
161
|
+
* @path /v1/ai-concierge/conversations
|
|
162
|
+
* @param sort (query) - Comma-separated sort fields. Prefix with `-` for DESC.
|
|
163
|
+
* @param q (query) - Full-text search on title/summary.
|
|
164
|
+
*
|
|
165
|
+
* @see {@link GET_AiConciergeConversations_Response_200} - 200 response type
|
|
166
|
+
* @see {@link GET_AiConciergeConversations_Response_401} - 401 response type
|
|
167
|
+
* @see {@link GET_AiConciergeConversations_Response_404} - 404 response type
|
|
168
|
+
* @see {@link GET_AiConciergeConversations_Response_422} - 422 response type
|
|
169
|
+
* @see {@link GET_AiConciergeConversations_Response_502} - 502 response type
|
|
170
|
+
*
|
|
171
|
+
|
|
172
|
+
*/
|
|
173
|
+
export type GET_AiConciergeConversations_Response = GET_AiConciergeConversations_Response_200 | GET_AiConciergeConversations_Response_401 | GET_AiConciergeConversations_Response_404 | GET_AiConciergeConversations_Response_422 | GET_AiConciergeConversations_Response_502;
|
|
174
|
+
|
|
175
|
+
/**
|
|
176
|
+
* 200 response for GET AiConciergeConversations endpoint
|
|
177
|
+
*
|
|
178
|
+
* @remarks
|
|
179
|
+
* This type defines the response structure for the 200 status code
|
|
180
|
+
* of the GET AiConciergeConversations endpoint.
|
|
181
|
+
* It provides type safety for handling this specific response as defined in the OpenAPI specification.
|
|
182
|
+
*
|
|
183
|
+
|
|
184
|
+
*
|
|
185
|
+
* @path /v1/ai-concierge/conversations
|
|
186
|
+
* @param sort (query) - Comma-separated sort fields. Prefix with `-` for DESC.
|
|
187
|
+
* @param q (query) - Full-text search on title/summary.
|
|
188
|
+
*
|
|
189
|
+
* @see {@link GET_AiConciergeConversations_Response} - The main response type definition
|
|
190
|
+
* @see {@link ConversationList} - The actual schema type definition
|
|
191
|
+
*/
|
|
192
|
+
export type GET_AiConciergeConversations_Response_200 = ConversationList
|
|
193
|
+
|
|
194
|
+
/**
|
|
195
|
+
* 401 response for GET AiConciergeConversations endpoint
|
|
196
|
+
*
|
|
197
|
+
* @remarks
|
|
198
|
+
* This type defines the response structure for the 401 status code
|
|
199
|
+
* of the GET AiConciergeConversations endpoint.
|
|
200
|
+
* It provides type safety for handling this specific response as defined in the OpenAPI specification.
|
|
201
|
+
*
|
|
202
|
+
|
|
203
|
+
*
|
|
204
|
+
* @path /v1/ai-concierge/conversations
|
|
205
|
+
* @param sort (query) - Comma-separated sort fields. Prefix with `-` for DESC.
|
|
206
|
+
* @param q (query) - Full-text search on title/summary.
|
|
207
|
+
*
|
|
208
|
+
* @see {@link GET_AiConciergeConversations_Response} - The main response type definition
|
|
209
|
+
* @see {@link Problem} - The actual schema type definition
|
|
210
|
+
*/
|
|
211
|
+
export type GET_AiConciergeConversations_Response_401 = Problem
|
|
212
|
+
|
|
213
|
+
/**
|
|
214
|
+
* 404 response for GET AiConciergeConversations endpoint
|
|
215
|
+
*
|
|
216
|
+
* @remarks
|
|
217
|
+
* This type defines the response structure for the 404 status code
|
|
218
|
+
* of the GET AiConciergeConversations endpoint.
|
|
219
|
+
* It provides type safety for handling this specific response as defined in the OpenAPI specification.
|
|
220
|
+
*
|
|
221
|
+
|
|
222
|
+
*
|
|
223
|
+
* @path /v1/ai-concierge/conversations
|
|
224
|
+
* @param sort (query) - Comma-separated sort fields. Prefix with `-` for DESC.
|
|
225
|
+
* @param q (query) - Full-text search on title/summary.
|
|
226
|
+
*
|
|
227
|
+
* @see {@link GET_AiConciergeConversations_Response} - The main response type definition
|
|
228
|
+
* @see {@link Problem} - The actual schema type definition
|
|
229
|
+
*/
|
|
230
|
+
export type GET_AiConciergeConversations_Response_404 = Problem
|
|
231
|
+
|
|
232
|
+
/**
|
|
233
|
+
* 422 response for GET AiConciergeConversations endpoint
|
|
234
|
+
*
|
|
235
|
+
* @remarks
|
|
236
|
+
* This type defines the response structure for the 422 status code
|
|
237
|
+
* of the GET AiConciergeConversations endpoint.
|
|
238
|
+
* It provides type safety for handling this specific response as defined in the OpenAPI specification.
|
|
239
|
+
*
|
|
240
|
+
|
|
241
|
+
*
|
|
242
|
+
* @path /v1/ai-concierge/conversations
|
|
243
|
+
* @param sort (query) - Comma-separated sort fields. Prefix with `-` for DESC.
|
|
244
|
+
* @param q (query) - Full-text search on title/summary.
|
|
245
|
+
*
|
|
246
|
+
* @see {@link GET_AiConciergeConversations_Response} - The main response type definition
|
|
247
|
+
* @see {@link HTTPValidationError} - The actual schema type definition
|
|
248
|
+
*/
|
|
249
|
+
export type GET_AiConciergeConversations_Response_422 = HTTPValidationError
|
|
250
|
+
|
|
251
|
+
/**
|
|
252
|
+
* 502 response for GET AiConciergeConversations endpoint
|
|
253
|
+
*
|
|
254
|
+
* @remarks
|
|
255
|
+
* This type defines the response structure for the 502 status code
|
|
256
|
+
* of the GET AiConciergeConversations endpoint.
|
|
257
|
+
* It provides type safety for handling this specific response as defined in the OpenAPI specification.
|
|
258
|
+
*
|
|
259
|
+
|
|
260
|
+
*
|
|
261
|
+
* @path /v1/ai-concierge/conversations
|
|
262
|
+
* @param sort (query) - Comma-separated sort fields. Prefix with `-` for DESC.
|
|
263
|
+
* @param q (query) - Full-text search on title/summary.
|
|
264
|
+
*
|
|
265
|
+
* @see {@link GET_AiConciergeConversations_Response} - The main response type definition
|
|
266
|
+
* @see {@link Problem} - The actual schema type definition
|
|
267
|
+
*/
|
|
268
|
+
export type GET_AiConciergeConversations_Response_502 = Problem
|
|
269
|
+
|
|
270
|
+
/**
|
|
271
|
+
* Response types for POST AiConciergeConversations endpoint
|
|
272
|
+
*
|
|
273
|
+
* Create an AI Concierge conversation
|
|
274
|
+
*
|
|
275
|
+
* @remarks
|
|
276
|
+
* This type defines all possible response structures for the POST AiConciergeConversations endpoint.
|
|
277
|
+
* Each response code maps to a specific response type as defined in the OpenAPI specification.
|
|
278
|
+
* Use this type to ensure type safety when handling API responses from this endpoint.
|
|
279
|
+
*
|
|
280
|
+
|
|
281
|
+
*
|
|
282
|
+
* @path /v1/ai-concierge/conversations
|
|
283
|
+
*
|
|
284
|
+
* @see {@link POST_AiConciergeConversations_Response_201} - 201 response type
|
|
285
|
+
* @see {@link POST_AiConciergeConversations_Response_401} - 401 response type
|
|
286
|
+
* @see {@link POST_AiConciergeConversations_Response_404} - 404 response type
|
|
287
|
+
* @see {@link POST_AiConciergeConversations_Response_422} - 422 response type
|
|
288
|
+
* @see {@link POST_AiConciergeConversations_Response_502} - 502 response type
|
|
289
|
+
*
|
|
290
|
+
|
|
291
|
+
*/
|
|
292
|
+
export type POST_AiConciergeConversations_Response = POST_AiConciergeConversations_Response_201 | POST_AiConciergeConversations_Response_401 | POST_AiConciergeConversations_Response_404 | POST_AiConciergeConversations_Response_422 | POST_AiConciergeConversations_Response_502;
|
|
293
|
+
|
|
294
|
+
/**
|
|
295
|
+
* 201 response for POST AiConciergeConversations endpoint
|
|
296
|
+
*
|
|
297
|
+
* @remarks
|
|
298
|
+
* This type defines the response structure for the 201 status code
|
|
299
|
+
* of the POST AiConciergeConversations endpoint.
|
|
300
|
+
* It provides type safety for handling this specific response as defined in the OpenAPI specification.
|
|
301
|
+
*
|
|
302
|
+
|
|
303
|
+
*
|
|
304
|
+
* @path /v1/ai-concierge/conversations
|
|
305
|
+
*
|
|
306
|
+
* @see {@link POST_AiConciergeConversations_Response} - The main response type definition
|
|
307
|
+
* @see {@link Conversation} - The actual schema type definition
|
|
308
|
+
*/
|
|
309
|
+
export type POST_AiConciergeConversations_Response_201 = Conversation
|
|
310
|
+
|
|
311
|
+
/**
|
|
312
|
+
* 401 response for POST AiConciergeConversations endpoint
|
|
313
|
+
*
|
|
314
|
+
* @remarks
|
|
315
|
+
* This type defines the response structure for the 401 status code
|
|
316
|
+
* of the POST AiConciergeConversations endpoint.
|
|
317
|
+
* It provides type safety for handling this specific response as defined in the OpenAPI specification.
|
|
318
|
+
*
|
|
319
|
+
|
|
320
|
+
*
|
|
321
|
+
* @path /v1/ai-concierge/conversations
|
|
322
|
+
*
|
|
323
|
+
* @see {@link POST_AiConciergeConversations_Response} - The main response type definition
|
|
324
|
+
* @see {@link Problem} - The actual schema type definition
|
|
325
|
+
*/
|
|
326
|
+
export type POST_AiConciergeConversations_Response_401 = Problem
|
|
327
|
+
|
|
328
|
+
/**
|
|
329
|
+
* 404 response for POST AiConciergeConversations endpoint
|
|
330
|
+
*
|
|
331
|
+
* @remarks
|
|
332
|
+
* This type defines the response structure for the 404 status code
|
|
333
|
+
* of the POST AiConciergeConversations endpoint.
|
|
334
|
+
* It provides type safety for handling this specific response as defined in the OpenAPI specification.
|
|
335
|
+
*
|
|
336
|
+
|
|
337
|
+
*
|
|
338
|
+
* @path /v1/ai-concierge/conversations
|
|
339
|
+
*
|
|
340
|
+
* @see {@link POST_AiConciergeConversations_Response} - The main response type definition
|
|
341
|
+
* @see {@link Problem} - The actual schema type definition
|
|
342
|
+
*/
|
|
343
|
+
export type POST_AiConciergeConversations_Response_404 = Problem
|
|
344
|
+
|
|
345
|
+
/**
|
|
346
|
+
* 422 response for POST AiConciergeConversations endpoint
|
|
347
|
+
*
|
|
348
|
+
* @remarks
|
|
349
|
+
* This type defines the response structure for the 422 status code
|
|
350
|
+
* of the POST AiConciergeConversations endpoint.
|
|
351
|
+
* It provides type safety for handling this specific response as defined in the OpenAPI specification.
|
|
352
|
+
*
|
|
353
|
+
|
|
354
|
+
*
|
|
355
|
+
* @path /v1/ai-concierge/conversations
|
|
356
|
+
*
|
|
357
|
+
* @see {@link POST_AiConciergeConversations_Response} - The main response type definition
|
|
358
|
+
* @see {@link HTTPValidationError} - The actual schema type definition
|
|
359
|
+
*/
|
|
360
|
+
export type POST_AiConciergeConversations_Response_422 = HTTPValidationError
|
|
361
|
+
|
|
362
|
+
/**
|
|
363
|
+
* 502 response for POST AiConciergeConversations endpoint
|
|
364
|
+
*
|
|
365
|
+
* @remarks
|
|
366
|
+
* This type defines the response structure for the 502 status code
|
|
367
|
+
* of the POST AiConciergeConversations endpoint.
|
|
368
|
+
* It provides type safety for handling this specific response as defined in the OpenAPI specification.
|
|
369
|
+
*
|
|
370
|
+
|
|
371
|
+
*
|
|
372
|
+
* @path /v1/ai-concierge/conversations
|
|
373
|
+
*
|
|
374
|
+
* @see {@link POST_AiConciergeConversations_Response} - The main response type definition
|
|
375
|
+
* @see {@link Problem} - The actual schema type definition
|
|
376
|
+
*/
|
|
377
|
+
export type POST_AiConciergeConversations_Response_502 = Problem
|
|
378
|
+
|
|
379
|
+
/**
|
|
380
|
+
* Response types for DELETE AiConciergeConversationsByConversationId endpoint
|
|
381
|
+
*
|
|
382
|
+
* Delete a conversation
|
|
383
|
+
* Permanently delete a conversation, its messages, and any attached contexts.
|
|
384
|
+
*
|
|
385
|
+
* @remarks
|
|
386
|
+
* This type defines all possible response structures for the DELETE AiConciergeConversationsByConversationId endpoint.
|
|
387
|
+
* Each response code maps to a specific response type as defined in the OpenAPI specification.
|
|
388
|
+
* Use this type to ensure type safety when handling API responses from this endpoint.
|
|
389
|
+
*
|
|
390
|
+
|
|
391
|
+
*
|
|
392
|
+
* @path /v1/ai-concierge/conversations/{conversation_id}
|
|
393
|
+
*
|
|
394
|
+
* @see {@link DELETE_AiConciergeConversationsByConversationId_Response_401} - 401 response type
|
|
395
|
+
* @see {@link DELETE_AiConciergeConversationsByConversationId_Response_404} - 404 response type
|
|
396
|
+
* @see {@link DELETE_AiConciergeConversationsByConversationId_Response_422} - 422 response type
|
|
397
|
+
* @see {@link DELETE_AiConciergeConversationsByConversationId_Response_502} - 502 response type
|
|
398
|
+
*
|
|
399
|
+
|
|
400
|
+
*/
|
|
401
|
+
export type DELETE_AiConciergeConversationsByConversationId_Response = DELETE_AiConciergeConversationsByConversationId_Response_401 | DELETE_AiConciergeConversationsByConversationId_Response_404 | DELETE_AiConciergeConversationsByConversationId_Response_422 | DELETE_AiConciergeConversationsByConversationId_Response_502;
|
|
402
|
+
|
|
403
|
+
/**
|
|
404
|
+
* 401 response for DELETE AiConciergeConversationsByConversationId endpoint
|
|
405
|
+
*
|
|
406
|
+
* @remarks
|
|
407
|
+
* This type defines the response structure for the 401 status code
|
|
408
|
+
* of the DELETE AiConciergeConversationsByConversationId endpoint.
|
|
409
|
+
* It provides type safety for handling this specific response as defined in the OpenAPI specification.
|
|
410
|
+
*
|
|
411
|
+
|
|
412
|
+
*
|
|
413
|
+
* @path /v1/ai-concierge/conversations/{conversation_id}
|
|
414
|
+
*
|
|
415
|
+
* @see {@link DELETE_AiConciergeConversationsByConversationId_Response} - The main response type definition
|
|
416
|
+
* @see {@link Problem} - The actual schema type definition
|
|
417
|
+
*/
|
|
418
|
+
export type DELETE_AiConciergeConversationsByConversationId_Response_401 = Problem
|
|
419
|
+
|
|
420
|
+
/**
|
|
421
|
+
* 404 response for DELETE AiConciergeConversationsByConversationId endpoint
|
|
422
|
+
*
|
|
423
|
+
* @remarks
|
|
424
|
+
* This type defines the response structure for the 404 status code
|
|
425
|
+
* of the DELETE AiConciergeConversationsByConversationId endpoint.
|
|
426
|
+
* It provides type safety for handling this specific response as defined in the OpenAPI specification.
|
|
427
|
+
*
|
|
428
|
+
|
|
429
|
+
*
|
|
430
|
+
* @path /v1/ai-concierge/conversations/{conversation_id}
|
|
431
|
+
*
|
|
432
|
+
* @see {@link DELETE_AiConciergeConversationsByConversationId_Response} - The main response type definition
|
|
433
|
+
* @see {@link Problem} - The actual schema type definition
|
|
434
|
+
*/
|
|
435
|
+
export type DELETE_AiConciergeConversationsByConversationId_Response_404 = Problem
|
|
436
|
+
|
|
437
|
+
/**
|
|
438
|
+
* 422 response for DELETE AiConciergeConversationsByConversationId endpoint
|
|
439
|
+
*
|
|
440
|
+
* @remarks
|
|
441
|
+
* This type defines the response structure for the 422 status code
|
|
442
|
+
* of the DELETE AiConciergeConversationsByConversationId endpoint.
|
|
443
|
+
* It provides type safety for handling this specific response as defined in the OpenAPI specification.
|
|
444
|
+
*
|
|
445
|
+
|
|
446
|
+
*
|
|
447
|
+
* @path /v1/ai-concierge/conversations/{conversation_id}
|
|
448
|
+
*
|
|
449
|
+
* @see {@link DELETE_AiConciergeConversationsByConversationId_Response} - The main response type definition
|
|
450
|
+
* @see {@link HTTPValidationError} - The actual schema type definition
|
|
451
|
+
*/
|
|
452
|
+
export type DELETE_AiConciergeConversationsByConversationId_Response_422 = HTTPValidationError
|
|
453
|
+
|
|
454
|
+
/**
|
|
455
|
+
* 502 response for DELETE AiConciergeConversationsByConversationId endpoint
|
|
456
|
+
*
|
|
457
|
+
* @remarks
|
|
458
|
+
* This type defines the response structure for the 502 status code
|
|
459
|
+
* of the DELETE AiConciergeConversationsByConversationId endpoint.
|
|
460
|
+
* It provides type safety for handling this specific response as defined in the OpenAPI specification.
|
|
461
|
+
*
|
|
462
|
+
|
|
463
|
+
*
|
|
464
|
+
* @path /v1/ai-concierge/conversations/{conversation_id}
|
|
465
|
+
*
|
|
466
|
+
* @see {@link DELETE_AiConciergeConversationsByConversationId_Response} - The main response type definition
|
|
467
|
+
* @see {@link Problem} - The actual schema type definition
|
|
468
|
+
*/
|
|
469
|
+
export type DELETE_AiConciergeConversationsByConversationId_Response_502 = Problem
|
|
470
|
+
|
|
471
|
+
/**
|
|
472
|
+
* Response types for GET AiConciergeConversationsByConversationId endpoint
|
|
473
|
+
*
|
|
474
|
+
* Get a conversation
|
|
475
|
+
*
|
|
476
|
+
* @remarks
|
|
477
|
+
* This type defines all possible response structures for the GET AiConciergeConversationsByConversationId endpoint.
|
|
478
|
+
* Each response code maps to a specific response type as defined in the OpenAPI specification.
|
|
479
|
+
* Use this type to ensure type safety when handling API responses from this endpoint.
|
|
480
|
+
*
|
|
481
|
+
|
|
482
|
+
*
|
|
483
|
+
* @path /v1/ai-concierge/conversations/{conversation_id}
|
|
484
|
+
*
|
|
485
|
+
* @see {@link GET_AiConciergeConversationsByConversationId_Response_200} - 200 response type
|
|
486
|
+
* @see {@link GET_AiConciergeConversationsByConversationId_Response_401} - 401 response type
|
|
487
|
+
* @see {@link GET_AiConciergeConversationsByConversationId_Response_404} - 404 response type
|
|
488
|
+
* @see {@link GET_AiConciergeConversationsByConversationId_Response_422} - 422 response type
|
|
489
|
+
* @see {@link GET_AiConciergeConversationsByConversationId_Response_502} - 502 response type
|
|
490
|
+
*
|
|
491
|
+
|
|
492
|
+
*/
|
|
493
|
+
export type GET_AiConciergeConversationsByConversationId_Response = GET_AiConciergeConversationsByConversationId_Response_200 | GET_AiConciergeConversationsByConversationId_Response_401 | GET_AiConciergeConversationsByConversationId_Response_404 | GET_AiConciergeConversationsByConversationId_Response_422 | GET_AiConciergeConversationsByConversationId_Response_502;
|
|
494
|
+
|
|
495
|
+
/**
|
|
496
|
+
* 200 response for GET AiConciergeConversationsByConversationId endpoint
|
|
497
|
+
*
|
|
498
|
+
* @remarks
|
|
499
|
+
* This type defines the response structure for the 200 status code
|
|
500
|
+
* of the GET AiConciergeConversationsByConversationId endpoint.
|
|
501
|
+
* It provides type safety for handling this specific response as defined in the OpenAPI specification.
|
|
502
|
+
*
|
|
503
|
+
|
|
504
|
+
*
|
|
505
|
+
* @path /v1/ai-concierge/conversations/{conversation_id}
|
|
506
|
+
*
|
|
507
|
+
* @see {@link GET_AiConciergeConversationsByConversationId_Response} - The main response type definition
|
|
508
|
+
* @see {@link Conversation} - The actual schema type definition
|
|
509
|
+
*/
|
|
510
|
+
export type GET_AiConciergeConversationsByConversationId_Response_200 = Conversation
|
|
511
|
+
|
|
512
|
+
/**
|
|
513
|
+
* 401 response for GET AiConciergeConversationsByConversationId endpoint
|
|
514
|
+
*
|
|
515
|
+
* @remarks
|
|
516
|
+
* This type defines the response structure for the 401 status code
|
|
517
|
+
* of the GET AiConciergeConversationsByConversationId endpoint.
|
|
518
|
+
* It provides type safety for handling this specific response as defined in the OpenAPI specification.
|
|
519
|
+
*
|
|
520
|
+
|
|
521
|
+
*
|
|
522
|
+
* @path /v1/ai-concierge/conversations/{conversation_id}
|
|
523
|
+
*
|
|
524
|
+
* @see {@link GET_AiConciergeConversationsByConversationId_Response} - The main response type definition
|
|
525
|
+
* @see {@link Problem} - The actual schema type definition
|
|
526
|
+
*/
|
|
527
|
+
export type GET_AiConciergeConversationsByConversationId_Response_401 = Problem
|
|
528
|
+
|
|
529
|
+
/**
|
|
530
|
+
* 404 response for GET AiConciergeConversationsByConversationId endpoint
|
|
531
|
+
*
|
|
532
|
+
* @remarks
|
|
533
|
+
* This type defines the response structure for the 404 status code
|
|
534
|
+
* of the GET AiConciergeConversationsByConversationId endpoint.
|
|
535
|
+
* It provides type safety for handling this specific response as defined in the OpenAPI specification.
|
|
536
|
+
*
|
|
537
|
+
|
|
538
|
+
*
|
|
539
|
+
* @path /v1/ai-concierge/conversations/{conversation_id}
|
|
540
|
+
*
|
|
541
|
+
* @see {@link GET_AiConciergeConversationsByConversationId_Response} - The main response type definition
|
|
542
|
+
* @see {@link Problem} - The actual schema type definition
|
|
543
|
+
*/
|
|
544
|
+
export type GET_AiConciergeConversationsByConversationId_Response_404 = Problem
|
|
545
|
+
|
|
546
|
+
/**
|
|
547
|
+
* 422 response for GET AiConciergeConversationsByConversationId endpoint
|
|
548
|
+
*
|
|
549
|
+
* @remarks
|
|
550
|
+
* This type defines the response structure for the 422 status code
|
|
551
|
+
* of the GET AiConciergeConversationsByConversationId endpoint.
|
|
552
|
+
* It provides type safety for handling this specific response as defined in the OpenAPI specification.
|
|
553
|
+
*
|
|
554
|
+
|
|
555
|
+
*
|
|
556
|
+
* @path /v1/ai-concierge/conversations/{conversation_id}
|
|
557
|
+
*
|
|
558
|
+
* @see {@link GET_AiConciergeConversationsByConversationId_Response} - The main response type definition
|
|
559
|
+
* @see {@link HTTPValidationError} - The actual schema type definition
|
|
560
|
+
*/
|
|
561
|
+
export type GET_AiConciergeConversationsByConversationId_Response_422 = HTTPValidationError
|
|
562
|
+
|
|
563
|
+
/**
|
|
564
|
+
* 502 response for GET AiConciergeConversationsByConversationId endpoint
|
|
565
|
+
*
|
|
566
|
+
* @remarks
|
|
567
|
+
* This type defines the response structure for the 502 status code
|
|
568
|
+
* of the GET AiConciergeConversationsByConversationId endpoint.
|
|
569
|
+
* It provides type safety for handling this specific response as defined in the OpenAPI specification.
|
|
570
|
+
*
|
|
571
|
+
|
|
572
|
+
*
|
|
573
|
+
* @path /v1/ai-concierge/conversations/{conversation_id}
|
|
574
|
+
*
|
|
575
|
+
* @see {@link GET_AiConciergeConversationsByConversationId_Response} - The main response type definition
|
|
576
|
+
* @see {@link Problem} - The actual schema type definition
|
|
577
|
+
*/
|
|
578
|
+
export type GET_AiConciergeConversationsByConversationId_Response_502 = Problem
|
|
579
|
+
|
|
580
|
+
/**
|
|
581
|
+
* Response types for PATCH AiConciergeConversationsByConversationId endpoint
|
|
582
|
+
*
|
|
583
|
+
* Update a conversation
|
|
584
|
+
* Update conversation title or metadata. Supports optimistic concurrency via `If-Match`.
|
|
585
|
+
*
|
|
586
|
+
* @remarks
|
|
587
|
+
* This type defines all possible response structures for the PATCH AiConciergeConversationsByConversationId endpoint.
|
|
588
|
+
* Each response code maps to a specific response type as defined in the OpenAPI specification.
|
|
589
|
+
* Use this type to ensure type safety when handling API responses from this endpoint.
|
|
590
|
+
*
|
|
591
|
+
|
|
592
|
+
*
|
|
593
|
+
* @path /v1/ai-concierge/conversations/{conversation_id}
|
|
594
|
+
*
|
|
595
|
+
* @see {@link PATCH_AiConciergeConversationsByConversationId_Response_200} - 200 response type
|
|
596
|
+
* @see {@link PATCH_AiConciergeConversationsByConversationId_Response_401} - 401 response type
|
|
597
|
+
* @see {@link PATCH_AiConciergeConversationsByConversationId_Response_404} - 404 response type
|
|
598
|
+
* @see {@link PATCH_AiConciergeConversationsByConversationId_Response_422} - 422 response type
|
|
599
|
+
* @see {@link PATCH_AiConciergeConversationsByConversationId_Response_502} - 502 response type
|
|
600
|
+
*
|
|
601
|
+
|
|
602
|
+
*/
|
|
603
|
+
export type PATCH_AiConciergeConversationsByConversationId_Response = PATCH_AiConciergeConversationsByConversationId_Response_200 | PATCH_AiConciergeConversationsByConversationId_Response_401 | PATCH_AiConciergeConversationsByConversationId_Response_404 | PATCH_AiConciergeConversationsByConversationId_Response_422 | PATCH_AiConciergeConversationsByConversationId_Response_502;
|
|
604
|
+
|
|
605
|
+
/**
|
|
606
|
+
* 200 response for PATCH AiConciergeConversationsByConversationId endpoint
|
|
607
|
+
*
|
|
608
|
+
* @remarks
|
|
609
|
+
* This type defines the response structure for the 200 status code
|
|
610
|
+
* of the PATCH AiConciergeConversationsByConversationId endpoint.
|
|
611
|
+
* It provides type safety for handling this specific response as defined in the OpenAPI specification.
|
|
612
|
+
*
|
|
613
|
+
|
|
614
|
+
*
|
|
615
|
+
* @path /v1/ai-concierge/conversations/{conversation_id}
|
|
616
|
+
*
|
|
617
|
+
* @see {@link PATCH_AiConciergeConversationsByConversationId_Response} - The main response type definition
|
|
618
|
+
* @see {@link Conversation} - The actual schema type definition
|
|
619
|
+
*/
|
|
620
|
+
export type PATCH_AiConciergeConversationsByConversationId_Response_200 = Conversation
|
|
621
|
+
|
|
622
|
+
/**
|
|
623
|
+
* 401 response for PATCH AiConciergeConversationsByConversationId endpoint
|
|
624
|
+
*
|
|
625
|
+
* @remarks
|
|
626
|
+
* This type defines the response structure for the 401 status code
|
|
627
|
+
* of the PATCH AiConciergeConversationsByConversationId endpoint.
|
|
628
|
+
* It provides type safety for handling this specific response as defined in the OpenAPI specification.
|
|
629
|
+
*
|
|
630
|
+
|
|
631
|
+
*
|
|
632
|
+
* @path /v1/ai-concierge/conversations/{conversation_id}
|
|
633
|
+
*
|
|
634
|
+
* @see {@link PATCH_AiConciergeConversationsByConversationId_Response} - The main response type definition
|
|
635
|
+
* @see {@link Problem} - The actual schema type definition
|
|
636
|
+
*/
|
|
637
|
+
export type PATCH_AiConciergeConversationsByConversationId_Response_401 = Problem
|
|
638
|
+
|
|
639
|
+
/**
|
|
640
|
+
* 404 response for PATCH AiConciergeConversationsByConversationId endpoint
|
|
641
|
+
*
|
|
642
|
+
* @remarks
|
|
643
|
+
* This type defines the response structure for the 404 status code
|
|
644
|
+
* of the PATCH AiConciergeConversationsByConversationId endpoint.
|
|
645
|
+
* It provides type safety for handling this specific response as defined in the OpenAPI specification.
|
|
646
|
+
*
|
|
647
|
+
|
|
648
|
+
*
|
|
649
|
+
* @path /v1/ai-concierge/conversations/{conversation_id}
|
|
650
|
+
*
|
|
651
|
+
* @see {@link PATCH_AiConciergeConversationsByConversationId_Response} - The main response type definition
|
|
652
|
+
* @see {@link Problem} - The actual schema type definition
|
|
653
|
+
*/
|
|
654
|
+
export type PATCH_AiConciergeConversationsByConversationId_Response_404 = Problem
|
|
655
|
+
|
|
656
|
+
/**
|
|
657
|
+
* 422 response for PATCH AiConciergeConversationsByConversationId endpoint
|
|
658
|
+
*
|
|
659
|
+
* @remarks
|
|
660
|
+
* This type defines the response structure for the 422 status code
|
|
661
|
+
* of the PATCH AiConciergeConversationsByConversationId endpoint.
|
|
662
|
+
* It provides type safety for handling this specific response as defined in the OpenAPI specification.
|
|
663
|
+
*
|
|
664
|
+
|
|
665
|
+
*
|
|
666
|
+
* @path /v1/ai-concierge/conversations/{conversation_id}
|
|
667
|
+
*
|
|
668
|
+
* @see {@link PATCH_AiConciergeConversationsByConversationId_Response} - The main response type definition
|
|
669
|
+
* @see {@link HTTPValidationError} - The actual schema type definition
|
|
670
|
+
*/
|
|
671
|
+
export type PATCH_AiConciergeConversationsByConversationId_Response_422 = HTTPValidationError
|
|
672
|
+
|
|
673
|
+
/**
|
|
674
|
+
* 502 response for PATCH AiConciergeConversationsByConversationId endpoint
|
|
675
|
+
*
|
|
676
|
+
* @remarks
|
|
677
|
+
* This type defines the response structure for the 502 status code
|
|
678
|
+
* of the PATCH AiConciergeConversationsByConversationId endpoint.
|
|
679
|
+
* It provides type safety for handling this specific response as defined in the OpenAPI specification.
|
|
680
|
+
*
|
|
681
|
+
|
|
682
|
+
*
|
|
683
|
+
* @path /v1/ai-concierge/conversations/{conversation_id}
|
|
684
|
+
*
|
|
685
|
+
* @see {@link PATCH_AiConciergeConversationsByConversationId_Response} - The main response type definition
|
|
686
|
+
* @see {@link Problem} - The actual schema type definition
|
|
687
|
+
*/
|
|
688
|
+
export type PATCH_AiConciergeConversationsByConversationId_Response_502 = Problem
|
|
689
|
+
|
|
690
|
+
/**
|
|
691
|
+
* Response types for GET AiConciergeConversationsByConversationIdContexts endpoint
|
|
692
|
+
*
|
|
693
|
+
* List contexts attached to a conversation
|
|
694
|
+
*
|
|
695
|
+
* @remarks
|
|
696
|
+
* This type defines all possible response structures for the GET AiConciergeConversationsByConversationIdContexts endpoint.
|
|
697
|
+
* Each response code maps to a specific response type as defined in the OpenAPI specification.
|
|
698
|
+
* Use this type to ensure type safety when handling API responses from this endpoint.
|
|
699
|
+
*
|
|
700
|
+
|
|
701
|
+
*
|
|
702
|
+
* @path /v1/ai-concierge/conversations/{conversation_id}/contexts
|
|
703
|
+
*
|
|
704
|
+
* @see {@link GET_AiConciergeConversationsByConversationIdContexts_Response_200} - 200 response type
|
|
705
|
+
* @see {@link GET_AiConciergeConversationsByConversationIdContexts_Response_401} - 401 response type
|
|
706
|
+
* @see {@link GET_AiConciergeConversationsByConversationIdContexts_Response_404} - 404 response type
|
|
707
|
+
* @see {@link GET_AiConciergeConversationsByConversationIdContexts_Response_422} - 422 response type
|
|
708
|
+
* @see {@link GET_AiConciergeConversationsByConversationIdContexts_Response_502} - 502 response type
|
|
709
|
+
*
|
|
710
|
+
|
|
711
|
+
*/
|
|
712
|
+
export type GET_AiConciergeConversationsByConversationIdContexts_Response = GET_AiConciergeConversationsByConversationIdContexts_Response_200 | GET_AiConciergeConversationsByConversationIdContexts_Response_401 | GET_AiConciergeConversationsByConversationIdContexts_Response_404 | GET_AiConciergeConversationsByConversationIdContexts_Response_422 | GET_AiConciergeConversationsByConversationIdContexts_Response_502;
|
|
713
|
+
|
|
714
|
+
/**
|
|
715
|
+
* 200 response for GET AiConciergeConversationsByConversationIdContexts endpoint
|
|
716
|
+
*
|
|
717
|
+
* @remarks
|
|
718
|
+
* This type defines the response structure for the 200 status code
|
|
719
|
+
* of the GET AiConciergeConversationsByConversationIdContexts endpoint.
|
|
720
|
+
* It provides type safety for handling this specific response as defined in the OpenAPI specification.
|
|
721
|
+
*
|
|
722
|
+
|
|
723
|
+
*
|
|
724
|
+
* @path /v1/ai-concierge/conversations/{conversation_id}/contexts
|
|
725
|
+
*
|
|
726
|
+
* @see {@link GET_AiConciergeConversationsByConversationIdContexts_Response} - The main response type definition
|
|
727
|
+
* @see {@link ContextList} - The actual schema type definition
|
|
728
|
+
*/
|
|
729
|
+
export type GET_AiConciergeConversationsByConversationIdContexts_Response_200 = ContextList
|
|
730
|
+
|
|
731
|
+
/**
|
|
732
|
+
* 401 response for GET AiConciergeConversationsByConversationIdContexts endpoint
|
|
733
|
+
*
|
|
734
|
+
* @remarks
|
|
735
|
+
* This type defines the response structure for the 401 status code
|
|
736
|
+
* of the GET AiConciergeConversationsByConversationIdContexts endpoint.
|
|
737
|
+
* It provides type safety for handling this specific response as defined in the OpenAPI specification.
|
|
738
|
+
*
|
|
739
|
+
|
|
740
|
+
*
|
|
741
|
+
* @path /v1/ai-concierge/conversations/{conversation_id}/contexts
|
|
742
|
+
*
|
|
743
|
+
* @see {@link GET_AiConciergeConversationsByConversationIdContexts_Response} - The main response type definition
|
|
744
|
+
* @see {@link Problem} - The actual schema type definition
|
|
745
|
+
*/
|
|
746
|
+
export type GET_AiConciergeConversationsByConversationIdContexts_Response_401 = Problem
|
|
747
|
+
|
|
748
|
+
/**
|
|
749
|
+
* 404 response for GET AiConciergeConversationsByConversationIdContexts endpoint
|
|
750
|
+
*
|
|
751
|
+
* @remarks
|
|
752
|
+
* This type defines the response structure for the 404 status code
|
|
753
|
+
* of the GET AiConciergeConversationsByConversationIdContexts endpoint.
|
|
754
|
+
* It provides type safety for handling this specific response as defined in the OpenAPI specification.
|
|
755
|
+
*
|
|
756
|
+
|
|
757
|
+
*
|
|
758
|
+
* @path /v1/ai-concierge/conversations/{conversation_id}/contexts
|
|
759
|
+
*
|
|
760
|
+
* @see {@link GET_AiConciergeConversationsByConversationIdContexts_Response} - The main response type definition
|
|
761
|
+
* @see {@link Problem} - The actual schema type definition
|
|
762
|
+
*/
|
|
763
|
+
export type GET_AiConciergeConversationsByConversationIdContexts_Response_404 = Problem
|
|
764
|
+
|
|
765
|
+
/**
|
|
766
|
+
* 422 response for GET AiConciergeConversationsByConversationIdContexts endpoint
|
|
767
|
+
*
|
|
768
|
+
* @remarks
|
|
769
|
+
* This type defines the response structure for the 422 status code
|
|
770
|
+
* of the GET AiConciergeConversationsByConversationIdContexts endpoint.
|
|
771
|
+
* It provides type safety for handling this specific response as defined in the OpenAPI specification.
|
|
772
|
+
*
|
|
773
|
+
|
|
774
|
+
*
|
|
775
|
+
* @path /v1/ai-concierge/conversations/{conversation_id}/contexts
|
|
776
|
+
*
|
|
777
|
+
* @see {@link GET_AiConciergeConversationsByConversationIdContexts_Response} - The main response type definition
|
|
778
|
+
* @see {@link HTTPValidationError} - The actual schema type definition
|
|
779
|
+
*/
|
|
780
|
+
export type GET_AiConciergeConversationsByConversationIdContexts_Response_422 = HTTPValidationError
|
|
781
|
+
|
|
782
|
+
/**
|
|
783
|
+
* 502 response for GET AiConciergeConversationsByConversationIdContexts endpoint
|
|
784
|
+
*
|
|
785
|
+
* @remarks
|
|
786
|
+
* This type defines the response structure for the 502 status code
|
|
787
|
+
* of the GET AiConciergeConversationsByConversationIdContexts endpoint.
|
|
788
|
+
* It provides type safety for handling this specific response as defined in the OpenAPI specification.
|
|
789
|
+
*
|
|
790
|
+
|
|
791
|
+
*
|
|
792
|
+
* @path /v1/ai-concierge/conversations/{conversation_id}/contexts
|
|
793
|
+
*
|
|
794
|
+
* @see {@link GET_AiConciergeConversationsByConversationIdContexts_Response} - The main response type definition
|
|
795
|
+
* @see {@link Problem} - The actual schema type definition
|
|
796
|
+
*/
|
|
797
|
+
export type GET_AiConciergeConversationsByConversationIdContexts_Response_502 = Problem
|
|
798
|
+
|
|
799
|
+
/**
|
|
800
|
+
* Response types for POST AiConciergeConversationsByConversationIdContexts endpoint
|
|
801
|
+
*
|
|
802
|
+
* Attach a context to a conversation
|
|
803
|
+
*
|
|
804
|
+
* @remarks
|
|
805
|
+
* This type defines all possible response structures for the POST AiConciergeConversationsByConversationIdContexts endpoint.
|
|
806
|
+
* Each response code maps to a specific response type as defined in the OpenAPI specification.
|
|
807
|
+
* Use this type to ensure type safety when handling API responses from this endpoint.
|
|
808
|
+
*
|
|
809
|
+
|
|
810
|
+
*
|
|
811
|
+
* @path /v1/ai-concierge/conversations/{conversation_id}/contexts
|
|
812
|
+
*
|
|
813
|
+
* @see {@link POST_AiConciergeConversationsByConversationIdContexts_Response_201} - 201 response type
|
|
814
|
+
* @see {@link POST_AiConciergeConversationsByConversationIdContexts_Response_401} - 401 response type
|
|
815
|
+
* @see {@link POST_AiConciergeConversationsByConversationIdContexts_Response_404} - 404 response type
|
|
816
|
+
* @see {@link POST_AiConciergeConversationsByConversationIdContexts_Response_422} - 422 response type
|
|
817
|
+
* @see {@link POST_AiConciergeConversationsByConversationIdContexts_Response_502} - 502 response type
|
|
818
|
+
*
|
|
819
|
+
|
|
820
|
+
*/
|
|
821
|
+
export type POST_AiConciergeConversationsByConversationIdContexts_Response = POST_AiConciergeConversationsByConversationIdContexts_Response_201 | POST_AiConciergeConversationsByConversationIdContexts_Response_401 | POST_AiConciergeConversationsByConversationIdContexts_Response_404 | POST_AiConciergeConversationsByConversationIdContexts_Response_422 | POST_AiConciergeConversationsByConversationIdContexts_Response_502;
|
|
822
|
+
|
|
823
|
+
/**
|
|
824
|
+
* 201 response for POST AiConciergeConversationsByConversationIdContexts endpoint
|
|
825
|
+
*
|
|
826
|
+
* @remarks
|
|
827
|
+
* This type defines the response structure for the 201 status code
|
|
828
|
+
* of the POST AiConciergeConversationsByConversationIdContexts endpoint.
|
|
829
|
+
* It provides type safety for handling this specific response as defined in the OpenAPI specification.
|
|
830
|
+
*
|
|
831
|
+
|
|
832
|
+
*
|
|
833
|
+
* @path /v1/ai-concierge/conversations/{conversation_id}/contexts
|
|
834
|
+
*
|
|
835
|
+
* @see {@link POST_AiConciergeConversationsByConversationIdContexts_Response} - The main response type definition
|
|
836
|
+
* @see {@link Context} - The actual schema type definition
|
|
837
|
+
*/
|
|
838
|
+
export type POST_AiConciergeConversationsByConversationIdContexts_Response_201 = Context
|
|
839
|
+
|
|
840
|
+
/**
|
|
841
|
+
* 401 response for POST AiConciergeConversationsByConversationIdContexts endpoint
|
|
842
|
+
*
|
|
843
|
+
* @remarks
|
|
844
|
+
* This type defines the response structure for the 401 status code
|
|
845
|
+
* of the POST AiConciergeConversationsByConversationIdContexts endpoint.
|
|
846
|
+
* It provides type safety for handling this specific response as defined in the OpenAPI specification.
|
|
847
|
+
*
|
|
848
|
+
|
|
849
|
+
*
|
|
850
|
+
* @path /v1/ai-concierge/conversations/{conversation_id}/contexts
|
|
851
|
+
*
|
|
852
|
+
* @see {@link POST_AiConciergeConversationsByConversationIdContexts_Response} - The main response type definition
|
|
853
|
+
* @see {@link Problem} - The actual schema type definition
|
|
854
|
+
*/
|
|
855
|
+
export type POST_AiConciergeConversationsByConversationIdContexts_Response_401 = Problem
|
|
856
|
+
|
|
857
|
+
/**
|
|
858
|
+
* 404 response for POST AiConciergeConversationsByConversationIdContexts endpoint
|
|
859
|
+
*
|
|
860
|
+
* @remarks
|
|
861
|
+
* This type defines the response structure for the 404 status code
|
|
862
|
+
* of the POST AiConciergeConversationsByConversationIdContexts endpoint.
|
|
863
|
+
* It provides type safety for handling this specific response as defined in the OpenAPI specification.
|
|
864
|
+
*
|
|
865
|
+
|
|
866
|
+
*
|
|
867
|
+
* @path /v1/ai-concierge/conversations/{conversation_id}/contexts
|
|
868
|
+
*
|
|
869
|
+
* @see {@link POST_AiConciergeConversationsByConversationIdContexts_Response} - The main response type definition
|
|
870
|
+
* @see {@link Problem} - The actual schema type definition
|
|
871
|
+
*/
|
|
872
|
+
export type POST_AiConciergeConversationsByConversationIdContexts_Response_404 = Problem
|
|
873
|
+
|
|
874
|
+
/**
|
|
875
|
+
* 422 response for POST AiConciergeConversationsByConversationIdContexts endpoint
|
|
876
|
+
*
|
|
877
|
+
* @remarks
|
|
878
|
+
* This type defines the response structure for the 422 status code
|
|
879
|
+
* of the POST AiConciergeConversationsByConversationIdContexts endpoint.
|
|
880
|
+
* It provides type safety for handling this specific response as defined in the OpenAPI specification.
|
|
881
|
+
*
|
|
882
|
+
|
|
883
|
+
*
|
|
884
|
+
* @path /v1/ai-concierge/conversations/{conversation_id}/contexts
|
|
885
|
+
*
|
|
886
|
+
* @see {@link POST_AiConciergeConversationsByConversationIdContexts_Response} - The main response type definition
|
|
887
|
+
* @see {@link HTTPValidationError} - The actual schema type definition
|
|
888
|
+
*/
|
|
889
|
+
export type POST_AiConciergeConversationsByConversationIdContexts_Response_422 = HTTPValidationError
|
|
890
|
+
|
|
891
|
+
/**
|
|
892
|
+
* 502 response for POST AiConciergeConversationsByConversationIdContexts endpoint
|
|
893
|
+
*
|
|
894
|
+
* @remarks
|
|
895
|
+
* This type defines the response structure for the 502 status code
|
|
896
|
+
* of the POST AiConciergeConversationsByConversationIdContexts endpoint.
|
|
897
|
+
* It provides type safety for handling this specific response as defined in the OpenAPI specification.
|
|
898
|
+
*
|
|
899
|
+
|
|
900
|
+
*
|
|
901
|
+
* @path /v1/ai-concierge/conversations/{conversation_id}/contexts
|
|
902
|
+
*
|
|
903
|
+
* @see {@link POST_AiConciergeConversationsByConversationIdContexts_Response} - The main response type definition
|
|
904
|
+
* @see {@link Problem} - The actual schema type definition
|
|
905
|
+
*/
|
|
906
|
+
export type POST_AiConciergeConversationsByConversationIdContexts_Response_502 = Problem
|
|
907
|
+
|
|
908
|
+
/**
|
|
909
|
+
* Response types for GET AiConciergeConversationsByConversationIdMessages endpoint
|
|
910
|
+
*
|
|
911
|
+
* List messages in a conversation
|
|
912
|
+
*
|
|
913
|
+
* @remarks
|
|
914
|
+
* This type defines all possible response structures for the GET AiConciergeConversationsByConversationIdMessages endpoint.
|
|
915
|
+
* Each response code maps to a specific response type as defined in the OpenAPI specification.
|
|
916
|
+
* Use this type to ensure type safety when handling API responses from this endpoint.
|
|
917
|
+
*
|
|
918
|
+
|
|
919
|
+
*
|
|
920
|
+
* @path /v1/ai-concierge/conversations/{conversation_id}/messages
|
|
921
|
+
* @param recent (query) - If set, returns last N messages and overrides pagination.
|
|
922
|
+
* @param exclude (query) - Comma-separated tokens to exclude (case-insensitive). Supports `tools`.
|
|
923
|
+
*
|
|
924
|
+
* @see {@link GET_AiConciergeConversationsByConversationIdMessages_Response_200} - 200 response type
|
|
925
|
+
* @see {@link GET_AiConciergeConversationsByConversationIdMessages_Response_401} - 401 response type
|
|
926
|
+
* @see {@link GET_AiConciergeConversationsByConversationIdMessages_Response_404} - 404 response type
|
|
927
|
+
* @see {@link GET_AiConciergeConversationsByConversationIdMessages_Response_422} - 422 response type
|
|
928
|
+
* @see {@link GET_AiConciergeConversationsByConversationIdMessages_Response_502} - 502 response type
|
|
929
|
+
*
|
|
930
|
+
|
|
931
|
+
*/
|
|
932
|
+
export type GET_AiConciergeConversationsByConversationIdMessages_Response = GET_AiConciergeConversationsByConversationIdMessages_Response_200 | GET_AiConciergeConversationsByConversationIdMessages_Response_401 | GET_AiConciergeConversationsByConversationIdMessages_Response_404 | GET_AiConciergeConversationsByConversationIdMessages_Response_422 | GET_AiConciergeConversationsByConversationIdMessages_Response_502;
|
|
933
|
+
|
|
934
|
+
/**
|
|
935
|
+
* 200 response for GET AiConciergeConversationsByConversationIdMessages endpoint
|
|
936
|
+
*
|
|
937
|
+
* @remarks
|
|
938
|
+
* This type defines the response structure for the 200 status code
|
|
939
|
+
* of the GET AiConciergeConversationsByConversationIdMessages endpoint.
|
|
940
|
+
* It provides type safety for handling this specific response as defined in the OpenAPI specification.
|
|
941
|
+
*
|
|
942
|
+
|
|
943
|
+
*
|
|
944
|
+
* @path /v1/ai-concierge/conversations/{conversation_id}/messages
|
|
945
|
+
* @param recent (query) - If set, returns last N messages and overrides pagination.
|
|
946
|
+
* @param exclude (query) - Comma-separated tokens to exclude (case-insensitive). Supports `tools`.
|
|
947
|
+
*
|
|
948
|
+
* @see {@link GET_AiConciergeConversationsByConversationIdMessages_Response} - The main response type definition
|
|
949
|
+
* @see {@link MessageList} - The actual schema type definition
|
|
950
|
+
*/
|
|
951
|
+
export type GET_AiConciergeConversationsByConversationIdMessages_Response_200 = MessageList
|
|
952
|
+
|
|
953
|
+
/**
|
|
954
|
+
* 401 response for GET AiConciergeConversationsByConversationIdMessages endpoint
|
|
955
|
+
*
|
|
956
|
+
* @remarks
|
|
957
|
+
* This type defines the response structure for the 401 status code
|
|
958
|
+
* of the GET AiConciergeConversationsByConversationIdMessages endpoint.
|
|
959
|
+
* It provides type safety for handling this specific response as defined in the OpenAPI specification.
|
|
960
|
+
*
|
|
961
|
+
|
|
962
|
+
*
|
|
963
|
+
* @path /v1/ai-concierge/conversations/{conversation_id}/messages
|
|
964
|
+
* @param recent (query) - If set, returns last N messages and overrides pagination.
|
|
965
|
+
* @param exclude (query) - Comma-separated tokens to exclude (case-insensitive). Supports `tools`.
|
|
966
|
+
*
|
|
967
|
+
* @see {@link GET_AiConciergeConversationsByConversationIdMessages_Response} - The main response type definition
|
|
968
|
+
* @see {@link Problem} - The actual schema type definition
|
|
969
|
+
*/
|
|
970
|
+
export type GET_AiConciergeConversationsByConversationIdMessages_Response_401 = Problem
|
|
971
|
+
|
|
972
|
+
/**
|
|
973
|
+
* 404 response for GET AiConciergeConversationsByConversationIdMessages endpoint
|
|
974
|
+
*
|
|
975
|
+
* @remarks
|
|
976
|
+
* This type defines the response structure for the 404 status code
|
|
977
|
+
* of the GET AiConciergeConversationsByConversationIdMessages endpoint.
|
|
978
|
+
* It provides type safety for handling this specific response as defined in the OpenAPI specification.
|
|
979
|
+
*
|
|
980
|
+
|
|
981
|
+
*
|
|
982
|
+
* @path /v1/ai-concierge/conversations/{conversation_id}/messages
|
|
983
|
+
* @param recent (query) - If set, returns last N messages and overrides pagination.
|
|
984
|
+
* @param exclude (query) - Comma-separated tokens to exclude (case-insensitive). Supports `tools`.
|
|
985
|
+
*
|
|
986
|
+
* @see {@link GET_AiConciergeConversationsByConversationIdMessages_Response} - The main response type definition
|
|
987
|
+
* @see {@link Problem} - The actual schema type definition
|
|
988
|
+
*/
|
|
989
|
+
export type GET_AiConciergeConversationsByConversationIdMessages_Response_404 = Problem
|
|
990
|
+
|
|
991
|
+
/**
|
|
992
|
+
* 422 response for GET AiConciergeConversationsByConversationIdMessages endpoint
|
|
993
|
+
*
|
|
994
|
+
* @remarks
|
|
995
|
+
* This type defines the response structure for the 422 status code
|
|
996
|
+
* of the GET AiConciergeConversationsByConversationIdMessages endpoint.
|
|
997
|
+
* It provides type safety for handling this specific response as defined in the OpenAPI specification.
|
|
998
|
+
*
|
|
999
|
+
|
|
1000
|
+
*
|
|
1001
|
+
* @path /v1/ai-concierge/conversations/{conversation_id}/messages
|
|
1002
|
+
* @param recent (query) - If set, returns last N messages and overrides pagination.
|
|
1003
|
+
* @param exclude (query) - Comma-separated tokens to exclude (case-insensitive). Supports `tools`.
|
|
1004
|
+
*
|
|
1005
|
+
* @see {@link GET_AiConciergeConversationsByConversationIdMessages_Response} - The main response type definition
|
|
1006
|
+
* @see {@link HTTPValidationError} - The actual schema type definition
|
|
1007
|
+
*/
|
|
1008
|
+
export type GET_AiConciergeConversationsByConversationIdMessages_Response_422 = HTTPValidationError
|
|
1009
|
+
|
|
1010
|
+
/**
|
|
1011
|
+
* 502 response for GET AiConciergeConversationsByConversationIdMessages endpoint
|
|
1012
|
+
*
|
|
1013
|
+
* @remarks
|
|
1014
|
+
* This type defines the response structure for the 502 status code
|
|
1015
|
+
* of the GET AiConciergeConversationsByConversationIdMessages endpoint.
|
|
1016
|
+
* It provides type safety for handling this specific response as defined in the OpenAPI specification.
|
|
1017
|
+
*
|
|
1018
|
+
|
|
1019
|
+
*
|
|
1020
|
+
* @path /v1/ai-concierge/conversations/{conversation_id}/messages
|
|
1021
|
+
* @param recent (query) - If set, returns last N messages and overrides pagination.
|
|
1022
|
+
* @param exclude (query) - Comma-separated tokens to exclude (case-insensitive). Supports `tools`.
|
|
1023
|
+
*
|
|
1024
|
+
* @see {@link GET_AiConciergeConversationsByConversationIdMessages_Response} - The main response type definition
|
|
1025
|
+
* @see {@link Problem} - The actual schema type definition
|
|
1026
|
+
*/
|
|
1027
|
+
export type GET_AiConciergeConversationsByConversationIdMessages_Response_502 = Problem
|
|
1028
|
+
|
|
1029
|
+
/**
|
|
1030
|
+
* Response types for POST AiConciergeConversationsByConversationIdMessages endpoint
|
|
1031
|
+
*
|
|
1032
|
+
* Append a message to a conversation
|
|
1033
|
+
*
|
|
1034
|
+
* @remarks
|
|
1035
|
+
* This type defines all possible response structures for the POST AiConciergeConversationsByConversationIdMessages endpoint.
|
|
1036
|
+
* Each response code maps to a specific response type as defined in the OpenAPI specification.
|
|
1037
|
+
* Use this type to ensure type safety when handling API responses from this endpoint.
|
|
1038
|
+
*
|
|
1039
|
+
|
|
1040
|
+
*
|
|
1041
|
+
* @path /v1/ai-concierge/conversations/{conversation_id}/messages
|
|
1042
|
+
*
|
|
1043
|
+
* @see {@link POST_AiConciergeConversationsByConversationIdMessages_Response_201} - 201 response type
|
|
1044
|
+
* @see {@link POST_AiConciergeConversationsByConversationIdMessages_Response_401} - 401 response type
|
|
1045
|
+
* @see {@link POST_AiConciergeConversationsByConversationIdMessages_Response_404} - 404 response type
|
|
1046
|
+
* @see {@link POST_AiConciergeConversationsByConversationIdMessages_Response_422} - 422 response type
|
|
1047
|
+
* @see {@link POST_AiConciergeConversationsByConversationIdMessages_Response_502} - 502 response type
|
|
1048
|
+
*
|
|
1049
|
+
|
|
1050
|
+
*/
|
|
1051
|
+
export type POST_AiConciergeConversationsByConversationIdMessages_Response = POST_AiConciergeConversationsByConversationIdMessages_Response_201 | POST_AiConciergeConversationsByConversationIdMessages_Response_401 | POST_AiConciergeConversationsByConversationIdMessages_Response_404 | POST_AiConciergeConversationsByConversationIdMessages_Response_422 | POST_AiConciergeConversationsByConversationIdMessages_Response_502;
|
|
1052
|
+
|
|
1053
|
+
/**
|
|
1054
|
+
* 201 response for POST AiConciergeConversationsByConversationIdMessages endpoint
|
|
1055
|
+
*
|
|
1056
|
+
* @remarks
|
|
1057
|
+
* This type defines the response structure for the 201 status code
|
|
1058
|
+
* of the POST AiConciergeConversationsByConversationIdMessages endpoint.
|
|
1059
|
+
* It provides type safety for handling this specific response as defined in the OpenAPI specification.
|
|
1060
|
+
*
|
|
1061
|
+
|
|
1062
|
+
*
|
|
1063
|
+
* @path /v1/ai-concierge/conversations/{conversation_id}/messages
|
|
1064
|
+
*
|
|
1065
|
+
* @see {@link POST_AiConciergeConversationsByConversationIdMessages_Response} - The main response type definition
|
|
1066
|
+
* @see {@link Message} - The actual schema type definition
|
|
1067
|
+
*/
|
|
1068
|
+
export type POST_AiConciergeConversationsByConversationIdMessages_Response_201 = Message
|
|
1069
|
+
|
|
1070
|
+
/**
|
|
1071
|
+
* 401 response for POST AiConciergeConversationsByConversationIdMessages endpoint
|
|
1072
|
+
*
|
|
1073
|
+
* @remarks
|
|
1074
|
+
* This type defines the response structure for the 401 status code
|
|
1075
|
+
* of the POST AiConciergeConversationsByConversationIdMessages endpoint.
|
|
1076
|
+
* It provides type safety for handling this specific response as defined in the OpenAPI specification.
|
|
1077
|
+
*
|
|
1078
|
+
|
|
1079
|
+
*
|
|
1080
|
+
* @path /v1/ai-concierge/conversations/{conversation_id}/messages
|
|
1081
|
+
*
|
|
1082
|
+
* @see {@link POST_AiConciergeConversationsByConversationIdMessages_Response} - The main response type definition
|
|
1083
|
+
* @see {@link Problem} - The actual schema type definition
|
|
1084
|
+
*/
|
|
1085
|
+
export type POST_AiConciergeConversationsByConversationIdMessages_Response_401 = Problem
|
|
1086
|
+
|
|
1087
|
+
/**
|
|
1088
|
+
* 404 response for POST AiConciergeConversationsByConversationIdMessages endpoint
|
|
1089
|
+
*
|
|
1090
|
+
* @remarks
|
|
1091
|
+
* This type defines the response structure for the 404 status code
|
|
1092
|
+
* of the POST AiConciergeConversationsByConversationIdMessages endpoint.
|
|
1093
|
+
* It provides type safety for handling this specific response as defined in the OpenAPI specification.
|
|
1094
|
+
*
|
|
1095
|
+
|
|
1096
|
+
*
|
|
1097
|
+
* @path /v1/ai-concierge/conversations/{conversation_id}/messages
|
|
1098
|
+
*
|
|
1099
|
+
* @see {@link POST_AiConciergeConversationsByConversationIdMessages_Response} - The main response type definition
|
|
1100
|
+
* @see {@link Problem} - The actual schema type definition
|
|
1101
|
+
*/
|
|
1102
|
+
export type POST_AiConciergeConversationsByConversationIdMessages_Response_404 = Problem
|
|
1103
|
+
|
|
1104
|
+
/**
|
|
1105
|
+
* 422 response for POST AiConciergeConversationsByConversationIdMessages endpoint
|
|
1106
|
+
*
|
|
1107
|
+
* @remarks
|
|
1108
|
+
* This type defines the response structure for the 422 status code
|
|
1109
|
+
* of the POST AiConciergeConversationsByConversationIdMessages endpoint.
|
|
1110
|
+
* It provides type safety for handling this specific response as defined in the OpenAPI specification.
|
|
1111
|
+
*
|
|
1112
|
+
|
|
1113
|
+
*
|
|
1114
|
+
* @path /v1/ai-concierge/conversations/{conversation_id}/messages
|
|
1115
|
+
*
|
|
1116
|
+
* @see {@link POST_AiConciergeConversationsByConversationIdMessages_Response} - The main response type definition
|
|
1117
|
+
* @see {@link HTTPValidationError} - The actual schema type definition
|
|
1118
|
+
*/
|
|
1119
|
+
export type POST_AiConciergeConversationsByConversationIdMessages_Response_422 = HTTPValidationError
|
|
1120
|
+
|
|
1121
|
+
/**
|
|
1122
|
+
* 502 response for POST AiConciergeConversationsByConversationIdMessages endpoint
|
|
1123
|
+
*
|
|
1124
|
+
* @remarks
|
|
1125
|
+
* This type defines the response structure for the 502 status code
|
|
1126
|
+
* of the POST AiConciergeConversationsByConversationIdMessages endpoint.
|
|
1127
|
+
* It provides type safety for handling this specific response as defined in the OpenAPI specification.
|
|
1128
|
+
*
|
|
1129
|
+
|
|
1130
|
+
*
|
|
1131
|
+
* @path /v1/ai-concierge/conversations/{conversation_id}/messages
|
|
1132
|
+
*
|
|
1133
|
+
* @see {@link POST_AiConciergeConversationsByConversationIdMessages_Response} - The main response type definition
|
|
1134
|
+
* @see {@link Problem} - The actual schema type definition
|
|
1135
|
+
*/
|
|
1136
|
+
export type POST_AiConciergeConversationsByConversationIdMessages_Response_502 = Problem
|
|
1137
|
+
|
|
1138
|
+
/**
|
|
1139
|
+
* Response types for GET AiConciergeConversationsByConversationIdMessagesByMessageId endpoint
|
|
1140
|
+
*
|
|
1141
|
+
* Get a message
|
|
1142
|
+
*
|
|
1143
|
+
* @remarks
|
|
1144
|
+
* This type defines all possible response structures for the GET AiConciergeConversationsByConversationIdMessagesByMessageId endpoint.
|
|
1145
|
+
* Each response code maps to a specific response type as defined in the OpenAPI specification.
|
|
1146
|
+
* Use this type to ensure type safety when handling API responses from this endpoint.
|
|
1147
|
+
*
|
|
1148
|
+
|
|
1149
|
+
*
|
|
1150
|
+
* @path /v1/ai-concierge/conversations/{conversation_id}/messages/{message_id}
|
|
1151
|
+
*
|
|
1152
|
+
* @see {@link GET_AiConciergeConversationsByConversationIdMessagesByMessageId_Response_200} - 200 response type
|
|
1153
|
+
* @see {@link GET_AiConciergeConversationsByConversationIdMessagesByMessageId_Response_401} - 401 response type
|
|
1154
|
+
* @see {@link GET_AiConciergeConversationsByConversationIdMessagesByMessageId_Response_404} - 404 response type
|
|
1155
|
+
* @see {@link GET_AiConciergeConversationsByConversationIdMessagesByMessageId_Response_422} - 422 response type
|
|
1156
|
+
* @see {@link GET_AiConciergeConversationsByConversationIdMessagesByMessageId_Response_502} - 502 response type
|
|
1157
|
+
*
|
|
1158
|
+
|
|
1159
|
+
*/
|
|
1160
|
+
export type GET_AiConciergeConversationsByConversationIdMessagesByMessageId_Response = GET_AiConciergeConversationsByConversationIdMessagesByMessageId_Response_200 | GET_AiConciergeConversationsByConversationIdMessagesByMessageId_Response_401 | GET_AiConciergeConversationsByConversationIdMessagesByMessageId_Response_404 | GET_AiConciergeConversationsByConversationIdMessagesByMessageId_Response_422 | GET_AiConciergeConversationsByConversationIdMessagesByMessageId_Response_502;
|
|
1161
|
+
|
|
1162
|
+
/**
|
|
1163
|
+
* 200 response for GET AiConciergeConversationsByConversationIdMessagesByMessageId endpoint
|
|
1164
|
+
*
|
|
1165
|
+
* @remarks
|
|
1166
|
+
* This type defines the response structure for the 200 status code
|
|
1167
|
+
* of the GET AiConciergeConversationsByConversationIdMessagesByMessageId endpoint.
|
|
1168
|
+
* It provides type safety for handling this specific response as defined in the OpenAPI specification.
|
|
1169
|
+
*
|
|
1170
|
+
|
|
1171
|
+
*
|
|
1172
|
+
* @path /v1/ai-concierge/conversations/{conversation_id}/messages/{message_id}
|
|
1173
|
+
*
|
|
1174
|
+
* @see {@link GET_AiConciergeConversationsByConversationIdMessagesByMessageId_Response} - The main response type definition
|
|
1175
|
+
* @see {@link Message} - The actual schema type definition
|
|
1176
|
+
*/
|
|
1177
|
+
export type GET_AiConciergeConversationsByConversationIdMessagesByMessageId_Response_200 = Message
|
|
1178
|
+
|
|
1179
|
+
/**
|
|
1180
|
+
* 401 response for GET AiConciergeConversationsByConversationIdMessagesByMessageId endpoint
|
|
1181
|
+
*
|
|
1182
|
+
* @remarks
|
|
1183
|
+
* This type defines the response structure for the 401 status code
|
|
1184
|
+
* of the GET AiConciergeConversationsByConversationIdMessagesByMessageId endpoint.
|
|
1185
|
+
* It provides type safety for handling this specific response as defined in the OpenAPI specification.
|
|
1186
|
+
*
|
|
1187
|
+
|
|
1188
|
+
*
|
|
1189
|
+
* @path /v1/ai-concierge/conversations/{conversation_id}/messages/{message_id}
|
|
1190
|
+
*
|
|
1191
|
+
* @see {@link GET_AiConciergeConversationsByConversationIdMessagesByMessageId_Response} - The main response type definition
|
|
1192
|
+
* @see {@link Problem} - The actual schema type definition
|
|
1193
|
+
*/
|
|
1194
|
+
export type GET_AiConciergeConversationsByConversationIdMessagesByMessageId_Response_401 = Problem
|
|
1195
|
+
|
|
1196
|
+
/**
|
|
1197
|
+
* 404 response for GET AiConciergeConversationsByConversationIdMessagesByMessageId endpoint
|
|
1198
|
+
*
|
|
1199
|
+
* @remarks
|
|
1200
|
+
* This type defines the response structure for the 404 status code
|
|
1201
|
+
* of the GET AiConciergeConversationsByConversationIdMessagesByMessageId endpoint.
|
|
1202
|
+
* It provides type safety for handling this specific response as defined in the OpenAPI specification.
|
|
1203
|
+
*
|
|
1204
|
+
|
|
1205
|
+
*
|
|
1206
|
+
* @path /v1/ai-concierge/conversations/{conversation_id}/messages/{message_id}
|
|
1207
|
+
*
|
|
1208
|
+
* @see {@link GET_AiConciergeConversationsByConversationIdMessagesByMessageId_Response} - The main response type definition
|
|
1209
|
+
* @see {@link Problem} - The actual schema type definition
|
|
1210
|
+
*/
|
|
1211
|
+
export type GET_AiConciergeConversationsByConversationIdMessagesByMessageId_Response_404 = Problem
|
|
1212
|
+
|
|
1213
|
+
/**
|
|
1214
|
+
* 422 response for GET AiConciergeConversationsByConversationIdMessagesByMessageId endpoint
|
|
1215
|
+
*
|
|
1216
|
+
* @remarks
|
|
1217
|
+
* This type defines the response structure for the 422 status code
|
|
1218
|
+
* of the GET AiConciergeConversationsByConversationIdMessagesByMessageId endpoint.
|
|
1219
|
+
* It provides type safety for handling this specific response as defined in the OpenAPI specification.
|
|
1220
|
+
*
|
|
1221
|
+
|
|
1222
|
+
*
|
|
1223
|
+
* @path /v1/ai-concierge/conversations/{conversation_id}/messages/{message_id}
|
|
1224
|
+
*
|
|
1225
|
+
* @see {@link GET_AiConciergeConversationsByConversationIdMessagesByMessageId_Response} - The main response type definition
|
|
1226
|
+
* @see {@link HTTPValidationError} - The actual schema type definition
|
|
1227
|
+
*/
|
|
1228
|
+
export type GET_AiConciergeConversationsByConversationIdMessagesByMessageId_Response_422 = HTTPValidationError
|
|
1229
|
+
|
|
1230
|
+
/**
|
|
1231
|
+
* 502 response for GET AiConciergeConversationsByConversationIdMessagesByMessageId endpoint
|
|
1232
|
+
*
|
|
1233
|
+
* @remarks
|
|
1234
|
+
* This type defines the response structure for the 502 status code
|
|
1235
|
+
* of the GET AiConciergeConversationsByConversationIdMessagesByMessageId endpoint.
|
|
1236
|
+
* It provides type safety for handling this specific response as defined in the OpenAPI specification.
|
|
1237
|
+
*
|
|
1238
|
+
|
|
1239
|
+
*
|
|
1240
|
+
* @path /v1/ai-concierge/conversations/{conversation_id}/messages/{message_id}
|
|
1241
|
+
*
|
|
1242
|
+
* @see {@link GET_AiConciergeConversationsByConversationIdMessagesByMessageId_Response} - The main response type definition
|
|
1243
|
+
* @see {@link Problem} - The actual schema type definition
|
|
1244
|
+
*/
|
|
1245
|
+
export type GET_AiConciergeConversationsByConversationIdMessagesByMessageId_Response_502 = Problem
|
|
1246
|
+
|
|
1247
|
+
/**
|
|
1248
|
+
* Response types for GET AiConciergeMemoryFacts endpoint
|
|
1249
|
+
*
|
|
1250
|
+
* List long-term memory facts
|
|
1251
|
+
* List long-term, organization-scoped memory facts available to the AI Concierge.
|
|
1252
|
+
*
|
|
1253
|
+
* @remarks
|
|
1254
|
+
* This type defines all possible response structures for the GET AiConciergeMemoryFacts endpoint.
|
|
1255
|
+
* Each response code maps to a specific response type as defined in the OpenAPI specification.
|
|
1256
|
+
* Use this type to ensure type safety when handling API responses from this endpoint.
|
|
1257
|
+
*
|
|
1258
|
+
|
|
1259
|
+
*
|
|
1260
|
+
* @path /v1/ai-concierge/memory/facts
|
|
1261
|
+
*
|
|
1262
|
+
* @see {@link GET_AiConciergeMemoryFacts_Response_200} - 200 response type
|
|
1263
|
+
* @see {@link GET_AiConciergeMemoryFacts_Response_401} - 401 response type
|
|
1264
|
+
* @see {@link GET_AiConciergeMemoryFacts_Response_404} - 404 response type
|
|
1265
|
+
* @see {@link GET_AiConciergeMemoryFacts_Response_422} - 422 response type
|
|
1266
|
+
* @see {@link GET_AiConciergeMemoryFacts_Response_502} - 502 response type
|
|
1267
|
+
*
|
|
1268
|
+
|
|
1269
|
+
*/
|
|
1270
|
+
export type GET_AiConciergeMemoryFacts_Response = GET_AiConciergeMemoryFacts_Response_200 | GET_AiConciergeMemoryFacts_Response_401 | GET_AiConciergeMemoryFacts_Response_404 | GET_AiConciergeMemoryFacts_Response_422 | GET_AiConciergeMemoryFacts_Response_502;
|
|
1271
|
+
|
|
1272
|
+
/**
|
|
1273
|
+
* 200 response for GET AiConciergeMemoryFacts endpoint
|
|
1274
|
+
*
|
|
1275
|
+
* @remarks
|
|
1276
|
+
* This type defines the response structure for the 200 status code
|
|
1277
|
+
* of the GET AiConciergeMemoryFacts endpoint.
|
|
1278
|
+
* It provides type safety for handling this specific response as defined in the OpenAPI specification.
|
|
1279
|
+
*
|
|
1280
|
+
|
|
1281
|
+
*
|
|
1282
|
+
* @path /v1/ai-concierge/memory/facts
|
|
1283
|
+
*
|
|
1284
|
+
* @see {@link GET_AiConciergeMemoryFacts_Response} - The main response type definition
|
|
1285
|
+
* @see {@link MemoryFactList} - The actual schema type definition
|
|
1286
|
+
*/
|
|
1287
|
+
export type GET_AiConciergeMemoryFacts_Response_200 = MemoryFactList
|
|
1288
|
+
|
|
1289
|
+
/**
|
|
1290
|
+
* 401 response for GET AiConciergeMemoryFacts endpoint
|
|
1291
|
+
*
|
|
1292
|
+
* @remarks
|
|
1293
|
+
* This type defines the response structure for the 401 status code
|
|
1294
|
+
* of the GET AiConciergeMemoryFacts endpoint.
|
|
1295
|
+
* It provides type safety for handling this specific response as defined in the OpenAPI specification.
|
|
1296
|
+
*
|
|
1297
|
+
|
|
1298
|
+
*
|
|
1299
|
+
* @path /v1/ai-concierge/memory/facts
|
|
1300
|
+
*
|
|
1301
|
+
* @see {@link GET_AiConciergeMemoryFacts_Response} - The main response type definition
|
|
1302
|
+
* @see {@link Problem} - The actual schema type definition
|
|
1303
|
+
*/
|
|
1304
|
+
export type GET_AiConciergeMemoryFacts_Response_401 = Problem
|
|
1305
|
+
|
|
1306
|
+
/**
|
|
1307
|
+
* 404 response for GET AiConciergeMemoryFacts endpoint
|
|
1308
|
+
*
|
|
1309
|
+
* @remarks
|
|
1310
|
+
* This type defines the response structure for the 404 status code
|
|
1311
|
+
* of the GET AiConciergeMemoryFacts endpoint.
|
|
1312
|
+
* It provides type safety for handling this specific response as defined in the OpenAPI specification.
|
|
1313
|
+
*
|
|
1314
|
+
|
|
1315
|
+
*
|
|
1316
|
+
* @path /v1/ai-concierge/memory/facts
|
|
1317
|
+
*
|
|
1318
|
+
* @see {@link GET_AiConciergeMemoryFacts_Response} - The main response type definition
|
|
1319
|
+
* @see {@link Problem} - The actual schema type definition
|
|
1320
|
+
*/
|
|
1321
|
+
export type GET_AiConciergeMemoryFacts_Response_404 = Problem
|
|
1322
|
+
|
|
1323
|
+
/**
|
|
1324
|
+
* 422 response for GET AiConciergeMemoryFacts endpoint
|
|
1325
|
+
*
|
|
1326
|
+
* @remarks
|
|
1327
|
+
* This type defines the response structure for the 422 status code
|
|
1328
|
+
* of the GET AiConciergeMemoryFacts endpoint.
|
|
1329
|
+
* It provides type safety for handling this specific response as defined in the OpenAPI specification.
|
|
1330
|
+
*
|
|
1331
|
+
|
|
1332
|
+
*
|
|
1333
|
+
* @path /v1/ai-concierge/memory/facts
|
|
1334
|
+
*
|
|
1335
|
+
* @see {@link GET_AiConciergeMemoryFacts_Response} - The main response type definition
|
|
1336
|
+
* @see {@link HTTPValidationError} - The actual schema type definition
|
|
1337
|
+
*/
|
|
1338
|
+
export type GET_AiConciergeMemoryFacts_Response_422 = HTTPValidationError
|
|
1339
|
+
|
|
1340
|
+
/**
|
|
1341
|
+
* 502 response for GET AiConciergeMemoryFacts endpoint
|
|
1342
|
+
*
|
|
1343
|
+
* @remarks
|
|
1344
|
+
* This type defines the response structure for the 502 status code
|
|
1345
|
+
* of the GET AiConciergeMemoryFacts endpoint.
|
|
1346
|
+
* It provides type safety for handling this specific response as defined in the OpenAPI specification.
|
|
1347
|
+
*
|
|
1348
|
+
|
|
1349
|
+
*
|
|
1350
|
+
* @path /v1/ai-concierge/memory/facts
|
|
1351
|
+
*
|
|
1352
|
+
* @see {@link GET_AiConciergeMemoryFacts_Response} - The main response type definition
|
|
1353
|
+
* @see {@link Problem} - The actual schema type definition
|
|
1354
|
+
*/
|
|
1355
|
+
export type GET_AiConciergeMemoryFacts_Response_502 = Problem
|
|
1356
|
+
|
|
1357
|
+
/**
|
|
1358
|
+
* Response types for POST AiConciergeMemoryFacts endpoint
|
|
1359
|
+
*
|
|
1360
|
+
* Create a long-term memory fact
|
|
1361
|
+
*
|
|
1362
|
+
* @remarks
|
|
1363
|
+
* This type defines all possible response structures for the POST AiConciergeMemoryFacts endpoint.
|
|
1364
|
+
* Each response code maps to a specific response type as defined in the OpenAPI specification.
|
|
1365
|
+
* Use this type to ensure type safety when handling API responses from this endpoint.
|
|
1366
|
+
*
|
|
1367
|
+
|
|
1368
|
+
*
|
|
1369
|
+
* @path /v1/ai-concierge/memory/facts
|
|
1370
|
+
*
|
|
1371
|
+
* @see {@link POST_AiConciergeMemoryFacts_Response_201} - 201 response type
|
|
1372
|
+
* @see {@link POST_AiConciergeMemoryFacts_Response_401} - 401 response type
|
|
1373
|
+
* @see {@link POST_AiConciergeMemoryFacts_Response_404} - 404 response type
|
|
1374
|
+
* @see {@link POST_AiConciergeMemoryFacts_Response_422} - 422 response type
|
|
1375
|
+
* @see {@link POST_AiConciergeMemoryFacts_Response_502} - 502 response type
|
|
1376
|
+
*
|
|
1377
|
+
|
|
1378
|
+
*/
|
|
1379
|
+
export type POST_AiConciergeMemoryFacts_Response = POST_AiConciergeMemoryFacts_Response_201 | POST_AiConciergeMemoryFacts_Response_401 | POST_AiConciergeMemoryFacts_Response_404 | POST_AiConciergeMemoryFacts_Response_422 | POST_AiConciergeMemoryFacts_Response_502;
|
|
1380
|
+
|
|
1381
|
+
/**
|
|
1382
|
+
* 201 response for POST AiConciergeMemoryFacts endpoint
|
|
1383
|
+
*
|
|
1384
|
+
* @remarks
|
|
1385
|
+
* This type defines the response structure for the 201 status code
|
|
1386
|
+
* of the POST AiConciergeMemoryFacts endpoint.
|
|
1387
|
+
* It provides type safety for handling this specific response as defined in the OpenAPI specification.
|
|
1388
|
+
*
|
|
1389
|
+
|
|
1390
|
+
*
|
|
1391
|
+
* @path /v1/ai-concierge/memory/facts
|
|
1392
|
+
*
|
|
1393
|
+
* @see {@link POST_AiConciergeMemoryFacts_Response} - The main response type definition
|
|
1394
|
+
* @see {@link MemoryFact} - The actual schema type definition
|
|
1395
|
+
*/
|
|
1396
|
+
export type POST_AiConciergeMemoryFacts_Response_201 = MemoryFact
|
|
1397
|
+
|
|
1398
|
+
/**
|
|
1399
|
+
* 401 response for POST AiConciergeMemoryFacts endpoint
|
|
1400
|
+
*
|
|
1401
|
+
* @remarks
|
|
1402
|
+
* This type defines the response structure for the 401 status code
|
|
1403
|
+
* of the POST AiConciergeMemoryFacts endpoint.
|
|
1404
|
+
* It provides type safety for handling this specific response as defined in the OpenAPI specification.
|
|
1405
|
+
*
|
|
1406
|
+
|
|
1407
|
+
*
|
|
1408
|
+
* @path /v1/ai-concierge/memory/facts
|
|
1409
|
+
*
|
|
1410
|
+
* @see {@link POST_AiConciergeMemoryFacts_Response} - The main response type definition
|
|
1411
|
+
* @see {@link Problem} - The actual schema type definition
|
|
1412
|
+
*/
|
|
1413
|
+
export type POST_AiConciergeMemoryFacts_Response_401 = Problem
|
|
1414
|
+
|
|
1415
|
+
/**
|
|
1416
|
+
* 404 response for POST AiConciergeMemoryFacts endpoint
|
|
1417
|
+
*
|
|
1418
|
+
* @remarks
|
|
1419
|
+
* This type defines the response structure for the 404 status code
|
|
1420
|
+
* of the POST AiConciergeMemoryFacts endpoint.
|
|
1421
|
+
* It provides type safety for handling this specific response as defined in the OpenAPI specification.
|
|
1422
|
+
*
|
|
1423
|
+
|
|
1424
|
+
*
|
|
1425
|
+
* @path /v1/ai-concierge/memory/facts
|
|
1426
|
+
*
|
|
1427
|
+
* @see {@link POST_AiConciergeMemoryFacts_Response} - The main response type definition
|
|
1428
|
+
* @see {@link Problem} - The actual schema type definition
|
|
1429
|
+
*/
|
|
1430
|
+
export type POST_AiConciergeMemoryFacts_Response_404 = Problem
|
|
1431
|
+
|
|
1432
|
+
/**
|
|
1433
|
+
* 422 response for POST AiConciergeMemoryFacts endpoint
|
|
1434
|
+
*
|
|
1435
|
+
* @remarks
|
|
1436
|
+
* This type defines the response structure for the 422 status code
|
|
1437
|
+
* of the POST AiConciergeMemoryFacts endpoint.
|
|
1438
|
+
* It provides type safety for handling this specific response as defined in the OpenAPI specification.
|
|
1439
|
+
*
|
|
1440
|
+
|
|
1441
|
+
*
|
|
1442
|
+
* @path /v1/ai-concierge/memory/facts
|
|
1443
|
+
*
|
|
1444
|
+
* @see {@link POST_AiConciergeMemoryFacts_Response} - The main response type definition
|
|
1445
|
+
* @see {@link HTTPValidationError} - The actual schema type definition
|
|
1446
|
+
*/
|
|
1447
|
+
export type POST_AiConciergeMemoryFacts_Response_422 = HTTPValidationError
|
|
1448
|
+
|
|
1449
|
+
/**
|
|
1450
|
+
* 502 response for POST AiConciergeMemoryFacts endpoint
|
|
1451
|
+
*
|
|
1452
|
+
* @remarks
|
|
1453
|
+
* This type defines the response structure for the 502 status code
|
|
1454
|
+
* of the POST AiConciergeMemoryFacts endpoint.
|
|
1455
|
+
* It provides type safety for handling this specific response as defined in the OpenAPI specification.
|
|
1456
|
+
*
|
|
1457
|
+
|
|
1458
|
+
*
|
|
1459
|
+
* @path /v1/ai-concierge/memory/facts
|
|
1460
|
+
*
|
|
1461
|
+
* @see {@link POST_AiConciergeMemoryFacts_Response} - The main response type definition
|
|
1462
|
+
* @see {@link Problem} - The actual schema type definition
|
|
1463
|
+
*/
|
|
1464
|
+
export type POST_AiConciergeMemoryFacts_Response_502 = Problem
|
|
1465
|
+
|
|
1466
|
+
/**
|
|
1467
|
+
* Response types for DELETE AiConciergeMemoryFactsByFactId endpoint
|
|
1468
|
+
*
|
|
1469
|
+
* Delete a long-term memory fact
|
|
1470
|
+
*
|
|
1471
|
+
* @remarks
|
|
1472
|
+
* This type defines all possible response structures for the DELETE AiConciergeMemoryFactsByFactId endpoint.
|
|
1473
|
+
* Each response code maps to a specific response type as defined in the OpenAPI specification.
|
|
1474
|
+
* Use this type to ensure type safety when handling API responses from this endpoint.
|
|
1475
|
+
*
|
|
1476
|
+
|
|
1477
|
+
*
|
|
1478
|
+
* @path /v1/ai-concierge/memory/facts/{fact_id}
|
|
1479
|
+
*
|
|
1480
|
+
* @see {@link DELETE_AiConciergeMemoryFactsByFactId_Response_401} - 401 response type
|
|
1481
|
+
* @see {@link DELETE_AiConciergeMemoryFactsByFactId_Response_404} - 404 response type
|
|
1482
|
+
* @see {@link DELETE_AiConciergeMemoryFactsByFactId_Response_422} - 422 response type
|
|
1483
|
+
* @see {@link DELETE_AiConciergeMemoryFactsByFactId_Response_502} - 502 response type
|
|
1484
|
+
*
|
|
1485
|
+
|
|
1486
|
+
*/
|
|
1487
|
+
export type DELETE_AiConciergeMemoryFactsByFactId_Response = DELETE_AiConciergeMemoryFactsByFactId_Response_401 | DELETE_AiConciergeMemoryFactsByFactId_Response_404 | DELETE_AiConciergeMemoryFactsByFactId_Response_422 | DELETE_AiConciergeMemoryFactsByFactId_Response_502;
|
|
1488
|
+
|
|
1489
|
+
/**
|
|
1490
|
+
* 401 response for DELETE AiConciergeMemoryFactsByFactId endpoint
|
|
1491
|
+
*
|
|
1492
|
+
* @remarks
|
|
1493
|
+
* This type defines the response structure for the 401 status code
|
|
1494
|
+
* of the DELETE AiConciergeMemoryFactsByFactId endpoint.
|
|
1495
|
+
* It provides type safety for handling this specific response as defined in the OpenAPI specification.
|
|
1496
|
+
*
|
|
1497
|
+
|
|
1498
|
+
*
|
|
1499
|
+
* @path /v1/ai-concierge/memory/facts/{fact_id}
|
|
1500
|
+
*
|
|
1501
|
+
* @see {@link DELETE_AiConciergeMemoryFactsByFactId_Response} - The main response type definition
|
|
1502
|
+
* @see {@link Problem} - The actual schema type definition
|
|
1503
|
+
*/
|
|
1504
|
+
export type DELETE_AiConciergeMemoryFactsByFactId_Response_401 = Problem
|
|
1505
|
+
|
|
1506
|
+
/**
|
|
1507
|
+
* 404 response for DELETE AiConciergeMemoryFactsByFactId endpoint
|
|
1508
|
+
*
|
|
1509
|
+
* @remarks
|
|
1510
|
+
* This type defines the response structure for the 404 status code
|
|
1511
|
+
* of the DELETE AiConciergeMemoryFactsByFactId endpoint.
|
|
1512
|
+
* It provides type safety for handling this specific response as defined in the OpenAPI specification.
|
|
1513
|
+
*
|
|
1514
|
+
|
|
1515
|
+
*
|
|
1516
|
+
* @path /v1/ai-concierge/memory/facts/{fact_id}
|
|
1517
|
+
*
|
|
1518
|
+
* @see {@link DELETE_AiConciergeMemoryFactsByFactId_Response} - The main response type definition
|
|
1519
|
+
* @see {@link Problem} - The actual schema type definition
|
|
1520
|
+
*/
|
|
1521
|
+
export type DELETE_AiConciergeMemoryFactsByFactId_Response_404 = Problem
|
|
1522
|
+
|
|
1523
|
+
/**
|
|
1524
|
+
* 422 response for DELETE AiConciergeMemoryFactsByFactId endpoint
|
|
1525
|
+
*
|
|
1526
|
+
* @remarks
|
|
1527
|
+
* This type defines the response structure for the 422 status code
|
|
1528
|
+
* of the DELETE AiConciergeMemoryFactsByFactId endpoint.
|
|
1529
|
+
* It provides type safety for handling this specific response as defined in the OpenAPI specification.
|
|
1530
|
+
*
|
|
1531
|
+
|
|
1532
|
+
*
|
|
1533
|
+
* @path /v1/ai-concierge/memory/facts/{fact_id}
|
|
1534
|
+
*
|
|
1535
|
+
* @see {@link DELETE_AiConciergeMemoryFactsByFactId_Response} - The main response type definition
|
|
1536
|
+
* @see {@link HTTPValidationError} - The actual schema type definition
|
|
1537
|
+
*/
|
|
1538
|
+
export type DELETE_AiConciergeMemoryFactsByFactId_Response_422 = HTTPValidationError
|
|
1539
|
+
|
|
1540
|
+
/**
|
|
1541
|
+
* 502 response for DELETE AiConciergeMemoryFactsByFactId endpoint
|
|
1542
|
+
*
|
|
1543
|
+
* @remarks
|
|
1544
|
+
* This type defines the response structure for the 502 status code
|
|
1545
|
+
* of the DELETE AiConciergeMemoryFactsByFactId endpoint.
|
|
1546
|
+
* It provides type safety for handling this specific response as defined in the OpenAPI specification.
|
|
1547
|
+
*
|
|
1548
|
+
|
|
1549
|
+
*
|
|
1550
|
+
* @path /v1/ai-concierge/memory/facts/{fact_id}
|
|
1551
|
+
*
|
|
1552
|
+
* @see {@link DELETE_AiConciergeMemoryFactsByFactId_Response} - The main response type definition
|
|
1553
|
+
* @see {@link Problem} - The actual schema type definition
|
|
1554
|
+
*/
|
|
1555
|
+
export type DELETE_AiConciergeMemoryFactsByFactId_Response_502 = Problem
|
|
1556
|
+
|
|
1557
|
+
/**
|
|
1558
|
+
* Response types for PATCH AiConciergeMemoryFactsByFactId endpoint
|
|
1559
|
+
*
|
|
1560
|
+
* Update a long-term memory fact
|
|
1561
|
+
*
|
|
1562
|
+
* @remarks
|
|
1563
|
+
* This type defines all possible response structures for the PATCH AiConciergeMemoryFactsByFactId endpoint.
|
|
1564
|
+
* Each response code maps to a specific response type as defined in the OpenAPI specification.
|
|
1565
|
+
* Use this type to ensure type safety when handling API responses from this endpoint.
|
|
1566
|
+
*
|
|
1567
|
+
|
|
1568
|
+
*
|
|
1569
|
+
* @path /v1/ai-concierge/memory/facts/{fact_id}
|
|
1570
|
+
*
|
|
1571
|
+
* @see {@link PATCH_AiConciergeMemoryFactsByFactId_Response_200} - 200 response type
|
|
1572
|
+
* @see {@link PATCH_AiConciergeMemoryFactsByFactId_Response_401} - 401 response type
|
|
1573
|
+
* @see {@link PATCH_AiConciergeMemoryFactsByFactId_Response_404} - 404 response type
|
|
1574
|
+
* @see {@link PATCH_AiConciergeMemoryFactsByFactId_Response_422} - 422 response type
|
|
1575
|
+
* @see {@link PATCH_AiConciergeMemoryFactsByFactId_Response_502} - 502 response type
|
|
1576
|
+
*
|
|
1577
|
+
|
|
1578
|
+
*/
|
|
1579
|
+
export type PATCH_AiConciergeMemoryFactsByFactId_Response = PATCH_AiConciergeMemoryFactsByFactId_Response_200 | PATCH_AiConciergeMemoryFactsByFactId_Response_401 | PATCH_AiConciergeMemoryFactsByFactId_Response_404 | PATCH_AiConciergeMemoryFactsByFactId_Response_422 | PATCH_AiConciergeMemoryFactsByFactId_Response_502;
|
|
1580
|
+
|
|
1581
|
+
/**
|
|
1582
|
+
* 200 response for PATCH AiConciergeMemoryFactsByFactId endpoint
|
|
1583
|
+
*
|
|
1584
|
+
* @remarks
|
|
1585
|
+
* This type defines the response structure for the 200 status code
|
|
1586
|
+
* of the PATCH AiConciergeMemoryFactsByFactId endpoint.
|
|
1587
|
+
* It provides type safety for handling this specific response as defined in the OpenAPI specification.
|
|
1588
|
+
*
|
|
1589
|
+
|
|
1590
|
+
*
|
|
1591
|
+
* @path /v1/ai-concierge/memory/facts/{fact_id}
|
|
1592
|
+
*
|
|
1593
|
+
* @see {@link PATCH_AiConciergeMemoryFactsByFactId_Response} - The main response type definition
|
|
1594
|
+
* @see {@link MemoryFact} - The actual schema type definition
|
|
1595
|
+
*/
|
|
1596
|
+
export type PATCH_AiConciergeMemoryFactsByFactId_Response_200 = MemoryFact
|
|
1597
|
+
|
|
1598
|
+
/**
|
|
1599
|
+
* 401 response for PATCH AiConciergeMemoryFactsByFactId endpoint
|
|
1600
|
+
*
|
|
1601
|
+
* @remarks
|
|
1602
|
+
* This type defines the response structure for the 401 status code
|
|
1603
|
+
* of the PATCH AiConciergeMemoryFactsByFactId endpoint.
|
|
1604
|
+
* It provides type safety for handling this specific response as defined in the OpenAPI specification.
|
|
1605
|
+
*
|
|
1606
|
+
|
|
1607
|
+
*
|
|
1608
|
+
* @path /v1/ai-concierge/memory/facts/{fact_id}
|
|
1609
|
+
*
|
|
1610
|
+
* @see {@link PATCH_AiConciergeMemoryFactsByFactId_Response} - The main response type definition
|
|
1611
|
+
* @see {@link Problem} - The actual schema type definition
|
|
1612
|
+
*/
|
|
1613
|
+
export type PATCH_AiConciergeMemoryFactsByFactId_Response_401 = Problem
|
|
1614
|
+
|
|
1615
|
+
/**
|
|
1616
|
+
* 404 response for PATCH AiConciergeMemoryFactsByFactId endpoint
|
|
1617
|
+
*
|
|
1618
|
+
* @remarks
|
|
1619
|
+
* This type defines the response structure for the 404 status code
|
|
1620
|
+
* of the PATCH AiConciergeMemoryFactsByFactId endpoint.
|
|
1621
|
+
* It provides type safety for handling this specific response as defined in the OpenAPI specification.
|
|
1622
|
+
*
|
|
1623
|
+
|
|
1624
|
+
*
|
|
1625
|
+
* @path /v1/ai-concierge/memory/facts/{fact_id}
|
|
1626
|
+
*
|
|
1627
|
+
* @see {@link PATCH_AiConciergeMemoryFactsByFactId_Response} - The main response type definition
|
|
1628
|
+
* @see {@link Problem} - The actual schema type definition
|
|
1629
|
+
*/
|
|
1630
|
+
export type PATCH_AiConciergeMemoryFactsByFactId_Response_404 = Problem
|
|
1631
|
+
|
|
1632
|
+
/**
|
|
1633
|
+
* 422 response for PATCH AiConciergeMemoryFactsByFactId endpoint
|
|
1634
|
+
*
|
|
1635
|
+
* @remarks
|
|
1636
|
+
* This type defines the response structure for the 422 status code
|
|
1637
|
+
* of the PATCH AiConciergeMemoryFactsByFactId endpoint.
|
|
1638
|
+
* It provides type safety for handling this specific response as defined in the OpenAPI specification.
|
|
1639
|
+
*
|
|
1640
|
+
|
|
1641
|
+
*
|
|
1642
|
+
* @path /v1/ai-concierge/memory/facts/{fact_id}
|
|
1643
|
+
*
|
|
1644
|
+
* @see {@link PATCH_AiConciergeMemoryFactsByFactId_Response} - The main response type definition
|
|
1645
|
+
* @see {@link HTTPValidationError} - The actual schema type definition
|
|
1646
|
+
*/
|
|
1647
|
+
export type PATCH_AiConciergeMemoryFactsByFactId_Response_422 = HTTPValidationError
|
|
1648
|
+
|
|
1649
|
+
/**
|
|
1650
|
+
* 502 response for PATCH AiConciergeMemoryFactsByFactId endpoint
|
|
1651
|
+
*
|
|
1652
|
+
* @remarks
|
|
1653
|
+
* This type defines the response structure for the 502 status code
|
|
1654
|
+
* of the PATCH AiConciergeMemoryFactsByFactId endpoint.
|
|
1655
|
+
* It provides type safety for handling this specific response as defined in the OpenAPI specification.
|
|
1656
|
+
*
|
|
1657
|
+
|
|
1658
|
+
*
|
|
1659
|
+
* @path /v1/ai-concierge/memory/facts/{fact_id}
|
|
1660
|
+
*
|
|
1661
|
+
* @see {@link PATCH_AiConciergeMemoryFactsByFactId_Response} - The main response type definition
|
|
1662
|
+
* @see {@link Problem} - The actual schema type definition
|
|
1663
|
+
*/
|
|
1664
|
+
export type PATCH_AiConciergeMemoryFactsByFactId_Response_502 = Problem
|
|
38
1665
|
|
|
39
1666
|
/**
|
|
40
1667
|
* Response types for GET ArchiveEmailForwardLogsAliasesByEmailForwardAliasId endpoint
|
|
@@ -5970,7 +7597,15 @@ export type DELETE_DomainsByDomainReferenceTransfer_Response_422 = HTTPValidatio
|
|
|
5970
7597
|
/**
|
|
5971
7598
|
* Response types for GET DomainsCheck endpoint
|
|
5972
7599
|
*
|
|
5973
|
-
* Check domain availability
|
|
7600
|
+
* Check domain availability and registration metadata
|
|
7601
|
+
* Performs a real-time check against the authoritative registry for each domain and returns availability plus any registry-specific metadata needed to register it.
|
|
7602
|
+
|
|
7603
|
+
For each domain the response includes:
|
|
7604
|
+
- **Availability** — whether the domain can be registered, and the registry's reason if not.
|
|
7605
|
+
- **Trademark claims (TMCH)** — when the TLD is in its claims phase and the domain matches a trademark in the Trademark Clearinghouse, a `claims_key` is returned. The corresponding claims notice must be retrieved and acknowledged before the domain can be registered. See the [Trademarked domains](/products/domains/trademarked-domains) guide for the full workflow.
|
|
7606
|
+
- **Premium status and pricing** — whether the domain is classified as premium by the registry, and if so, the price per action (create / renew / transfer / restore). See the [Premium domains](/products/domains/premium) guide for background on how premium domains are priced and registered.
|
|
7607
|
+
|
|
7608
|
+
Domains are queried in parallel, grouped by registry connection. Availability and metadata reflect the registry's state at the moment of the call and are not cached.
|
|
5974
7609
|
*
|
|
5975
7610
|
* @remarks
|
|
5976
7611
|
* This type defines all possible response structures for the GET DomainsCheck endpoint.
|
|
@@ -5981,7 +7616,11 @@ export type DELETE_DomainsByDomainReferenceTransfer_Response_422 = HTTPValidatio
|
|
|
5981
7616
|
*
|
|
5982
7617
|
* @path /v1/domains/check
|
|
5983
7618
|
* @param domains (query) -
|
|
5984
|
-
|
|
7619
|
+
One or more fully-qualified domain names to check at the registry.
|
|
7620
|
+
|
|
7621
|
+
Each domain is checked for availability and, when applicable, enriched with
|
|
7622
|
+
trademark claims information and premium pricing. The list of domains may
|
|
7623
|
+
include a mix of TLDs.
|
|
5985
7624
|
|
|
5986
7625
|
*
|
|
5987
7626
|
* @see {@link GET_DomainsCheck_Response_200} - 200 response type
|
|
@@ -6003,7 +7642,11 @@ export type GET_DomainsCheck_Response = GET_DomainsCheck_Response_200 | GET_Doma
|
|
|
6003
7642
|
*
|
|
6004
7643
|
* @path /v1/domains/check
|
|
6005
7644
|
* @param domains (query) -
|
|
6006
|
-
|
|
7645
|
+
One or more fully-qualified domain names to check at the registry.
|
|
7646
|
+
|
|
7647
|
+
Each domain is checked for availability and, when applicable, enriched with
|
|
7648
|
+
trademark claims information and premium pricing. The list of domains may
|
|
7649
|
+
include a mix of TLDs.
|
|
6007
7650
|
|
|
6008
7651
|
*
|
|
6009
7652
|
* @see {@link GET_DomainsCheck_Response} - The main response type definition
|
|
@@ -6023,7 +7666,11 @@ export type GET_DomainsCheck_Response_200 = DomainCheck
|
|
|
6023
7666
|
*
|
|
6024
7667
|
* @path /v1/domains/check
|
|
6025
7668
|
* @param domains (query) -
|
|
6026
|
-
|
|
7669
|
+
One or more fully-qualified domain names to check at the registry.
|
|
7670
|
+
|
|
7671
|
+
Each domain is checked for availability and, when applicable, enriched with
|
|
7672
|
+
trademark claims information and premium pricing. The list of domains may
|
|
7673
|
+
include a mix of TLDs.
|
|
6027
7674
|
|
|
6028
7675
|
*
|
|
6029
7676
|
* @see {@link GET_DomainsCheck_Response} - The main response type definition
|