@lessly/sdk-app 76.0.0 → 77.0.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.
@@ -71146,13 +71146,7 @@ export type BrainClickupSpacesListOutput = {
71146
71146
  export interface BrainCognitionDigestInput {
71147
71147
  }
71148
71148
  export interface BrainCognitionDigestOutput {
71149
- /**
71150
- * Id of the queued run. The completion event carries the same `run_id`, which is how a waiting step ties the event back to this call; brain_cognition_status reports the same run.
71151
- */
71152
71149
  run_id: string;
71153
- /**
71154
- * Always true — the run was queued. The call fails outright rather than reporting a false here.
71155
- */
71156
71150
  accepted: true;
71157
71151
  }
71158
71152
  export interface BrainCognitionStatusInput {
@@ -71185,13 +71179,7 @@ export interface BrainCognitionStatusOutput {
71185
71179
  export interface BrainCognitionSweepInput {
71186
71180
  }
71187
71181
  export interface BrainCognitionSweepOutput {
71188
- /**
71189
- * Id of the queued run. The completion event carries the same `run_id`, which is how a waiting step ties the event back to this call; brain_cognition_status reports the same run.
71190
- */
71191
71182
  run_id: string;
71192
- /**
71193
- * Always true — the run was queued. The call fails outright rather than reporting a false here.
71194
- */
71195
71183
  accepted: true;
71196
71184
  }
71197
71185
  export interface BrainConnectorBranchesListInput {
@@ -71221,9 +71209,6 @@ export type BrainConnectorReposListOutput = {
71221
71209
  defaultBranch: string;
71222
71210
  }[];
71223
71211
  export interface BrainDaemonBatchStatusInput {
71224
- /**
71225
- * Id of the ingestion daemon to act on, as returned by brain_daemons_list
71226
- */
71227
71212
  id: string;
71228
71213
  }
71229
71214
  export interface BrainDaemonBatchStatusOutput {
@@ -71307,9 +71292,6 @@ export interface BrainDaemonCreateOutput {
71307
71292
  unmeasuredCount: number;
71308
71293
  }
71309
71294
  export interface BrainDaemonGetInput {
71310
- /**
71311
- * Id of the ingestion daemon to act on, as returned by brain_daemons_list
71312
- */
71313
71295
  id: string;
71314
71296
  }
71315
71297
  export interface BrainDaemonGetOutput {
@@ -71333,154 +71315,52 @@ export interface BrainDaemonGetOutput {
71333
71315
  unmeasuredCount: number;
71334
71316
  }
71335
71317
  export interface BrainDaemonReingestInput {
71336
- /**
71337
- * Id of the ingestion daemon that owns these documents, as returned by brain_daemons_list
71338
- */
71339
71318
  id: string;
71340
71319
  /**
71341
- * Source paths to re-ingest, exactly as the daemon recorded them (a repo path such as docs/spec.md, a Drive file id, a ClickUp item id). 1-100 per call.
71342
- *
71343
71320
  * @minItems 1
71344
71321
  * @maxItems 100
71345
71322
  */
71346
71323
  paths: [string, ...(string)[]];
71347
71324
  }
71348
71325
  export interface BrainDaemonReingestOutput {
71349
- /**
71350
- * The run started to pick the cleared paths up — brain/daemon.run-completed for this id is what finishes the step. Null when no run was started (see triggered/triggerError).
71351
- */
71352
- runId: (string | null);
71353
- /**
71354
- * Paths whose ingest state was cleared, so the next run will read them again from scratch
71355
- */
71356
71326
  cleared: string[];
71357
- /**
71358
- * Paths this daemon has no ingest record for — usually a typo, or a document it never ingested
71359
- */
71360
71327
  notFound: string[];
71361
- /**
71362
- * True when a run was started to pick the cleared paths up; false when the daemon is paused, a run is already in flight, or nothing was eligible
71363
- */
71364
71328
  triggered: boolean;
71365
- /**
71366
- * Why no run was started; absent when one was
71367
- */
71368
71329
  triggerError?: string;
71369
- /**
71370
- * Paths left alone because they are in an unfinished batch; re-ask once that run has finished
71371
- */
71372
71330
  skippedPending: string[];
71373
71331
  }
71374
71332
  export interface BrainDaemonRemoveInput {
71375
- /**
71376
- * Id of the ingestion daemon to act on, as returned by brain_daemons_list
71377
- */
71378
71333
  id: string;
71379
71334
  }
71380
71335
  export interface BrainDaemonRemoveOutput {
71381
71336
  ok: true;
71382
71337
  }
71383
71338
  export interface BrainDaemonRunInput {
71384
- /**
71385
- * Id of the ingestion daemon to act on, as returned by brain_daemons_list
71386
- */
71387
71339
  id: string;
71388
71340
  }
71389
71341
  export interface BrainDaemonRunOutput {
71390
- /**
71391
- * True once the run has finished, whether it succeeded or failed
71392
- */
71393
71342
  done: boolean;
71394
- /**
71395
- * Id of the run being reported; null when this daemon has never run
71396
- */
71397
71343
  runId: (string | null);
71398
- /**
71399
- * Where the run stands: 'queued' waiting to start, 'running' in progress, 'done' finished, 'failed' gave up, 'none' this daemon has never run
71400
- */
71401
71344
  status: ("queued" | "running" | "done" | "failed" | "none");
71402
- /**
71403
- * Per-source progress as the connector reported it; the shape differs by connector type and is meant for display, not for binding a step to
71404
- */
71405
71345
  sources: unknown[];
71406
- /**
71407
- * Document counts for the run; null when nothing has been counted yet
71408
- */
71409
71346
  progress: ({
71410
- /**
71411
- * Totals for the whole run
71412
- */
71413
- counts: {
71414
- /**
71415
- * Documents that failed after retries — transient failures, worth re-running
71416
- */
71417
- error: number;
71418
- /**
71419
- * Documents the source permanently refused (403/404/401) — a permissions or deletion problem, not a transient one
71420
- */
71421
- denied: number;
71422
- /**
71423
- * Of those, how many were downloaded
71424
- */
71425
- fetched: number;
71426
- /**
71427
- * Of those, how many became memories
71428
- */
71429
- ingested: number;
71430
- /**
71431
- * Documents the run found at the source
71432
- */
71433
- discovered: number;
71434
- /**
71435
- * Documents skipped because their content had not changed since the last run
71436
- */
71437
- skippedUnchanged: number;
71438
- };
71439
- /**
71440
- * The same totals split by source category; the keys are the connector's own (github: markdown/issues/pulls, clickup: tasks/comments/docs/chat, gdrive: files)
71441
- */
71347
+ counts: BrainDaemonRunOutputCounts;
71442
71348
  byCategory: {
71443
- [k: string]: {
71444
- /**
71445
- * Documents that failed after retries — transient failures, worth re-running
71446
- */
71447
- error: number;
71448
- /**
71449
- * Documents the source permanently refused (403/404/401) — a permissions or deletion problem, not a transient one
71450
- */
71451
- denied: number;
71452
- /**
71453
- * Of those, how many were downloaded
71454
- */
71455
- fetched: number;
71456
- /**
71457
- * Of those, how many became memories
71458
- */
71459
- ingested: number;
71460
- /**
71461
- * Documents the run found at the source
71462
- */
71463
- discovered: number;
71464
- /**
71465
- * Documents skipped because their content had not changed since the last run
71466
- */
71467
- skippedUnchanged: number;
71468
- };
71349
+ [k: string]: BrainDaemonRunOutputCounts;
71469
71350
  };
71470
71351
  } | null);
71471
- /**
71472
- * Which lane the run went to: 'realtime' finishes in minutes, 'batch' queues the work with the model provider and can take hours
71473
- */
71474
71352
  routedTo: ("realtime" | "batch");
71475
- /**
71476
- * True when this call actually started a run; false when one was already in flight and nothing new was started
71477
- */
71478
71353
  triggered: boolean;
71479
- /**
71480
- * Why the run could not be started; absent when it was started
71481
- */
71482
71354
  triggerError?: string;
71483
71355
  }
71356
+ export interface BrainDaemonRunOutputCounts {
71357
+ error: number;
71358
+ denied: number;
71359
+ fetched: number;
71360
+ ingested: number;
71361
+ discovered: number;
71362
+ skippedUnchanged: number;
71363
+ }
71484
71364
  export interface BrainDaemonRunItemsInput {
71485
71365
  limit?: number;
71486
71366
  runId: string;
@@ -71498,208 +71378,64 @@ export interface BrainDaemonRunItemsOutput {
71498
71378
  }[];
71499
71379
  runId: string;
71500
71380
  counts: {
71501
- /**
71502
- * Documents that failed after retries — transient failures, worth re-running
71503
- */
71504
71381
  error: number;
71505
- /**
71506
- * Documents the source permanently refused (403/404/401) — a permissions or deletion problem, not a transient one
71507
- */
71508
71382
  denied: number;
71509
- /**
71510
- * Of those, how many were downloaded
71511
- */
71512
71383
  fetched: number;
71513
- /**
71514
- * Of those, how many became memories
71515
- */
71516
71384
  ingested: number;
71517
- /**
71518
- * Documents the run found at the source
71519
- */
71520
71385
  discovered: number;
71521
- /**
71522
- * Documents skipped because their content had not changed since the last run
71523
- */
71524
71386
  skippedUnchanged: number;
71525
71387
  };
71526
71388
  nextCursor: (string | null);
71527
71389
  }
71528
71390
  export interface BrainDaemonRunsInput {
71529
- /**
71530
- * Id of the ingestion daemon whose run history to read, as returned by brain_daemons_list
71531
- */
71532
71391
  id: string;
71533
- /**
71534
- * How many of the most recent runs to return (default 20, max 100)
71535
- */
71536
71392
  limit?: number;
71537
71393
  }
71538
71394
  export interface BrainDaemonRunsOutput {
71539
- /**
71540
- * The most recent runs, newest first
71541
- */
71542
71395
  runs: {
71543
- /**
71544
- * How the run was carried out: 'realtime' inline, 'batch' through the model provider's batch queue, 'reclaimed' a stalled run closed out by the janitor
71545
- */
71546
71396
  lane: ("realtime" | "batch" | "reclaimed");
71547
- /**
71548
- * Id of this run
71549
- */
71550
71397
  runId: string;
71551
- /**
71552
- * Document counts for this run
71553
- */
71554
71398
  counts: {
71555
- /**
71556
- * Documents that failed after retries — transient failures, worth re-running
71557
- */
71558
71399
  error: number;
71559
- /**
71560
- * Documents the source permanently refused (403/404/401) — a permissions or deletion problem, not a transient one
71561
- */
71562
71400
  denied: number;
71563
- /**
71564
- * Of those, how many were downloaded
71565
- */
71566
71401
  fetched: number;
71567
- /**
71568
- * Of those, how many became memories
71569
- */
71570
71402
  ingested: number;
71571
- /**
71572
- * Documents the run found at the source
71573
- */
71574
71403
  discovered: number;
71575
- /**
71576
- * Documents skipped because their content had not changed since the last run
71577
- */
71578
71404
  skippedUnchanged: number;
71579
71405
  };
71580
- /**
71581
- * Where the run ended up — 'queued', 'running', 'done' or 'failed'
71582
- */
71583
71406
  status: string;
71584
- /**
71585
- * How a batch run finished, in the batch pipeline's own words (e.g. finalized, timeout, crash); null for a realtime run
71586
- */
71587
71407
  outcome: (string | null);
71588
- /**
71589
- * When the run started, ISO 8601 timestamp
71590
- */
71591
71408
  startedAt: string;
71592
- /**
71593
- * Documents that failed after retries during this run
71594
- */
71595
71409
  errorCount: number;
71596
- /**
71597
- * When the run finished, ISO 8601 timestamp; null while it is still going
71598
- */
71599
71410
  finishedAt: (string | null);
71600
- /**
71601
- * Documents the source permanently refused during this run
71602
- */
71603
71411
  deniedCount: number;
71604
- /**
71605
- * Documents stored as raw text because the extraction step failed — NULL MEANS NOT MEASURED, never "clean": only realtime runs measure this, so every batch and reclaimed run reports null
71606
- */
71607
71412
  degradedCount: (number | null);
71608
71413
  }[];
71609
- /**
71610
- * Id of the daemon these runs belong to
71611
- */
71612
71414
  daemonId: string;
71613
71415
  }
71614
71416
  export interface BrainDaemonStatusInput {
71615
- /**
71616
- * Id of the ingestion daemon to act on, as returned by brain_daemons_list
71617
- */
71618
71417
  id: string;
71619
71418
  }
71620
71419
  export interface BrainDaemonStatusOutput {
71621
- /**
71622
- * True once the run has finished, whether it succeeded or failed
71623
- */
71624
71420
  done: boolean;
71625
- /**
71626
- * Id of the run being reported; null when this daemon has never run
71627
- */
71628
71421
  runId: (string | null);
71629
- /**
71630
- * Where the run stands: 'queued' waiting to start, 'running' in progress, 'done' finished, 'failed' gave up, 'none' this daemon has never run
71631
- */
71632
71422
  status: ("queued" | "running" | "done" | "failed" | "none");
71633
- /**
71634
- * Per-source progress as the connector reported it; the shape differs by connector type and is meant for display, not for binding a step to
71635
- */
71636
71423
  sources: unknown[];
71637
- /**
71638
- * Document counts for the run; null when nothing has been counted yet
71639
- */
71640
71424
  progress: ({
71641
- /**
71642
- * Totals for the whole run
71643
- */
71644
- counts: {
71645
- /**
71646
- * Documents that failed after retries — transient failures, worth re-running
71647
- */
71648
- error: number;
71649
- /**
71650
- * Documents the source permanently refused (403/404/401) — a permissions or deletion problem, not a transient one
71651
- */
71652
- denied: number;
71653
- /**
71654
- * Of those, how many were downloaded
71655
- */
71656
- fetched: number;
71657
- /**
71658
- * Of those, how many became memories
71659
- */
71660
- ingested: number;
71661
- /**
71662
- * Documents the run found at the source
71663
- */
71664
- discovered: number;
71665
- /**
71666
- * Documents skipped because their content had not changed since the last run
71667
- */
71668
- skippedUnchanged: number;
71669
- };
71670
- /**
71671
- * The same totals split by source category; the keys are the connector's own (github: markdown/issues/pulls, clickup: tasks/comments/docs/chat, gdrive: files)
71672
- */
71425
+ counts: BrainDaemonStatusOutputCounts;
71673
71426
  byCategory: {
71674
- [k: string]: {
71675
- /**
71676
- * Documents that failed after retries — transient failures, worth re-running
71677
- */
71678
- error: number;
71679
- /**
71680
- * Documents the source permanently refused (403/404/401) — a permissions or deletion problem, not a transient one
71681
- */
71682
- denied: number;
71683
- /**
71684
- * Of those, how many were downloaded
71685
- */
71686
- fetched: number;
71687
- /**
71688
- * Of those, how many became memories
71689
- */
71690
- ingested: number;
71691
- /**
71692
- * Documents the run found at the source
71693
- */
71694
- discovered: number;
71695
- /**
71696
- * Documents skipped because their content had not changed since the last run
71697
- */
71698
- skippedUnchanged: number;
71699
- };
71427
+ [k: string]: BrainDaemonStatusOutputCounts;
71700
71428
  };
71701
71429
  } | null);
71702
71430
  }
71431
+ export interface BrainDaemonStatusOutputCounts {
71432
+ error: number;
71433
+ denied: number;
71434
+ fetched: number;
71435
+ ingested: number;
71436
+ discovered: number;
71437
+ skippedUnchanged: number;
71438
+ }
71703
71439
  export interface BrainDaemonUpdateInput {
71704
71440
  id: string;
71705
71441
  name?: (string | null);
@@ -71785,121 +71521,46 @@ export interface BrainKnowledgeEntityMemoriesInput {
71785
71521
  entity_ref: string;
71786
71522
  }
71787
71523
  export interface BrainKnowledgeEntityMemoriesOutput {
71788
- /**
71789
- * How many memories back this entity in total, across all pages
71790
- */
71791
71524
  total: number;
71792
- /**
71793
- * The entity the memories belong to; null when `entity_ref` matched nothing
71794
- */
71795
71525
  entity: ({
71796
- /**
71797
- * How closely this entity matches the query, higher is closer; absent on an unscored read such as a plain type filter
71798
- */
71799
71526
  score?: number;
71800
- /**
71801
- * Other names the same entity appears under in the ingested text
71802
- */
71803
71527
  aliases: string[];
71804
- /**
71805
- * Id of this entity; pass it as `entity_ref` to brain_knowledge_neighborhood or brain_knowledge_entity_memories
71806
- */
71807
71528
  entity_id: string;
71808
- /**
71809
- * What the entity is, as the engine summarised it from the memories mentioning it; null when it has not written one
71810
- */
71811
71529
  description: (string | null);
71812
- /**
71813
- * Ontology type of the entity, e.g. Feature, Decision, Risk, Integration
71814
- */
71815
71530
  entity_type: string;
71816
- /**
71817
- * The name to show a person — usually the spelling the source text used
71818
- */
71819
71531
  display_name: string;
71820
- /**
71821
- * The one name this entity is stored under; use it when matching entities against each other
71822
- */
71823
71532
  canonical_name: string;
71824
- /**
71825
- * How many memories mention this entity — a rough measure of how well attested it is
71826
- */
71827
71533
  evidence_count: number;
71828
71534
  } | null);
71829
- /**
71830
- * One page of the memories this entity was drawn from — the same shape brain_memory_list returns
71831
- */
71832
71535
  memories: {
71833
71536
  /**
71834
71537
  * Consumer-facing label derived from the layer; 'unknown' for an unrecognised layer
71835
71538
  */
71836
71539
  kind: ("schema" | "intention" | "identity" | "basic" | "fact" | "summary" | "knowledge" | "raw" | "unknown");
71837
- /**
71838
- * Engine tags on this memory; empty when it carries none
71839
- */
71840
71540
  tags: string[];
71841
71541
  /**
71842
71542
  * Engine memory layer (l0_basic_info…l7_intention)
71843
71543
  */
71844
71544
  layer: ("l6_schema" | "l7_intention" | "l4_identity" | "l0_basic_info" | "l2_fact" | "l3_summary" | "l5_knowledge" | "l1_raw");
71845
- /**
71846
- * Free-form metadata, verbatim as the writer passed brain_memory_add's `metadata`; keys are the caller's
71847
- */
71848
71545
  custom: {
71849
71546
  [k: string]: unknown;
71850
71547
  };
71851
- /**
71852
- * Engine lifecycle status of the row — 'active' for a memory in use; superseded rows are not listed
71853
- */
71854
71548
  status: string;
71855
- /**
71856
- * The memory text itself
71857
- */
71858
71549
  content: string;
71859
- /**
71860
- * Engine user namespace the memory was written under
71861
- */
71862
71550
  user_id: string;
71863
- /**
71864
- * Engine agent namespace the memory was written under — the shared pool for a 'shared' write, the caller's own for a private one
71865
- */
71866
71551
  agent_id: string;
71867
- /**
71868
- * When the remembered EVENT happened, epoch milliseconds; null when the writer stated no time
71869
- */
71870
71552
  memory_at: (number | null);
71871
- /**
71872
- * Engine id of this memory; pass it to brain_memory_get, _update or _delete
71873
- */
71874
71553
  memory_id: string;
71875
- /**
71876
- * The engine's own inference about this memory, or null when it recorded none
71877
- */
71878
71554
  speculate: (string | null);
71879
- /**
71880
- * Engine session the memory was written in; empty when the writer opened none
71881
- */
71882
71555
  session_id: string;
71883
- /**
71884
- * When this memory row was written, epoch milliseconds
71885
- */
71886
71556
  gmt_created: number;
71887
71557
  /**
71888
71558
  * Source authority (highest→lowest): policy > official > team > informal
71889
71559
  */
71890
71560
  source_authority: ("policy" | "official" | "team" | "informal");
71891
- /**
71892
- * Id of the l1_raw memory this one was derived from; null when it was written directly
71893
- */
71894
71561
  source_raw_memory_id: (string | null);
71895
71562
  }[];
71896
- /**
71897
- * How long the engine took to answer, milliseconds
71898
- */
71899
71563
  elapsed_ms: number;
71900
- /**
71901
- * Engine request id for this call — quote it when reporting a problem
71902
- */
71903
71564
  request_id: string;
71904
71565
  }
71905
71566
  export interface BrainKnowledgeGraphInput {
@@ -71913,92 +71574,29 @@ export interface BrainKnowledgeGraphInput {
71913
71574
  scope?: ("shared" | "private" | "both");
71914
71575
  }
71915
71576
  export interface BrainKnowledgeGraphOutput {
71916
- /**
71917
- * The typed relations between those entities
71918
- */
71919
71577
  edges: {
71920
- /**
71921
- * Why the engine drew this edge, in its own words; null when it recorded none
71922
- */
71923
71578
  reason: (string | null);
71924
- /**
71925
- * Id of the node the edge points FROM (a `nodes[].id`)
71926
- */
71927
71579
  source: string;
71928
- /**
71929
- * Id of the node the edge points TO (a `nodes[].id`)
71930
- */
71931
71580
  target: string;
71932
- /**
71933
- * True when the relation reads the same in both directions
71934
- */
71935
71581
  symmetric: boolean;
71936
- /**
71937
- * Ontology type of the relation, e.g. depends_on, competes_with, owns
71938
- */
71939
71582
  relation_type: string;
71940
71583
  }[];
71941
- /**
71942
- * The entities in the exported graph
71943
- */
71944
71584
  nodes: {
71945
- /**
71946
- * Id of this entity; the `source` and `target` of an edge refer to it
71947
- */
71948
71585
  id: string;
71949
- /**
71950
- * How many edges touch this node — the hub concepts are the ones kept when the export is truncated
71951
- */
71952
71586
  degree: number;
71953
- /**
71954
- * Other names the same entity appears under in the ingested text
71955
- */
71956
71587
  aliases: string[];
71957
- /**
71958
- * What the entity is, as the engine summarised it; null when it has not written one
71959
- */
71960
71588
  description: (string | null);
71961
- /**
71962
- * Ontology type of the entity, e.g. Feature, Decision, Risk, Integration
71963
- */
71964
71589
  entity_type: string;
71965
- /**
71966
- * The name to show a person
71967
- */
71968
71590
  display_name: string;
71969
- /**
71970
- * The one name this entity is stored under
71971
- */
71972
71591
  canonical_name: string;
71973
- /**
71974
- * How many memories mention this entity
71975
- */
71976
71592
  evidence_count: number;
71977
71593
  }[];
71978
- /**
71979
- * Sizes of what was actually returned
71980
- */
71981
71594
  totals: {
71982
- /**
71983
- * Edges returned in this export
71984
- */
71985
71595
  edgeCount: number;
71986
- /**
71987
- * Nodes returned in this export
71988
- */
71989
71596
  nodeCount: number;
71990
71597
  };
71991
- /**
71992
- * True when `limit` cut the export short — the highest-degree nodes were kept, so what you get is the hubs
71993
- */
71994
71598
  truncated: boolean;
71995
- /**
71996
- * How long the engine took to answer, milliseconds
71997
- */
71998
71599
  elapsed_ms: number;
71999
- /**
72000
- * Engine request id for this call — quote it when reporting a problem
72001
- */
72002
71600
  request_id: string;
72003
71601
  }
72004
71602
  export interface BrainKnowledgeNeighborhoodInput {
@@ -72028,128 +71626,38 @@ export interface BrainKnowledgeNeighborhoodInput {
72028
71626
  relation_type?: string;
72029
71627
  }
72030
71628
  export interface BrainKnowledgeNeighborhoodOutput {
72031
- /**
72032
- * The entity that was expanded around; null when `entity_ref` matched nothing
72033
- */
72034
71629
  root: ({
72035
- /**
72036
- * How closely this entity matches the query, higher is closer; absent on an unscored read such as a plain type filter
72037
- */
72038
71630
  score?: number;
72039
- /**
72040
- * Other names the same entity appears under in the ingested text
72041
- */
72042
71631
  aliases: string[];
72043
- /**
72044
- * Id of this entity; pass it as `entity_ref` to brain_knowledge_neighborhood or brain_knowledge_entity_memories
72045
- */
72046
71632
  entity_id: string;
72047
- /**
72048
- * What the entity is, as the engine summarised it from the memories mentioning it; null when it has not written one
72049
- */
72050
71633
  description: (string | null);
72051
- /**
72052
- * Ontology type of the entity, e.g. Feature, Decision, Risk, Integration
72053
- */
72054
71634
  entity_type: string;
72055
- /**
72056
- * The name to show a person — usually the spelling the source text used
72057
- */
72058
71635
  display_name: string;
72059
- /**
72060
- * The one name this entity is stored under; use it when matching entities against each other
72061
- */
72062
71636
  canonical_name: string;
72063
- /**
72064
- * How many memories mention this entity — a rough measure of how well attested it is
72065
- */
72066
71637
  evidence_count: number;
72067
71638
  } | null);
72068
- /**
72069
- * The neighbours reached within `depth` hops of the root, the root excluded
72070
- */
72071
71639
  entities: {
72072
- /**
72073
- * How closely this entity matches the query, higher is closer; absent on an unscored read such as a plain type filter
72074
- */
72075
71640
  score?: number;
72076
- /**
72077
- * Other names the same entity appears under in the ingested text
72078
- */
72079
71641
  aliases: string[];
72080
- /**
72081
- * Id of this entity; pass it as `entity_ref` to brain_knowledge_neighborhood or brain_knowledge_entity_memories
72082
- */
72083
71642
  entity_id: string;
72084
- /**
72085
- * What the entity is, as the engine summarised it from the memories mentioning it; null when it has not written one
72086
- */
72087
71643
  description: (string | null);
72088
- /**
72089
- * Ontology type of the entity, e.g. Feature, Decision, Risk, Integration
72090
- */
72091
71644
  entity_type: string;
72092
- /**
72093
- * The name to show a person — usually the spelling the source text used
72094
- */
72095
71645
  display_name: string;
72096
- /**
72097
- * The one name this entity is stored under; use it when matching entities against each other
72098
- */
72099
71646
  canonical_name: string;
72100
- /**
72101
- * How many memories mention this entity — a rough measure of how well attested it is
72102
- */
72103
71647
  evidence_count: number;
72104
71648
  }[];
72105
- /**
72106
- * The relations that connect the root and the neighbours above
72107
- */
72108
71649
  relations: {
72109
- /**
72110
- * Why the engine drew this relation, in its own words; null when it recorded none
72111
- */
72112
71650
  reason: (string | null);
72113
- /**
72114
- * Id of the entity the relation points FROM
72115
- */
72116
71651
  source_id: string;
72117
- /**
72118
- * True when the relation reads the same in both directions, so source and target are interchangeable
72119
- */
72120
71652
  symmetric: boolean;
72121
- /**
72122
- * Id of the entity the relation points TO
72123
- */
72124
71653
  target_id: string;
72125
- /**
72126
- * Ontology type of the relation, e.g. depends_on, competes_with, owns
72127
- */
72128
71654
  relation_type: string;
72129
- /**
72130
- * Name to show for the source entity
72131
- */
72132
71655
  source_display_name: string;
72133
- /**
72134
- * Name to show for the target entity
72135
- */
72136
71656
  target_display_name: string;
72137
- /**
72138
- * Stored name of the source entity
72139
- */
72140
71657
  source_canonical_name: string;
72141
- /**
72142
- * Stored name of the target entity
72143
- */
72144
71658
  target_canonical_name: string;
72145
71659
  }[];
72146
- /**
72147
- * How long the engine took to answer, milliseconds
72148
- */
72149
71660
  elapsed_ms: number;
72150
- /**
72151
- * Engine request id for this call — quote it when reporting a problem
72152
- */
72153
71661
  request_id: string;
72154
71662
  }
72155
71663
  export interface BrainKnowledgeRelationsInput {
@@ -72175,54 +71683,18 @@ export interface BrainKnowledgeRelationsInput {
72175
71683
  target_entity?: string;
72176
71684
  }
72177
71685
  export interface BrainKnowledgeRelationsOutput {
72178
- /**
72179
- * The relations matching the filters
72180
- */
72181
71686
  relations: {
72182
- /**
72183
- * Why the engine drew this relation, in its own words; null when it recorded none
72184
- */
72185
71687
  reason: (string | null);
72186
- /**
72187
- * Id of the entity the relation points FROM
72188
- */
72189
71688
  source_id: string;
72190
- /**
72191
- * True when the relation reads the same in both directions, so source and target are interchangeable
72192
- */
72193
71689
  symmetric: boolean;
72194
- /**
72195
- * Id of the entity the relation points TO
72196
- */
72197
71690
  target_id: string;
72198
- /**
72199
- * Ontology type of the relation, e.g. depends_on, competes_with, owns
72200
- */
72201
71691
  relation_type: string;
72202
- /**
72203
- * Name to show for the source entity
72204
- */
72205
71692
  source_display_name: string;
72206
- /**
72207
- * Name to show for the target entity
72208
- */
72209
71693
  target_display_name: string;
72210
- /**
72211
- * Stored name of the source entity
72212
- */
72213
71694
  source_canonical_name: string;
72214
- /**
72215
- * Stored name of the target entity
72216
- */
72217
71695
  target_canonical_name: string;
72218
71696
  }[];
72219
- /**
72220
- * How long the engine took to answer, milliseconds
72221
- */
72222
71697
  elapsed_ms: number;
72223
- /**
72224
- * Engine request id for this call — quote it when reporting a problem
72225
- */
72226
71698
  request_id: string;
72227
71699
  }
72228
71700
  export interface BrainKnowledgeSearchInput {
@@ -72248,54 +71720,18 @@ export interface BrainKnowledgeSearchInput {
72248
71720
  entity_type?: string;
72249
71721
  }
72250
71722
  export interface BrainKnowledgeSearchOutput {
72251
- /**
72252
- * How many entities match in total, across all pages — not the length of this page
72253
- */
72254
71723
  total: number;
72255
- /**
72256
- * Matching entities, best match first
72257
- */
72258
71724
  entities: {
72259
- /**
72260
- * How closely this entity matches the query, higher is closer; absent on an unscored read such as a plain type filter
72261
- */
72262
71725
  score?: number;
72263
- /**
72264
- * Other names the same entity appears under in the ingested text
72265
- */
72266
71726
  aliases: string[];
72267
- /**
72268
- * Id of this entity; pass it as `entity_ref` to brain_knowledge_neighborhood or brain_knowledge_entity_memories
72269
- */
72270
71727
  entity_id: string;
72271
- /**
72272
- * What the entity is, as the engine summarised it from the memories mentioning it; null when it has not written one
72273
- */
72274
71728
  description: (string | null);
72275
- /**
72276
- * Ontology type of the entity, e.g. Feature, Decision, Risk, Integration
72277
- */
72278
71729
  entity_type: string;
72279
- /**
72280
- * The name to show a person — usually the spelling the source text used
72281
- */
72282
71730
  display_name: string;
72283
- /**
72284
- * The one name this entity is stored under; use it when matching entities against each other
72285
- */
72286
71731
  canonical_name: string;
72287
- /**
72288
- * How many memories mention this entity — a rough measure of how well attested it is
72289
- */
72290
71732
  evidence_count: number;
72291
71733
  }[];
72292
- /**
72293
- * How long the engine took to answer, milliseconds
72294
- */
72295
71734
  elapsed_ms: number;
72296
- /**
72297
- * Engine request id for this call — quote it when reporting a problem
72298
- */
72299
71735
  request_id: string;
72300
71736
  }
72301
71737
  export interface BrainMemoryAddInput {
@@ -72319,17 +71755,8 @@ export interface BrainMemoryAddInput {
72319
71755
  source_authority?: ("policy" | "official" | "team" | "informal");
72320
71756
  }
72321
71757
  export interface BrainMemoryAddOutput {
72322
- /**
72323
- * True when the memory was stored
72324
- */
72325
71758
  success: boolean;
72326
- /**
72327
- * Engine id of the memory just stored; keep it to read, replace or delete the memory later
72328
- */
72329
71759
  memory_id: string;
72330
- /**
72331
- * Engine request id for this call — quote it when reporting a problem
72332
- */
72333
71760
  request_id: string;
72334
71761
  }
72335
71762
  export interface BrainMemoryDeleteInput {
@@ -72339,17 +71766,8 @@ export interface BrainMemoryDeleteInput {
72339
71766
  memory_id: string;
72340
71767
  }
72341
71768
  export interface BrainMemoryDeleteOutput {
72342
- /**
72343
- * Always true — the call fails outright rather than reporting a false here
72344
- */
72345
71769
  success: true;
72346
- /**
72347
- * Engine request id for this call — quote it when reporting a problem
72348
- */
72349
71770
  request_id: string;
72350
- /**
72351
- * How many memory rows the engine removed for this id; 0 when it was already gone
72352
- */
72353
71771
  deleted_count: number;
72354
71772
  }
72355
71773
  export interface BrainMemoryGetInput {
@@ -72359,177 +71777,72 @@ export interface BrainMemoryGetInput {
72359
71777
  memory_id: string;
72360
71778
  }
72361
71779
  export interface BrainMemoryGetOutput {
72362
- /**
72363
- * Engine tags on this memory; empty when it carries none
72364
- */
72365
71780
  tags: string[];
72366
71781
  /**
72367
71782
  * Engine memory layer (l0_basic_info…l7_intention)
72368
71783
  */
72369
71784
  layer: ("l6_schema" | "l7_intention" | "l4_identity" | "l0_basic_info" | "l2_fact" | "l3_summary" | "l5_knowledge" | "l1_raw");
72370
- /**
72371
- * Free-form metadata, verbatim as the writer passed brain_memory_add's `metadata`; keys are the caller's
72372
- */
72373
71785
  custom: {
72374
71786
  [k: string]: unknown;
72375
71787
  };
72376
- /**
72377
- * Which store answered the read — 'vdb' the vector store, 'graph' the memory graph. Diagnostic; the content is the same either way.
72378
- */
72379
71788
  source: ("vdb" | "graph");
72380
- /**
72381
- * Engine lifecycle status of the row — 'active' for a memory in use
72382
- */
72383
71789
  status: string;
72384
- /**
72385
- * The memory text itself
72386
- */
72387
71790
  content: string;
72388
- /**
72389
- * Engine user namespace the memory was written under
72390
- */
72391
71791
  user_id: string;
72392
- /**
72393
- * Engine agent namespace the memory was written under
72394
- */
72395
71792
  agent_id: string;
72396
- /**
72397
- * True when this is the current version of the memory; false when a newer one has replaced it
72398
- */
72399
71793
  is_latest: boolean;
72400
- /**
72401
- * When the remembered EVENT happened, epoch milliseconds; null when the writer stated no time
72402
- */
72403
71794
  memory_at: (number | null);
72404
- /**
72405
- * Engine id of this memory — the id that was asked for
72406
- */
72407
71795
  memory_id: string;
72408
- /**
72409
- * The engine's own inference about this memory, or null when it recorded none
72410
- */
72411
71796
  speculate: (string | null);
72412
- /**
72413
- * The engine's confidence in this memory, 0..1
72414
- */
72415
71797
  confidence: number;
72416
- /**
72417
- * How long the engine took to answer, milliseconds
72418
- */
72419
71798
  elapsed_ms: number;
72420
- /**
72421
- * Engine request id for this call — quote it when reporting a problem
72422
- */
72423
71799
  request_id: string;
72424
- /**
72425
- * Ids of the memories this one replaced; null when it replaced none
72426
- */
72427
71800
  supersedes: (string[] | null);
72428
- /**
72429
- * When this memory row was written, epoch milliseconds
72430
- */
72431
71801
  gmt_created: number;
72432
- /**
72433
- * Ids of the memories that replaced this one; null while it is still current
72434
- */
72435
71802
  superseded_by: (string[] | null);
72436
71803
  /**
72437
71804
  * Source authority (highest→lowest): policy > official > team > informal
72438
71805
  */
72439
71806
  source_authority: ("policy" | "official" | "team" | "informal");
72440
- /**
72441
- * Id of the l1_raw memory this one was derived from; null when it was written directly
72442
- */
72443
71807
  source_raw_memory_id: (string | null);
72444
71808
  }
72445
71809
  export interface BrainMemoryListInput {
72446
- /**
72447
- * How many memories to return, max 1000. Omit to use the engine's own page size.
72448
- */
72449
71810
  limit?: number;
72450
- /**
72451
- * Sort by write time: 'desc' newest first, 'asc' oldest first. Omit to take the engine's own order.
72452
- */
72453
71811
  order?: ("asc" | "desc");
72454
71812
  /**
72455
71813
  * Read scope; 'both' (default) unions shared + your private
72456
71814
  */
72457
71815
  scope?: ("shared" | "private" | "both");
72458
- /**
72459
- * How many memories to skip before this page — offset 100 with limit 100 is the second page. Omit to start at the beginning.
72460
- */
72461
71816
  offset?: number;
72462
71817
  }
72463
71818
  export interface BrainMemoryListOutput {
72464
- /**
72465
- * How many memories match in total, across all pages — not the length of this page
72466
- */
72467
71819
  total: number;
72468
- /**
72469
- * One page of memories, newest first unless `order` said otherwise
72470
- */
72471
71820
  memories: {
72472
71821
  /**
72473
71822
  * Consumer-facing label derived from the layer; 'unknown' for an unrecognised layer
72474
71823
  */
72475
71824
  kind: ("schema" | "intention" | "identity" | "basic" | "fact" | "summary" | "knowledge" | "raw" | "unknown");
72476
- /**
72477
- * Engine tags on this memory; empty when it carries none
72478
- */
72479
71825
  tags: string[];
72480
71826
  /**
72481
71827
  * Engine memory layer (l0_basic_info…l7_intention)
72482
71828
  */
72483
71829
  layer: ("l6_schema" | "l7_intention" | "l4_identity" | "l0_basic_info" | "l2_fact" | "l3_summary" | "l5_knowledge" | "l1_raw");
72484
- /**
72485
- * Free-form metadata, verbatim as the writer passed brain_memory_add's `metadata`; keys are the caller's
72486
- */
72487
71830
  custom: {
72488
71831
  [k: string]: unknown;
72489
71832
  };
72490
- /**
72491
- * Engine lifecycle status of the row — 'active' for a memory in use; superseded rows are not listed
72492
- */
72493
71833
  status: string;
72494
- /**
72495
- * The memory text itself
72496
- */
72497
71834
  content: string;
72498
- /**
72499
- * Engine user namespace the memory was written under
72500
- */
72501
71835
  user_id: string;
72502
- /**
72503
- * Engine agent namespace the memory was written under — the shared pool for a 'shared' write, the caller's own for a private one
72504
- */
72505
71836
  agent_id: string;
72506
- /**
72507
- * When the remembered EVENT happened, epoch milliseconds; null when the writer stated no time
72508
- */
72509
71837
  memory_at: (number | null);
72510
- /**
72511
- * Engine id of this memory; pass it to brain_memory_get, _update or _delete
72512
- */
72513
71838
  memory_id: string;
72514
- /**
72515
- * The engine's own inference about this memory, or null when it recorded none
72516
- */
72517
71839
  speculate: (string | null);
72518
- /**
72519
- * Engine session the memory was written in; empty when the writer opened none
72520
- */
72521
71840
  session_id: string;
72522
- /**
72523
- * When this memory row was written, epoch milliseconds
72524
- */
72525
71841
  gmt_created: number;
72526
71842
  /**
72527
71843
  * Source authority (highest→lowest): policy > official > team > informal
72528
71844
  */
72529
71845
  source_authority: ("policy" | "official" | "team" | "informal");
72530
- /**
72531
- * Id of the l1_raw memory this one was derived from; null when it was written directly
72532
- */
72533
71846
  source_raw_memory_id: (string | null);
72534
71847
  }[];
72535
71848
  }
@@ -72548,17 +71861,8 @@ export interface BrainMemorySearchInput {
72548
71861
  scope?: ("shared" | "private" | "both");
72549
71862
  }
72550
71863
  export interface BrainMemorySearchOutput {
72551
- /**
72552
- * Ordinary hits: the facts, summaries and raw notes that match the query
72553
- */
72554
71864
  normal: BrainMemorySearchOutputItems[];
72555
- /**
72556
- * Hits describing WHO the subject is — stable identity and preference memories (l0/l4). Usually the ones worth carrying into a prompt.
72557
- */
72558
71865
  profile: BrainMemorySearchOutputItems[];
72559
- /**
72560
- * Hits the engine offers unprompted — intentions and open threads (l7) it judged relevant to the query rather than matched to it
72561
- */
72562
71866
  proactive: BrainMemorySearchOutputItems[];
72563
71867
  }
72564
71868
  export interface BrainMemorySearchOutputItems {
@@ -72566,53 +71870,23 @@ export interface BrainMemorySearchOutputItems {
72566
71870
  * Consumer-facing label derived from the layer; 'unknown' for an unrecognised layer
72567
71871
  */
72568
71872
  kind: ("schema" | "intention" | "identity" | "basic" | "fact" | "summary" | "knowledge" | "raw" | "unknown");
72569
- /**
72570
- * Engine tags on this memory; empty when it carries none
72571
- */
72572
71873
  tags: string[];
72573
71874
  /**
72574
71875
  * Engine memory layer (l0_basic_info…l7_intention)
72575
71876
  */
72576
71877
  layer: ("l6_schema" | "l7_intention" | "l4_identity" | "l0_basic_info" | "l2_fact" | "l3_summary" | "l5_knowledge" | "l1_raw");
72577
- /**
72578
- * How closely this hit matches the query — higher is closer. An engine-internal scale, not a percentage; compare hits against each other, never against a fixed threshold.
72579
- */
72580
71878
  score: number;
72581
- /**
72582
- * The memory text itself
72583
- */
72584
71879
  content: string;
72585
- /**
72586
- * When the remembered EVENT happened, epoch milliseconds; null when the writer stated no time
72587
- */
72588
71880
  memory_at: (number | null);
72589
- /**
72590
- * Engine id of this memory; pass it to brain_memory_get, _update or _delete
72591
- */
72592
71881
  memory_id: string;
72593
- /**
72594
- * The engine's own inference about this memory, or null when it recorded none
72595
- */
72596
71882
  speculate: (string | null);
72597
- /**
72598
- * When this memory row was written, epoch milliseconds
72599
- */
72600
71883
  gmt_created: number;
72601
- /**
72602
- * Name of the l6_schema type this memory instantiates; absent on every other layer
72603
- */
72604
71884
  schema_type?: string;
72605
- /**
72606
- * Ids of the earlier memories this one grew out of, oldest first; absent when it has no history
72607
- */
72608
71885
  evolution_chain?: string[];
72609
71886
  /**
72610
71887
  * Source authority (highest→lowest): policy > official > team > informal
72611
71888
  */
72612
71889
  source_authority: ("policy" | "official" | "team" | "informal");
72613
- /**
72614
- * Id of the l1_raw memory this one was derived from; null when it was written directly
72615
- */
72616
71890
  source_raw_memory_id: (string | null);
72617
71891
  }
72618
71892
  export interface BrainMemoryStatsInput {
@@ -72622,52 +71896,19 @@ export interface BrainMemoryStatsInput {
72622
71896
  scope?: ("shared" | "private" | "both");
72623
71897
  }
72624
71898
  export interface BrainMemoryStatsOutput {
72625
- /**
72626
- * Size of the engine's memory graph
72627
- */
72628
71899
  graph: {
72629
- /**
72630
- * Edges between those nodes
72631
- */
72632
71900
  edgeCount: number;
72633
- /**
72634
- * Nodes in the memory graph
72635
- */
72636
71901
  nodeCount: number;
72637
71902
  };
72638
- /**
72639
- * Memory counts for the requested scope
72640
- */
72641
71903
  memories: {
72642
- /**
72643
- * How many memories the scope holds in total
72644
- */
72645
71904
  total: number;
72646
- /**
72647
- * Counts for the three derived layers the engine reports; the other layers are not broken out
72648
- */
72649
71905
  byLayer: {
72650
- /**
72651
- * Count of l2_fact memories — extracted facts
72652
- */
72653
71906
  l2: number;
72654
- /**
72655
- * Count of l3_summary memories — summaries over facts
72656
- */
72657
71907
  l3: number;
72658
- /**
72659
- * Count of l4_identity memories — who the subject is
72660
- */
72661
71908
  l4: number;
72662
71909
  };
72663
71910
  };
72664
- /**
72665
- * Size of the product knowledge graph
72666
- */
72667
71911
  knowledge: {
72668
- /**
72669
- * Entities in the product knowledge graph (see brain_knowledge_search)
72670
- */
72671
71912
  entityCount: number;
72672
71913
  };
72673
71914
  }
@@ -72682,17 +71923,8 @@ export interface BrainMemoryUpdateInput {
72682
71923
  memory_id: string;
72683
71924
  }
72684
71925
  export interface BrainMemoryUpdateOutput {
72685
- /**
72686
- * Always true — the call fails outright rather than reporting a false here
72687
- */
72688
71926
  success: true;
72689
- /**
72690
- * Engine id of the memory that was replaced
72691
- */
72692
71927
  memory_id: string;
72693
- /**
72694
- * Engine request id for this call — quote it when reporting a problem
72695
- */
72696
71928
  request_id: string;
72697
71929
  }
72698
71930
  export interface BrainProductSharedMemoryResetInput {
@@ -72741,9 +71973,6 @@ export interface BrainUsageReportInput {
72741
71973
  days?: number;
72742
71974
  }
72743
71975
  export interface BrainUsageReportOutput {
72744
- /**
72745
- * A standing warning, in words, that product.rows and platform.meters have different subjects and need not match
72746
- */
72747
71976
  note: string;
72748
71977
  /**
72749
71978
  * Brain's own ledger, for THIS product only
@@ -72761,9 +71990,6 @@ export interface BrainUsageReportOutput {
72761
71990
  * Inclusive UTC start of the window, YYYY-MM-DD
72762
71991
  */
72763
71992
  from: string;
72764
- /**
72765
- * One row per UTC day and meter dimension — the grain to join against a billing export
72766
- */
72767
71993
  rows: {
72768
71994
  /**
72769
71995
  * 'sync' | 'batch'; '' when the push carried none
@@ -72802,72 +72028,27 @@ export interface BrainUsageReportOutput {
72802
72028
  * The rows rolled up per meter across the whole window
72803
72029
  */
72804
72030
  totals: {
72805
- /**
72806
- * Manifest meter slug, e.g. llm-tokens
72807
- */
72808
72031
  meter: string;
72809
- /**
72810
- * How many metered calls landed in the window
72811
- */
72812
72032
  events: number;
72813
- /**
72814
- * Tokens metered for this meter across the whole window
72815
- */
72816
72033
  tokens: number;
72817
- /**
72818
- * Of those calls, how many billing did not accept — a non-zero here means our ledger and the invoice will differ
72819
- */
72820
72034
  delivery_failed: number;
72821
72035
  }[];
72822
- /**
72823
- * The product this ledger belongs to — the one the call was made for
72824
- */
72825
72036
  product_id: string;
72826
72037
  };
72827
72038
  /**
72828
72039
  * The platform billing aggregate for the whole ORG; null if it could not be read
72829
72040
  */
72830
72041
  platform: ({
72831
- /**
72832
- * The billing plan in force for that organisation
72833
- */
72834
72042
  plan: string;
72835
- /**
72836
- * Always 'org' — a reminder that these numbers are the whole organisation's, not this product's
72837
- */
72838
72043
  scope: "org";
72839
- /**
72840
- * Per-meter allowance and month-to-date usage as billing reports it
72841
- */
72842
72044
  meters: {
72843
- /**
72844
- * What the numbers below are counted in, e.g. tokens
72845
- */
72846
72045
  unit?: string;
72847
- /**
72848
- * How much of it has been used MONTH TO DATE, for the whole org — not for the window asked for here
72849
- */
72850
72046
  used?: number;
72851
- /**
72852
- * The plan's allowance for this meter; null or absent when there is no cap
72853
- */
72854
72047
  limit?: (number | null);
72855
- /**
72856
- * Allowance left; null or absent when the meter is uncapped
72857
- */
72858
72048
  remaining?: (number | null);
72859
- /**
72860
- * True when this meter has no cap at all
72861
- */
72862
72049
  unlimited?: boolean;
72863
- /**
72864
- * Platform meter slug, e.g. llm-tokens
72865
- */
72866
72050
  meter_slug: string;
72867
72051
  }[];
72868
- /**
72869
- * The organisation the billing aggregate was read for
72870
- */
72871
72052
  org_id: string;
72872
72053
  } | null);
72873
72054
  /**
@@ -94130,332 +93311,6 @@ export interface OrganizationYoutubeInstallInput {
94130
93311
  export interface OrganizationYoutubeInstallOutput {
94131
93312
  url: string;
94132
93313
  }
94133
- export interface PlaygroundAnalyticsOverviewInput {
94134
- /**
94135
- * Max records per entity in recent[]; omit for the endpoint default
94136
- */
94137
- limit?: number;
94138
- }
94139
- export interface PlaygroundAnalyticsOverviewOutput {
94140
- ok: boolean;
94141
- minted: boolean;
94142
- overview?: unknown;
94143
- http_status: number;
94144
- }
94145
- export interface PlaygroundBillingEntitlementsInput {
94146
- }
94147
- export interface PlaygroundBillingEntitlementsOutput {
94148
- ok: boolean;
94149
- minted: boolean;
94150
- http_status: number;
94151
- entitlements?: unknown;
94152
- }
94153
- export interface PlaygroundBillingRecordUsageInput {
94154
- /**
94155
- * Quantity of events to record against playground-events (SUM); defaults to 1
94156
- */
94157
- value?: number;
94158
- }
94159
- export interface PlaygroundBillingRecordUsageOutput {
94160
- minted: boolean;
94161
- accepted: (number | null);
94162
- recorded: boolean;
94163
- duplicates: (number | null);
94164
- http_status: number;
94165
- }
94166
- export interface PlaygroundClickupCreateTaskInput {
94167
- /**
94168
- * Task title; defaults to a fixture label
94169
- */
94170
- name?: string;
94171
- /**
94172
- * ClickUp list id; falls back to CLICKUP_TEST_LIST_ID
94173
- */
94174
- listId?: string;
94175
- }
94176
- export interface PlaygroundClickupCreateTaskOutput {
94177
- minted: boolean;
94178
- task_id: (string | null);
94179
- list_status: number;
94180
- vend_status: number;
94181
- clickup_status: number;
94182
- installation_count: number;
94183
- }
94184
- export interface PlaygroundClickupGetLastWebhookInput {
94185
- }
94186
- export type PlaygroundClickupGetLastWebhookOutput = ({
94187
- payload: string;
94188
- event_id: string;
94189
- provider: string;
94190
- verified: boolean;
94191
- product_id: string;
94192
- occurred_at: string;
94193
- connector_id: string;
94194
- clickup_event: (string | null);
94195
- receipt_count: number;
94196
- } | {
94197
- found: false;
94198
- });
94199
- export interface PlaygroundClickupGetOverviewInput {
94200
- }
94201
- export interface PlaygroundClickupGetOverviewOutput {
94202
- team: ({
94203
- teamId: string;
94204
- teamName: string;
94205
- } | null);
94206
- lists: PlaygroundClickupGetOverviewOutputItems[];
94207
- tasks: {
94208
- id: string;
94209
- name: string;
94210
- status: (string | null);
94211
- }[];
94212
- minted: boolean;
94213
- spaces: PlaygroundClickupGetOverviewOutputItems[];
94214
- list_status: number;
94215
- vend_status: number;
94216
- lists_status: number;
94217
- tasks_status: number;
94218
- spaces_status: number;
94219
- folders_status: number;
94220
- installation_count: number;
94221
- }
94222
- export interface PlaygroundClickupGetOverviewOutputItems {
94223
- id: string;
94224
- name: string;
94225
- }
94226
- export interface PlaygroundEchoPingInput {
94227
- /**
94228
- * The text to echo back, 1–1024 characters
94229
- */
94230
- message: string;
94231
- }
94232
- export interface PlaygroundEchoPingOutput {
94233
- /**
94234
- * The message exactly as it was received
94235
- */
94236
- message: string;
94237
- /**
94238
- * The product the call was resolved to
94239
- */
94240
- productId: string;
94241
- /**
94242
- * ISO-8601 instant (UTC) at which the call reached the service
94243
- */
94244
- receivedAt: string;
94245
- }
94246
- export interface PlaygroundGdriveGetLastChangeInput {
94247
- }
94248
- export type PlaygroundGdriveGetLastChangeOutput = ({
94249
- file_id: string;
94250
- removed: boolean;
94251
- file_name: (string | null);
94252
- mime_type: (string | null);
94253
- product_id: string;
94254
- occurred_at: string;
94255
- connector_id: string;
94256
- resource_state: string;
94257
- } | {
94258
- found: false;
94259
- });
94260
- export interface PlaygroundGdriveReadFileInput {
94261
- /**
94262
- * Drive file id; falls back to GDRIVE_TEST_FILE_ID, then the first picked file
94263
- */
94264
- fileId?: string;
94265
- }
94266
- export interface PlaygroundGdriveReadFileOutput {
94267
- minted: boolean;
94268
- file_id: (string | null);
94269
- file_name: (string | null);
94270
- mime_type: (string | null);
94271
- file_count: number;
94272
- get_status: number;
94273
- list_status: number;
94274
- vend_status: number;
94275
- content_bytes: (number | null);
94276
- }
94277
- export interface PlaygroundGoogleadsReadCustomerInput {
94278
- }
94279
- export interface PlaygroundGoogleadsReadCustomerOutput {
94280
- minted: boolean;
94281
- vended: boolean;
94282
- customer_id: (string | null);
94283
- vend_status: number;
94284
- result_count: number;
94285
- search_status: number;
94286
- login_customer_id: (string | null);
94287
- }
94288
- export interface PlaygroundLifecycleGetStateInput {
94289
- }
94290
- export interface PlaygroundLifecycleGetStateOutput {
94291
- blocked: boolean;
94292
- archived: boolean;
94293
- productId: string;
94294
- lastBlockTransition: ({
94295
- eventId: string;
94296
- eventName: string;
94297
- productId: string;
94298
- occurredAt: string;
94299
- recordedAt: string;
94300
- receiptCount: number;
94301
- organizationId: string;
94302
- cascadedFromOrg: boolean;
94303
- } | null);
94304
- lastArchiveTransition: ({
94305
- eventId: string;
94306
- eventName: string;
94307
- productId: string;
94308
- occurredAt: string;
94309
- recordedAt: string;
94310
- receiptCount: number;
94311
- organizationId: string;
94312
- cascadedFromOrg: boolean;
94313
- } | null);
94314
- }
94315
- export interface PlaygroundLifecycleListEventsInput {
94316
- }
94317
- export type PlaygroundLifecycleListEventsOutput = {
94318
- eventId: string;
94319
- eventName: string;
94320
- productId: string;
94321
- occurredAt: string;
94322
- recordedAt: string;
94323
- receiptCount: number;
94324
- organizationId: string;
94325
- cascadedFromOrg: boolean;
94326
- }[];
94327
- export interface PlaygroundWebhookGetLastInput {
94328
- }
94329
- export type PlaygroundWebhookGetLastOutput = ({
94330
- payload?: unknown;
94331
- event_id: string;
94332
- provider: string;
94333
- verified: boolean;
94334
- product_id: string;
94335
- occurred_at: string;
94336
- connector_id: string;
94337
- delivery_count: number;
94338
- } | {
94339
- found: false;
94340
- });
94341
- export interface PlaygroundWorkflowEchoInput {
94342
- /**
94343
- * The text to store, 1–1024 characters
94344
- */
94345
- note: string;
94346
- /**
94347
- * Optional labels stored alongside the note, at most 20
94348
- *
94349
- * @maxItems 20
94350
- */
94351
- tags?: [] | [string] | [string, string] | [string, string, string] | [string, string, string, string] | [string, string, string, string, string] | [string, string, string, string, string, string] | [string, string, string, string, string, string, string] | [string, string, string, string, string, string, string, string] | [string, string, string, string, string, string, string, string, string] | [string, string, string, string, string, string, string, string, string, string] | [string, string, string, string, string, string, string, string, string, string, string] | [string, string, string, string, string, string, string, string, string, string, string, string] | [string, string, string, string, string, string, string, string, string, string, string, string, string] | [string, string, string, string, string, string, string, string, string, string, string, string, string, string] | [string, string, string, string, string, string, string, string, string, string, string, string, string, string, string] | [string, string, string, string, string, string, string, string, string, string, string, string, string, string, string, string] | [string, string, string, string, string, string, string, string, string, string, string, string, string, string, string, string, string] | [string, string, string, string, string, string, string, string, string, string, string, string, string, string, string, string, string, string] | [string, string, string, string, string, string, string, string, string, string, string, string, string, string, string, string, string, string, string] | [string, string, string, string, string, string, string, string, string, string, string, string, string, string, string, string, string, string, string, string];
94352
- }
94353
- export interface PlaygroundWorkflowEchoOutput {
94354
- /**
94355
- * Identifier of the stored echo
94356
- */
94357
- id: string;
94358
- /**
94359
- * The note exactly as it was received
94360
- */
94361
- note: string;
94362
- /**
94363
- * The tags exactly as they were received
94364
- */
94365
- tags: string[];
94366
- /**
94367
- * Correlation id for this echo. The playground/workflow.echoed event published about two seconds later repeats it, which is how a composer matches the completion back to this step.
94368
- */
94369
- echo_id: string;
94370
- /**
94371
- * ISO-8601 instant (UTC) at which the echo was stored
94372
- */
94373
- received_at: string;
94374
- }
94375
- export interface PlaygroundWorkflowEchoListInput {
94376
- }
94377
- export type PlaygroundWorkflowEchoListOutput = {
94378
- /**
94379
- * Identifier of the stored echo
94380
- */
94381
- id: string;
94382
- /**
94383
- * The note exactly as it was received
94384
- */
94385
- note: string;
94386
- /**
94387
- * The tags exactly as they were received
94388
- */
94389
- tags: string[];
94390
- /**
94391
- * ISO-8601 instant (UTC) at which the echo was stored
94392
- */
94393
- received_at: string;
94394
- }[];
94395
- export interface PlaygroundWorkflowPingInput {
94396
- /**
94397
- * Class of ping, echoed on the emitted event and filterable on the trigger. Defaults to 'manual'.
94398
- */
94399
- kind?: string;
94400
- }
94401
- export interface PlaygroundWorkflowPingOutput {
94402
- /**
94403
- * Correlation id for this ping. The emitted playground/workflow.ping event repeats it, which is how a composer matches the event back to this step.
94404
- */
94405
- id: string;
94406
- /**
94407
- * The name of the event that was published
94408
- */
94409
- event: string;
94410
- }
94411
- export interface PlaygroundWorkflowSubjectsListInput {
94412
- /**
94413
- * How many subjects to return, 1–100. Defaults to 25.
94414
- */
94415
- limit?: number;
94416
- /**
94417
- * The next_cursor of the previous page. Opaque — pass it back unchanged. Omit for the first page.
94418
- */
94419
- cursor?: string;
94420
- /**
94421
- * ISO-8601 UTC instant. Return only subjects whose last_activity_at is AT OR AFTER this — the opposite question, the recently active population. Omit for no lower bound.
94422
- */
94423
- last_activity_after?: string;
94424
- /**
94425
- * ISO-8601 UTC instant. Return only subjects whose last_activity_at is AT OR BEFORE this — the "inactive for N days" question: pass now minus N days. Omit for no upper bound.
94426
- */
94427
- last_activity_before?: string;
94428
- }
94429
- export interface PlaygroundWorkflowSubjectsListOutput {
94430
- /**
94431
- * This page of subjects, most recently active first
94432
- */
94433
- items: {
94434
- /**
94435
- * Stable identifier for the subject. This is the field a batch trigger keys on, so a subject already served in an earlier run is skipped rather than served twice.
94436
- */
94437
- subject_key: string;
94438
- /**
94439
- * Human-readable name of the subject
94440
- */
94441
- display_name: string;
94442
- /**
94443
- * ISO-8601 instant (UTC) of the subject last activity
94444
- */
94445
- last_activity_at: string;
94446
- }[];
94447
- /**
94448
- * Whether another page follows. False and a null next_cursor both mark the last page, so a consumer that loops on either terminates.
94449
- */
94450
- has_more: boolean;
94451
- /**
94452
- * Pass back as `cursor` to fetch the next page; null on the last page. Always null when has_more is false.
94453
- */
94454
- next_cursor: (string | null);
94455
- }
94456
- export interface PlaygroundWsEchoInput {
94457
- }
94458
- export type PlaygroundWsEchoOutput = unknown;
94459
93314
  export interface RealtimeArchiveExportInput {
94460
93315
  /**
94461
93316
  * Only entries with ts <= to_ts (epoch ms)
@@ -117682,70 +116537,25 @@ export interface UsersApikeysCreateInput {
117682
116537
  type: ("server" | "publishable");
117683
116538
  }
117684
116539
  export interface UsersApikeysCreateOutput {
117685
- /**
117686
- * Id of the key. Pass it to users_apikeys_revoke.
117687
- */
117688
116540
  id: string;
117689
- /**
117690
- * The full secret key, shown ONCE. Store it now — it is never returned again, and a lost key is replaced by minting a new one.
117691
- */
117692
116541
  key: string;
117693
- /**
117694
- * The label a human gave this key — which backend or environment holds it.
117695
- */
117696
116542
  name: string;
117697
- /**
117698
- * `server` for a secret backend key (usk_…), `publishable` for a browser-safe one (upk_…).
117699
- */
117700
116543
  type: ("server" | "publishable");
117701
- /**
117702
- * The full value of a publishable key, which is not a secret. Null for a server key — that value exists in exactly one response, ever.
117703
- */
117704
116544
  value: (string | null);
117705
- /**
117706
- * `usk_`/`upk_` plus six characters — enough to recognise a key, never to use one.
117707
- */
117708
116545
  prefix: string;
117709
- /**
117710
- * When the key was issued (ISO 8601).
117711
- */
117712
116546
  createdAt: string;
117713
- /**
117714
- * When the key was revoked (ISO 8601). Null while it still works.
117715
- */
117716
116547
  revokedAt: (string | null);
117717
116548
  }
117718
116549
  export interface UsersApikeysListInput {
117719
116550
  }
117720
116551
  export interface UsersApikeysListOutput {
117721
116552
  keys: {
117722
- /**
117723
- * Id of the key. Pass it to users_apikeys_revoke.
117724
- */
117725
116553
  id: string;
117726
- /**
117727
- * The label a human gave this key — which backend or environment holds it.
117728
- */
117729
116554
  name: string;
117730
- /**
117731
- * `server` for a secret backend key (usk_…), `publishable` for a browser-safe one (upk_…).
117732
- */
117733
116555
  type: ("server" | "publishable");
117734
- /**
117735
- * The full value of a publishable key, which is not a secret. Null for a server key — that value exists in exactly one response, ever.
117736
- */
117737
116556
  value: (string | null);
117738
- /**
117739
- * `usk_`/`upk_` plus six characters — enough to recognise a key, never to use one.
117740
- */
117741
116557
  prefix: string;
117742
- /**
117743
- * When the key was issued (ISO 8601).
117744
- */
117745
116558
  createdAt: string;
117746
- /**
117747
- * When the key was revoked (ISO 8601). Null while it still works.
117748
- */
117749
116559
  revokedAt: (string | null);
117750
116560
  }[];
117751
116561
  }
@@ -117756,13 +116566,7 @@ export interface UsersApikeysRevokeInput {
117756
116566
  id: string;
117757
116567
  }
117758
116568
  export interface UsersApikeysRevokeOutput {
117759
- /**
117760
- * Id of the key that was revoked.
117761
- */
117762
116569
  id: string;
117763
- /**
117764
- * Always true — revocation is immediate and final.
117765
- */
117766
116570
  revoked: true;
117767
116571
  }
117768
116572
  export interface UsersAuditListInput {
@@ -117796,60 +116600,21 @@ export interface UsersAuditListInput {
117796
116600
  targetType?: string;
117797
116601
  }
117798
116602
  export interface UsersAuditListOutput {
117799
- /**
117800
- * The page of audit events, newest first.
117801
- */
117802
116603
  events: {
117803
- /**
117804
- * Id of this audit row.
117805
- */
117806
116604
  id: string;
117807
- /**
117808
- * IP the action came from. Null when it was not an HTTP action.
117809
- */
117810
116605
  ip: (string | null);
117811
- /**
117812
- * What happened, as a dotted name — `user.created`, `passkey.deleted`, `email_change.override_applied`.
117813
- */
117814
116606
  action: string;
117815
- /**
117816
- * Id of the actor. Null for a system action.
117817
- */
117818
116607
  actorId: (string | null);
117819
- /**
117820
- * Action-specific detail — the reason text, counts, whatever the action recorded.
117821
- */
117822
116608
  metadata: {
117823
116609
  [k: string]: unknown;
117824
116610
  };
117825
- /**
117826
- * Id of the row the action was about. Null when there was none.
117827
- */
117828
116611
  targetId: (string | null);
117829
- /**
117830
- * Who acted: `operator` (a human or agent on the management plane), `end_user`, or `system`.
117831
- */
117832
116612
  actorType: ("operator" | "system" | "end_user");
117833
- /**
117834
- * When the action happened (ISO 8601).
117835
- */
117836
116613
  createdAt: string;
117837
- /**
117838
- * Product the audited action happened in.
117839
- */
117840
116614
  productId: string;
117841
- /**
117842
- * User agent the action came from. Null when none was sent.
117843
- */
117844
116615
  userAgent: (string | null);
117845
- /**
117846
- * What kind of row the action was about — `user` or `product`. Null when it was about nothing in particular.
117847
- */
117848
116616
  targetType: (string | null);
117849
116617
  }[];
117850
- /**
117851
- * Pass back as `cursor` to fetch the next page. Null when this page is the last.
117852
- */
117853
116618
  nextCursor: (string | null);
117854
116619
  }
117855
116620
  export interface UsersConfigGetInput {
@@ -118825,33 +117590,12 @@ export interface UsersFactorsListInput {
118825
117590
  userId: string;
118826
117591
  }
118827
117592
  export interface UsersFactorsListOutput {
118828
- /**
118829
- * Every second factor this user has — types and status only, never material.
118830
- */
118831
117593
  factors: {
118832
- /**
118833
- * Kind of second factor: `totp` or `backup_codes`. No key material is ever returned.
118834
- */
118835
117594
  type: ("totp" | "backup_codes" | "webauthn");
118836
- /**
118837
- * Whether this factor is enrolled and usable, or still pending verification.
118838
- */
118839
117595
  status: ("unverified" | "verified");
118840
- /**
118841
- * When the factor was enrolled (ISO 8601).
118842
- */
118843
117596
  createdAt: string;
118844
- /**
118845
- * `backup_codes` only: how many of the batch are still unspent. Null for any other factor type.
118846
- */
118847
117597
  remaining: (number | null);
118848
- /**
118849
- * When the factor was last used to sign in (ISO 8601). Null if it never was.
118850
- */
118851
117598
  lastUsedAt: (string | null);
118852
- /**
118853
- * When the user first proved the factor works (ISO 8601). Null while it is unverified.
118854
- */
118855
117599
  verifiedAt: (string | null);
118856
117600
  }[];
118857
117601
  }
@@ -118866,13 +117610,7 @@ export interface UsersFactorsResetInput {
118866
117610
  userId: string;
118867
117611
  }
118868
117612
  export interface UsersFactorsResetOutput {
118869
- /**
118870
- * Id of the scheduled reset. The same value arrives on `users/mfa.reset-settled`, which is what finishes this step.
118871
- */
118872
117613
  requestId: string;
118873
- /**
118874
- * When the removal happens, if nobody aborts it first (ISO 8601). The delay is this product's, not a fixed one.
118875
- */
118876
117614
  scheduledFor: string;
118877
117615
  }
118878
117616
  export interface UsersKeysListInput {
@@ -119190,18 +117928,9 @@ export interface UsersPasskeysRevokeOutput {
119190
117928
  * Present when the revoke was refused — today, only because it was the last way in.
119191
117929
  */
119192
117930
  error: ({
119193
- /**
119194
- * Why it was refused. Today only `passkey_last_way_in`.
119195
- */
119196
117931
  code: string;
119197
- /**
119198
- * The refusal in a sentence, safe to show a human.
119199
- */
119200
117932
  message: string;
119201
117933
  } | null);
119202
- /**
119203
- * `deleted` when the credential is gone, `failed` when the revoke was refused.
119204
- */
119205
117934
  status: ("deleted" | "failed");
119206
117935
  }
119207
117936
  export interface UsersSessionsGetInput {
@@ -119211,13 +117940,7 @@ export interface UsersSessionsGetInput {
119211
117940
  sessionId: string;
119212
117941
  }
119213
117942
  export interface UsersSessionsGetOutput {
119214
- /**
119215
- * Id of this session. Pass it to users_sessions_revoke.
119216
- */
119217
117943
  id: string;
119218
- /**
119219
- * IP the session was opened from. Null when it was not recorded.
119220
- */
119221
117944
  ip: (string | null);
119222
117945
  /**
119223
117946
  * `aal2` only if a verified second factor completed.
@@ -119227,42 +117950,18 @@ export interface UsersSessionsGetOutput {
119227
117950
  * The factors this session was established with.
119228
117951
  */
119229
117952
  amr: string[];
119230
- /**
119231
- * Whether the session is still usable, expired, or revoked.
119232
- */
119233
117953
  status: ("active" | "revoked");
119234
- /**
119235
- * The end user this session belongs to.
119236
- */
119237
117954
  userId: string;
119238
- /**
119239
- * When the session was opened (ISO 8601).
119240
- */
119241
117955
  createdAt: string;
119242
- /**
119243
- * When the current token stops working unless refreshed (ISO 8601).
119244
- */
119245
117956
  expiresAt: string;
119246
- /**
119247
- * When the session was revoked (ISO 8601). Null while it is live.
119248
- */
119249
117957
  revokedAt: (string | null);
119250
- /**
119251
- * User agent the session was opened from. Null when none was sent.
119252
- */
119253
117958
  userAgent: (string | null);
119254
117959
  revokedReason: (string | null);
119255
117960
  /**
119256
117961
  * The operator behind an impersonated session, or null for an ordinary one.
119257
117962
  */
119258
117963
  impersonatedBy: (string | null);
119259
- /**
119260
- * When the session last refreshed its tokens (ISO 8601). Null if it never has.
119261
- */
119262
117964
  lastRefreshedAt: (string | null);
119263
- /**
119264
- * When the session ends no matter how often it refreshes (ISO 8601).
119265
- */
119266
117965
  absoluteExpiresAt: string;
119267
117966
  }
119268
117967
  export interface UsersSessionsImpersonateInput {
@@ -119298,49 +117997,16 @@ export interface UsersSessionsListInput {
119298
117997
  userId: string;
119299
117998
  }
119300
117999
  export interface UsersSessionsListOutput {
119301
- /**
119302
- * The sessions matching the filter, newest first.
119303
- */
119304
118000
  sessions: {
119305
- /**
119306
- * Id of this session. Pass it to users_sessions_revoke.
119307
- */
119308
118001
  id: string;
119309
- /**
119310
- * IP the session was opened from. Null when it was not recorded.
119311
- */
119312
118002
  ip: (string | null);
119313
- /**
119314
- * Whether the session is still usable, expired, or revoked.
119315
- */
119316
118003
  status: ("active" | "revoked");
119317
- /**
119318
- * The end user this session belongs to.
119319
- */
119320
118004
  userId: string;
119321
- /**
119322
- * When the session was opened (ISO 8601).
119323
- */
119324
118005
  createdAt: string;
119325
- /**
119326
- * When the current token stops working unless refreshed (ISO 8601).
119327
- */
119328
118006
  expiresAt: string;
119329
- /**
119330
- * When the session was revoked (ISO 8601). Null while it is live.
119331
- */
119332
118007
  revokedAt: (string | null);
119333
- /**
119334
- * User agent the session was opened from. Null when none was sent.
119335
- */
119336
118008
  userAgent: (string | null);
119337
- /**
119338
- * When the session last refreshed its tokens (ISO 8601). Null if it never has.
119339
- */
119340
118009
  lastRefreshedAt: (string | null);
119341
- /**
119342
- * When the session ends no matter how often it refreshes (ISO 8601).
119343
- */
119344
118010
  absoluteExpiresAt: string;
119345
118011
  }[];
119346
118012
  }
@@ -119355,9 +118021,6 @@ export interface UsersSessionsRevokeInput {
119355
118021
  sessionId?: string;
119356
118022
  }
119357
118023
  export interface UsersSessionsRevokeOutput {
119358
- /**
119359
- * How many sessions were revoked. Zero when there was nothing live to revoke.
119360
- */
119361
118024
  revoked: number;
119362
118025
  }
119363
118026
  export interface UsersStatsGetInput {
@@ -119480,126 +118143,37 @@ export interface UsersUsersBanInput {
119480
118143
  userId: string;
119481
118144
  }
119482
118145
  export interface UsersUsersBanOutput {
119483
- /**
119484
- * Id of this end user. Pass it to any users_users_* tool.
119485
- */
119486
118146
  id: string;
119487
- /**
119488
- * The user's display name. Null when nobody set one.
119489
- */
119490
118147
  name: (string | null);
119491
- /**
119492
- * When the user was banned (ISO 8601). Null while they are not banned.
119493
- */
119494
118148
  bannedAt: (string | null);
119495
- /**
119496
- * When this user's personal data was purged for good (ISO 8601). Null while it is intact.
119497
- */
119498
118149
  erasedAt: (string | null);
119499
- /**
119500
- * URL of the user's avatar. Null when there is none.
119501
- */
119502
118150
  imageUrl: (string | null);
119503
- /**
119504
- * Whether this is a test fixture — excluded from metering and from the default listing.
119505
- */
119506
118151
  testUser: boolean;
119507
- /**
119508
- * When the user was created (ISO 8601).
119509
- */
119510
118152
  createdAt: string;
119511
- /**
119512
- * When the user was soft-deleted (ISO 8601). Null while the account is live.
119513
- */
119514
118153
  deletedAt: (string | null);
119515
- /**
119516
- * Product this user belongs to. Never an input — it comes from the calling identity.
119517
- */
119518
118154
  productId: string;
119519
- /**
119520
- * When the user was last changed (ISO 8601).
119521
- */
119522
118155
  updatedAt: string;
119523
- /**
119524
- * Whether this user is still on the waitlist and cannot sign in yet.
119525
- */
119526
118156
  waitlisted: boolean;
119527
- /**
119528
- * Every identifier of this user, the primary one flagged. To bind the primary address itself, use `primaryEmail` — `identifiers.0` means "the first", not "the primary".
119529
- */
119530
118157
  identifiers: {
119531
- /**
119532
- * Id of this identifier row.
119533
- */
119534
118158
  id: string;
119535
- /**
119536
- * What kind of identifier this is. Today always `email`.
119537
- */
119538
118159
  type: "email";
119539
- /**
119540
- * The address as the user typed it, for display.
119541
- */
119542
118160
  value: string;
119543
- /**
119544
- * Whether this is the identifier the user signs in with and is contacted at.
119545
- */
119546
118161
  isPrimary: boolean;
119547
- /**
119548
- * When this address was verified (ISO 8601). Null while it never was.
119549
- */
119550
118162
  verifiedAt: (string | null);
119551
- /**
119552
- * The address lowercased and NFC-normalised — what uniqueness is checked against.
119553
- */
119554
118163
  valueCanonical: string;
119555
- /**
119556
- * `unverified`, `verified`, or `expired` when a verification link ran out before it was used.
119557
- */
119558
118164
  verificationStatus: ("unverified" | "verified" | "expired");
119559
118165
  }[];
119560
- /**
119561
- * When a failed-attempt lockout expires (ISO 8601). Null when the user is not locked out.
119562
- */
119563
118166
  lockedUntil: (string | null);
119564
- /**
119565
- * When the user last signed in (ISO 8601). Null if they never have.
119566
- */
119567
118167
  lastSignInAt: (string | null);
119568
- /**
119569
- * The user's primary email address, as typed. Null when they have no primary identifier. Bind this rather than `identifiers.0.value`.
119570
- */
119571
- primaryEmail: (string | null);
119572
- /**
119573
- * Whether the user must set a new password at their next sign-in.
119574
- */
119575
118168
  requiresReset: boolean;
119576
- /**
119577
- * Metadata the end user may read; the only bag projected into their access token. Capped at 1.2 KB.
119578
- */
119579
- publicMetadata: {
119580
- [k: string]: unknown;
119581
- };
119582
- /**
119583
- * Metadata the end user may write themselves. Treat it as untrusted.
119584
- */
119585
- unsafeMetadata: {
119586
- [k: string]: unknown;
119587
- };
119588
- /**
119589
- * Metadata for the management plane only. Never reaches the end user or a token.
119590
- */
119591
- privateMetadata: {
119592
- [k: string]: unknown;
119593
- };
119594
- /**
119595
- * Id of the primary identifier row. Null when there is no primary identifier.
119596
- */
119597
- primaryIdentifierId: (string | null);
119598
- /**
119599
- * Until this instant the user may not start another email change, because somebody reverted one (ISO 8601). Null for a user who never reverted one.
119600
- */
118169
+ publicMetadata: UsersUsersBanOutputPublicMetadata;
118170
+ unsafeMetadata: UsersUsersBanOutputPublicMetadata;
118171
+ privateMetadata: UsersUsersBanOutputPublicMetadata;
119601
118172
  emailChangeLockedUntil: (string | null);
119602
118173
  }
118174
+ export interface UsersUsersBanOutputPublicMetadata {
118175
+ [k: string]: unknown;
118176
+ }
119603
118177
  export interface UsersUsersCreateInput {
119604
118178
  /**
119605
118179
  * The user's display name.
@@ -119703,126 +118277,37 @@ export interface UsersUsersCreateInputPublicMetadata1 {
119703
118277
  [k: string]: unknown;
119704
118278
  }
119705
118279
  export interface UsersUsersCreateOutput {
119706
- /**
119707
- * Id of this end user. Pass it to any users_users_* tool.
119708
- */
119709
118280
  id: string;
119710
- /**
119711
- * The user's display name. Null when nobody set one.
119712
- */
119713
118281
  name: (string | null);
119714
- /**
119715
- * When the user was banned (ISO 8601). Null while they are not banned.
119716
- */
119717
118282
  bannedAt: (string | null);
119718
- /**
119719
- * When this user's personal data was purged for good (ISO 8601). Null while it is intact.
119720
- */
119721
118283
  erasedAt: (string | null);
119722
- /**
119723
- * URL of the user's avatar. Null when there is none.
119724
- */
119725
118284
  imageUrl: (string | null);
119726
- /**
119727
- * Whether this is a test fixture — excluded from metering and from the default listing.
119728
- */
119729
118285
  testUser: boolean;
119730
- /**
119731
- * When the user was created (ISO 8601).
119732
- */
119733
118286
  createdAt: string;
119734
- /**
119735
- * When the user was soft-deleted (ISO 8601). Null while the account is live.
119736
- */
119737
118287
  deletedAt: (string | null);
119738
- /**
119739
- * Product this user belongs to. Never an input — it comes from the calling identity.
119740
- */
119741
118288
  productId: string;
119742
- /**
119743
- * When the user was last changed (ISO 8601).
119744
- */
119745
118289
  updatedAt: string;
119746
- /**
119747
- * Whether this user is still on the waitlist and cannot sign in yet.
119748
- */
119749
118290
  waitlisted: boolean;
119750
- /**
119751
- * Every identifier of this user, the primary one flagged. To bind the primary address itself, use `primaryEmail` — `identifiers.0` means "the first", not "the primary".
119752
- */
119753
118291
  identifiers: {
119754
- /**
119755
- * Id of this identifier row.
119756
- */
119757
118292
  id: string;
119758
- /**
119759
- * What kind of identifier this is. Today always `email`.
119760
- */
119761
118293
  type: "email";
119762
- /**
119763
- * The address as the user typed it, for display.
119764
- */
119765
118294
  value: string;
119766
- /**
119767
- * Whether this is the identifier the user signs in with and is contacted at.
119768
- */
119769
118295
  isPrimary: boolean;
119770
- /**
119771
- * When this address was verified (ISO 8601). Null while it never was.
119772
- */
119773
118296
  verifiedAt: (string | null);
119774
- /**
119775
- * The address lowercased and NFC-normalised — what uniqueness is checked against.
119776
- */
119777
118297
  valueCanonical: string;
119778
- /**
119779
- * `unverified`, `verified`, or `expired` when a verification link ran out before it was used.
119780
- */
119781
118298
  verificationStatus: ("unverified" | "verified" | "expired");
119782
118299
  }[];
119783
- /**
119784
- * When a failed-attempt lockout expires (ISO 8601). Null when the user is not locked out.
119785
- */
119786
118300
  lockedUntil: (string | null);
119787
- /**
119788
- * When the user last signed in (ISO 8601). Null if they never have.
119789
- */
119790
118301
  lastSignInAt: (string | null);
119791
- /**
119792
- * The user's primary email address, as typed. Null when they have no primary identifier. Bind this rather than `identifiers.0.value`.
119793
- */
119794
- primaryEmail: (string | null);
119795
- /**
119796
- * Whether the user must set a new password at their next sign-in.
119797
- */
119798
118302
  requiresReset: boolean;
119799
- /**
119800
- * Metadata the end user may read; the only bag projected into their access token. Capped at 1.2 KB.
119801
- */
119802
- publicMetadata: {
119803
- [k: string]: unknown;
119804
- };
119805
- /**
119806
- * Metadata the end user may write themselves. Treat it as untrusted.
119807
- */
119808
- unsafeMetadata: {
119809
- [k: string]: unknown;
119810
- };
119811
- /**
119812
- * Metadata for the management plane only. Never reaches the end user or a token.
119813
- */
119814
- privateMetadata: {
119815
- [k: string]: unknown;
119816
- };
119817
- /**
119818
- * Id of the primary identifier row. Null when there is no primary identifier.
119819
- */
119820
- primaryIdentifierId: (string | null);
119821
- /**
119822
- * Until this instant the user may not start another email change, because somebody reverted one (ISO 8601). Null for a user who never reverted one.
119823
- */
118303
+ publicMetadata: UsersUsersCreateOutputPublicMetadata;
118304
+ unsafeMetadata: UsersUsersCreateOutputPublicMetadata;
118305
+ privateMetadata: UsersUsersCreateOutputPublicMetadata;
119824
118306
  emailChangeLockedUntil: (string | null);
119825
118307
  }
118308
+ export interface UsersUsersCreateOutputPublicMetadata {
118309
+ [k: string]: unknown;
118310
+ }
119826
118311
  export interface UsersUsersDeleteInput {
119827
118312
  /**
119828
118313
  * The opaque user id returned by users_users_create or _list.
@@ -119830,126 +118315,37 @@ export interface UsersUsersDeleteInput {
119830
118315
  userId: string;
119831
118316
  }
119832
118317
  export interface UsersUsersDeleteOutput {
119833
- /**
119834
- * Id of this end user. Pass it to any users_users_* tool.
119835
- */
119836
118318
  id: string;
119837
- /**
119838
- * The user's display name. Null when nobody set one.
119839
- */
119840
118319
  name: (string | null);
119841
- /**
119842
- * When the user was banned (ISO 8601). Null while they are not banned.
119843
- */
119844
118320
  bannedAt: (string | null);
119845
- /**
119846
- * When this user's personal data was purged for good (ISO 8601). Null while it is intact.
119847
- */
119848
118321
  erasedAt: (string | null);
119849
- /**
119850
- * URL of the user's avatar. Null when there is none.
119851
- */
119852
118322
  imageUrl: (string | null);
119853
- /**
119854
- * Whether this is a test fixture — excluded from metering and from the default listing.
119855
- */
119856
118323
  testUser: boolean;
119857
- /**
119858
- * When the user was created (ISO 8601).
119859
- */
119860
118324
  createdAt: string;
119861
- /**
119862
- * When the user was soft-deleted (ISO 8601). Null while the account is live.
119863
- */
119864
118325
  deletedAt: (string | null);
119865
- /**
119866
- * Product this user belongs to. Never an input — it comes from the calling identity.
119867
- */
119868
118326
  productId: string;
119869
- /**
119870
- * When the user was last changed (ISO 8601).
119871
- */
119872
118327
  updatedAt: string;
119873
- /**
119874
- * Whether this user is still on the waitlist and cannot sign in yet.
119875
- */
119876
118328
  waitlisted: boolean;
119877
- /**
119878
- * Every identifier of this user, the primary one flagged. To bind the primary address itself, use `primaryEmail` — `identifiers.0` means "the first", not "the primary".
119879
- */
119880
118329
  identifiers: {
119881
- /**
119882
- * Id of this identifier row.
119883
- */
119884
118330
  id: string;
119885
- /**
119886
- * What kind of identifier this is. Today always `email`.
119887
- */
119888
118331
  type: "email";
119889
- /**
119890
- * The address as the user typed it, for display.
119891
- */
119892
118332
  value: string;
119893
- /**
119894
- * Whether this is the identifier the user signs in with and is contacted at.
119895
- */
119896
118333
  isPrimary: boolean;
119897
- /**
119898
- * When this address was verified (ISO 8601). Null while it never was.
119899
- */
119900
118334
  verifiedAt: (string | null);
119901
- /**
119902
- * The address lowercased and NFC-normalised — what uniqueness is checked against.
119903
- */
119904
118335
  valueCanonical: string;
119905
- /**
119906
- * `unverified`, `verified`, or `expired` when a verification link ran out before it was used.
119907
- */
119908
118336
  verificationStatus: ("unverified" | "verified" | "expired");
119909
118337
  }[];
119910
- /**
119911
- * When a failed-attempt lockout expires (ISO 8601). Null when the user is not locked out.
119912
- */
119913
118338
  lockedUntil: (string | null);
119914
- /**
119915
- * When the user last signed in (ISO 8601). Null if they never have.
119916
- */
119917
118339
  lastSignInAt: (string | null);
119918
- /**
119919
- * The user's primary email address, as typed. Null when they have no primary identifier. Bind this rather than `identifiers.0.value`.
119920
- */
119921
- primaryEmail: (string | null);
119922
- /**
119923
- * Whether the user must set a new password at their next sign-in.
119924
- */
119925
118340
  requiresReset: boolean;
119926
- /**
119927
- * Metadata the end user may read; the only bag projected into their access token. Capped at 1.2 KB.
119928
- */
119929
- publicMetadata: {
119930
- [k: string]: unknown;
119931
- };
119932
- /**
119933
- * Metadata the end user may write themselves. Treat it as untrusted.
119934
- */
119935
- unsafeMetadata: {
119936
- [k: string]: unknown;
119937
- };
119938
- /**
119939
- * Metadata for the management plane only. Never reaches the end user or a token.
119940
- */
119941
- privateMetadata: {
119942
- [k: string]: unknown;
119943
- };
119944
- /**
119945
- * Id of the primary identifier row. Null when there is no primary identifier.
119946
- */
119947
- primaryIdentifierId: (string | null);
119948
- /**
119949
- * Until this instant the user may not start another email change, because somebody reverted one (ISO 8601). Null for a user who never reverted one.
119950
- */
118341
+ publicMetadata: UsersUsersDeleteOutputPublicMetadata;
118342
+ unsafeMetadata: UsersUsersDeleteOutputPublicMetadata;
118343
+ privateMetadata: UsersUsersDeleteOutputPublicMetadata;
119951
118344
  emailChangeLockedUntil: (string | null);
119952
118345
  }
118346
+ export interface UsersUsersDeleteOutputPublicMetadata {
118347
+ [k: string]: unknown;
118348
+ }
119953
118349
  export interface UsersUsersExportInput {
119954
118350
  /**
119955
118351
  * Rows per page, 1-500. Default 100.
@@ -119975,129 +118371,40 @@ export interface UsersUsersExportInput {
119975
118371
  export interface UsersUsersExportOutput {
119976
118372
  count: number;
119977
118373
  users: {
119978
- /**
119979
- * Id of this end user. Pass it to any users_users_* tool.
119980
- */
119981
118374
  id: string;
119982
- /**
119983
- * The user's display name. Null when nobody set one.
119984
- */
119985
118375
  name: (string | null);
119986
- /**
119987
- * When the user was banned (ISO 8601). Null while they are not banned.
119988
- */
119989
118376
  bannedAt: (string | null);
119990
- /**
119991
- * When this user's personal data was purged for good (ISO 8601). Null while it is intact.
119992
- */
119993
118377
  erasedAt: (string | null);
119994
- /**
119995
- * URL of the user's avatar. Null when there is none.
119996
- */
119997
118378
  imageUrl: (string | null);
119998
- /**
119999
- * Whether this is a test fixture — excluded from metering and from the default listing.
120000
- */
120001
118379
  testUser: boolean;
120002
- /**
120003
- * When the user was created (ISO 8601).
120004
- */
120005
118380
  createdAt: string;
120006
- /**
120007
- * When the user was soft-deleted (ISO 8601). Null while the account is live.
120008
- */
120009
118381
  deletedAt: (string | null);
120010
- /**
120011
- * Product this user belongs to. Never an input — it comes from the calling identity.
120012
- */
120013
118382
  productId: string;
120014
- /**
120015
- * When the user was last changed (ISO 8601).
120016
- */
120017
118383
  updatedAt: string;
120018
- /**
120019
- * Whether this user is still on the waitlist and cannot sign in yet.
120020
- */
120021
118384
  waitlisted: boolean;
120022
- /**
120023
- * Every identifier of this user, the primary one flagged. To bind the primary address itself, use `primaryEmail` — `identifiers.0` means "the first", not "the primary".
120024
- */
120025
118385
  identifiers: {
120026
- /**
120027
- * Id of this identifier row.
120028
- */
120029
118386
  id: string;
120030
- /**
120031
- * What kind of identifier this is. Today always `email`.
120032
- */
120033
118387
  type: "email";
120034
- /**
120035
- * The address as the user typed it, for display.
120036
- */
120037
118388
  value: string;
120038
- /**
120039
- * Whether this is the identifier the user signs in with and is contacted at.
120040
- */
120041
118389
  isPrimary: boolean;
120042
- /**
120043
- * When this address was verified (ISO 8601). Null while it never was.
120044
- */
120045
118390
  verifiedAt: (string | null);
120046
- /**
120047
- * The address lowercased and NFC-normalised — what uniqueness is checked against.
120048
- */
120049
118391
  valueCanonical: string;
120050
- /**
120051
- * `unverified`, `verified`, or `expired` when a verification link ran out before it was used.
120052
- */
120053
118392
  verificationStatus: ("unverified" | "verified" | "expired");
120054
118393
  }[];
120055
- /**
120056
- * When a failed-attempt lockout expires (ISO 8601). Null when the user is not locked out.
120057
- */
120058
118394
  lockedUntil: (string | null);
120059
- /**
120060
- * When the user last signed in (ISO 8601). Null if they never have.
120061
- */
120062
118395
  lastSignInAt: (string | null);
120063
- /**
120064
- * The user's primary email address, as typed. Null when they have no primary identifier. Bind this rather than `identifiers.0.value`.
120065
- */
120066
- primaryEmail: (string | null);
120067
- /**
120068
- * Whether the user must set a new password at their next sign-in.
120069
- */
120070
118396
  requiresReset: boolean;
120071
- /**
120072
- * Metadata the end user may read; the only bag projected into their access token. Capped at 1.2 KB.
120073
- */
120074
- publicMetadata: {
120075
- [k: string]: unknown;
120076
- };
120077
- /**
120078
- * Metadata the end user may write themselves. Treat it as untrusted.
120079
- */
120080
- unsafeMetadata: {
120081
- [k: string]: unknown;
120082
- };
120083
- /**
120084
- * Metadata for the management plane only. Never reaches the end user or a token.
120085
- */
120086
- privateMetadata: {
120087
- [k: string]: unknown;
120088
- };
120089
- /**
120090
- * Id of the primary identifier row. Null when there is no primary identifier.
120091
- */
120092
- primaryIdentifierId: (string | null);
120093
- /**
120094
- * Until this instant the user may not start another email change, because somebody reverted one (ISO 8601). Null for a user who never reverted one.
120095
- */
118397
+ publicMetadata: UsersUsersExportOutputPublicMetadata;
118398
+ unsafeMetadata: UsersUsersExportOutputPublicMetadata;
118399
+ privateMetadata: UsersUsersExportOutputPublicMetadata;
120096
118400
  emailChangeLockedUntil: (string | null);
120097
118401
  }[];
120098
118402
  exportedAt: string;
120099
118403
  nextCursor: (string | null);
120100
118404
  }
118405
+ export interface UsersUsersExportOutputPublicMetadata {
118406
+ [k: string]: unknown;
118407
+ }
120101
118408
  export interface UsersUsersGetInput {
120102
118409
  /**
120103
118410
  * The opaque user id returned by users_users_create or _list.
@@ -120105,126 +118412,37 @@ export interface UsersUsersGetInput {
120105
118412
  userId: string;
120106
118413
  }
120107
118414
  export interface UsersUsersGetOutput {
120108
- /**
120109
- * Id of this end user. Pass it to any users_users_* tool.
120110
- */
120111
118415
  id: string;
120112
- /**
120113
- * The user's display name. Null when nobody set one.
120114
- */
120115
118416
  name: (string | null);
120116
- /**
120117
- * When the user was banned (ISO 8601). Null while they are not banned.
120118
- */
120119
118417
  bannedAt: (string | null);
120120
- /**
120121
- * When this user's personal data was purged for good (ISO 8601). Null while it is intact.
120122
- */
120123
118418
  erasedAt: (string | null);
120124
- /**
120125
- * URL of the user's avatar. Null when there is none.
120126
- */
120127
118419
  imageUrl: (string | null);
120128
- /**
120129
- * Whether this is a test fixture — excluded from metering and from the default listing.
120130
- */
120131
118420
  testUser: boolean;
120132
- /**
120133
- * When the user was created (ISO 8601).
120134
- */
120135
118421
  createdAt: string;
120136
- /**
120137
- * When the user was soft-deleted (ISO 8601). Null while the account is live.
120138
- */
120139
118422
  deletedAt: (string | null);
120140
- /**
120141
- * Product this user belongs to. Never an input — it comes from the calling identity.
120142
- */
120143
118423
  productId: string;
120144
- /**
120145
- * When the user was last changed (ISO 8601).
120146
- */
120147
118424
  updatedAt: string;
120148
- /**
120149
- * Whether this user is still on the waitlist and cannot sign in yet.
120150
- */
120151
118425
  waitlisted: boolean;
120152
- /**
120153
- * Every identifier of this user, the primary one flagged. To bind the primary address itself, use `primaryEmail` — `identifiers.0` means "the first", not "the primary".
120154
- */
120155
118426
  identifiers: {
120156
- /**
120157
- * Id of this identifier row.
120158
- */
120159
118427
  id: string;
120160
- /**
120161
- * What kind of identifier this is. Today always `email`.
120162
- */
120163
118428
  type: "email";
120164
- /**
120165
- * The address as the user typed it, for display.
120166
- */
120167
118429
  value: string;
120168
- /**
120169
- * Whether this is the identifier the user signs in with and is contacted at.
120170
- */
120171
118430
  isPrimary: boolean;
120172
- /**
120173
- * When this address was verified (ISO 8601). Null while it never was.
120174
- */
120175
118431
  verifiedAt: (string | null);
120176
- /**
120177
- * The address lowercased and NFC-normalised — what uniqueness is checked against.
120178
- */
120179
118432
  valueCanonical: string;
120180
- /**
120181
- * `unverified`, `verified`, or `expired` when a verification link ran out before it was used.
120182
- */
120183
118433
  verificationStatus: ("unverified" | "verified" | "expired");
120184
118434
  }[];
120185
- /**
120186
- * When a failed-attempt lockout expires (ISO 8601). Null when the user is not locked out.
120187
- */
120188
118435
  lockedUntil: (string | null);
120189
- /**
120190
- * When the user last signed in (ISO 8601). Null if they never have.
120191
- */
120192
118436
  lastSignInAt: (string | null);
120193
- /**
120194
- * The user's primary email address, as typed. Null when they have no primary identifier. Bind this rather than `identifiers.0.value`.
120195
- */
120196
- primaryEmail: (string | null);
120197
- /**
120198
- * Whether the user must set a new password at their next sign-in.
120199
- */
120200
118437
  requiresReset: boolean;
120201
- /**
120202
- * Metadata the end user may read; the only bag projected into their access token. Capped at 1.2 KB.
120203
- */
120204
- publicMetadata: {
120205
- [k: string]: unknown;
120206
- };
120207
- /**
120208
- * Metadata the end user may write themselves. Treat it as untrusted.
120209
- */
120210
- unsafeMetadata: {
120211
- [k: string]: unknown;
120212
- };
120213
- /**
120214
- * Metadata for the management plane only. Never reaches the end user or a token.
120215
- */
120216
- privateMetadata: {
120217
- [k: string]: unknown;
120218
- };
120219
- /**
120220
- * Id of the primary identifier row. Null when there is no primary identifier.
120221
- */
120222
- primaryIdentifierId: (string | null);
120223
- /**
120224
- * Until this instant the user may not start another email change, because somebody reverted one (ISO 8601). Null for a user who never reverted one.
120225
- */
118438
+ publicMetadata: UsersUsersGetOutputPublicMetadata;
118439
+ unsafeMetadata: UsersUsersGetOutputPublicMetadata;
118440
+ privateMetadata: UsersUsersGetOutputPublicMetadata;
120226
118441
  emailChangeLockedUntil: (string | null);
120227
118442
  }
118443
+ export interface UsersUsersGetOutputPublicMetadata {
118444
+ [k: string]: unknown;
118445
+ }
120228
118446
  export interface UsersUsersImportInput {
120229
118447
  /**
120230
118448
  * The users to import, at most 500 per call — batch client-side beyond that. Each row: identifiers (email), optional profile, optional password HASH, optional flags.
@@ -120235,42 +118453,15 @@ export interface UsersUsersImportInput {
120235
118453
  users: [unknown, ...(unknown)[]];
120236
118454
  }
120237
118455
  export interface UsersUsersImportOutput {
120238
- /**
120239
- * How many rows could not be imported at all.
120240
- */
120241
118456
  failed: number;
120242
- /**
120243
- * How many users were created.
120244
- */
120245
118457
  created: number;
120246
- /**
120247
- * One row per submitted row, in the order you sent them.
120248
- */
120249
118458
  results: {
120250
- /**
120251
- * Zero-based index of the row in the `users` array you sent.
120252
- */
120253
118459
  row: number;
120254
- /**
120255
- * Why it was skipped, or what went wrong. Null for a created row.
120256
- */
120257
118460
  reason: (string | null);
120258
- /**
120259
- * What happened to this row.
120260
- */
120261
118461
  status: ("created" | "skipped" | "failed");
120262
- /**
120263
- * The created user's id. Null for skipped and failed rows.
120264
- */
120265
118462
  userId: (string | null);
120266
118463
  }[];
120267
- /**
120268
- * How many rows were passed over — an address already in the directory, typically.
120269
- */
120270
118464
  skipped: number;
120271
- /**
120272
- * How many rows you submitted.
120273
- */
120274
118465
  requested: number;
120275
118466
  }
120276
118467
  export interface UsersUsersInviteInput {
@@ -120296,21 +118487,9 @@ export interface UsersUsersInviteInput {
120296
118487
  };
120297
118488
  }
120298
118489
  export interface UsersUsersInviteOutput {
120299
- /**
120300
- * False when the re-invite cooldown or the mail toolkit refused the send. The invite is still live.
120301
- */
120302
118490
  mailed: boolean;
120303
- /**
120304
- * The invited user, created immediately and listed straight away — they simply cannot sign in until they accept.
120305
- */
120306
118491
  userId: string;
120307
- /**
120308
- * False when this address had already been invited; the same user is returned.
120309
- */
120310
118492
  created: boolean;
120311
- /**
120312
- * When the invite link stops working (ISO 8601).
120313
- */
120314
118493
  expiresAt: string;
120315
118494
  }
120316
118495
  export interface UsersUsersListInput {
@@ -120344,135 +118523,40 @@ export interface UsersUsersListInput {
120344
118523
  includeWaitlisted?: boolean;
120345
118524
  }
120346
118525
  export interface UsersUsersListOutput {
120347
- /**
120348
- * The page of users, newest first.
120349
- */
120350
118526
  users: {
120351
- /**
120352
- * Id of this end user. Pass it to any users_users_* tool.
120353
- */
120354
118527
  id: string;
120355
- /**
120356
- * The user's display name. Null when nobody set one.
120357
- */
120358
118528
  name: (string | null);
120359
- /**
120360
- * When the user was banned (ISO 8601). Null while they are not banned.
120361
- */
120362
118529
  bannedAt: (string | null);
120363
- /**
120364
- * When this user's personal data was purged for good (ISO 8601). Null while it is intact.
120365
- */
120366
118530
  erasedAt: (string | null);
120367
- /**
120368
- * URL of the user's avatar. Null when there is none.
120369
- */
120370
118531
  imageUrl: (string | null);
120371
- /**
120372
- * Whether this is a test fixture — excluded from metering and from the default listing.
120373
- */
120374
118532
  testUser: boolean;
120375
- /**
120376
- * When the user was created (ISO 8601).
120377
- */
120378
118533
  createdAt: string;
120379
- /**
120380
- * When the user was soft-deleted (ISO 8601). Null while the account is live.
120381
- */
120382
118534
  deletedAt: (string | null);
120383
- /**
120384
- * Product this user belongs to. Never an input — it comes from the calling identity.
120385
- */
120386
118535
  productId: string;
120387
- /**
120388
- * When the user was last changed (ISO 8601).
120389
- */
120390
118536
  updatedAt: string;
120391
- /**
120392
- * Whether this user is still on the waitlist and cannot sign in yet.
120393
- */
120394
118537
  waitlisted: boolean;
120395
- /**
120396
- * Every identifier of this user, the primary one flagged. To bind the primary address itself, use `primaryEmail` — `identifiers.0` means "the first", not "the primary".
120397
- */
120398
118538
  identifiers: {
120399
- /**
120400
- * Id of this identifier row.
120401
- */
120402
118539
  id: string;
120403
- /**
120404
- * What kind of identifier this is. Today always `email`.
120405
- */
120406
118540
  type: "email";
120407
- /**
120408
- * The address as the user typed it, for display.
120409
- */
120410
118541
  value: string;
120411
- /**
120412
- * Whether this is the identifier the user signs in with and is contacted at.
120413
- */
120414
118542
  isPrimary: boolean;
120415
- /**
120416
- * When this address was verified (ISO 8601). Null while it never was.
120417
- */
120418
118543
  verifiedAt: (string | null);
120419
- /**
120420
- * The address lowercased and NFC-normalised — what uniqueness is checked against.
120421
- */
120422
118544
  valueCanonical: string;
120423
- /**
120424
- * `unverified`, `verified`, or `expired` when a verification link ran out before it was used.
120425
- */
120426
118545
  verificationStatus: ("unverified" | "verified" | "expired");
120427
118546
  }[];
120428
- /**
120429
- * When a failed-attempt lockout expires (ISO 8601). Null when the user is not locked out.
120430
- */
120431
118547
  lockedUntil: (string | null);
120432
- /**
120433
- * When the user last signed in (ISO 8601). Null if they never have.
120434
- */
120435
118548
  lastSignInAt: (string | null);
120436
- /**
120437
- * The user's primary email address, as typed. Null when they have no primary identifier. Bind this rather than `identifiers.0.value`.
120438
- */
120439
- primaryEmail: (string | null);
120440
- /**
120441
- * Whether the user must set a new password at their next sign-in.
120442
- */
120443
118549
  requiresReset: boolean;
120444
- /**
120445
- * Metadata the end user may read; the only bag projected into their access token. Capped at 1.2 KB.
120446
- */
120447
- publicMetadata: {
120448
- [k: string]: unknown;
120449
- };
120450
- /**
120451
- * Metadata the end user may write themselves. Treat it as untrusted.
120452
- */
120453
- unsafeMetadata: {
120454
- [k: string]: unknown;
120455
- };
120456
- /**
120457
- * Metadata for the management plane only. Never reaches the end user or a token.
120458
- */
120459
- privateMetadata: {
120460
- [k: string]: unknown;
120461
- };
120462
- /**
120463
- * Id of the primary identifier row. Null when there is no primary identifier.
120464
- */
120465
- primaryIdentifierId: (string | null);
120466
- /**
120467
- * Until this instant the user may not start another email change, because somebody reverted one (ISO 8601). Null for a user who never reverted one.
120468
- */
118550
+ publicMetadata: UsersUsersListOutputPublicMetadata;
118551
+ unsafeMetadata: UsersUsersListOutputPublicMetadata;
118552
+ privateMetadata: UsersUsersListOutputPublicMetadata;
120469
118553
  emailChangeLockedUntil: (string | null);
120470
118554
  }[];
120471
- /**
120472
- * Pass back as `cursor` to fetch the next page. Null when this page is the last.
120473
- */
120474
118555
  nextCursor: (string | null);
120475
118556
  }
118557
+ export interface UsersUsersListOutputPublicMetadata {
118558
+ [k: string]: unknown;
118559
+ }
120476
118560
  export interface UsersUsersSetPrimaryIdentifierInput {
120477
118561
  /**
120478
118562
  * The address to make primary. Must not already belong, verified, to another user of this product.
@@ -120488,13 +118572,7 @@ export interface UsersUsersSetPrimaryIdentifierInput {
120488
118572
  userId: string;
120489
118573
  }
120490
118574
  export interface UsersUsersSetPrimaryIdentifierOutput {
120491
- /**
120492
- * Id of the scheduled change. It appears in the audit rows and in the abort link mailed to the old address.
120493
- */
120494
118575
  requestId: string;
120495
- /**
120496
- * When the swap becomes applicable, if nobody aborts it first (ISO 8601). The delay is this product's `emailChange.overrideDelayHours`, 72 by default.
120497
- */
120498
118576
  scheduledFor: string;
120499
118577
  }
120500
118578
  export interface UsersUsersUnbanInput {
@@ -120504,126 +118582,37 @@ export interface UsersUsersUnbanInput {
120504
118582
  userId: string;
120505
118583
  }
120506
118584
  export interface UsersUsersUnbanOutput {
120507
- /**
120508
- * Id of this end user. Pass it to any users_users_* tool.
120509
- */
120510
118585
  id: string;
120511
- /**
120512
- * The user's display name. Null when nobody set one.
120513
- */
120514
118586
  name: (string | null);
120515
- /**
120516
- * When the user was banned (ISO 8601). Null while they are not banned.
120517
- */
120518
118587
  bannedAt: (string | null);
120519
- /**
120520
- * When this user's personal data was purged for good (ISO 8601). Null while it is intact.
120521
- */
120522
118588
  erasedAt: (string | null);
120523
- /**
120524
- * URL of the user's avatar. Null when there is none.
120525
- */
120526
118589
  imageUrl: (string | null);
120527
- /**
120528
- * Whether this is a test fixture — excluded from metering and from the default listing.
120529
- */
120530
118590
  testUser: boolean;
120531
- /**
120532
- * When the user was created (ISO 8601).
120533
- */
120534
118591
  createdAt: string;
120535
- /**
120536
- * When the user was soft-deleted (ISO 8601). Null while the account is live.
120537
- */
120538
118592
  deletedAt: (string | null);
120539
- /**
120540
- * Product this user belongs to. Never an input — it comes from the calling identity.
120541
- */
120542
118593
  productId: string;
120543
- /**
120544
- * When the user was last changed (ISO 8601).
120545
- */
120546
118594
  updatedAt: string;
120547
- /**
120548
- * Whether this user is still on the waitlist and cannot sign in yet.
120549
- */
120550
118595
  waitlisted: boolean;
120551
- /**
120552
- * Every identifier of this user, the primary one flagged. To bind the primary address itself, use `primaryEmail` — `identifiers.0` means "the first", not "the primary".
120553
- */
120554
118596
  identifiers: {
120555
- /**
120556
- * Id of this identifier row.
120557
- */
120558
118597
  id: string;
120559
- /**
120560
- * What kind of identifier this is. Today always `email`.
120561
- */
120562
118598
  type: "email";
120563
- /**
120564
- * The address as the user typed it, for display.
120565
- */
120566
118599
  value: string;
120567
- /**
120568
- * Whether this is the identifier the user signs in with and is contacted at.
120569
- */
120570
118600
  isPrimary: boolean;
120571
- /**
120572
- * When this address was verified (ISO 8601). Null while it never was.
120573
- */
120574
118601
  verifiedAt: (string | null);
120575
- /**
120576
- * The address lowercased and NFC-normalised — what uniqueness is checked against.
120577
- */
120578
118602
  valueCanonical: string;
120579
- /**
120580
- * `unverified`, `verified`, or `expired` when a verification link ran out before it was used.
120581
- */
120582
118603
  verificationStatus: ("unverified" | "verified" | "expired");
120583
118604
  }[];
120584
- /**
120585
- * When a failed-attempt lockout expires (ISO 8601). Null when the user is not locked out.
120586
- */
120587
118605
  lockedUntil: (string | null);
120588
- /**
120589
- * When the user last signed in (ISO 8601). Null if they never have.
120590
- */
120591
118606
  lastSignInAt: (string | null);
120592
- /**
120593
- * The user's primary email address, as typed. Null when they have no primary identifier. Bind this rather than `identifiers.0.value`.
120594
- */
120595
- primaryEmail: (string | null);
120596
- /**
120597
- * Whether the user must set a new password at their next sign-in.
120598
- */
120599
118607
  requiresReset: boolean;
120600
- /**
120601
- * Metadata the end user may read; the only bag projected into their access token. Capped at 1.2 KB.
120602
- */
120603
- publicMetadata: {
120604
- [k: string]: unknown;
120605
- };
120606
- /**
120607
- * Metadata the end user may write themselves. Treat it as untrusted.
120608
- */
120609
- unsafeMetadata: {
120610
- [k: string]: unknown;
120611
- };
120612
- /**
120613
- * Metadata for the management plane only. Never reaches the end user or a token.
120614
- */
120615
- privateMetadata: {
120616
- [k: string]: unknown;
120617
- };
120618
- /**
120619
- * Id of the primary identifier row. Null when there is no primary identifier.
120620
- */
120621
- primaryIdentifierId: (string | null);
120622
- /**
120623
- * Until this instant the user may not start another email change, because somebody reverted one (ISO 8601). Null for a user who never reverted one.
120624
- */
118608
+ publicMetadata: UsersUsersUnbanOutputPublicMetadata;
118609
+ unsafeMetadata: UsersUsersUnbanOutputPublicMetadata;
118610
+ privateMetadata: UsersUsersUnbanOutputPublicMetadata;
120625
118611
  emailChangeLockedUntil: (string | null);
120626
118612
  }
118613
+ export interface UsersUsersUnbanOutputPublicMetadata {
118614
+ [k: string]: unknown;
118615
+ }
120627
118616
  export interface UsersUsersUpdateInput {
120628
118617
  /**
120629
118618
  * The user's display name. Pass null to clear.
@@ -120671,126 +118660,37 @@ export interface UsersUsersUpdateInputPublicMetadata1 {
120671
118660
  [k: string]: unknown;
120672
118661
  }
120673
118662
  export interface UsersUsersUpdateOutput {
120674
- /**
120675
- * Id of this end user. Pass it to any users_users_* tool.
120676
- */
120677
118663
  id: string;
120678
- /**
120679
- * The user's display name. Null when nobody set one.
120680
- */
120681
118664
  name: (string | null);
120682
- /**
120683
- * When the user was banned (ISO 8601). Null while they are not banned.
120684
- */
120685
118665
  bannedAt: (string | null);
120686
- /**
120687
- * When this user's personal data was purged for good (ISO 8601). Null while it is intact.
120688
- */
120689
118666
  erasedAt: (string | null);
120690
- /**
120691
- * URL of the user's avatar. Null when there is none.
120692
- */
120693
118667
  imageUrl: (string | null);
120694
- /**
120695
- * Whether this is a test fixture — excluded from metering and from the default listing.
120696
- */
120697
118668
  testUser: boolean;
120698
- /**
120699
- * When the user was created (ISO 8601).
120700
- */
120701
118669
  createdAt: string;
120702
- /**
120703
- * When the user was soft-deleted (ISO 8601). Null while the account is live.
120704
- */
120705
118670
  deletedAt: (string | null);
120706
- /**
120707
- * Product this user belongs to. Never an input — it comes from the calling identity.
120708
- */
120709
118671
  productId: string;
120710
- /**
120711
- * When the user was last changed (ISO 8601).
120712
- */
120713
118672
  updatedAt: string;
120714
- /**
120715
- * Whether this user is still on the waitlist and cannot sign in yet.
120716
- */
120717
118673
  waitlisted: boolean;
120718
- /**
120719
- * Every identifier of this user, the primary one flagged. To bind the primary address itself, use `primaryEmail` — `identifiers.0` means "the first", not "the primary".
120720
- */
120721
118674
  identifiers: {
120722
- /**
120723
- * Id of this identifier row.
120724
- */
120725
118675
  id: string;
120726
- /**
120727
- * What kind of identifier this is. Today always `email`.
120728
- */
120729
118676
  type: "email";
120730
- /**
120731
- * The address as the user typed it, for display.
120732
- */
120733
118677
  value: string;
120734
- /**
120735
- * Whether this is the identifier the user signs in with and is contacted at.
120736
- */
120737
118678
  isPrimary: boolean;
120738
- /**
120739
- * When this address was verified (ISO 8601). Null while it never was.
120740
- */
120741
118679
  verifiedAt: (string | null);
120742
- /**
120743
- * The address lowercased and NFC-normalised — what uniqueness is checked against.
120744
- */
120745
118680
  valueCanonical: string;
120746
- /**
120747
- * `unverified`, `verified`, or `expired` when a verification link ran out before it was used.
120748
- */
120749
118681
  verificationStatus: ("unverified" | "verified" | "expired");
120750
118682
  }[];
120751
- /**
120752
- * When a failed-attempt lockout expires (ISO 8601). Null when the user is not locked out.
120753
- */
120754
118683
  lockedUntil: (string | null);
120755
- /**
120756
- * When the user last signed in (ISO 8601). Null if they never have.
120757
- */
120758
118684
  lastSignInAt: (string | null);
120759
- /**
120760
- * The user's primary email address, as typed. Null when they have no primary identifier. Bind this rather than `identifiers.0.value`.
120761
- */
120762
- primaryEmail: (string | null);
120763
- /**
120764
- * Whether the user must set a new password at their next sign-in.
120765
- */
120766
118685
  requiresReset: boolean;
120767
- /**
120768
- * Metadata the end user may read; the only bag projected into their access token. Capped at 1.2 KB.
120769
- */
120770
- publicMetadata: {
120771
- [k: string]: unknown;
120772
- };
120773
- /**
120774
- * Metadata the end user may write themselves. Treat it as untrusted.
120775
- */
120776
- unsafeMetadata: {
120777
- [k: string]: unknown;
120778
- };
120779
- /**
120780
- * Metadata for the management plane only. Never reaches the end user or a token.
120781
- */
120782
- privateMetadata: {
120783
- [k: string]: unknown;
120784
- };
120785
- /**
120786
- * Id of the primary identifier row. Null when there is no primary identifier.
120787
- */
120788
- primaryIdentifierId: (string | null);
120789
- /**
120790
- * Until this instant the user may not start another email change, because somebody reverted one (ISO 8601). Null for a user who never reverted one.
120791
- */
118686
+ publicMetadata: UsersUsersUpdateOutputPublicMetadata;
118687
+ unsafeMetadata: UsersUsersUpdateOutputPublicMetadata;
118688
+ privateMetadata: UsersUsersUpdateOutputPublicMetadata;
120792
118689
  emailChangeLockedUntil: (string | null);
120793
118690
  }
118691
+ export interface UsersUsersUpdateOutputPublicMetadata {
118692
+ [k: string]: unknown;
118693
+ }
120794
118694
  export interface UsersWaitlistFunnelInput {
120795
118695
  }
120796
118696
  export interface UsersWaitlistFunnelOutput {
@@ -120968,42 +118868,15 @@ export interface UsersWaitlistImportInput {
120968
118868
  ];
120969
118869
  }
120970
118870
  export interface UsersWaitlistImportOutput {
120971
- /**
120972
- * How many could not be imported at all.
120973
- */
120974
118871
  failed: number;
120975
- /**
120976
- * One row per submitted row, in the order you sent them.
120977
- */
120978
118872
  results: {
120979
- /**
120980
- * Zero-based index of the row in the array you sent.
120981
- */
120982
118873
  row: number;
120983
- /**
120984
- * Why it was skipped, or what went wrong. Null for an imported row.
120985
- */
120986
118874
  reason: (string | null);
120987
- /**
120988
- * What happened to this row.
120989
- */
120990
118875
  status: ("imported" | "skipped" | "failed");
120991
- /**
120992
- * The waitlisted user this row created. Null for skipped and failed rows.
120993
- */
120994
118876
  userId: (string | null);
120995
118877
  }[];
120996
- /**
120997
- * How many were already on the list or otherwise passed over.
120998
- */
120999
118878
  skipped: number;
121000
- /**
121001
- * How many became waitlist entries.
121002
- */
121003
118879
  imported: number;
121004
- /**
121005
- * How many rows you submitted.
121006
- */
121007
118880
  requested: number;
121008
118881
  }
121009
118882
  export interface UsersWaitlistInviteInput {
@@ -121016,30 +118889,12 @@ export interface UsersWaitlistInviteInput {
121016
118889
  userIds: [string, ...(string)[]];
121017
118890
  }
121018
118891
  export interface UsersWaitlistInviteOutput {
121019
- /**
121020
- * How many of the requested users were invited.
121021
- */
121022
118892
  invited: number;
121023
- /**
121024
- * One row per user you asked for, in the order you sent them.
121025
- */
121026
118893
  results: {
121027
- /**
121028
- * Why this user was skipped. Null for an invited row.
121029
- */
121030
118894
  reason: (("suppressed" | "not_found" | "already_registered") | null);
121031
- /**
121032
- * Whether this user was invited or passed over.
121033
- */
121034
118895
  status: ("invited" | "skipped");
121035
- /**
121036
- * The user this row is about.
121037
- */
121038
118896
  userId: string;
121039
118897
  }[];
121040
- /**
121041
- * How many were passed over — see each row's `reason`.
121042
- */
121043
118898
  skipped: number;
121044
118899
  }
121045
118900
  export interface UsersWaitlistListInput {
@@ -121061,62 +118916,23 @@ export interface UsersWaitlistListInput {
121061
118916
  confirmed?: boolean;
121062
118917
  }
121063
118918
  export interface UsersWaitlistListOutput {
121064
- /**
121065
- * The page of waitlist entries, newest first.
121066
- */
121067
118919
  entries: {
121068
- /**
121069
- * Where in the funnel this entry is: `pending`, `invited`, `registered` or `withdrawn`.
121070
- */
121071
118920
  status: ("pending" | "invited" | "registered" | "withdrawn");
121072
- /**
121073
- * The waitlisted user. Every users_users_* tool takes this id.
121074
- */
121075
118921
  userId: string;
121076
- /**
121077
- * When the entry joined the waitlist (ISO 8601).
121078
- */
121079
118922
  createdAt: string;
121080
- /**
121081
- * When the invite was sent (ISO 8601). Null while the entry is pending.
121082
- */
121083
118923
  invitedAt: (string | null);
121084
- /**
121085
- * The email address that signed up.
121086
- */
121087
118924
  identifier: string;
121088
- /**
121089
- * Where the signup came from — the campaign, referrer and landing page recorded at the time.
121090
- */
121091
118925
  attribution: {
121092
118926
  [k: string]: unknown;
121093
118927
  };
121094
- /**
121095
- * When the address confirmed a double opt-in (ISO 8601). Null when it never did.
121096
- */
121097
118928
  confirmedAt: (string | null);
121098
- /**
121099
- * When the address asked to be taken off the list (ISO 8601). Null when it did not.
121100
- */
121101
118929
  withdrawnAt: (string | null);
121102
- /**
121103
- * What was recorded to show this address consented: when, from where, and under which wording.
121104
- */
121105
118930
  consentProof: {
121106
118931
  [k: string]: unknown;
121107
118932
  };
121108
- /**
121109
- * When the invitee finished signing up (ISO 8601). Null until they do.
121110
- */
121111
118933
  registeredAt: (string | null);
121112
- /**
121113
- * Id of the live invite token. Null while the entry has not been invited.
121114
- */
121115
118934
  inviteTokenId: (string | null);
121116
118935
  }[];
121117
- /**
121118
- * Pass back as `cursor` to fetch the next page. Null when this page is the last.
121119
- */
121120
118936
  nextCursor: (string | null);
121121
118937
  }
121122
118938
  export interface UsersWebhooksCreateInput {