@opusdns/api 0.281.0 → 0.283.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 +10441 -8676
- package/src/helpers/requests.d.ts +663 -1
- package/src/helpers/responses.d.ts +1647 -2
- package/src/helpers/schemas-arrays.d.ts +57 -1
- package/src/helpers/schemas.d.ts +272 -0
- package/src/openapi.yaml +1635 -27
- package/src/schema.d.ts +1660 -23
|
@@ -34,7 +34,669 @@ import { operations } from '../schema';
|
|
|
34
34
|
|
|
35
35
|
import { DomainDnssecDataCreateArray, OrganizationAttributeUpdateArray } from './schemas-arrays.d';
|
|
36
36
|
|
|
37
|
-
import { PublicAuthRequestForm, DomainAvailabilityRequest, ContactCreate, ContactAttributeSetCreate, ContactAttributeSetUpdate, DnsZoneCreate, DnsZoneRecordsPatchOps, DnsZoneRrsetsPatchOps, DnsZoneRrsetsCreate, DomainForwardPatchOps, DomainForwardCreateRequest, DomainForwardSetCreateRequest, DomainForwardSetRequest, DomainCreate, DomainUpdate, DomainRenewRequest, DomainRestoreRequest, DomainWithdrawRequest, DomainTransitRequest, DomainTransferIn, EmailForwardCreate, EmailForwardAliasCreate, EmailForwardAliasUpdate, JobBatchRequest, OrganizationCreate, IpRestrictionCreate, IpRestrictionUpdate, OrganizationUpdate, ParkingSignupRequest, TagCreate, BulkObjectTagChanges, TagUpdate, ObjectTagChanges, UserCreate, PasswordUpdate, UserUpdate, SpiceDbRelationshipUpdate } from './schemas.d';
|
|
37
|
+
import { ConversationCreateRequest, ConversationPatchRequest, ContextCreateRequest, MessageCreateRequest, MemoryFactCreateRequest, MemoryFactPatchRequest, PublicAuthRequestForm, DomainAvailabilityRequest, ContactCreate, ContactAttributeSetCreate, ContactAttributeSetUpdate, DnsZoneCreate, DnsZoneRecordsPatchOps, DnsZoneRrsetsPatchOps, DnsZoneRrsetsCreate, DomainForwardPatchOps, DomainForwardCreateRequest, DomainForwardSetCreateRequest, DomainForwardSetRequest, DomainCreate, DomainUpdate, DomainRenewRequest, DomainRestoreRequest, DomainWithdrawRequest, DomainTransitRequest, DomainTransferIn, EmailForwardCreate, EmailForwardAliasCreate, EmailForwardAliasUpdate, JobBatchRequest, OrganizationCreate, IpRestrictionCreate, IpRestrictionUpdate, OrganizationUpdate, ParkingSignupRequest, TagCreate, BulkObjectTagChanges, TagUpdate, ObjectTagChanges, UserCreate, PasswordUpdate, UserUpdate, SpiceDbRelationshipUpdate } from './schemas.d';
|
|
38
|
+
|
|
39
|
+
/**
|
|
40
|
+
* Request type for GET AiConciergeContextsContextId endpoint
|
|
41
|
+
*
|
|
42
|
+
* Get a context entry
|
|
43
|
+
*
|
|
44
|
+
* @remarks
|
|
45
|
+
* This type defines the complete request structure for the GET AiConciergeContextsContextId endpoint.
|
|
46
|
+
* It includes all parameters (query, path) and request body types as defined in the OpenAPI specification.
|
|
47
|
+
* Use this type to ensure type safety when making API requests to this endpoint.
|
|
48
|
+
*
|
|
49
|
+
* @example
|
|
50
|
+
* Use this type to ensure type safety when making API requests to this endpoint.
|
|
51
|
+
*
|
|
52
|
+
* @path /v1/ai-concierge/contexts/{context_id}
|
|
53
|
+
*
|
|
54
|
+
* @see {@link GET_AiConciergeContextsContextId_Request_Query} - Query parameters type
|
|
55
|
+
* @see {@link GET_AiConciergeContextsContextId_Request_Path} - Path parameters type
|
|
56
|
+
* @see {@link GET_AiConciergeContextsContextId_Request_Body} - Request body type
|
|
57
|
+
*/
|
|
58
|
+
export type GET_AiConciergeContextsContextId_Request = {
|
|
59
|
+
parameters: {
|
|
60
|
+
path: operations['get_context_v1_ai_concierge_contexts__context_id__get']['parameters']['path'];
|
|
61
|
+
};
|
|
62
|
+
}
|
|
63
|
+
/**
|
|
64
|
+
* Path parameters for GET /v1/ai-concierge/contexts/{context_id}
|
|
65
|
+
*
|
|
66
|
+
* @remarks
|
|
67
|
+
* This type defines the path parameters for the GET /v1/ai-concierge/contexts/{context_id} endpoint.
|
|
68
|
+
* It provides type safety for all path parameters as defined in the OpenAPI specification.
|
|
69
|
+
*
|
|
70
|
+
* @example
|
|
71
|
+
* Use this type to ensure type safety for path parameters.
|
|
72
|
+
*
|
|
73
|
+
* @path /v1/ai-concierge/contexts/{context_id}
|
|
74
|
+
*/
|
|
75
|
+
export type GET_AiConciergeContextsContextId_Request_Path = GET_AiConciergeContextsContextId_Request['parameters']['path'];
|
|
76
|
+
|
|
77
|
+
/**
|
|
78
|
+
* Request type for GET AiConciergeConversations endpoint
|
|
79
|
+
*
|
|
80
|
+
* List AI Concierge conversations
|
|
81
|
+
* List the authenticated organization's AI Concierge conversations.
|
|
82
|
+
*
|
|
83
|
+
* @remarks
|
|
84
|
+
* This type defines the complete request structure for the GET AiConciergeConversations endpoint.
|
|
85
|
+
* It includes all parameters (query, path) and request body types as defined in the OpenAPI specification.
|
|
86
|
+
* Use this type to ensure type safety when making API requests to this endpoint.
|
|
87
|
+
*
|
|
88
|
+
* @example
|
|
89
|
+
* Use this type to ensure type safety when making API requests to this endpoint.
|
|
90
|
+
*
|
|
91
|
+
* @path /v1/ai-concierge/conversations
|
|
92
|
+
* @param sort (query) - Comma-separated sort fields. Prefix with `-` for DESC.
|
|
93
|
+
* @param q (query) - Full-text search on title/summary.
|
|
94
|
+
*
|
|
95
|
+
* @see {@link GET_AiConciergeConversations_Request_Query} - Query parameters type
|
|
96
|
+
* @see {@link GET_AiConciergeConversations_Request_Path} - Path parameters type
|
|
97
|
+
* @see {@link GET_AiConciergeConversations_Request_Body} - Request body type
|
|
98
|
+
*/
|
|
99
|
+
export type GET_AiConciergeConversations_Request = {
|
|
100
|
+
parameters: {
|
|
101
|
+
query: operations['list_conversations_v1_ai_concierge_conversations_get']['parameters']['query'];
|
|
102
|
+
};
|
|
103
|
+
}
|
|
104
|
+
/**
|
|
105
|
+
* Query parameters for GET /v1/ai-concierge/conversations
|
|
106
|
+
*
|
|
107
|
+
* @remarks
|
|
108
|
+
* This type defines the query parameters for the GET /v1/ai-concierge/conversations endpoint.
|
|
109
|
+
* It provides type safety for all query parameters as defined in the OpenAPI specification.
|
|
110
|
+
*
|
|
111
|
+
* @example
|
|
112
|
+
* Use this type to ensure type safety for query parameters.
|
|
113
|
+
*
|
|
114
|
+
* @path /v1/ai-concierge/conversations
|
|
115
|
+
* @param sort (query) - Comma-separated sort fields. Prefix with `-` for DESC.
|
|
116
|
+
* @param q (query) - Full-text search on title/summary.
|
|
117
|
+
*/
|
|
118
|
+
export type GET_AiConciergeConversations_Request_Query = GET_AiConciergeConversations_Request['parameters']['query'];
|
|
119
|
+
|
|
120
|
+
/**
|
|
121
|
+
* Request type for POST AiConciergeConversations endpoint
|
|
122
|
+
*
|
|
123
|
+
* Create an AI Concierge conversation
|
|
124
|
+
*
|
|
125
|
+
* @remarks
|
|
126
|
+
* This type defines the complete request structure for the POST AiConciergeConversations endpoint.
|
|
127
|
+
* It includes all parameters (query, path) and request body types as defined in the OpenAPI specification.
|
|
128
|
+
* Use this type to ensure type safety when making API requests to this endpoint.
|
|
129
|
+
*
|
|
130
|
+
* @example
|
|
131
|
+
* Use this type to ensure type safety when making API requests to this endpoint.
|
|
132
|
+
*
|
|
133
|
+
* @path /v1/ai-concierge/conversations
|
|
134
|
+
*
|
|
135
|
+
* @see {@link POST_AiConciergeConversations_Request_Query} - Query parameters type
|
|
136
|
+
* @see {@link POST_AiConciergeConversations_Request_Path} - Path parameters type
|
|
137
|
+
* @see {@link POST_AiConciergeConversations_Request_Body} - Request body type
|
|
138
|
+
*/
|
|
139
|
+
export type POST_AiConciergeConversations_Request = {
|
|
140
|
+
requestBody: ConversationCreateRequest;
|
|
141
|
+
}
|
|
142
|
+
/**
|
|
143
|
+
* Request body for POST /v1/ai-concierge/conversations
|
|
144
|
+
*
|
|
145
|
+
* @remarks
|
|
146
|
+
* This type defines the request body structure for the POST /v1/ai-concierge/conversations endpoint.
|
|
147
|
+
* It provides type safety for the request body as defined in the OpenAPI specification.
|
|
148
|
+
*
|
|
149
|
+
* @example
|
|
150
|
+
* Use this type to ensure type safety for request body structure.
|
|
151
|
+
*
|
|
152
|
+
* @path /v1/ai-concierge/conversations
|
|
153
|
+
*/
|
|
154
|
+
export type POST_AiConciergeConversations_Request_Body = POST_AiConciergeConversations_Request['requestBody'];
|
|
155
|
+
|
|
156
|
+
/**
|
|
157
|
+
* Request type for DELETE AiConciergeConversationsConversationId endpoint
|
|
158
|
+
*
|
|
159
|
+
* Delete a conversation
|
|
160
|
+
* Permanently delete a conversation, its messages, and any attached contexts.
|
|
161
|
+
*
|
|
162
|
+
* @remarks
|
|
163
|
+
* This type defines the complete request structure for the DELETE AiConciergeConversationsConversationId endpoint.
|
|
164
|
+
* It includes all parameters (query, path) and request body types as defined in the OpenAPI specification.
|
|
165
|
+
* Use this type to ensure type safety when making API requests to this endpoint.
|
|
166
|
+
*
|
|
167
|
+
* @example
|
|
168
|
+
* Use this type to ensure type safety when making API requests to this endpoint.
|
|
169
|
+
*
|
|
170
|
+
* @path /v1/ai-concierge/conversations/{conversation_id}
|
|
171
|
+
*
|
|
172
|
+
* @see {@link DELETE_AiConciergeConversationsConversationId_Request_Query} - Query parameters type
|
|
173
|
+
* @see {@link DELETE_AiConciergeConversationsConversationId_Request_Path} - Path parameters type
|
|
174
|
+
* @see {@link DELETE_AiConciergeConversationsConversationId_Request_Body} - Request body type
|
|
175
|
+
*/
|
|
176
|
+
export type DELETE_AiConciergeConversationsConversationId_Request = {
|
|
177
|
+
parameters: {
|
|
178
|
+
path: operations['delete_conversation_v1_ai_concierge_conversations__conversation_id__delete']['parameters']['path'];
|
|
179
|
+
};
|
|
180
|
+
}
|
|
181
|
+
/**
|
|
182
|
+
* Path parameters for DELETE /v1/ai-concierge/conversations/{conversation_id}
|
|
183
|
+
*
|
|
184
|
+
* @remarks
|
|
185
|
+
* This type defines the path parameters for the DELETE /v1/ai-concierge/conversations/{conversation_id} endpoint.
|
|
186
|
+
* It provides type safety for all path parameters as defined in the OpenAPI specification.
|
|
187
|
+
*
|
|
188
|
+
* @example
|
|
189
|
+
* Use this type to ensure type safety for path parameters.
|
|
190
|
+
*
|
|
191
|
+
* @path /v1/ai-concierge/conversations/{conversation_id}
|
|
192
|
+
*/
|
|
193
|
+
export type DELETE_AiConciergeConversationsConversationId_Request_Path = DELETE_AiConciergeConversationsConversationId_Request['parameters']['path'];
|
|
194
|
+
|
|
195
|
+
/**
|
|
196
|
+
* Request type for GET AiConciergeConversationsConversationId endpoint
|
|
197
|
+
*
|
|
198
|
+
* Get a conversation
|
|
199
|
+
*
|
|
200
|
+
* @remarks
|
|
201
|
+
* This type defines the complete request structure for the GET AiConciergeConversationsConversationId endpoint.
|
|
202
|
+
* It includes all parameters (query, path) and request body types as defined in the OpenAPI specification.
|
|
203
|
+
* Use this type to ensure type safety when making API requests to this endpoint.
|
|
204
|
+
*
|
|
205
|
+
* @example
|
|
206
|
+
* Use this type to ensure type safety when making API requests to this endpoint.
|
|
207
|
+
*
|
|
208
|
+
* @path /v1/ai-concierge/conversations/{conversation_id}
|
|
209
|
+
*
|
|
210
|
+
* @see {@link GET_AiConciergeConversationsConversationId_Request_Query} - Query parameters type
|
|
211
|
+
* @see {@link GET_AiConciergeConversationsConversationId_Request_Path} - Path parameters type
|
|
212
|
+
* @see {@link GET_AiConciergeConversationsConversationId_Request_Body} - Request body type
|
|
213
|
+
*/
|
|
214
|
+
export type GET_AiConciergeConversationsConversationId_Request = {
|
|
215
|
+
parameters: {
|
|
216
|
+
path: operations['get_conversation_v1_ai_concierge_conversations__conversation_id__get']['parameters']['path'];
|
|
217
|
+
};
|
|
218
|
+
}
|
|
219
|
+
/**
|
|
220
|
+
* Path parameters for GET /v1/ai-concierge/conversations/{conversation_id}
|
|
221
|
+
*
|
|
222
|
+
* @remarks
|
|
223
|
+
* This type defines the path parameters for the GET /v1/ai-concierge/conversations/{conversation_id} endpoint.
|
|
224
|
+
* It provides type safety for all path parameters as defined in the OpenAPI specification.
|
|
225
|
+
*
|
|
226
|
+
* @example
|
|
227
|
+
* Use this type to ensure type safety for path parameters.
|
|
228
|
+
*
|
|
229
|
+
* @path /v1/ai-concierge/conversations/{conversation_id}
|
|
230
|
+
*/
|
|
231
|
+
export type GET_AiConciergeConversationsConversationId_Request_Path = GET_AiConciergeConversationsConversationId_Request['parameters']['path'];
|
|
232
|
+
|
|
233
|
+
/**
|
|
234
|
+
* Request type for PATCH AiConciergeConversationsConversationId endpoint
|
|
235
|
+
*
|
|
236
|
+
* Update a conversation
|
|
237
|
+
* Update conversation title or metadata. Supports optimistic concurrency via `If-Match`.
|
|
238
|
+
*
|
|
239
|
+
* @remarks
|
|
240
|
+
* This type defines the complete request structure for the PATCH AiConciergeConversationsConversationId endpoint.
|
|
241
|
+
* It includes all parameters (query, path) and request body types as defined in the OpenAPI specification.
|
|
242
|
+
* Use this type to ensure type safety when making API requests to this endpoint.
|
|
243
|
+
*
|
|
244
|
+
* @example
|
|
245
|
+
* Use this type to ensure type safety when making API requests to this endpoint.
|
|
246
|
+
*
|
|
247
|
+
* @path /v1/ai-concierge/conversations/{conversation_id}
|
|
248
|
+
*
|
|
249
|
+
* @see {@link PATCH_AiConciergeConversationsConversationId_Request_Query} - Query parameters type
|
|
250
|
+
* @see {@link PATCH_AiConciergeConversationsConversationId_Request_Path} - Path parameters type
|
|
251
|
+
* @see {@link PATCH_AiConciergeConversationsConversationId_Request_Body} - Request body type
|
|
252
|
+
*/
|
|
253
|
+
export type PATCH_AiConciergeConversationsConversationId_Request = {
|
|
254
|
+
parameters: {
|
|
255
|
+
path: operations['patch_conversation_v1_ai_concierge_conversations__conversation_id__patch']['parameters']['path'];
|
|
256
|
+
};
|
|
257
|
+
requestBody: ConversationPatchRequest;
|
|
258
|
+
}
|
|
259
|
+
/**
|
|
260
|
+
* Path parameters for PATCH /v1/ai-concierge/conversations/{conversation_id}
|
|
261
|
+
*
|
|
262
|
+
* @remarks
|
|
263
|
+
* This type defines the path parameters for the PATCH /v1/ai-concierge/conversations/{conversation_id} endpoint.
|
|
264
|
+
* It provides type safety for all path parameters as defined in the OpenAPI specification.
|
|
265
|
+
*
|
|
266
|
+
* @example
|
|
267
|
+
* Use this type to ensure type safety for path parameters.
|
|
268
|
+
*
|
|
269
|
+
* @path /v1/ai-concierge/conversations/{conversation_id}
|
|
270
|
+
*/
|
|
271
|
+
export type PATCH_AiConciergeConversationsConversationId_Request_Path = PATCH_AiConciergeConversationsConversationId_Request['parameters']['path'];
|
|
272
|
+
/**
|
|
273
|
+
* Request body for PATCH /v1/ai-concierge/conversations/{conversation_id}
|
|
274
|
+
*
|
|
275
|
+
* @remarks
|
|
276
|
+
* This type defines the request body structure for the PATCH /v1/ai-concierge/conversations/{conversation_id} endpoint.
|
|
277
|
+
* It provides type safety for the request body as defined in the OpenAPI specification.
|
|
278
|
+
*
|
|
279
|
+
* @example
|
|
280
|
+
* Use this type to ensure type safety for request body structure.
|
|
281
|
+
*
|
|
282
|
+
* @path /v1/ai-concierge/conversations/{conversation_id}
|
|
283
|
+
*/
|
|
284
|
+
export type PATCH_AiConciergeConversationsConversationId_Request_Body = PATCH_AiConciergeConversationsConversationId_Request['requestBody'];
|
|
285
|
+
|
|
286
|
+
/**
|
|
287
|
+
* Request type for GET AiConciergeConversationsConversationIdContexts endpoint
|
|
288
|
+
*
|
|
289
|
+
* List contexts attached to a conversation
|
|
290
|
+
*
|
|
291
|
+
* @remarks
|
|
292
|
+
* This type defines the complete request structure for the GET AiConciergeConversationsConversationIdContexts endpoint.
|
|
293
|
+
* It includes all parameters (query, path) and request body types as defined in the OpenAPI specification.
|
|
294
|
+
* Use this type to ensure type safety when making API requests to this endpoint.
|
|
295
|
+
*
|
|
296
|
+
* @example
|
|
297
|
+
* Use this type to ensure type safety when making API requests to this endpoint.
|
|
298
|
+
*
|
|
299
|
+
* @path /v1/ai-concierge/conversations/{conversation_id}/contexts
|
|
300
|
+
*
|
|
301
|
+
* @see {@link GET_AiConciergeConversationsConversationIdContexts_Request_Query} - Query parameters type
|
|
302
|
+
* @see {@link GET_AiConciergeConversationsConversationIdContexts_Request_Path} - Path parameters type
|
|
303
|
+
* @see {@link GET_AiConciergeConversationsConversationIdContexts_Request_Body} - Request body type
|
|
304
|
+
*/
|
|
305
|
+
export type GET_AiConciergeConversationsConversationIdContexts_Request = {
|
|
306
|
+
parameters: {
|
|
307
|
+
query: operations['list_contexts_v1_ai_concierge_conversations__conversation_id__contexts_get']['parameters']['query'];
|
|
308
|
+
path: operations['list_contexts_v1_ai_concierge_conversations__conversation_id__contexts_get']['parameters']['path'];
|
|
309
|
+
};
|
|
310
|
+
}
|
|
311
|
+
/**
|
|
312
|
+
* Query parameters for GET /v1/ai-concierge/conversations/{conversation_id}/contexts
|
|
313
|
+
*
|
|
314
|
+
* @remarks
|
|
315
|
+
* This type defines the query parameters for the GET /v1/ai-concierge/conversations/{conversation_id}/contexts endpoint.
|
|
316
|
+
* It provides type safety for all query parameters as defined in the OpenAPI specification.
|
|
317
|
+
*
|
|
318
|
+
* @example
|
|
319
|
+
* Use this type to ensure type safety for query parameters.
|
|
320
|
+
*
|
|
321
|
+
* @path /v1/ai-concierge/conversations/{conversation_id}/contexts
|
|
322
|
+
*/
|
|
323
|
+
export type GET_AiConciergeConversationsConversationIdContexts_Request_Query = GET_AiConciergeConversationsConversationIdContexts_Request['parameters']['query'];
|
|
324
|
+
/**
|
|
325
|
+
* Path parameters for GET /v1/ai-concierge/conversations/{conversation_id}/contexts
|
|
326
|
+
*
|
|
327
|
+
* @remarks
|
|
328
|
+
* This type defines the path parameters for the GET /v1/ai-concierge/conversations/{conversation_id}/contexts endpoint.
|
|
329
|
+
* It provides type safety for all path parameters as defined in the OpenAPI specification.
|
|
330
|
+
*
|
|
331
|
+
* @example
|
|
332
|
+
* Use this type to ensure type safety for path parameters.
|
|
333
|
+
*
|
|
334
|
+
* @path /v1/ai-concierge/conversations/{conversation_id}/contexts
|
|
335
|
+
*/
|
|
336
|
+
export type GET_AiConciergeConversationsConversationIdContexts_Request_Path = GET_AiConciergeConversationsConversationIdContexts_Request['parameters']['path'];
|
|
337
|
+
|
|
338
|
+
/**
|
|
339
|
+
* Request type for POST AiConciergeConversationsConversationIdContexts endpoint
|
|
340
|
+
*
|
|
341
|
+
* Attach a context to a conversation
|
|
342
|
+
*
|
|
343
|
+
* @remarks
|
|
344
|
+
* This type defines the complete request structure for the POST AiConciergeConversationsConversationIdContexts endpoint.
|
|
345
|
+
* It includes all parameters (query, path) and request body types as defined in the OpenAPI specification.
|
|
346
|
+
* Use this type to ensure type safety when making API requests to this endpoint.
|
|
347
|
+
*
|
|
348
|
+
* @example
|
|
349
|
+
* Use this type to ensure type safety when making API requests to this endpoint.
|
|
350
|
+
*
|
|
351
|
+
* @path /v1/ai-concierge/conversations/{conversation_id}/contexts
|
|
352
|
+
*
|
|
353
|
+
* @see {@link POST_AiConciergeConversationsConversationIdContexts_Request_Query} - Query parameters type
|
|
354
|
+
* @see {@link POST_AiConciergeConversationsConversationIdContexts_Request_Path} - Path parameters type
|
|
355
|
+
* @see {@link POST_AiConciergeConversationsConversationIdContexts_Request_Body} - Request body type
|
|
356
|
+
*/
|
|
357
|
+
export type POST_AiConciergeConversationsConversationIdContexts_Request = {
|
|
358
|
+
parameters: {
|
|
359
|
+
path: operations['create_context_v1_ai_concierge_conversations__conversation_id__contexts_post']['parameters']['path'];
|
|
360
|
+
};
|
|
361
|
+
requestBody: ContextCreateRequest;
|
|
362
|
+
}
|
|
363
|
+
/**
|
|
364
|
+
* Path parameters for POST /v1/ai-concierge/conversations/{conversation_id}/contexts
|
|
365
|
+
*
|
|
366
|
+
* @remarks
|
|
367
|
+
* This type defines the path parameters for the POST /v1/ai-concierge/conversations/{conversation_id}/contexts endpoint.
|
|
368
|
+
* It provides type safety for all path parameters as defined in the OpenAPI specification.
|
|
369
|
+
*
|
|
370
|
+
* @example
|
|
371
|
+
* Use this type to ensure type safety for path parameters.
|
|
372
|
+
*
|
|
373
|
+
* @path /v1/ai-concierge/conversations/{conversation_id}/contexts
|
|
374
|
+
*/
|
|
375
|
+
export type POST_AiConciergeConversationsConversationIdContexts_Request_Path = POST_AiConciergeConversationsConversationIdContexts_Request['parameters']['path'];
|
|
376
|
+
/**
|
|
377
|
+
* Request body for POST /v1/ai-concierge/conversations/{conversation_id}/contexts
|
|
378
|
+
*
|
|
379
|
+
* @remarks
|
|
380
|
+
* This type defines the request body structure for the POST /v1/ai-concierge/conversations/{conversation_id}/contexts endpoint.
|
|
381
|
+
* It provides type safety for the request body as defined in the OpenAPI specification.
|
|
382
|
+
*
|
|
383
|
+
* @example
|
|
384
|
+
* Use this type to ensure type safety for request body structure.
|
|
385
|
+
*
|
|
386
|
+
* @path /v1/ai-concierge/conversations/{conversation_id}/contexts
|
|
387
|
+
*/
|
|
388
|
+
export type POST_AiConciergeConversationsConversationIdContexts_Request_Body = POST_AiConciergeConversationsConversationIdContexts_Request['requestBody'];
|
|
389
|
+
|
|
390
|
+
/**
|
|
391
|
+
* Request type for GET AiConciergeConversationsConversationIdMessages endpoint
|
|
392
|
+
*
|
|
393
|
+
* List messages in a conversation
|
|
394
|
+
*
|
|
395
|
+
* @remarks
|
|
396
|
+
* This type defines the complete request structure for the GET AiConciergeConversationsConversationIdMessages endpoint.
|
|
397
|
+
* It includes all parameters (query, path) and request body types as defined in the OpenAPI specification.
|
|
398
|
+
* Use this type to ensure type safety when making API requests to this endpoint.
|
|
399
|
+
*
|
|
400
|
+
* @example
|
|
401
|
+
* Use this type to ensure type safety when making API requests to this endpoint.
|
|
402
|
+
*
|
|
403
|
+
* @path /v1/ai-concierge/conversations/{conversation_id}/messages
|
|
404
|
+
* @param recent (query) - If set, returns last N messages and overrides pagination.
|
|
405
|
+
* @param exclude (query) - Comma-separated tokens to exclude (case-insensitive). Supports `tools`.
|
|
406
|
+
*
|
|
407
|
+
* @see {@link GET_AiConciergeConversationsConversationIdMessages_Request_Query} - Query parameters type
|
|
408
|
+
* @see {@link GET_AiConciergeConversationsConversationIdMessages_Request_Path} - Path parameters type
|
|
409
|
+
* @see {@link GET_AiConciergeConversationsConversationIdMessages_Request_Body} - Request body type
|
|
410
|
+
*/
|
|
411
|
+
export type GET_AiConciergeConversationsConversationIdMessages_Request = {
|
|
412
|
+
parameters: {
|
|
413
|
+
query: operations['list_messages_v1_ai_concierge_conversations__conversation_id__messages_get']['parameters']['query'];
|
|
414
|
+
path: operations['list_messages_v1_ai_concierge_conversations__conversation_id__messages_get']['parameters']['path'];
|
|
415
|
+
};
|
|
416
|
+
}
|
|
417
|
+
/**
|
|
418
|
+
* Query parameters for GET /v1/ai-concierge/conversations/{conversation_id}/messages
|
|
419
|
+
*
|
|
420
|
+
* @remarks
|
|
421
|
+
* This type defines the query parameters for the GET /v1/ai-concierge/conversations/{conversation_id}/messages endpoint.
|
|
422
|
+
* It provides type safety for all query parameters as defined in the OpenAPI specification.
|
|
423
|
+
*
|
|
424
|
+
* @example
|
|
425
|
+
* Use this type to ensure type safety for query parameters.
|
|
426
|
+
*
|
|
427
|
+
* @path /v1/ai-concierge/conversations/{conversation_id}/messages
|
|
428
|
+
* @param recent (query) - If set, returns last N messages and overrides pagination.
|
|
429
|
+
* @param exclude (query) - Comma-separated tokens to exclude (case-insensitive). Supports `tools`.
|
|
430
|
+
*/
|
|
431
|
+
export type GET_AiConciergeConversationsConversationIdMessages_Request_Query = GET_AiConciergeConversationsConversationIdMessages_Request['parameters']['query'];
|
|
432
|
+
/**
|
|
433
|
+
* Path parameters for GET /v1/ai-concierge/conversations/{conversation_id}/messages
|
|
434
|
+
*
|
|
435
|
+
* @remarks
|
|
436
|
+
* This type defines the path parameters for the GET /v1/ai-concierge/conversations/{conversation_id}/messages endpoint.
|
|
437
|
+
* It provides type safety for all path parameters as defined in the OpenAPI specification.
|
|
438
|
+
*
|
|
439
|
+
* @example
|
|
440
|
+
* Use this type to ensure type safety for path parameters.
|
|
441
|
+
*
|
|
442
|
+
* @path /v1/ai-concierge/conversations/{conversation_id}/messages
|
|
443
|
+
*/
|
|
444
|
+
export type GET_AiConciergeConversationsConversationIdMessages_Request_Path = GET_AiConciergeConversationsConversationIdMessages_Request['parameters']['path'];
|
|
445
|
+
|
|
446
|
+
/**
|
|
447
|
+
* Request type for POST AiConciergeConversationsConversationIdMessages endpoint
|
|
448
|
+
*
|
|
449
|
+
* Append a message to a conversation
|
|
450
|
+
*
|
|
451
|
+
* @remarks
|
|
452
|
+
* This type defines the complete request structure for the POST AiConciergeConversationsConversationIdMessages endpoint.
|
|
453
|
+
* It includes all parameters (query, path) and request body types as defined in the OpenAPI specification.
|
|
454
|
+
* Use this type to ensure type safety when making API requests to this endpoint.
|
|
455
|
+
*
|
|
456
|
+
* @example
|
|
457
|
+
* Use this type to ensure type safety when making API requests to this endpoint.
|
|
458
|
+
*
|
|
459
|
+
* @path /v1/ai-concierge/conversations/{conversation_id}/messages
|
|
460
|
+
*
|
|
461
|
+
* @see {@link POST_AiConciergeConversationsConversationIdMessages_Request_Query} - Query parameters type
|
|
462
|
+
* @see {@link POST_AiConciergeConversationsConversationIdMessages_Request_Path} - Path parameters type
|
|
463
|
+
* @see {@link POST_AiConciergeConversationsConversationIdMessages_Request_Body} - Request body type
|
|
464
|
+
*/
|
|
465
|
+
export type POST_AiConciergeConversationsConversationIdMessages_Request = {
|
|
466
|
+
parameters: {
|
|
467
|
+
path: operations['create_message_v1_ai_concierge_conversations__conversation_id__messages_post']['parameters']['path'];
|
|
468
|
+
};
|
|
469
|
+
requestBody: MessageCreateRequest;
|
|
470
|
+
}
|
|
471
|
+
/**
|
|
472
|
+
* Path parameters for POST /v1/ai-concierge/conversations/{conversation_id}/messages
|
|
473
|
+
*
|
|
474
|
+
* @remarks
|
|
475
|
+
* This type defines the path parameters for the POST /v1/ai-concierge/conversations/{conversation_id}/messages endpoint.
|
|
476
|
+
* It provides type safety for all path parameters as defined in the OpenAPI specification.
|
|
477
|
+
*
|
|
478
|
+
* @example
|
|
479
|
+
* Use this type to ensure type safety for path parameters.
|
|
480
|
+
*
|
|
481
|
+
* @path /v1/ai-concierge/conversations/{conversation_id}/messages
|
|
482
|
+
*/
|
|
483
|
+
export type POST_AiConciergeConversationsConversationIdMessages_Request_Path = POST_AiConciergeConversationsConversationIdMessages_Request['parameters']['path'];
|
|
484
|
+
/**
|
|
485
|
+
* Request body for POST /v1/ai-concierge/conversations/{conversation_id}/messages
|
|
486
|
+
*
|
|
487
|
+
* @remarks
|
|
488
|
+
* This type defines the request body structure for the POST /v1/ai-concierge/conversations/{conversation_id}/messages endpoint.
|
|
489
|
+
* It provides type safety for the request body as defined in the OpenAPI specification.
|
|
490
|
+
*
|
|
491
|
+
* @example
|
|
492
|
+
* Use this type to ensure type safety for request body structure.
|
|
493
|
+
*
|
|
494
|
+
* @path /v1/ai-concierge/conversations/{conversation_id}/messages
|
|
495
|
+
*/
|
|
496
|
+
export type POST_AiConciergeConversationsConversationIdMessages_Request_Body = POST_AiConciergeConversationsConversationIdMessages_Request['requestBody'];
|
|
497
|
+
|
|
498
|
+
/**
|
|
499
|
+
* Request type for GET AiConciergeConversationsConversationIdMessagesMessageId endpoint
|
|
500
|
+
*
|
|
501
|
+
* Get a message
|
|
502
|
+
*
|
|
503
|
+
* @remarks
|
|
504
|
+
* This type defines the complete request structure for the GET AiConciergeConversationsConversationIdMessagesMessageId endpoint.
|
|
505
|
+
* It includes all parameters (query, path) and request body types as defined in the OpenAPI specification.
|
|
506
|
+
* Use this type to ensure type safety when making API requests to this endpoint.
|
|
507
|
+
*
|
|
508
|
+
* @example
|
|
509
|
+
* Use this type to ensure type safety when making API requests to this endpoint.
|
|
510
|
+
*
|
|
511
|
+
* @path /v1/ai-concierge/conversations/{conversation_id}/messages/{message_id}
|
|
512
|
+
*
|
|
513
|
+
* @see {@link GET_AiConciergeConversationsConversationIdMessagesMessageId_Request_Query} - Query parameters type
|
|
514
|
+
* @see {@link GET_AiConciergeConversationsConversationIdMessagesMessageId_Request_Path} - Path parameters type
|
|
515
|
+
* @see {@link GET_AiConciergeConversationsConversationIdMessagesMessageId_Request_Body} - Request body type
|
|
516
|
+
*/
|
|
517
|
+
export type GET_AiConciergeConversationsConversationIdMessagesMessageId_Request = {
|
|
518
|
+
parameters: {
|
|
519
|
+
path: operations['get_message_v1_ai_concierge_conversations__conversation_id__messages__message_id__get']['parameters']['path'];
|
|
520
|
+
};
|
|
521
|
+
}
|
|
522
|
+
/**
|
|
523
|
+
* Path parameters for GET /v1/ai-concierge/conversations/{conversation_id}/messages/{message_id}
|
|
524
|
+
*
|
|
525
|
+
* @remarks
|
|
526
|
+
* This type defines the path parameters for the GET /v1/ai-concierge/conversations/{conversation_id}/messages/{message_id} endpoint.
|
|
527
|
+
* It provides type safety for all path parameters as defined in the OpenAPI specification.
|
|
528
|
+
*
|
|
529
|
+
* @example
|
|
530
|
+
* Use this type to ensure type safety for path parameters.
|
|
531
|
+
*
|
|
532
|
+
* @path /v1/ai-concierge/conversations/{conversation_id}/messages/{message_id}
|
|
533
|
+
*/
|
|
534
|
+
export type GET_AiConciergeConversationsConversationIdMessagesMessageId_Request_Path = GET_AiConciergeConversationsConversationIdMessagesMessageId_Request['parameters']['path'];
|
|
535
|
+
|
|
536
|
+
/**
|
|
537
|
+
* Request type for GET AiConciergeMemoryFacts endpoint
|
|
538
|
+
*
|
|
539
|
+
* List long-term memory facts
|
|
540
|
+
* List long-term, organization-scoped memory facts available to the AI Concierge.
|
|
541
|
+
*
|
|
542
|
+
* @remarks
|
|
543
|
+
* This type defines the complete request structure for the GET AiConciergeMemoryFacts endpoint.
|
|
544
|
+
* It includes all parameters (query, path) and request body types as defined in the OpenAPI specification.
|
|
545
|
+
* Use this type to ensure type safety when making API requests to this endpoint.
|
|
546
|
+
*
|
|
547
|
+
* @example
|
|
548
|
+
* Use this type to ensure type safety when making API requests to this endpoint.
|
|
549
|
+
*
|
|
550
|
+
* @path /v1/ai-concierge/memory/facts
|
|
551
|
+
*
|
|
552
|
+
* @see {@link GET_AiConciergeMemoryFacts_Request_Query} - Query parameters type
|
|
553
|
+
* @see {@link GET_AiConciergeMemoryFacts_Request_Path} - Path parameters type
|
|
554
|
+
* @see {@link GET_AiConciergeMemoryFacts_Request_Body} - Request body type
|
|
555
|
+
*/
|
|
556
|
+
export type GET_AiConciergeMemoryFacts_Request = {
|
|
557
|
+
parameters: {
|
|
558
|
+
query: operations['list_memory_facts_v1_ai_concierge_memory_facts_get']['parameters']['query'];
|
|
559
|
+
};
|
|
560
|
+
}
|
|
561
|
+
/**
|
|
562
|
+
* Query parameters for GET /v1/ai-concierge/memory/facts
|
|
563
|
+
*
|
|
564
|
+
* @remarks
|
|
565
|
+
* This type defines the query parameters for the GET /v1/ai-concierge/memory/facts endpoint.
|
|
566
|
+
* It provides type safety for all query parameters as defined in the OpenAPI specification.
|
|
567
|
+
*
|
|
568
|
+
* @example
|
|
569
|
+
* Use this type to ensure type safety for query parameters.
|
|
570
|
+
*
|
|
571
|
+
* @path /v1/ai-concierge/memory/facts
|
|
572
|
+
*/
|
|
573
|
+
export type GET_AiConciergeMemoryFacts_Request_Query = GET_AiConciergeMemoryFacts_Request['parameters']['query'];
|
|
574
|
+
|
|
575
|
+
/**
|
|
576
|
+
* Request type for POST AiConciergeMemoryFacts endpoint
|
|
577
|
+
*
|
|
578
|
+
* Create a long-term memory fact
|
|
579
|
+
*
|
|
580
|
+
* @remarks
|
|
581
|
+
* This type defines the complete request structure for the POST AiConciergeMemoryFacts endpoint.
|
|
582
|
+
* It includes all parameters (query, path) and request body types as defined in the OpenAPI specification.
|
|
583
|
+
* Use this type to ensure type safety when making API requests to this endpoint.
|
|
584
|
+
*
|
|
585
|
+
* @example
|
|
586
|
+
* Use this type to ensure type safety when making API requests to this endpoint.
|
|
587
|
+
*
|
|
588
|
+
* @path /v1/ai-concierge/memory/facts
|
|
589
|
+
*
|
|
590
|
+
* @see {@link POST_AiConciergeMemoryFacts_Request_Query} - Query parameters type
|
|
591
|
+
* @see {@link POST_AiConciergeMemoryFacts_Request_Path} - Path parameters type
|
|
592
|
+
* @see {@link POST_AiConciergeMemoryFacts_Request_Body} - Request body type
|
|
593
|
+
*/
|
|
594
|
+
export type POST_AiConciergeMemoryFacts_Request = {
|
|
595
|
+
requestBody: MemoryFactCreateRequest;
|
|
596
|
+
}
|
|
597
|
+
/**
|
|
598
|
+
* Request body for POST /v1/ai-concierge/memory/facts
|
|
599
|
+
*
|
|
600
|
+
* @remarks
|
|
601
|
+
* This type defines the request body structure for the POST /v1/ai-concierge/memory/facts endpoint.
|
|
602
|
+
* It provides type safety for the request body as defined in the OpenAPI specification.
|
|
603
|
+
*
|
|
604
|
+
* @example
|
|
605
|
+
* Use this type to ensure type safety for request body structure.
|
|
606
|
+
*
|
|
607
|
+
* @path /v1/ai-concierge/memory/facts
|
|
608
|
+
*/
|
|
609
|
+
export type POST_AiConciergeMemoryFacts_Request_Body = POST_AiConciergeMemoryFacts_Request['requestBody'];
|
|
610
|
+
|
|
611
|
+
/**
|
|
612
|
+
* Request type for DELETE AiConciergeMemoryFactsFactId endpoint
|
|
613
|
+
*
|
|
614
|
+
* Delete a long-term memory fact
|
|
615
|
+
*
|
|
616
|
+
* @remarks
|
|
617
|
+
* This type defines the complete request structure for the DELETE AiConciergeMemoryFactsFactId endpoint.
|
|
618
|
+
* It includes all parameters (query, path) and request body types as defined in the OpenAPI specification.
|
|
619
|
+
* Use this type to ensure type safety when making API requests to this endpoint.
|
|
620
|
+
*
|
|
621
|
+
* @example
|
|
622
|
+
* Use this type to ensure type safety when making API requests to this endpoint.
|
|
623
|
+
*
|
|
624
|
+
* @path /v1/ai-concierge/memory/facts/{fact_id}
|
|
625
|
+
*
|
|
626
|
+
* @see {@link DELETE_AiConciergeMemoryFactsFactId_Request_Query} - Query parameters type
|
|
627
|
+
* @see {@link DELETE_AiConciergeMemoryFactsFactId_Request_Path} - Path parameters type
|
|
628
|
+
* @see {@link DELETE_AiConciergeMemoryFactsFactId_Request_Body} - Request body type
|
|
629
|
+
*/
|
|
630
|
+
export type DELETE_AiConciergeMemoryFactsFactId_Request = {
|
|
631
|
+
parameters: {
|
|
632
|
+
path: operations['delete_memory_fact_v1_ai_concierge_memory_facts__fact_id__delete']['parameters']['path'];
|
|
633
|
+
};
|
|
634
|
+
}
|
|
635
|
+
/**
|
|
636
|
+
* Path parameters for DELETE /v1/ai-concierge/memory/facts/{fact_id}
|
|
637
|
+
*
|
|
638
|
+
* @remarks
|
|
639
|
+
* This type defines the path parameters for the DELETE /v1/ai-concierge/memory/facts/{fact_id} endpoint.
|
|
640
|
+
* It provides type safety for all path parameters as defined in the OpenAPI specification.
|
|
641
|
+
*
|
|
642
|
+
* @example
|
|
643
|
+
* Use this type to ensure type safety for path parameters.
|
|
644
|
+
*
|
|
645
|
+
* @path /v1/ai-concierge/memory/facts/{fact_id}
|
|
646
|
+
*/
|
|
647
|
+
export type DELETE_AiConciergeMemoryFactsFactId_Request_Path = DELETE_AiConciergeMemoryFactsFactId_Request['parameters']['path'];
|
|
648
|
+
|
|
649
|
+
/**
|
|
650
|
+
* Request type for PATCH AiConciergeMemoryFactsFactId endpoint
|
|
651
|
+
*
|
|
652
|
+
* Update a long-term memory fact
|
|
653
|
+
*
|
|
654
|
+
* @remarks
|
|
655
|
+
* This type defines the complete request structure for the PATCH AiConciergeMemoryFactsFactId endpoint.
|
|
656
|
+
* It includes all parameters (query, path) and request body types as defined in the OpenAPI specification.
|
|
657
|
+
* Use this type to ensure type safety when making API requests to this endpoint.
|
|
658
|
+
*
|
|
659
|
+
* @example
|
|
660
|
+
* Use this type to ensure type safety when making API requests to this endpoint.
|
|
661
|
+
*
|
|
662
|
+
* @path /v1/ai-concierge/memory/facts/{fact_id}
|
|
663
|
+
*
|
|
664
|
+
* @see {@link PATCH_AiConciergeMemoryFactsFactId_Request_Query} - Query parameters type
|
|
665
|
+
* @see {@link PATCH_AiConciergeMemoryFactsFactId_Request_Path} - Path parameters type
|
|
666
|
+
* @see {@link PATCH_AiConciergeMemoryFactsFactId_Request_Body} - Request body type
|
|
667
|
+
*/
|
|
668
|
+
export type PATCH_AiConciergeMemoryFactsFactId_Request = {
|
|
669
|
+
parameters: {
|
|
670
|
+
path: operations['patch_memory_fact_v1_ai_concierge_memory_facts__fact_id__patch']['parameters']['path'];
|
|
671
|
+
};
|
|
672
|
+
requestBody: MemoryFactPatchRequest;
|
|
673
|
+
}
|
|
674
|
+
/**
|
|
675
|
+
* Path parameters for PATCH /v1/ai-concierge/memory/facts/{fact_id}
|
|
676
|
+
*
|
|
677
|
+
* @remarks
|
|
678
|
+
* This type defines the path parameters for the PATCH /v1/ai-concierge/memory/facts/{fact_id} endpoint.
|
|
679
|
+
* It provides type safety for all path parameters as defined in the OpenAPI specification.
|
|
680
|
+
*
|
|
681
|
+
* @example
|
|
682
|
+
* Use this type to ensure type safety for path parameters.
|
|
683
|
+
*
|
|
684
|
+
* @path /v1/ai-concierge/memory/facts/{fact_id}
|
|
685
|
+
*/
|
|
686
|
+
export type PATCH_AiConciergeMemoryFactsFactId_Request_Path = PATCH_AiConciergeMemoryFactsFactId_Request['parameters']['path'];
|
|
687
|
+
/**
|
|
688
|
+
* Request body for PATCH /v1/ai-concierge/memory/facts/{fact_id}
|
|
689
|
+
*
|
|
690
|
+
* @remarks
|
|
691
|
+
* This type defines the request body structure for the PATCH /v1/ai-concierge/memory/facts/{fact_id} endpoint.
|
|
692
|
+
* It provides type safety for the request body as defined in the OpenAPI specification.
|
|
693
|
+
*
|
|
694
|
+
* @example
|
|
695
|
+
* Use this type to ensure type safety for request body structure.
|
|
696
|
+
*
|
|
697
|
+
* @path /v1/ai-concierge/memory/facts/{fact_id}
|
|
698
|
+
*/
|
|
699
|
+
export type PATCH_AiConciergeMemoryFactsFactId_Request_Body = PATCH_AiConciergeMemoryFactsFactId_Request['requestBody'];
|
|
38
700
|
|
|
39
701
|
/**
|
|
40
702
|
* Request type for GET ArchiveEmailForwardLogsAliasesEmailForwardAliasId endpoint
|