@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.
- package/dist/_types/gen/client.gen.d.ts +1 -38
- package/dist/_types/gen/manifest.gen.d.ts +1 -1
- package/dist/_types/gen/types.gen.d.ts +68 -2252
- package/dist/index.cjs +14 -241
- package/dist/index.cjs.map +1 -1
- package/dist/index.js +11199 -36
- package/dist/index.js.map +1 -1
- package/package.json +2 -12
- package/src/gen/bindings.gen.ts +1 -216
- package/src/gen/client.gen.ts +0 -71
- package/src/gen/manifest.gen.ts +15 -35
- package/src/gen/types.gen.ts +57 -2287
- package/dist/_types/gen/playground/connect.gen.d.ts +0 -3
- package/dist/_types/gen/playground/index.d.ts +0 -3
- package/dist/_types/gen/playground/queryOptions.gen.d.ts +0 -70
- package/dist/chunk-5RJ6WKNG.js +0 -11404
- package/dist/chunk-5RJ6WKNG.js.map +0 -1
- package/dist/playground/index.cjs +0 -106
- package/dist/playground/index.cjs.map +0 -1
- package/dist/playground/index.d.cts +0 -1
- package/dist/playground/index.d.ts +0 -1
- package/dist/playground/index.js +0 -78
- package/dist/playground/index.js.map +0 -1
- package/src/gen/playground/connect.gen.ts +0 -9
- package/src/gen/playground/index.ts +0 -4
- package/src/gen/playground/queryOptions.gen.ts +0 -119
package/src/gen/types.gen.ts
CHANGED
|
@@ -65652,13 +65652,7 @@ export interface BrainCognitionDigestInput {
|
|
|
65652
65652
|
}
|
|
65653
65653
|
|
|
65654
65654
|
export interface BrainCognitionDigestOutput {
|
|
65655
|
-
/**
|
|
65656
|
-
* 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.
|
|
65657
|
-
*/
|
|
65658
65655
|
run_id: string
|
|
65659
|
-
/**
|
|
65660
|
-
* Always true — the run was queued. The call fails outright rather than reporting a false here.
|
|
65661
|
-
*/
|
|
65662
65656
|
accepted: true
|
|
65663
65657
|
}
|
|
65664
65658
|
|
|
@@ -65697,13 +65691,7 @@ export interface BrainCognitionSweepInput {
|
|
|
65697
65691
|
}
|
|
65698
65692
|
|
|
65699
65693
|
export interface BrainCognitionSweepOutput {
|
|
65700
|
-
/**
|
|
65701
|
-
* 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.
|
|
65702
|
-
*/
|
|
65703
65694
|
run_id: string
|
|
65704
|
-
/**
|
|
65705
|
-
* Always true — the run was queued. The call fails outright rather than reporting a false here.
|
|
65706
|
-
*/
|
|
65707
65695
|
accepted: true
|
|
65708
65696
|
}
|
|
65709
65697
|
|
|
@@ -65741,9 +65729,6 @@ defaultBranch: string
|
|
|
65741
65729
|
}[]
|
|
65742
65730
|
|
|
65743
65731
|
export interface BrainDaemonBatchStatusInput {
|
|
65744
|
-
/**
|
|
65745
|
-
* Id of the ingestion daemon to act on, as returned by brain_daemons_list
|
|
65746
|
-
*/
|
|
65747
65732
|
id: string
|
|
65748
65733
|
}
|
|
65749
65734
|
|
|
@@ -65831,9 +65816,6 @@ unmeasuredCount: number
|
|
|
65831
65816
|
}
|
|
65832
65817
|
|
|
65833
65818
|
export interface BrainDaemonGetInput {
|
|
65834
|
-
/**
|
|
65835
|
-
* Id of the ingestion daemon to act on, as returned by brain_daemons_list
|
|
65836
|
-
*/
|
|
65837
65819
|
id: string
|
|
65838
65820
|
}
|
|
65839
65821
|
|
|
@@ -65859,13 +65841,8 @@ unmeasuredCount: number
|
|
|
65859
65841
|
}
|
|
65860
65842
|
|
|
65861
65843
|
export interface BrainDaemonReingestInput {
|
|
65862
|
-
/**
|
|
65863
|
-
* Id of the ingestion daemon that owns these documents, as returned by brain_daemons_list
|
|
65864
|
-
*/
|
|
65865
65844
|
id: string
|
|
65866
65845
|
/**
|
|
65867
|
-
* 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.
|
|
65868
|
-
*
|
|
65869
65846
|
* @minItems 1
|
|
65870
65847
|
* @maxItems 100
|
|
65871
65848
|
*/
|
|
@@ -65873,36 +65850,14 @@ paths: [string, ...(string)[]]
|
|
|
65873
65850
|
}
|
|
65874
65851
|
|
|
65875
65852
|
export interface BrainDaemonReingestOutput {
|
|
65876
|
-
/**
|
|
65877
|
-
* 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).
|
|
65878
|
-
*/
|
|
65879
|
-
runId: (string | null)
|
|
65880
|
-
/**
|
|
65881
|
-
* Paths whose ingest state was cleared, so the next run will read them again from scratch
|
|
65882
|
-
*/
|
|
65883
65853
|
cleared: string[]
|
|
65884
|
-
/**
|
|
65885
|
-
* Paths this daemon has no ingest record for — usually a typo, or a document it never ingested
|
|
65886
|
-
*/
|
|
65887
65854
|
notFound: string[]
|
|
65888
|
-
/**
|
|
65889
|
-
* 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
|
|
65890
|
-
*/
|
|
65891
65855
|
triggered: boolean
|
|
65892
|
-
/**
|
|
65893
|
-
* Why no run was started; absent when one was
|
|
65894
|
-
*/
|
|
65895
65856
|
triggerError?: string
|
|
65896
|
-
/**
|
|
65897
|
-
* Paths left alone because they are in an unfinished batch; re-ask once that run has finished
|
|
65898
|
-
*/
|
|
65899
65857
|
skippedPending: string[]
|
|
65900
65858
|
}
|
|
65901
65859
|
|
|
65902
65860
|
export interface BrainDaemonRemoveInput {
|
|
65903
|
-
/**
|
|
65904
|
-
* Id of the ingestion daemon to act on, as returned by brain_daemons_list
|
|
65905
|
-
*/
|
|
65906
65861
|
id: string
|
|
65907
65862
|
}
|
|
65908
65863
|
|
|
@@ -65911,107 +65866,32 @@ ok: true
|
|
|
65911
65866
|
}
|
|
65912
65867
|
|
|
65913
65868
|
export interface BrainDaemonRunInput {
|
|
65914
|
-
/**
|
|
65915
|
-
* Id of the ingestion daemon to act on, as returned by brain_daemons_list
|
|
65916
|
-
*/
|
|
65917
65869
|
id: string
|
|
65918
65870
|
}
|
|
65919
65871
|
|
|
65920
65872
|
export interface BrainDaemonRunOutput {
|
|
65921
|
-
/**
|
|
65922
|
-
* True once the run has finished, whether it succeeded or failed
|
|
65923
|
-
*/
|
|
65924
65873
|
done: boolean
|
|
65925
|
-
/**
|
|
65926
|
-
* Id of the run being reported; null when this daemon has never run
|
|
65927
|
-
*/
|
|
65928
65874
|
runId: (string | null)
|
|
65929
|
-
/**
|
|
65930
|
-
* Where the run stands: 'queued' waiting to start, 'running' in progress, 'done' finished, 'failed' gave up, 'none' this daemon has never run
|
|
65931
|
-
*/
|
|
65932
65875
|
status: ("queued" | "running" | "done" | "failed" | "none")
|
|
65933
|
-
/**
|
|
65934
|
-
* 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
|
|
65935
|
-
*/
|
|
65936
65876
|
sources: unknown[]
|
|
65937
|
-
/**
|
|
65938
|
-
* Document counts for the run; null when nothing has been counted yet
|
|
65939
|
-
*/
|
|
65940
65877
|
progress: ({
|
|
65941
|
-
|
|
65942
|
-
* Totals for the whole run
|
|
65943
|
-
*/
|
|
65944
|
-
counts: {
|
|
65945
|
-
/**
|
|
65946
|
-
* Documents that failed after retries — transient failures, worth re-running
|
|
65947
|
-
*/
|
|
65948
|
-
error: number
|
|
65949
|
-
/**
|
|
65950
|
-
* Documents the source permanently refused (403/404/401) — a permissions or deletion problem, not a transient one
|
|
65951
|
-
*/
|
|
65952
|
-
denied: number
|
|
65953
|
-
/**
|
|
65954
|
-
* Of those, how many were downloaded
|
|
65955
|
-
*/
|
|
65956
|
-
fetched: number
|
|
65957
|
-
/**
|
|
65958
|
-
* Of those, how many became memories
|
|
65959
|
-
*/
|
|
65960
|
-
ingested: number
|
|
65961
|
-
/**
|
|
65962
|
-
* Documents the run found at the source
|
|
65963
|
-
*/
|
|
65964
|
-
discovered: number
|
|
65965
|
-
/**
|
|
65966
|
-
* Documents skipped because their content had not changed since the last run
|
|
65967
|
-
*/
|
|
65968
|
-
skippedUnchanged: number
|
|
65969
|
-
}
|
|
65970
|
-
/**
|
|
65971
|
-
* 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)
|
|
65972
|
-
*/
|
|
65878
|
+
counts: BrainDaemonRunOutputCounts
|
|
65973
65879
|
byCategory: {
|
|
65974
|
-
[k: string]:
|
|
65975
|
-
|
|
65976
|
-
|
|
65977
|
-
|
|
65880
|
+
[k: string]: BrainDaemonRunOutputCounts
|
|
65881
|
+
}
|
|
65882
|
+
} | null)
|
|
65883
|
+
routedTo: ("realtime" | "batch")
|
|
65884
|
+
triggered: boolean
|
|
65885
|
+
triggerError?: string
|
|
65886
|
+
}
|
|
65887
|
+
export interface BrainDaemonRunOutputCounts {
|
|
65978
65888
|
error: number
|
|
65979
|
-
/**
|
|
65980
|
-
* Documents the source permanently refused (403/404/401) — a permissions or deletion problem, not a transient one
|
|
65981
|
-
*/
|
|
65982
65889
|
denied: number
|
|
65983
|
-
/**
|
|
65984
|
-
* Of those, how many were downloaded
|
|
65985
|
-
*/
|
|
65986
65890
|
fetched: number
|
|
65987
|
-
/**
|
|
65988
|
-
* Of those, how many became memories
|
|
65989
|
-
*/
|
|
65990
65891
|
ingested: number
|
|
65991
|
-
/**
|
|
65992
|
-
* Documents the run found at the source
|
|
65993
|
-
*/
|
|
65994
65892
|
discovered: number
|
|
65995
|
-
/**
|
|
65996
|
-
* Documents skipped because their content had not changed since the last run
|
|
65997
|
-
*/
|
|
65998
65893
|
skippedUnchanged: number
|
|
65999
65894
|
}
|
|
66000
|
-
}
|
|
66001
|
-
} | null)
|
|
66002
|
-
/**
|
|
66003
|
-
* Which lane the run went to: 'realtime' finishes in minutes, 'batch' queues the work with the model provider and can take hours
|
|
66004
|
-
*/
|
|
66005
|
-
routedTo: ("realtime" | "batch")
|
|
66006
|
-
/**
|
|
66007
|
-
* True when this call actually started a run; false when one was already in flight and nothing new was started
|
|
66008
|
-
*/
|
|
66009
|
-
triggered: boolean
|
|
66010
|
-
/**
|
|
66011
|
-
* Why the run could not be started; absent when it was started
|
|
66012
|
-
*/
|
|
66013
|
-
triggerError?: string
|
|
66014
|
-
}
|
|
66015
65895
|
|
|
66016
65896
|
export interface BrainDaemonRunItemsInput {
|
|
66017
65897
|
limit?: number
|
|
@@ -66031,212 +65911,68 @@ sourceKind: string
|
|
|
66031
65911
|
}[]
|
|
66032
65912
|
runId: string
|
|
66033
65913
|
counts: {
|
|
66034
|
-
/**
|
|
66035
|
-
* Documents that failed after retries — transient failures, worth re-running
|
|
66036
|
-
*/
|
|
66037
65914
|
error: number
|
|
66038
|
-
/**
|
|
66039
|
-
* Documents the source permanently refused (403/404/401) — a permissions or deletion problem, not a transient one
|
|
66040
|
-
*/
|
|
66041
65915
|
denied: number
|
|
66042
|
-
/**
|
|
66043
|
-
* Of those, how many were downloaded
|
|
66044
|
-
*/
|
|
66045
65916
|
fetched: number
|
|
66046
|
-
/**
|
|
66047
|
-
* Of those, how many became memories
|
|
66048
|
-
*/
|
|
66049
65917
|
ingested: number
|
|
66050
|
-
/**
|
|
66051
|
-
* Documents the run found at the source
|
|
66052
|
-
*/
|
|
66053
65918
|
discovered: number
|
|
66054
|
-
/**
|
|
66055
|
-
* Documents skipped because their content had not changed since the last run
|
|
66056
|
-
*/
|
|
66057
65919
|
skippedUnchanged: number
|
|
66058
65920
|
}
|
|
66059
65921
|
nextCursor: (string | null)
|
|
66060
65922
|
}
|
|
66061
65923
|
|
|
66062
65924
|
export interface BrainDaemonRunsInput {
|
|
66063
|
-
/**
|
|
66064
|
-
* Id of the ingestion daemon whose run history to read, as returned by brain_daemons_list
|
|
66065
|
-
*/
|
|
66066
65925
|
id: string
|
|
66067
|
-
/**
|
|
66068
|
-
* How many of the most recent runs to return (default 20, max 100)
|
|
66069
|
-
*/
|
|
66070
65926
|
limit?: number
|
|
66071
65927
|
}
|
|
66072
65928
|
|
|
66073
65929
|
export interface BrainDaemonRunsOutput {
|
|
66074
|
-
/**
|
|
66075
|
-
* The most recent runs, newest first
|
|
66076
|
-
*/
|
|
66077
65930
|
runs: {
|
|
66078
|
-
/**
|
|
66079
|
-
* 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
|
|
66080
|
-
*/
|
|
66081
65931
|
lane: ("realtime" | "batch" | "reclaimed")
|
|
66082
|
-
/**
|
|
66083
|
-
* Id of this run
|
|
66084
|
-
*/
|
|
66085
65932
|
runId: string
|
|
66086
|
-
/**
|
|
66087
|
-
* Document counts for this run
|
|
66088
|
-
*/
|
|
66089
65933
|
counts: {
|
|
66090
|
-
/**
|
|
66091
|
-
* Documents that failed after retries — transient failures, worth re-running
|
|
66092
|
-
*/
|
|
66093
65934
|
error: number
|
|
66094
|
-
/**
|
|
66095
|
-
* Documents the source permanently refused (403/404/401) — a permissions or deletion problem, not a transient one
|
|
66096
|
-
*/
|
|
66097
65935
|
denied: number
|
|
66098
|
-
/**
|
|
66099
|
-
* Of those, how many were downloaded
|
|
66100
|
-
*/
|
|
66101
65936
|
fetched: number
|
|
66102
|
-
/**
|
|
66103
|
-
* Of those, how many became memories
|
|
66104
|
-
*/
|
|
66105
65937
|
ingested: number
|
|
66106
|
-
/**
|
|
66107
|
-
* Documents the run found at the source
|
|
66108
|
-
*/
|
|
66109
65938
|
discovered: number
|
|
66110
|
-
/**
|
|
66111
|
-
* Documents skipped because their content had not changed since the last run
|
|
66112
|
-
*/
|
|
66113
65939
|
skippedUnchanged: number
|
|
66114
65940
|
}
|
|
66115
|
-
/**
|
|
66116
|
-
* Where the run ended up — 'queued', 'running', 'done' or 'failed'
|
|
66117
|
-
*/
|
|
66118
65941
|
status: string
|
|
66119
|
-
/**
|
|
66120
|
-
* How a batch run finished, in the batch pipeline's own words (e.g. finalized, timeout, crash); null for a realtime run
|
|
66121
|
-
*/
|
|
66122
65942
|
outcome: (string | null)
|
|
66123
|
-
/**
|
|
66124
|
-
* When the run started, ISO 8601 timestamp
|
|
66125
|
-
*/
|
|
66126
65943
|
startedAt: string
|
|
66127
|
-
/**
|
|
66128
|
-
* Documents that failed after retries during this run
|
|
66129
|
-
*/
|
|
66130
65944
|
errorCount: number
|
|
66131
|
-
/**
|
|
66132
|
-
* When the run finished, ISO 8601 timestamp; null while it is still going
|
|
66133
|
-
*/
|
|
66134
65945
|
finishedAt: (string | null)
|
|
66135
|
-
/**
|
|
66136
|
-
* Documents the source permanently refused during this run
|
|
66137
|
-
*/
|
|
66138
65946
|
deniedCount: number
|
|
66139
|
-
/**
|
|
66140
|
-
* 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
|
|
66141
|
-
*/
|
|
66142
65947
|
degradedCount: (number | null)
|
|
66143
65948
|
}[]
|
|
66144
|
-
/**
|
|
66145
|
-
* Id of the daemon these runs belong to
|
|
66146
|
-
*/
|
|
66147
65949
|
daemonId: string
|
|
66148
65950
|
}
|
|
66149
65951
|
|
|
66150
65952
|
export interface BrainDaemonStatusInput {
|
|
66151
|
-
/**
|
|
66152
|
-
* Id of the ingestion daemon to act on, as returned by brain_daemons_list
|
|
66153
|
-
*/
|
|
66154
65953
|
id: string
|
|
66155
65954
|
}
|
|
66156
65955
|
|
|
66157
65956
|
export interface BrainDaemonStatusOutput {
|
|
66158
|
-
/**
|
|
66159
|
-
* True once the run has finished, whether it succeeded or failed
|
|
66160
|
-
*/
|
|
66161
65957
|
done: boolean
|
|
66162
|
-
/**
|
|
66163
|
-
* Id of the run being reported; null when this daemon has never run
|
|
66164
|
-
*/
|
|
66165
65958
|
runId: (string | null)
|
|
66166
|
-
/**
|
|
66167
|
-
* Where the run stands: 'queued' waiting to start, 'running' in progress, 'done' finished, 'failed' gave up, 'none' this daemon has never run
|
|
66168
|
-
*/
|
|
66169
65959
|
status: ("queued" | "running" | "done" | "failed" | "none")
|
|
66170
|
-
/**
|
|
66171
|
-
* 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
|
|
66172
|
-
*/
|
|
66173
65960
|
sources: unknown[]
|
|
66174
|
-
/**
|
|
66175
|
-
* Document counts for the run; null when nothing has been counted yet
|
|
66176
|
-
*/
|
|
66177
65961
|
progress: ({
|
|
66178
|
-
|
|
66179
|
-
* Totals for the whole run
|
|
66180
|
-
*/
|
|
66181
|
-
counts: {
|
|
66182
|
-
/**
|
|
66183
|
-
* Documents that failed after retries — transient failures, worth re-running
|
|
66184
|
-
*/
|
|
66185
|
-
error: number
|
|
66186
|
-
/**
|
|
66187
|
-
* Documents the source permanently refused (403/404/401) — a permissions or deletion problem, not a transient one
|
|
66188
|
-
*/
|
|
66189
|
-
denied: number
|
|
66190
|
-
/**
|
|
66191
|
-
* Of those, how many were downloaded
|
|
66192
|
-
*/
|
|
66193
|
-
fetched: number
|
|
66194
|
-
/**
|
|
66195
|
-
* Of those, how many became memories
|
|
66196
|
-
*/
|
|
66197
|
-
ingested: number
|
|
66198
|
-
/**
|
|
66199
|
-
* Documents the run found at the source
|
|
66200
|
-
*/
|
|
66201
|
-
discovered: number
|
|
66202
|
-
/**
|
|
66203
|
-
* Documents skipped because their content had not changed since the last run
|
|
66204
|
-
*/
|
|
66205
|
-
skippedUnchanged: number
|
|
66206
|
-
}
|
|
66207
|
-
/**
|
|
66208
|
-
* 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)
|
|
66209
|
-
*/
|
|
65962
|
+
counts: BrainDaemonStatusOutputCounts
|
|
66210
65963
|
byCategory: {
|
|
66211
|
-
[k: string]:
|
|
66212
|
-
|
|
66213
|
-
|
|
66214
|
-
|
|
65964
|
+
[k: string]: BrainDaemonStatusOutputCounts
|
|
65965
|
+
}
|
|
65966
|
+
} | null)
|
|
65967
|
+
}
|
|
65968
|
+
export interface BrainDaemonStatusOutputCounts {
|
|
66215
65969
|
error: number
|
|
66216
|
-
/**
|
|
66217
|
-
* Documents the source permanently refused (403/404/401) — a permissions or deletion problem, not a transient one
|
|
66218
|
-
*/
|
|
66219
65970
|
denied: number
|
|
66220
|
-
/**
|
|
66221
|
-
* Of those, how many were downloaded
|
|
66222
|
-
*/
|
|
66223
65971
|
fetched: number
|
|
66224
|
-
/**
|
|
66225
|
-
* Of those, how many became memories
|
|
66226
|
-
*/
|
|
66227
65972
|
ingested: number
|
|
66228
|
-
/**
|
|
66229
|
-
* Documents the run found at the source
|
|
66230
|
-
*/
|
|
66231
65973
|
discovered: number
|
|
66232
|
-
/**
|
|
66233
|
-
* Documents skipped because their content had not changed since the last run
|
|
66234
|
-
*/
|
|
66235
65974
|
skippedUnchanged: number
|
|
66236
65975
|
}
|
|
66237
|
-
}
|
|
66238
|
-
} | null)
|
|
66239
|
-
}
|
|
66240
65976
|
|
|
66241
65977
|
export interface BrainDaemonUpdateInput {
|
|
66242
65978
|
id: string
|
|
@@ -66332,121 +66068,46 @@ entity_ref: string
|
|
|
66332
66068
|
}
|
|
66333
66069
|
|
|
66334
66070
|
export interface BrainKnowledgeEntityMemoriesOutput {
|
|
66335
|
-
/**
|
|
66336
|
-
* How many memories back this entity in total, across all pages
|
|
66337
|
-
*/
|
|
66338
66071
|
total: number
|
|
66339
|
-
/**
|
|
66340
|
-
* The entity the memories belong to; null when `entity_ref` matched nothing
|
|
66341
|
-
*/
|
|
66342
66072
|
entity: ({
|
|
66343
|
-
/**
|
|
66344
|
-
* How closely this entity matches the query, higher is closer; absent on an unscored read such as a plain type filter
|
|
66345
|
-
*/
|
|
66346
66073
|
score?: number
|
|
66347
|
-
/**
|
|
66348
|
-
* Other names the same entity appears under in the ingested text
|
|
66349
|
-
*/
|
|
66350
66074
|
aliases: string[]
|
|
66351
|
-
/**
|
|
66352
|
-
* Id of this entity; pass it as `entity_ref` to brain_knowledge_neighborhood or brain_knowledge_entity_memories
|
|
66353
|
-
*/
|
|
66354
66075
|
entity_id: string
|
|
66355
|
-
/**
|
|
66356
|
-
* What the entity is, as the engine summarised it from the memories mentioning it; null when it has not written one
|
|
66357
|
-
*/
|
|
66358
66076
|
description: (string | null)
|
|
66359
|
-
/**
|
|
66360
|
-
* Ontology type of the entity, e.g. Feature, Decision, Risk, Integration
|
|
66361
|
-
*/
|
|
66362
66077
|
entity_type: string
|
|
66363
|
-
/**
|
|
66364
|
-
* The name to show a person — usually the spelling the source text used
|
|
66365
|
-
*/
|
|
66366
66078
|
display_name: string
|
|
66367
|
-
/**
|
|
66368
|
-
* The one name this entity is stored under; use it when matching entities against each other
|
|
66369
|
-
*/
|
|
66370
66079
|
canonical_name: string
|
|
66371
|
-
/**
|
|
66372
|
-
* How many memories mention this entity — a rough measure of how well attested it is
|
|
66373
|
-
*/
|
|
66374
66080
|
evidence_count: number
|
|
66375
66081
|
} | null)
|
|
66376
|
-
/**
|
|
66377
|
-
* One page of the memories this entity was drawn from — the same shape brain_memory_list returns
|
|
66378
|
-
*/
|
|
66379
66082
|
memories: {
|
|
66380
66083
|
/**
|
|
66381
66084
|
* Consumer-facing label derived from the layer; 'unknown' for an unrecognised layer
|
|
66382
66085
|
*/
|
|
66383
66086
|
kind: ("schema" | "intention" | "identity" | "basic" | "fact" | "summary" | "knowledge" | "raw" | "unknown")
|
|
66384
|
-
/**
|
|
66385
|
-
* Engine tags on this memory; empty when it carries none
|
|
66386
|
-
*/
|
|
66387
66087
|
tags: string[]
|
|
66388
66088
|
/**
|
|
66389
66089
|
* Engine memory layer (l0_basic_info…l7_intention)
|
|
66390
66090
|
*/
|
|
66391
66091
|
layer: ("l6_schema" | "l7_intention" | "l4_identity" | "l0_basic_info" | "l2_fact" | "l3_summary" | "l5_knowledge" | "l1_raw")
|
|
66392
|
-
/**
|
|
66393
|
-
* Free-form metadata, verbatim as the writer passed brain_memory_add's `metadata`; keys are the caller's
|
|
66394
|
-
*/
|
|
66395
66092
|
custom: {
|
|
66396
66093
|
[k: string]: unknown
|
|
66397
66094
|
}
|
|
66398
|
-
/**
|
|
66399
|
-
* Engine lifecycle status of the row — 'active' for a memory in use; superseded rows are not listed
|
|
66400
|
-
*/
|
|
66401
66095
|
status: string
|
|
66402
|
-
/**
|
|
66403
|
-
* The memory text itself
|
|
66404
|
-
*/
|
|
66405
66096
|
content: string
|
|
66406
|
-
/**
|
|
66407
|
-
* Engine user namespace the memory was written under
|
|
66408
|
-
*/
|
|
66409
66097
|
user_id: string
|
|
66410
|
-
/**
|
|
66411
|
-
* Engine agent namespace the memory was written under — the shared pool for a 'shared' write, the caller's own for a private one
|
|
66412
|
-
*/
|
|
66413
66098
|
agent_id: string
|
|
66414
|
-
/**
|
|
66415
|
-
* When the remembered EVENT happened, epoch milliseconds; null when the writer stated no time
|
|
66416
|
-
*/
|
|
66417
66099
|
memory_at: (number | null)
|
|
66418
|
-
/**
|
|
66419
|
-
* Engine id of this memory; pass it to brain_memory_get, _update or _delete
|
|
66420
|
-
*/
|
|
66421
66100
|
memory_id: string
|
|
66422
|
-
/**
|
|
66423
|
-
* The engine's own inference about this memory, or null when it recorded none
|
|
66424
|
-
*/
|
|
66425
66101
|
speculate: (string | null)
|
|
66426
|
-
/**
|
|
66427
|
-
* Engine session the memory was written in; empty when the writer opened none
|
|
66428
|
-
*/
|
|
66429
66102
|
session_id: string
|
|
66430
|
-
/**
|
|
66431
|
-
* When this memory row was written, epoch milliseconds
|
|
66432
|
-
*/
|
|
66433
66103
|
gmt_created: number
|
|
66434
66104
|
/**
|
|
66435
66105
|
* Source authority (highest→lowest): policy > official > team > informal
|
|
66436
66106
|
*/
|
|
66437
66107
|
source_authority: ("policy" | "official" | "team" | "informal")
|
|
66438
|
-
/**
|
|
66439
|
-
* Id of the l1_raw memory this one was derived from; null when it was written directly
|
|
66440
|
-
*/
|
|
66441
66108
|
source_raw_memory_id: (string | null)
|
|
66442
66109
|
}[]
|
|
66443
|
-
/**
|
|
66444
|
-
* How long the engine took to answer, milliseconds
|
|
66445
|
-
*/
|
|
66446
66110
|
elapsed_ms: number
|
|
66447
|
-
/**
|
|
66448
|
-
* Engine request id for this call — quote it when reporting a problem
|
|
66449
|
-
*/
|
|
66450
66111
|
request_id: string
|
|
66451
66112
|
}
|
|
66452
66113
|
|
|
@@ -66462,92 +66123,29 @@ scope?: ("shared" | "private" | "both")
|
|
|
66462
66123
|
}
|
|
66463
66124
|
|
|
66464
66125
|
export interface BrainKnowledgeGraphOutput {
|
|
66465
|
-
/**
|
|
66466
|
-
* The typed relations between those entities
|
|
66467
|
-
*/
|
|
66468
66126
|
edges: {
|
|
66469
|
-
/**
|
|
66470
|
-
* Why the engine drew this edge, in its own words; null when it recorded none
|
|
66471
|
-
*/
|
|
66472
66127
|
reason: (string | null)
|
|
66473
|
-
/**
|
|
66474
|
-
* Id of the node the edge points FROM (a `nodes[].id`)
|
|
66475
|
-
*/
|
|
66476
66128
|
source: string
|
|
66477
|
-
/**
|
|
66478
|
-
* Id of the node the edge points TO (a `nodes[].id`)
|
|
66479
|
-
*/
|
|
66480
66129
|
target: string
|
|
66481
|
-
/**
|
|
66482
|
-
* True when the relation reads the same in both directions
|
|
66483
|
-
*/
|
|
66484
66130
|
symmetric: boolean
|
|
66485
|
-
/**
|
|
66486
|
-
* Ontology type of the relation, e.g. depends_on, competes_with, owns
|
|
66487
|
-
*/
|
|
66488
66131
|
relation_type: string
|
|
66489
66132
|
}[]
|
|
66490
|
-
/**
|
|
66491
|
-
* The entities in the exported graph
|
|
66492
|
-
*/
|
|
66493
66133
|
nodes: {
|
|
66494
|
-
/**
|
|
66495
|
-
* Id of this entity; the `source` and `target` of an edge refer to it
|
|
66496
|
-
*/
|
|
66497
66134
|
id: string
|
|
66498
|
-
/**
|
|
66499
|
-
* How many edges touch this node — the hub concepts are the ones kept when the export is truncated
|
|
66500
|
-
*/
|
|
66501
66135
|
degree: number
|
|
66502
|
-
/**
|
|
66503
|
-
* Other names the same entity appears under in the ingested text
|
|
66504
|
-
*/
|
|
66505
66136
|
aliases: string[]
|
|
66506
|
-
/**
|
|
66507
|
-
* What the entity is, as the engine summarised it; null when it has not written one
|
|
66508
|
-
*/
|
|
66509
66137
|
description: (string | null)
|
|
66510
|
-
/**
|
|
66511
|
-
* Ontology type of the entity, e.g. Feature, Decision, Risk, Integration
|
|
66512
|
-
*/
|
|
66513
66138
|
entity_type: string
|
|
66514
|
-
/**
|
|
66515
|
-
* The name to show a person
|
|
66516
|
-
*/
|
|
66517
66139
|
display_name: string
|
|
66518
|
-
/**
|
|
66519
|
-
* The one name this entity is stored under
|
|
66520
|
-
*/
|
|
66521
66140
|
canonical_name: string
|
|
66522
|
-
/**
|
|
66523
|
-
* How many memories mention this entity
|
|
66524
|
-
*/
|
|
66525
66141
|
evidence_count: number
|
|
66526
66142
|
}[]
|
|
66527
|
-
/**
|
|
66528
|
-
* Sizes of what was actually returned
|
|
66529
|
-
*/
|
|
66530
66143
|
totals: {
|
|
66531
|
-
/**
|
|
66532
|
-
* Edges returned in this export
|
|
66533
|
-
*/
|
|
66534
66144
|
edgeCount: number
|
|
66535
|
-
/**
|
|
66536
|
-
* Nodes returned in this export
|
|
66537
|
-
*/
|
|
66538
66145
|
nodeCount: number
|
|
66539
66146
|
}
|
|
66540
|
-
/**
|
|
66541
|
-
* True when `limit` cut the export short — the highest-degree nodes were kept, so what you get is the hubs
|
|
66542
|
-
*/
|
|
66543
66147
|
truncated: boolean
|
|
66544
|
-
/**
|
|
66545
|
-
* How long the engine took to answer, milliseconds
|
|
66546
|
-
*/
|
|
66547
66148
|
elapsed_ms: number
|
|
66548
|
-
/**
|
|
66549
|
-
* Engine request id for this call — quote it when reporting a problem
|
|
66550
|
-
*/
|
|
66551
66149
|
request_id: string
|
|
66552
66150
|
}
|
|
66553
66151
|
|
|
@@ -66579,128 +66177,38 @@ relation_type?: string
|
|
|
66579
66177
|
}
|
|
66580
66178
|
|
|
66581
66179
|
export interface BrainKnowledgeNeighborhoodOutput {
|
|
66582
|
-
/**
|
|
66583
|
-
* The entity that was expanded around; null when `entity_ref` matched nothing
|
|
66584
|
-
*/
|
|
66585
66180
|
root: ({
|
|
66586
|
-
/**
|
|
66587
|
-
* How closely this entity matches the query, higher is closer; absent on an unscored read such as a plain type filter
|
|
66588
|
-
*/
|
|
66589
66181
|
score?: number
|
|
66590
|
-
/**
|
|
66591
|
-
* Other names the same entity appears under in the ingested text
|
|
66592
|
-
*/
|
|
66593
66182
|
aliases: string[]
|
|
66594
|
-
/**
|
|
66595
|
-
* Id of this entity; pass it as `entity_ref` to brain_knowledge_neighborhood or brain_knowledge_entity_memories
|
|
66596
|
-
*/
|
|
66597
66183
|
entity_id: string
|
|
66598
|
-
/**
|
|
66599
|
-
* What the entity is, as the engine summarised it from the memories mentioning it; null when it has not written one
|
|
66600
|
-
*/
|
|
66601
66184
|
description: (string | null)
|
|
66602
|
-
/**
|
|
66603
|
-
* Ontology type of the entity, e.g. Feature, Decision, Risk, Integration
|
|
66604
|
-
*/
|
|
66605
66185
|
entity_type: string
|
|
66606
|
-
/**
|
|
66607
|
-
* The name to show a person — usually the spelling the source text used
|
|
66608
|
-
*/
|
|
66609
66186
|
display_name: string
|
|
66610
|
-
/**
|
|
66611
|
-
* The one name this entity is stored under; use it when matching entities against each other
|
|
66612
|
-
*/
|
|
66613
66187
|
canonical_name: string
|
|
66614
|
-
/**
|
|
66615
|
-
* How many memories mention this entity — a rough measure of how well attested it is
|
|
66616
|
-
*/
|
|
66617
66188
|
evidence_count: number
|
|
66618
66189
|
} | null)
|
|
66619
|
-
/**
|
|
66620
|
-
* The neighbours reached within `depth` hops of the root, the root excluded
|
|
66621
|
-
*/
|
|
66622
66190
|
entities: {
|
|
66623
|
-
/**
|
|
66624
|
-
* How closely this entity matches the query, higher is closer; absent on an unscored read such as a plain type filter
|
|
66625
|
-
*/
|
|
66626
66191
|
score?: number
|
|
66627
|
-
/**
|
|
66628
|
-
* Other names the same entity appears under in the ingested text
|
|
66629
|
-
*/
|
|
66630
66192
|
aliases: string[]
|
|
66631
|
-
/**
|
|
66632
|
-
* Id of this entity; pass it as `entity_ref` to brain_knowledge_neighborhood or brain_knowledge_entity_memories
|
|
66633
|
-
*/
|
|
66634
66193
|
entity_id: string
|
|
66635
|
-
/**
|
|
66636
|
-
* What the entity is, as the engine summarised it from the memories mentioning it; null when it has not written one
|
|
66637
|
-
*/
|
|
66638
66194
|
description: (string | null)
|
|
66639
|
-
/**
|
|
66640
|
-
* Ontology type of the entity, e.g. Feature, Decision, Risk, Integration
|
|
66641
|
-
*/
|
|
66642
66195
|
entity_type: string
|
|
66643
|
-
/**
|
|
66644
|
-
* The name to show a person — usually the spelling the source text used
|
|
66645
|
-
*/
|
|
66646
66196
|
display_name: string
|
|
66647
|
-
/**
|
|
66648
|
-
* The one name this entity is stored under; use it when matching entities against each other
|
|
66649
|
-
*/
|
|
66650
66197
|
canonical_name: string
|
|
66651
|
-
/**
|
|
66652
|
-
* How many memories mention this entity — a rough measure of how well attested it is
|
|
66653
|
-
*/
|
|
66654
66198
|
evidence_count: number
|
|
66655
66199
|
}[]
|
|
66656
|
-
/**
|
|
66657
|
-
* The relations that connect the root and the neighbours above
|
|
66658
|
-
*/
|
|
66659
66200
|
relations: {
|
|
66660
|
-
/**
|
|
66661
|
-
* Why the engine drew this relation, in its own words; null when it recorded none
|
|
66662
|
-
*/
|
|
66663
66201
|
reason: (string | null)
|
|
66664
|
-
/**
|
|
66665
|
-
* Id of the entity the relation points FROM
|
|
66666
|
-
*/
|
|
66667
66202
|
source_id: string
|
|
66668
|
-
/**
|
|
66669
|
-
* True when the relation reads the same in both directions, so source and target are interchangeable
|
|
66670
|
-
*/
|
|
66671
66203
|
symmetric: boolean
|
|
66672
|
-
/**
|
|
66673
|
-
* Id of the entity the relation points TO
|
|
66674
|
-
*/
|
|
66675
66204
|
target_id: string
|
|
66676
|
-
/**
|
|
66677
|
-
* Ontology type of the relation, e.g. depends_on, competes_with, owns
|
|
66678
|
-
*/
|
|
66679
66205
|
relation_type: string
|
|
66680
|
-
/**
|
|
66681
|
-
* Name to show for the source entity
|
|
66682
|
-
*/
|
|
66683
66206
|
source_display_name: string
|
|
66684
|
-
/**
|
|
66685
|
-
* Name to show for the target entity
|
|
66686
|
-
*/
|
|
66687
66207
|
target_display_name: string
|
|
66688
|
-
/**
|
|
66689
|
-
* Stored name of the source entity
|
|
66690
|
-
*/
|
|
66691
66208
|
source_canonical_name: string
|
|
66692
|
-
/**
|
|
66693
|
-
* Stored name of the target entity
|
|
66694
|
-
*/
|
|
66695
66209
|
target_canonical_name: string
|
|
66696
66210
|
}[]
|
|
66697
|
-
/**
|
|
66698
|
-
* How long the engine took to answer, milliseconds
|
|
66699
|
-
*/
|
|
66700
66211
|
elapsed_ms: number
|
|
66701
|
-
/**
|
|
66702
|
-
* Engine request id for this call — quote it when reporting a problem
|
|
66703
|
-
*/
|
|
66704
66212
|
request_id: string
|
|
66705
66213
|
}
|
|
66706
66214
|
|
|
@@ -66728,54 +66236,18 @@ target_entity?: string
|
|
|
66728
66236
|
}
|
|
66729
66237
|
|
|
66730
66238
|
export interface BrainKnowledgeRelationsOutput {
|
|
66731
|
-
/**
|
|
66732
|
-
* The relations matching the filters
|
|
66733
|
-
*/
|
|
66734
66239
|
relations: {
|
|
66735
|
-
/**
|
|
66736
|
-
* Why the engine drew this relation, in its own words; null when it recorded none
|
|
66737
|
-
*/
|
|
66738
66240
|
reason: (string | null)
|
|
66739
|
-
/**
|
|
66740
|
-
* Id of the entity the relation points FROM
|
|
66741
|
-
*/
|
|
66742
66241
|
source_id: string
|
|
66743
|
-
/**
|
|
66744
|
-
* True when the relation reads the same in both directions, so source and target are interchangeable
|
|
66745
|
-
*/
|
|
66746
66242
|
symmetric: boolean
|
|
66747
|
-
/**
|
|
66748
|
-
* Id of the entity the relation points TO
|
|
66749
|
-
*/
|
|
66750
66243
|
target_id: string
|
|
66751
|
-
/**
|
|
66752
|
-
* Ontology type of the relation, e.g. depends_on, competes_with, owns
|
|
66753
|
-
*/
|
|
66754
66244
|
relation_type: string
|
|
66755
|
-
/**
|
|
66756
|
-
* Name to show for the source entity
|
|
66757
|
-
*/
|
|
66758
66245
|
source_display_name: string
|
|
66759
|
-
/**
|
|
66760
|
-
* Name to show for the target entity
|
|
66761
|
-
*/
|
|
66762
66246
|
target_display_name: string
|
|
66763
|
-
/**
|
|
66764
|
-
* Stored name of the source entity
|
|
66765
|
-
*/
|
|
66766
66247
|
source_canonical_name: string
|
|
66767
|
-
/**
|
|
66768
|
-
* Stored name of the target entity
|
|
66769
|
-
*/
|
|
66770
66248
|
target_canonical_name: string
|
|
66771
66249
|
}[]
|
|
66772
|
-
/**
|
|
66773
|
-
* How long the engine took to answer, milliseconds
|
|
66774
|
-
*/
|
|
66775
66250
|
elapsed_ms: number
|
|
66776
|
-
/**
|
|
66777
|
-
* Engine request id for this call — quote it when reporting a problem
|
|
66778
|
-
*/
|
|
66779
66251
|
request_id: string
|
|
66780
66252
|
}
|
|
66781
66253
|
|
|
@@ -66803,54 +66275,18 @@ entity_type?: string
|
|
|
66803
66275
|
}
|
|
66804
66276
|
|
|
66805
66277
|
export interface BrainKnowledgeSearchOutput {
|
|
66806
|
-
/**
|
|
66807
|
-
* How many entities match in total, across all pages — not the length of this page
|
|
66808
|
-
*/
|
|
66809
66278
|
total: number
|
|
66810
|
-
/**
|
|
66811
|
-
* Matching entities, best match first
|
|
66812
|
-
*/
|
|
66813
66279
|
entities: {
|
|
66814
|
-
/**
|
|
66815
|
-
* How closely this entity matches the query, higher is closer; absent on an unscored read such as a plain type filter
|
|
66816
|
-
*/
|
|
66817
66280
|
score?: number
|
|
66818
|
-
/**
|
|
66819
|
-
* Other names the same entity appears under in the ingested text
|
|
66820
|
-
*/
|
|
66821
66281
|
aliases: string[]
|
|
66822
|
-
/**
|
|
66823
|
-
* Id of this entity; pass it as `entity_ref` to brain_knowledge_neighborhood or brain_knowledge_entity_memories
|
|
66824
|
-
*/
|
|
66825
66282
|
entity_id: string
|
|
66826
|
-
/**
|
|
66827
|
-
* What the entity is, as the engine summarised it from the memories mentioning it; null when it has not written one
|
|
66828
|
-
*/
|
|
66829
66283
|
description: (string | null)
|
|
66830
|
-
/**
|
|
66831
|
-
* Ontology type of the entity, e.g. Feature, Decision, Risk, Integration
|
|
66832
|
-
*/
|
|
66833
66284
|
entity_type: string
|
|
66834
|
-
/**
|
|
66835
|
-
* The name to show a person — usually the spelling the source text used
|
|
66836
|
-
*/
|
|
66837
66285
|
display_name: string
|
|
66838
|
-
/**
|
|
66839
|
-
* The one name this entity is stored under; use it when matching entities against each other
|
|
66840
|
-
*/
|
|
66841
66286
|
canonical_name: string
|
|
66842
|
-
/**
|
|
66843
|
-
* How many memories mention this entity — a rough measure of how well attested it is
|
|
66844
|
-
*/
|
|
66845
66287
|
evidence_count: number
|
|
66846
66288
|
}[]
|
|
66847
|
-
/**
|
|
66848
|
-
* How long the engine took to answer, milliseconds
|
|
66849
|
-
*/
|
|
66850
66289
|
elapsed_ms: number
|
|
66851
|
-
/**
|
|
66852
|
-
* Engine request id for this call — quote it when reporting a problem
|
|
66853
|
-
*/
|
|
66854
66290
|
request_id: string
|
|
66855
66291
|
}
|
|
66856
66292
|
|
|
@@ -66876,17 +66312,8 @@ source_authority?: ("policy" | "official" | "team" | "informal")
|
|
|
66876
66312
|
}
|
|
66877
66313
|
|
|
66878
66314
|
export interface BrainMemoryAddOutput {
|
|
66879
|
-
/**
|
|
66880
|
-
* True when the memory was stored
|
|
66881
|
-
*/
|
|
66882
66315
|
success: boolean
|
|
66883
|
-
/**
|
|
66884
|
-
* Engine id of the memory just stored; keep it to read, replace or delete the memory later
|
|
66885
|
-
*/
|
|
66886
66316
|
memory_id: string
|
|
66887
|
-
/**
|
|
66888
|
-
* Engine request id for this call — quote it when reporting a problem
|
|
66889
|
-
*/
|
|
66890
66317
|
request_id: string
|
|
66891
66318
|
}
|
|
66892
66319
|
|
|
@@ -66898,17 +66325,8 @@ memory_id: string
|
|
|
66898
66325
|
}
|
|
66899
66326
|
|
|
66900
66327
|
export interface BrainMemoryDeleteOutput {
|
|
66901
|
-
/**
|
|
66902
|
-
* Always true — the call fails outright rather than reporting a false here
|
|
66903
|
-
*/
|
|
66904
66328
|
success: true
|
|
66905
|
-
/**
|
|
66906
|
-
* Engine request id for this call — quote it when reporting a problem
|
|
66907
|
-
*/
|
|
66908
66329
|
request_id: string
|
|
66909
|
-
/**
|
|
66910
|
-
* How many memory rows the engine removed for this id; 0 when it was already gone
|
|
66911
|
-
*/
|
|
66912
66330
|
deleted_count: number
|
|
66913
66331
|
}
|
|
66914
66332
|
|
|
@@ -66920,179 +66338,74 @@ memory_id: string
|
|
|
66920
66338
|
}
|
|
66921
66339
|
|
|
66922
66340
|
export interface BrainMemoryGetOutput {
|
|
66923
|
-
/**
|
|
66924
|
-
* Engine tags on this memory; empty when it carries none
|
|
66925
|
-
*/
|
|
66926
66341
|
tags: string[]
|
|
66927
66342
|
/**
|
|
66928
66343
|
* Engine memory layer (l0_basic_info…l7_intention)
|
|
66929
66344
|
*/
|
|
66930
66345
|
layer: ("l6_schema" | "l7_intention" | "l4_identity" | "l0_basic_info" | "l2_fact" | "l3_summary" | "l5_knowledge" | "l1_raw")
|
|
66931
|
-
/**
|
|
66932
|
-
* Free-form metadata, verbatim as the writer passed brain_memory_add's `metadata`; keys are the caller's
|
|
66933
|
-
*/
|
|
66934
66346
|
custom: {
|
|
66935
66347
|
[k: string]: unknown
|
|
66936
66348
|
}
|
|
66937
|
-
/**
|
|
66938
|
-
* Which store answered the read — 'vdb' the vector store, 'graph' the memory graph. Diagnostic; the content is the same either way.
|
|
66939
|
-
*/
|
|
66940
66349
|
source: ("vdb" | "graph")
|
|
66941
|
-
/**
|
|
66942
|
-
* Engine lifecycle status of the row — 'active' for a memory in use
|
|
66943
|
-
*/
|
|
66944
66350
|
status: string
|
|
66945
|
-
/**
|
|
66946
|
-
* The memory text itself
|
|
66947
|
-
*/
|
|
66948
66351
|
content: string
|
|
66949
|
-
/**
|
|
66950
|
-
* Engine user namespace the memory was written under
|
|
66951
|
-
*/
|
|
66952
66352
|
user_id: string
|
|
66953
|
-
/**
|
|
66954
|
-
* Engine agent namespace the memory was written under
|
|
66955
|
-
*/
|
|
66956
66353
|
agent_id: string
|
|
66957
|
-
/**
|
|
66958
|
-
* True when this is the current version of the memory; false when a newer one has replaced it
|
|
66959
|
-
*/
|
|
66960
66354
|
is_latest: boolean
|
|
66961
|
-
/**
|
|
66962
|
-
* When the remembered EVENT happened, epoch milliseconds; null when the writer stated no time
|
|
66963
|
-
*/
|
|
66964
66355
|
memory_at: (number | null)
|
|
66965
|
-
/**
|
|
66966
|
-
* Engine id of this memory — the id that was asked for
|
|
66967
|
-
*/
|
|
66968
66356
|
memory_id: string
|
|
66969
|
-
/**
|
|
66970
|
-
* The engine's own inference about this memory, or null when it recorded none
|
|
66971
|
-
*/
|
|
66972
66357
|
speculate: (string | null)
|
|
66973
|
-
/**
|
|
66974
|
-
* The engine's confidence in this memory, 0..1
|
|
66975
|
-
*/
|
|
66976
66358
|
confidence: number
|
|
66977
|
-
/**
|
|
66978
|
-
* How long the engine took to answer, milliseconds
|
|
66979
|
-
*/
|
|
66980
66359
|
elapsed_ms: number
|
|
66981
|
-
/**
|
|
66982
|
-
* Engine request id for this call — quote it when reporting a problem
|
|
66983
|
-
*/
|
|
66984
66360
|
request_id: string
|
|
66985
|
-
/**
|
|
66986
|
-
* Ids of the memories this one replaced; null when it replaced none
|
|
66987
|
-
*/
|
|
66988
66361
|
supersedes: (string[] | null)
|
|
66989
|
-
/**
|
|
66990
|
-
* When this memory row was written, epoch milliseconds
|
|
66991
|
-
*/
|
|
66992
66362
|
gmt_created: number
|
|
66993
|
-
/**
|
|
66994
|
-
* Ids of the memories that replaced this one; null while it is still current
|
|
66995
|
-
*/
|
|
66996
66363
|
superseded_by: (string[] | null)
|
|
66997
66364
|
/**
|
|
66998
66365
|
* Source authority (highest→lowest): policy > official > team > informal
|
|
66999
66366
|
*/
|
|
67000
66367
|
source_authority: ("policy" | "official" | "team" | "informal")
|
|
67001
|
-
/**
|
|
67002
|
-
* Id of the l1_raw memory this one was derived from; null when it was written directly
|
|
67003
|
-
*/
|
|
67004
66368
|
source_raw_memory_id: (string | null)
|
|
67005
66369
|
}
|
|
67006
66370
|
|
|
67007
66371
|
export interface BrainMemoryListInput {
|
|
67008
|
-
/**
|
|
67009
|
-
* How many memories to return, max 1000. Omit to use the engine's own page size.
|
|
67010
|
-
*/
|
|
67011
66372
|
limit?: number
|
|
67012
|
-
/**
|
|
67013
|
-
* Sort by write time: 'desc' newest first, 'asc' oldest first. Omit to take the engine's own order.
|
|
67014
|
-
*/
|
|
67015
66373
|
order?: ("asc" | "desc")
|
|
67016
66374
|
/**
|
|
67017
66375
|
* Read scope; 'both' (default) unions shared + your private
|
|
67018
66376
|
*/
|
|
67019
66377
|
scope?: ("shared" | "private" | "both")
|
|
67020
|
-
/**
|
|
67021
|
-
* How many memories to skip before this page — offset 100 with limit 100 is the second page. Omit to start at the beginning.
|
|
67022
|
-
*/
|
|
67023
66378
|
offset?: number
|
|
67024
66379
|
}
|
|
67025
66380
|
|
|
67026
66381
|
export interface BrainMemoryListOutput {
|
|
67027
|
-
/**
|
|
67028
|
-
* How many memories match in total, across all pages — not the length of this page
|
|
67029
|
-
*/
|
|
67030
66382
|
total: number
|
|
67031
|
-
/**
|
|
67032
|
-
* One page of memories, newest first unless `order` said otherwise
|
|
67033
|
-
*/
|
|
67034
66383
|
memories: {
|
|
67035
66384
|
/**
|
|
67036
66385
|
* Consumer-facing label derived from the layer; 'unknown' for an unrecognised layer
|
|
67037
66386
|
*/
|
|
67038
66387
|
kind: ("schema" | "intention" | "identity" | "basic" | "fact" | "summary" | "knowledge" | "raw" | "unknown")
|
|
67039
|
-
/**
|
|
67040
|
-
* Engine tags on this memory; empty when it carries none
|
|
67041
|
-
*/
|
|
67042
66388
|
tags: string[]
|
|
67043
66389
|
/**
|
|
67044
66390
|
* Engine memory layer (l0_basic_info…l7_intention)
|
|
67045
66391
|
*/
|
|
67046
66392
|
layer: ("l6_schema" | "l7_intention" | "l4_identity" | "l0_basic_info" | "l2_fact" | "l3_summary" | "l5_knowledge" | "l1_raw")
|
|
67047
|
-
/**
|
|
67048
|
-
* Free-form metadata, verbatim as the writer passed brain_memory_add's `metadata`; keys are the caller's
|
|
67049
|
-
*/
|
|
67050
66393
|
custom: {
|
|
67051
66394
|
[k: string]: unknown
|
|
67052
66395
|
}
|
|
67053
|
-
/**
|
|
67054
|
-
* Engine lifecycle status of the row — 'active' for a memory in use; superseded rows are not listed
|
|
67055
|
-
*/
|
|
67056
66396
|
status: string
|
|
67057
|
-
/**
|
|
67058
|
-
* The memory text itself
|
|
67059
|
-
*/
|
|
67060
66397
|
content: string
|
|
67061
|
-
/**
|
|
67062
|
-
* Engine user namespace the memory was written under
|
|
67063
|
-
*/
|
|
67064
66398
|
user_id: string
|
|
67065
|
-
/**
|
|
67066
|
-
* Engine agent namespace the memory was written under — the shared pool for a 'shared' write, the caller's own for a private one
|
|
67067
|
-
*/
|
|
67068
66399
|
agent_id: string
|
|
67069
|
-
/**
|
|
67070
|
-
* When the remembered EVENT happened, epoch milliseconds; null when the writer stated no time
|
|
67071
|
-
*/
|
|
67072
66400
|
memory_at: (number | null)
|
|
67073
|
-
/**
|
|
67074
|
-
* Engine id of this memory; pass it to brain_memory_get, _update or _delete
|
|
67075
|
-
*/
|
|
67076
66401
|
memory_id: string
|
|
67077
|
-
/**
|
|
67078
|
-
* The engine's own inference about this memory, or null when it recorded none
|
|
67079
|
-
*/
|
|
67080
66402
|
speculate: (string | null)
|
|
67081
|
-
/**
|
|
67082
|
-
* Engine session the memory was written in; empty when the writer opened none
|
|
67083
|
-
*/
|
|
67084
66403
|
session_id: string
|
|
67085
|
-
/**
|
|
67086
|
-
* When this memory row was written, epoch milliseconds
|
|
67087
|
-
*/
|
|
67088
66404
|
gmt_created: number
|
|
67089
66405
|
/**
|
|
67090
66406
|
* Source authority (highest→lowest): policy > official > team > informal
|
|
67091
66407
|
*/
|
|
67092
66408
|
source_authority: ("policy" | "official" | "team" | "informal")
|
|
67093
|
-
/**
|
|
67094
|
-
* Id of the l1_raw memory this one was derived from; null when it was written directly
|
|
67095
|
-
*/
|
|
67096
66409
|
source_raw_memory_id: (string | null)
|
|
67097
66410
|
}[]
|
|
67098
66411
|
}
|
|
@@ -67113,17 +66426,8 @@ scope?: ("shared" | "private" | "both")
|
|
|
67113
66426
|
}
|
|
67114
66427
|
|
|
67115
66428
|
export interface BrainMemorySearchOutput {
|
|
67116
|
-
/**
|
|
67117
|
-
* Ordinary hits: the facts, summaries and raw notes that match the query
|
|
67118
|
-
*/
|
|
67119
66429
|
normal: BrainMemorySearchOutputItems[]
|
|
67120
|
-
/**
|
|
67121
|
-
* Hits describing WHO the subject is — stable identity and preference memories (l0/l4). Usually the ones worth carrying into a prompt.
|
|
67122
|
-
*/
|
|
67123
66430
|
profile: BrainMemorySearchOutputItems[]
|
|
67124
|
-
/**
|
|
67125
|
-
* Hits the engine offers unprompted — intentions and open threads (l7) it judged relevant to the query rather than matched to it
|
|
67126
|
-
*/
|
|
67127
66431
|
proactive: BrainMemorySearchOutputItems[]
|
|
67128
66432
|
}
|
|
67129
66433
|
export interface BrainMemorySearchOutputItems {
|
|
@@ -67131,53 +66435,23 @@ export interface BrainMemorySearchOutputItems {
|
|
|
67131
66435
|
* Consumer-facing label derived from the layer; 'unknown' for an unrecognised layer
|
|
67132
66436
|
*/
|
|
67133
66437
|
kind: ("schema" | "intention" | "identity" | "basic" | "fact" | "summary" | "knowledge" | "raw" | "unknown")
|
|
67134
|
-
/**
|
|
67135
|
-
* Engine tags on this memory; empty when it carries none
|
|
67136
|
-
*/
|
|
67137
66438
|
tags: string[]
|
|
67138
66439
|
/**
|
|
67139
66440
|
* Engine memory layer (l0_basic_info…l7_intention)
|
|
67140
66441
|
*/
|
|
67141
66442
|
layer: ("l6_schema" | "l7_intention" | "l4_identity" | "l0_basic_info" | "l2_fact" | "l3_summary" | "l5_knowledge" | "l1_raw")
|
|
67142
|
-
/**
|
|
67143
|
-
* 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.
|
|
67144
|
-
*/
|
|
67145
66443
|
score: number
|
|
67146
|
-
/**
|
|
67147
|
-
* The memory text itself
|
|
67148
|
-
*/
|
|
67149
66444
|
content: string
|
|
67150
|
-
/**
|
|
67151
|
-
* When the remembered EVENT happened, epoch milliseconds; null when the writer stated no time
|
|
67152
|
-
*/
|
|
67153
66445
|
memory_at: (number | null)
|
|
67154
|
-
/**
|
|
67155
|
-
* Engine id of this memory; pass it to brain_memory_get, _update or _delete
|
|
67156
|
-
*/
|
|
67157
66446
|
memory_id: string
|
|
67158
|
-
/**
|
|
67159
|
-
* The engine's own inference about this memory, or null when it recorded none
|
|
67160
|
-
*/
|
|
67161
66447
|
speculate: (string | null)
|
|
67162
|
-
/**
|
|
67163
|
-
* When this memory row was written, epoch milliseconds
|
|
67164
|
-
*/
|
|
67165
66448
|
gmt_created: number
|
|
67166
|
-
/**
|
|
67167
|
-
* Name of the l6_schema type this memory instantiates; absent on every other layer
|
|
67168
|
-
*/
|
|
67169
66449
|
schema_type?: string
|
|
67170
|
-
/**
|
|
67171
|
-
* Ids of the earlier memories this one grew out of, oldest first; absent when it has no history
|
|
67172
|
-
*/
|
|
67173
66450
|
evolution_chain?: string[]
|
|
67174
66451
|
/**
|
|
67175
66452
|
* Source authority (highest→lowest): policy > official > team > informal
|
|
67176
66453
|
*/
|
|
67177
66454
|
source_authority: ("policy" | "official" | "team" | "informal")
|
|
67178
|
-
/**
|
|
67179
|
-
* Id of the l1_raw memory this one was derived from; null when it was written directly
|
|
67180
|
-
*/
|
|
67181
66455
|
source_raw_memory_id: (string | null)
|
|
67182
66456
|
}
|
|
67183
66457
|
|
|
@@ -67189,52 +66463,19 @@ scope?: ("shared" | "private" | "both")
|
|
|
67189
66463
|
}
|
|
67190
66464
|
|
|
67191
66465
|
export interface BrainMemoryStatsOutput {
|
|
67192
|
-
/**
|
|
67193
|
-
* Size of the engine's memory graph
|
|
67194
|
-
*/
|
|
67195
66466
|
graph: {
|
|
67196
|
-
/**
|
|
67197
|
-
* Edges between those nodes
|
|
67198
|
-
*/
|
|
67199
66467
|
edgeCount: number
|
|
67200
|
-
/**
|
|
67201
|
-
* Nodes in the memory graph
|
|
67202
|
-
*/
|
|
67203
66468
|
nodeCount: number
|
|
67204
66469
|
}
|
|
67205
|
-
/**
|
|
67206
|
-
* Memory counts for the requested scope
|
|
67207
|
-
*/
|
|
67208
66470
|
memories: {
|
|
67209
|
-
/**
|
|
67210
|
-
* How many memories the scope holds in total
|
|
67211
|
-
*/
|
|
67212
66471
|
total: number
|
|
67213
|
-
/**
|
|
67214
|
-
* Counts for the three derived layers the engine reports; the other layers are not broken out
|
|
67215
|
-
*/
|
|
67216
66472
|
byLayer: {
|
|
67217
|
-
/**
|
|
67218
|
-
* Count of l2_fact memories — extracted facts
|
|
67219
|
-
*/
|
|
67220
66473
|
l2: number
|
|
67221
|
-
/**
|
|
67222
|
-
* Count of l3_summary memories — summaries over facts
|
|
67223
|
-
*/
|
|
67224
66474
|
l3: number
|
|
67225
|
-
/**
|
|
67226
|
-
* Count of l4_identity memories — who the subject is
|
|
67227
|
-
*/
|
|
67228
66475
|
l4: number
|
|
67229
66476
|
}
|
|
67230
66477
|
}
|
|
67231
|
-
/**
|
|
67232
|
-
* Size of the product knowledge graph
|
|
67233
|
-
*/
|
|
67234
66478
|
knowledge: {
|
|
67235
|
-
/**
|
|
67236
|
-
* Entities in the product knowledge graph (see brain_knowledge_search)
|
|
67237
|
-
*/
|
|
67238
66479
|
entityCount: number
|
|
67239
66480
|
}
|
|
67240
66481
|
}
|
|
@@ -67251,17 +66492,8 @@ memory_id: string
|
|
|
67251
66492
|
}
|
|
67252
66493
|
|
|
67253
66494
|
export interface BrainMemoryUpdateOutput {
|
|
67254
|
-
/**
|
|
67255
|
-
* Always true — the call fails outright rather than reporting a false here
|
|
67256
|
-
*/
|
|
67257
66495
|
success: true
|
|
67258
|
-
/**
|
|
67259
|
-
* Engine id of the memory that was replaced
|
|
67260
|
-
*/
|
|
67261
66496
|
memory_id: string
|
|
67262
|
-
/**
|
|
67263
|
-
* Engine request id for this call — quote it when reporting a problem
|
|
67264
|
-
*/
|
|
67265
66497
|
request_id: string
|
|
67266
66498
|
}
|
|
67267
66499
|
|
|
@@ -67316,9 +66548,6 @@ days?: number
|
|
|
67316
66548
|
}
|
|
67317
66549
|
|
|
67318
66550
|
export interface BrainUsageReportOutput {
|
|
67319
|
-
/**
|
|
67320
|
-
* A standing warning, in words, that product.rows and platform.meters have different subjects and need not match
|
|
67321
|
-
*/
|
|
67322
66551
|
note: string
|
|
67323
66552
|
/**
|
|
67324
66553
|
* Brain's own ledger, for THIS product only
|
|
@@ -67336,9 +66565,6 @@ days: number
|
|
|
67336
66565
|
* Inclusive UTC start of the window, YYYY-MM-DD
|
|
67337
66566
|
*/
|
|
67338
66567
|
from: string
|
|
67339
|
-
/**
|
|
67340
|
-
* One row per UTC day and meter dimension — the grain to join against a billing export
|
|
67341
|
-
*/
|
|
67342
66568
|
rows: {
|
|
67343
66569
|
/**
|
|
67344
66570
|
* 'sync' | 'batch'; '' when the push carried none
|
|
@@ -67377,72 +66603,27 @@ delivery_failed: number
|
|
|
67377
66603
|
* The rows rolled up per meter across the whole window
|
|
67378
66604
|
*/
|
|
67379
66605
|
totals: {
|
|
67380
|
-
/**
|
|
67381
|
-
* Manifest meter slug, e.g. llm-tokens
|
|
67382
|
-
*/
|
|
67383
66606
|
meter: string
|
|
67384
|
-
/**
|
|
67385
|
-
* How many metered calls landed in the window
|
|
67386
|
-
*/
|
|
67387
66607
|
events: number
|
|
67388
|
-
/**
|
|
67389
|
-
* Tokens metered for this meter across the whole window
|
|
67390
|
-
*/
|
|
67391
66608
|
tokens: number
|
|
67392
|
-
/**
|
|
67393
|
-
* Of those calls, how many billing did not accept — a non-zero here means our ledger and the invoice will differ
|
|
67394
|
-
*/
|
|
67395
66609
|
delivery_failed: number
|
|
67396
66610
|
}[]
|
|
67397
|
-
/**
|
|
67398
|
-
* The product this ledger belongs to — the one the call was made for
|
|
67399
|
-
*/
|
|
67400
66611
|
product_id: string
|
|
67401
66612
|
}
|
|
67402
66613
|
/**
|
|
67403
66614
|
* The platform billing aggregate for the whole ORG; null if it could not be read
|
|
67404
66615
|
*/
|
|
67405
66616
|
platform: ({
|
|
67406
|
-
/**
|
|
67407
|
-
* The billing plan in force for that organisation
|
|
67408
|
-
*/
|
|
67409
66617
|
plan: string
|
|
67410
|
-
/**
|
|
67411
|
-
* Always 'org' — a reminder that these numbers are the whole organisation's, not this product's
|
|
67412
|
-
*/
|
|
67413
66618
|
scope: "org"
|
|
67414
|
-
/**
|
|
67415
|
-
* Per-meter allowance and month-to-date usage as billing reports it
|
|
67416
|
-
*/
|
|
67417
66619
|
meters: {
|
|
67418
|
-
/**
|
|
67419
|
-
* What the numbers below are counted in, e.g. tokens
|
|
67420
|
-
*/
|
|
67421
66620
|
unit?: string
|
|
67422
|
-
/**
|
|
67423
|
-
* How much of it has been used MONTH TO DATE, for the whole org — not for the window asked for here
|
|
67424
|
-
*/
|
|
67425
66621
|
used?: number
|
|
67426
|
-
/**
|
|
67427
|
-
* The plan's allowance for this meter; null or absent when there is no cap
|
|
67428
|
-
*/
|
|
67429
66622
|
limit?: (number | null)
|
|
67430
|
-
/**
|
|
67431
|
-
* Allowance left; null or absent when the meter is uncapped
|
|
67432
|
-
*/
|
|
67433
66623
|
remaining?: (number | null)
|
|
67434
|
-
/**
|
|
67435
|
-
* True when this meter has no cap at all
|
|
67436
|
-
*/
|
|
67437
66624
|
unlimited?: boolean
|
|
67438
|
-
/**
|
|
67439
|
-
* Platform meter slug, e.g. llm-tokens
|
|
67440
|
-
*/
|
|
67441
66625
|
meter_slug: string
|
|
67442
66626
|
}[]
|
|
67443
|
-
/**
|
|
67444
|
-
* The organisation the billing aggregate was read for
|
|
67445
|
-
*/
|
|
67446
66627
|
org_id: string
|
|
67447
66628
|
} | null)
|
|
67448
66629
|
/**
|
|
@@ -88590,378 +87771,6 @@ export interface OrganizationYoutubeInstallOutput {
|
|
|
88590
87771
|
url: string
|
|
88591
87772
|
}
|
|
88592
87773
|
|
|
88593
|
-
export interface PlaygroundAnalyticsOverviewInput {
|
|
88594
|
-
/**
|
|
88595
|
-
* Max records per entity in recent[]; omit for the endpoint default
|
|
88596
|
-
*/
|
|
88597
|
-
limit?: number
|
|
88598
|
-
}
|
|
88599
|
-
|
|
88600
|
-
export interface PlaygroundAnalyticsOverviewOutput {
|
|
88601
|
-
ok: boolean
|
|
88602
|
-
minted: boolean
|
|
88603
|
-
overview?: unknown
|
|
88604
|
-
http_status: number
|
|
88605
|
-
}
|
|
88606
|
-
|
|
88607
|
-
export interface PlaygroundBillingEntitlementsInput {
|
|
88608
|
-
|
|
88609
|
-
}
|
|
88610
|
-
|
|
88611
|
-
export interface PlaygroundBillingEntitlementsOutput {
|
|
88612
|
-
ok: boolean
|
|
88613
|
-
minted: boolean
|
|
88614
|
-
http_status: number
|
|
88615
|
-
entitlements?: unknown
|
|
88616
|
-
}
|
|
88617
|
-
|
|
88618
|
-
export interface PlaygroundBillingRecordUsageInput {
|
|
88619
|
-
/**
|
|
88620
|
-
* Quantity of events to record against playground-events (SUM); defaults to 1
|
|
88621
|
-
*/
|
|
88622
|
-
value?: number
|
|
88623
|
-
}
|
|
88624
|
-
|
|
88625
|
-
export interface PlaygroundBillingRecordUsageOutput {
|
|
88626
|
-
minted: boolean
|
|
88627
|
-
accepted: (number | null)
|
|
88628
|
-
recorded: boolean
|
|
88629
|
-
duplicates: (number | null)
|
|
88630
|
-
http_status: number
|
|
88631
|
-
}
|
|
88632
|
-
|
|
88633
|
-
export interface PlaygroundClickupCreateTaskInput {
|
|
88634
|
-
/**
|
|
88635
|
-
* Task title; defaults to a fixture label
|
|
88636
|
-
*/
|
|
88637
|
-
name?: string
|
|
88638
|
-
/**
|
|
88639
|
-
* ClickUp list id; falls back to CLICKUP_TEST_LIST_ID
|
|
88640
|
-
*/
|
|
88641
|
-
listId?: string
|
|
88642
|
-
}
|
|
88643
|
-
|
|
88644
|
-
export interface PlaygroundClickupCreateTaskOutput {
|
|
88645
|
-
minted: boolean
|
|
88646
|
-
task_id: (string | null)
|
|
88647
|
-
list_status: number
|
|
88648
|
-
vend_status: number
|
|
88649
|
-
clickup_status: number
|
|
88650
|
-
installation_count: number
|
|
88651
|
-
}
|
|
88652
|
-
|
|
88653
|
-
export interface PlaygroundClickupGetLastWebhookInput {
|
|
88654
|
-
|
|
88655
|
-
}
|
|
88656
|
-
|
|
88657
|
-
export type PlaygroundClickupGetLastWebhookOutput = ({
|
|
88658
|
-
payload: string
|
|
88659
|
-
event_id: string
|
|
88660
|
-
provider: string
|
|
88661
|
-
verified: boolean
|
|
88662
|
-
product_id: string
|
|
88663
|
-
occurred_at: string
|
|
88664
|
-
connector_id: string
|
|
88665
|
-
clickup_event: (string | null)
|
|
88666
|
-
receipt_count: number
|
|
88667
|
-
} | {
|
|
88668
|
-
found: false
|
|
88669
|
-
})
|
|
88670
|
-
|
|
88671
|
-
export interface PlaygroundClickupGetOverviewInput {
|
|
88672
|
-
|
|
88673
|
-
}
|
|
88674
|
-
|
|
88675
|
-
export interface PlaygroundClickupGetOverviewOutput {
|
|
88676
|
-
team: ({
|
|
88677
|
-
teamId: string
|
|
88678
|
-
teamName: string
|
|
88679
|
-
} | null)
|
|
88680
|
-
lists: PlaygroundClickupGetOverviewOutputItems[]
|
|
88681
|
-
tasks: {
|
|
88682
|
-
id: string
|
|
88683
|
-
name: string
|
|
88684
|
-
status: (string | null)
|
|
88685
|
-
}[]
|
|
88686
|
-
minted: boolean
|
|
88687
|
-
spaces: PlaygroundClickupGetOverviewOutputItems[]
|
|
88688
|
-
list_status: number
|
|
88689
|
-
vend_status: number
|
|
88690
|
-
lists_status: number
|
|
88691
|
-
tasks_status: number
|
|
88692
|
-
spaces_status: number
|
|
88693
|
-
folders_status: number
|
|
88694
|
-
installation_count: number
|
|
88695
|
-
}
|
|
88696
|
-
export interface PlaygroundClickupGetOverviewOutputItems {
|
|
88697
|
-
id: string
|
|
88698
|
-
name: string
|
|
88699
|
-
}
|
|
88700
|
-
|
|
88701
|
-
export interface PlaygroundEchoPingInput {
|
|
88702
|
-
/**
|
|
88703
|
-
* The text to echo back, 1–1024 characters
|
|
88704
|
-
*/
|
|
88705
|
-
message: string
|
|
88706
|
-
}
|
|
88707
|
-
|
|
88708
|
-
export interface PlaygroundEchoPingOutput {
|
|
88709
|
-
/**
|
|
88710
|
-
* The message exactly as it was received
|
|
88711
|
-
*/
|
|
88712
|
-
message: string
|
|
88713
|
-
/**
|
|
88714
|
-
* The product the call was resolved to
|
|
88715
|
-
*/
|
|
88716
|
-
productId: string
|
|
88717
|
-
/**
|
|
88718
|
-
* ISO-8601 instant (UTC) at which the call reached the service
|
|
88719
|
-
*/
|
|
88720
|
-
receivedAt: string
|
|
88721
|
-
}
|
|
88722
|
-
|
|
88723
|
-
export interface PlaygroundGdriveGetLastChangeInput {
|
|
88724
|
-
|
|
88725
|
-
}
|
|
88726
|
-
|
|
88727
|
-
export type PlaygroundGdriveGetLastChangeOutput = ({
|
|
88728
|
-
file_id: string
|
|
88729
|
-
removed: boolean
|
|
88730
|
-
file_name: (string | null)
|
|
88731
|
-
mime_type: (string | null)
|
|
88732
|
-
product_id: string
|
|
88733
|
-
occurred_at: string
|
|
88734
|
-
connector_id: string
|
|
88735
|
-
resource_state: string
|
|
88736
|
-
} | {
|
|
88737
|
-
found: false
|
|
88738
|
-
})
|
|
88739
|
-
|
|
88740
|
-
export interface PlaygroundGdriveReadFileInput {
|
|
88741
|
-
/**
|
|
88742
|
-
* Drive file id; falls back to GDRIVE_TEST_FILE_ID, then the first picked file
|
|
88743
|
-
*/
|
|
88744
|
-
fileId?: string
|
|
88745
|
-
}
|
|
88746
|
-
|
|
88747
|
-
export interface PlaygroundGdriveReadFileOutput {
|
|
88748
|
-
minted: boolean
|
|
88749
|
-
file_id: (string | null)
|
|
88750
|
-
file_name: (string | null)
|
|
88751
|
-
mime_type: (string | null)
|
|
88752
|
-
file_count: number
|
|
88753
|
-
get_status: number
|
|
88754
|
-
list_status: number
|
|
88755
|
-
vend_status: number
|
|
88756
|
-
content_bytes: (number | null)
|
|
88757
|
-
}
|
|
88758
|
-
|
|
88759
|
-
export interface PlaygroundGoogleadsReadCustomerInput {
|
|
88760
|
-
|
|
88761
|
-
}
|
|
88762
|
-
|
|
88763
|
-
export interface PlaygroundGoogleadsReadCustomerOutput {
|
|
88764
|
-
minted: boolean
|
|
88765
|
-
vended: boolean
|
|
88766
|
-
customer_id: (string | null)
|
|
88767
|
-
vend_status: number
|
|
88768
|
-
result_count: number
|
|
88769
|
-
search_status: number
|
|
88770
|
-
login_customer_id: (string | null)
|
|
88771
|
-
}
|
|
88772
|
-
|
|
88773
|
-
export interface PlaygroundLifecycleGetStateInput {
|
|
88774
|
-
|
|
88775
|
-
}
|
|
88776
|
-
|
|
88777
|
-
export interface PlaygroundLifecycleGetStateOutput {
|
|
88778
|
-
blocked: boolean
|
|
88779
|
-
archived: boolean
|
|
88780
|
-
productId: string
|
|
88781
|
-
lastBlockTransition: ({
|
|
88782
|
-
eventId: string
|
|
88783
|
-
eventName: string
|
|
88784
|
-
productId: string
|
|
88785
|
-
occurredAt: string
|
|
88786
|
-
recordedAt: string
|
|
88787
|
-
receiptCount: number
|
|
88788
|
-
organizationId: string
|
|
88789
|
-
cascadedFromOrg: boolean
|
|
88790
|
-
} | null)
|
|
88791
|
-
lastArchiveTransition: ({
|
|
88792
|
-
eventId: string
|
|
88793
|
-
eventName: string
|
|
88794
|
-
productId: string
|
|
88795
|
-
occurredAt: string
|
|
88796
|
-
recordedAt: string
|
|
88797
|
-
receiptCount: number
|
|
88798
|
-
organizationId: string
|
|
88799
|
-
cascadedFromOrg: boolean
|
|
88800
|
-
} | null)
|
|
88801
|
-
}
|
|
88802
|
-
|
|
88803
|
-
export interface PlaygroundLifecycleListEventsInput {
|
|
88804
|
-
|
|
88805
|
-
}
|
|
88806
|
-
|
|
88807
|
-
export type PlaygroundLifecycleListEventsOutput = {
|
|
88808
|
-
eventId: string
|
|
88809
|
-
eventName: string
|
|
88810
|
-
productId: string
|
|
88811
|
-
occurredAt: string
|
|
88812
|
-
recordedAt: string
|
|
88813
|
-
receiptCount: number
|
|
88814
|
-
organizationId: string
|
|
88815
|
-
cascadedFromOrg: boolean
|
|
88816
|
-
}[]
|
|
88817
|
-
|
|
88818
|
-
export interface PlaygroundWebhookGetLastInput {
|
|
88819
|
-
|
|
88820
|
-
}
|
|
88821
|
-
|
|
88822
|
-
export type PlaygroundWebhookGetLastOutput = ({
|
|
88823
|
-
payload?: unknown
|
|
88824
|
-
event_id: string
|
|
88825
|
-
provider: string
|
|
88826
|
-
verified: boolean
|
|
88827
|
-
product_id: string
|
|
88828
|
-
occurred_at: string
|
|
88829
|
-
connector_id: string
|
|
88830
|
-
delivery_count: number
|
|
88831
|
-
} | {
|
|
88832
|
-
found: false
|
|
88833
|
-
})
|
|
88834
|
-
|
|
88835
|
-
export interface PlaygroundWorkflowEchoInput {
|
|
88836
|
-
/**
|
|
88837
|
-
* The text to store, 1–1024 characters
|
|
88838
|
-
*/
|
|
88839
|
-
note: string
|
|
88840
|
-
/**
|
|
88841
|
-
* Optional labels stored alongside the note, at most 20
|
|
88842
|
-
*
|
|
88843
|
-
* @maxItems 20
|
|
88844
|
-
*/
|
|
88845
|
-
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]
|
|
88846
|
-
}
|
|
88847
|
-
|
|
88848
|
-
export interface PlaygroundWorkflowEchoOutput {
|
|
88849
|
-
/**
|
|
88850
|
-
* Identifier of the stored echo
|
|
88851
|
-
*/
|
|
88852
|
-
id: string
|
|
88853
|
-
/**
|
|
88854
|
-
* The note exactly as it was received
|
|
88855
|
-
*/
|
|
88856
|
-
note: string
|
|
88857
|
-
/**
|
|
88858
|
-
* The tags exactly as they were received
|
|
88859
|
-
*/
|
|
88860
|
-
tags: string[]
|
|
88861
|
-
/**
|
|
88862
|
-
* 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.
|
|
88863
|
-
*/
|
|
88864
|
-
echo_id: string
|
|
88865
|
-
/**
|
|
88866
|
-
* ISO-8601 instant (UTC) at which the echo was stored
|
|
88867
|
-
*/
|
|
88868
|
-
received_at: string
|
|
88869
|
-
}
|
|
88870
|
-
|
|
88871
|
-
export interface PlaygroundWorkflowEchoListInput {
|
|
88872
|
-
|
|
88873
|
-
}
|
|
88874
|
-
|
|
88875
|
-
export type PlaygroundWorkflowEchoListOutput = {
|
|
88876
|
-
/**
|
|
88877
|
-
* Identifier of the stored echo
|
|
88878
|
-
*/
|
|
88879
|
-
id: string
|
|
88880
|
-
/**
|
|
88881
|
-
* The note exactly as it was received
|
|
88882
|
-
*/
|
|
88883
|
-
note: string
|
|
88884
|
-
/**
|
|
88885
|
-
* The tags exactly as they were received
|
|
88886
|
-
*/
|
|
88887
|
-
tags: string[]
|
|
88888
|
-
/**
|
|
88889
|
-
* ISO-8601 instant (UTC) at which the echo was stored
|
|
88890
|
-
*/
|
|
88891
|
-
received_at: string
|
|
88892
|
-
}[]
|
|
88893
|
-
|
|
88894
|
-
export interface PlaygroundWorkflowPingInput {
|
|
88895
|
-
/**
|
|
88896
|
-
* Class of ping, echoed on the emitted event and filterable on the trigger. Defaults to 'manual'.
|
|
88897
|
-
*/
|
|
88898
|
-
kind?: string
|
|
88899
|
-
}
|
|
88900
|
-
|
|
88901
|
-
export interface PlaygroundWorkflowPingOutput {
|
|
88902
|
-
/**
|
|
88903
|
-
* 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.
|
|
88904
|
-
*/
|
|
88905
|
-
id: string
|
|
88906
|
-
/**
|
|
88907
|
-
* The name of the event that was published
|
|
88908
|
-
*/
|
|
88909
|
-
event: string
|
|
88910
|
-
}
|
|
88911
|
-
|
|
88912
|
-
export interface PlaygroundWorkflowSubjectsListInput {
|
|
88913
|
-
/**
|
|
88914
|
-
* How many subjects to return, 1–100. Defaults to 25.
|
|
88915
|
-
*/
|
|
88916
|
-
limit?: number
|
|
88917
|
-
/**
|
|
88918
|
-
* The next_cursor of the previous page. Opaque — pass it back unchanged. Omit for the first page.
|
|
88919
|
-
*/
|
|
88920
|
-
cursor?: string
|
|
88921
|
-
/**
|
|
88922
|
-
* 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.
|
|
88923
|
-
*/
|
|
88924
|
-
last_activity_after?: string
|
|
88925
|
-
/**
|
|
88926
|
-
* 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.
|
|
88927
|
-
*/
|
|
88928
|
-
last_activity_before?: string
|
|
88929
|
-
}
|
|
88930
|
-
|
|
88931
|
-
export interface PlaygroundWorkflowSubjectsListOutput {
|
|
88932
|
-
/**
|
|
88933
|
-
* This page of subjects, most recently active first
|
|
88934
|
-
*/
|
|
88935
|
-
items: {
|
|
88936
|
-
/**
|
|
88937
|
-
* 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.
|
|
88938
|
-
*/
|
|
88939
|
-
subject_key: string
|
|
88940
|
-
/**
|
|
88941
|
-
* Human-readable name of the subject
|
|
88942
|
-
*/
|
|
88943
|
-
display_name: string
|
|
88944
|
-
/**
|
|
88945
|
-
* ISO-8601 instant (UTC) of the subject last activity
|
|
88946
|
-
*/
|
|
88947
|
-
last_activity_at: string
|
|
88948
|
-
}[]
|
|
88949
|
-
/**
|
|
88950
|
-
* Whether another page follows. False and a null next_cursor both mark the last page, so a consumer that loops on either terminates.
|
|
88951
|
-
*/
|
|
88952
|
-
has_more: boolean
|
|
88953
|
-
/**
|
|
88954
|
-
* Pass back as `cursor` to fetch the next page; null on the last page. Always null when has_more is false.
|
|
88955
|
-
*/
|
|
88956
|
-
next_cursor: (string | null)
|
|
88957
|
-
}
|
|
88958
|
-
|
|
88959
|
-
export interface PlaygroundWsEchoInput {
|
|
88960
|
-
|
|
88961
|
-
}
|
|
88962
|
-
|
|
88963
|
-
export type PlaygroundWsEchoOutput = unknown;
|
|
88964
|
-
|
|
88965
87774
|
export interface RealtimeArchiveExportInput {
|
|
88966
87775
|
/**
|
|
88967
87776
|
* Only entries with ts <= to_ts (epoch ms)
|
|
@@ -111017,37 +109826,13 @@ type: ("server" | "publishable")
|
|
|
111017
109826
|
}
|
|
111018
109827
|
|
|
111019
109828
|
export interface UsersApikeysCreateOutput {
|
|
111020
|
-
/**
|
|
111021
|
-
* Id of the key. Pass it to users_apikeys_revoke.
|
|
111022
|
-
*/
|
|
111023
109829
|
id: string
|
|
111024
|
-
/**
|
|
111025
|
-
* 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.
|
|
111026
|
-
*/
|
|
111027
109830
|
key: string
|
|
111028
|
-
/**
|
|
111029
|
-
* The label a human gave this key — which backend or environment holds it.
|
|
111030
|
-
*/
|
|
111031
109831
|
name: string
|
|
111032
|
-
/**
|
|
111033
|
-
* `server` for a secret backend key (usk_…), `publishable` for a browser-safe one (upk_…).
|
|
111034
|
-
*/
|
|
111035
109832
|
type: ("server" | "publishable")
|
|
111036
|
-
/**
|
|
111037
|
-
* 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.
|
|
111038
|
-
*/
|
|
111039
109833
|
value: (string | null)
|
|
111040
|
-
/**
|
|
111041
|
-
* `usk_`/`upk_` plus six characters — enough to recognise a key, never to use one.
|
|
111042
|
-
*/
|
|
111043
109834
|
prefix: string
|
|
111044
|
-
/**
|
|
111045
|
-
* When the key was issued (ISO 8601).
|
|
111046
|
-
*/
|
|
111047
109835
|
createdAt: string
|
|
111048
|
-
/**
|
|
111049
|
-
* When the key was revoked (ISO 8601). Null while it still works.
|
|
111050
|
-
*/
|
|
111051
109836
|
revokedAt: (string | null)
|
|
111052
109837
|
}
|
|
111053
109838
|
|
|
@@ -111057,33 +109842,12 @@ export interface UsersApikeysListInput {
|
|
|
111057
109842
|
|
|
111058
109843
|
export interface UsersApikeysListOutput {
|
|
111059
109844
|
keys: {
|
|
111060
|
-
/**
|
|
111061
|
-
* Id of the key. Pass it to users_apikeys_revoke.
|
|
111062
|
-
*/
|
|
111063
109845
|
id: string
|
|
111064
|
-
/**
|
|
111065
|
-
* The label a human gave this key — which backend or environment holds it.
|
|
111066
|
-
*/
|
|
111067
109846
|
name: string
|
|
111068
|
-
/**
|
|
111069
|
-
* `server` for a secret backend key (usk_…), `publishable` for a browser-safe one (upk_…).
|
|
111070
|
-
*/
|
|
111071
109847
|
type: ("server" | "publishable")
|
|
111072
|
-
/**
|
|
111073
|
-
* 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.
|
|
111074
|
-
*/
|
|
111075
109848
|
value: (string | null)
|
|
111076
|
-
/**
|
|
111077
|
-
* `usk_`/`upk_` plus six characters — enough to recognise a key, never to use one.
|
|
111078
|
-
*/
|
|
111079
109849
|
prefix: string
|
|
111080
|
-
/**
|
|
111081
|
-
* When the key was issued (ISO 8601).
|
|
111082
|
-
*/
|
|
111083
109850
|
createdAt: string
|
|
111084
|
-
/**
|
|
111085
|
-
* When the key was revoked (ISO 8601). Null while it still works.
|
|
111086
|
-
*/
|
|
111087
109851
|
revokedAt: (string | null)
|
|
111088
109852
|
}[]
|
|
111089
109853
|
}
|
|
@@ -111096,13 +109860,7 @@ id: string
|
|
|
111096
109860
|
}
|
|
111097
109861
|
|
|
111098
109862
|
export interface UsersApikeysRevokeOutput {
|
|
111099
|
-
/**
|
|
111100
|
-
* Id of the key that was revoked.
|
|
111101
|
-
*/
|
|
111102
109863
|
id: string
|
|
111103
|
-
/**
|
|
111104
|
-
* Always true — revocation is immediate and final.
|
|
111105
|
-
*/
|
|
111106
109864
|
revoked: true
|
|
111107
109865
|
}
|
|
111108
109866
|
|
|
@@ -111138,60 +109896,21 @@ targetType?: string
|
|
|
111138
109896
|
}
|
|
111139
109897
|
|
|
111140
109898
|
export interface UsersAuditListOutput {
|
|
111141
|
-
/**
|
|
111142
|
-
* The page of audit events, newest first.
|
|
111143
|
-
*/
|
|
111144
109899
|
events: {
|
|
111145
|
-
/**
|
|
111146
|
-
* Id of this audit row.
|
|
111147
|
-
*/
|
|
111148
109900
|
id: string
|
|
111149
|
-
/**
|
|
111150
|
-
* IP the action came from. Null when it was not an HTTP action.
|
|
111151
|
-
*/
|
|
111152
109901
|
ip: (string | null)
|
|
111153
|
-
/**
|
|
111154
|
-
* What happened, as a dotted name — `user.created`, `passkey.deleted`, `email_change.override_applied`.
|
|
111155
|
-
*/
|
|
111156
109902
|
action: string
|
|
111157
|
-
/**
|
|
111158
|
-
* Id of the actor. Null for a system action.
|
|
111159
|
-
*/
|
|
111160
109903
|
actorId: (string | null)
|
|
111161
|
-
/**
|
|
111162
|
-
* Action-specific detail — the reason text, counts, whatever the action recorded.
|
|
111163
|
-
*/
|
|
111164
109904
|
metadata: {
|
|
111165
109905
|
[k: string]: unknown
|
|
111166
109906
|
}
|
|
111167
|
-
/**
|
|
111168
|
-
* Id of the row the action was about. Null when there was none.
|
|
111169
|
-
*/
|
|
111170
109907
|
targetId: (string | null)
|
|
111171
|
-
/**
|
|
111172
|
-
* Who acted: `operator` (a human or agent on the management plane), `end_user`, or `system`.
|
|
111173
|
-
*/
|
|
111174
109908
|
actorType: ("operator" | "system" | "end_user")
|
|
111175
|
-
/**
|
|
111176
|
-
* When the action happened (ISO 8601).
|
|
111177
|
-
*/
|
|
111178
109909
|
createdAt: string
|
|
111179
|
-
/**
|
|
111180
|
-
* Product the audited action happened in.
|
|
111181
|
-
*/
|
|
111182
109910
|
productId: string
|
|
111183
|
-
/**
|
|
111184
|
-
* User agent the action came from. Null when none was sent.
|
|
111185
|
-
*/
|
|
111186
109911
|
userAgent: (string | null)
|
|
111187
|
-
/**
|
|
111188
|
-
* What kind of row the action was about — `user` or `product`. Null when it was about nothing in particular.
|
|
111189
|
-
*/
|
|
111190
109912
|
targetType: (string | null)
|
|
111191
109913
|
}[]
|
|
111192
|
-
/**
|
|
111193
|
-
* Pass back as `cursor` to fetch the next page. Null when this page is the last.
|
|
111194
|
-
*/
|
|
111195
109914
|
nextCursor: (string | null)
|
|
111196
109915
|
}
|
|
111197
109916
|
|
|
@@ -112174,33 +110893,12 @@ userId: string
|
|
|
112174
110893
|
}
|
|
112175
110894
|
|
|
112176
110895
|
export interface UsersFactorsListOutput {
|
|
112177
|
-
/**
|
|
112178
|
-
* Every second factor this user has — types and status only, never material.
|
|
112179
|
-
*/
|
|
112180
110896
|
factors: {
|
|
112181
|
-
/**
|
|
112182
|
-
* Kind of second factor: `totp` or `backup_codes`. No key material is ever returned.
|
|
112183
|
-
*/
|
|
112184
110897
|
type: ("totp" | "backup_codes" | "webauthn")
|
|
112185
|
-
/**
|
|
112186
|
-
* Whether this factor is enrolled and usable, or still pending verification.
|
|
112187
|
-
*/
|
|
112188
110898
|
status: ("unverified" | "verified")
|
|
112189
|
-
/**
|
|
112190
|
-
* When the factor was enrolled (ISO 8601).
|
|
112191
|
-
*/
|
|
112192
110899
|
createdAt: string
|
|
112193
|
-
/**
|
|
112194
|
-
* `backup_codes` only: how many of the batch are still unspent. Null for any other factor type.
|
|
112195
|
-
*/
|
|
112196
110900
|
remaining: (number | null)
|
|
112197
|
-
/**
|
|
112198
|
-
* When the factor was last used to sign in (ISO 8601). Null if it never was.
|
|
112199
|
-
*/
|
|
112200
110901
|
lastUsedAt: (string | null)
|
|
112201
|
-
/**
|
|
112202
|
-
* When the user first proved the factor works (ISO 8601). Null while it is unverified.
|
|
112203
|
-
*/
|
|
112204
110902
|
verifiedAt: (string | null)
|
|
112205
110903
|
}[]
|
|
112206
110904
|
}
|
|
@@ -112217,13 +110915,7 @@ userId: string
|
|
|
112217
110915
|
}
|
|
112218
110916
|
|
|
112219
110917
|
export interface UsersFactorsResetOutput {
|
|
112220
|
-
/**
|
|
112221
|
-
* Id of the scheduled reset. The same value arrives on `users/mfa.reset-settled`, which is what finishes this step.
|
|
112222
|
-
*/
|
|
112223
110918
|
requestId: string
|
|
112224
|
-
/**
|
|
112225
|
-
* When the removal happens, if nobody aborts it first (ISO 8601). The delay is this product's, not a fixed one.
|
|
112226
|
-
*/
|
|
112227
110919
|
scheduledFor: string
|
|
112228
110920
|
}
|
|
112229
110921
|
|
|
@@ -112559,18 +111251,9 @@ export interface UsersPasskeysRevokeOutput {
|
|
|
112559
111251
|
* Present when the revoke was refused — today, only because it was the last way in.
|
|
112560
111252
|
*/
|
|
112561
111253
|
error: ({
|
|
112562
|
-
/**
|
|
112563
|
-
* Why it was refused. Today only `passkey_last_way_in`.
|
|
112564
|
-
*/
|
|
112565
111254
|
code: string
|
|
112566
|
-
/**
|
|
112567
|
-
* The refusal in a sentence, safe to show a human.
|
|
112568
|
-
*/
|
|
112569
111255
|
message: string
|
|
112570
111256
|
} | null)
|
|
112571
|
-
/**
|
|
112572
|
-
* `deleted` when the credential is gone, `failed` when the revoke was refused.
|
|
112573
|
-
*/
|
|
112574
111257
|
status: ("deleted" | "failed")
|
|
112575
111258
|
}
|
|
112576
111259
|
|
|
@@ -112582,13 +111265,7 @@ sessionId: string
|
|
|
112582
111265
|
}
|
|
112583
111266
|
|
|
112584
111267
|
export interface UsersSessionsGetOutput {
|
|
112585
|
-
/**
|
|
112586
|
-
* Id of this session. Pass it to users_sessions_revoke.
|
|
112587
|
-
*/
|
|
112588
111268
|
id: string
|
|
112589
|
-
/**
|
|
112590
|
-
* IP the session was opened from. Null when it was not recorded.
|
|
112591
|
-
*/
|
|
112592
111269
|
ip: (string | null)
|
|
112593
111270
|
/**
|
|
112594
111271
|
* `aal2` only if a verified second factor completed.
|
|
@@ -112598,42 +111275,18 @@ aal: ("aal1" | "aal2")
|
|
|
112598
111275
|
* The factors this session was established with.
|
|
112599
111276
|
*/
|
|
112600
111277
|
amr: string[]
|
|
112601
|
-
/**
|
|
112602
|
-
* Whether the session is still usable, expired, or revoked.
|
|
112603
|
-
*/
|
|
112604
111278
|
status: ("active" | "revoked")
|
|
112605
|
-
/**
|
|
112606
|
-
* The end user this session belongs to.
|
|
112607
|
-
*/
|
|
112608
111279
|
userId: string
|
|
112609
|
-
/**
|
|
112610
|
-
* When the session was opened (ISO 8601).
|
|
112611
|
-
*/
|
|
112612
111280
|
createdAt: string
|
|
112613
|
-
/**
|
|
112614
|
-
* When the current token stops working unless refreshed (ISO 8601).
|
|
112615
|
-
*/
|
|
112616
111281
|
expiresAt: string
|
|
112617
|
-
/**
|
|
112618
|
-
* When the session was revoked (ISO 8601). Null while it is live.
|
|
112619
|
-
*/
|
|
112620
111282
|
revokedAt: (string | null)
|
|
112621
|
-
/**
|
|
112622
|
-
* User agent the session was opened from. Null when none was sent.
|
|
112623
|
-
*/
|
|
112624
111283
|
userAgent: (string | null)
|
|
112625
111284
|
revokedReason: (string | null)
|
|
112626
111285
|
/**
|
|
112627
111286
|
* The operator behind an impersonated session, or null for an ordinary one.
|
|
112628
111287
|
*/
|
|
112629
111288
|
impersonatedBy: (string | null)
|
|
112630
|
-
/**
|
|
112631
|
-
* When the session last refreshed its tokens (ISO 8601). Null if it never has.
|
|
112632
|
-
*/
|
|
112633
111289
|
lastRefreshedAt: (string | null)
|
|
112634
|
-
/**
|
|
112635
|
-
* When the session ends no matter how often it refreshes (ISO 8601).
|
|
112636
|
-
*/
|
|
112637
111290
|
absoluteExpiresAt: string
|
|
112638
111291
|
}
|
|
112639
111292
|
|
|
@@ -112673,49 +111326,16 @@ userId: string
|
|
|
112673
111326
|
}
|
|
112674
111327
|
|
|
112675
111328
|
export interface UsersSessionsListOutput {
|
|
112676
|
-
/**
|
|
112677
|
-
* The sessions matching the filter, newest first.
|
|
112678
|
-
*/
|
|
112679
111329
|
sessions: {
|
|
112680
|
-
/**
|
|
112681
|
-
* Id of this session. Pass it to users_sessions_revoke.
|
|
112682
|
-
*/
|
|
112683
111330
|
id: string
|
|
112684
|
-
/**
|
|
112685
|
-
* IP the session was opened from. Null when it was not recorded.
|
|
112686
|
-
*/
|
|
112687
111331
|
ip: (string | null)
|
|
112688
|
-
/**
|
|
112689
|
-
* Whether the session is still usable, expired, or revoked.
|
|
112690
|
-
*/
|
|
112691
111332
|
status: ("active" | "revoked")
|
|
112692
|
-
/**
|
|
112693
|
-
* The end user this session belongs to.
|
|
112694
|
-
*/
|
|
112695
111333
|
userId: string
|
|
112696
|
-
/**
|
|
112697
|
-
* When the session was opened (ISO 8601).
|
|
112698
|
-
*/
|
|
112699
111334
|
createdAt: string
|
|
112700
|
-
/**
|
|
112701
|
-
* When the current token stops working unless refreshed (ISO 8601).
|
|
112702
|
-
*/
|
|
112703
111335
|
expiresAt: string
|
|
112704
|
-
/**
|
|
112705
|
-
* When the session was revoked (ISO 8601). Null while it is live.
|
|
112706
|
-
*/
|
|
112707
111336
|
revokedAt: (string | null)
|
|
112708
|
-
/**
|
|
112709
|
-
* User agent the session was opened from. Null when none was sent.
|
|
112710
|
-
*/
|
|
112711
111337
|
userAgent: (string | null)
|
|
112712
|
-
/**
|
|
112713
|
-
* When the session last refreshed its tokens (ISO 8601). Null if it never has.
|
|
112714
|
-
*/
|
|
112715
111338
|
lastRefreshedAt: (string | null)
|
|
112716
|
-
/**
|
|
112717
|
-
* When the session ends no matter how often it refreshes (ISO 8601).
|
|
112718
|
-
*/
|
|
112719
111339
|
absoluteExpiresAt: string
|
|
112720
111340
|
}[]
|
|
112721
111341
|
}
|
|
@@ -112732,9 +111352,6 @@ sessionId?: string
|
|
|
112732
111352
|
}
|
|
112733
111353
|
|
|
112734
111354
|
export interface UsersSessionsRevokeOutput {
|
|
112735
|
-
/**
|
|
112736
|
-
* How many sessions were revoked. Zero when there was nothing live to revoke.
|
|
112737
|
-
*/
|
|
112738
111355
|
revoked: number
|
|
112739
111356
|
}
|
|
112740
111357
|
|
|
@@ -112861,126 +111478,37 @@ userId: string
|
|
|
112861
111478
|
}
|
|
112862
111479
|
|
|
112863
111480
|
export interface UsersUsersBanOutput {
|
|
112864
|
-
/**
|
|
112865
|
-
* Id of this end user. Pass it to any users_users_* tool.
|
|
112866
|
-
*/
|
|
112867
111481
|
id: string
|
|
112868
|
-
/**
|
|
112869
|
-
* The user's display name. Null when nobody set one.
|
|
112870
|
-
*/
|
|
112871
111482
|
name: (string | null)
|
|
112872
|
-
/**
|
|
112873
|
-
* When the user was banned (ISO 8601). Null while they are not banned.
|
|
112874
|
-
*/
|
|
112875
111483
|
bannedAt: (string | null)
|
|
112876
|
-
/**
|
|
112877
|
-
* When this user's personal data was purged for good (ISO 8601). Null while it is intact.
|
|
112878
|
-
*/
|
|
112879
111484
|
erasedAt: (string | null)
|
|
112880
|
-
/**
|
|
112881
|
-
* URL of the user's avatar. Null when there is none.
|
|
112882
|
-
*/
|
|
112883
111485
|
imageUrl: (string | null)
|
|
112884
|
-
/**
|
|
112885
|
-
* Whether this is a test fixture — excluded from metering and from the default listing.
|
|
112886
|
-
*/
|
|
112887
111486
|
testUser: boolean
|
|
112888
|
-
/**
|
|
112889
|
-
* When the user was created (ISO 8601).
|
|
112890
|
-
*/
|
|
112891
111487
|
createdAt: string
|
|
112892
|
-
/**
|
|
112893
|
-
* When the user was soft-deleted (ISO 8601). Null while the account is live.
|
|
112894
|
-
*/
|
|
112895
111488
|
deletedAt: (string | null)
|
|
112896
|
-
/**
|
|
112897
|
-
* Product this user belongs to. Never an input — it comes from the calling identity.
|
|
112898
|
-
*/
|
|
112899
111489
|
productId: string
|
|
112900
|
-
/**
|
|
112901
|
-
* When the user was last changed (ISO 8601).
|
|
112902
|
-
*/
|
|
112903
111490
|
updatedAt: string
|
|
112904
|
-
/**
|
|
112905
|
-
* Whether this user is still on the waitlist and cannot sign in yet.
|
|
112906
|
-
*/
|
|
112907
111491
|
waitlisted: boolean
|
|
112908
|
-
/**
|
|
112909
|
-
* 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".
|
|
112910
|
-
*/
|
|
112911
111492
|
identifiers: {
|
|
112912
|
-
/**
|
|
112913
|
-
* Id of this identifier row.
|
|
112914
|
-
*/
|
|
112915
111493
|
id: string
|
|
112916
|
-
/**
|
|
112917
|
-
* What kind of identifier this is. Today always `email`.
|
|
112918
|
-
*/
|
|
112919
111494
|
type: "email"
|
|
112920
|
-
/**
|
|
112921
|
-
* The address as the user typed it, for display.
|
|
112922
|
-
*/
|
|
112923
111495
|
value: string
|
|
112924
|
-
/**
|
|
112925
|
-
* Whether this is the identifier the user signs in with and is contacted at.
|
|
112926
|
-
*/
|
|
112927
111496
|
isPrimary: boolean
|
|
112928
|
-
/**
|
|
112929
|
-
* When this address was verified (ISO 8601). Null while it never was.
|
|
112930
|
-
*/
|
|
112931
111497
|
verifiedAt: (string | null)
|
|
112932
|
-
/**
|
|
112933
|
-
* The address lowercased and NFC-normalised — what uniqueness is checked against.
|
|
112934
|
-
*/
|
|
112935
111498
|
valueCanonical: string
|
|
112936
|
-
/**
|
|
112937
|
-
* `unverified`, `verified`, or `expired` when a verification link ran out before it was used.
|
|
112938
|
-
*/
|
|
112939
111499
|
verificationStatus: ("unverified" | "verified" | "expired")
|
|
112940
111500
|
}[]
|
|
112941
|
-
/**
|
|
112942
|
-
* When a failed-attempt lockout expires (ISO 8601). Null when the user is not locked out.
|
|
112943
|
-
*/
|
|
112944
111501
|
lockedUntil: (string | null)
|
|
112945
|
-
/**
|
|
112946
|
-
* When the user last signed in (ISO 8601). Null if they never have.
|
|
112947
|
-
*/
|
|
112948
111502
|
lastSignInAt: (string | null)
|
|
112949
|
-
/**
|
|
112950
|
-
* The user's primary email address, as typed. Null when they have no primary identifier. Bind this rather than `identifiers.0.value`.
|
|
112951
|
-
*/
|
|
112952
|
-
primaryEmail: (string | null)
|
|
112953
|
-
/**
|
|
112954
|
-
* Whether the user must set a new password at their next sign-in.
|
|
112955
|
-
*/
|
|
112956
111503
|
requiresReset: boolean
|
|
112957
|
-
|
|
112958
|
-
|
|
112959
|
-
|
|
112960
|
-
|
|
112961
|
-
[k: string]: unknown
|
|
112962
|
-
}
|
|
112963
|
-
/**
|
|
112964
|
-
* Metadata the end user may write themselves. Treat it as untrusted.
|
|
112965
|
-
*/
|
|
112966
|
-
unsafeMetadata: {
|
|
112967
|
-
[k: string]: unknown
|
|
111504
|
+
publicMetadata: UsersUsersBanOutputPublicMetadata
|
|
111505
|
+
unsafeMetadata: UsersUsersBanOutputPublicMetadata
|
|
111506
|
+
privateMetadata: UsersUsersBanOutputPublicMetadata
|
|
111507
|
+
emailChangeLockedUntil: (string | null)
|
|
112968
111508
|
}
|
|
112969
|
-
|
|
112970
|
-
* Metadata for the management plane only. Never reaches the end user or a token.
|
|
112971
|
-
*/
|
|
112972
|
-
privateMetadata: {
|
|
111509
|
+
export interface UsersUsersBanOutputPublicMetadata {
|
|
112973
111510
|
[k: string]: unknown
|
|
112974
111511
|
}
|
|
112975
|
-
/**
|
|
112976
|
-
* Id of the primary identifier row. Null when there is no primary identifier.
|
|
112977
|
-
*/
|
|
112978
|
-
primaryIdentifierId: (string | null)
|
|
112979
|
-
/**
|
|
112980
|
-
* 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.
|
|
112981
|
-
*/
|
|
112982
|
-
emailChangeLockedUntil: (string | null)
|
|
112983
|
-
}
|
|
112984
111512
|
|
|
112985
111513
|
export interface UsersUsersCreateInput {
|
|
112986
111514
|
/**
|
|
@@ -113083,126 +111611,37 @@ export interface UsersUsersCreateInputPublicMetadata1 {
|
|
|
113083
111611
|
}
|
|
113084
111612
|
|
|
113085
111613
|
export interface UsersUsersCreateOutput {
|
|
113086
|
-
/**
|
|
113087
|
-
* Id of this end user. Pass it to any users_users_* tool.
|
|
113088
|
-
*/
|
|
113089
111614
|
id: string
|
|
113090
|
-
/**
|
|
113091
|
-
* The user's display name. Null when nobody set one.
|
|
113092
|
-
*/
|
|
113093
111615
|
name: (string | null)
|
|
113094
|
-
/**
|
|
113095
|
-
* When the user was banned (ISO 8601). Null while they are not banned.
|
|
113096
|
-
*/
|
|
113097
111616
|
bannedAt: (string | null)
|
|
113098
|
-
/**
|
|
113099
|
-
* When this user's personal data was purged for good (ISO 8601). Null while it is intact.
|
|
113100
|
-
*/
|
|
113101
111617
|
erasedAt: (string | null)
|
|
113102
|
-
/**
|
|
113103
|
-
* URL of the user's avatar. Null when there is none.
|
|
113104
|
-
*/
|
|
113105
111618
|
imageUrl: (string | null)
|
|
113106
|
-
/**
|
|
113107
|
-
* Whether this is a test fixture — excluded from metering and from the default listing.
|
|
113108
|
-
*/
|
|
113109
111619
|
testUser: boolean
|
|
113110
|
-
/**
|
|
113111
|
-
* When the user was created (ISO 8601).
|
|
113112
|
-
*/
|
|
113113
111620
|
createdAt: string
|
|
113114
|
-
/**
|
|
113115
|
-
* When the user was soft-deleted (ISO 8601). Null while the account is live.
|
|
113116
|
-
*/
|
|
113117
111621
|
deletedAt: (string | null)
|
|
113118
|
-
/**
|
|
113119
|
-
* Product this user belongs to. Never an input — it comes from the calling identity.
|
|
113120
|
-
*/
|
|
113121
111622
|
productId: string
|
|
113122
|
-
/**
|
|
113123
|
-
* When the user was last changed (ISO 8601).
|
|
113124
|
-
*/
|
|
113125
111623
|
updatedAt: string
|
|
113126
|
-
/**
|
|
113127
|
-
* Whether this user is still on the waitlist and cannot sign in yet.
|
|
113128
|
-
*/
|
|
113129
111624
|
waitlisted: boolean
|
|
113130
|
-
/**
|
|
113131
|
-
* 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".
|
|
113132
|
-
*/
|
|
113133
111625
|
identifiers: {
|
|
113134
|
-
/**
|
|
113135
|
-
* Id of this identifier row.
|
|
113136
|
-
*/
|
|
113137
111626
|
id: string
|
|
113138
|
-
/**
|
|
113139
|
-
* What kind of identifier this is. Today always `email`.
|
|
113140
|
-
*/
|
|
113141
111627
|
type: "email"
|
|
113142
|
-
/**
|
|
113143
|
-
* The address as the user typed it, for display.
|
|
113144
|
-
*/
|
|
113145
111628
|
value: string
|
|
113146
|
-
/**
|
|
113147
|
-
* Whether this is the identifier the user signs in with and is contacted at.
|
|
113148
|
-
*/
|
|
113149
111629
|
isPrimary: boolean
|
|
113150
|
-
/**
|
|
113151
|
-
* When this address was verified (ISO 8601). Null while it never was.
|
|
113152
|
-
*/
|
|
113153
111630
|
verifiedAt: (string | null)
|
|
113154
|
-
/**
|
|
113155
|
-
* The address lowercased and NFC-normalised — what uniqueness is checked against.
|
|
113156
|
-
*/
|
|
113157
111631
|
valueCanonical: string
|
|
113158
|
-
/**
|
|
113159
|
-
* `unverified`, `verified`, or `expired` when a verification link ran out before it was used.
|
|
113160
|
-
*/
|
|
113161
111632
|
verificationStatus: ("unverified" | "verified" | "expired")
|
|
113162
111633
|
}[]
|
|
113163
|
-
/**
|
|
113164
|
-
* When a failed-attempt lockout expires (ISO 8601). Null when the user is not locked out.
|
|
113165
|
-
*/
|
|
113166
111634
|
lockedUntil: (string | null)
|
|
113167
|
-
/**
|
|
113168
|
-
* When the user last signed in (ISO 8601). Null if they never have.
|
|
113169
|
-
*/
|
|
113170
111635
|
lastSignInAt: (string | null)
|
|
113171
|
-
/**
|
|
113172
|
-
* The user's primary email address, as typed. Null when they have no primary identifier. Bind this rather than `identifiers.0.value`.
|
|
113173
|
-
*/
|
|
113174
|
-
primaryEmail: (string | null)
|
|
113175
|
-
/**
|
|
113176
|
-
* Whether the user must set a new password at their next sign-in.
|
|
113177
|
-
*/
|
|
113178
111636
|
requiresReset: boolean
|
|
113179
|
-
|
|
113180
|
-
|
|
113181
|
-
|
|
113182
|
-
|
|
113183
|
-
[k: string]: unknown
|
|
113184
|
-
}
|
|
113185
|
-
/**
|
|
113186
|
-
* Metadata the end user may write themselves. Treat it as untrusted.
|
|
113187
|
-
*/
|
|
113188
|
-
unsafeMetadata: {
|
|
113189
|
-
[k: string]: unknown
|
|
111637
|
+
publicMetadata: UsersUsersCreateOutputPublicMetadata
|
|
111638
|
+
unsafeMetadata: UsersUsersCreateOutputPublicMetadata
|
|
111639
|
+
privateMetadata: UsersUsersCreateOutputPublicMetadata
|
|
111640
|
+
emailChangeLockedUntil: (string | null)
|
|
113190
111641
|
}
|
|
113191
|
-
|
|
113192
|
-
* Metadata for the management plane only. Never reaches the end user or a token.
|
|
113193
|
-
*/
|
|
113194
|
-
privateMetadata: {
|
|
111642
|
+
export interface UsersUsersCreateOutputPublicMetadata {
|
|
113195
111643
|
[k: string]: unknown
|
|
113196
111644
|
}
|
|
113197
|
-
/**
|
|
113198
|
-
* Id of the primary identifier row. Null when there is no primary identifier.
|
|
113199
|
-
*/
|
|
113200
|
-
primaryIdentifierId: (string | null)
|
|
113201
|
-
/**
|
|
113202
|
-
* 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.
|
|
113203
|
-
*/
|
|
113204
|
-
emailChangeLockedUntil: (string | null)
|
|
113205
|
-
}
|
|
113206
111645
|
|
|
113207
111646
|
export interface UsersUsersDeleteInput {
|
|
113208
111647
|
/**
|
|
@@ -113212,126 +111651,37 @@ userId: string
|
|
|
113212
111651
|
}
|
|
113213
111652
|
|
|
113214
111653
|
export interface UsersUsersDeleteOutput {
|
|
113215
|
-
/**
|
|
113216
|
-
* Id of this end user. Pass it to any users_users_* tool.
|
|
113217
|
-
*/
|
|
113218
111654
|
id: string
|
|
113219
|
-
/**
|
|
113220
|
-
* The user's display name. Null when nobody set one.
|
|
113221
|
-
*/
|
|
113222
111655
|
name: (string | null)
|
|
113223
|
-
/**
|
|
113224
|
-
* When the user was banned (ISO 8601). Null while they are not banned.
|
|
113225
|
-
*/
|
|
113226
111656
|
bannedAt: (string | null)
|
|
113227
|
-
/**
|
|
113228
|
-
* When this user's personal data was purged for good (ISO 8601). Null while it is intact.
|
|
113229
|
-
*/
|
|
113230
111657
|
erasedAt: (string | null)
|
|
113231
|
-
/**
|
|
113232
|
-
* URL of the user's avatar. Null when there is none.
|
|
113233
|
-
*/
|
|
113234
111658
|
imageUrl: (string | null)
|
|
113235
|
-
/**
|
|
113236
|
-
* Whether this is a test fixture — excluded from metering and from the default listing.
|
|
113237
|
-
*/
|
|
113238
111659
|
testUser: boolean
|
|
113239
|
-
/**
|
|
113240
|
-
* When the user was created (ISO 8601).
|
|
113241
|
-
*/
|
|
113242
111660
|
createdAt: string
|
|
113243
|
-
/**
|
|
113244
|
-
* When the user was soft-deleted (ISO 8601). Null while the account is live.
|
|
113245
|
-
*/
|
|
113246
111661
|
deletedAt: (string | null)
|
|
113247
|
-
/**
|
|
113248
|
-
* Product this user belongs to. Never an input — it comes from the calling identity.
|
|
113249
|
-
*/
|
|
113250
111662
|
productId: string
|
|
113251
|
-
/**
|
|
113252
|
-
* When the user was last changed (ISO 8601).
|
|
113253
|
-
*/
|
|
113254
111663
|
updatedAt: string
|
|
113255
|
-
/**
|
|
113256
|
-
* Whether this user is still on the waitlist and cannot sign in yet.
|
|
113257
|
-
*/
|
|
113258
111664
|
waitlisted: boolean
|
|
113259
|
-
/**
|
|
113260
|
-
* 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".
|
|
113261
|
-
*/
|
|
113262
111665
|
identifiers: {
|
|
113263
|
-
/**
|
|
113264
|
-
* Id of this identifier row.
|
|
113265
|
-
*/
|
|
113266
111666
|
id: string
|
|
113267
|
-
/**
|
|
113268
|
-
* What kind of identifier this is. Today always `email`.
|
|
113269
|
-
*/
|
|
113270
111667
|
type: "email"
|
|
113271
|
-
/**
|
|
113272
|
-
* The address as the user typed it, for display.
|
|
113273
|
-
*/
|
|
113274
111668
|
value: string
|
|
113275
|
-
/**
|
|
113276
|
-
* Whether this is the identifier the user signs in with and is contacted at.
|
|
113277
|
-
*/
|
|
113278
111669
|
isPrimary: boolean
|
|
113279
|
-
/**
|
|
113280
|
-
* When this address was verified (ISO 8601). Null while it never was.
|
|
113281
|
-
*/
|
|
113282
111670
|
verifiedAt: (string | null)
|
|
113283
|
-
/**
|
|
113284
|
-
* The address lowercased and NFC-normalised — what uniqueness is checked against.
|
|
113285
|
-
*/
|
|
113286
111671
|
valueCanonical: string
|
|
113287
|
-
/**
|
|
113288
|
-
* `unverified`, `verified`, or `expired` when a verification link ran out before it was used.
|
|
113289
|
-
*/
|
|
113290
111672
|
verificationStatus: ("unverified" | "verified" | "expired")
|
|
113291
111673
|
}[]
|
|
113292
|
-
/**
|
|
113293
|
-
* When a failed-attempt lockout expires (ISO 8601). Null when the user is not locked out.
|
|
113294
|
-
*/
|
|
113295
111674
|
lockedUntil: (string | null)
|
|
113296
|
-
/**
|
|
113297
|
-
* When the user last signed in (ISO 8601). Null if they never have.
|
|
113298
|
-
*/
|
|
113299
111675
|
lastSignInAt: (string | null)
|
|
113300
|
-
/**
|
|
113301
|
-
* The user's primary email address, as typed. Null when they have no primary identifier. Bind this rather than `identifiers.0.value`.
|
|
113302
|
-
*/
|
|
113303
|
-
primaryEmail: (string | null)
|
|
113304
|
-
/**
|
|
113305
|
-
* Whether the user must set a new password at their next sign-in.
|
|
113306
|
-
*/
|
|
113307
111676
|
requiresReset: boolean
|
|
113308
|
-
|
|
113309
|
-
|
|
113310
|
-
|
|
113311
|
-
|
|
113312
|
-
[k: string]: unknown
|
|
113313
|
-
}
|
|
113314
|
-
/**
|
|
113315
|
-
* Metadata the end user may write themselves. Treat it as untrusted.
|
|
113316
|
-
*/
|
|
113317
|
-
unsafeMetadata: {
|
|
113318
|
-
[k: string]: unknown
|
|
111677
|
+
publicMetadata: UsersUsersDeleteOutputPublicMetadata
|
|
111678
|
+
unsafeMetadata: UsersUsersDeleteOutputPublicMetadata
|
|
111679
|
+
privateMetadata: UsersUsersDeleteOutputPublicMetadata
|
|
111680
|
+
emailChangeLockedUntil: (string | null)
|
|
113319
111681
|
}
|
|
113320
|
-
|
|
113321
|
-
* Metadata for the management plane only. Never reaches the end user or a token.
|
|
113322
|
-
*/
|
|
113323
|
-
privateMetadata: {
|
|
111682
|
+
export interface UsersUsersDeleteOutputPublicMetadata {
|
|
113324
111683
|
[k: string]: unknown
|
|
113325
111684
|
}
|
|
113326
|
-
/**
|
|
113327
|
-
* Id of the primary identifier row. Null when there is no primary identifier.
|
|
113328
|
-
*/
|
|
113329
|
-
primaryIdentifierId: (string | null)
|
|
113330
|
-
/**
|
|
113331
|
-
* 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.
|
|
113332
|
-
*/
|
|
113333
|
-
emailChangeLockedUntil: (string | null)
|
|
113334
|
-
}
|
|
113335
111685
|
|
|
113336
111686
|
export interface UsersUsersExportInput {
|
|
113337
111687
|
/**
|
|
@@ -113359,129 +111709,40 @@ includeDeleted?: boolean
|
|
|
113359
111709
|
export interface UsersUsersExportOutput {
|
|
113360
111710
|
count: number
|
|
113361
111711
|
users: {
|
|
113362
|
-
/**
|
|
113363
|
-
* Id of this end user. Pass it to any users_users_* tool.
|
|
113364
|
-
*/
|
|
113365
111712
|
id: string
|
|
113366
|
-
/**
|
|
113367
|
-
* The user's display name. Null when nobody set one.
|
|
113368
|
-
*/
|
|
113369
111713
|
name: (string | null)
|
|
113370
|
-
/**
|
|
113371
|
-
* When the user was banned (ISO 8601). Null while they are not banned.
|
|
113372
|
-
*/
|
|
113373
111714
|
bannedAt: (string | null)
|
|
113374
|
-
/**
|
|
113375
|
-
* When this user's personal data was purged for good (ISO 8601). Null while it is intact.
|
|
113376
|
-
*/
|
|
113377
111715
|
erasedAt: (string | null)
|
|
113378
|
-
/**
|
|
113379
|
-
* URL of the user's avatar. Null when there is none.
|
|
113380
|
-
*/
|
|
113381
111716
|
imageUrl: (string | null)
|
|
113382
|
-
/**
|
|
113383
|
-
* Whether this is a test fixture — excluded from metering and from the default listing.
|
|
113384
|
-
*/
|
|
113385
111717
|
testUser: boolean
|
|
113386
|
-
/**
|
|
113387
|
-
* When the user was created (ISO 8601).
|
|
113388
|
-
*/
|
|
113389
111718
|
createdAt: string
|
|
113390
|
-
/**
|
|
113391
|
-
* When the user was soft-deleted (ISO 8601). Null while the account is live.
|
|
113392
|
-
*/
|
|
113393
111719
|
deletedAt: (string | null)
|
|
113394
|
-
/**
|
|
113395
|
-
* Product this user belongs to. Never an input — it comes from the calling identity.
|
|
113396
|
-
*/
|
|
113397
111720
|
productId: string
|
|
113398
|
-
/**
|
|
113399
|
-
* When the user was last changed (ISO 8601).
|
|
113400
|
-
*/
|
|
113401
111721
|
updatedAt: string
|
|
113402
|
-
/**
|
|
113403
|
-
* Whether this user is still on the waitlist and cannot sign in yet.
|
|
113404
|
-
*/
|
|
113405
111722
|
waitlisted: boolean
|
|
113406
|
-
/**
|
|
113407
|
-
* 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".
|
|
113408
|
-
*/
|
|
113409
111723
|
identifiers: {
|
|
113410
|
-
/**
|
|
113411
|
-
* Id of this identifier row.
|
|
113412
|
-
*/
|
|
113413
111724
|
id: string
|
|
113414
|
-
/**
|
|
113415
|
-
* What kind of identifier this is. Today always `email`.
|
|
113416
|
-
*/
|
|
113417
111725
|
type: "email"
|
|
113418
|
-
/**
|
|
113419
|
-
* The address as the user typed it, for display.
|
|
113420
|
-
*/
|
|
113421
111726
|
value: string
|
|
113422
|
-
/**
|
|
113423
|
-
* Whether this is the identifier the user signs in with and is contacted at.
|
|
113424
|
-
*/
|
|
113425
111727
|
isPrimary: boolean
|
|
113426
|
-
/**
|
|
113427
|
-
* When this address was verified (ISO 8601). Null while it never was.
|
|
113428
|
-
*/
|
|
113429
111728
|
verifiedAt: (string | null)
|
|
113430
|
-
/**
|
|
113431
|
-
* The address lowercased and NFC-normalised — what uniqueness is checked against.
|
|
113432
|
-
*/
|
|
113433
111729
|
valueCanonical: string
|
|
113434
|
-
/**
|
|
113435
|
-
* `unverified`, `verified`, or `expired` when a verification link ran out before it was used.
|
|
113436
|
-
*/
|
|
113437
111730
|
verificationStatus: ("unverified" | "verified" | "expired")
|
|
113438
111731
|
}[]
|
|
113439
|
-
/**
|
|
113440
|
-
* When a failed-attempt lockout expires (ISO 8601). Null when the user is not locked out.
|
|
113441
|
-
*/
|
|
113442
111732
|
lockedUntil: (string | null)
|
|
113443
|
-
/**
|
|
113444
|
-
* When the user last signed in (ISO 8601). Null if they never have.
|
|
113445
|
-
*/
|
|
113446
111733
|
lastSignInAt: (string | null)
|
|
113447
|
-
/**
|
|
113448
|
-
* The user's primary email address, as typed. Null when they have no primary identifier. Bind this rather than `identifiers.0.value`.
|
|
113449
|
-
*/
|
|
113450
|
-
primaryEmail: (string | null)
|
|
113451
|
-
/**
|
|
113452
|
-
* Whether the user must set a new password at their next sign-in.
|
|
113453
|
-
*/
|
|
113454
111734
|
requiresReset: boolean
|
|
113455
|
-
|
|
113456
|
-
|
|
113457
|
-
|
|
113458
|
-
publicMetadata: {
|
|
113459
|
-
[k: string]: unknown
|
|
113460
|
-
}
|
|
113461
|
-
/**
|
|
113462
|
-
* Metadata the end user may write themselves. Treat it as untrusted.
|
|
113463
|
-
*/
|
|
113464
|
-
unsafeMetadata: {
|
|
113465
|
-
[k: string]: unknown
|
|
113466
|
-
}
|
|
113467
|
-
/**
|
|
113468
|
-
* Metadata for the management plane only. Never reaches the end user or a token.
|
|
113469
|
-
*/
|
|
113470
|
-
privateMetadata: {
|
|
113471
|
-
[k: string]: unknown
|
|
113472
|
-
}
|
|
113473
|
-
/**
|
|
113474
|
-
* Id of the primary identifier row. Null when there is no primary identifier.
|
|
113475
|
-
*/
|
|
113476
|
-
primaryIdentifierId: (string | null)
|
|
113477
|
-
/**
|
|
113478
|
-
* 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.
|
|
113479
|
-
*/
|
|
111735
|
+
publicMetadata: UsersUsersExportOutputPublicMetadata
|
|
111736
|
+
unsafeMetadata: UsersUsersExportOutputPublicMetadata
|
|
111737
|
+
privateMetadata: UsersUsersExportOutputPublicMetadata
|
|
113480
111738
|
emailChangeLockedUntil: (string | null)
|
|
113481
111739
|
}[]
|
|
113482
111740
|
exportedAt: string
|
|
113483
111741
|
nextCursor: (string | null)
|
|
113484
111742
|
}
|
|
111743
|
+
export interface UsersUsersExportOutputPublicMetadata {
|
|
111744
|
+
[k: string]: unknown
|
|
111745
|
+
}
|
|
113485
111746
|
|
|
113486
111747
|
export interface UsersUsersGetInput {
|
|
113487
111748
|
/**
|
|
@@ -113491,126 +111752,37 @@ userId: string
|
|
|
113491
111752
|
}
|
|
113492
111753
|
|
|
113493
111754
|
export interface UsersUsersGetOutput {
|
|
113494
|
-
/**
|
|
113495
|
-
* Id of this end user. Pass it to any users_users_* tool.
|
|
113496
|
-
*/
|
|
113497
111755
|
id: string
|
|
113498
|
-
/**
|
|
113499
|
-
* The user's display name. Null when nobody set one.
|
|
113500
|
-
*/
|
|
113501
111756
|
name: (string | null)
|
|
113502
|
-
/**
|
|
113503
|
-
* When the user was banned (ISO 8601). Null while they are not banned.
|
|
113504
|
-
*/
|
|
113505
111757
|
bannedAt: (string | null)
|
|
113506
|
-
/**
|
|
113507
|
-
* When this user's personal data was purged for good (ISO 8601). Null while it is intact.
|
|
113508
|
-
*/
|
|
113509
111758
|
erasedAt: (string | null)
|
|
113510
|
-
/**
|
|
113511
|
-
* URL of the user's avatar. Null when there is none.
|
|
113512
|
-
*/
|
|
113513
111759
|
imageUrl: (string | null)
|
|
113514
|
-
/**
|
|
113515
|
-
* Whether this is a test fixture — excluded from metering and from the default listing.
|
|
113516
|
-
*/
|
|
113517
111760
|
testUser: boolean
|
|
113518
|
-
/**
|
|
113519
|
-
* When the user was created (ISO 8601).
|
|
113520
|
-
*/
|
|
113521
111761
|
createdAt: string
|
|
113522
|
-
/**
|
|
113523
|
-
* When the user was soft-deleted (ISO 8601). Null while the account is live.
|
|
113524
|
-
*/
|
|
113525
111762
|
deletedAt: (string | null)
|
|
113526
|
-
/**
|
|
113527
|
-
* Product this user belongs to. Never an input — it comes from the calling identity.
|
|
113528
|
-
*/
|
|
113529
111763
|
productId: string
|
|
113530
|
-
/**
|
|
113531
|
-
* When the user was last changed (ISO 8601).
|
|
113532
|
-
*/
|
|
113533
111764
|
updatedAt: string
|
|
113534
|
-
/**
|
|
113535
|
-
* Whether this user is still on the waitlist and cannot sign in yet.
|
|
113536
|
-
*/
|
|
113537
111765
|
waitlisted: boolean
|
|
113538
|
-
/**
|
|
113539
|
-
* 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".
|
|
113540
|
-
*/
|
|
113541
111766
|
identifiers: {
|
|
113542
|
-
/**
|
|
113543
|
-
* Id of this identifier row.
|
|
113544
|
-
*/
|
|
113545
111767
|
id: string
|
|
113546
|
-
/**
|
|
113547
|
-
* What kind of identifier this is. Today always `email`.
|
|
113548
|
-
*/
|
|
113549
111768
|
type: "email"
|
|
113550
|
-
/**
|
|
113551
|
-
* The address as the user typed it, for display.
|
|
113552
|
-
*/
|
|
113553
111769
|
value: string
|
|
113554
|
-
/**
|
|
113555
|
-
* Whether this is the identifier the user signs in with and is contacted at.
|
|
113556
|
-
*/
|
|
113557
111770
|
isPrimary: boolean
|
|
113558
|
-
/**
|
|
113559
|
-
* When this address was verified (ISO 8601). Null while it never was.
|
|
113560
|
-
*/
|
|
113561
111771
|
verifiedAt: (string | null)
|
|
113562
|
-
/**
|
|
113563
|
-
* The address lowercased and NFC-normalised — what uniqueness is checked against.
|
|
113564
|
-
*/
|
|
113565
111772
|
valueCanonical: string
|
|
113566
|
-
/**
|
|
113567
|
-
* `unverified`, `verified`, or `expired` when a verification link ran out before it was used.
|
|
113568
|
-
*/
|
|
113569
111773
|
verificationStatus: ("unverified" | "verified" | "expired")
|
|
113570
111774
|
}[]
|
|
113571
|
-
/**
|
|
113572
|
-
* When a failed-attempt lockout expires (ISO 8601). Null when the user is not locked out.
|
|
113573
|
-
*/
|
|
113574
111775
|
lockedUntil: (string | null)
|
|
113575
|
-
/**
|
|
113576
|
-
* When the user last signed in (ISO 8601). Null if they never have.
|
|
113577
|
-
*/
|
|
113578
111776
|
lastSignInAt: (string | null)
|
|
113579
|
-
/**
|
|
113580
|
-
* The user's primary email address, as typed. Null when they have no primary identifier. Bind this rather than `identifiers.0.value`.
|
|
113581
|
-
*/
|
|
113582
|
-
primaryEmail: (string | null)
|
|
113583
|
-
/**
|
|
113584
|
-
* Whether the user must set a new password at their next sign-in.
|
|
113585
|
-
*/
|
|
113586
111777
|
requiresReset: boolean
|
|
113587
|
-
|
|
113588
|
-
|
|
113589
|
-
|
|
113590
|
-
|
|
113591
|
-
[k: string]: unknown
|
|
113592
|
-
}
|
|
113593
|
-
/**
|
|
113594
|
-
* Metadata the end user may write themselves. Treat it as untrusted.
|
|
113595
|
-
*/
|
|
113596
|
-
unsafeMetadata: {
|
|
113597
|
-
[k: string]: unknown
|
|
111778
|
+
publicMetadata: UsersUsersGetOutputPublicMetadata
|
|
111779
|
+
unsafeMetadata: UsersUsersGetOutputPublicMetadata
|
|
111780
|
+
privateMetadata: UsersUsersGetOutputPublicMetadata
|
|
111781
|
+
emailChangeLockedUntil: (string | null)
|
|
113598
111782
|
}
|
|
113599
|
-
|
|
113600
|
-
* Metadata for the management plane only. Never reaches the end user or a token.
|
|
113601
|
-
*/
|
|
113602
|
-
privateMetadata: {
|
|
111783
|
+
export interface UsersUsersGetOutputPublicMetadata {
|
|
113603
111784
|
[k: string]: unknown
|
|
113604
111785
|
}
|
|
113605
|
-
/**
|
|
113606
|
-
* Id of the primary identifier row. Null when there is no primary identifier.
|
|
113607
|
-
*/
|
|
113608
|
-
primaryIdentifierId: (string | null)
|
|
113609
|
-
/**
|
|
113610
|
-
* 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.
|
|
113611
|
-
*/
|
|
113612
|
-
emailChangeLockedUntil: (string | null)
|
|
113613
|
-
}
|
|
113614
111786
|
|
|
113615
111787
|
export interface UsersUsersImportInput {
|
|
113616
111788
|
/**
|
|
@@ -113623,42 +111795,15 @@ users: [unknown, ...(unknown)[]]
|
|
|
113623
111795
|
}
|
|
113624
111796
|
|
|
113625
111797
|
export interface UsersUsersImportOutput {
|
|
113626
|
-
/**
|
|
113627
|
-
* How many rows could not be imported at all.
|
|
113628
|
-
*/
|
|
113629
111798
|
failed: number
|
|
113630
|
-
/**
|
|
113631
|
-
* How many users were created.
|
|
113632
|
-
*/
|
|
113633
111799
|
created: number
|
|
113634
|
-
/**
|
|
113635
|
-
* One row per submitted row, in the order you sent them.
|
|
113636
|
-
*/
|
|
113637
111800
|
results: {
|
|
113638
|
-
/**
|
|
113639
|
-
* Zero-based index of the row in the `users` array you sent.
|
|
113640
|
-
*/
|
|
113641
111801
|
row: number
|
|
113642
|
-
/**
|
|
113643
|
-
* Why it was skipped, or what went wrong. Null for a created row.
|
|
113644
|
-
*/
|
|
113645
111802
|
reason: (string | null)
|
|
113646
|
-
/**
|
|
113647
|
-
* What happened to this row.
|
|
113648
|
-
*/
|
|
113649
111803
|
status: ("created" | "skipped" | "failed")
|
|
113650
|
-
/**
|
|
113651
|
-
* The created user's id. Null for skipped and failed rows.
|
|
113652
|
-
*/
|
|
113653
111804
|
userId: (string | null)
|
|
113654
111805
|
}[]
|
|
113655
|
-
/**
|
|
113656
|
-
* How many rows were passed over — an address already in the directory, typically.
|
|
113657
|
-
*/
|
|
113658
111806
|
skipped: number
|
|
113659
|
-
/**
|
|
113660
|
-
* How many rows you submitted.
|
|
113661
|
-
*/
|
|
113662
111807
|
requested: number
|
|
113663
111808
|
}
|
|
113664
111809
|
|
|
@@ -113686,21 +111831,9 @@ privateMetadata?: {
|
|
|
113686
111831
|
}
|
|
113687
111832
|
|
|
113688
111833
|
export interface UsersUsersInviteOutput {
|
|
113689
|
-
/**
|
|
113690
|
-
* False when the re-invite cooldown or the mail toolkit refused the send. The invite is still live.
|
|
113691
|
-
*/
|
|
113692
111834
|
mailed: boolean
|
|
113693
|
-
/**
|
|
113694
|
-
* The invited user, created immediately and listed straight away — they simply cannot sign in until they accept.
|
|
113695
|
-
*/
|
|
113696
111835
|
userId: string
|
|
113697
|
-
/**
|
|
113698
|
-
* False when this address had already been invited; the same user is returned.
|
|
113699
|
-
*/
|
|
113700
111836
|
created: boolean
|
|
113701
|
-
/**
|
|
113702
|
-
* When the invite link stops working (ISO 8601).
|
|
113703
|
-
*/
|
|
113704
111837
|
expiresAt: string
|
|
113705
111838
|
}
|
|
113706
111839
|
|
|
@@ -113736,135 +111869,40 @@ includeWaitlisted?: boolean
|
|
|
113736
111869
|
}
|
|
113737
111870
|
|
|
113738
111871
|
export interface UsersUsersListOutput {
|
|
113739
|
-
/**
|
|
113740
|
-
* The page of users, newest first.
|
|
113741
|
-
*/
|
|
113742
111872
|
users: {
|
|
113743
|
-
/**
|
|
113744
|
-
* Id of this end user. Pass it to any users_users_* tool.
|
|
113745
|
-
*/
|
|
113746
111873
|
id: string
|
|
113747
|
-
/**
|
|
113748
|
-
* The user's display name. Null when nobody set one.
|
|
113749
|
-
*/
|
|
113750
111874
|
name: (string | null)
|
|
113751
|
-
/**
|
|
113752
|
-
* When the user was banned (ISO 8601). Null while they are not banned.
|
|
113753
|
-
*/
|
|
113754
111875
|
bannedAt: (string | null)
|
|
113755
|
-
/**
|
|
113756
|
-
* When this user's personal data was purged for good (ISO 8601). Null while it is intact.
|
|
113757
|
-
*/
|
|
113758
111876
|
erasedAt: (string | null)
|
|
113759
|
-
/**
|
|
113760
|
-
* URL of the user's avatar. Null when there is none.
|
|
113761
|
-
*/
|
|
113762
111877
|
imageUrl: (string | null)
|
|
113763
|
-
/**
|
|
113764
|
-
* Whether this is a test fixture — excluded from metering and from the default listing.
|
|
113765
|
-
*/
|
|
113766
111878
|
testUser: boolean
|
|
113767
|
-
/**
|
|
113768
|
-
* When the user was created (ISO 8601).
|
|
113769
|
-
*/
|
|
113770
111879
|
createdAt: string
|
|
113771
|
-
/**
|
|
113772
|
-
* When the user was soft-deleted (ISO 8601). Null while the account is live.
|
|
113773
|
-
*/
|
|
113774
111880
|
deletedAt: (string | null)
|
|
113775
|
-
/**
|
|
113776
|
-
* Product this user belongs to. Never an input — it comes from the calling identity.
|
|
113777
|
-
*/
|
|
113778
111881
|
productId: string
|
|
113779
|
-
/**
|
|
113780
|
-
* When the user was last changed (ISO 8601).
|
|
113781
|
-
*/
|
|
113782
111882
|
updatedAt: string
|
|
113783
|
-
/**
|
|
113784
|
-
* Whether this user is still on the waitlist and cannot sign in yet.
|
|
113785
|
-
*/
|
|
113786
111883
|
waitlisted: boolean
|
|
113787
|
-
/**
|
|
113788
|
-
* 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".
|
|
113789
|
-
*/
|
|
113790
111884
|
identifiers: {
|
|
113791
|
-
/**
|
|
113792
|
-
* Id of this identifier row.
|
|
113793
|
-
*/
|
|
113794
111885
|
id: string
|
|
113795
|
-
/**
|
|
113796
|
-
* What kind of identifier this is. Today always `email`.
|
|
113797
|
-
*/
|
|
113798
111886
|
type: "email"
|
|
113799
|
-
/**
|
|
113800
|
-
* The address as the user typed it, for display.
|
|
113801
|
-
*/
|
|
113802
111887
|
value: string
|
|
113803
|
-
/**
|
|
113804
|
-
* Whether this is the identifier the user signs in with and is contacted at.
|
|
113805
|
-
*/
|
|
113806
111888
|
isPrimary: boolean
|
|
113807
|
-
/**
|
|
113808
|
-
* When this address was verified (ISO 8601). Null while it never was.
|
|
113809
|
-
*/
|
|
113810
111889
|
verifiedAt: (string | null)
|
|
113811
|
-
/**
|
|
113812
|
-
* The address lowercased and NFC-normalised — what uniqueness is checked against.
|
|
113813
|
-
*/
|
|
113814
111890
|
valueCanonical: string
|
|
113815
|
-
/**
|
|
113816
|
-
* `unverified`, `verified`, or `expired` when a verification link ran out before it was used.
|
|
113817
|
-
*/
|
|
113818
111891
|
verificationStatus: ("unverified" | "verified" | "expired")
|
|
113819
111892
|
}[]
|
|
113820
|
-
/**
|
|
113821
|
-
* When a failed-attempt lockout expires (ISO 8601). Null when the user is not locked out.
|
|
113822
|
-
*/
|
|
113823
111893
|
lockedUntil: (string | null)
|
|
113824
|
-
/**
|
|
113825
|
-
* When the user last signed in (ISO 8601). Null if they never have.
|
|
113826
|
-
*/
|
|
113827
111894
|
lastSignInAt: (string | null)
|
|
113828
|
-
/**
|
|
113829
|
-
* The user's primary email address, as typed. Null when they have no primary identifier. Bind this rather than `identifiers.0.value`.
|
|
113830
|
-
*/
|
|
113831
|
-
primaryEmail: (string | null)
|
|
113832
|
-
/**
|
|
113833
|
-
* Whether the user must set a new password at their next sign-in.
|
|
113834
|
-
*/
|
|
113835
111895
|
requiresReset: boolean
|
|
113836
|
-
|
|
113837
|
-
|
|
113838
|
-
|
|
113839
|
-
publicMetadata: {
|
|
113840
|
-
[k: string]: unknown
|
|
113841
|
-
}
|
|
113842
|
-
/**
|
|
113843
|
-
* Metadata the end user may write themselves. Treat it as untrusted.
|
|
113844
|
-
*/
|
|
113845
|
-
unsafeMetadata: {
|
|
113846
|
-
[k: string]: unknown
|
|
113847
|
-
}
|
|
113848
|
-
/**
|
|
113849
|
-
* Metadata for the management plane only. Never reaches the end user or a token.
|
|
113850
|
-
*/
|
|
113851
|
-
privateMetadata: {
|
|
113852
|
-
[k: string]: unknown
|
|
113853
|
-
}
|
|
113854
|
-
/**
|
|
113855
|
-
* Id of the primary identifier row. Null when there is no primary identifier.
|
|
113856
|
-
*/
|
|
113857
|
-
primaryIdentifierId: (string | null)
|
|
113858
|
-
/**
|
|
113859
|
-
* 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.
|
|
113860
|
-
*/
|
|
111896
|
+
publicMetadata: UsersUsersListOutputPublicMetadata
|
|
111897
|
+
unsafeMetadata: UsersUsersListOutputPublicMetadata
|
|
111898
|
+
privateMetadata: UsersUsersListOutputPublicMetadata
|
|
113861
111899
|
emailChangeLockedUntil: (string | null)
|
|
113862
111900
|
}[]
|
|
113863
|
-
/**
|
|
113864
|
-
* Pass back as `cursor` to fetch the next page. Null when this page is the last.
|
|
113865
|
-
*/
|
|
113866
111901
|
nextCursor: (string | null)
|
|
113867
111902
|
}
|
|
111903
|
+
export interface UsersUsersListOutputPublicMetadata {
|
|
111904
|
+
[k: string]: unknown
|
|
111905
|
+
}
|
|
113868
111906
|
|
|
113869
111907
|
export interface UsersUsersSetPrimaryIdentifierInput {
|
|
113870
111908
|
/**
|
|
@@ -113882,13 +111920,7 @@ userId: string
|
|
|
113882
111920
|
}
|
|
113883
111921
|
|
|
113884
111922
|
export interface UsersUsersSetPrimaryIdentifierOutput {
|
|
113885
|
-
/**
|
|
113886
|
-
* Id of the scheduled change. It appears in the audit rows and in the abort link mailed to the old address.
|
|
113887
|
-
*/
|
|
113888
111923
|
requestId: string
|
|
113889
|
-
/**
|
|
113890
|
-
* When the swap becomes applicable, if nobody aborts it first (ISO 8601). The delay is this product's `emailChange.overrideDelayHours`, 72 by default.
|
|
113891
|
-
*/
|
|
113892
111924
|
scheduledFor: string
|
|
113893
111925
|
}
|
|
113894
111926
|
|
|
@@ -113900,126 +111932,37 @@ userId: string
|
|
|
113900
111932
|
}
|
|
113901
111933
|
|
|
113902
111934
|
export interface UsersUsersUnbanOutput {
|
|
113903
|
-
/**
|
|
113904
|
-
* Id of this end user. Pass it to any users_users_* tool.
|
|
113905
|
-
*/
|
|
113906
111935
|
id: string
|
|
113907
|
-
/**
|
|
113908
|
-
* The user's display name. Null when nobody set one.
|
|
113909
|
-
*/
|
|
113910
111936
|
name: (string | null)
|
|
113911
|
-
/**
|
|
113912
|
-
* When the user was banned (ISO 8601). Null while they are not banned.
|
|
113913
|
-
*/
|
|
113914
111937
|
bannedAt: (string | null)
|
|
113915
|
-
/**
|
|
113916
|
-
* When this user's personal data was purged for good (ISO 8601). Null while it is intact.
|
|
113917
|
-
*/
|
|
113918
111938
|
erasedAt: (string | null)
|
|
113919
|
-
/**
|
|
113920
|
-
* URL of the user's avatar. Null when there is none.
|
|
113921
|
-
*/
|
|
113922
111939
|
imageUrl: (string | null)
|
|
113923
|
-
/**
|
|
113924
|
-
* Whether this is a test fixture — excluded from metering and from the default listing.
|
|
113925
|
-
*/
|
|
113926
111940
|
testUser: boolean
|
|
113927
|
-
/**
|
|
113928
|
-
* When the user was created (ISO 8601).
|
|
113929
|
-
*/
|
|
113930
111941
|
createdAt: string
|
|
113931
|
-
/**
|
|
113932
|
-
* When the user was soft-deleted (ISO 8601). Null while the account is live.
|
|
113933
|
-
*/
|
|
113934
111942
|
deletedAt: (string | null)
|
|
113935
|
-
/**
|
|
113936
|
-
* Product this user belongs to. Never an input — it comes from the calling identity.
|
|
113937
|
-
*/
|
|
113938
111943
|
productId: string
|
|
113939
|
-
/**
|
|
113940
|
-
* When the user was last changed (ISO 8601).
|
|
113941
|
-
*/
|
|
113942
111944
|
updatedAt: string
|
|
113943
|
-
/**
|
|
113944
|
-
* Whether this user is still on the waitlist and cannot sign in yet.
|
|
113945
|
-
*/
|
|
113946
111945
|
waitlisted: boolean
|
|
113947
|
-
/**
|
|
113948
|
-
* 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".
|
|
113949
|
-
*/
|
|
113950
111946
|
identifiers: {
|
|
113951
|
-
/**
|
|
113952
|
-
* Id of this identifier row.
|
|
113953
|
-
*/
|
|
113954
111947
|
id: string
|
|
113955
|
-
/**
|
|
113956
|
-
* What kind of identifier this is. Today always `email`.
|
|
113957
|
-
*/
|
|
113958
111948
|
type: "email"
|
|
113959
|
-
/**
|
|
113960
|
-
* The address as the user typed it, for display.
|
|
113961
|
-
*/
|
|
113962
111949
|
value: string
|
|
113963
|
-
/**
|
|
113964
|
-
* Whether this is the identifier the user signs in with and is contacted at.
|
|
113965
|
-
*/
|
|
113966
111950
|
isPrimary: boolean
|
|
113967
|
-
/**
|
|
113968
|
-
* When this address was verified (ISO 8601). Null while it never was.
|
|
113969
|
-
*/
|
|
113970
111951
|
verifiedAt: (string | null)
|
|
113971
|
-
/**
|
|
113972
|
-
* The address lowercased and NFC-normalised — what uniqueness is checked against.
|
|
113973
|
-
*/
|
|
113974
111952
|
valueCanonical: string
|
|
113975
|
-
/**
|
|
113976
|
-
* `unverified`, `verified`, or `expired` when a verification link ran out before it was used.
|
|
113977
|
-
*/
|
|
113978
111953
|
verificationStatus: ("unverified" | "verified" | "expired")
|
|
113979
111954
|
}[]
|
|
113980
|
-
/**
|
|
113981
|
-
* When a failed-attempt lockout expires (ISO 8601). Null when the user is not locked out.
|
|
113982
|
-
*/
|
|
113983
111955
|
lockedUntil: (string | null)
|
|
113984
|
-
/**
|
|
113985
|
-
* When the user last signed in (ISO 8601). Null if they never have.
|
|
113986
|
-
*/
|
|
113987
111956
|
lastSignInAt: (string | null)
|
|
113988
|
-
/**
|
|
113989
|
-
* The user's primary email address, as typed. Null when they have no primary identifier. Bind this rather than `identifiers.0.value`.
|
|
113990
|
-
*/
|
|
113991
|
-
primaryEmail: (string | null)
|
|
113992
|
-
/**
|
|
113993
|
-
* Whether the user must set a new password at their next sign-in.
|
|
113994
|
-
*/
|
|
113995
111957
|
requiresReset: boolean
|
|
113996
|
-
|
|
113997
|
-
|
|
113998
|
-
|
|
113999
|
-
|
|
114000
|
-
[k: string]: unknown
|
|
114001
|
-
}
|
|
114002
|
-
/**
|
|
114003
|
-
* Metadata the end user may write themselves. Treat it as untrusted.
|
|
114004
|
-
*/
|
|
114005
|
-
unsafeMetadata: {
|
|
114006
|
-
[k: string]: unknown
|
|
111958
|
+
publicMetadata: UsersUsersUnbanOutputPublicMetadata
|
|
111959
|
+
unsafeMetadata: UsersUsersUnbanOutputPublicMetadata
|
|
111960
|
+
privateMetadata: UsersUsersUnbanOutputPublicMetadata
|
|
111961
|
+
emailChangeLockedUntil: (string | null)
|
|
114007
111962
|
}
|
|
114008
|
-
|
|
114009
|
-
* Metadata for the management plane only. Never reaches the end user or a token.
|
|
114010
|
-
*/
|
|
114011
|
-
privateMetadata: {
|
|
111963
|
+
export interface UsersUsersUnbanOutputPublicMetadata {
|
|
114012
111964
|
[k: string]: unknown
|
|
114013
111965
|
}
|
|
114014
|
-
/**
|
|
114015
|
-
* Id of the primary identifier row. Null when there is no primary identifier.
|
|
114016
|
-
*/
|
|
114017
|
-
primaryIdentifierId: (string | null)
|
|
114018
|
-
/**
|
|
114019
|
-
* 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.
|
|
114020
|
-
*/
|
|
114021
|
-
emailChangeLockedUntil: (string | null)
|
|
114022
|
-
}
|
|
114023
111966
|
|
|
114024
111967
|
export interface UsersUsersUpdateInput {
|
|
114025
111968
|
/**
|
|
@@ -114069,126 +112012,37 @@ export interface UsersUsersUpdateInputPublicMetadata1 {
|
|
|
114069
112012
|
}
|
|
114070
112013
|
|
|
114071
112014
|
export interface UsersUsersUpdateOutput {
|
|
114072
|
-
/**
|
|
114073
|
-
* Id of this end user. Pass it to any users_users_* tool.
|
|
114074
|
-
*/
|
|
114075
112015
|
id: string
|
|
114076
|
-
/**
|
|
114077
|
-
* The user's display name. Null when nobody set one.
|
|
114078
|
-
*/
|
|
114079
112016
|
name: (string | null)
|
|
114080
|
-
/**
|
|
114081
|
-
* When the user was banned (ISO 8601). Null while they are not banned.
|
|
114082
|
-
*/
|
|
114083
112017
|
bannedAt: (string | null)
|
|
114084
|
-
/**
|
|
114085
|
-
* When this user's personal data was purged for good (ISO 8601). Null while it is intact.
|
|
114086
|
-
*/
|
|
114087
112018
|
erasedAt: (string | null)
|
|
114088
|
-
/**
|
|
114089
|
-
* URL of the user's avatar. Null when there is none.
|
|
114090
|
-
*/
|
|
114091
112019
|
imageUrl: (string | null)
|
|
114092
|
-
/**
|
|
114093
|
-
* Whether this is a test fixture — excluded from metering and from the default listing.
|
|
114094
|
-
*/
|
|
114095
112020
|
testUser: boolean
|
|
114096
|
-
/**
|
|
114097
|
-
* When the user was created (ISO 8601).
|
|
114098
|
-
*/
|
|
114099
112021
|
createdAt: string
|
|
114100
|
-
/**
|
|
114101
|
-
* When the user was soft-deleted (ISO 8601). Null while the account is live.
|
|
114102
|
-
*/
|
|
114103
112022
|
deletedAt: (string | null)
|
|
114104
|
-
/**
|
|
114105
|
-
* Product this user belongs to. Never an input — it comes from the calling identity.
|
|
114106
|
-
*/
|
|
114107
112023
|
productId: string
|
|
114108
|
-
/**
|
|
114109
|
-
* When the user was last changed (ISO 8601).
|
|
114110
|
-
*/
|
|
114111
112024
|
updatedAt: string
|
|
114112
|
-
/**
|
|
114113
|
-
* Whether this user is still on the waitlist and cannot sign in yet.
|
|
114114
|
-
*/
|
|
114115
112025
|
waitlisted: boolean
|
|
114116
|
-
/**
|
|
114117
|
-
* 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".
|
|
114118
|
-
*/
|
|
114119
112026
|
identifiers: {
|
|
114120
|
-
/**
|
|
114121
|
-
* Id of this identifier row.
|
|
114122
|
-
*/
|
|
114123
112027
|
id: string
|
|
114124
|
-
/**
|
|
114125
|
-
* What kind of identifier this is. Today always `email`.
|
|
114126
|
-
*/
|
|
114127
112028
|
type: "email"
|
|
114128
|
-
/**
|
|
114129
|
-
* The address as the user typed it, for display.
|
|
114130
|
-
*/
|
|
114131
112029
|
value: string
|
|
114132
|
-
/**
|
|
114133
|
-
* Whether this is the identifier the user signs in with and is contacted at.
|
|
114134
|
-
*/
|
|
114135
112030
|
isPrimary: boolean
|
|
114136
|
-
/**
|
|
114137
|
-
* When this address was verified (ISO 8601). Null while it never was.
|
|
114138
|
-
*/
|
|
114139
112031
|
verifiedAt: (string | null)
|
|
114140
|
-
/**
|
|
114141
|
-
* The address lowercased and NFC-normalised — what uniqueness is checked against.
|
|
114142
|
-
*/
|
|
114143
112032
|
valueCanonical: string
|
|
114144
|
-
/**
|
|
114145
|
-
* `unverified`, `verified`, or `expired` when a verification link ran out before it was used.
|
|
114146
|
-
*/
|
|
114147
112033
|
verificationStatus: ("unverified" | "verified" | "expired")
|
|
114148
112034
|
}[]
|
|
114149
|
-
/**
|
|
114150
|
-
* When a failed-attempt lockout expires (ISO 8601). Null when the user is not locked out.
|
|
114151
|
-
*/
|
|
114152
112035
|
lockedUntil: (string | null)
|
|
114153
|
-
/**
|
|
114154
|
-
* When the user last signed in (ISO 8601). Null if they never have.
|
|
114155
|
-
*/
|
|
114156
112036
|
lastSignInAt: (string | null)
|
|
114157
|
-
/**
|
|
114158
|
-
* The user's primary email address, as typed. Null when they have no primary identifier. Bind this rather than `identifiers.0.value`.
|
|
114159
|
-
*/
|
|
114160
|
-
primaryEmail: (string | null)
|
|
114161
|
-
/**
|
|
114162
|
-
* Whether the user must set a new password at their next sign-in.
|
|
114163
|
-
*/
|
|
114164
112037
|
requiresReset: boolean
|
|
114165
|
-
|
|
114166
|
-
|
|
114167
|
-
|
|
114168
|
-
|
|
114169
|
-
[k: string]: unknown
|
|
114170
|
-
}
|
|
114171
|
-
/**
|
|
114172
|
-
* Metadata the end user may write themselves. Treat it as untrusted.
|
|
114173
|
-
*/
|
|
114174
|
-
unsafeMetadata: {
|
|
114175
|
-
[k: string]: unknown
|
|
112038
|
+
publicMetadata: UsersUsersUpdateOutputPublicMetadata
|
|
112039
|
+
unsafeMetadata: UsersUsersUpdateOutputPublicMetadata
|
|
112040
|
+
privateMetadata: UsersUsersUpdateOutputPublicMetadata
|
|
112041
|
+
emailChangeLockedUntil: (string | null)
|
|
114176
112042
|
}
|
|
114177
|
-
|
|
114178
|
-
* Metadata for the management plane only. Never reaches the end user or a token.
|
|
114179
|
-
*/
|
|
114180
|
-
privateMetadata: {
|
|
112043
|
+
export interface UsersUsersUpdateOutputPublicMetadata {
|
|
114181
112044
|
[k: string]: unknown
|
|
114182
112045
|
}
|
|
114183
|
-
/**
|
|
114184
|
-
* Id of the primary identifier row. Null when there is no primary identifier.
|
|
114185
|
-
*/
|
|
114186
|
-
primaryIdentifierId: (string | null)
|
|
114187
|
-
/**
|
|
114188
|
-
* 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.
|
|
114189
|
-
*/
|
|
114190
|
-
emailChangeLockedUntil: (string | null)
|
|
114191
|
-
}
|
|
114192
112046
|
|
|
114193
112047
|
export interface UsersWaitlistFunnelInput {
|
|
114194
112048
|
|
|
@@ -114368,42 +112222,15 @@ unsafeMetadata?: {
|
|
|
114368
112222
|
}
|
|
114369
112223
|
|
|
114370
112224
|
export interface UsersWaitlistImportOutput {
|
|
114371
|
-
/**
|
|
114372
|
-
* How many could not be imported at all.
|
|
114373
|
-
*/
|
|
114374
112225
|
failed: number
|
|
114375
|
-
/**
|
|
114376
|
-
* One row per submitted row, in the order you sent them.
|
|
114377
|
-
*/
|
|
114378
112226
|
results: {
|
|
114379
|
-
/**
|
|
114380
|
-
* Zero-based index of the row in the array you sent.
|
|
114381
|
-
*/
|
|
114382
112227
|
row: number
|
|
114383
|
-
/**
|
|
114384
|
-
* Why it was skipped, or what went wrong. Null for an imported row.
|
|
114385
|
-
*/
|
|
114386
112228
|
reason: (string | null)
|
|
114387
|
-
/**
|
|
114388
|
-
* What happened to this row.
|
|
114389
|
-
*/
|
|
114390
112229
|
status: ("imported" | "skipped" | "failed")
|
|
114391
|
-
/**
|
|
114392
|
-
* The waitlisted user this row created. Null for skipped and failed rows.
|
|
114393
|
-
*/
|
|
114394
112230
|
userId: (string | null)
|
|
114395
112231
|
}[]
|
|
114396
|
-
/**
|
|
114397
|
-
* How many were already on the list or otherwise passed over.
|
|
114398
|
-
*/
|
|
114399
112232
|
skipped: number
|
|
114400
|
-
/**
|
|
114401
|
-
* How many became waitlist entries.
|
|
114402
|
-
*/
|
|
114403
112233
|
imported: number
|
|
114404
|
-
/**
|
|
114405
|
-
* How many rows you submitted.
|
|
114406
|
-
*/
|
|
114407
112234
|
requested: number
|
|
114408
112235
|
}
|
|
114409
112236
|
|
|
@@ -114418,30 +112245,12 @@ userIds: [string, ...(string)[]]
|
|
|
114418
112245
|
}
|
|
114419
112246
|
|
|
114420
112247
|
export interface UsersWaitlistInviteOutput {
|
|
114421
|
-
/**
|
|
114422
|
-
* How many of the requested users were invited.
|
|
114423
|
-
*/
|
|
114424
112248
|
invited: number
|
|
114425
|
-
/**
|
|
114426
|
-
* One row per user you asked for, in the order you sent them.
|
|
114427
|
-
*/
|
|
114428
112249
|
results: {
|
|
114429
|
-
/**
|
|
114430
|
-
* Why this user was skipped. Null for an invited row.
|
|
114431
|
-
*/
|
|
114432
112250
|
reason: (("suppressed" | "not_found" | "already_registered") | null)
|
|
114433
|
-
/**
|
|
114434
|
-
* Whether this user was invited or passed over.
|
|
114435
|
-
*/
|
|
114436
112251
|
status: ("invited" | "skipped")
|
|
114437
|
-
/**
|
|
114438
|
-
* The user this row is about.
|
|
114439
|
-
*/
|
|
114440
112252
|
userId: string
|
|
114441
112253
|
}[]
|
|
114442
|
-
/**
|
|
114443
|
-
* How many were passed over — see each row's `reason`.
|
|
114444
|
-
*/
|
|
114445
112254
|
skipped: number
|
|
114446
112255
|
}
|
|
114447
112256
|
|
|
@@ -114465,62 +112274,23 @@ confirmed?: boolean
|
|
|
114465
112274
|
}
|
|
114466
112275
|
|
|
114467
112276
|
export interface UsersWaitlistListOutput {
|
|
114468
|
-
/**
|
|
114469
|
-
* The page of waitlist entries, newest first.
|
|
114470
|
-
*/
|
|
114471
112277
|
entries: {
|
|
114472
|
-
/**
|
|
114473
|
-
* Where in the funnel this entry is: `pending`, `invited`, `registered` or `withdrawn`.
|
|
114474
|
-
*/
|
|
114475
112278
|
status: ("pending" | "invited" | "registered" | "withdrawn")
|
|
114476
|
-
/**
|
|
114477
|
-
* The waitlisted user. Every users_users_* tool takes this id.
|
|
114478
|
-
*/
|
|
114479
112279
|
userId: string
|
|
114480
|
-
/**
|
|
114481
|
-
* When the entry joined the waitlist (ISO 8601).
|
|
114482
|
-
*/
|
|
114483
112280
|
createdAt: string
|
|
114484
|
-
/**
|
|
114485
|
-
* When the invite was sent (ISO 8601). Null while the entry is pending.
|
|
114486
|
-
*/
|
|
114487
112281
|
invitedAt: (string | null)
|
|
114488
|
-
/**
|
|
114489
|
-
* The email address that signed up.
|
|
114490
|
-
*/
|
|
114491
112282
|
identifier: string
|
|
114492
|
-
/**
|
|
114493
|
-
* Where the signup came from — the campaign, referrer and landing page recorded at the time.
|
|
114494
|
-
*/
|
|
114495
112283
|
attribution: {
|
|
114496
112284
|
[k: string]: unknown
|
|
114497
112285
|
}
|
|
114498
|
-
/**
|
|
114499
|
-
* When the address confirmed a double opt-in (ISO 8601). Null when it never did.
|
|
114500
|
-
*/
|
|
114501
112286
|
confirmedAt: (string | null)
|
|
114502
|
-
/**
|
|
114503
|
-
* When the address asked to be taken off the list (ISO 8601). Null when it did not.
|
|
114504
|
-
*/
|
|
114505
112287
|
withdrawnAt: (string | null)
|
|
114506
|
-
/**
|
|
114507
|
-
* What was recorded to show this address consented: when, from where, and under which wording.
|
|
114508
|
-
*/
|
|
114509
112288
|
consentProof: {
|
|
114510
112289
|
[k: string]: unknown
|
|
114511
112290
|
}
|
|
114512
|
-
/**
|
|
114513
|
-
* When the invitee finished signing up (ISO 8601). Null until they do.
|
|
114514
|
-
*/
|
|
114515
112291
|
registeredAt: (string | null)
|
|
114516
|
-
/**
|
|
114517
|
-
* Id of the live invite token. Null while the entry has not been invited.
|
|
114518
|
-
*/
|
|
114519
112292
|
inviteTokenId: (string | null)
|
|
114520
112293
|
}[]
|
|
114521
|
-
/**
|
|
114522
|
-
* Pass back as `cursor` to fetch the next page. Null when this page is the last.
|
|
114523
|
-
*/
|
|
114524
112294
|
nextCursor: (string | null)
|
|
114525
112295
|
}
|
|
114526
112296
|
|