@sentdm/sentdm 0.34.0 → 0.36.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 +15 -0
- package/client.d.mts +53 -22
- package/client.d.mts.map +1 -1
- package/client.d.ts +53 -22
- package/client.d.ts.map +1 -1
- package/client.js +39 -8
- package/client.js.map +1 -1
- package/client.mjs +39 -8
- package/client.mjs.map +1 -1
- package/package.json +1 -1
- package/resources/contacts.d.mts +606 -89
- package/resources/contacts.d.mts.map +1 -1
- package/resources/contacts.d.ts +606 -89
- package/resources/contacts.d.ts.map +1 -1
- package/resources/contacts.js +21 -15
- package/resources/contacts.js.map +1 -1
- package/resources/contacts.mjs +21 -15
- package/resources/contacts.mjs.map +1 -1
- package/resources/conversations.d.mts +335 -69
- package/resources/conversations.d.mts.map +1 -1
- package/resources/conversations.d.ts +335 -69
- package/resources/conversations.d.ts.map +1 -1
- package/resources/conversations.js +15 -10
- package/resources/conversations.js.map +1 -1
- package/resources/conversations.mjs +15 -10
- package/resources/conversations.mjs.map +1 -1
- package/resources/index.d.mts +7 -7
- package/resources/index.d.mts.map +1 -1
- package/resources/index.d.ts +7 -7
- package/resources/index.d.ts.map +1 -1
- package/resources/index.js.map +1 -1
- package/resources/index.mjs.map +1 -1
- package/resources/me.d.mts +165 -41
- package/resources/me.d.mts.map +1 -1
- package/resources/me.d.ts +165 -41
- package/resources/me.d.ts.map +1 -1
- package/resources/me.js +14 -1
- package/resources/me.js.map +1 -1
- package/resources/me.mjs +14 -1
- package/resources/me.mjs.map +1 -1
- package/resources/messages.d.mts +206 -27
- package/resources/messages.d.mts.map +1 -1
- package/resources/messages.d.ts +206 -27
- package/resources/messages.d.ts.map +1 -1
- package/resources/messages.js +5 -1
- package/resources/messages.js.map +1 -1
- package/resources/messages.mjs +5 -1
- package/resources/messages.mjs.map +1 -1
- package/resources/numbers.d.mts +45 -4
- package/resources/numbers.d.mts.map +1 -1
- package/resources/numbers.d.ts +45 -4
- package/resources/numbers.d.ts.map +1 -1
- package/resources/numbers.js +3 -1
- package/resources/numbers.js.map +1 -1
- package/resources/numbers.mjs +3 -1
- package/resources/numbers.mjs.map +1 -1
- package/resources/profiles/campaigns.d.mts +579 -209
- package/resources/profiles/campaigns.d.mts.map +1 -1
- package/resources/profiles/campaigns.d.ts +579 -209
- package/resources/profiles/campaigns.d.ts.map +1 -1
- package/resources/profiles/campaigns.js +33 -64
- package/resources/profiles/campaigns.js.map +1 -1
- package/resources/profiles/campaigns.mjs +33 -64
- package/resources/profiles/campaigns.mjs.map +1 -1
- package/resources/profiles/index.d.mts +2 -2
- package/resources/profiles/index.d.mts.map +1 -1
- package/resources/profiles/index.d.ts +2 -2
- package/resources/profiles/index.d.ts.map +1 -1
- package/resources/profiles/index.js.map +1 -1
- package/resources/profiles/index.mjs.map +1 -1
- package/resources/profiles/profiles.d.mts +2006 -508
- package/resources/profiles/profiles.d.mts.map +1 -1
- package/resources/profiles/profiles.d.ts +2006 -508
- package/resources/profiles/profiles.d.ts.map +1 -1
- package/resources/profiles/profiles.js +98 -75
- package/resources/profiles/profiles.js.map +1 -1
- package/resources/profiles/profiles.mjs +98 -75
- package/resources/profiles/profiles.mjs.map +1 -1
- package/resources/templates.d.mts +497 -84
- package/resources/templates.d.mts.map +1 -1
- package/resources/templates.d.ts +497 -84
- package/resources/templates.d.ts.map +1 -1
- package/resources/templates.js +6 -4
- package/resources/templates.js.map +1 -1
- package/resources/templates.mjs +6 -4
- package/resources/templates.mjs.map +1 -1
- package/resources/users.d.mts +444 -43
- package/resources/users.d.mts.map +1 -1
- package/resources/users.d.ts +444 -43
- package/resources/users.d.ts.map +1 -1
- package/resources/users.js +6 -4
- package/resources/users.js.map +1 -1
- package/resources/users.mjs +6 -4
- package/resources/users.mjs.map +1 -1
- package/resources/webhooks.d.mts +791 -190
- package/resources/webhooks.d.mts.map +1 -1
- package/resources/webhooks.d.ts +791 -190
- package/resources/webhooks.d.ts.map +1 -1
- package/resources/webhooks.js +11 -8
- package/resources/webhooks.js.map +1 -1
- package/resources/webhooks.mjs +11 -8
- package/resources/webhooks.mjs.map +1 -1
- package/src/client.ts +78 -60
- package/src/resources/contacts.ts +696 -92
- package/src/resources/conversations.ts +400 -77
- package/src/resources/index.ts +20 -26
- package/src/resources/me.ts +186 -52
- package/src/resources/messages.ts +230 -27
- package/src/resources/numbers.ts +50 -4
- package/src/resources/profiles/campaigns.ts +706 -232
- package/src/resources/profiles/index.ts +6 -14
- package/src/resources/profiles/profiles.ts +2421 -646
- package/src/resources/templates.ts +583 -99
- package/src/resources/users.ts +514 -44
- package/src/resources/webhooks.ts +964 -241
- package/src/version.ts +1 -1
- package/version.d.mts +1 -1
- package/version.d.ts +1 -1
- package/version.js +1 -1
- package/version.mjs +1 -1
package/resources/users.d.mts
CHANGED
|
@@ -1,10 +1,10 @@
|
|
|
1
1
|
import { APIResource } from "../core/resource.mjs";
|
|
2
|
-
import * as UsersAPI from "./users.mjs";
|
|
3
|
-
import * as WebhooksAPI from "./webhooks.mjs";
|
|
4
2
|
import { APIPromise } from "../core/api-promise.mjs";
|
|
5
3
|
import { RequestOptions } from "../internal/request-options.mjs";
|
|
6
4
|
/**
|
|
7
|
-
*
|
|
5
|
+
* The people who can sign in to your organization, and what each may do.
|
|
6
|
+
*
|
|
7
|
+
* Users are dashboard access and nothing else — they do not send, and removing one does not affect traffic. An API key is not a user: it belongs to the organization or to a sender profile, so revoking a person's access leaves your integration running.
|
|
8
8
|
*/
|
|
9
9
|
export declare class Users extends APIResource {
|
|
10
10
|
/**
|
|
@@ -13,12 +13,12 @@ export declare class Users extends APIResource {
|
|
|
13
13
|
*
|
|
14
14
|
* @example
|
|
15
15
|
* ```ts
|
|
16
|
-
* const
|
|
16
|
+
* const user = await client.users.retrieve(
|
|
17
17
|
* '880e8400-e29b-41d4-a716-446655440003',
|
|
18
18
|
* );
|
|
19
19
|
* ```
|
|
20
20
|
*/
|
|
21
|
-
retrieve(userID: string, params?: UserRetrieveParams | null | undefined, options?: RequestOptions): APIPromise<
|
|
21
|
+
retrieve(userID: string, params?: UserRetrieveParams | null | undefined, options?: RequestOptions): APIPromise<UserRetrieveResponse>;
|
|
22
22
|
/**
|
|
23
23
|
* Retrieves all users who have access to the organization or profile identified by
|
|
24
24
|
* the API key, including their roles and status. Shows invited users (pending
|
|
@@ -37,10 +37,10 @@ export declare class Users extends APIResource {
|
|
|
37
37
|
*
|
|
38
38
|
* @example
|
|
39
39
|
* ```ts
|
|
40
|
-
* const
|
|
40
|
+
* const response = await client.users.invite();
|
|
41
41
|
* ```
|
|
42
42
|
*/
|
|
43
|
-
invite(params: UserInviteParams, options?: RequestOptions): APIPromise<
|
|
43
|
+
invite(params: UserInviteParams, options?: RequestOptions): APIPromise<UserInviteResponse>;
|
|
44
44
|
/**
|
|
45
45
|
* Removes a user's access to an organization or profile. Requires admin role. You
|
|
46
46
|
* cannot remove yourself or remove the last admin.
|
|
@@ -59,105 +59,506 @@ export declare class Users extends APIResource {
|
|
|
59
59
|
*
|
|
60
60
|
* @example
|
|
61
61
|
* ```ts
|
|
62
|
-
* const
|
|
62
|
+
* const response = await client.users.updateRole(
|
|
63
63
|
* 'aa0e8400-e29b-41d4-a716-446655440005',
|
|
64
64
|
* );
|
|
65
65
|
* ```
|
|
66
66
|
*/
|
|
67
|
-
updateRole(userID: string, params: UserUpdateRoleParams, options?: RequestOptions): APIPromise<
|
|
67
|
+
updateRole(userID: string, params: UserUpdateRoleParams, options?: RequestOptions): APIPromise<UserUpdateRoleResponse>;
|
|
68
68
|
}
|
|
69
69
|
/**
|
|
70
70
|
* Standard API response envelope for all v3 endpoints
|
|
71
71
|
*/
|
|
72
|
-
export interface
|
|
72
|
+
export interface UserRetrieveResponse {
|
|
73
73
|
/**
|
|
74
74
|
* User response for v3 API
|
|
75
75
|
*/
|
|
76
|
-
data?:
|
|
76
|
+
data?: UserRetrieveResponse.Data | null;
|
|
77
77
|
/**
|
|
78
78
|
* Error information
|
|
79
79
|
*/
|
|
80
|
-
error?:
|
|
80
|
+
error?: UserRetrieveResponse.Error | null;
|
|
81
81
|
/**
|
|
82
82
|
* Request and response metadata
|
|
83
83
|
*/
|
|
84
|
-
meta?:
|
|
84
|
+
meta?: UserRetrieveResponse.Meta;
|
|
85
85
|
/**
|
|
86
86
|
* Indicates whether the request was successful
|
|
87
87
|
*/
|
|
88
88
|
success?: boolean;
|
|
89
89
|
}
|
|
90
|
+
export declare namespace UserRetrieveResponse {
|
|
91
|
+
/**
|
|
92
|
+
* User response for v3 API
|
|
93
|
+
*/
|
|
94
|
+
interface Data {
|
|
95
|
+
/**
|
|
96
|
+
* User unique identifier
|
|
97
|
+
*/
|
|
98
|
+
id?: string;
|
|
99
|
+
/**
|
|
100
|
+
* When the user was added to the organization
|
|
101
|
+
*/
|
|
102
|
+
created_at?: string;
|
|
103
|
+
/**
|
|
104
|
+
* Which customer owns this — the key's own, or the profile named in x-profile-id.
|
|
105
|
+
* Says whose resource this is, which the resource's own id does not.
|
|
106
|
+
*/
|
|
107
|
+
customer_id?: string;
|
|
108
|
+
/**
|
|
109
|
+
* User email address
|
|
110
|
+
*/
|
|
111
|
+
email?: string;
|
|
112
|
+
/**
|
|
113
|
+
* When the user was invited
|
|
114
|
+
*/
|
|
115
|
+
invited_at?: string | null;
|
|
116
|
+
/**
|
|
117
|
+
* When the user last logged in
|
|
118
|
+
*/
|
|
119
|
+
last_login_at?: string | null;
|
|
120
|
+
/**
|
|
121
|
+
* User full name
|
|
122
|
+
*/
|
|
123
|
+
name?: string;
|
|
124
|
+
/**
|
|
125
|
+
* User role in the organization: admin, billing, developer
|
|
126
|
+
*/
|
|
127
|
+
role?: string;
|
|
128
|
+
/**
|
|
129
|
+
* User status: active, invited, suspended, rejected
|
|
130
|
+
*/
|
|
131
|
+
status?: string;
|
|
132
|
+
/**
|
|
133
|
+
* When the user record was last updated
|
|
134
|
+
*/
|
|
135
|
+
updated_at?: string | null;
|
|
136
|
+
}
|
|
137
|
+
/**
|
|
138
|
+
* Error information
|
|
139
|
+
*/
|
|
140
|
+
interface Error {
|
|
141
|
+
/**
|
|
142
|
+
* Machine-readable error code (e.g., "RESOURCE_001")
|
|
143
|
+
*/
|
|
144
|
+
code?: string;
|
|
145
|
+
/**
|
|
146
|
+
* Additional validation error details (field-level errors)
|
|
147
|
+
*/
|
|
148
|
+
details?: {
|
|
149
|
+
[key: string]: Array<string>;
|
|
150
|
+
} | null;
|
|
151
|
+
/**
|
|
152
|
+
* URL to documentation about this error
|
|
153
|
+
*/
|
|
154
|
+
doc_url?: string | null;
|
|
155
|
+
/**
|
|
156
|
+
* Human-readable error message
|
|
157
|
+
*/
|
|
158
|
+
message?: string;
|
|
159
|
+
}
|
|
160
|
+
/**
|
|
161
|
+
* Request and response metadata
|
|
162
|
+
*/
|
|
163
|
+
interface Meta {
|
|
164
|
+
/**
|
|
165
|
+
* Unique identifier for this request (for tracing and support)
|
|
166
|
+
*/
|
|
167
|
+
request_id?: string;
|
|
168
|
+
/**
|
|
169
|
+
* Server timestamp when the response was generated
|
|
170
|
+
*/
|
|
171
|
+
timestamp?: string;
|
|
172
|
+
/**
|
|
173
|
+
* API version used for this request
|
|
174
|
+
*/
|
|
175
|
+
version?: string;
|
|
176
|
+
}
|
|
177
|
+
}
|
|
90
178
|
/**
|
|
91
|
-
*
|
|
179
|
+
* Standard API response envelope for all v3 endpoints
|
|
92
180
|
*/
|
|
93
|
-
export interface
|
|
181
|
+
export interface UserListResponse {
|
|
94
182
|
/**
|
|
95
|
-
*
|
|
183
|
+
* The users in the organization.
|
|
96
184
|
*/
|
|
97
|
-
|
|
185
|
+
data?: UserListResponse.Data | null;
|
|
98
186
|
/**
|
|
99
|
-
*
|
|
187
|
+
* Error information
|
|
100
188
|
*/
|
|
101
|
-
|
|
189
|
+
error?: UserListResponse.Error | null;
|
|
102
190
|
/**
|
|
103
|
-
*
|
|
191
|
+
* Request and response metadata
|
|
104
192
|
*/
|
|
105
|
-
|
|
193
|
+
meta?: UserListResponse.Meta;
|
|
106
194
|
/**
|
|
107
|
-
*
|
|
195
|
+
* Indicates whether the request was successful
|
|
108
196
|
*/
|
|
109
|
-
|
|
197
|
+
success?: boolean;
|
|
198
|
+
}
|
|
199
|
+
export declare namespace UserListResponse {
|
|
110
200
|
/**
|
|
111
|
-
*
|
|
201
|
+
* The users in the organization.
|
|
112
202
|
*/
|
|
113
|
-
|
|
203
|
+
interface Data {
|
|
204
|
+
/**
|
|
205
|
+
* Pagination metadata for list responses
|
|
206
|
+
*/
|
|
207
|
+
pagination?: Data.Pagination;
|
|
208
|
+
/**
|
|
209
|
+
* The users on this page.
|
|
210
|
+
*/
|
|
211
|
+
users?: Array<Data.User>;
|
|
212
|
+
}
|
|
213
|
+
namespace Data {
|
|
214
|
+
/**
|
|
215
|
+
* Pagination metadata for list responses
|
|
216
|
+
*/
|
|
217
|
+
interface Pagination {
|
|
218
|
+
/**
|
|
219
|
+
* @deprecated Cursor-based pagination. Never populated — see Cursors.
|
|
220
|
+
*/
|
|
221
|
+
cursors?: Pagination.Cursors | null;
|
|
222
|
+
/**
|
|
223
|
+
* Whether there are more pages after this one
|
|
224
|
+
*/
|
|
225
|
+
has_more?: boolean;
|
|
226
|
+
/**
|
|
227
|
+
* Current page number (1-indexed)
|
|
228
|
+
*/
|
|
229
|
+
page?: number;
|
|
230
|
+
/**
|
|
231
|
+
* Number of items per page
|
|
232
|
+
*/
|
|
233
|
+
page_size?: number;
|
|
234
|
+
/**
|
|
235
|
+
* Total number of items across all pages
|
|
236
|
+
*/
|
|
237
|
+
total_count?: number;
|
|
238
|
+
/**
|
|
239
|
+
* Total number of pages
|
|
240
|
+
*/
|
|
241
|
+
total_pages?: number;
|
|
242
|
+
}
|
|
243
|
+
namespace Pagination {
|
|
244
|
+
/**
|
|
245
|
+
* @deprecated Cursor-based pagination. Never populated — see Cursors.
|
|
246
|
+
*/
|
|
247
|
+
interface Cursors {
|
|
248
|
+
/**
|
|
249
|
+
* Cursor to fetch the next page.
|
|
250
|
+
*/
|
|
251
|
+
after?: string | null;
|
|
252
|
+
/**
|
|
253
|
+
* Cursor to fetch the previous page.
|
|
254
|
+
*/
|
|
255
|
+
before?: string | null;
|
|
256
|
+
}
|
|
257
|
+
}
|
|
258
|
+
/**
|
|
259
|
+
* User response for v3 API
|
|
260
|
+
*/
|
|
261
|
+
interface User {
|
|
262
|
+
/**
|
|
263
|
+
* User unique identifier
|
|
264
|
+
*/
|
|
265
|
+
id?: string;
|
|
266
|
+
/**
|
|
267
|
+
* When the user was added to the organization
|
|
268
|
+
*/
|
|
269
|
+
created_at?: string;
|
|
270
|
+
/**
|
|
271
|
+
* Which customer owns this — the key's own, or the profile named in x-profile-id.
|
|
272
|
+
* Says whose resource this is, which the resource's own id does not.
|
|
273
|
+
*/
|
|
274
|
+
customer_id?: string;
|
|
275
|
+
/**
|
|
276
|
+
* User email address
|
|
277
|
+
*/
|
|
278
|
+
email?: string;
|
|
279
|
+
/**
|
|
280
|
+
* When the user was invited
|
|
281
|
+
*/
|
|
282
|
+
invited_at?: string | null;
|
|
283
|
+
/**
|
|
284
|
+
* When the user last logged in
|
|
285
|
+
*/
|
|
286
|
+
last_login_at?: string | null;
|
|
287
|
+
/**
|
|
288
|
+
* User full name
|
|
289
|
+
*/
|
|
290
|
+
name?: string;
|
|
291
|
+
/**
|
|
292
|
+
* User role in the organization: admin, billing, developer
|
|
293
|
+
*/
|
|
294
|
+
role?: string;
|
|
295
|
+
/**
|
|
296
|
+
* User status: active, invited, suspended, rejected
|
|
297
|
+
*/
|
|
298
|
+
status?: string;
|
|
299
|
+
/**
|
|
300
|
+
* When the user record was last updated
|
|
301
|
+
*/
|
|
302
|
+
updated_at?: string | null;
|
|
303
|
+
}
|
|
304
|
+
}
|
|
114
305
|
/**
|
|
115
|
-
*
|
|
306
|
+
* Error information
|
|
116
307
|
*/
|
|
117
|
-
|
|
308
|
+
interface Error {
|
|
309
|
+
/**
|
|
310
|
+
* Machine-readable error code (e.g., "RESOURCE_001")
|
|
311
|
+
*/
|
|
312
|
+
code?: string;
|
|
313
|
+
/**
|
|
314
|
+
* Additional validation error details (field-level errors)
|
|
315
|
+
*/
|
|
316
|
+
details?: {
|
|
317
|
+
[key: string]: Array<string>;
|
|
318
|
+
} | null;
|
|
319
|
+
/**
|
|
320
|
+
* URL to documentation about this error
|
|
321
|
+
*/
|
|
322
|
+
doc_url?: string | null;
|
|
323
|
+
/**
|
|
324
|
+
* Human-readable error message
|
|
325
|
+
*/
|
|
326
|
+
message?: string;
|
|
327
|
+
}
|
|
118
328
|
/**
|
|
119
|
-
*
|
|
329
|
+
* Request and response metadata
|
|
120
330
|
*/
|
|
121
|
-
|
|
331
|
+
interface Meta {
|
|
332
|
+
/**
|
|
333
|
+
* Unique identifier for this request (for tracing and support)
|
|
334
|
+
*/
|
|
335
|
+
request_id?: string;
|
|
336
|
+
/**
|
|
337
|
+
* Server timestamp when the response was generated
|
|
338
|
+
*/
|
|
339
|
+
timestamp?: string;
|
|
340
|
+
/**
|
|
341
|
+
* API version used for this request
|
|
342
|
+
*/
|
|
343
|
+
version?: string;
|
|
344
|
+
}
|
|
345
|
+
}
|
|
346
|
+
/**
|
|
347
|
+
* Standard API response envelope for all v3 endpoints
|
|
348
|
+
*/
|
|
349
|
+
export interface UserInviteResponse {
|
|
350
|
+
/**
|
|
351
|
+
* User response for v3 API
|
|
352
|
+
*/
|
|
353
|
+
data?: UserInviteResponse.Data | null;
|
|
122
354
|
/**
|
|
123
|
-
*
|
|
355
|
+
* Error information
|
|
124
356
|
*/
|
|
125
|
-
|
|
357
|
+
error?: UserInviteResponse.Error | null;
|
|
126
358
|
/**
|
|
127
|
-
*
|
|
359
|
+
* Request and response metadata
|
|
128
360
|
*/
|
|
129
|
-
|
|
361
|
+
meta?: UserInviteResponse.Meta;
|
|
362
|
+
/**
|
|
363
|
+
* Indicates whether the request was successful
|
|
364
|
+
*/
|
|
365
|
+
success?: boolean;
|
|
366
|
+
}
|
|
367
|
+
export declare namespace UserInviteResponse {
|
|
368
|
+
/**
|
|
369
|
+
* User response for v3 API
|
|
370
|
+
*/
|
|
371
|
+
interface Data {
|
|
372
|
+
/**
|
|
373
|
+
* User unique identifier
|
|
374
|
+
*/
|
|
375
|
+
id?: string;
|
|
376
|
+
/**
|
|
377
|
+
* When the user was added to the organization
|
|
378
|
+
*/
|
|
379
|
+
created_at?: string;
|
|
380
|
+
/**
|
|
381
|
+
* Which customer owns this — the key's own, or the profile named in x-profile-id.
|
|
382
|
+
* Says whose resource this is, which the resource's own id does not.
|
|
383
|
+
*/
|
|
384
|
+
customer_id?: string;
|
|
385
|
+
/**
|
|
386
|
+
* User email address
|
|
387
|
+
*/
|
|
388
|
+
email?: string;
|
|
389
|
+
/**
|
|
390
|
+
* When the user was invited
|
|
391
|
+
*/
|
|
392
|
+
invited_at?: string | null;
|
|
393
|
+
/**
|
|
394
|
+
* When the user last logged in
|
|
395
|
+
*/
|
|
396
|
+
last_login_at?: string | null;
|
|
397
|
+
/**
|
|
398
|
+
* User full name
|
|
399
|
+
*/
|
|
400
|
+
name?: string;
|
|
401
|
+
/**
|
|
402
|
+
* User role in the organization: admin, billing, developer
|
|
403
|
+
*/
|
|
404
|
+
role?: string;
|
|
405
|
+
/**
|
|
406
|
+
* User status: active, invited, suspended, rejected
|
|
407
|
+
*/
|
|
408
|
+
status?: string;
|
|
409
|
+
/**
|
|
410
|
+
* When the user record was last updated
|
|
411
|
+
*/
|
|
412
|
+
updated_at?: string | null;
|
|
413
|
+
}
|
|
414
|
+
/**
|
|
415
|
+
* Error information
|
|
416
|
+
*/
|
|
417
|
+
interface Error {
|
|
418
|
+
/**
|
|
419
|
+
* Machine-readable error code (e.g., "RESOURCE_001")
|
|
420
|
+
*/
|
|
421
|
+
code?: string;
|
|
422
|
+
/**
|
|
423
|
+
* Additional validation error details (field-level errors)
|
|
424
|
+
*/
|
|
425
|
+
details?: {
|
|
426
|
+
[key: string]: Array<string>;
|
|
427
|
+
} | null;
|
|
428
|
+
/**
|
|
429
|
+
* URL to documentation about this error
|
|
430
|
+
*/
|
|
431
|
+
doc_url?: string | null;
|
|
432
|
+
/**
|
|
433
|
+
* Human-readable error message
|
|
434
|
+
*/
|
|
435
|
+
message?: string;
|
|
436
|
+
}
|
|
437
|
+
/**
|
|
438
|
+
* Request and response metadata
|
|
439
|
+
*/
|
|
440
|
+
interface Meta {
|
|
441
|
+
/**
|
|
442
|
+
* Unique identifier for this request (for tracing and support)
|
|
443
|
+
*/
|
|
444
|
+
request_id?: string;
|
|
445
|
+
/**
|
|
446
|
+
* Server timestamp when the response was generated
|
|
447
|
+
*/
|
|
448
|
+
timestamp?: string;
|
|
449
|
+
/**
|
|
450
|
+
* API version used for this request
|
|
451
|
+
*/
|
|
452
|
+
version?: string;
|
|
453
|
+
}
|
|
130
454
|
}
|
|
131
455
|
/**
|
|
132
456
|
* Standard API response envelope for all v3 endpoints
|
|
133
457
|
*/
|
|
134
|
-
export interface
|
|
458
|
+
export interface UserUpdateRoleResponse {
|
|
135
459
|
/**
|
|
136
|
-
*
|
|
460
|
+
* User response for v3 API
|
|
137
461
|
*/
|
|
138
|
-
data?:
|
|
462
|
+
data?: UserUpdateRoleResponse.Data | null;
|
|
139
463
|
/**
|
|
140
464
|
* Error information
|
|
141
465
|
*/
|
|
142
|
-
error?:
|
|
466
|
+
error?: UserUpdateRoleResponse.Error | null;
|
|
143
467
|
/**
|
|
144
468
|
* Request and response metadata
|
|
145
469
|
*/
|
|
146
|
-
meta?:
|
|
470
|
+
meta?: UserUpdateRoleResponse.Meta;
|
|
147
471
|
/**
|
|
148
472
|
* Indicates whether the request was successful
|
|
149
473
|
*/
|
|
150
474
|
success?: boolean;
|
|
151
475
|
}
|
|
152
|
-
export declare namespace
|
|
476
|
+
export declare namespace UserUpdateRoleResponse {
|
|
153
477
|
/**
|
|
154
|
-
*
|
|
478
|
+
* User response for v3 API
|
|
155
479
|
*/
|
|
156
480
|
interface Data {
|
|
157
481
|
/**
|
|
158
|
-
*
|
|
482
|
+
* User unique identifier
|
|
483
|
+
*/
|
|
484
|
+
id?: string;
|
|
485
|
+
/**
|
|
486
|
+
* When the user was added to the organization
|
|
487
|
+
*/
|
|
488
|
+
created_at?: string;
|
|
489
|
+
/**
|
|
490
|
+
* Which customer owns this — the key's own, or the profile named in x-profile-id.
|
|
491
|
+
* Says whose resource this is, which the resource's own id does not.
|
|
492
|
+
*/
|
|
493
|
+
customer_id?: string;
|
|
494
|
+
/**
|
|
495
|
+
* User email address
|
|
496
|
+
*/
|
|
497
|
+
email?: string;
|
|
498
|
+
/**
|
|
499
|
+
* When the user was invited
|
|
500
|
+
*/
|
|
501
|
+
invited_at?: string | null;
|
|
502
|
+
/**
|
|
503
|
+
* When the user last logged in
|
|
504
|
+
*/
|
|
505
|
+
last_login_at?: string | null;
|
|
506
|
+
/**
|
|
507
|
+
* User full name
|
|
508
|
+
*/
|
|
509
|
+
name?: string;
|
|
510
|
+
/**
|
|
511
|
+
* User role in the organization: admin, billing, developer
|
|
512
|
+
*/
|
|
513
|
+
role?: string;
|
|
514
|
+
/**
|
|
515
|
+
* User status: active, invited, suspended, rejected
|
|
516
|
+
*/
|
|
517
|
+
status?: string;
|
|
518
|
+
/**
|
|
519
|
+
* When the user record was last updated
|
|
520
|
+
*/
|
|
521
|
+
updated_at?: string | null;
|
|
522
|
+
}
|
|
523
|
+
/**
|
|
524
|
+
* Error information
|
|
525
|
+
*/
|
|
526
|
+
interface Error {
|
|
527
|
+
/**
|
|
528
|
+
* Machine-readable error code (e.g., "RESOURCE_001")
|
|
529
|
+
*/
|
|
530
|
+
code?: string;
|
|
531
|
+
/**
|
|
532
|
+
* Additional validation error details (field-level errors)
|
|
533
|
+
*/
|
|
534
|
+
details?: {
|
|
535
|
+
[key: string]: Array<string>;
|
|
536
|
+
} | null;
|
|
537
|
+
/**
|
|
538
|
+
* URL to documentation about this error
|
|
539
|
+
*/
|
|
540
|
+
doc_url?: string | null;
|
|
541
|
+
/**
|
|
542
|
+
* Human-readable error message
|
|
543
|
+
*/
|
|
544
|
+
message?: string;
|
|
545
|
+
}
|
|
546
|
+
/**
|
|
547
|
+
* Request and response metadata
|
|
548
|
+
*/
|
|
549
|
+
interface Meta {
|
|
550
|
+
/**
|
|
551
|
+
* Unique identifier for this request (for tracing and support)
|
|
552
|
+
*/
|
|
553
|
+
request_id?: string;
|
|
554
|
+
/**
|
|
555
|
+
* Server timestamp when the response was generated
|
|
556
|
+
*/
|
|
557
|
+
timestamp?: string;
|
|
558
|
+
/**
|
|
559
|
+
* API version used for this request
|
|
159
560
|
*/
|
|
160
|
-
|
|
561
|
+
version?: string;
|
|
161
562
|
}
|
|
162
563
|
}
|
|
163
564
|
export interface UserRetrieveParams {
|
|
@@ -242,6 +643,6 @@ export interface UserUpdateRoleParams {
|
|
|
242
643
|
'x-profile-id'?: string;
|
|
243
644
|
}
|
|
244
645
|
export declare namespace Users {
|
|
245
|
-
export { type
|
|
646
|
+
export { type UserRetrieveResponse as UserRetrieveResponse, type UserListResponse as UserListResponse, type UserInviteResponse as UserInviteResponse, type UserUpdateRoleResponse as UserUpdateRoleResponse, type UserRetrieveParams as UserRetrieveParams, type UserListParams as UserListParams, type UserInviteParams as UserInviteParams, type UserRemoveParams as UserRemoveParams, type UserUpdateRoleParams as UserUpdateRoleParams, };
|
|
246
647
|
}
|
|
247
648
|
//# sourceMappingURL=users.d.mts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"users.d.mts","sourceRoot":"","sources":["../src/resources/users.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,6BAAyB;AAC/C,OAAO,
|
|
1
|
+
{"version":3,"file":"users.d.mts","sourceRoot":"","sources":["../src/resources/users.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,6BAAyB;AAC/C,OAAO,EAAE,UAAU,EAAE,gCAA4B;AAEjD,OAAO,EAAE,cAAc,EAAE,wCAAoC;AAG7D;;;;GAIG;AACH,qBAAa,KAAM,SAAQ,WAAW;IACpC;;;;;;;;;;OAUG;IACH,QAAQ,CACN,MAAM,EAAE,MAAM,EACd,MAAM,GAAE,kBAAkB,GAAG,IAAI,GAAG,SAAc,EAClD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,oBAAoB,CAAC;IAWnC;;;;;;;;;OASG;IACH,IAAI,CACF,MAAM,GAAE,cAAc,GAAG,IAAI,GAAG,SAAc,EAC9C,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,gBAAgB,CAAC;IAW/B;;;;;;;;;OASG;IACH,MAAM,CAAC,MAAM,EAAE,gBAAgB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,kBAAkB,CAAC;IAe1F;;;;;;;;;;OAUG;IACH,MAAM,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,gBAAgB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,IAAI,CAAC;IAY5F;;;;;;;;;;OAUG;IACH,UAAU,CACR,MAAM,EAAE,MAAM,EACd,MAAM,EAAE,oBAAoB,EAC5B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,sBAAsB,CAAC;CActC;AAED;;GAEG;AACH,MAAM,WAAW,oBAAoB;IACnC;;OAEG;IACH,IAAI,CAAC,EAAE,oBAAoB,CAAC,IAAI,GAAG,IAAI,CAAC;IAExC;;OAEG;IACH,KAAK,CAAC,EAAE,oBAAoB,CAAC,KAAK,GAAG,IAAI,CAAC;IAE1C;;OAEG;IACH,IAAI,CAAC,EAAE,oBAAoB,CAAC,IAAI,CAAC;IAEjC;;OAEG;IACH,OAAO,CAAC,EAAE,OAAO,CAAC;CACnB;AAED,yBAAiB,oBAAoB,CAAC;IACpC;;OAEG;IACH,UAAiB,IAAI;QACnB;;WAEG;QACH,EAAE,CAAC,EAAE,MAAM,CAAC;QAEZ;;WAEG;QACH,UAAU,CAAC,EAAE,MAAM,CAAC;QAEpB;;;WAGG;QACH,WAAW,CAAC,EAAE,MAAM,CAAC;QAErB;;WAEG;QACH,KAAK,CAAC,EAAE,MAAM,CAAC;QAEf;;WAEG;QACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAE3B;;WAEG;QACH,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAE9B;;WAEG;QACH,IAAI,CAAC,EAAE,MAAM,CAAC;QAEd;;WAEG;QACH,IAAI,CAAC,EAAE,MAAM,CAAC;QAEd;;WAEG;QACH,MAAM,CAAC,EAAE,MAAM,CAAC;QAEhB;;WAEG;QACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;KAC5B;IAED;;OAEG;IACH,UAAiB,KAAK;QACpB;;WAEG;QACH,IAAI,CAAC,EAAE,MAAM,CAAC;QAEd;;WAEG;QACH,OAAO,CAAC,EAAE;YAAE,CAAC,GAAG,EAAE,MAAM,GAAG,KAAK,CAAC,MAAM,CAAC,CAAA;SAAE,GAAG,IAAI,CAAC;QAElD;;WAEG;QACH,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAExB;;WAEG;QACH,OAAO,CAAC,EAAE,MAAM,CAAC;KAClB;IAED;;OAEG;IACH,UAAiB,IAAI;QACnB;;WAEG;QACH,UAAU,CAAC,EAAE,MAAM,CAAC;QAEpB;;WAEG;QACH,SAAS,CAAC,EAAE,MAAM,CAAC;QAEnB;;WAEG;QACH,OAAO,CAAC,EAAE,MAAM,CAAC;KAClB;CACF;AAED;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC/B;;OAEG;IACH,IAAI,CAAC,EAAE,gBAAgB,CAAC,IAAI,GAAG,IAAI,CAAC;IAEpC;;OAEG;IACH,KAAK,CAAC,EAAE,gBAAgB,CAAC,KAAK,GAAG,IAAI,CAAC;IAEtC;;OAEG;IACH,IAAI,CAAC,EAAE,gBAAgB,CAAC,IAAI,CAAC;IAE7B;;OAEG;IACH,OAAO,CAAC,EAAE,OAAO,CAAC;CACnB;AAED,yBAAiB,gBAAgB,CAAC;IAChC;;OAEG;IACH,UAAiB,IAAI;QACnB;;WAEG;QACH,UAAU,CAAC,EAAE,IAAI,CAAC,UAAU,CAAC;QAE7B;;WAEG;QACH,KAAK,CAAC,EAAE,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;KAC1B;IAED,UAAiB,IAAI,CAAC;QACpB;;WAEG;QACH,UAAiB,UAAU;YACzB;;eAEG;YACH,OAAO,CAAC,EAAE,UAAU,CAAC,OAAO,GAAG,IAAI,CAAC;YAEpC;;eAEG;YACH,QAAQ,CAAC,EAAE,OAAO,CAAC;YAEnB;;eAEG;YACH,IAAI,CAAC,EAAE,MAAM,CAAC;YAEd;;eAEG;YACH,SAAS,CAAC,EAAE,MAAM,CAAC;YAEnB;;eAEG;YACH,WAAW,CAAC,EAAE,MAAM,CAAC;YAErB;;eAEG;YACH,WAAW,CAAC,EAAE,MAAM,CAAC;SACtB;QAED,UAAiB,UAAU,CAAC;YAC1B;;eAEG;YACH,UAAiB,OAAO;gBACtB;;mBAEG;gBACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;gBAEtB;;mBAEG;gBACH,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;aACxB;SACF;QAED;;WAEG;QACH,UAAiB,IAAI;YACnB;;eAEG;YACH,EAAE,CAAC,EAAE,MAAM,CAAC;YAEZ;;eAEG;YACH,UAAU,CAAC,EAAE,MAAM,CAAC;YAEpB;;;eAGG;YACH,WAAW,CAAC,EAAE,MAAM,CAAC;YAErB;;eAEG;YACH,KAAK,CAAC,EAAE,MAAM,CAAC;YAEf;;eAEG;YACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;YAE3B;;eAEG;YACH,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;YAE9B;;eAEG;YACH,IAAI,CAAC,EAAE,MAAM,CAAC;YAEd;;eAEG;YACH,IAAI,CAAC,EAAE,MAAM,CAAC;YAEd;;eAEG;YACH,MAAM,CAAC,EAAE,MAAM,CAAC;YAEhB;;eAEG;YACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;SAC5B;KACF;IAED;;OAEG;IACH,UAAiB,KAAK;QACpB;;WAEG;QACH,IAAI,CAAC,EAAE,MAAM,CAAC;QAEd;;WAEG;QACH,OAAO,CAAC,EAAE;YAAE,CAAC,GAAG,EAAE,MAAM,GAAG,KAAK,CAAC,MAAM,CAAC,CAAA;SAAE,GAAG,IAAI,CAAC;QAElD;;WAEG;QACH,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAExB;;WAEG;QACH,OAAO,CAAC,EAAE,MAAM,CAAC;KAClB;IAED;;OAEG;IACH,UAAiB,IAAI;QACnB;;WAEG;QACH,UAAU,CAAC,EAAE,MAAM,CAAC;QAEpB;;WAEG;QACH,SAAS,CAAC,EAAE,MAAM,CAAC;QAEnB;;WAEG;QACH,OAAO,CAAC,EAAE,MAAM,CAAC;KAClB;CACF;AAED;;GAEG;AACH,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,IAAI,CAAC,EAAE,kBAAkB,CAAC,IAAI,GAAG,IAAI,CAAC;IAEtC;;OAEG;IACH,KAAK,CAAC,EAAE,kBAAkB,CAAC,KAAK,GAAG,IAAI,CAAC;IAExC;;OAEG;IACH,IAAI,CAAC,EAAE,kBAAkB,CAAC,IAAI,CAAC;IAE/B;;OAEG;IACH,OAAO,CAAC,EAAE,OAAO,CAAC;CACnB;AAED,yBAAiB,kBAAkB,CAAC;IAClC;;OAEG;IACH,UAAiB,IAAI;QACnB;;WAEG;QACH,EAAE,CAAC,EAAE,MAAM,CAAC;QAEZ;;WAEG;QACH,UAAU,CAAC,EAAE,MAAM,CAAC;QAEpB;;;WAGG;QACH,WAAW,CAAC,EAAE,MAAM,CAAC;QAErB;;WAEG;QACH,KAAK,CAAC,EAAE,MAAM,CAAC;QAEf;;WAEG;QACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAE3B;;WAEG;QACH,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAE9B;;WAEG;QACH,IAAI,CAAC,EAAE,MAAM,CAAC;QAEd;;WAEG;QACH,IAAI,CAAC,EAAE,MAAM,CAAC;QAEd;;WAEG;QACH,MAAM,CAAC,EAAE,MAAM,CAAC;QAEhB;;WAEG;QACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;KAC5B;IAED;;OAEG;IACH,UAAiB,KAAK;QACpB;;WAEG;QACH,IAAI,CAAC,EAAE,MAAM,CAAC;QAEd;;WAEG;QACH,OAAO,CAAC,EAAE;YAAE,CAAC,GAAG,EAAE,MAAM,GAAG,KAAK,CAAC,MAAM,CAAC,CAAA;SAAE,GAAG,IAAI,CAAC;QAElD;;WAEG;QACH,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAExB;;WAEG;QACH,OAAO,CAAC,EAAE,MAAM,CAAC;KAClB;IAED;;OAEG;IACH,UAAiB,IAAI;QACnB;;WAEG;QACH,UAAU,CAAC,EAAE,MAAM,CAAC;QAEpB;;WAEG;QACH,SAAS,CAAC,EAAE,MAAM,CAAC;QAEnB;;WAEG;QACH,OAAO,CAAC,EAAE,MAAM,CAAC;KAClB;CACF;AAED;;GAEG;AACH,MAAM,WAAW,sBAAsB;IACrC;;OAEG;IACH,IAAI,CAAC,EAAE,sBAAsB,CAAC,IAAI,GAAG,IAAI,CAAC;IAE1C;;OAEG;IACH,KAAK,CAAC,EAAE,sBAAsB,CAAC,KAAK,GAAG,IAAI,CAAC;IAE5C;;OAEG;IACH,IAAI,CAAC,EAAE,sBAAsB,CAAC,IAAI,CAAC;IAEnC;;OAEG;IACH,OAAO,CAAC,EAAE,OAAO,CAAC;CACnB;AAED,yBAAiB,sBAAsB,CAAC;IACtC;;OAEG;IACH,UAAiB,IAAI;QACnB;;WAEG;QACH,EAAE,CAAC,EAAE,MAAM,CAAC;QAEZ;;WAEG;QACH,UAAU,CAAC,EAAE,MAAM,CAAC;QAEpB;;;WAGG;QACH,WAAW,CAAC,EAAE,MAAM,CAAC;QAErB;;WAEG;QACH,KAAK,CAAC,EAAE,MAAM,CAAC;QAEf;;WAEG;QACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAE3B;;WAEG;QACH,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAE9B;;WAEG;QACH,IAAI,CAAC,EAAE,MAAM,CAAC;QAEd;;WAEG;QACH,IAAI,CAAC,EAAE,MAAM,CAAC;QAEd;;WAEG;QACH,MAAM,CAAC,EAAE,MAAM,CAAC;QAEhB;;WAEG;QACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;KAC5B;IAED;;OAEG;IACH,UAAiB,KAAK;QACpB;;WAEG;QACH,IAAI,CAAC,EAAE,MAAM,CAAC;QAEd;;WAEG;QACH,OAAO,CAAC,EAAE;YAAE,CAAC,GAAG,EAAE,MAAM,GAAG,KAAK,CAAC,MAAM,CAAC,CAAA;SAAE,GAAG,IAAI,CAAC;QAElD;;WAEG;QACH,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAExB;;WAEG;QACH,OAAO,CAAC,EAAE,MAAM,CAAC;KAClB;IAED;;OAEG;IACH,UAAiB,IAAI;QACnB;;WAEG;QACH,UAAU,CAAC,EAAE,MAAM,CAAC;QAEpB;;WAEG;QACH,SAAS,CAAC,EAAE,MAAM,CAAC;QAEnB;;WAEG;QACH,OAAO,CAAC,EAAE,MAAM,CAAC;KAClB;CACF;AAED,MAAM,WAAW,kBAAkB;IACjC;;;OAGG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;CACzB;AAED,MAAM,WAAW,cAAc;IAC7B;;;OAGG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;CACzB;AAED,MAAM,WAAW,gBAAgB;IAC/B;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;;OAGG;IACH,OAAO,CAAC,EAAE,OAAO,CAAC;IAElB;;;;OAIG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAE3B;;;;OAIG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;CACzB;AAED,MAAM,WAAW,gBAAgB;IAC/B;;;OAGG;IACH,OAAO,CAAC,EAAE,OAAO,CAAC;IAElB;;;;OAIG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;CACzB;AAED,MAAM,WAAW,oBAAoB;IACnC;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;;OAGG;IACH,OAAO,CAAC,EAAE,OAAO,CAAC;IAElB;;;;OAIG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAE3B;;;;OAIG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;CACzB;AAED,MAAM,CAAC,OAAO,WAAW,KAAK,CAAC;IAC7B,OAAO,EACL,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,cAAc,IAAI,cAAc,EACrC,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,oBAAoB,IAAI,oBAAoB,GAClD,CAAC;CACH"}
|