agentbase-web-sdk 1.12.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.
Files changed (107) hide show
  1. package/LICENSE +0 -0
  2. package/README.md +41 -0
  3. package/dist/cjs/sdk.js +16322 -0
  4. package/dist/cjs/sdk.js.map +1 -0
  5. package/dist/esm/sdk.js +16292 -0
  6. package/dist/esm/sdk.js.map +1 -0
  7. package/dist/iife/sdk.js +20121 -0
  8. package/package.json +54 -0
  9. package/types/channel.d.ts +79 -0
  10. package/types/client.d.ts +289 -0
  11. package/types/enums/authentication-factor.d.ts +6 -0
  12. package/types/enums/authenticator-type.d.ts +3 -0
  13. package/types/enums/browser-permission.d.ts +22 -0
  14. package/types/enums/browser.d.ts +16 -0
  15. package/types/enums/credit-card.d.ts +19 -0
  16. package/types/enums/data-api-catalog-data-source-database-type.d.ts +6 -0
  17. package/types/enums/data-api-catalog-data-source-visibility-source.d.ts +7 -0
  18. package/types/enums/data-api-catalog-database-availability.d.ts +5 -0
  19. package/types/enums/data-api-catalog-database-classification.d.ts +4 -0
  20. package/types/enums/data-api-catalog-database-status.d.ts +4 -0
  21. package/types/enums/data-api-catalog-database-visibility-source.d.ts +7 -0
  22. package/types/enums/data-api-filter-logic.d.ts +4 -0
  23. package/types/enums/data-api-owned-binding-principal-type.d.ts +4 -0
  24. package/types/enums/data-api-owned-binding-status.d.ts +4 -0
  25. package/types/enums/distillation-message-role.d.ts +6 -0
  26. package/types/enums/distillation-mode.d.ts +4 -0
  27. package/types/enums/distillation-tool-status.d.ts +4 -0
  28. package/types/enums/execution-method.d.ts +9 -0
  29. package/types/enums/execution-status.d.ts +7 -0
  30. package/types/enums/execution-trigger.d.ts +5 -0
  31. package/types/enums/export-job-mode.d.ts +4 -0
  32. package/types/enums/export-mode.d.ts +3 -0
  33. package/types/enums/feedback-type.d.ts +5 -0
  34. package/types/enums/flag.d.ts +197 -0
  35. package/types/enums/format.d.ts +4 -0
  36. package/types/enums/image-format.d.ts +9 -0
  37. package/types/enums/image-gravity.d.ts +11 -0
  38. package/types/enums/kind.d.ts +6 -0
  39. package/types/enums/kinds.d.ts +6 -0
  40. package/types/enums/knowledge-base-data-source-document-import-result-status.d.ts +5 -0
  41. package/types/enums/memory-access-mode.d.ts +4 -0
  42. package/types/enums/memory-batch-operation.d.ts +5 -0
  43. package/types/enums/memory-bulk-delete-item-status.d.ts +4 -0
  44. package/types/enums/memory-bulk-delete-response-status.d.ts +4 -0
  45. package/types/enums/memory-handling-policy.d.ts +5 -0
  46. package/types/enums/memory-message-role.d.ts +5 -0
  47. package/types/enums/memory-pipeline-run-result-status.d.ts +4 -0
  48. package/types/enums/memory-pipeline-run-scenario.d.ts +6 -0
  49. package/types/enums/memory-pipeline-run-status.d.ts +6 -0
  50. package/types/enums/memory-record-kind.d.ts +5 -0
  51. package/types/enums/memory-record-sensitivity.d.ts +5 -0
  52. package/types/enums/memory-scope.d.ts +7 -0
  53. package/types/enums/memory-sensitivity.d.ts +6 -0
  54. package/types/enums/memory-share-subject-type.d.ts +4 -0
  55. package/types/enums/method.d.ts +9 -0
  56. package/types/enums/o-auth-provider.d.ts +45 -0
  57. package/types/enums/organization-project-deletion-deletion-status.d.ts +5 -0
  58. package/types/enums/organization-role.d.ts +8 -0
  59. package/types/enums/organization-usage-range.d.ts +5 -0
  60. package/types/enums/outcome.d.ts +6 -0
  61. package/types/enums/path-match.d.ts +4 -0
  62. package/types/enums/profile-extraction-mode.d.ts +4 -0
  63. package/types/enums/profile-type.d.ts +4 -0
  64. package/types/enums/project-deletion-restore-status.d.ts +3 -0
  65. package/types/enums/project-deletion-result-deletion-status.d.ts +5 -0
  66. package/types/enums/project-deletion-result-status.d.ts +5 -0
  67. package/types/enums/record-kind.d.ts +5 -0
  68. package/types/enums/retention-policy.d.ts +3 -0
  69. package/types/enums/scenario.d.ts +6 -0
  70. package/types/enums/scene.d.ts +4 -0
  71. package/types/enums/scope.d.ts +5 -0
  72. package/types/enums/source-type.d.ts +6 -0
  73. package/types/enums/status.d.ts +23 -0
  74. package/types/enums/theme.d.ts +4 -0
  75. package/types/enums/timezone.d.ts +422 -0
  76. package/types/enums/transaction-action.d.ts +12 -0
  77. package/types/enums/validation-status.d.ts +6 -0
  78. package/types/enums/verification-source.d.ts +5 -0
  79. package/types/id.d.ts +20 -0
  80. package/types/index.d.ts +105 -0
  81. package/types/models.d.ts +3368 -0
  82. package/types/operator.d.ts +180 -0
  83. package/types/permission.d.ts +43 -0
  84. package/types/query.d.ts +442 -0
  85. package/types/role.d.ts +70 -0
  86. package/types/service.d.ts +11 -0
  87. package/types/services/account.d.ts +1350 -0
  88. package/types/services/agent-runtime.d.ts +370 -0
  89. package/types/services/ai-gateway.d.ts +888 -0
  90. package/types/services/avatars.d.ts +320 -0
  91. package/types/services/data-api.d.ts +257 -0
  92. package/types/services/databases.d.ts +441 -0
  93. package/types/services/documents-db.d.ts +409 -0
  94. package/types/services/functions.d.ts +175 -0
  95. package/types/services/graphql.d.ts +43 -0
  96. package/types/services/knowledge-bases.d.ts +304 -0
  97. package/types/services/llm-gateway.d.ts +289 -0
  98. package/types/services/locale.d.ts +64 -0
  99. package/types/services/memory.d.ts +2352 -0
  100. package/types/services/messaging.d.ts +53 -0
  101. package/types/services/projects.d.ts +129 -0
  102. package/types/services/realtime.d.ts +197 -0
  103. package/types/services/self-hosted-organizations.d.ts +495 -0
  104. package/types/services/storage.d.ts +265 -0
  105. package/types/services/tables-db.d.ts +438 -0
  106. package/types/services/teams.d.ts +341 -0
  107. package/types/services/vectors-db.d.ts +297 -0
