@lepsto/sdk-app 89.7.1 → 89.8.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 +54 -4
- package/dist/_types/gen/types.gen.d.ts +190 -10
- 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 +190 -10
package/CHANGELOG.md
CHANGED
|
@@ -115,8 +115,58 @@ before this point lives in that package.
|
|
|
115
115
|
The publish pipeline appends its machine-rendered block for the release being
|
|
116
116
|
built below this line. It is not committed back to the repo, so in a git
|
|
117
117
|
checkout this section is empty — see the note at the top.
|
|
118
|
-
## 89.
|
|
119
|
-
|
|
120
|
-
###
|
|
121
|
-
-
|
|
118
|
+
## 89.8.0 (minor)
|
|
119
|
+
|
|
120
|
+
### users
|
|
121
|
+
- `users_stats_get`: new optional field `users.contacts (output)`
|
|
122
|
+
- `users_stats_get`: description updated
|
|
123
|
+
- `users_users_ban`: new optional field `kind (output)`
|
|
124
|
+
- `users_users_ban`: new optional field `tags (output)`
|
|
125
|
+
- `users_users_ban`: new optional field `stage (output)`
|
|
126
|
+
- `users_users_ban`: new optional field `mergedIntoUserId (output)`
|
|
127
|
+
- `users_users_create`: new optional field `kind`
|
|
128
|
+
- `users_users_create`: new optional field `tags`
|
|
129
|
+
- `users_users_create`: new optional field `stage`
|
|
130
|
+
- `users_users_create`: new optional field `kind (output)`
|
|
131
|
+
- `users_users_create`: new optional field `tags (output)`
|
|
132
|
+
- `users_users_create`: new optional field `stage (output)`
|
|
133
|
+
- `users_users_create`: new optional field `mergedIntoUserId (output)`
|
|
134
|
+
- `users_users_create`: description updated
|
|
135
|
+
- `users_users_delete`: new optional field `kind (output)`
|
|
136
|
+
- `users_users_delete`: new optional field `tags (output)`
|
|
137
|
+
- `users_users_delete`: new optional field `stage (output)`
|
|
138
|
+
- `users_users_delete`: new optional field `mergedIntoUserId (output)`
|
|
139
|
+
- `users_users_export`: new optional field `kind`
|
|
140
|
+
- `users_users_export`: new optional field `includeContacts`
|
|
141
|
+
- `users_users_export`: new optional field `users.kind (output)`
|
|
142
|
+
- `users_users_export`: new optional field `users.tags (output)`
|
|
143
|
+
- `users_users_export`: new optional field `users.stage (output)`
|
|
144
|
+
- `users_users_export`: new optional field `users.mergedIntoUserId (output)`
|
|
145
|
+
- `users_users_export`: description updated
|
|
146
|
+
- `users_users_get`: new optional field `kind (output)`
|
|
147
|
+
- `users_users_get`: new optional field `tags (output)`
|
|
148
|
+
- `users_users_get`: new optional field `stage (output)`
|
|
149
|
+
- `users_users_get`: new optional field `mergedIntoUserId (output)`
|
|
150
|
+
- `users_users_import`: new optional field `contacts (output)`
|
|
151
|
+
- `users_users_import`: description updated
|
|
152
|
+
- `users_users_list`: new optional field `tag`
|
|
153
|
+
- `users_users_list`: new optional field `kind`
|
|
154
|
+
- `users_users_list`: new optional field `stage`
|
|
155
|
+
- `users_users_list`: new optional field `includeContacts`
|
|
156
|
+
- `users_users_list`: new optional field `users.kind (output)`
|
|
157
|
+
- `users_users_list`: new optional field `users.tags (output)`
|
|
158
|
+
- `users_users_list`: new optional field `users.stage (output)`
|
|
159
|
+
- `users_users_list`: new optional field `users.mergedIntoUserId (output)`
|
|
160
|
+
- `users_users_list`: description updated
|
|
161
|
+
- `users_users_unban`: new optional field `kind (output)`
|
|
162
|
+
- `users_users_unban`: new optional field `tags (output)`
|
|
163
|
+
- `users_users_unban`: new optional field `stage (output)`
|
|
164
|
+
- `users_users_unban`: new optional field `mergedIntoUserId (output)`
|
|
165
|
+
- `users_users_update`: new optional field `tags`
|
|
166
|
+
- `users_users_update`: new optional field `stage`
|
|
167
|
+
- `users_users_update`: new optional field `kind (output)`
|
|
168
|
+
- `users_users_update`: new optional field `tags (output)`
|
|
169
|
+
- `users_users_update`: new optional field `stage (output)`
|
|
170
|
+
- `users_users_update`: new optional field `mergedIntoUserId (output)`
|
|
171
|
+
- `users_users_update`: description updated
|
|
122
172
|
|
|
@@ -122689,7 +122689,7 @@ export interface UsersConfigGetOutput {
|
|
|
122689
122689
|
*/
|
|
122690
122690
|
codeEnabled: boolean;
|
|
122691
122691
|
/**
|
|
122692
|
-
* Base URL magic links point at, e.g. "https://public.
|
|
122692
|
+
* Base URL magic links point at, e.g. "https://public.lepsto.com/{productId}/users". Null uses the deployment default.
|
|
122693
122693
|
*/
|
|
122694
122694
|
linkBaseUrl: (string | null);
|
|
122695
122695
|
/**
|
|
@@ -122813,7 +122813,7 @@ export interface UsersConfigGetOutput {
|
|
|
122813
122813
|
*/
|
|
122814
122814
|
doubleOptIn: boolean;
|
|
122815
122815
|
/**
|
|
122816
|
-
* How long an UNCONVERTED waitlist entry — still pending, or invited and never registered — is kept, counted from SIGN-UP, before the sweep erases it. Default 180:
|
|
122816
|
+
* How long an UNCONVERTED waitlist entry — still pending, or invited and never registered — is kept, counted from SIGN-UP, before the sweep erases it. Default 180: Lepsto Privacy Policy §6 promises deletion 6 months from sign-up. The bound stays wide because a client Product answers to its own privacy policy, not ours.
|
|
122817
122817
|
*/
|
|
122818
122818
|
retentionDays: number;
|
|
122819
122819
|
/**
|
|
@@ -122983,7 +122983,7 @@ export interface UsersConfigUpsertInput {
|
|
|
122983
122983
|
*/
|
|
122984
122984
|
codeEnabled?: boolean;
|
|
122985
122985
|
/**
|
|
122986
|
-
* Base URL magic links point at, e.g. "https://public.
|
|
122986
|
+
* Base URL magic links point at, e.g. "https://public.lepsto.com/{productId}/users". Null uses the deployment default.
|
|
122987
122987
|
*/
|
|
122988
122988
|
linkBaseUrl?: (string | null);
|
|
122989
122989
|
/**
|
|
@@ -123153,7 +123153,7 @@ export interface UsersConfigUpsertInput {
|
|
|
123153
123153
|
*/
|
|
123154
123154
|
doubleOptIn?: boolean;
|
|
123155
123155
|
/**
|
|
123156
|
-
* How long an UNCONVERTED waitlist entry — still pending, or invited and never registered — is kept, counted from SIGN-UP, before the sweep erases it. Default 180:
|
|
123156
|
+
* How long an UNCONVERTED waitlist entry — still pending, or invited and never registered — is kept, counted from SIGN-UP, before the sweep erases it. Default 180: Lepsto Privacy Policy §6 promises deletion 6 months from sign-up. The bound stays wide because a client Product answers to its own privacy policy, not ours.
|
|
123157
123157
|
*/
|
|
123158
123158
|
retentionDays?: number;
|
|
123159
123159
|
/**
|
|
@@ -123365,7 +123365,7 @@ export interface UsersConfigUpsertOutput {
|
|
|
123365
123365
|
*/
|
|
123366
123366
|
codeEnabled: boolean;
|
|
123367
123367
|
/**
|
|
123368
|
-
* Base URL magic links point at, e.g. "https://public.
|
|
123368
|
+
* Base URL magic links point at, e.g. "https://public.lepsto.com/{productId}/users". Null uses the deployment default.
|
|
123369
123369
|
*/
|
|
123370
123370
|
linkBaseUrl: (string | null);
|
|
123371
123371
|
/**
|
|
@@ -123489,7 +123489,7 @@ export interface UsersConfigUpsertOutput {
|
|
|
123489
123489
|
*/
|
|
123490
123490
|
doubleOptIn: boolean;
|
|
123491
123491
|
/**
|
|
123492
|
-
* How long an UNCONVERTED waitlist entry — still pending, or invited and never registered — is kept, counted from SIGN-UP, before the sweep erases it. Default 180:
|
|
123492
|
+
* How long an UNCONVERTED waitlist entry — still pending, or invited and never registered — is kept, counted from SIGN-UP, before the sweep erases it. Default 180: Lepsto Privacy Policy §6 promises deletion 6 months from sign-up. The bound stays wide because a client Product answers to its own privacy policy, not ours.
|
|
123493
123493
|
*/
|
|
123494
123494
|
retentionDays: number;
|
|
123495
123495
|
/**
|
|
@@ -123819,11 +123819,11 @@ export interface UsersOpsRetentionGetOutput {
|
|
|
123819
123819
|
*/
|
|
123820
123820
|
waitlistRetentionDays: number;
|
|
123821
123821
|
/**
|
|
123822
|
-
* What
|
|
123822
|
+
* What Lepsto PUBLISHED, in its Privacy Policy §6: a waitlist address that never converted is deleted 6 months from sign-up. It rides along so the window above can be read against the promise it came from, rather than as a number with no provenance.
|
|
123823
123823
|
*/
|
|
123824
123824
|
waitlistPromisedMaxDays: number;
|
|
123825
123825
|
/**
|
|
123826
|
-
* True when this product configured a window WIDER than the published 180 days. Nothing refuses such a value and nothing clamps it — §6 is
|
|
123826
|
+
* True when this product configured a window WIDER than the published 180 days. Nothing refuses such a value and nothing clamps it — §6 is Lepsto’s own policy and a client Product answers to its own, under which a longer window may be perfectly lawful. This flag exists INSTEAD of that ceiling: a deliberate divergence from what Lepsto published must be diagnosable in one call rather than found by comparing two numbers nobody thought to compare.
|
|
123827
123827
|
*/
|
|
123828
123828
|
waitlistWiderThanPromised: boolean;
|
|
123829
123829
|
}
|
|
@@ -124265,7 +124265,7 @@ export interface UsersStatsGetOutput {
|
|
|
124265
124265
|
*/
|
|
124266
124266
|
since: string;
|
|
124267
124267
|
/**
|
|
124268
|
-
* Point-in-time directory populations by DERIVED status — `user` has no status column, these are computed from `waitlisted` and the ban/delete/erase timestamps.
|
|
124268
|
+
* 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.
|
|
124269
124269
|
*/
|
|
124270
124270
|
users: {
|
|
124271
124271
|
/**
|
|
@@ -124273,7 +124273,7 @@ export interface UsersStatsGetOutput {
|
|
|
124273
124273
|
*/
|
|
124274
124274
|
total: number;
|
|
124275
124275
|
/**
|
|
124276
|
-
* Full accounts: not waitlisted, not banned, not deleted, not erased.
|
|
124276
|
+
* Full accounts: kind 'account', not waitlisted, not banned, not deleted, not erased.
|
|
124277
124277
|
*/
|
|
124278
124278
|
active: number;
|
|
124279
124279
|
/**
|
|
@@ -124288,6 +124288,10 @@ export interface UsersStatsGetOutput {
|
|
|
124288
124288
|
* SOFT-deleted and still recoverable — not erased.
|
|
124289
124289
|
*/
|
|
124290
124290
|
deleted: number;
|
|
124291
|
+
/**
|
|
124292
|
+
* 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.
|
|
124293
|
+
*/
|
|
124294
|
+
contacts: number;
|
|
124291
124295
|
/**
|
|
124292
124296
|
* Waitlist signups with no credential yet.
|
|
124293
124297
|
*/
|
|
@@ -124352,10 +124356,22 @@ export interface UsersUsersBanOutput {
|
|
|
124352
124356
|
* Id of this end user. Pass it to any users_users_* tool.
|
|
124353
124357
|
*/
|
|
124354
124358
|
id: string;
|
|
124359
|
+
/**
|
|
124360
|
+
* 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.
|
|
124361
|
+
*/
|
|
124362
|
+
kind: ("account" | "contact");
|
|
124355
124363
|
/**
|
|
124356
124364
|
* The user's display name. Null when nobody set one.
|
|
124357
124365
|
*/
|
|
124358
124366
|
name: (string | null);
|
|
124367
|
+
/**
|
|
124368
|
+
* Free labels on this person, stored trimmed, lowercased and de-duplicated.
|
|
124369
|
+
*/
|
|
124370
|
+
tags: string[];
|
|
124371
|
+
/**
|
|
124372
|
+
* The relationship stage, in funnel order: new, contacted, replied, engaged, converted, lost. A real change publishes `users/user.stage-changed`.
|
|
124373
|
+
*/
|
|
124374
|
+
stage: ("new" | "contacted" | "replied" | "engaged" | "converted" | "lost");
|
|
124359
124375
|
/**
|
|
124360
124376
|
* When the user was banned (ISO 8601). Null while they are not banned.
|
|
124361
124377
|
*/
|
|
@@ -124459,6 +124475,10 @@ export interface UsersUsersBanOutput {
|
|
|
124459
124475
|
privateMetadata: {
|
|
124460
124476
|
[k: string]: unknown;
|
|
124461
124477
|
};
|
|
124478
|
+
/**
|
|
124479
|
+
* The user this person was merged INTO, when they were merged. Null for everybody else — follow it to find where their records went.
|
|
124480
|
+
*/
|
|
124481
|
+
mergedIntoUserId: (string | null);
|
|
124462
124482
|
/**
|
|
124463
124483
|
* Id of the primary identifier row. Null when there is no primary identifier.
|
|
124464
124484
|
*/
|
|
@@ -124469,10 +124489,22 @@ export interface UsersUsersBanOutput {
|
|
|
124469
124489
|
emailChangeLockedUntil: (string | null);
|
|
124470
124490
|
}
|
|
124471
124491
|
export interface UsersUsersCreateInput {
|
|
124492
|
+
/**
|
|
124493
|
+
* 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.
|
|
124494
|
+
*/
|
|
124495
|
+
kind?: ("account" | "contact");
|
|
124472
124496
|
/**
|
|
124473
124497
|
* The user's display name.
|
|
124474
124498
|
*/
|
|
124475
124499
|
name?: string;
|
|
124500
|
+
/**
|
|
124501
|
+
* Free labels for this person. Trimmed, lowercased and de-duplicated on write; at most 32 of at most 64 characters each.
|
|
124502
|
+
*/
|
|
124503
|
+
tags?: string[];
|
|
124504
|
+
/**
|
|
124505
|
+
* The relationship stage to start them at, in funnel order: new, contacted, replied, engaged, converted, lost. Default 'new'.
|
|
124506
|
+
*/
|
|
124507
|
+
stage?: ("new" | "contacted" | "replied" | "engaged" | "converted" | "lost");
|
|
124476
124508
|
/**
|
|
124477
124509
|
* URL of the user's avatar image.
|
|
124478
124510
|
*/
|
|
@@ -124575,10 +124607,22 @@ export interface UsersUsersCreateOutput {
|
|
|
124575
124607
|
* Id of this end user. Pass it to any users_users_* tool.
|
|
124576
124608
|
*/
|
|
124577
124609
|
id: string;
|
|
124610
|
+
/**
|
|
124611
|
+
* 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.
|
|
124612
|
+
*/
|
|
124613
|
+
kind: ("account" | "contact");
|
|
124578
124614
|
/**
|
|
124579
124615
|
* The user's display name. Null when nobody set one.
|
|
124580
124616
|
*/
|
|
124581
124617
|
name: (string | null);
|
|
124618
|
+
/**
|
|
124619
|
+
* Free labels on this person, stored trimmed, lowercased and de-duplicated.
|
|
124620
|
+
*/
|
|
124621
|
+
tags: string[];
|
|
124622
|
+
/**
|
|
124623
|
+
* The relationship stage, in funnel order: new, contacted, replied, engaged, converted, lost. A real change publishes `users/user.stage-changed`.
|
|
124624
|
+
*/
|
|
124625
|
+
stage: ("new" | "contacted" | "replied" | "engaged" | "converted" | "lost");
|
|
124582
124626
|
/**
|
|
124583
124627
|
* When the user was banned (ISO 8601). Null while they are not banned.
|
|
124584
124628
|
*/
|
|
@@ -124682,6 +124726,10 @@ export interface UsersUsersCreateOutput {
|
|
|
124682
124726
|
privateMetadata: {
|
|
124683
124727
|
[k: string]: unknown;
|
|
124684
124728
|
};
|
|
124729
|
+
/**
|
|
124730
|
+
* The user this person was merged INTO, when they were merged. Null for everybody else — follow it to find where their records went.
|
|
124731
|
+
*/
|
|
124732
|
+
mergedIntoUserId: (string | null);
|
|
124685
124733
|
/**
|
|
124686
124734
|
* Id of the primary identifier row. Null when there is no primary identifier.
|
|
124687
124735
|
*/
|
|
@@ -124702,10 +124750,22 @@ export interface UsersUsersDeleteOutput {
|
|
|
124702
124750
|
* Id of this end user. Pass it to any users_users_* tool.
|
|
124703
124751
|
*/
|
|
124704
124752
|
id: string;
|
|
124753
|
+
/**
|
|
124754
|
+
* 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.
|
|
124755
|
+
*/
|
|
124756
|
+
kind: ("account" | "contact");
|
|
124705
124757
|
/**
|
|
124706
124758
|
* The user's display name. Null when nobody set one.
|
|
124707
124759
|
*/
|
|
124708
124760
|
name: (string | null);
|
|
124761
|
+
/**
|
|
124762
|
+
* Free labels on this person, stored trimmed, lowercased and de-duplicated.
|
|
124763
|
+
*/
|
|
124764
|
+
tags: string[];
|
|
124765
|
+
/**
|
|
124766
|
+
* The relationship stage, in funnel order: new, contacted, replied, engaged, converted, lost. A real change publishes `users/user.stage-changed`.
|
|
124767
|
+
*/
|
|
124768
|
+
stage: ("new" | "contacted" | "replied" | "engaged" | "converted" | "lost");
|
|
124709
124769
|
/**
|
|
124710
124770
|
* When the user was banned (ISO 8601). Null while they are not banned.
|
|
124711
124771
|
*/
|
|
@@ -124809,6 +124869,10 @@ export interface UsersUsersDeleteOutput {
|
|
|
124809
124869
|
privateMetadata: {
|
|
124810
124870
|
[k: string]: unknown;
|
|
124811
124871
|
};
|
|
124872
|
+
/**
|
|
124873
|
+
* The user this person was merged INTO, when they were merged. Null for everybody else — follow it to find where their records went.
|
|
124874
|
+
*/
|
|
124875
|
+
mergedIntoUserId: (string | null);
|
|
124812
124876
|
/**
|
|
124813
124877
|
* Id of the primary identifier row. Null when there is no primary identifier.
|
|
124814
124878
|
*/
|
|
@@ -124819,6 +124883,10 @@ export interface UsersUsersDeleteOutput {
|
|
|
124819
124883
|
emailChangeLockedUntil: (string | null);
|
|
124820
124884
|
}
|
|
124821
124885
|
export interface UsersUsersExportInput {
|
|
124886
|
+
/**
|
|
124887
|
+
* Filter by kind: 'account' or 'contact'. Omit for accounts only, unless `includeContacts` is true.
|
|
124888
|
+
*/
|
|
124889
|
+
kind?: ("account" | "contact");
|
|
124822
124890
|
/**
|
|
124823
124891
|
* Rows per page, 1-500. Default 100.
|
|
124824
124892
|
*/
|
|
@@ -124839,6 +124907,10 @@ export interface UsersUsersExportInput {
|
|
|
124839
124907
|
* Include soft-deleted users. Default false.
|
|
124840
124908
|
*/
|
|
124841
124909
|
includeDeleted?: boolean;
|
|
124910
|
+
/**
|
|
124911
|
+
* Include CONTACTS alongside accounts, so one pass exports both. Default false — the same rule this export already applies to waitlist signups and test users.
|
|
124912
|
+
*/
|
|
124913
|
+
includeContacts?: boolean;
|
|
124842
124914
|
}
|
|
124843
124915
|
export interface UsersUsersExportOutput {
|
|
124844
124916
|
count: number;
|
|
@@ -124847,10 +124919,22 @@ export interface UsersUsersExportOutput {
|
|
|
124847
124919
|
* Id of this end user. Pass it to any users_users_* tool.
|
|
124848
124920
|
*/
|
|
124849
124921
|
id: string;
|
|
124922
|
+
/**
|
|
124923
|
+
* 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.
|
|
124924
|
+
*/
|
|
124925
|
+
kind: ("account" | "contact");
|
|
124850
124926
|
/**
|
|
124851
124927
|
* The user's display name. Null when nobody set one.
|
|
124852
124928
|
*/
|
|
124853
124929
|
name: (string | null);
|
|
124930
|
+
/**
|
|
124931
|
+
* Free labels on this person, stored trimmed, lowercased and de-duplicated.
|
|
124932
|
+
*/
|
|
124933
|
+
tags: string[];
|
|
124934
|
+
/**
|
|
124935
|
+
* The relationship stage, in funnel order: new, contacted, replied, engaged, converted, lost. A real change publishes `users/user.stage-changed`.
|
|
124936
|
+
*/
|
|
124937
|
+
stage: ("new" | "contacted" | "replied" | "engaged" | "converted" | "lost");
|
|
124854
124938
|
/**
|
|
124855
124939
|
* When the user was banned (ISO 8601). Null while they are not banned.
|
|
124856
124940
|
*/
|
|
@@ -124954,6 +125038,10 @@ export interface UsersUsersExportOutput {
|
|
|
124954
125038
|
privateMetadata: {
|
|
124955
125039
|
[k: string]: unknown;
|
|
124956
125040
|
};
|
|
125041
|
+
/**
|
|
125042
|
+
* The user this person was merged INTO, when they were merged. Null for everybody else — follow it to find where their records went.
|
|
125043
|
+
*/
|
|
125044
|
+
mergedIntoUserId: (string | null);
|
|
124957
125045
|
/**
|
|
124958
125046
|
* Id of the primary identifier row. Null when there is no primary identifier.
|
|
124959
125047
|
*/
|
|
@@ -124977,10 +125065,22 @@ export interface UsersUsersGetOutput {
|
|
|
124977
125065
|
* Id of this end user. Pass it to any users_users_* tool.
|
|
124978
125066
|
*/
|
|
124979
125067
|
id: string;
|
|
125068
|
+
/**
|
|
125069
|
+
* 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.
|
|
125070
|
+
*/
|
|
125071
|
+
kind: ("account" | "contact");
|
|
124980
125072
|
/**
|
|
124981
125073
|
* The user's display name. Null when nobody set one.
|
|
124982
125074
|
*/
|
|
124983
125075
|
name: (string | null);
|
|
125076
|
+
/**
|
|
125077
|
+
* Free labels on this person, stored trimmed, lowercased and de-duplicated.
|
|
125078
|
+
*/
|
|
125079
|
+
tags: string[];
|
|
125080
|
+
/**
|
|
125081
|
+
* The relationship stage, in funnel order: new, contacted, replied, engaged, converted, lost. A real change publishes `users/user.stage-changed`.
|
|
125082
|
+
*/
|
|
125083
|
+
stage: ("new" | "contacted" | "replied" | "engaged" | "converted" | "lost");
|
|
124984
125084
|
/**
|
|
124985
125085
|
* When the user was banned (ISO 8601). Null while they are not banned.
|
|
124986
125086
|
*/
|
|
@@ -125084,6 +125184,10 @@ export interface UsersUsersGetOutput {
|
|
|
125084
125184
|
privateMetadata: {
|
|
125085
125185
|
[k: string]: unknown;
|
|
125086
125186
|
};
|
|
125187
|
+
/**
|
|
125188
|
+
* The user this person was merged INTO, when they were merged. Null for everybody else — follow it to find where their records went.
|
|
125189
|
+
*/
|
|
125190
|
+
mergedIntoUserId: (string | null);
|
|
125087
125191
|
/**
|
|
125088
125192
|
* Id of the primary identifier row. Null when there is no primary identifier.
|
|
125089
125193
|
*/
|
|
@@ -125136,6 +125240,10 @@ export interface UsersUsersImportOutput {
|
|
|
125136
125240
|
* How many rows were passed over — an address already in the directory, typically.
|
|
125137
125241
|
*/
|
|
125138
125242
|
skipped: number;
|
|
125243
|
+
/**
|
|
125244
|
+
* How many of the CREATED users were contacts (`kind: 'contact'`). A row that was skipped or failed is not counted.
|
|
125245
|
+
*/
|
|
125246
|
+
contacts: number;
|
|
125139
125247
|
/**
|
|
125140
125248
|
* How many rows you submitted.
|
|
125141
125249
|
*/
|
|
@@ -125182,6 +125290,14 @@ export interface UsersUsersInviteOutput {
|
|
|
125182
125290
|
expiresAt: string;
|
|
125183
125291
|
}
|
|
125184
125292
|
export interface UsersUsersListInput {
|
|
125293
|
+
/**
|
|
125294
|
+
* Return only people carrying this tag. ONE tag, matched against the stored (lowercased) value and ANDed with the other filters.
|
|
125295
|
+
*/
|
|
125296
|
+
tag?: string;
|
|
125297
|
+
/**
|
|
125298
|
+
* 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.
|
|
125299
|
+
*/
|
|
125300
|
+
kind?: ("account" | "contact");
|
|
125185
125301
|
/**
|
|
125186
125302
|
* Page size, 1-100. Default 25.
|
|
125187
125303
|
*/
|
|
@@ -125190,6 +125306,10 @@ export interface UsersUsersListInput {
|
|
|
125190
125306
|
* Case-insensitive substring match against the user's identifiers (email) and name.
|
|
125191
125307
|
*/
|
|
125192
125308
|
query?: string;
|
|
125309
|
+
/**
|
|
125310
|
+
* Filter by relationship stage: new, contacted, replied, engaged, converted or lost. Omit for every stage.
|
|
125311
|
+
*/
|
|
125312
|
+
stage?: ("new" | "contacted" | "replied" | "engaged" | "converted" | "lost");
|
|
125193
125313
|
/**
|
|
125194
125314
|
* Opaque cursor from a previous response's `nextCursor`. Omit for the first page.
|
|
125195
125315
|
*/
|
|
@@ -125202,6 +125322,10 @@ export interface UsersUsersListInput {
|
|
|
125202
125322
|
* Include soft-deleted users. Default false — deleted users are hidden.
|
|
125203
125323
|
*/
|
|
125204
125324
|
includeDeleted?: boolean;
|
|
125325
|
+
/**
|
|
125326
|
+
* 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.
|
|
125327
|
+
*/
|
|
125328
|
+
includeContacts?: boolean;
|
|
125205
125329
|
/**
|
|
125206
125330
|
* 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.
|
|
125207
125331
|
*/
|
|
@@ -125220,10 +125344,22 @@ export interface UsersUsersListOutput {
|
|
|
125220
125344
|
* Id of this end user. Pass it to any users_users_* tool.
|
|
125221
125345
|
*/
|
|
125222
125346
|
id: string;
|
|
125347
|
+
/**
|
|
125348
|
+
* 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.
|
|
125349
|
+
*/
|
|
125350
|
+
kind: ("account" | "contact");
|
|
125223
125351
|
/**
|
|
125224
125352
|
* The user's display name. Null when nobody set one.
|
|
125225
125353
|
*/
|
|
125226
125354
|
name: (string | null);
|
|
125355
|
+
/**
|
|
125356
|
+
* Free labels on this person, stored trimmed, lowercased and de-duplicated.
|
|
125357
|
+
*/
|
|
125358
|
+
tags: string[];
|
|
125359
|
+
/**
|
|
125360
|
+
* The relationship stage, in funnel order: new, contacted, replied, engaged, converted, lost. A real change publishes `users/user.stage-changed`.
|
|
125361
|
+
*/
|
|
125362
|
+
stage: ("new" | "contacted" | "replied" | "engaged" | "converted" | "lost");
|
|
125227
125363
|
/**
|
|
125228
125364
|
* When the user was banned (ISO 8601). Null while they are not banned.
|
|
125229
125365
|
*/
|
|
@@ -125327,6 +125463,10 @@ export interface UsersUsersListOutput {
|
|
|
125327
125463
|
privateMetadata: {
|
|
125328
125464
|
[k: string]: unknown;
|
|
125329
125465
|
};
|
|
125466
|
+
/**
|
|
125467
|
+
* The user this person was merged INTO, when they were merged. Null for everybody else — follow it to find where their records went.
|
|
125468
|
+
*/
|
|
125469
|
+
mergedIntoUserId: (string | null);
|
|
125330
125470
|
/**
|
|
125331
125471
|
* Id of the primary identifier row. Null when there is no primary identifier.
|
|
125332
125472
|
*/
|
|
@@ -125376,10 +125516,22 @@ export interface UsersUsersUnbanOutput {
|
|
|
125376
125516
|
* Id of this end user. Pass it to any users_users_* tool.
|
|
125377
125517
|
*/
|
|
125378
125518
|
id: string;
|
|
125519
|
+
/**
|
|
125520
|
+
* 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.
|
|
125521
|
+
*/
|
|
125522
|
+
kind: ("account" | "contact");
|
|
125379
125523
|
/**
|
|
125380
125524
|
* The user's display name. Null when nobody set one.
|
|
125381
125525
|
*/
|
|
125382
125526
|
name: (string | null);
|
|
125527
|
+
/**
|
|
125528
|
+
* Free labels on this person, stored trimmed, lowercased and de-duplicated.
|
|
125529
|
+
*/
|
|
125530
|
+
tags: string[];
|
|
125531
|
+
/**
|
|
125532
|
+
* The relationship stage, in funnel order: new, contacted, replied, engaged, converted, lost. A real change publishes `users/user.stage-changed`.
|
|
125533
|
+
*/
|
|
125534
|
+
stage: ("new" | "contacted" | "replied" | "engaged" | "converted" | "lost");
|
|
125383
125535
|
/**
|
|
125384
125536
|
* When the user was banned (ISO 8601). Null while they are not banned.
|
|
125385
125537
|
*/
|
|
@@ -125483,6 +125635,10 @@ export interface UsersUsersUnbanOutput {
|
|
|
125483
125635
|
privateMetadata: {
|
|
125484
125636
|
[k: string]: unknown;
|
|
125485
125637
|
};
|
|
125638
|
+
/**
|
|
125639
|
+
* The user this person was merged INTO, when they were merged. Null for everybody else — follow it to find where their records went.
|
|
125640
|
+
*/
|
|
125641
|
+
mergedIntoUserId: (string | null);
|
|
125486
125642
|
/**
|
|
125487
125643
|
* Id of the primary identifier row. Null when there is no primary identifier.
|
|
125488
125644
|
*/
|
|
@@ -125497,6 +125653,14 @@ export interface UsersUsersUpdateInput {
|
|
|
125497
125653
|
* The user's display name. Pass null to clear.
|
|
125498
125654
|
*/
|
|
125499
125655
|
name?: (string | null);
|
|
125656
|
+
/**
|
|
125657
|
+
* REPLACES the whole tag list — send every tag you want stored, not just the new ones. Trimmed, lowercased and de-duplicated on write.
|
|
125658
|
+
*/
|
|
125659
|
+
tags?: string[];
|
|
125660
|
+
/**
|
|
125661
|
+
* 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.
|
|
125662
|
+
*/
|
|
125663
|
+
stage?: ("new" | "contacted" | "replied" | "engaged" | "converted" | "lost");
|
|
125500
125664
|
/**
|
|
125501
125665
|
* The user to update.
|
|
125502
125666
|
*/
|
|
@@ -125543,10 +125707,22 @@ export interface UsersUsersUpdateOutput {
|
|
|
125543
125707
|
* Id of this end user. Pass it to any users_users_* tool.
|
|
125544
125708
|
*/
|
|
125545
125709
|
id: string;
|
|
125710
|
+
/**
|
|
125711
|
+
* 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.
|
|
125712
|
+
*/
|
|
125713
|
+
kind: ("account" | "contact");
|
|
125546
125714
|
/**
|
|
125547
125715
|
* The user's display name. Null when nobody set one.
|
|
125548
125716
|
*/
|
|
125549
125717
|
name: (string | null);
|
|
125718
|
+
/**
|
|
125719
|
+
* Free labels on this person, stored trimmed, lowercased and de-duplicated.
|
|
125720
|
+
*/
|
|
125721
|
+
tags: string[];
|
|
125722
|
+
/**
|
|
125723
|
+
* The relationship stage, in funnel order: new, contacted, replied, engaged, converted, lost. A real change publishes `users/user.stage-changed`.
|
|
125724
|
+
*/
|
|
125725
|
+
stage: ("new" | "contacted" | "replied" | "engaged" | "converted" | "lost");
|
|
125550
125726
|
/**
|
|
125551
125727
|
* When the user was banned (ISO 8601). Null while they are not banned.
|
|
125552
125728
|
*/
|
|
@@ -125650,6 +125826,10 @@ export interface UsersUsersUpdateOutput {
|
|
|
125650
125826
|
privateMetadata: {
|
|
125651
125827
|
[k: string]: unknown;
|
|
125652
125828
|
};
|
|
125829
|
+
/**
|
|
125830
|
+
* The user this person was merged INTO, when they were merged. Null for everybody else — follow it to find where their records went.
|
|
125831
|
+
*/
|
|
125832
|
+
mergedIntoUserId: (string | null);
|
|
125653
125833
|
/**
|
|
125654
125834
|
* Id of the primary identifier row. Null when there is no primary identifier.
|
|
125655
125835
|
*/
|
|
@@ -10347,6 +10347,18 @@ var bindings = {
|
|
|
10347
10347
|
"in": "body",
|
|
10348
10348
|
"name": "testUser"
|
|
10349
10349
|
},
|
|
10350
|
+
{
|
|
10351
|
+
"in": "body",
|
|
10352
|
+
"name": "kind"
|
|
10353
|
+
},
|
|
10354
|
+
{
|
|
10355
|
+
"in": "body",
|
|
10356
|
+
"name": "stage"
|
|
10357
|
+
},
|
|
10358
|
+
{
|
|
10359
|
+
"in": "body",
|
|
10360
|
+
"name": "tags"
|
|
10361
|
+
},
|
|
10350
10362
|
{
|
|
10351
10363
|
"in": "body",
|
|
10352
10364
|
"name": "requiresReset"
|
|
@@ -10397,6 +10409,14 @@ var bindings = {
|
|
|
10397
10409
|
"in": "query",
|
|
10398
10410
|
"name": "includeDeleted"
|
|
10399
10411
|
},
|
|
10412
|
+
{
|
|
10413
|
+
"in": "query",
|
|
10414
|
+
"name": "kind"
|
|
10415
|
+
},
|
|
10416
|
+
{
|
|
10417
|
+
"in": "query",
|
|
10418
|
+
"name": "includeContacts"
|
|
10419
|
+
},
|
|
10400
10420
|
{
|
|
10401
10421
|
"in": "query",
|
|
10402
10422
|
"name": "limit"
|
|
@@ -10485,6 +10505,22 @@ var bindings = {
|
|
|
10485
10505
|
"in": "query",
|
|
10486
10506
|
"name": "includeTestUsers"
|
|
10487
10507
|
},
|
|
10508
|
+
{
|
|
10509
|
+
"in": "query",
|
|
10510
|
+
"name": "kind"
|
|
10511
|
+
},
|
|
10512
|
+
{
|
|
10513
|
+
"in": "query",
|
|
10514
|
+
"name": "stage"
|
|
10515
|
+
},
|
|
10516
|
+
{
|
|
10517
|
+
"in": "query",
|
|
10518
|
+
"name": "tag"
|
|
10519
|
+
},
|
|
10520
|
+
{
|
|
10521
|
+
"in": "query",
|
|
10522
|
+
"name": "includeContacts"
|
|
10523
|
+
},
|
|
10488
10524
|
{
|
|
10489
10525
|
"in": "query",
|
|
10490
10526
|
"name": "limit"
|
|
@@ -10550,6 +10586,14 @@ var bindings = {
|
|
|
10550
10586
|
{
|
|
10551
10587
|
"in": "body",
|
|
10552
10588
|
"name": "unsafeMetadata"
|
|
10589
|
+
},
|
|
10590
|
+
{
|
|
10591
|
+
"in": "body",
|
|
10592
|
+
"name": "stage"
|
|
10593
|
+
},
|
|
10594
|
+
{
|
|
10595
|
+
"in": "body",
|
|
10596
|
+
"name": "tags"
|
|
10553
10597
|
}
|
|
10554
10598
|
],
|
|
10555
10599
|
"path": "/users/users/:userId",
|
|
@@ -11527,5 +11571,5 @@ var wsBindings = {
|
|
|
11527
11571
|
};
|
|
11528
11572
|
|
|
11529
11573
|
export { bindings, wsBindings };
|
|
11530
|
-
//# sourceMappingURL=chunk-
|
|
11531
|
-
//# sourceMappingURL=chunk-
|
|
11574
|
+
//# sourceMappingURL=chunk-T3O56NBF.js.map
|
|
11575
|
+
//# sourceMappingURL=chunk-T3O56NBF.js.map
|