@lepsto/sdk-app 89.7.2 → 90.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/CHANGELOG.md +6 -6
- package/dist/_types/gen/types.gen.d.ts +196 -16
- package/dist/{chunk-OSI6GWYM.js → chunk-T3O56NBF.js} +46 -2
- package/dist/{chunk-OSI6GWYM.js.map → chunk-T3O56NBF.js.map} +1 -1
- package/dist/index.cjs +44 -0
- package/dist/index.cjs.map +1 -1
- package/dist/index.js +1 -1
- package/dist/playground/index.cjs.map +1 -1
- package/dist/playground/index.js +1 -1
- package/package.json +2 -2
- package/src/gen/bindings.gen.ts +44 -0
- package/src/gen/types.gen.ts +196 -16
package/dist/playground/index.js
CHANGED
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@lepsto/sdk-app",
|
|
3
3
|
"description": "The Lepsto SDK for App is a TypeScript SDK that provides runtime bindings and type-safe generated code for interacting with Lepsto Platform APIs and services. This package generates type definitions and client bindings from API catalogs, enabling developers to build applications that consume Lepsto platform services with full type safety and autocompletion.",
|
|
4
|
-
"version": "
|
|
4
|
+
"version": "90.0.0",
|
|
5
5
|
"repository": {
|
|
6
6
|
"type": "git",
|
|
7
7
|
"url": "git+https://github.com/lepsto/lepsto-sdk-app.git"
|
|
@@ -220,5 +220,5 @@
|
|
|
220
220
|
}
|
|
221
221
|
}
|
|
222
222
|
},
|
|
223
|
-
"sdkContentHash": "sha256:
|
|
223
|
+
"sdkContentHash": "sha256:681e6a1f4cc516c2a553ab21aa745074f4cfaf3c62617d9739ab6ac2ba0c5a96"
|
|
224
224
|
}
|
package/src/gen/bindings.gen.ts
CHANGED
|
@@ -10349,6 +10349,18 @@ export const bindings: BindingsMap = {
|
|
|
10349
10349
|
"in": "body",
|
|
10350
10350
|
"name": "testUser"
|
|
10351
10351
|
},
|
|
10352
|
+
{
|
|
10353
|
+
"in": "body",
|
|
10354
|
+
"name": "kind"
|
|
10355
|
+
},
|
|
10356
|
+
{
|
|
10357
|
+
"in": "body",
|
|
10358
|
+
"name": "stage"
|
|
10359
|
+
},
|
|
10360
|
+
{
|
|
10361
|
+
"in": "body",
|
|
10362
|
+
"name": "tags"
|
|
10363
|
+
},
|
|
10352
10364
|
{
|
|
10353
10365
|
"in": "body",
|
|
10354
10366
|
"name": "requiresReset"
|
|
@@ -10399,6 +10411,14 @@ export const bindings: BindingsMap = {
|
|
|
10399
10411
|
"in": "query",
|
|
10400
10412
|
"name": "includeDeleted"
|
|
10401
10413
|
},
|
|
10414
|
+
{
|
|
10415
|
+
"in": "query",
|
|
10416
|
+
"name": "kind"
|
|
10417
|
+
},
|
|
10418
|
+
{
|
|
10419
|
+
"in": "query",
|
|
10420
|
+
"name": "includeContacts"
|
|
10421
|
+
},
|
|
10402
10422
|
{
|
|
10403
10423
|
"in": "query",
|
|
10404
10424
|
"name": "limit"
|
|
@@ -10487,6 +10507,22 @@ export const bindings: BindingsMap = {
|
|
|
10487
10507
|
"in": "query",
|
|
10488
10508
|
"name": "includeTestUsers"
|
|
10489
10509
|
},
|
|
10510
|
+
{
|
|
10511
|
+
"in": "query",
|
|
10512
|
+
"name": "kind"
|
|
10513
|
+
},
|
|
10514
|
+
{
|
|
10515
|
+
"in": "query",
|
|
10516
|
+
"name": "stage"
|
|
10517
|
+
},
|
|
10518
|
+
{
|
|
10519
|
+
"in": "query",
|
|
10520
|
+
"name": "tag"
|
|
10521
|
+
},
|
|
10522
|
+
{
|
|
10523
|
+
"in": "query",
|
|
10524
|
+
"name": "includeContacts"
|
|
10525
|
+
},
|
|
10490
10526
|
{
|
|
10491
10527
|
"in": "query",
|
|
10492
10528
|
"name": "limit"
|
|
@@ -10552,6 +10588,14 @@ export const bindings: BindingsMap = {
|
|
|
10552
10588
|
{
|
|
10553
10589
|
"in": "body",
|
|
10554
10590
|
"name": "unsafeMetadata"
|
|
10591
|
+
},
|
|
10592
|
+
{
|
|
10593
|
+
"in": "body",
|
|
10594
|
+
"name": "stage"
|
|
10595
|
+
},
|
|
10596
|
+
{
|
|
10597
|
+
"in": "body",
|
|
10598
|
+
"name": "tags"
|
|
10555
10599
|
}
|
|
10556
10600
|
],
|
|
10557
10601
|
"path": "/users/users/:userId",
|
package/src/gen/types.gen.ts
CHANGED
|
@@ -115799,9 +115799,9 @@ export interface UsersApikeysCreateInput {
|
|
|
115799
115799
|
*/
|
|
115800
115800
|
name: string
|
|
115801
115801
|
/**
|
|
115802
|
-
* '
|
|
115802
|
+
* 'publishable' mints a non-secret key (upk_…) that identifies this product in browser flows and stays readable. It is the only key type: the secret server key (usk_…) is retired.
|
|
115803
115803
|
*/
|
|
115804
|
-
type:
|
|
115804
|
+
type: "publishable"
|
|
115805
115805
|
}
|
|
115806
115806
|
|
|
115807
115807
|
export interface UsersApikeysCreateOutput {
|
|
@@ -115818,15 +115818,15 @@ key: string
|
|
|
115818
115818
|
*/
|
|
115819
115819
|
name: string
|
|
115820
115820
|
/**
|
|
115821
|
-
* `
|
|
115821
|
+
* `publishable` — a browser-safe key (upk_…). It is the only type.
|
|
115822
115822
|
*/
|
|
115823
|
-
type:
|
|
115823
|
+
type: "publishable"
|
|
115824
115824
|
/**
|
|
115825
|
-
* The full value of
|
|
115825
|
+
* The full value of the key, which is not a secret and stays readable.
|
|
115826
115826
|
*/
|
|
115827
115827
|
value: (string | null)
|
|
115828
115828
|
/**
|
|
115829
|
-
* `
|
|
115829
|
+
* `upk_` plus six characters — enough to recognise a key, never to use one.
|
|
115830
115830
|
*/
|
|
115831
115831
|
prefix: string
|
|
115832
115832
|
/**
|
|
@@ -115856,15 +115856,15 @@ id: string
|
|
|
115856
115856
|
*/
|
|
115857
115857
|
name: string
|
|
115858
115858
|
/**
|
|
115859
|
-
* `
|
|
115859
|
+
* `publishable` — a browser-safe key (upk_…). It is the only type.
|
|
115860
115860
|
*/
|
|
115861
|
-
type:
|
|
115861
|
+
type: "publishable"
|
|
115862
115862
|
/**
|
|
115863
|
-
* The full value of
|
|
115863
|
+
* The full value of the key, which is not a secret and stays readable.
|
|
115864
115864
|
*/
|
|
115865
115865
|
value: (string | null)
|
|
115866
115866
|
/**
|
|
115867
|
-
* `
|
|
115867
|
+
* `upk_` plus six characters — enough to recognise a key, never to use one.
|
|
115868
115868
|
*/
|
|
115869
115869
|
prefix: string
|
|
115870
115870
|
/**
|
|
@@ -115892,15 +115892,15 @@ id: string
|
|
|
115892
115892
|
*/
|
|
115893
115893
|
name: string
|
|
115894
115894
|
/**
|
|
115895
|
-
* `
|
|
115895
|
+
* `publishable` — a browser-safe key (upk_…). It is the only type.
|
|
115896
115896
|
*/
|
|
115897
|
-
type:
|
|
115897
|
+
type: "publishable"
|
|
115898
115898
|
/**
|
|
115899
|
-
* The full value of
|
|
115899
|
+
* The full value of the key, which is not a secret and stays readable.
|
|
115900
115900
|
*/
|
|
115901
115901
|
value: (string | null)
|
|
115902
115902
|
/**
|
|
115903
|
-
* `
|
|
115903
|
+
* `upk_` plus six characters — enough to recognise a key, never to use one.
|
|
115904
115904
|
*/
|
|
115905
115905
|
prefix: string
|
|
115906
115906
|
/**
|
|
@@ -117678,7 +117678,7 @@ refreshReuseDetected: number
|
|
|
117678
117678
|
*/
|
|
117679
117679
|
since: string
|
|
117680
117680
|
/**
|
|
117681
|
-
* Point-in-time directory populations by DERIVED status — `user` has no status column, these are computed from `waitlisted` and the ban/delete/erase timestamps.
|
|
117681
|
+
* Point-in-time directory populations by DERIVED status — `user` has no status column, these are computed from `kind`, `waitlisted` and the ban/delete/erase timestamps.
|
|
117682
117682
|
*/
|
|
117683
117683
|
users: {
|
|
117684
117684
|
/**
|
|
@@ -117686,7 +117686,7 @@ users: {
|
|
|
117686
117686
|
*/
|
|
117687
117687
|
total: number
|
|
117688
117688
|
/**
|
|
117689
|
-
* Full accounts: not waitlisted, not banned, not deleted, not erased.
|
|
117689
|
+
* Full accounts: kind 'account', not waitlisted, not banned, not deleted, not erased.
|
|
117690
117690
|
*/
|
|
117691
117691
|
active: number
|
|
117692
117692
|
/**
|
|
@@ -117701,6 +117701,10 @@ erased: number
|
|
|
117701
117701
|
* SOFT-deleted and still recoverable — not erased.
|
|
117702
117702
|
*/
|
|
117703
117703
|
deleted: number
|
|
117704
|
+
/**
|
|
117705
|
+
* People the Product knows who have no credential and have never signed in (kind 'contact'), excluding deleted and erased ones. Never part of `active`, and never billed as retained users.
|
|
117706
|
+
*/
|
|
117707
|
+
contacts: number
|
|
117704
117708
|
/**
|
|
117705
117709
|
* Waitlist signups with no credential yet.
|
|
117706
117710
|
*/
|
|
@@ -117767,10 +117771,22 @@ export interface UsersUsersBanOutput {
|
|
|
117767
117771
|
* Id of this end user. Pass it to any users_users_* tool.
|
|
117768
117772
|
*/
|
|
117769
117773
|
id: string
|
|
117774
|
+
/**
|
|
117775
|
+
* What kind of person this row is: 'account' (can sign in) or 'contact' (known to the Product, no credential, never signed in). A contact is hidden from the default users_users_list view and is never counted as a retained user.
|
|
117776
|
+
*/
|
|
117777
|
+
kind: ("account" | "contact")
|
|
117770
117778
|
/**
|
|
117771
117779
|
* The user's display name. Null when nobody set one.
|
|
117772
117780
|
*/
|
|
117773
117781
|
name: (string | null)
|
|
117782
|
+
/**
|
|
117783
|
+
* Free labels on this person, stored trimmed, lowercased and de-duplicated.
|
|
117784
|
+
*/
|
|
117785
|
+
tags: string[]
|
|
117786
|
+
/**
|
|
117787
|
+
* The relationship stage, in funnel order: new, contacted, replied, engaged, converted, lost. A real change publishes `users/user.stage-changed`.
|
|
117788
|
+
*/
|
|
117789
|
+
stage: ("new" | "contacted" | "replied" | "engaged" | "converted" | "lost")
|
|
117774
117790
|
/**
|
|
117775
117791
|
* When the user was banned (ISO 8601). Null while they are not banned.
|
|
117776
117792
|
*/
|
|
@@ -117874,6 +117890,10 @@ unsafeMetadata: {
|
|
|
117874
117890
|
privateMetadata: {
|
|
117875
117891
|
[k: string]: unknown
|
|
117876
117892
|
}
|
|
117893
|
+
/**
|
|
117894
|
+
* The user this person was merged INTO, when they were merged. Null for everybody else — follow it to find where their records went.
|
|
117895
|
+
*/
|
|
117896
|
+
mergedIntoUserId: (string | null)
|
|
117877
117897
|
/**
|
|
117878
117898
|
* Id of the primary identifier row. Null when there is no primary identifier.
|
|
117879
117899
|
*/
|
|
@@ -117885,10 +117905,22 @@ emailChangeLockedUntil: (string | null)
|
|
|
117885
117905
|
}
|
|
117886
117906
|
|
|
117887
117907
|
export interface UsersUsersCreateInput {
|
|
117908
|
+
/**
|
|
117909
|
+
* What kind of person to create. 'account' (the default) can sign in. 'contact' is somebody the Product knows who has NO credential — a contact may not carry `password`, `waitlisted` or `requiresReset` (`contact_cannot_hold_credentials`), is hidden from the default users_users_list view, and is never counted as a retained user. A contact becomes an account only by proving an address, never by an operator setting this.
|
|
117910
|
+
*/
|
|
117911
|
+
kind?: ("account" | "contact")
|
|
117888
117912
|
/**
|
|
117889
117913
|
* The user's display name.
|
|
117890
117914
|
*/
|
|
117891
117915
|
name?: string
|
|
117916
|
+
/**
|
|
117917
|
+
* Free labels for this person. Trimmed, lowercased and de-duplicated on write; at most 32 of at most 64 characters each.
|
|
117918
|
+
*/
|
|
117919
|
+
tags?: string[]
|
|
117920
|
+
/**
|
|
117921
|
+
* The relationship stage to start them at, in funnel order: new, contacted, replied, engaged, converted, lost. Default 'new'.
|
|
117922
|
+
*/
|
|
117923
|
+
stage?: ("new" | "contacted" | "replied" | "engaged" | "converted" | "lost")
|
|
117892
117924
|
/**
|
|
117893
117925
|
* URL of the user's avatar image.
|
|
117894
117926
|
*/
|
|
@@ -117989,10 +118021,22 @@ export interface UsersUsersCreateOutput {
|
|
|
117989
118021
|
* Id of this end user. Pass it to any users_users_* tool.
|
|
117990
118022
|
*/
|
|
117991
118023
|
id: string
|
|
118024
|
+
/**
|
|
118025
|
+
* What kind of person this row is: 'account' (can sign in) or 'contact' (known to the Product, no credential, never signed in). A contact is hidden from the default users_users_list view and is never counted as a retained user.
|
|
118026
|
+
*/
|
|
118027
|
+
kind: ("account" | "contact")
|
|
117992
118028
|
/**
|
|
117993
118029
|
* The user's display name. Null when nobody set one.
|
|
117994
118030
|
*/
|
|
117995
118031
|
name: (string | null)
|
|
118032
|
+
/**
|
|
118033
|
+
* Free labels on this person, stored trimmed, lowercased and de-duplicated.
|
|
118034
|
+
*/
|
|
118035
|
+
tags: string[]
|
|
118036
|
+
/**
|
|
118037
|
+
* The relationship stage, in funnel order: new, contacted, replied, engaged, converted, lost. A real change publishes `users/user.stage-changed`.
|
|
118038
|
+
*/
|
|
118039
|
+
stage: ("new" | "contacted" | "replied" | "engaged" | "converted" | "lost")
|
|
117996
118040
|
/**
|
|
117997
118041
|
* When the user was banned (ISO 8601). Null while they are not banned.
|
|
117998
118042
|
*/
|
|
@@ -118096,6 +118140,10 @@ unsafeMetadata: {
|
|
|
118096
118140
|
privateMetadata: {
|
|
118097
118141
|
[k: string]: unknown
|
|
118098
118142
|
}
|
|
118143
|
+
/**
|
|
118144
|
+
* The user this person was merged INTO, when they were merged. Null for everybody else — follow it to find where their records went.
|
|
118145
|
+
*/
|
|
118146
|
+
mergedIntoUserId: (string | null)
|
|
118099
118147
|
/**
|
|
118100
118148
|
* Id of the primary identifier row. Null when there is no primary identifier.
|
|
118101
118149
|
*/
|
|
@@ -118118,10 +118166,22 @@ export interface UsersUsersDeleteOutput {
|
|
|
118118
118166
|
* Id of this end user. Pass it to any users_users_* tool.
|
|
118119
118167
|
*/
|
|
118120
118168
|
id: string
|
|
118169
|
+
/**
|
|
118170
|
+
* What kind of person this row is: 'account' (can sign in) or 'contact' (known to the Product, no credential, never signed in). A contact is hidden from the default users_users_list view and is never counted as a retained user.
|
|
118171
|
+
*/
|
|
118172
|
+
kind: ("account" | "contact")
|
|
118121
118173
|
/**
|
|
118122
118174
|
* The user's display name. Null when nobody set one.
|
|
118123
118175
|
*/
|
|
118124
118176
|
name: (string | null)
|
|
118177
|
+
/**
|
|
118178
|
+
* Free labels on this person, stored trimmed, lowercased and de-duplicated.
|
|
118179
|
+
*/
|
|
118180
|
+
tags: string[]
|
|
118181
|
+
/**
|
|
118182
|
+
* The relationship stage, in funnel order: new, contacted, replied, engaged, converted, lost. A real change publishes `users/user.stage-changed`.
|
|
118183
|
+
*/
|
|
118184
|
+
stage: ("new" | "contacted" | "replied" | "engaged" | "converted" | "lost")
|
|
118125
118185
|
/**
|
|
118126
118186
|
* When the user was banned (ISO 8601). Null while they are not banned.
|
|
118127
118187
|
*/
|
|
@@ -118225,6 +118285,10 @@ unsafeMetadata: {
|
|
|
118225
118285
|
privateMetadata: {
|
|
118226
118286
|
[k: string]: unknown
|
|
118227
118287
|
}
|
|
118288
|
+
/**
|
|
118289
|
+
* The user this person was merged INTO, when they were merged. Null for everybody else — follow it to find where their records went.
|
|
118290
|
+
*/
|
|
118291
|
+
mergedIntoUserId: (string | null)
|
|
118228
118292
|
/**
|
|
118229
118293
|
* Id of the primary identifier row. Null when there is no primary identifier.
|
|
118230
118294
|
*/
|
|
@@ -118236,6 +118300,10 @@ emailChangeLockedUntil: (string | null)
|
|
|
118236
118300
|
}
|
|
118237
118301
|
|
|
118238
118302
|
export interface UsersUsersExportInput {
|
|
118303
|
+
/**
|
|
118304
|
+
* Filter by kind: 'account' or 'contact'. Omit for accounts only, unless `includeContacts` is true.
|
|
118305
|
+
*/
|
|
118306
|
+
kind?: ("account" | "contact")
|
|
118239
118307
|
/**
|
|
118240
118308
|
* Rows per page, 1-500. Default 100.
|
|
118241
118309
|
*/
|
|
@@ -118256,6 +118324,10 @@ status?: ("active" | "banned" | "waitlisted")
|
|
|
118256
118324
|
* Include soft-deleted users. Default false.
|
|
118257
118325
|
*/
|
|
118258
118326
|
includeDeleted?: boolean
|
|
118327
|
+
/**
|
|
118328
|
+
* Include CONTACTS alongside accounts, so one pass exports both. Default false — the same rule this export already applies to waitlist signups and test users.
|
|
118329
|
+
*/
|
|
118330
|
+
includeContacts?: boolean
|
|
118259
118331
|
}
|
|
118260
118332
|
|
|
118261
118333
|
export interface UsersUsersExportOutput {
|
|
@@ -118265,10 +118337,22 @@ users: {
|
|
|
118265
118337
|
* Id of this end user. Pass it to any users_users_* tool.
|
|
118266
118338
|
*/
|
|
118267
118339
|
id: string
|
|
118340
|
+
/**
|
|
118341
|
+
* What kind of person this row is: 'account' (can sign in) or 'contact' (known to the Product, no credential, never signed in). A contact is hidden from the default users_users_list view and is never counted as a retained user.
|
|
118342
|
+
*/
|
|
118343
|
+
kind: ("account" | "contact")
|
|
118268
118344
|
/**
|
|
118269
118345
|
* The user's display name. Null when nobody set one.
|
|
118270
118346
|
*/
|
|
118271
118347
|
name: (string | null)
|
|
118348
|
+
/**
|
|
118349
|
+
* Free labels on this person, stored trimmed, lowercased and de-duplicated.
|
|
118350
|
+
*/
|
|
118351
|
+
tags: string[]
|
|
118352
|
+
/**
|
|
118353
|
+
* The relationship stage, in funnel order: new, contacted, replied, engaged, converted, lost. A real change publishes `users/user.stage-changed`.
|
|
118354
|
+
*/
|
|
118355
|
+
stage: ("new" | "contacted" | "replied" | "engaged" | "converted" | "lost")
|
|
118272
118356
|
/**
|
|
118273
118357
|
* When the user was banned (ISO 8601). Null while they are not banned.
|
|
118274
118358
|
*/
|
|
@@ -118372,6 +118456,10 @@ unsafeMetadata: {
|
|
|
118372
118456
|
privateMetadata: {
|
|
118373
118457
|
[k: string]: unknown
|
|
118374
118458
|
}
|
|
118459
|
+
/**
|
|
118460
|
+
* The user this person was merged INTO, when they were merged. Null for everybody else — follow it to find where their records went.
|
|
118461
|
+
*/
|
|
118462
|
+
mergedIntoUserId: (string | null)
|
|
118375
118463
|
/**
|
|
118376
118464
|
* Id of the primary identifier row. Null when there is no primary identifier.
|
|
118377
118465
|
*/
|
|
@@ -118397,10 +118485,22 @@ export interface UsersUsersGetOutput {
|
|
|
118397
118485
|
* Id of this end user. Pass it to any users_users_* tool.
|
|
118398
118486
|
*/
|
|
118399
118487
|
id: string
|
|
118488
|
+
/**
|
|
118489
|
+
* What kind of person this row is: 'account' (can sign in) or 'contact' (known to the Product, no credential, never signed in). A contact is hidden from the default users_users_list view and is never counted as a retained user.
|
|
118490
|
+
*/
|
|
118491
|
+
kind: ("account" | "contact")
|
|
118400
118492
|
/**
|
|
118401
118493
|
* The user's display name. Null when nobody set one.
|
|
118402
118494
|
*/
|
|
118403
118495
|
name: (string | null)
|
|
118496
|
+
/**
|
|
118497
|
+
* Free labels on this person, stored trimmed, lowercased and de-duplicated.
|
|
118498
|
+
*/
|
|
118499
|
+
tags: string[]
|
|
118500
|
+
/**
|
|
118501
|
+
* The relationship stage, in funnel order: new, contacted, replied, engaged, converted, lost. A real change publishes `users/user.stage-changed`.
|
|
118502
|
+
*/
|
|
118503
|
+
stage: ("new" | "contacted" | "replied" | "engaged" | "converted" | "lost")
|
|
118404
118504
|
/**
|
|
118405
118505
|
* When the user was banned (ISO 8601). Null while they are not banned.
|
|
118406
118506
|
*/
|
|
@@ -118504,6 +118604,10 @@ unsafeMetadata: {
|
|
|
118504
118604
|
privateMetadata: {
|
|
118505
118605
|
[k: string]: unknown
|
|
118506
118606
|
}
|
|
118607
|
+
/**
|
|
118608
|
+
* The user this person was merged INTO, when they were merged. Null for everybody else — follow it to find where their records went.
|
|
118609
|
+
*/
|
|
118610
|
+
mergedIntoUserId: (string | null)
|
|
118507
118611
|
/**
|
|
118508
118612
|
* Id of the primary identifier row. Null when there is no primary identifier.
|
|
118509
118613
|
*/
|
|
@@ -118558,6 +118662,10 @@ userId: (string | null)
|
|
|
118558
118662
|
* How many rows were passed over — an address already in the directory, typically.
|
|
118559
118663
|
*/
|
|
118560
118664
|
skipped: number
|
|
118665
|
+
/**
|
|
118666
|
+
* How many of the CREATED users were contacts (`kind: 'contact'`). A row that was skipped or failed is not counted.
|
|
118667
|
+
*/
|
|
118668
|
+
contacts: number
|
|
118561
118669
|
/**
|
|
118562
118670
|
* How many rows you submitted.
|
|
118563
118671
|
*/
|
|
@@ -118607,6 +118715,14 @@ expiresAt: string
|
|
|
118607
118715
|
}
|
|
118608
118716
|
|
|
118609
118717
|
export interface UsersUsersListInput {
|
|
118718
|
+
/**
|
|
118719
|
+
* Return only people carrying this tag. ONE tag, matched against the stored (lowercased) value and ANDed with the other filters.
|
|
118720
|
+
*/
|
|
118721
|
+
tag?: string
|
|
118722
|
+
/**
|
|
118723
|
+
* Filter by kind: 'account' or 'contact'. Passing 'contact' is how you list contacts — they are hidden otherwise. Omit for accounts only, unless `includeContacts` is true.
|
|
118724
|
+
*/
|
|
118725
|
+
kind?: ("account" | "contact")
|
|
118610
118726
|
/**
|
|
118611
118727
|
* Page size, 1-100. Default 25.
|
|
118612
118728
|
*/
|
|
@@ -118615,6 +118731,10 @@ limit?: number
|
|
|
118615
118731
|
* Case-insensitive substring match against the user's identifiers (email) and name.
|
|
118616
118732
|
*/
|
|
118617
118733
|
query?: string
|
|
118734
|
+
/**
|
|
118735
|
+
* Filter by relationship stage: new, contacted, replied, engaged, converted or lost. Omit for every stage.
|
|
118736
|
+
*/
|
|
118737
|
+
stage?: ("new" | "contacted" | "replied" | "engaged" | "converted" | "lost")
|
|
118618
118738
|
/**
|
|
118619
118739
|
* Opaque cursor from a previous response's `nextCursor`. Omit for the first page.
|
|
118620
118740
|
*/
|
|
@@ -118627,6 +118747,10 @@ status?: ("active" | "banned" | "waitlisted")
|
|
|
118627
118747
|
* Include soft-deleted users. Default false — deleted users are hidden.
|
|
118628
118748
|
*/
|
|
118629
118749
|
includeDeleted?: boolean
|
|
118750
|
+
/**
|
|
118751
|
+
* Include CONTACTS. Default false: a contact has no credential and has never signed in, so it is not part of the directory an operator browses — the same rule waitlist signups and test users follow. Use `kind: "contact"` to see only them.
|
|
118752
|
+
*/
|
|
118753
|
+
includeContacts?: boolean
|
|
118630
118754
|
/**
|
|
118631
118755
|
* Include TEST USERS. Default false: a test user is a fixture, not a customer — it is excluded from metering and from this listing for the same reason. Ask for it explicitly when you are debugging the fixtures themselves.
|
|
118632
118756
|
*/
|
|
@@ -118646,10 +118770,22 @@ users: {
|
|
|
118646
118770
|
* Id of this end user. Pass it to any users_users_* tool.
|
|
118647
118771
|
*/
|
|
118648
118772
|
id: string
|
|
118773
|
+
/**
|
|
118774
|
+
* What kind of person this row is: 'account' (can sign in) or 'contact' (known to the Product, no credential, never signed in). A contact is hidden from the default users_users_list view and is never counted as a retained user.
|
|
118775
|
+
*/
|
|
118776
|
+
kind: ("account" | "contact")
|
|
118649
118777
|
/**
|
|
118650
118778
|
* The user's display name. Null when nobody set one.
|
|
118651
118779
|
*/
|
|
118652
118780
|
name: (string | null)
|
|
118781
|
+
/**
|
|
118782
|
+
* Free labels on this person, stored trimmed, lowercased and de-duplicated.
|
|
118783
|
+
*/
|
|
118784
|
+
tags: string[]
|
|
118785
|
+
/**
|
|
118786
|
+
* The relationship stage, in funnel order: new, contacted, replied, engaged, converted, lost. A real change publishes `users/user.stage-changed`.
|
|
118787
|
+
*/
|
|
118788
|
+
stage: ("new" | "contacted" | "replied" | "engaged" | "converted" | "lost")
|
|
118653
118789
|
/**
|
|
118654
118790
|
* When the user was banned (ISO 8601). Null while they are not banned.
|
|
118655
118791
|
*/
|
|
@@ -118753,6 +118889,10 @@ unsafeMetadata: {
|
|
|
118753
118889
|
privateMetadata: {
|
|
118754
118890
|
[k: string]: unknown
|
|
118755
118891
|
}
|
|
118892
|
+
/**
|
|
118893
|
+
* The user this person was merged INTO, when they were merged. Null for everybody else — follow it to find where their records went.
|
|
118894
|
+
*/
|
|
118895
|
+
mergedIntoUserId: (string | null)
|
|
118756
118896
|
/**
|
|
118757
118897
|
* Id of the primary identifier row. Null when there is no primary identifier.
|
|
118758
118898
|
*/
|
|
@@ -118806,10 +118946,22 @@ export interface UsersUsersUnbanOutput {
|
|
|
118806
118946
|
* Id of this end user. Pass it to any users_users_* tool.
|
|
118807
118947
|
*/
|
|
118808
118948
|
id: string
|
|
118949
|
+
/**
|
|
118950
|
+
* What kind of person this row is: 'account' (can sign in) or 'contact' (known to the Product, no credential, never signed in). A contact is hidden from the default users_users_list view and is never counted as a retained user.
|
|
118951
|
+
*/
|
|
118952
|
+
kind: ("account" | "contact")
|
|
118809
118953
|
/**
|
|
118810
118954
|
* The user's display name. Null when nobody set one.
|
|
118811
118955
|
*/
|
|
118812
118956
|
name: (string | null)
|
|
118957
|
+
/**
|
|
118958
|
+
* Free labels on this person, stored trimmed, lowercased and de-duplicated.
|
|
118959
|
+
*/
|
|
118960
|
+
tags: string[]
|
|
118961
|
+
/**
|
|
118962
|
+
* The relationship stage, in funnel order: new, contacted, replied, engaged, converted, lost. A real change publishes `users/user.stage-changed`.
|
|
118963
|
+
*/
|
|
118964
|
+
stage: ("new" | "contacted" | "replied" | "engaged" | "converted" | "lost")
|
|
118813
118965
|
/**
|
|
118814
118966
|
* When the user was banned (ISO 8601). Null while they are not banned.
|
|
118815
118967
|
*/
|
|
@@ -118913,6 +119065,10 @@ unsafeMetadata: {
|
|
|
118913
119065
|
privateMetadata: {
|
|
118914
119066
|
[k: string]: unknown
|
|
118915
119067
|
}
|
|
119068
|
+
/**
|
|
119069
|
+
* The user this person was merged INTO, when they were merged. Null for everybody else — follow it to find where their records went.
|
|
119070
|
+
*/
|
|
119071
|
+
mergedIntoUserId: (string | null)
|
|
118916
119072
|
/**
|
|
118917
119073
|
* Id of the primary identifier row. Null when there is no primary identifier.
|
|
118918
119074
|
*/
|
|
@@ -118928,6 +119084,14 @@ export interface UsersUsersUpdateInput {
|
|
|
118928
119084
|
* The user's display name. Pass null to clear.
|
|
118929
119085
|
*/
|
|
118930
119086
|
name?: (string | null)
|
|
119087
|
+
/**
|
|
119088
|
+
* REPLACES the whole tag list — send every tag you want stored, not just the new ones. Trimmed, lowercased and de-duplicated on write.
|
|
119089
|
+
*/
|
|
119090
|
+
tags?: string[]
|
|
119091
|
+
/**
|
|
119092
|
+
* Move the person to this relationship stage. A real change publishes `users/user.stage-changed`; a patch that changes ONLY the stage deliberately does not also publish `users/user.updated`, so a workflow that writes stages does not wake itself.
|
|
119093
|
+
*/
|
|
119094
|
+
stage?: ("new" | "contacted" | "replied" | "engaged" | "converted" | "lost")
|
|
118931
119095
|
/**
|
|
118932
119096
|
* The user to update.
|
|
118933
119097
|
*/
|
|
@@ -118975,10 +119139,22 @@ export interface UsersUsersUpdateOutput {
|
|
|
118975
119139
|
* Id of this end user. Pass it to any users_users_* tool.
|
|
118976
119140
|
*/
|
|
118977
119141
|
id: string
|
|
119142
|
+
/**
|
|
119143
|
+
* What kind of person this row is: 'account' (can sign in) or 'contact' (known to the Product, no credential, never signed in). A contact is hidden from the default users_users_list view and is never counted as a retained user.
|
|
119144
|
+
*/
|
|
119145
|
+
kind: ("account" | "contact")
|
|
118978
119146
|
/**
|
|
118979
119147
|
* The user's display name. Null when nobody set one.
|
|
118980
119148
|
*/
|
|
118981
119149
|
name: (string | null)
|
|
119150
|
+
/**
|
|
119151
|
+
* Free labels on this person, stored trimmed, lowercased and de-duplicated.
|
|
119152
|
+
*/
|
|
119153
|
+
tags: string[]
|
|
119154
|
+
/**
|
|
119155
|
+
* The relationship stage, in funnel order: new, contacted, replied, engaged, converted, lost. A real change publishes `users/user.stage-changed`.
|
|
119156
|
+
*/
|
|
119157
|
+
stage: ("new" | "contacted" | "replied" | "engaged" | "converted" | "lost")
|
|
118982
119158
|
/**
|
|
118983
119159
|
* When the user was banned (ISO 8601). Null while they are not banned.
|
|
118984
119160
|
*/
|
|
@@ -119082,6 +119258,10 @@ unsafeMetadata: {
|
|
|
119082
119258
|
privateMetadata: {
|
|
119083
119259
|
[k: string]: unknown
|
|
119084
119260
|
}
|
|
119261
|
+
/**
|
|
119262
|
+
* The user this person was merged INTO, when they were merged. Null for everybody else — follow it to find where their records went.
|
|
119263
|
+
*/
|
|
119264
|
+
mergedIntoUserId: (string | null)
|
|
119085
119265
|
/**
|
|
119086
119266
|
* Id of the primary identifier row. Null when there is no primary identifier.
|
|
119087
119267
|
*/
|