@@ -0,0 +1,3368 @@
1
+ import { DataApiFilterLogic } from './enums/data-api-filter-logic';
2
+ import { DistillationMessageRole } from './enums/distillation-message-role';
3
+ import { DistillationToolStatus } from './enums/distillation-tool-status';
4
+ import { MemoryBatchOperation } from './enums/memory-batch-operation';
5
+ import { MemoryHandlingPolicy } from './enums/memory-handling-policy';
6
+ import { MemoryMessageRole } from './enums/memory-message-role';
7
+ import { MemoryRecordKind } from './enums/memory-record-kind';
8
+ import { MemoryRecordSensitivity } from './enums/memory-record-sensitivity';
9
+ import { MemoryScope } from './enums/memory-scope';
10
+ import { TransactionAction } from './enums/transaction-action';
11
+ import { DataApiOwnedBindingPrincipalType } from "./enums/data-api-owned-binding-principal-type";
12
+ import { DataApiOwnedBindingStatus } from "./enums/data-api-owned-binding-status";
13
+ import { DataApiCatalogDataSourceDatabaseType } from "./enums/data-api-catalog-data-source-database-type";
14
+ import { DataApiCatalogDataSourceVisibilitySource } from "./enums/data-api-catalog-data-source-visibility-source";
15
+ import { DataApiCatalogDatabaseClassification } from "./enums/data-api-catalog-database-classification";
16
+ import { DataApiCatalogDatabaseStatus } from "./enums/data-api-catalog-database-status";
17
+ import { DataApiCatalogDatabaseAvailability } from "./enums/data-api-catalog-database-availability";
18
+ import { DataApiCatalogDatabaseVisibilitySource } from "./enums/data-api-catalog-database-visibility-source";
19
+ import { ExecutionTrigger } from "./enums/execution-trigger";
20
+ import { ExecutionStatus } from "./enums/execution-status";
21
+ import { OrganizationProjectDeletionDeletionStatus } from "./enums/organization-project-deletion-deletion-status";
22
+ import { ProjectDeletionResultStatus } from "./enums/project-deletion-result-status";
23
+ import { ProjectDeletionResultDeletionStatus } from "./enums/project-deletion-result-deletion-status";
24
+ import { ProjectDeletionRestoreStatus } from "./enums/project-deletion-restore-status";
25
+ import { MemoryBulkDeleteItemStatus } from "./enums/memory-bulk-delete-item-status";
26
+ import { MemoryBulkDeleteResponseStatus } from "./enums/memory-bulk-delete-response-status";
27
+ import { MemoryPipelineRunResultStatus } from "./enums/memory-pipeline-run-result-status";
28
+ import { MemoryPipelineRunScenario } from "./enums/memory-pipeline-run-scenario";
29
+ import { MemoryPipelineRunStatus } from "./enums/memory-pipeline-run-status";
30
+ import { KnowledgeBaseDataSourceDocumentImportResultStatus } from "./enums/knowledge-base-data-source-document-import-result-status";
31
+ /**
32
+ * Agentbase Models
33
+ */
34
+ export declare namespace Models {
35
+ const __default: unique symbol;
36
+ /**
37
+ * Data API Binding Catalog Table Detail
38
+ */
39
+ export type DataApiRouteCatalogTableDetail = {
40
+ /**
41
+ * Public table metadata.
42
+ */
43
+ table: DataApiCatalogTableMetadata;
44
+ /**
45
+ * Public column metadata.
46
+ */
47
+ columns: DataApiCatalogColumn[];
48
+ /**
49
+ * Public index metadata.
50
+ */
51
+ indexes: DataApiCatalogIndex[];
52
+ /**
53
+ * Public partition metadata.
54
+ */
55
+ partitions: DataApiCatalogPartition[];
56
+ /**
57
+ * Bounded cache state.
58
+ */
59
+ cache: DataApiCatalogCache;
60
+ /**
61
+ * Constraints of the selected binding.
62
+ */
63
+ routeConstraints: DataApiRouteConstraints;
64
+ };
65
+ /**
66
+ * Data API Route Constraints
67
+ */
68
+ export type DataApiRouteConstraints = {
69
+ /**
70
+ * Whether row restrictions apply.
71
+ */
72
+ rowRestricted: boolean;
73
+ /**
74
+ * Effective row limit, null when unlimited.
75
+ */
76
+ maxRows?: number;
77
+ /**
78
+ * Whether organization defaults contribute to the constraints.
79
+ */
80
+ organizationDefault: boolean;
81
+ };
82
+ /**
83
+ * Current Data API Binding
84
+ */
85
+ export type DataApiOwnedBinding = {
86
+ /**
87
+ * Data API access binding ID.
88
+ */
89
+ id: number;
90
+ /**
91
+ * Published policy set used by this binding.
92
+ */
93
+ dataPolicySetId: number;
94
+ /**
95
+ * Binding recipient type.
96
+ */
97
+ principalType: DataApiOwnedBindingPrincipalType;
98
+ /**
99
+ * Binding status.
100
+ */
101
+ status: DataApiOwnedBindingStatus;
102
+ /**
103
+ * Optional binding expiry.
104
+ */
105
+ validUntil?: string;
106
+ /**
107
+ * Binding display name.
108
+ */
109
+ displayName: string;
110
+ /**
111
+ * Binding description.
112
+ */
113
+ description: string;
114
+ };
115
+ /**
116
+ * Current Data API Bindings List
117
+ */
118
+ export type DataApiOwnedBindingList = {
119
+ /**
120
+ * Bindings in this page.
121
+ */
122
+ items: DataApiOwnedBinding[];
123
+ /**
124
+ * Opaque cursor for the next page.
125
+ */
126
+ nextCursor?: string;
127
+ };
128
+ /**
129
+ * Data API Native SQL Result
130
+ */
131
+ export type DataApiNativeSqlResult = {
132
+ /**
133
+ * Ordered result column metadata.
134
+ */
135
+ columns: object[];
136
+ /**
137
+ * Rows of string, number, boolean or null cells aligned with columns. Exact integers and decimals are strings.
138
+ */
139
+ rows: any[][];
140
+ /**
141
+ * Number of returned rows.
142
+ */
143
+ rowCount: number;
144
+ };
145
+ /**
146
+ * Data API REST Result
147
+ */
148
+ export type DataApiRestResult = {
149
+ /**
150
+ * Projected rows or aggregate groups.
151
+ */
152
+ rows: object[];
153
+ /**
154
+ * Effective pagination and ordering information.
155
+ */
156
+ pageInfo: object;
157
+ };
158
+ /**
159
+ * Data API Catalog Data Source
160
+ */
161
+ export type DataApiCatalogDataSource = {
162
+ /**
163
+ * Data source ID.
164
+ */
165
+ dataSourceId: number;
166
+ /**
167
+ * Display name.
168
+ */
169
+ displayName: string;
170
+ /**
171
+ * Database family.
172
+ */
173
+ databaseType: DataApiCatalogDataSourceDatabaseType;
174
+ /**
175
+ * Visibility source.
176
+ */
177
+ visibilitySource: DataApiCatalogDataSourceVisibilitySource;
178
+ };
179
+ /**
180
+ * Data API Catalog Data Sources List
181
+ */
182
+ export type DataApiCatalogDataSourceList = {
183
+ /**
184
+ * Items in this page.
185
+ */
186
+ items: DataApiCatalogDataSource[];
187
+ /**
188
+ * Opaque next-page cursor.
189
+ */
190
+ nextCursor?: string;
191
+ };
192
+ /**
193
+ * Data API Catalog Database
194
+ */
195
+ export type DataApiCatalogDatabase = {
196
+ /**
197
+ * Database ID.
198
+ */
199
+ databaseId: number;
200
+ /**
201
+ * Database name.
202
+ */
203
+ name: string;
204
+ /**
205
+ * Database classification.
206
+ */
207
+ classification: DataApiCatalogDatabaseClassification;
208
+ /**
209
+ * Database status.
210
+ */
211
+ status: DataApiCatalogDatabaseStatus;
212
+ /**
213
+ * Last known availability.
214
+ */
215
+ availability: DataApiCatalogDatabaseAvailability;
216
+ /**
217
+ * Visibility source.
218
+ */
219
+ visibilitySource: DataApiCatalogDatabaseVisibilitySource;
220
+ };
221
+ /**
222
+ * Data API Catalog Databases List
223
+ */
224
+ export type DataApiCatalogDatabaseList = {
225
+ /**
226
+ * Items in this page.
227
+ */
228
+ items: DataApiCatalogDatabase[];
229
+ /**
230
+ * Opaque next-page cursor.
231
+ */
232
+ nextCursor?: string;
233
+ };
234
+ /**
235
+ * Data API Catalog Cache Summary
236
+ */
237
+ export type DataApiCatalogCacheSummary = {
238
+ /**
239
+ * Cache state.
240
+ */
241
+ state: string;
242
+ /**
243
+ * Last observation time.
244
+ */
245
+ observedAt?: string;
246
+ /**
247
+ * Last refresh attempt time.
248
+ */
249
+ lastRefreshAttemptAt?: string;
250
+ /**
251
+ * Stable refresh failure code.
252
+ */
253
+ lastRefreshErrorCode?: string;
254
+ };
255
+ /**
256
+ * Data API Catalog Cache
257
+ */
258
+ export type DataApiCatalogCache = {
259
+ /**
260
+ * Cache state.
261
+ */
262
+ state: string;
263
+ /**
264
+ * Last observation time.
265
+ */
266
+ observedAt?: string;
267
+ /**
268
+ * Last refresh attempt time.
269
+ */
270
+ lastRefreshAttemptAt?: string;
271
+ /**
272
+ * Stable refresh failure code.
273
+ */
274
+ lastRefreshErrorCode?: string;
275
+ /**
276
+ * Cache detail schema version.
277
+ */
278
+ detailSchemaVersion: number;
279
+ };
280
+ /**
281
+ * Data API Catalog Table Metadata
282
+ */
283
+ export type DataApiCatalogTableMetadata = {
284
+ /**
285
+ * Table name.
286
+ */
287
+ tableName: string;
288
+ /**
289
+ * Table type.
290
+ */
291
+ tableType: string;
292
+ /**
293
+ * Visibility source.
294
+ */
295
+ visibilitySource: string;
296
+ /**
297
+ * Whether the table can be queried.
298
+ */
299
+ queryable: boolean;
300
+ };
301
+ /**
302
+ * Data API Catalog Column
303
+ */
304
+ export type DataApiCatalogColumn = {
305
+ /**
306
+ * Column name.
307
+ */
308
+ columnName: string;
309
+ /**
310
+ * One-based visible ordinal.
311
+ */
312
+ visibleOrdinal: number;
313
+ /**
314
+ * Portable data type.
315
+ */
316
+ dataType: string;
317
+ /**
318
+ * Native database type.
319
+ */
320
+ nativeType: string;
321
+ /**
322
+ * Whether null is accepted.
323
+ */
324
+ nullable: boolean;
325
+ /**
326
+ * Visibility source.
327
+ */
328
+ visibilitySource: string;
329
+ /**
330
+ * Effective access mode.
331
+ */
332
+ accessMode: string;
333
+ };
334
+ /**
335
+ * Data API Catalog Column Reference
336
+ */
337
+ export type DataApiCatalogColumnReference = {
338
+ /**
339
+ * Referenced column name.
340
+ */
341
+ columnName: string;
342
+ };
343
+ /**
344
+ * Data API Catalog Index
345
+ */
346
+ export type DataApiCatalogIndex = {
347
+ /**
348
+ * Whether this is a primary index.
349
+ */
350
+ primary: boolean;
351
+ /**
352
+ * Whether values are unique.
353
+ */
354
+ unique: boolean;
355
+ /**
356
+ * Native index type.
357
+ */
358
+ indexType: string;
359
+ /**
360
+ * Whether all index columns are visible.
361
+ */
362
+ complete: boolean;
363
+ /**
364
+ * Ordered index columns.
365
+ */
366
+ columns: DataApiCatalogColumnReference[];
367
+ /**
368
+ * Recommended leading predicate columns.
369
+ */
370
+ recommendedPredicateColumns: string[];
371
+ };
372
+ /**
373
+ * Data API Catalog Partition
374
+ */
375
+ export type DataApiCatalogPartition = {
376
+ /**
377
+ * Partition type.
378
+ */
379
+ partitionType: string;
380
+ /**
381
+ * Whether all partition key columns are visible.
382
+ */
383
+ complete: boolean;
384
+ /**
385
+ * Partition key columns.
386
+ */
387
+ keyColumns: DataApiCatalogColumnReference[];
388
+ };
389
+ /**
390
+ * Data API Catalog Table
391
+ */
392
+ export type DataApiCatalogTable = {
393
+ /**
394
+ * Table name.
395
+ */
396
+ tableName: string;
397
+ /**
398
+ * Table type.
399
+ */
400
+ tableType: string;
401
+ /**
402
+ * Visibility source.
403
+ */
404
+ visibilitySource: string;
405
+ /**
406
+ * Bounded cache summary.
407
+ */
408
+ cache: DataApiCatalogCacheSummary;
409
+ };
410
+ /**
411
+ * Data API Catalog Tables List
412
+ */
413
+ export type DataApiCatalogTableList = {
414
+ /**
415
+ * Items in this page.
416
+ */
417
+ items: DataApiCatalogTable[];
418
+ /**
419
+ * Opaque next-page cursor.
420
+ */
421
+ nextCursor?: string;
422
+ };
423
+ /**
424
+ * Aggregated Row
425
+ */
426
+ export type RowAggregationRow = {
427
+ /**
428
+ * Selected grouped column values keyed by their aliases.
429
+ */
430
+ group: object;
431
+ /**
432
+ * Aggregate values keyed by their aliases.
433
+ */
434
+ values: object;
435
+ };
436
+ /**
437
+ * Rows Aggregation
438
+ */
439
+ export type RowAggregation = {
440
+ /**
441
+ * Total number of groups returned by the aggregation.
442
+ */
443
+ total: number;
444
+ /**
445
+ * Aggregated rows split into grouped columns and aggregate values.
446
+ */
447
+ rows: RowAggregationRow[];
448
+ };
449
+ /**
450
+ * Rows List
451
+ */
452
+ export type RowList<Row extends Models.Row = Models.DefaultRow> = {
453
+ /**
454
+ * Total number of rows that matched your query.
455
+ */
456
+ total: number;
457
+ /**
458
+ * List of rows.
459
+ */
460
+ rows: Row[];
461
+ };
462
+ /**
463
+ * Documents List
464
+ */
465
+ export type DocumentList<Document extends Models.Document = Models.DefaultDocument> = {
466
+ /**
467
+ * Total number of documents that matched your query.
468
+ */
469
+ total: number;
470
+ /**
471
+ * List of documents.
472
+ */
473
+ documents: Document[];
474
+ };
475
+ /**
476
+ * Sessions List
477
+ */
478
+ export type SessionList = {
479
+ /**
480
+ * Total number of sessions that matched your query.
481
+ */
482
+ total: number;
483
+ /**
484
+ * List of sessions.
485
+ */
486
+ sessions: Session[];
487
+ };
488
+ /**
489
+ * Identities List
490
+ */
491
+ export type IdentityList = {
492
+ /**
493
+ * Total number of identities that matched your query.
494
+ */
495
+ total: number;
496
+ /**
497
+ * List of identities.
498
+ */
499
+ identities: Identity[];
500
+ };
501
+ /**
502
+ * Logs List
503
+ */
504
+ export type LogList = {
505
+ /**
506
+ * Total number of logs that matched your query.
507
+ */
508
+ total: number;
509
+ /**
510
+ * List of logs.
511
+ */
512
+ logs: Log[];
513
+ };
514
+ /**
515
+ * Files List
516
+ */
517
+ export type FileList = {
518
+ /**
519
+ * Total number of files that matched your query.
520
+ */
521
+ total: number;
522
+ /**
523
+ * List of files.
524
+ */
525
+ files: File[];
526
+ };
527
+ /**
528
+ * Teams List
529
+ */
530
+ export type TeamList<Preferences extends Models.Preferences = Models.DefaultPreferences> = {
531
+ /**
532
+ * Total number of teams that matched your query.
533
+ */
534
+ total: number;
535
+ /**
536
+ * List of teams.
537
+ */
538
+ teams: Team<Preferences>[];
539
+ };
540
+ /**
541
+ * Memberships List
542
+ */
543
+ export type MembershipList = {
544
+ /**
545
+ * Total number of memberships that matched your query.
546
+ */
547
+ total: number;
548
+ /**
549
+ * List of memberships.
550
+ */
551
+ memberships: Membership[];
552
+ };
553
+ /**
554
+ * Self-hosted Organizations List
555
+ */
556
+ export type SelfHostedOrganizationList = {
557
+ /**
558
+ * Total number of organizations that matched your query.
559
+ */
560
+ total: number;
561
+ /**
562
+ * List of organizations.
563
+ */
564
+ organizations: SelfHostedOrganization[];
565
+ };
566
+ /**
567
+ * Self-hosted Organization Memberships List
568
+ */
569
+ export type SelfHostedOrgMembershipList = {
570
+ /**
571
+ * Total number of memberships that matched your query.
572
+ */
573
+ total: number;
574
+ /**
575
+ * List of memberships.
576
+ */
577
+ memberships: SelfHostedOrgMembership[];
578
+ };
579
+ /**
580
+ * Executions List
581
+ */
582
+ export type ExecutionList = {
583
+ /**
584
+ * Total number of executions that matched your query.
585
+ */
586
+ total: number;
587
+ /**
588
+ * List of executions.
589
+ */
590
+ executions: Execution[];
591
+ };
592
+ /**
593
+ * Execution Paths List
594
+ */
595
+ export type ExecutionPathList = {
596
+ /**
597
+ * Total number of distinct execution paths.
598
+ */
599
+ total: number;
600
+ /**
601
+ * List of distinct execution paths.
602
+ */
603
+ paths: string[];
604
+ };
605
+ /**
606
+ * Countries List
607
+ */
608
+ export type CountryList = {
609
+ /**
610
+ * Total number of countries that matched your query.
611
+ */
612
+ total: number;
613
+ /**
614
+ * List of countries.
615
+ */
616
+ countries: Country[];
617
+ };
618
+ /**
619
+ * Continents List
620
+ */
621
+ export type ContinentList = {
622
+ /**
623
+ * Total number of continents that matched your query.
624
+ */
625
+ total: number;
626
+ /**
627
+ * List of continents.
628
+ */
629
+ continents: Continent[];
630
+ };
631
+ /**
632
+ * Languages List
633
+ */
634
+ export type LanguageList = {
635
+ /**
636
+ * Total number of languages that matched your query.
637
+ */
638
+ total: number;
639
+ /**
640
+ * List of languages.
641
+ */
642
+ languages: Language[];
643
+ };
644
+ /**
645
+ * Currencies List
646
+ */
647
+ export type CurrencyList = {
648
+ /**
649
+ * Total number of currencies that matched your query.
650
+ */
651
+ total: number;
652
+ /**
653
+ * List of currencies.
654
+ */
655
+ currencies: Currency[];
656
+ };
657
+ /**
658
+ * Phones List
659
+ */
660
+ export type PhoneList = {
661
+ /**
662
+ * Total number of phones that matched your query.
663
+ */
664
+ total: number;
665
+ /**
666
+ * List of phones.
667
+ */
668
+ phones: Phone[];
669
+ };
670
+ /**
671
+ * Locale codes list
672
+ */
673
+ export type LocaleCodeList = {
674
+ /**
675
+ * Total number of localeCodes that matched your query.
676
+ */
677
+ total: number;
678
+ /**
679
+ * List of localeCodes.
680
+ */
681
+ localeCodes: LocaleCode[];
682
+ };
683
+ /**
684
+ * Transaction List
685
+ */
686
+ export type TransactionList = {
687
+ /**
688
+ * Total number of transactions that matched your query.
689
+ */
690
+ total: number;
691
+ /**
692
+ * List of transactions.
693
+ */
694
+ transactions: Transaction[];
695
+ };
696
+ /**
697
+ * Project Table Mode Conversions List
698
+ */
699
+ export type ProjectTableModeConversionList = {
700
+ /**
701
+ * Total number of conversions that matched your query.
702
+ */
703
+ total: number;
704
+ /**
705
+ * List of conversions.
706
+ */
707
+ conversions: ProjectTableModeConversion[];
708
+ };
709
+ /**
710
+ * Row
711
+ */
712
+ export type Row = {
713
+ /**
714
+ * Row ID.
715
+ */
716
+ $id: string;
717
+ /**
718
+ * Row sequence ID.
719
+ */
720
+ $sequence: string;
721
+ /**
722
+ * Table ID.
723
+ */
724
+ $tableId: string;
725
+ /**
726
+ * Database ID.
727
+ */
728
+ $databaseId: string;
729
+ /**
730
+ * Row creation date in ISO 8601 format.
731
+ */
732
+ $createdAt: string;
733
+ /**
734
+ * Row update date in ISO 8601 format.
735
+ */
736
+ $updatedAt: string;
737
+ /**
738
+ * Row permissions. [Learn more about permissions]([HOSTNAME]/docs/permissions).
739
+ */
740
+ $permissions: string[];
741
+ };
742
+ export type DefaultRow = Row & {
743
+ [key: string]: any;
744
+ [__default]: true;
745
+ };
746
+ /**
747
+ * Document
748
+ */
749
+ export type Document = {
750
+ /**
751
+ * Document ID.
752
+ */
753
+ $id: string;
754
+ /**
755
+ * Document sequence ID.
756
+ */
757
+ $sequence: string;
758
+ /**
759
+ * Collection ID.
760
+ */
761
+ $collectionId: string;
762
+ /**
763
+ * Database ID.
764
+ */
765
+ $databaseId: string;
766
+ /**
767
+ * Document creation date in ISO 8601 format.
768
+ */
769
+ $createdAt: string;
770
+ /**
771
+ * Document update date in ISO 8601 format.
772
+ */
773
+ $updatedAt: string;
774
+ /**
775
+ * Document permissions. [Learn more about permissions]([HOSTNAME]/docs/permissions).
776
+ */
777
+ $permissions: string[];
778
+ /**
779
+ * Moderation disposition: checking, published, quarantined, private_hold. Only present when moderation is active.
780
+ */
781
+ moderationStatus?: string | null;
782
+ /**
783
+ * ID of the moderation job processing this document. Only present when moderation is active.
784
+ */
785
+ moderationJobId?: string | null;
786
+ /**
787
+ * Monotonically increasing version of the document content, used by moderation to track which version was reviewed.
788
+ */
789
+ contentVersion?: number | null;
790
+ };
791
+ export type DefaultDocument = Document & {
792
+ [key: string]: any;
793
+ [__default]: true;
794
+ };
795
+ /**
796
+ * Log
797
+ */
798
+ export type Log = {
799
+ /**
800
+ * Event name.
801
+ */
802
+ event: string;
803
+ /**
804
+ * User ID of the actor recorded for this log. During impersonation, this is the original impersonator, not the impersonated target user.
805
+ */
806
+ userId: string;
807
+ /**
808
+ * User email of the actor recorded for this log. During impersonation, this is the original impersonator.
809
+ */
810
+ userEmail: string;
811
+ /**
812
+ * User name of the actor recorded for this log. During impersonation, this is the original impersonator.
813
+ */
814
+ userName: string;
815
+ /**
816
+ * API mode when event triggered.
817
+ */
818
+ mode: string;
819
+ /**
820
+ * IP session in use when the session was created.
821
+ */
822
+ ip: string;
823
+ /**
824
+ * Log creation date in ISO 8601 format.
825
+ */
826
+ time: string;
827
+ /**
828
+ * Operating system code name. View list of [available options]([HOSTNAME]/docs/lists/os.json).
829
+ */
830
+ osCode: string;
831
+ /**
832
+ * Operating system name.
833
+ */
834
+ osName: string;
835
+ /**
836
+ * Operating system version.
837
+ */
838
+ osVersion: string;
839
+ /**
840
+ * Client type.
841
+ */
842
+ clientType: string;
843
+ /**
844
+ * Client code name. View list of [available options]([HOSTNAME]/docs/lists/clients.json).
845
+ */
846
+ clientCode: string;
847
+ /**
848
+ * Client name.
849
+ */
850
+ clientName: string;
851
+ /**
852
+ * Client version.
853
+ */
854
+ clientVersion: string;
855
+ /**
856
+ * Client engine name.
857
+ */
858
+ clientEngine: string;
859
+ /**
860
+ * Client engine name.
861
+ */
862
+ clientEngineVersion: string;
863
+ /**
864
+ * Device name.
865
+ */
866
+ deviceName: string;
867
+ /**
868
+ * Device brand name.
869
+ */
870
+ deviceBrand: string;
871
+ /**
872
+ * Device model name.
873
+ */
874
+ deviceModel: string;
875
+ /**
876
+ * Country two-character ISO 3166-1 alpha code.
877
+ */
878
+ countryCode: string;
879
+ /**
880
+ * Country name.
881
+ */
882
+ countryName: string;
883
+ };
884
+ /**
885
+ * User
886
+ */
887
+ export type User<Preferences extends Models.Preferences = Models.DefaultPreferences> = {
888
+ /**
889
+ * User ID.
890
+ */
891
+ $id: string;
892
+ /**
893
+ * User creation date in ISO 8601 format.
894
+ */
895
+ $createdAt: string;
896
+ /**
897
+ * User update date in ISO 8601 format.
898
+ */
899
+ $updatedAt: string;
900
+ /**
901
+ * User name.
902
+ */
903
+ name: string;
904
+ /**
905
+ * Hashed user password.
906
+ */
907
+ password?: string;
908
+ /**
909
+ * Password hashing algorithm.
910
+ */
911
+ hash?: string;
912
+ /**
913
+ * Password hashing algorithm configuration.
914
+ */
915
+ hashOptions?: object;
916
+ /**
917
+ * User registration date in ISO 8601 format.
918
+ */
919
+ registration: string;
920
+ /**
921
+ * User status. Pass `true` for enabled and `false` for disabled.
922
+ */
923
+ status: boolean;
924
+ /**
925
+ * Labels for the user.
926
+ */
927
+ labels: string[];
928
+ /**
929
+ * Password update time in ISO 8601 format.
930
+ */
931
+ passwordUpdate: string;
932
+ /**
933
+ * User email address.
934
+ */
935
+ email: string;
936
+ /**
937
+ * User phone number in E.164 format.
938
+ */
939
+ phone: string;
940
+ /**
941
+ * Email verification status.
942
+ */
943
+ emailVerification: boolean;
944
+ /**
945
+ * Phone verification status.
946
+ */
947
+ phoneVerification: boolean;
948
+ /**
949
+ * Multi factor authentication status.
950
+ */
951
+ mfa: boolean;
952
+ /**
953
+ * User preferences as a key-value object
954
+ */
955
+ prefs: Preferences;
956
+ /**
957
+ * A user-owned message receiver. A single user may have multiple e.g. emails, phones, and a browser. Each target is registered with a single provider.
958
+ */
959
+ targets: Target[];
960
+ /**
961
+ * Most recent access date in ISO 8601 format. This attribute is only updated again after 24 hours.
962
+ */
963
+ accessedAt: string;
964
+ /**
965
+ * Whether the user can impersonate other users.
966
+ */
967
+ impersonator?: boolean;
968
+ /**
969
+ * ID of the original actor performing the impersonation. Present only when the current request is impersonating another user. Internal audit logs attribute the action to this user, while the impersonated target is recorded only in internal audit payload data.
970
+ */
971
+ impersonatorUserId?: string;
972
+ };
973
+ /**
974
+ * AlgoMD5
975
+ */
976
+ export type AlgoMd5 = {
977
+ /**
978
+ * Algo type.
979
+ */
980
+ type: string;
981
+ };
982
+ /**
983
+ * AlgoSHA
984
+ */
985
+ export type AlgoSha = {
986
+ /**
987
+ * Algo type.
988
+ */
989
+ type: string;
990
+ };
991
+ /**
992
+ * AlgoPHPass
993
+ */
994
+ export type AlgoPhpass = {
995
+ /**
996
+ * Algo type.
997
+ */
998
+ type: string;
999
+ };
1000
+ /**
1001
+ * AlgoBcrypt
1002
+ */
1003
+ export type AlgoBcrypt = {
1004
+ /**
1005
+ * Algo type.
1006
+ */
1007
+ type: string;
1008
+ };
1009
+ /**
1010
+ * AlgoScrypt
1011
+ */
1012
+ export type AlgoScrypt = {
1013
+ /**
1014
+ * Algo type.
1015
+ */
1016
+ type: string;
1017
+ /**
1018
+ * CPU complexity of computed hash.
1019
+ */
1020
+ costCpu: number;
1021
+ /**
1022
+ * Memory complexity of computed hash.
1023
+ */
1024
+ costMemory: number;
1025
+ /**
1026
+ * Parallelization of computed hash.
1027
+ */
1028
+ costParallel: number;
1029
+ /**
1030
+ * Length used to compute hash.
1031
+ */
1032
+ length: number;
1033
+ };
1034
+ /**
1035
+ * AlgoScryptModified
1036
+ */
1037
+ export type AlgoScryptModified = {
1038
+ /**
1039
+ * Algo type.
1040
+ */
1041
+ type: string;
1042
+ /**
1043
+ * Salt used to compute hash.
1044
+ */
1045
+ salt: string;
1046
+ /**
1047
+ * Separator used to compute hash.
1048
+ */
1049
+ saltSeparator: string;
1050
+ /**
1051
+ * Key used to compute hash.
1052
+ */
1053
+ signerKey: string;
1054
+ };
1055
+ /**
1056
+ * AlgoArgon2
1057
+ */
1058
+ export type AlgoArgon2 = {
1059
+ /**
1060
+ * Algo type.
1061
+ */
1062
+ type: string;
1063
+ /**
1064
+ * Memory used to compute hash.
1065
+ */
1066
+ memoryCost: number;
1067
+ /**
1068
+ * Amount of time consumed to compute hash
1069
+ */
1070
+ timeCost: number;
1071
+ /**
1072
+ * Number of threads used to compute hash.
1073
+ */
1074
+ threads: number;
1075
+ };
1076
+ /**
1077
+ * Account
1078
+ */
1079
+ export type Account<Preferences extends Models.Preferences = Models.DefaultPreferences> = {
1080
+ /**
1081
+ * User ID.
1082
+ */
1083
+ $id: string;
1084
+ /**
1085
+ * User creation date in ISO 8601 format.
1086
+ */
1087
+ $createdAt: string;
1088
+ /**
1089
+ * User update date in ISO 8601 format.
1090
+ */
1091
+ $updatedAt: string;
1092
+ /**
1093
+ * User name.
1094
+ */
1095
+ name: string;
1096
+ /**
1097
+ * User registration date in ISO 8601 format.
1098
+ */
1099
+ registration: string;
1100
+ /**
1101
+ * User status. Pass `true` for enabled and `false` for disabled.
1102
+ */
1103
+ status: boolean;
1104
+ /**
1105
+ * Labels for the user.
1106
+ */
1107
+ labels: string[];
1108
+ /**
1109
+ * Password update time in ISO 8601 format.
1110
+ */
1111
+ passwordUpdate: string;
1112
+ /**
1113
+ * User email address.
1114
+ */
1115
+ email: string;
1116
+ /**
1117
+ * User phone number in E.164 format.
1118
+ */
1119
+ phone: string;
1120
+ /**
1121
+ * Email verification status.
1122
+ */
1123
+ emailVerification: boolean;
1124
+ /**
1125
+ * Phone verification status.
1126
+ */
1127
+ phoneVerification: boolean;
1128
+ /**
1129
+ * Multi factor authentication status.
1130
+ */
1131
+ mfa: boolean;
1132
+ /**
1133
+ * User preferences as a key-value object
1134
+ */
1135
+ prefs: Preferences;
1136
+ /**
1137
+ * A user-owned message receiver. A single user may have multiple e.g. emails, phones, and a browser. Each target is registered with a single provider.
1138
+ */
1139
+ targets: Target[];
1140
+ /**
1141
+ * Most recent access date in ISO 8601 format. This attribute is only updated again after 24 hours.
1142
+ */
1143
+ accessedAt: string;
1144
+ /**
1145
+ * Whether the user can impersonate other users.
1146
+ */
1147
+ impersonator?: boolean;
1148
+ /**
1149
+ * ID of the original actor performing the impersonation. Present only when the current request is impersonating another user. Internal audit logs attribute the action to this user, while the impersonated target is recorded only in internal audit payload data.
1150
+ */
1151
+ impersonatorUserId?: string;
1152
+ };
1153
+ /**
1154
+ * Preferences
1155
+ */
1156
+ export type Preferences = {};
1157
+ export type DefaultPreferences = Preferences & {
1158
+ [key: string]: any;
1159
+ [__default]: true;
1160
+ };
1161
+ /**
1162
+ * Session
1163
+ */
1164
+ export type Session = {
1165
+ /**
1166
+ * Session ID.
1167
+ */
1168
+ $id: string;
1169
+ /**
1170
+ * Session creation date in ISO 8601 format.
1171
+ */
1172
+ $createdAt: string;
1173
+ /**
1174
+ * Session update date in ISO 8601 format.
1175
+ */
1176
+ $updatedAt: string;
1177
+ /**
1178
+ * User ID.
1179
+ */
1180
+ userId: string;
1181
+ /**
1182
+ * Session expiration date in ISO 8601 format.
1183
+ */
1184
+ expire: string;
1185
+ /**
1186
+ * Session Provider.
1187
+ */
1188
+ provider: string;
1189
+ /**
1190
+ * Session Provider User ID.
1191
+ */
1192
+ providerUid: string;
1193
+ /**
1194
+ * Session Provider Access Token.
1195
+ */
1196
+ providerAccessToken: string;
1197
+ /**
1198
+ * The date of when the access token expires in ISO 8601 format.
1199
+ */
1200
+ providerAccessTokenExpiry: string;
1201
+ /**
1202
+ * Session Provider Refresh Token.
1203
+ */
1204
+ providerRefreshToken: string;
1205
+ /**
1206
+ * IP in use when the session was created.
1207
+ */
1208
+ ip: string;
1209
+ /**
1210
+ * Operating system code name. View list of [available options]([HOSTNAME]/docs/lists/os.json).
1211
+ */
1212
+ osCode: string;
1213
+ /**
1214
+ * Operating system name.
1215
+ */
1216
+ osName: string;
1217
+ /**
1218
+ * Operating system version.
1219
+ */
1220
+ osVersion: string;
1221
+ /**
1222
+ * Client type.
1223
+ */
1224
+ clientType: string;
1225
+ /**
1226
+ * Client code name. View list of [available options]([HOSTNAME]/docs/lists/clients.json).
1227
+ */
1228
+ clientCode: string;
1229
+ /**
1230
+ * Client name.
1231
+ */
1232
+ clientName: string;
1233
+ /**
1234
+ * Client version.
1235
+ */
1236
+ clientVersion: string;
1237
+ /**
1238
+ * Client engine name.
1239
+ */
1240
+ clientEngine: string;
1241
+ /**
1242
+ * Client engine name.
1243
+ */
1244
+ clientEngineVersion: string;
1245
+ /**
1246
+ * Device name.
1247
+ */
1248
+ deviceName: string;
1249
+ /**
1250
+ * Device brand name.
1251
+ */
1252
+ deviceBrand: string;
1253
+ /**
1254
+ * Device model name.
1255
+ */
1256
+ deviceModel: string;
1257
+ /**
1258
+ * Country two-character ISO 3166-1 alpha code.
1259
+ */
1260
+ countryCode: string;
1261
+ /**
1262
+ * Country name.
1263
+ */
1264
+ countryName: string;
1265
+ /**
1266
+ * Returns true if this the current user session.
1267
+ */
1268
+ current: boolean;
1269
+ /**
1270
+ * Returns a list of active session factors.
1271
+ */
1272
+ factors: string[];
1273
+ /**
1274
+ * Secret used to authenticate the user. Only included if the request was made with an API key
1275
+ */
1276
+ secret: string;
1277
+ /**
1278
+ * Most recent date in ISO 8601 format when the session successfully passed MFA challenge.
1279
+ */
1280
+ mfaUpdatedAt: string;
1281
+ };
1282
+ /**
1283
+ * Identity
1284
+ */
1285
+ export type Identity = {
1286
+ /**
1287
+ * Identity ID.
1288
+ */
1289
+ $id: string;
1290
+ /**
1291
+ * Identity creation date in ISO 8601 format.
1292
+ */
1293
+ $createdAt: string;
1294
+ /**
1295
+ * Identity update date in ISO 8601 format.
1296
+ */
1297
+ $updatedAt: string;
1298
+ /**
1299
+ * User ID.
1300
+ */
1301
+ userId: string;
1302
+ /**
1303
+ * Identity Provider.
1304
+ */
1305
+ provider: string;
1306
+ /**
1307
+ * ID of the User in the Identity Provider.
1308
+ */
1309
+ providerUid: string;
1310
+ /**
1311
+ * Email of the User in the Identity Provider.
1312
+ */
1313
+ providerEmail: string;
1314
+ /**
1315
+ * Identity Provider Access Token.
1316
+ */
1317
+ providerAccessToken: string;
1318
+ /**
1319
+ * The date of when the access token expires in ISO 8601 format.
1320
+ */
1321
+ providerAccessTokenExpiry: string;
1322
+ /**
1323
+ * Identity Provider Refresh Token.
1324
+ */
1325
+ providerRefreshToken: string;
1326
+ };
1327
+ /**
1328
+ * Token
1329
+ */
1330
+ export type Token = {
1331
+ /**
1332
+ * Token ID.
1333
+ */
1334
+ $id: string;
1335
+ /**
1336
+ * Token creation date in ISO 8601 format.
1337
+ */
1338
+ $createdAt: string;
1339
+ /**
1340
+ * User ID.
1341
+ */
1342
+ userId: string;
1343
+ /**
1344
+ * Token secret key. This will return an empty string unless the response is returned using an API key or as part of a webhook payload.
1345
+ */
1346
+ secret: string;
1347
+ /**
1348
+ * Token expiration date in ISO 8601 format.
1349
+ */
1350
+ expire: string;
1351
+ /**
1352
+ * Security phrase of a token. Empty if security phrase was not requested when creating a token. It includes randomly generated phrase which is also sent in the external resource such as email.
1353
+ */
1354
+ phrase: string;
1355
+ };
1356
+ /**
1357
+ * JWT
1358
+ */
1359
+ export type Jwt = {
1360
+ /**
1361
+ * JWT encoded string.
1362
+ */
1363
+ jwt: string;
1364
+ };
1365
+ /**
1366
+ * Locale
1367
+ */
1368
+ export type Locale = {
1369
+ /**
1370
+ * User IP address.
1371
+ */
1372
+ ip: string;
1373
+ /**
1374
+ * Country code in [ISO 3166-1](http://en.wikipedia.org/wiki/ISO_3166-1) two-character format
1375
+ */
1376
+ countryCode: string;
1377
+ /**
1378
+ * Country name. This field support localization.
1379
+ */
1380
+ country: string;
1381
+ /**
1382
+ * Continent code. A two character continent code "AF" for Africa, "AN" for Antarctica, "AS" for Asia, "EU" for Europe, "NA" for North America, "OC" for Oceania, and "SA" for South America.
1383
+ */
1384
+ continentCode: string;
1385
+ /**
1386
+ * Continent name. This field support localization.
1387
+ */
1388
+ continent: string;
1389
+ /**
1390
+ * True if country is part of the European Union.
1391
+ */
1392
+ eu: boolean;
1393
+ /**
1394
+ * Currency code in [ISO 4217-1](http://en.wikipedia.org/wiki/ISO_4217) three-character format
1395
+ */
1396
+ currency: string;
1397
+ };
1398
+ /**
1399
+ * LocaleCode
1400
+ */
1401
+ export type LocaleCode = {
1402
+ /**
1403
+ * Locale codes in [ISO 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes)
1404
+ */
1405
+ code: string;
1406
+ /**
1407
+ * Locale name
1408
+ */
1409
+ name: string;
1410
+ };
1411
+ /**
1412
+ * File
1413
+ */
1414
+ export type File = {
1415
+ /**
1416
+ * File ID.
1417
+ */
1418
+ $id: string;
1419
+ /**
1420
+ * Bucket ID.
1421
+ */
1422
+ bucketId: string;
1423
+ /**
1424
+ * File creation date in ISO 8601 format.
1425
+ */
1426
+ $createdAt: string;
1427
+ /**
1428
+ * File update date in ISO 8601 format.
1429
+ */
1430
+ $updatedAt: string;
1431
+ /**
1432
+ * File permissions. [Learn more about permissions]([HOSTNAME]/docs/permissions).
1433
+ */
1434
+ $permissions: string[];
1435
+ /**
1436
+ * File name.
1437
+ */
1438
+ name: string;
1439
+ /**
1440
+ * File MD5 signature.
1441
+ */
1442
+ signature: string;
1443
+ /**
1444
+ * File mime type.
1445
+ */
1446
+ mimeType: string;
1447
+ /**
1448
+ * File original size in bytes.
1449
+ */
1450
+ sizeOriginal: number;
1451
+ /**
1452
+ * Total number of chunks available
1453
+ */
1454
+ chunksTotal: number;
1455
+ /**
1456
+ * Total number of chunks uploaded
1457
+ */
1458
+ chunksUploaded: number;
1459
+ /**
1460
+ * Whether file contents are encrypted at rest.
1461
+ */
1462
+ encryption: boolean;
1463
+ /**
1464
+ * Compression algorithm used for the file. Will be one of none, [gzip](https://en.wikipedia.org/wiki/Gzip), or [zstd](https://en.wikipedia.org/wiki/Zstd).
1465
+ */
1466
+ compression: string;
1467
+ };
1468
+ /**
1469
+ * Team
1470
+ */
1471
+ export type Team<Preferences extends Models.Preferences = Models.DefaultPreferences> = {
1472
+ /**
1473
+ * Team ID.
1474
+ */
1475
+ $id: string;
1476
+ /**
1477
+ * Team creation date in ISO 8601 format.
1478
+ */
1479
+ $createdAt: string;
1480
+ /**
1481
+ * Team update date in ISO 8601 format.
1482
+ */
1483
+ $updatedAt: string;
1484
+ /**
1485
+ * Team name.
1486
+ */
1487
+ name: string;
1488
+ /**
1489
+ * Total number of team members.
1490
+ */
1491
+ total: number;
1492
+ /**
1493
+ * Team preferences as a key-value object
1494
+ */
1495
+ prefs: Preferences;
1496
+ };
1497
+ /**
1498
+ * Membership
1499
+ */
1500
+ export type Membership = {
1501
+ /**
1502
+ * Membership ID.
1503
+ */
1504
+ $id: string;
1505
+ /**
1506
+ * Membership creation date in ISO 8601 format.
1507
+ */
1508
+ $createdAt: string;
1509
+ /**
1510
+ * Membership update date in ISO 8601 format.
1511
+ */
1512
+ $updatedAt: string;
1513
+ /**
1514
+ * User ID.
1515
+ */
1516
+ userId: string;
1517
+ /**
1518
+ * User name. Hide this attribute by toggling membership privacy in the Console.
1519
+ */
1520
+ userName: string;
1521
+ /**
1522
+ * User email address. Hide this attribute by toggling membership privacy in the Console.
1523
+ */
1524
+ userEmail: string;
1525
+ /**
1526
+ * Team ID.
1527
+ */
1528
+ teamId: string;
1529
+ /**
1530
+ * Team name.
1531
+ */
1532
+ teamName: string;
1533
+ /**
1534
+ * Date, the user has been invited to join the team in ISO 8601 format.
1535
+ */
1536
+ invited: string;
1537
+ /**
1538
+ * Date, the user has accepted the invitation to join the team in ISO 8601 format.
1539
+ */
1540
+ joined: string;
1541
+ /**
1542
+ * User confirmation status, true if the user has joined the team or false otherwise.
1543
+ */
1544
+ confirm: boolean;
1545
+ /**
1546
+ * Multi factor authentication status, true if the user has MFA enabled or false otherwise. Hide this attribute by toggling membership privacy in the Console.
1547
+ */
1548
+ mfa: boolean;
1549
+ /**
1550
+ * User list of roles
1551
+ */
1552
+ roles: string[];
1553
+ };
1554
+ /**
1555
+ * SelfHostedOrganization
1556
+ */
1557
+ export type SelfHostedOrganization = {
1558
+ /**
1559
+ * Organization ID.
1560
+ */
1561
+ $id: string;
1562
+ /**
1563
+ * Organization creation date in ISO 8601 format.
1564
+ */
1565
+ $createdAt: string;
1566
+ /**
1567
+ * Organization update date in ISO 8601 format.
1568
+ */
1569
+ $updatedAt: string;
1570
+ /**
1571
+ * Organization name.
1572
+ */
1573
+ name: string;
1574
+ /**
1575
+ * Organization description.
1576
+ */
1577
+ description: string;
1578
+ /**
1579
+ * Default team ID for this organization.
1580
+ */
1581
+ defaultTeamId: string;
1582
+ /**
1583
+ * Maximum number of members. Null means unlimited.
1584
+ */
1585
+ maxMembers?: number;
1586
+ /**
1587
+ * Current number of active organization members.
1588
+ */
1589
+ memberTotal?: number;
1590
+ /**
1591
+ * Current account role in the organization.
1592
+ */
1593
+ currentRole?: string;
1594
+ /**
1595
+ * Whether the current account is authorized as a platform administrator.
1596
+ */
1597
+ platformAdmin: boolean;
1598
+ /**
1599
+ * Whether the organization has associated projects. Null when this value is not evaluated for the current account.
1600
+ */
1601
+ hasProjects?: boolean;
1602
+ };
1603
+ /**
1604
+ * SelfHostedOrganizationUsage
1605
+ */
1606
+ export type SelfHostedOrganizationUsage = {
1607
+ /**
1608
+ * Time range of the usage statistics.
1609
+ */
1610
+ range: string;
1611
+ /**
1612
+ * Total storage usage across organization projects with available database pools in bytes.
1613
+ */
1614
+ storageTotal: number;
1615
+ /**
1616
+ * Total users across organization projects with available database pools.
1617
+ */
1618
+ usersTotal: number;
1619
+ /**
1620
+ * Total function executions across organization projects with available database pools.
1621
+ */
1622
+ executionsTotal: number;
1623
+ /**
1624
+ * Total inbound and outbound bandwidth across organization projects with available database pools in bytes.
1625
+ */
1626
+ bandwidthTotal: number;
1627
+ /**
1628
+ * Total platform-managed moderation invocations across organization projects with available database pools.
1629
+ */
1630
+ moderationPlatformTotal: number;
1631
+ /**
1632
+ * Aggregated inbound and outbound bandwidth time series.
1633
+ */
1634
+ bandwidth: Metric[];
1635
+ /**
1636
+ * Aggregated user count time series.
1637
+ */
1638
+ users: Metric[];
1639
+ /**
1640
+ * Aggregated function execution time series.
1641
+ */
1642
+ executions: Metric[];
1643
+ /**
1644
+ * Aggregated platform-managed moderation invocation time series.
1645
+ */
1646
+ moderationPlatform: Metric[];
1647
+ /**
1648
+ * Per-project usage breakdown with projectId, storage, bandwidth, users, and executions.
1649
+ */
1650
+ projects: SelfHostedOrganizationUsageProject[];
1651
+ /**
1652
+ * Most recent stats update included in the response. Null when no project stats exist.
1653
+ */
1654
+ freshnessAt?: string;
1655
+ };
1656
+ /**
1657
+ * SelfHostedOrganizationUsageProject
1658
+ */
1659
+ export type SelfHostedOrganizationUsageProject = {
1660
+ /**
1661
+ * Project ID.
1662
+ */
1663
+ projectId: string;
1664
+ /**
1665
+ * Project storage usage in bytes.
1666
+ */
1667
+ storage: number;
1668
+ /**
1669
+ * Project inbound and outbound bandwidth in bytes.
1670
+ */
1671
+ bandwidth: number;
1672
+ /**
1673
+ * Project user count.
1674
+ */
1675
+ users: number;
1676
+ /**
1677
+ * Project function execution count.
1678
+ */
1679
+ executions: number;
1680
+ /**
1681
+ * Project platform-managed moderation invocation count.
1682
+ */
1683
+ moderationPlatform: number;
1684
+ };
1685
+ /**
1686
+ * MeterUsage
1687
+ */
1688
+ export type MeterUsage = {
1689
+ /**
1690
+ * Usage subject type.
1691
+ */
1692
+ subjectType: string;
1693
+ /**
1694
+ * Public usage subject ID.
1695
+ */
1696
+ subjectId: string;
1697
+ /**
1698
+ * Stable meter name.
1699
+ */
1700
+ meter: string;
1701
+ /**
1702
+ * Meter definition version.
1703
+ */
1704
+ meterVersion: number;
1705
+ /**
1706
+ * Measured quantity. Null means the coverage is not trustworthy.
1707
+ */
1708
+ quantity?: number;
1709
+ /**
1710
+ * Meter unit.
1711
+ */
1712
+ unit: string;
1713
+ /**
1714
+ * Daily aggregation rule.
1715
+ */
1716
+ aggregation: string;
1717
+ /**
1718
+ * Inclusive UTC day start.
1719
+ */
1720
+ periodStart: string;
1721
+ /**
1722
+ * Exclusive UTC day end.
1723
+ */
1724
+ periodEnd: string;
1725
+ /**
1726
+ * Whether the full interval is trustworthy.
1727
+ */
1728
+ complete: boolean;
1729
+ /**
1730
+ * Minimum trusted closed watermark.
1731
+ */
1732
+ freshnessAt?: string;
1733
+ /**
1734
+ * Stable reason for incomplete or missing data.
1735
+ */
1736
+ reason?: string;
1737
+ };
1738
+ /**
1739
+ * MeterUsageList
1740
+ */
1741
+ export type MeterUsageList = {
1742
+ /**
1743
+ * Fixed usage range.
1744
+ */
1745
+ range: string;
1746
+ /**
1747
+ * Inclusive UTC range start.
1748
+ */
1749
+ periodStart: string;
1750
+ /**
1751
+ * Exclusive UTC range end.
1752
+ */
1753
+ periodEnd: string;
1754
+ /**
1755
+ * Whether all returned meter-days are trustworthy.
1756
+ */
1757
+ complete: boolean;
1758
+ /**
1759
+ * Minimum trusted watermark across the range.
1760
+ */
1761
+ freshnessAt?: string;
1762
+ /**
1763
+ * UTC daily meter aggregates.
1764
+ */
1765
+ aggregates: MeterUsage[];
1766
+ };
1767
+ /**
1768
+ * SelfHostedOrgMembership
1769
+ */
1770
+ export type SelfHostedOrgMembership = {
1771
+ /**
1772
+ * Organization membership ID.
1773
+ */
1774
+ $id: string;
1775
+ /**
1776
+ * Membership creation date in ISO 8601 format.
1777
+ */
1778
+ $createdAt: string;
1779
+ /**
1780
+ * Membership update date in ISO 8601 format.
1781
+ */
1782
+ $updatedAt: string;
1783
+ /**
1784
+ * Organization ID.
1785
+ */
1786
+ organizationId: string;
1787
+ /**
1788
+ * Organization name.
1789
+ */
1790
+ organizationName: string;
1791
+ /**
1792
+ * User ID.
1793
+ */
1794
+ userId: string;
1795
+ /**
1796
+ * User name.
1797
+ */
1798
+ userName: string;
1799
+ /**
1800
+ * User email address.
1801
+ */
1802
+ userEmail: string;
1803
+ /**
1804
+ * Organization role. One of: owner, admin, developer, editor, analyst, billing.
1805
+ */
1806
+ role: string;
1807
+ /**
1808
+ * Membership status. One of: pending, active.
1809
+ */
1810
+ status: string;
1811
+ /**
1812
+ * Date the user was invited to join the organization in ISO 8601 format.
1813
+ */
1814
+ invited: string;
1815
+ /**
1816
+ * Date the user accepted the invitation in ISO 8601 format.
1817
+ */
1818
+ joined: string;
1819
+ /**
1820
+ * Invitation expiry date in ISO 8601 format.
1821
+ */
1822
+ expiresAt: string;
1823
+ /**
1824
+ * Whether the member has multi-factor authentication enabled with at least one verified factor.
1825
+ */
1826
+ mfa?: boolean;
1827
+ };
1828
+ /**
1829
+ * Execution
1830
+ */
1831
+ export type Execution = {
1832
+ /**
1833
+ * Execution ID.
1834
+ */
1835
+ $id: string;
1836
+ /**
1837
+ * Execution creation date in ISO 8601 format.
1838
+ */
1839
+ $createdAt: string;
1840
+ /**
1841
+ * Execution update date in ISO 8601 format.
1842
+ */
1843
+ $updatedAt: string;
1844
+ /**
1845
+ * Execution roles.
1846
+ */
1847
+ $permissions: string[];
1848
+ /**
1849
+ * Function ID.
1850
+ */
1851
+ functionId: string;
1852
+ /**
1853
+ * Function's deployment ID used to create the execution.
1854
+ */
1855
+ deploymentId: string;
1856
+ /**
1857
+ * The trigger that caused the function to execute. Possible values can be: `http`, `schedule`, or `event`.
1858
+ */
1859
+ trigger: ExecutionTrigger;
1860
+ /**
1861
+ * The status of the function execution. Possible values can be: `waiting`, `processing`, `completed`, `failed`, or `scheduled`.
1862
+ */
1863
+ status: ExecutionStatus;
1864
+ /**
1865
+ * HTTP request method type.
1866
+ */
1867
+ requestMethod: string;
1868
+ /**
1869
+ * HTTP request path and query.
1870
+ */
1871
+ requestPath: string;
1872
+ /**
1873
+ * HTTP request headers as a key-value object. This will return only whitelisted headers. All headers are returned if execution is created as synchronous.
1874
+ */
1875
+ requestHeaders: Headers[];
1876
+ /**
1877
+ * HTTP response status code.
1878
+ */
1879
+ responseStatusCode: number;
1880
+ /**
1881
+ * HTTP response body returned by the function.
1882
+ */
1883
+ responseBody: string;
1884
+ /**
1885
+ * HTTP response headers as a key-value object. This will return only whitelisted headers. All headers are returned if execution is created as synchronous.
1886
+ */
1887
+ responseHeaders: Headers[];
1888
+ /**
1889
+ * Function logs. Includes the last 4,000 characters. This will return an empty string unless the response is returned using an API key or as part of a webhook payload.
1890
+ */
1891
+ logs: string;
1892
+ /**
1893
+ * Function errors. Includes the last 4,000 characters. This will return an empty string unless the response is returned using an API key or as part of a webhook payload.
1894
+ */
1895
+ errors: string;
1896
+ /**
1897
+ * Resource(function/site) execution duration in seconds.
1898
+ */
1899
+ duration: number;
1900
+ /**
1901
+ * The scheduled time for execution. If left empty, execution will be queued immediately.
1902
+ */
1903
+ scheduledAt?: string;
1904
+ };
1905
+ /**
1906
+ * Organization Inactive Project
1907
+ */
1908
+ export type OrganizationInactiveProject = {
1909
+ /**
1910
+ * Project ID.
1911
+ */
1912
+ projectId: string;
1913
+ /**
1914
+ * Project name.
1915
+ */
1916
+ name: string;
1917
+ /**
1918
+ * Organization ID.
1919
+ */
1920
+ teamId: string;
1921
+ /**
1922
+ * Project creation time.
1923
+ */
1924
+ createdAt: string;
1925
+ /**
1926
+ * Most recent project access time, when available.
1927
+ */
1928
+ lastResourceActivityAt?: string;
1929
+ /**
1930
+ * Time from which the project is considered inactive.
1931
+ */
1932
+ inactiveSince: string;
1933
+ /**
1934
+ * Current table mode conversion status.
1935
+ */
1936
+ tableModeConversionStatus: string;
1937
+ };
1938
+ /**
1939
+ * Organization Inactive Project List
1940
+ */
1941
+ export type OrganizationInactiveProjectList = {
1942
+ /**
1943
+ * Organization ID.
1944
+ */
1945
+ teamId: string;
1946
+ /**
1947
+ * Inactivity threshold in days.
1948
+ */
1949
+ inactiveDays: number;
1950
+ /**
1951
+ * Inactive projects in this page.
1952
+ */
1953
+ projects: OrganizationInactiveProject[];
1954
+ /**
1955
+ * Matching inactive projects found in this bounded scan.
1956
+ */
1957
+ total: number;
1958
+ /**
1959
+ * Number of organization projects inspected in this bounded scan.
1960
+ */
1961
+ scanned: number;
1962
+ /**
1963
+ * Last inspected project ID for continuing the bounded scan.
1964
+ */
1965
+ nextCursor?: string;
1966
+ };
1967
+ /**
1968
+ * Organization Project Deletion
1969
+ */
1970
+ export type OrganizationProjectDeletion = {
1971
+ /**
1972
+ * Project ID.
1973
+ */
1974
+ projectId: string;
1975
+ /**
1976
+ * Project name.
1977
+ */
1978
+ name: string;
1979
+ /**
1980
+ * Organization team ID.
1981
+ */
1982
+ teamId: string;
1983
+ /**
1984
+ * Deletion lifecycle status.
1985
+ */
1986
+ deletionStatus: OrganizationProjectDeletionDeletionStatus;
1987
+ /**
1988
+ * Logical deletion time.
1989
+ */
1990
+ deletedAt: string;
1991
+ /**
1992
+ * Scheduled physical deletion time.
1993
+ */
1994
+ purgeAt: string;
1995
+ /**
1996
+ * User or organization key identity that requested deletion.
1997
+ */
1998
+ deletedBy?: string;
1999
+ /**
2000
+ * Deletion reason.
2001
+ */
2002
+ reason?: string;
2003
+ /**
2004
+ * Deletion request ID.
2005
+ */
2006
+ requestId: string;
2007
+ /**
2008
+ * Latest purge error.
2009
+ */
2010
+ error?: string;
2011
+ };
2012
+ /**
2013
+ * Organization Project Deletion List
2014
+ */
2015
+ export type OrganizationProjectDeletionList = {
2016
+ /**
2017
+ * Organization team ID.
2018
+ */
2019
+ teamId: string;
2020
+ /**
2021
+ * Projects in a deletion lifecycle state.
2022
+ */
2023
+ projects: OrganizationProjectDeletion[];
2024
+ /**
2025
+ * Total matching projects.
2026
+ */
2027
+ total: number;
2028
+ };
2029
+ /**
2030
+ * Project Deletion Result
2031
+ */
2032
+ export type ProjectDeletionResult = {
2033
+ /**
2034
+ * Requested project ID.
2035
+ */
2036
+ projectId: string;
2037
+ /**
2038
+ * Per-project deletion result.
2039
+ */
2040
+ status: ProjectDeletionResultStatus;
2041
+ /**
2042
+ * Deletion request ID when accepted.
2043
+ */
2044
+ requestId?: string;
2045
+ /**
2046
+ * Deletion lifecycle status when accepted.
2047
+ */
2048
+ deletionStatus?: ProjectDeletionResultDeletionStatus;
2049
+ /**
2050
+ * Logical deletion time.
2051
+ */
2052
+ deletedAt?: string;
2053
+ /**
2054
+ * Scheduled physical deletion time.
2055
+ */
2056
+ purgeAt?: string;
2057
+ /**
2058
+ * Whether an existing deletion request was reused.
2059
+ */
2060
+ idempotent?: boolean;
2061
+ /**
2062
+ * Machine-readable result code.
2063
+ */
2064
+ code?: string;
2065
+ /**
2066
+ * Human-readable result detail.
2067
+ */
2068
+ message?: string;
2069
+ };
2070
+ /**
2071
+ * Project Deletion Restore
2072
+ */
2073
+ export type ProjectDeletionRestore = {
2074
+ /**
2075
+ * Restoration result.
2076
+ */
2077
+ status: ProjectDeletionRestoreStatus;
2078
+ /**
2079
+ * Restored project ID.
2080
+ */
2081
+ projectId: string;
2082
+ /**
2083
+ * Original deletion request ID.
2084
+ */
2085
+ requestId: string;
2086
+ };
2087
+ /**
2088
+ * Project Deletion Summary
2089
+ */
2090
+ export type ProjectDeletionSummary = {
2091
+ /**
2092
+ * Number of accepted deletions.
2093
+ */
2094
+ accepted: number;
2095
+ /**
2096
+ * Number of rejected deletions.
2097
+ */
2098
+ rejected: number;
2099
+ /**
2100
+ * Number of skipped deletions.
2101
+ */
2102
+ skipped: number;
2103
+ };
2104
+ /**
2105
+ * Project Batch Deletion
2106
+ */
2107
+ export type ProjectBatchDeletion = {
2108
+ /**
2109
+ * Batch request ID.
2110
+ */
2111
+ requestId: string;
2112
+ /**
2113
+ * Organization ID.
2114
+ */
2115
+ teamId: string;
2116
+ /**
2117
+ * Unique requested project IDs.
2118
+ */
2119
+ projectIds: string[];
2120
+ /**
2121
+ * Deletion reason.
2122
+ */
2123
+ reason?: string;
2124
+ /**
2125
+ * Whether this request only validated deletion eligibility.
2126
+ */
2127
+ dryRun: boolean;
2128
+ /**
2129
+ * Per-project deletion results.
2130
+ */
2131
+ results: ProjectDeletionResult[];
2132
+ /**
2133
+ * Counts keyed by accepted, rejected, and skipped.
2134
+ */
2135
+ summary: ProjectDeletionSummary;
2136
+ };
2137
+ /**
2138
+ * Project Table Mode Conversion
2139
+ */
2140
+ export type ProjectTableModeConversion = {
2141
+ /**
2142
+ * Conversion ID.
2143
+ */
2144
+ $id: string;
2145
+ /**
2146
+ * Conversion creation date in ISO 8601 format.
2147
+ */
2148
+ $createdAt: string;
2149
+ /**
2150
+ * Conversion update date in ISO 8601 format.
2151
+ */
2152
+ $updatedAt: string;
2153
+ /**
2154
+ * Project ID.
2155
+ */
2156
+ projectId: string;
2157
+ /**
2158
+ * Source pool alias.
2159
+ */
2160
+ sourcePool: string;
2161
+ /**
2162
+ * Source table mode.
2163
+ */
2164
+ sourceTableMode: string;
2165
+ /**
2166
+ * Target pool alias.
2167
+ */
2168
+ targetPool: string;
2169
+ /**
2170
+ * Target table mode.
2171
+ */
2172
+ targetTableMode: string;
2173
+ /**
2174
+ * Target pool tag.
2175
+ */
2176
+ targetTag: string;
2177
+ /**
2178
+ * Conversion status.
2179
+ */
2180
+ status: string;
2181
+ /**
2182
+ * Total number of records to migrate.
2183
+ */
2184
+ progressTotal: number;
2185
+ /**
2186
+ * Number of migrated records.
2187
+ */
2188
+ progressDone: number;
2189
+ /**
2190
+ * Backfill batch size.
2191
+ */
2192
+ batchSize: number;
2193
+ /**
2194
+ * Maximum freeze-writes window in seconds.
2195
+ */
2196
+ freezeWindowMaxSecs: number;
2197
+ /**
2198
+ * Source data retention period in seconds after cutover.
2199
+ */
2200
+ retentionSeconds: number;
2201
+ /**
2202
+ * Time when source data is scheduled for deletion.
2203
+ */
2204
+ sourceDataDeleteAt: string;
2205
+ /**
2206
+ * Time when source data was deleted.
2207
+ */
2208
+ sourceDataDeletedAt: string;
2209
+ /**
2210
+ * Source data deletion status.
2211
+ */
2212
+ sourceDataDeleteStatus: string;
2213
+ /**
2214
+ * Source data deletion error, when cleanup fails.
2215
+ */
2216
+ sourceDataDeleteError: string;
2217
+ /**
2218
+ * Verification report, when available.
2219
+ */
2220
+ verificationReport: object;
2221
+ /**
2222
+ * Error message, when the conversion fails.
2223
+ */
2224
+ errorMessage: string;
2225
+ /**
2226
+ * Time when project writes were frozen.
2227
+ */
2228
+ frozenAt: string;
2229
+ /**
2230
+ * Time when traffic was cut over.
2231
+ */
2232
+ cutoverAt: string;
2233
+ /**
2234
+ * Deadline for rollback after cutover.
2235
+ */
2236
+ rollbackDeadline: string;
2237
+ };
2238
+ /**
2239
+ * Country
2240
+ */
2241
+ export type Country = {
2242
+ /**
2243
+ * Country name.
2244
+ */
2245
+ name: string;
2246
+ /**
2247
+ * Country two-character ISO 3166-1 alpha code.
2248
+ */
2249
+ code: string;
2250
+ };
2251
+ /**
2252
+ * Continent
2253
+ */
2254
+ export type Continent = {
2255
+ /**
2256
+ * Continent name.
2257
+ */
2258
+ name: string;
2259
+ /**
2260
+ * Continent two letter code.
2261
+ */
2262
+ code: string;
2263
+ };
2264
+ /**
2265
+ * Language
2266
+ */
2267
+ export type Language = {
2268
+ /**
2269
+ * Language name.
2270
+ */
2271
+ name: string;
2272
+ /**
2273
+ * Language two-character ISO 639-1 codes.
2274
+ */
2275
+ code: string;
2276
+ /**
2277
+ * Language native name.
2278
+ */
2279
+ nativeName: string;
2280
+ };
2281
+ /**
2282
+ * Currency
2283
+ */
2284
+ export type Currency = {
2285
+ /**
2286
+ * Currency symbol.
2287
+ */
2288
+ symbol: string;
2289
+ /**
2290
+ * Currency name.
2291
+ */
2292
+ name: string;
2293
+ /**
2294
+ * Currency native symbol.
2295
+ */
2296
+ symbolNative: string;
2297
+ /**
2298
+ * Number of decimal digits.
2299
+ */
2300
+ decimalDigits: number;
2301
+ /**
2302
+ * Currency digit rounding.
2303
+ */
2304
+ rounding: number;
2305
+ /**
2306
+ * Currency code in [ISO 4217-1](http://en.wikipedia.org/wiki/ISO_4217) three-character format.
2307
+ */
2308
+ code: string;
2309
+ /**
2310
+ * Currency plural name
2311
+ */
2312
+ namePlural: string;
2313
+ };
2314
+ /**
2315
+ * Phone
2316
+ */
2317
+ export type Phone = {
2318
+ /**
2319
+ * Phone code.
2320
+ */
2321
+ code: string;
2322
+ /**
2323
+ * Country two-character ISO 3166-1 alpha code.
2324
+ */
2325
+ countryCode: string;
2326
+ /**
2327
+ * Country name.
2328
+ */
2329
+ countryName: string;
2330
+ };
2331
+ /**
2332
+ * Metric
2333
+ */
2334
+ export type Metric = {
2335
+ /**
2336
+ * The value of this metric at the timestamp.
2337
+ */
2338
+ value: number;
2339
+ /**
2340
+ * The date at which this metric was aggregated in ISO 8601 format.
2341
+ */
2342
+ date: string;
2343
+ };
2344
+ /**
2345
+ * Headers
2346
+ */
2347
+ export type Headers = {
2348
+ /**
2349
+ * Header name.
2350
+ */
2351
+ name: string;
2352
+ /**
2353
+ * Header value.
2354
+ */
2355
+ value: string;
2356
+ };
2357
+ /**
2358
+ * MFA Challenge
2359
+ */
2360
+ export type MfaChallenge = {
2361
+ /**
2362
+ * Token ID.
2363
+ */
2364
+ $id: string;
2365
+ /**
2366
+ * Token creation date in ISO 8601 format.
2367
+ */
2368
+ $createdAt: string;
2369
+ /**
2370
+ * User ID.
2371
+ */
2372
+ userId: string;
2373
+ /**
2374
+ * Token expiration date in ISO 8601 format.
2375
+ */
2376
+ expire: string;
2377
+ };
2378
+ /**
2379
+ * MFA Recovery Codes
2380
+ */
2381
+ export type MfaRecoveryCodes = {
2382
+ /**
2383
+ * Recovery codes.
2384
+ */
2385
+ recoveryCodes: string[];
2386
+ };
2387
+ /**
2388
+ * MFAType
2389
+ */
2390
+ export type MfaType = {
2391
+ /**
2392
+ * Secret token used for TOTP factor.
2393
+ */
2394
+ secret: string;
2395
+ /**
2396
+ * URI for authenticator apps.
2397
+ */
2398
+ uri: string;
2399
+ };
2400
+ /**
2401
+ * MFAFactors
2402
+ */
2403
+ export type MfaFactors = {
2404
+ /**
2405
+ * Can TOTP be used for MFA challenge for this account.
2406
+ */
2407
+ totp: boolean;
2408
+ /**
2409
+ * Can phone (SMS) be used for MFA challenge for this account.
2410
+ */
2411
+ phone: boolean;
2412
+ /**
2413
+ * Can email be used for MFA challenge for this account.
2414
+ */
2415
+ email: boolean;
2416
+ /**
2417
+ * Can recovery code be used for MFA challenge for this account.
2418
+ */
2419
+ recoveryCode: boolean;
2420
+ };
2421
+ /**
2422
+ * Transaction
2423
+ */
2424
+ export type Transaction = {
2425
+ /**
2426
+ * Transaction ID.
2427
+ */
2428
+ $id: string;
2429
+ /**
2430
+ * Transaction creation time in ISO 8601 format.
2431
+ */
2432
+ $createdAt: string;
2433
+ /**
2434
+ * Transaction update date in ISO 8601 format.
2435
+ */
2436
+ $updatedAt: string;
2437
+ /**
2438
+ * Current status of the transaction. One of: pending, committing, committed, rolled_back, failed.
2439
+ */
2440
+ status: string;
2441
+ /**
2442
+ * Number of operations in the transaction.
2443
+ */
2444
+ operations: number;
2445
+ /**
2446
+ * Expiration time in ISO 8601 format.
2447
+ */
2448
+ expiresAt: string;
2449
+ };
2450
+ /**
2451
+ * Subscriber
2452
+ */
2453
+ export type Subscriber = {
2454
+ /**
2455
+ * Subscriber ID.
2456
+ */
2457
+ $id: string;
2458
+ /**
2459
+ * Subscriber creation time in ISO 8601 format.
2460
+ */
2461
+ $createdAt: string;
2462
+ /**
2463
+ * Subscriber update date in ISO 8601 format.
2464
+ */
2465
+ $updatedAt: string;
2466
+ /**
2467
+ * Target ID.
2468
+ */
2469
+ targetId: string;
2470
+ /**
2471
+ * Target.
2472
+ */
2473
+ target: Target;
2474
+ /**
2475
+ * Topic ID.
2476
+ */
2477
+ userId: string;
2478
+ /**
2479
+ * User Name.
2480
+ */
2481
+ userName: string;
2482
+ /**
2483
+ * Topic ID.
2484
+ */
2485
+ topicId: string;
2486
+ /**
2487
+ * The target provider type. Can be one of the following: `email`, `sms` or `push`.
2488
+ */
2489
+ providerType: string;
2490
+ };
2491
+ /**
2492
+ * Target
2493
+ */
2494
+ export type Target = {
2495
+ /**
2496
+ * Target ID.
2497
+ */
2498
+ $id: string;
2499
+ /**
2500
+ * Target creation time in ISO 8601 format.
2501
+ */
2502
+ $createdAt: string;
2503
+ /**
2504
+ * Target update date in ISO 8601 format.
2505
+ */
2506
+ $updatedAt: string;
2507
+ /**
2508
+ * Target Name.
2509
+ */
2510
+ name: string;
2511
+ /**
2512
+ * User ID.
2513
+ */
2514
+ userId: string;
2515
+ /**
2516
+ * Provider ID.
2517
+ */
2518
+ providerId?: string;
2519
+ /**
2520
+ * The target provider type. Can be one of the following: `email`, `sms` or `push`.
2521
+ */
2522
+ providerType: string;
2523
+ /**
2524
+ * The target identifier.
2525
+ */
2526
+ identifier: string;
2527
+ /**
2528
+ * Is the target expired.
2529
+ */
2530
+ expired: boolean;
2531
+ };
2532
+ /**
2533
+ * Memory Bulk Delete Item
2534
+ */
2535
+ export type MemoryBulkDeleteItem = {
2536
+ /**
2537
+ * Memory record ID processed in this pass.
2538
+ */
2539
+ memoryId: string;
2540
+ /**
2541
+ * Per-record deletion outcome.
2542
+ */
2543
+ status: MemoryBulkDeleteItemStatus;
2544
+ /**
2545
+ * Machine-readable error code when deletion failed.
2546
+ */
2547
+ errorCode?: string;
2548
+ /**
2549
+ * Whether the failed record can be retried.
2550
+ */
2551
+ retryable?: boolean;
2552
+ /**
2553
+ * Human-readable failure detail.
2554
+ */
2555
+ error?: string;
2556
+ };
2557
+ /**
2558
+ * Memory Bulk Delete Response
2559
+ */
2560
+ export type MemoryBulkDeleteResponse = {
2561
+ /**
2562
+ * Aggregate deletion outcome for this pass.
2563
+ */
2564
+ status: MemoryBulkDeleteResponseStatus;
2565
+ /**
2566
+ * Number of memory records processed in this pass.
2567
+ */
2568
+ processed: number;
2569
+ /**
2570
+ * Number of memory records successfully forgotten in this pass.
2571
+ */
2572
+ forgotten: number;
2573
+ /**
2574
+ * Number of memory records that failed deletion in this pass.
2575
+ */
2576
+ failed: number;
2577
+ /**
2578
+ * Whether another deleteMany request is required to finish deleting the selected scope.
2579
+ */
2580
+ hasMore: boolean;
2581
+ /**
2582
+ * Per-record results for this pass.
2583
+ */
2584
+ items: MemoryBulkDeleteItem[];
2585
+ };
2586
+ /**
2587
+ * Memory Pipeline Run Error
2588
+ */
2589
+ export type MemoryPipelineRunError = {
2590
+ /**
2591
+ * Stable trial failure code.
2592
+ */
2593
+ code: string;
2594
+ /**
2595
+ * Safe human-readable trial failure detail.
2596
+ */
2597
+ message: string;
2598
+ };
2599
+ /**
2600
+ * Memory Pipeline Run Candidate
2601
+ */
2602
+ export type MemoryPipelineRunCandidate = {
2603
+ /**
2604
+ * Selected Pipeline ID.
2605
+ */
2606
+ pipelineId: string;
2607
+ /**
2608
+ * Frozen saved configuration version ID.
2609
+ */
2610
+ versionId: string;
2611
+ /**
2612
+ * Pipeline name at acceptance.
2613
+ */
2614
+ name: string;
2615
+ /**
2616
+ * Frozen configuration revision.
2617
+ */
2618
+ revision: number;
2619
+ /**
2620
+ * Frozen Pipeline configuration.
2621
+ */
2622
+ config: object;
2623
+ };
2624
+ /**
2625
+ * Memory Pipeline Run Sample
2626
+ */
2627
+ export type MemoryPipelineRunSample = {
2628
+ /**
2629
+ * Sample identifier unique within the run.
2630
+ */
2631
+ id: string;
2632
+ /**
2633
+ * Frozen scenario-specific sample input.
2634
+ */
2635
+ data: object;
2636
+ };
2637
+ /**
2638
+ * Memory Pipeline Run Result
2639
+ */
2640
+ export type MemoryPipelineRunResult = {
2641
+ /**
2642
+ * Sample identifier.
2643
+ */
2644
+ sampleId: string;
2645
+ /**
2646
+ * Candidate Pipeline ID.
2647
+ */
2648
+ pipelineId: string;
2649
+ /**
2650
+ * Frozen candidate version ID.
2651
+ */
2652
+ versionId: string;
2653
+ /**
2654
+ * Outcome of this candidate and sample.
2655
+ */
2656
+ status: MemoryPipelineRunResultStatus;
2657
+ /**
2658
+ * Elapsed execution time in milliseconds.
2659
+ */
2660
+ durationMs: number;
2661
+ /**
2662
+ * Historical baseline shared by candidates for this sample, in UTC.
2663
+ */
2664
+ baselineAt: string;
2665
+ /**
2666
+ * Step objects with id, status, optional reason and scenario-specific output. Output may be an object or an array.
2667
+ */
2668
+ steps: object[];
2669
+ /**
2670
+ * Failure detail when the sample failed.
2671
+ */
2672
+ error?: MemoryPipelineRunError;
2673
+ };
2674
+ /**
2675
+ * Memory Pipeline Run
2676
+ */
2677
+ export type MemoryPipelineRun = {
2678
+ /**
2679
+ * Trial run ID.
2680
+ */
2681
+ runId: string;
2682
+ /**
2683
+ * Trial run name.
2684
+ */
2685
+ name: string;
2686
+ /**
2687
+ * Shared candidate scenario.
2688
+ */
2689
+ scenario: MemoryPipelineRunScenario;
2690
+ /**
2691
+ * Run status. Completed runs may contain failed individual results.
2692
+ */
2693
+ status: MemoryPipelineRunStatus;
2694
+ /**
2695
+ * Run acceptance time in UTC.
2696
+ */
2697
+ createdAt: string;
2698
+ /**
2699
+ * Last progress update time in UTC.
2700
+ */
2701
+ updatedAt: string;
2702
+ /**
2703
+ * Total candidate and sample combinations.
2704
+ */
2705
+ total: number;
2706
+ /**
2707
+ * Finished combinations, including failures.
2708
+ */
2709
+ completed: number;
2710
+ /**
2711
+ * Successful combinations.
2712
+ */
2713
+ succeeded: number;
2714
+ /**
2715
+ * Failed combinations.
2716
+ */
2717
+ failed: number;
2718
+ /**
2719
+ * Frozen candidate configurations.
2720
+ */
2721
+ candidates: MemoryPipelineRunCandidate[];
2722
+ /**
2723
+ * Frozen sample inputs.
2724
+ */
2725
+ samples: MemoryPipelineRunSample[];
2726
+ /**
2727
+ * Available results, including completed results while the run is still running.
2728
+ */
2729
+ results: MemoryPipelineRunResult[];
2730
+ /**
2731
+ * Run-level failure detail.
2732
+ */
2733
+ error?: MemoryPipelineRunError;
2734
+ };
2735
+ /**
2736
+ * Memory Pipeline Run List
2737
+ */
2738
+ export type MemoryPipelineRunList = {
2739
+ /**
2740
+ * Pipeline trial runs.
2741
+ */
2742
+ runs: MemoryPipelineRun[];
2743
+ /**
2744
+ * Number of trial runs matching the scenario.
2745
+ */
2746
+ total: number;
2747
+ /**
2748
+ * Opaque cursor for the next page, or empty when exhausted.
2749
+ */
2750
+ nextCursor: string;
2751
+ };
2752
+ /**
2753
+ * LLMGatewayModel
2754
+ */
2755
+ export type LlmGatewayModel = {
2756
+ /**
2757
+ * Model ID.
2758
+ */
2759
+ $id: string;
2760
+ /**
2761
+ * Object type (always "model").
2762
+ */
2763
+ object: string;
2764
+ /**
2765
+ * Unix timestamp of when the upstream was created.
2766
+ */
2767
+ created: number;
2768
+ /**
2769
+ * Provider that owns this model.
2770
+ */
2771
+ ownedBy: string;
2772
+ /**
2773
+ * Supported capabilities: chat, embedding, rerank, vlm.
2774
+ */
2775
+ capabilities: string[];
2776
+ /**
2777
+ * Whether this model is currently active.
2778
+ */
2779
+ active: boolean;
2780
+ /**
2781
+ * Model source: project, platformTrial, or mixed.
2782
+ */
2783
+ source?: string;
2784
+ /**
2785
+ * Safe projections of the available model sources.
2786
+ */
2787
+ sources?: object[];
2788
+ /**
2789
+ * Resolved per-model metadata (stored provider metadata merged over the built-in preset catalog) when available.
2790
+ */
2791
+ metadata?: object;
2792
+ /**
2793
+ * Current account-model trial quota when a platform trial source is available.
2794
+ */
2795
+ trialQuota?: object;
2796
+ };
2797
+ /**
2798
+ * LLM Gateway Model list
2799
+ */
2800
+ export type LlmGatewayModelList = {
2801
+ /**
2802
+ * Total number of models that matched your query.
2803
+ */
2804
+ total: number;
2805
+ /**
2806
+ * List of models.
2807
+ */
2808
+ models: LlmGatewayModel[];
2809
+ };
2810
+ /**
2811
+ * LLMGatewayEmbeddingResponse
2812
+ */
2813
+ export type LlmGatewayEmbeddingResponse = {
2814
+ /**
2815
+ * Object type (always "list").
2816
+ */
2817
+ object: string;
2818
+ /**
2819
+ * Model used to generate embeddings.
2820
+ */
2821
+ model: string;
2822
+ /**
2823
+ * List of embedding objects.
2824
+ */
2825
+ data: object[];
2826
+ /**
2827
+ * Token usage information.
2828
+ */
2829
+ usage: object;
2830
+ };
2831
+ /**
2832
+ * LLMGatewayRerankResponse
2833
+ */
2834
+ export type LlmGatewayRerankResponse = {
2835
+ /**
2836
+ * Model used for reranking.
2837
+ */
2838
+ model: string;
2839
+ /**
2840
+ * Reranked results with relevance scores.
2841
+ */
2842
+ results: object[];
2843
+ /**
2844
+ * Token usage information.
2845
+ */
2846
+ usage: object;
2847
+ };
2848
+ /**
2849
+ * KnowledgeBaseDocument
2850
+ */
2851
+ export type KnowledgeBaseDocument = {
2852
+ /**
2853
+ * Document ID.
2854
+ */
2855
+ $id: string;
2856
+ /**
2857
+ * Document creation date (ISO 8601).
2858
+ */
2859
+ $createdAt: string;
2860
+ /**
2861
+ * Document update date (ISO 8601).
2862
+ */
2863
+ $updatedAt: string;
2864
+ /**
2865
+ * Knowledge base ID this document belongs to.
2866
+ */
2867
+ kbId: string;
2868
+ /**
2869
+ * Knowledge Base Version ID for Version-scoped documents.
2870
+ */
2871
+ versionId?: string;
2872
+ /**
2873
+ * Document name.
2874
+ */
2875
+ name: string;
2876
+ /**
2877
+ * Storage bucket ID holding the uploaded file.
2878
+ */
2879
+ bucketId: string;
2880
+ /**
2881
+ * Storage file ID of the uploaded file.
2882
+ */
2883
+ fileId: string;
2884
+ /**
2885
+ * MIME type of the uploaded file.
2886
+ */
2887
+ mimeType: string;
2888
+ /**
2889
+ * Document source. `manual` for direct upload, or `datasource:{id}` for synced items.
2890
+ */
2891
+ source: string;
2892
+ /**
2893
+ * External system item ID for datasource sync deduplication.
2894
+ */
2895
+ externalItemId?: string;
2896
+ /**
2897
+ * Optional document-level chunking strategy override. sheet is only for Excel .xls/.xlsx documents and splits each non-empty worksheet within token and storage budgets without crossing worksheet boundaries.
2898
+ */
2899
+ parserId?: string;
2900
+ /**
2901
+ * Optional document-level parser/chunker configuration override.
2902
+ */
2903
+ parserConfig?: object;
2904
+ /**
2905
+ * Optional business metadata.
2906
+ */
2907
+ metadata: object;
2908
+ /**
2909
+ * Document processing status: `uploaded`, `processing`, `ready`, or `failed`.
2910
+ */
2911
+ status: string;
2912
+ /**
2913
+ * Whether the document is enabled and eligible for search retrieval. Disabled documents are excluded from knowledge base search results.
2914
+ */
2915
+ enabled: boolean;
2916
+ /**
2917
+ * Mirrored stage from the active ingestion task.
2918
+ */
2919
+ stage?: string;
2920
+ /**
2921
+ * Current or most recent ingestion ID.
2922
+ */
2923
+ activeIngestionId?: string;
2924
+ /**
2925
+ * Search-visible generation. Only valid when status is ready.
2926
+ */
2927
+ activeGeneration?: string;
2928
+ /**
2929
+ * Timestamp when processing was last triggered.
2930
+ */
2931
+ processingStartedAt?: string;
2932
+ /**
2933
+ * Total number of chunks expected, once known.
2934
+ */
2935
+ chunksTotal?: number;
2936
+ /**
2937
+ * Number of chunks in the active generation.
2938
+ */
2939
+ chunkCount: number;
2940
+ /**
2941
+ * Last processing error message, if any.
2942
+ */
2943
+ error?: string;
2944
+ /**
2945
+ * Deprecated. Legacy Function execution ID.
2946
+ */
2947
+ lastExecutionId?: string;
2948
+ };
2949
+ /**
2950
+ * KnowledgeBaseDataSource
2951
+ */
2952
+ export type KnowledgeBaseDataSource = {
2953
+ /**
2954
+ * Data source ID.
2955
+ */
2956
+ $id: string;
2957
+ /**
2958
+ * Data source creation date (ISO 8601).
2959
+ */
2960
+ $createdAt: string;
2961
+ /**
2962
+ * Data source update date (ISO 8601).
2963
+ */
2964
+ $updatedAt: string;
2965
+ /**
2966
+ * Knowledge base ID this data source is bound to.
2967
+ */
2968
+ kbId: string;
2969
+ /**
2970
+ * Knowledge base Version ID. Null for legacy data sources.
2971
+ */
2972
+ versionId?: string;
2973
+ /**
2974
+ * Data source type.
2975
+ */
2976
+ type: string;
2977
+ /**
2978
+ * Data source name.
2979
+ */
2980
+ name: string;
2981
+ /**
2982
+ * Non-sensitive data source configuration.
2983
+ */
2984
+ config: object;
2985
+ /**
2986
+ * Sensitive credentials metadata. Secret values are never returned.
2987
+ */
2988
+ credentials: object;
2989
+ /**
2990
+ * Data source status: active, disabled, or error.
2991
+ */
2992
+ status: string;
2993
+ /**
2994
+ * Last sync completion timestamp.
2995
+ */
2996
+ lastSyncAt?: string;
2997
+ /**
2998
+ * Last sync status.
2999
+ */
3000
+ lastSyncStatus?: string;
3001
+ /**
3002
+ * Incremental sync cursor.
3003
+ */
3004
+ lastCursor?: string;
3005
+ /**
3006
+ * Last data source error message, if any.
3007
+ */
3008
+ error?: string;
3009
+ };
3010
+ /**
3011
+ * Knowledge Base Data Source list
3012
+ */
3013
+ export type KnowledgeBaseDataSourceList = {
3014
+ /**
3015
+ * Total number of dataSources that matched your query.
3016
+ */
3017
+ total: number;
3018
+ /**
3019
+ * List of dataSources.
3020
+ */
3021
+ dataSources: KnowledgeBaseDataSource[];
3022
+ };
3023
+ /**
3024
+ * KnowledgeBaseDataSourceDocumentImportResult
3025
+ */
3026
+ export type KnowledgeBaseDataSourceDocumentImportResult = {
3027
+ /**
3028
+ * Requested Yuque document URL.
3029
+ */
3030
+ url: string;
3031
+ /**
3032
+ * Per-URL import outcome: accepted, unchanged, or failed.
3033
+ */
3034
+ status: KnowledgeBaseDataSourceDocumentImportResultStatus;
3035
+ /**
3036
+ * Imported knowledge base document when status is accepted or unchanged.
3037
+ */
3038
+ document?: KnowledgeBaseDocument;
3039
+ /**
3040
+ * Human-readable failure detail when status is failed.
3041
+ */
3042
+ error?: string;
3043
+ /**
3044
+ * Machine-readable Agentbase exception type when status is failed.
3045
+ */
3046
+ errorType?: string;
3047
+ };
3048
+ /**
3049
+ * KnowledgeBaseDataSourceDocumentImportBatch
3050
+ */
3051
+ export type KnowledgeBaseDataSourceDocumentImportBatch = {
3052
+ /**
3053
+ * Number of URLs processed.
3054
+ */
3055
+ total: number;
3056
+ /**
3057
+ * URLs that created or updated a document and queued ingestion.
3058
+ */
3059
+ accepted: number;
3060
+ /**
3061
+ * URLs whose remote content was already processing or ready.
3062
+ */
3063
+ unchanged: number;
3064
+ /**
3065
+ * URLs that failed validation or import.
3066
+ */
3067
+ failed: number;
3068
+ /**
3069
+ * Per-URL import results in request order.
3070
+ */
3071
+ results: KnowledgeBaseDataSourceDocumentImportResult[];
3072
+ };
3073
+ /**
3074
+ * A staged database transaction operation.
3075
+ */
3076
+ export type DatabaseTransactionOperation = {
3077
+ /**
3078
+ * Database ID.
3079
+ */
3080
+ databaseId: string;
3081
+ /**
3082
+ * Collection ID.
3083
+ */
3084
+ collectionId: string;
3085
+ /**
3086
+ * Operation action.
3087
+ */
3088
+ action: TransactionAction;
3089
+ /**
3090
+ * Document ID.
3091
+ */
3092
+ documentId?: string;
3093
+ /**
3094
+ * Operation-specific JSON object or array.
3095
+ */
3096
+ data?: object;
3097
+ };
3098
+ /**
3099
+ * A staged database transaction operation.
3100
+ */
3101
+ export type TablesDBTransactionOperation = {
3102
+ /**
3103
+ * Database ID.
3104
+ */
3105
+ databaseId: string;
3106
+ /**
3107
+ * Table ID.
3108
+ */
3109
+ tableId: string;
3110
+ /**
3111
+ * Operation action.
3112
+ */
3113
+ action: TransactionAction;
3114
+ /**
3115
+ * Row ID.
3116
+ */
3117
+ rowId?: string;
3118
+ /**
3119
+ * Operation-specific JSON object or array.
3120
+ */
3121
+ data?: object;
3122
+ };
3123
+ /**
3124
+ * A staged database transaction operation.
3125
+ */
3126
+ export type DocumentsDBTransactionOperation = {
3127
+ /**
3128
+ * Database ID.
3129
+ */
3130
+ databaseId: string;
3131
+ /**
3132
+ * Collection ID.
3133
+ */
3134
+ collectionId: string;
3135
+ /**
3136
+ * Operation action.
3137
+ */
3138
+ action: TransactionAction;
3139
+ /**
3140
+ * Document ID.
3141
+ */
3142
+ documentId?: string;
3143
+ /**
3144
+ * Operation-specific JSON object or array.
3145
+ */
3146
+ data?: object;
3147
+ };
3148
+ /**
3149
+ * Bounded read-only REST row query.
3150
+ */
3151
+ export type DataApiRestRowsQuery = {
3152
+ /**
3153
+ *
3154
+ */
3155
+ fields: string[];
3156
+ /**
3157
+ *
3158
+ */
3159
+ filter?: object;
3160
+ /**
3161
+ *
3162
+ */
3163
+ filterLogic?: DataApiFilterLogic;
3164
+ /**
3165
+ *
3166
+ */
3167
+ sort?: object[];
3168
+ /**
3169
+ *
3170
+ */
3171
+ limit?: number;
3172
+ /**
3173
+ *
3174
+ */
3175
+ offset?: number;
3176
+ /**
3177
+ *
3178
+ */
3179
+ page?: number;
3180
+ /**
3181
+ *
3182
+ */
3183
+ after?: string;
3184
+ };
3185
+ /**
3186
+ * Bounded read-only REST aggregate query.
3187
+ */
3188
+ export type DataApiRestAggregatesQuery = {
3189
+ /**
3190
+ *
3191
+ */
3192
+ metrics: object[];
3193
+ /**
3194
+ *
3195
+ */
3196
+ filter?: object;
3197
+ /**
3198
+ *
3199
+ */
3200
+ filterLogic?: DataApiFilterLogic;
3201
+ /**
3202
+ *
3203
+ */
3204
+ groupBy?: object[];
3205
+ /**
3206
+ *
3207
+ */
3208
+ sort?: object[];
3209
+ /**
3210
+ *
3211
+ */
3212
+ limit?: number;
3213
+ /**
3214
+ *
3215
+ */
3216
+ offset?: number;
3217
+ /**
3218
+ *
3219
+ */
3220
+ page?: number;
3221
+ };
3222
+ /**
3223
+ * A role and text content pair used as memory source evidence.
3224
+ */
3225
+ export type MemoryMessage = {
3226
+ /**
3227
+ * Message author role.
3228
+ */
3229
+ role: MemoryMessageRole;
3230
+ /**
3231
+ * Message text content.
3232
+ */
3233
+ content: string;
3234
+ };
3235
+ /**
3236
+ * A bounded memory batch operation.
3237
+ */
3238
+ export type MemoryBatchItem = {
3239
+ /**
3240
+ * Batch operation type.
3241
+ */
3242
+ operation: MemoryBatchOperation;
3243
+ /**
3244
+ * Create-memory request.
3245
+ */
3246
+ create?: object;
3247
+ /**
3248
+ * Delete-memory request.
3249
+ */
3250
+ delete?: object;
3251
+ /**
3252
+ * Search-memory request.
3253
+ */
3254
+ search?: object;
3255
+ };
3256
+ /**
3257
+ * A structured memory record to import.
3258
+ */
3259
+ export type MemoryRecordInput = {
3260
+ /**
3261
+ * Target user ID.
3262
+ */
3263
+ userId: string;
3264
+ /**
3265
+ * Memory visibility scope.
3266
+ */
3267
+ scope: MemoryScope;
3268
+ /**
3269
+ * Memory type.
3270
+ */
3271
+ memoryType: string;
3272
+ /**
3273
+ * Memory record kind.
3274
+ */
3275
+ recordKind: MemoryRecordKind;
3276
+ /**
3277
+ * Optional original conversation context. For intelligent historical import, set infer=true. Missing time stays unknown, never the import or event date.
3278
+ */
3279
+ sourceContext?: object;
3280
+ /**
3281
+ * Memory content.
3282
+ */
3283
+ content?: string;
3284
+ /**
3285
+ * Optional role and content messages.
3286
+ */
3287
+ messages?: object[];
3288
+ /**
3289
+ * Optional agent ID.
3290
+ */
3291
+ agentId?: string;
3292
+ /**
3293
+ * Optional run ID.
3294
+ */
3295
+ runId?: string;
3296
+ /**
3297
+ * Optional source session ID.
3298
+ */
3299
+ sessionId?: string;
3300
+ /**
3301
+ * Content classification.
3302
+ */
3303
+ sensitivity?: MemoryRecordSensitivity;
3304
+ /**
3305
+ * Processing restriction.
3306
+ */
3307
+ handlingPolicy?: MemoryHandlingPolicy;
3308
+ /**
3309
+ * Arbitrary memory metadata.
3310
+ */
3311
+ metadata?: object;
3312
+ /**
3313
+ * Whether to infer derived memories.
3314
+ */
3315
+ infer?: boolean;
3316
+ /**
3317
+ * Whether to create new evidence for forgotten content.
3318
+ */
3319
+ reRemember?: boolean;
3320
+ };
3321
+ /**
3322
+ * A bounded text message used as distillation evidence.
3323
+ */
3324
+ export type DistillationMessage = {
3325
+ /**
3326
+ * Message author role.
3327
+ */
3328
+ role: DistillationMessageRole;
3329
+ /**
3330
+ * Message text content.
3331
+ */
3332
+ content: string;
3333
+ /**
3334
+ * Optional participant name.
3335
+ */
3336
+ name?: string;
3337
+ };
3338
+ /**
3339
+ * A redacted tool invocation used as distillation evidence.
3340
+ */
3341
+ export type DistillationToolEvent = {
3342
+ /**
3343
+ * Unique event ID.
3344
+ */
3345
+ eventId: string;
3346
+ /**
3347
+ * Tool name.
3348
+ */
3349
+ name: string;
3350
+ /**
3351
+ * Tool execution status.
3352
+ */
3353
+ status: DistillationToolStatus;
3354
+ /**
3355
+ * JSON-compatible tool arguments.
3356
+ */
3357
+ arguments?: object;
3358
+ /**
3359
+ * JSON-compatible tool result.
3360
+ */
3361
+ result?: object;
3362
+ /**
3363
+ * Failure message.
3364
+ */
3365
+ error?: string;
3366
+ };
3367
+ export {};
3368
+ }