@seamapi/http 2.23.6 → 2.24.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/README.md +5 -0
- package/lib/request-parameters.d.ts +1 -1
- package/lib/request-parameters.js +3 -3
- package/lib/request-parameters.js.map +1 -1
- package/lib/resolve-action-attempt.d.ts +2 -0
- package/lib/resolve-action-attempt.js +25 -27
- package/lib/resolve-action-attempt.js.map +1 -1
- package/lib/routes/access-codes/access-codes.d.ts +5 -5
- package/lib/routes/access-codes/access-codes.js +20 -1
- package/lib/routes/access-codes/access-codes.js.map +1 -1
- package/lib/routes/access-codes/simulate/simulate.d.ts +2 -2
- package/lib/routes/access-codes/simulate/simulate.js +2 -1
- package/lib/routes/access-codes/simulate/simulate.js.map +1 -1
- package/lib/routes/access-codes/unmanaged/unmanaged.d.ts +4 -4
- package/lib/routes/access-codes/unmanaged/unmanaged.js +6 -1
- package/lib/routes/access-codes/unmanaged/unmanaged.js.map +1 -1
- package/lib/routes/access-grants/access-grants.d.ts +6 -6
- package/lib/routes/access-grants/access-grants.js +19 -1
- package/lib/routes/access-grants/access-grants.js.map +1 -1
- package/lib/routes/access-grants/unmanaged/unmanaged.d.ts +3 -3
- package/lib/routes/access-grants/unmanaged/unmanaged.js +4 -1
- package/lib/routes/access-grants/unmanaged/unmanaged.js.map +1 -1
- package/lib/routes/access-methods/access-methods.d.ts +5 -5
- package/lib/routes/access-methods/access-methods.js +22 -4
- package/lib/routes/access-methods/access-methods.js.map +1 -1
- package/lib/routes/access-methods/unmanaged/unmanaged.d.ts +2 -2
- package/lib/routes/access-methods/unmanaged/unmanaged.js +3 -1
- package/lib/routes/access-methods/unmanaged/unmanaged.js.map +1 -1
- package/lib/routes/acs/access-groups/access-groups.d.ts +2 -2
- package/lib/routes/acs/access-groups/access-groups.js +8 -1
- package/lib/routes/acs/access-groups/access-groups.js.map +1 -1
- package/lib/routes/acs/acs.d.ts +2 -2
- package/lib/routes/acs/acs.js.map +1 -1
- package/lib/routes/acs/credentials/credentials.d.ts +3 -3
- package/lib/routes/acs/credentials/credentials.js +9 -1
- package/lib/routes/acs/credentials/credentials.js.map +1 -1
- package/lib/routes/acs/encoders/encoders.d.ts +3 -3
- package/lib/routes/acs/encoders/encoders.js +9 -4
- package/lib/routes/acs/encoders/encoders.js.map +1 -1
- package/lib/routes/acs/encoders/simulate/simulate.d.ts +2 -2
- package/lib/routes/acs/encoders/simulate/simulate.js +5 -1
- package/lib/routes/acs/encoders/simulate/simulate.js.map +1 -1
- package/lib/routes/acs/entrances/entrances.d.ts +3 -3
- package/lib/routes/acs/entrances/entrances.js +7 -2
- package/lib/routes/acs/entrances/entrances.js.map +1 -1
- package/lib/routes/acs/systems/systems.d.ts +2 -2
- package/lib/routes/acs/systems/systems.js +5 -1
- package/lib/routes/acs/systems/systems.js.map +1 -1
- package/lib/routes/acs/users/users.d.ts +10 -10
- package/lib/routes/acs/users/users.js +46 -1
- package/lib/routes/acs/users/users.js.map +1 -1
- package/lib/routes/action-attempts/action-attempts.d.ts +3 -3
- package/lib/routes/action-attempts/action-attempts.js +4 -2
- package/lib/routes/action-attempts/action-attempts.js.map +1 -1
- package/lib/routes/client-sessions/client-sessions.d.ts +3 -3
- package/lib/routes/client-sessions/client-sessions.js +15 -1
- package/lib/routes/client-sessions/client-sessions.js.map +1 -1
- package/lib/routes/connect-webviews/connect-webviews.d.ts +3 -3
- package/lib/routes/connect-webviews/connect-webviews.js +5 -1
- package/lib/routes/connect-webviews/connect-webviews.js.map +1 -1
- package/lib/routes/connected-accounts/connected-accounts.d.ts +4 -4
- package/lib/routes/connected-accounts/connected-accounts.js +6 -1
- package/lib/routes/connected-accounts/connected-accounts.js.map +1 -1
- package/lib/routes/connected-accounts/simulate/simulate.d.ts +2 -2
- package/lib/routes/connected-accounts/simulate/simulate.js +2 -1
- package/lib/routes/connected-accounts/simulate/simulate.js.map +1 -1
- package/lib/routes/customers/customers.d.ts +2 -2
- package/lib/routes/customers/customers.js +4 -1
- package/lib/routes/customers/customers.js.map +1 -1
- package/lib/routes/devices/devices.d.ts +4 -4
- package/lib/routes/devices/devices.js +6 -1
- package/lib/routes/devices/devices.js.map +1 -1
- package/lib/routes/devices/simulate/simulate.d.ts +2 -2
- package/lib/routes/devices/simulate/simulate.js +7 -1
- package/lib/routes/devices/simulate/simulate.js.map +1 -1
- package/lib/routes/devices/unmanaged/unmanaged.d.ts +4 -4
- package/lib/routes/devices/unmanaged/unmanaged.js +4 -1
- package/lib/routes/devices/unmanaged/unmanaged.js.map +1 -1
- package/lib/routes/events/events.d.ts +4 -4
- package/lib/routes/events/events.js +31 -1
- package/lib/routes/events/events.js.map +1 -1
- package/lib/routes/instant-keys/instant-keys.d.ts +3 -3
- package/lib/routes/instant-keys/instant-keys.js +4 -1
- package/lib/routes/instant-keys/instant-keys.js.map +1 -1
- package/lib/routes/locks/locks.d.ts +3 -3
- package/lib/routes/locks/locks.js +9 -4
- package/lib/routes/locks/locks.js.map +1 -1
- package/lib/routes/locks/simulate/simulate.d.ts +2 -2
- package/lib/routes/locks/simulate/simulate.js +5 -3
- package/lib/routes/locks/simulate/simulate.js.map +1 -1
- package/lib/routes/noise-sensors/noise-sensors.d.ts +2 -2
- package/lib/routes/noise-sensors/noise-sensors.js +2 -1
- package/lib/routes/noise-sensors/noise-sensors.js.map +1 -1
- package/lib/routes/noise-sensors/noise-thresholds/noise-thresholds.d.ts +2 -2
- package/lib/routes/noise-sensors/noise-thresholds/noise-thresholds.js +6 -1
- package/lib/routes/noise-sensors/noise-thresholds/noise-thresholds.js.map +1 -1
- package/lib/routes/noise-sensors/simulate/simulate.d.ts +2 -2
- package/lib/routes/noise-sensors/simulate/simulate.js +2 -1
- package/lib/routes/noise-sensors/simulate/simulate.js.map +1 -1
- package/lib/routes/phones/phones.d.ts +2 -2
- package/lib/routes/phones/phones.js +4 -1
- package/lib/routes/phones/phones.js.map +1 -1
- package/lib/routes/phones/simulate/simulate.d.ts +2 -2
- package/lib/routes/phones/simulate/simulate.js +2 -1
- package/lib/routes/phones/simulate/simulate.js.map +1 -1
- package/lib/routes/seam-http-endpoints.d.ts +2 -2
- package/lib/routes/seam-http-endpoints.js.map +1 -1
- package/lib/routes/seam-http.d.ts +2 -2
- package/lib/routes/seam-http.js.map +1 -1
- package/lib/routes/spaces/spaces.d.ts +5 -5
- package/lib/routes/spaces/spaces.js +18 -1
- package/lib/routes/spaces/spaces.js.map +1 -1
- package/lib/routes/thermostats/daily-programs/daily-programs.d.ts +2 -2
- package/lib/routes/thermostats/daily-programs/daily-programs.js +5 -2
- package/lib/routes/thermostats/daily-programs/daily-programs.js.map +1 -1
- package/lib/routes/thermostats/schedules/schedules.d.ts +2 -2
- package/lib/routes/thermostats/schedules/schedules.js +6 -1
- package/lib/routes/thermostats/schedules/schedules.js.map +1 -1
- package/lib/routes/thermostats/simulate/simulate.d.ts +2 -2
- package/lib/routes/thermostats/simulate/simulate.js +3 -1
- package/lib/routes/thermostats/simulate/simulate.js.map +1 -1
- package/lib/routes/thermostats/thermostats.d.ts +2 -2
- package/lib/routes/thermostats/thermostats.js +23 -9
- package/lib/routes/thermostats/thermostats.js.map +1 -1
- package/lib/routes/user-identities/unmanaged/unmanaged.d.ts +3 -3
- package/lib/routes/user-identities/unmanaged/unmanaged.js +4 -1
- package/lib/routes/user-identities/unmanaged/unmanaged.js.map +1 -1
- package/lib/routes/user-identities/user-identities.d.ts +5 -5
- package/lib/routes/user-identities/user-identities.js +21 -1
- package/lib/routes/user-identities/user-identities.js.map +1 -1
- package/lib/routes/webhooks/webhooks.d.ts +2 -2
- package/lib/routes/webhooks/webhooks.js +6 -1
- package/lib/routes/webhooks/webhooks.js.map +1 -1
- package/lib/routes/workspaces/workspaces.d.ts +2 -2
- package/lib/routes/workspaces/workspaces.js +7 -2
- package/lib/routes/workspaces/workspaces.js.map +1 -1
- package/lib/seam-http-request.d.ts +8 -3
- package/lib/seam-http-request.js +15 -6
- package/lib/seam-http-request.js.map +1 -1
- package/lib/seam-paginator.d.ts +2 -2
- package/lib/seam-paginator.js +12 -8
- package/lib/seam-paginator.js.map +1 -1
- package/lib/version.d.ts +1 -1
- package/lib/version.js +1 -1
- package/package.json +1 -1
- package/src/lib/request-parameters.ts +5 -2
- package/src/lib/resolve-action-attempt.ts +34 -37
- package/src/lib/routes/access-codes/access-codes.ts +94 -59
- package/src/lib/routes/access-codes/simulate/simulate.ts +6 -2
- package/src/lib/routes/access-codes/unmanaged/unmanaged.ts +28 -17
- package/src/lib/routes/access-grants/access-grants.ts +101 -71
- package/src/lib/routes/access-grants/unmanaged/unmanaged.ts +9 -3
- package/src/lib/routes/access-methods/access-methods.ts +98 -63
- package/src/lib/routes/access-methods/unmanaged/unmanaged.ts +7 -2
- package/src/lib/routes/acs/access-groups/access-groups.ts +12 -2
- package/src/lib/routes/acs/acs.ts +2 -2
- package/src/lib/routes/acs/credentials/credentials.ts +14 -3
- package/src/lib/routes/acs/encoders/encoders.ts +26 -15
- package/src/lib/routes/acs/encoders/simulate/simulate.ts +9 -2
- package/src/lib/routes/acs/entrances/entrances.ts +16 -7
- package/src/lib/routes/acs/systems/systems.ts +9 -2
- package/src/lib/routes/acs/users/users.ts +214 -137
- package/src/lib/routes/action-attempts/action-attempts.ts +13 -7
- package/src/lib/routes/client-sessions/client-sessions.ts +54 -29
- package/src/lib/routes/connect-webviews/connect-webviews.ts +10 -3
- package/src/lib/routes/connected-accounts/connected-accounts.ts +24 -13
- package/src/lib/routes/connected-accounts/simulate/simulate.ts +6 -2
- package/src/lib/routes/customers/customers.ts +8 -2
- package/src/lib/routes/devices/devices.ts +27 -13
- package/src/lib/routes/devices/simulate/simulate.ts +11 -2
- package/src/lib/routes/devices/unmanaged/unmanaged.ts +22 -13
- package/src/lib/routes/events/events.ts +427 -362
- package/src/lib/routes/instant-keys/instant-keys.ts +21 -12
- package/src/lib/routes/locks/locks.ts +38 -24
- package/src/lib/routes/locks/simulate/simulate.ts +17 -10
- package/src/lib/routes/noise-sensors/noise-sensors.ts +6 -2
- package/src/lib/routes/noise-sensors/noise-thresholds/noise-thresholds.ts +10 -2
- package/src/lib/routes/noise-sensors/simulate/simulate.ts +6 -2
- package/src/lib/routes/phones/phones.ts +8 -2
- package/src/lib/routes/phones/simulate/simulate.ts +6 -2
- package/src/lib/routes/seam-http-endpoints.ts +2 -2
- package/src/lib/routes/seam-http.ts +2 -2
- package/src/lib/routes/spaces/spaces.ts +73 -44
- package/src/lib/routes/thermostats/daily-programs/daily-programs.ts +13 -6
- package/src/lib/routes/thermostats/schedules/schedules.ts +10 -2
- package/src/lib/routes/thermostats/simulate/simulate.ts +7 -2
- package/src/lib/routes/thermostats/thermostats.ts +59 -34
- package/src/lib/routes/user-identities/unmanaged/unmanaged.ts +9 -3
- package/src/lib/routes/user-identities/user-identities.ts +60 -28
- package/src/lib/routes/webhooks/webhooks.ts +10 -2
- package/src/lib/routes/workspaces/workspaces.ts +15 -6
- package/src/lib/seam-http-request.ts +30 -8
- package/src/lib/seam-paginator.ts +22 -12
- package/src/lib/version.ts +1 -1
|
@@ -36,7 +36,10 @@ import type { Device } from 'lib/resources/device.js'
|
|
|
36
36
|
import type { InstantKey } from 'lib/resources/instant-key.js'
|
|
37
37
|
import type { UserIdentity } from 'lib/resources/user-identity.js'
|
|
38
38
|
import { SeamHttpClientSessions } from 'lib/routes/client-sessions/index.js'
|
|
39
|
-
import {
|
|
39
|
+
import {
|
|
40
|
+
SeamHttpRequest,
|
|
41
|
+
type SeamPaginatedRequest,
|
|
42
|
+
} from 'lib/seam-http-request.js'
|
|
40
43
|
import { SeamPaginator } from 'lib/seam-paginator.js'
|
|
41
44
|
|
|
42
45
|
import { SeamHttpUserIdentitiesUnmanaged } from './unmanaged/index.js'
|
|
@@ -142,7 +145,7 @@ export class SeamHttpUserIdentities {
|
|
|
142
145
|
}
|
|
143
146
|
|
|
144
147
|
createPaginator<const TResponse, const TResponseKey extends keyof TResponse>(
|
|
145
|
-
request:
|
|
148
|
+
request: SeamPaginatedRequest<TResponse, TResponseKey>,
|
|
146
149
|
): SeamPaginator<TResponse, TResponseKey> {
|
|
147
150
|
return new SeamPaginator<TResponse, TResponseKey>(this, request)
|
|
148
151
|
}
|
|
@@ -191,6 +194,7 @@ export class SeamHttpUserIdentities {
|
|
|
191
194
|
parameters,
|
|
192
195
|
hasRequiredParameters: true,
|
|
193
196
|
requiredParameterNames: ['acs_user_id'],
|
|
197
|
+
atLeastOneParameterNames: [],
|
|
194
198
|
responseKey: undefined,
|
|
195
199
|
options,
|
|
196
200
|
})
|
|
@@ -210,6 +214,7 @@ export class SeamHttpUserIdentities {
|
|
|
210
214
|
parameters,
|
|
211
215
|
hasRequiredParameters: false,
|
|
212
216
|
requiredParameterNames: [],
|
|
217
|
+
atLeastOneParameterNames: [],
|
|
213
218
|
responseKey: 'user_identity',
|
|
214
219
|
options,
|
|
215
220
|
})
|
|
@@ -229,6 +234,7 @@ export class SeamHttpUserIdentities {
|
|
|
229
234
|
parameters,
|
|
230
235
|
hasRequiredParameters: true,
|
|
231
236
|
requiredParameterNames: ['user_identity_id'],
|
|
237
|
+
atLeastOneParameterNames: [],
|
|
232
238
|
responseKey: undefined,
|
|
233
239
|
options,
|
|
234
240
|
})
|
|
@@ -248,6 +254,7 @@ export class SeamHttpUserIdentities {
|
|
|
248
254
|
parameters,
|
|
249
255
|
hasRequiredParameters: true,
|
|
250
256
|
requiredParameterNames: ['user_identity_id'],
|
|
257
|
+
atLeastOneParameterNames: [],
|
|
251
258
|
responseKey: 'instant_key',
|
|
252
259
|
options,
|
|
253
260
|
})
|
|
@@ -267,6 +274,7 @@ export class SeamHttpUserIdentities {
|
|
|
267
274
|
parameters,
|
|
268
275
|
hasRequiredParameters: true,
|
|
269
276
|
requiredParameterNames: [],
|
|
277
|
+
atLeastOneParameterNames: ['user_identity_id', 'user_identity_key'],
|
|
270
278
|
responseKey: 'user_identity',
|
|
271
279
|
options,
|
|
272
280
|
})
|
|
@@ -286,6 +294,7 @@ export class SeamHttpUserIdentities {
|
|
|
286
294
|
parameters,
|
|
287
295
|
hasRequiredParameters: true,
|
|
288
296
|
requiredParameterNames: ['device_id', 'user_identity_id'],
|
|
297
|
+
atLeastOneParameterNames: [],
|
|
289
298
|
responseKey: undefined,
|
|
290
299
|
options,
|
|
291
300
|
})
|
|
@@ -305,6 +314,7 @@ export class SeamHttpUserIdentities {
|
|
|
305
314
|
parameters,
|
|
306
315
|
hasRequiredParameters: false,
|
|
307
316
|
requiredParameterNames: [],
|
|
317
|
+
atLeastOneParameterNames: [],
|
|
308
318
|
responseKey: 'user_identities',
|
|
309
319
|
hasPagination: true,
|
|
310
320
|
options,
|
|
@@ -325,6 +335,7 @@ export class SeamHttpUserIdentities {
|
|
|
325
335
|
parameters,
|
|
326
336
|
hasRequiredParameters: true,
|
|
327
337
|
requiredParameterNames: ['user_identity_id'],
|
|
338
|
+
atLeastOneParameterNames: [],
|
|
328
339
|
responseKey: 'devices',
|
|
329
340
|
options,
|
|
330
341
|
})
|
|
@@ -344,6 +355,7 @@ export class SeamHttpUserIdentities {
|
|
|
344
355
|
parameters,
|
|
345
356
|
hasRequiredParameters: true,
|
|
346
357
|
requiredParameterNames: ['user_identity_id'],
|
|
358
|
+
atLeastOneParameterNames: [],
|
|
347
359
|
responseKey: 'acs_entrances',
|
|
348
360
|
options,
|
|
349
361
|
})
|
|
@@ -363,6 +375,7 @@ export class SeamHttpUserIdentities {
|
|
|
363
375
|
parameters,
|
|
364
376
|
hasRequiredParameters: true,
|
|
365
377
|
requiredParameterNames: ['user_identity_id'],
|
|
378
|
+
atLeastOneParameterNames: [],
|
|
366
379
|
responseKey: 'acs_systems',
|
|
367
380
|
options,
|
|
368
381
|
})
|
|
@@ -382,6 +395,7 @@ export class SeamHttpUserIdentities {
|
|
|
382
395
|
parameters,
|
|
383
396
|
hasRequiredParameters: true,
|
|
384
397
|
requiredParameterNames: ['user_identity_id'],
|
|
398
|
+
atLeastOneParameterNames: [],
|
|
385
399
|
responseKey: 'acs_users',
|
|
386
400
|
options,
|
|
387
401
|
})
|
|
@@ -407,6 +421,12 @@ export class SeamHttpUserIdentities {
|
|
|
407
421
|
parameters,
|
|
408
422
|
hasRequiredParameters: true,
|
|
409
423
|
requiredParameterNames: [],
|
|
424
|
+
atLeastOneParameterNames: [
|
|
425
|
+
'merged_user_identity_ids',
|
|
426
|
+
'user_identity_id',
|
|
427
|
+
'merged_user_identity_keys',
|
|
428
|
+
'user_identity_key',
|
|
429
|
+
],
|
|
410
430
|
responseKey: undefined,
|
|
411
431
|
options,
|
|
412
432
|
})
|
|
@@ -426,6 +446,7 @@ export class SeamHttpUserIdentities {
|
|
|
426
446
|
parameters,
|
|
427
447
|
hasRequiredParameters: true,
|
|
428
448
|
requiredParameterNames: ['acs_user_id', 'user_identity_id'],
|
|
449
|
+
atLeastOneParameterNames: [],
|
|
429
450
|
responseKey: undefined,
|
|
430
451
|
options,
|
|
431
452
|
})
|
|
@@ -445,6 +466,7 @@ export class SeamHttpUserIdentities {
|
|
|
445
466
|
parameters,
|
|
446
467
|
hasRequiredParameters: true,
|
|
447
468
|
requiredParameterNames: ['device_id', 'user_identity_id'],
|
|
469
|
+
atLeastOneParameterNames: [],
|
|
448
470
|
responseKey: undefined,
|
|
449
471
|
options,
|
|
450
472
|
})
|
|
@@ -464,6 +486,7 @@ export class SeamHttpUserIdentities {
|
|
|
464
486
|
parameters,
|
|
465
487
|
hasRequiredParameters: true,
|
|
466
488
|
requiredParameterNames: ['user_identity_id'],
|
|
489
|
+
atLeastOneParameterNames: [],
|
|
467
490
|
responseKey: undefined,
|
|
468
491
|
options,
|
|
469
492
|
})
|
|
@@ -572,14 +595,17 @@ export type UserIdentitiesGenerateInstantKeyRequest = SeamHttpRequest<
|
|
|
572
595
|
|
|
573
596
|
export interface UserIdentitiesGenerateInstantKeyOptions {}
|
|
574
597
|
|
|
575
|
-
export type UserIdentitiesGetParameters = RequireAtLeastOne<
|
|
576
|
-
|
|
577
|
-
|
|
578
|
-
|
|
579
|
-
|
|
598
|
+
export type UserIdentitiesGetParameters = RequireAtLeastOne<
|
|
599
|
+
{
|
|
600
|
+
/**
|
|
601
|
+
* ID of the user identity that you want to get.
|
|
602
|
+
*/
|
|
603
|
+
user_identity_id?: string | undefined
|
|
580
604
|
|
|
581
|
-
|
|
582
|
-
}
|
|
605
|
+
user_identity_key?: string | undefined
|
|
606
|
+
},
|
|
607
|
+
'user_identity_id' | 'user_identity_key'
|
|
608
|
+
>
|
|
583
609
|
|
|
584
610
|
/**
|
|
585
611
|
* @deprecated Use UserIdentitiesGetRequest instead.
|
|
@@ -651,7 +677,7 @@ export type UserIdentitiesListResponse = {
|
|
|
651
677
|
user_identities: Array<UserIdentity>
|
|
652
678
|
}
|
|
653
679
|
|
|
654
|
-
export type UserIdentitiesListRequest =
|
|
680
|
+
export type UserIdentitiesListRequest = SeamPaginatedRequest<
|
|
655
681
|
UserIdentitiesListResponse,
|
|
656
682
|
'user_identities'
|
|
657
683
|
>
|
|
@@ -740,24 +766,30 @@ export type UserIdentitiesListAcsUsersRequest = SeamHttpRequest<
|
|
|
740
766
|
|
|
741
767
|
export interface UserIdentitiesListAcsUsersOptions {}
|
|
742
768
|
|
|
743
|
-
export type UserIdentitiesMergeParameters = RequireAtLeastOne<
|
|
744
|
-
|
|
745
|
-
|
|
746
|
-
|
|
747
|
-
|
|
748
|
-
|
|
749
|
-
|
|
750
|
-
|
|
751
|
-
|
|
752
|
-
|
|
753
|
-
|
|
754
|
-
|
|
755
|
-
|
|
756
|
-
|
|
757
|
-
|
|
758
|
-
|
|
759
|
-
|
|
760
|
-
|
|
769
|
+
export type UserIdentitiesMergeParameters = RequireAtLeastOne<
|
|
770
|
+
{
|
|
771
|
+
/**
|
|
772
|
+
* IDs of the user identities to merge into the primary user identity. These user identities are deleted.
|
|
773
|
+
*/
|
|
774
|
+
merged_user_identity_ids?: Array<string> | undefined
|
|
775
|
+
/**
|
|
776
|
+
* ID of the primary user identity to keep.
|
|
777
|
+
*/
|
|
778
|
+
user_identity_id?: string | undefined
|
|
779
|
+
/**
|
|
780
|
+
* Keys of the user identities to merge into the primary user identity. These user identities are deleted.
|
|
781
|
+
*/
|
|
782
|
+
merged_user_identity_keys?: Array<string> | undefined
|
|
783
|
+
/**
|
|
784
|
+
* Key of the primary user identity to keep.
|
|
785
|
+
*/
|
|
786
|
+
user_identity_key?: string | undefined
|
|
787
|
+
},
|
|
788
|
+
| 'merged_user_identity_ids'
|
|
789
|
+
| 'user_identity_id'
|
|
790
|
+
| 'merged_user_identity_keys'
|
|
791
|
+
| 'user_identity_key'
|
|
792
|
+
>
|
|
761
793
|
|
|
762
794
|
/**
|
|
763
795
|
* @deprecated Use UserIdentitiesMergeRequest instead.
|
|
@@ -30,7 +30,10 @@ import {
|
|
|
30
30
|
} from 'lib/parse-options.js'
|
|
31
31
|
import type { Webhook } from 'lib/resources/webhook.js'
|
|
32
32
|
import { SeamHttpClientSessions } from 'lib/routes/client-sessions/index.js'
|
|
33
|
-
import {
|
|
33
|
+
import {
|
|
34
|
+
SeamHttpRequest,
|
|
35
|
+
type SeamPaginatedRequest,
|
|
36
|
+
} from 'lib/seam-http-request.js'
|
|
34
37
|
import { SeamPaginator } from 'lib/seam-paginator.js'
|
|
35
38
|
|
|
36
39
|
export class SeamHttpWebhooks {
|
|
@@ -134,7 +137,7 @@ export class SeamHttpWebhooks {
|
|
|
134
137
|
}
|
|
135
138
|
|
|
136
139
|
createPaginator<const TResponse, const TResponseKey extends keyof TResponse>(
|
|
137
|
-
request:
|
|
140
|
+
request: SeamPaginatedRequest<TResponse, TResponseKey>,
|
|
138
141
|
): SeamPaginator<TResponse, TResponseKey> {
|
|
139
142
|
return new SeamPaginator<TResponse, TResponseKey>(this, request)
|
|
140
143
|
}
|
|
@@ -172,6 +175,7 @@ export class SeamHttpWebhooks {
|
|
|
172
175
|
parameters,
|
|
173
176
|
hasRequiredParameters: true,
|
|
174
177
|
requiredParameterNames: ['url'],
|
|
178
|
+
atLeastOneParameterNames: [],
|
|
175
179
|
responseKey: 'webhook',
|
|
176
180
|
options,
|
|
177
181
|
})
|
|
@@ -191,6 +195,7 @@ export class SeamHttpWebhooks {
|
|
|
191
195
|
parameters,
|
|
192
196
|
hasRequiredParameters: true,
|
|
193
197
|
requiredParameterNames: ['webhook_id'],
|
|
198
|
+
atLeastOneParameterNames: [],
|
|
194
199
|
responseKey: undefined,
|
|
195
200
|
options,
|
|
196
201
|
})
|
|
@@ -210,6 +215,7 @@ export class SeamHttpWebhooks {
|
|
|
210
215
|
parameters,
|
|
211
216
|
hasRequiredParameters: true,
|
|
212
217
|
requiredParameterNames: ['webhook_id'],
|
|
218
|
+
atLeastOneParameterNames: [],
|
|
213
219
|
responseKey: 'webhook',
|
|
214
220
|
options,
|
|
215
221
|
})
|
|
@@ -229,6 +235,7 @@ export class SeamHttpWebhooks {
|
|
|
229
235
|
parameters,
|
|
230
236
|
hasRequiredParameters: false,
|
|
231
237
|
requiredParameterNames: [],
|
|
238
|
+
atLeastOneParameterNames: [],
|
|
232
239
|
responseKey: 'webhooks',
|
|
233
240
|
options,
|
|
234
241
|
})
|
|
@@ -248,6 +255,7 @@ export class SeamHttpWebhooks {
|
|
|
248
255
|
parameters,
|
|
249
256
|
hasRequiredParameters: true,
|
|
250
257
|
requiredParameterNames: ['event_types', 'webhook_id'],
|
|
258
|
+
atLeastOneParameterNames: [],
|
|
251
259
|
responseKey: undefined,
|
|
252
260
|
options,
|
|
253
261
|
})
|
|
@@ -32,7 +32,10 @@ import type { ActionAttempt } from 'lib/resources/action-attempt.js'
|
|
|
32
32
|
import type { Workspace } from 'lib/resources/workspace.js'
|
|
33
33
|
import { SeamHttpActionAttempts } from 'lib/routes/action-attempts/index.js'
|
|
34
34
|
import { SeamHttpClientSessions } from 'lib/routes/client-sessions/index.js'
|
|
35
|
-
import {
|
|
35
|
+
import {
|
|
36
|
+
SeamHttpRequest,
|
|
37
|
+
type SeamPaginatedRequest,
|
|
38
|
+
} from 'lib/seam-http-request.js'
|
|
36
39
|
import { SeamPaginator } from 'lib/seam-paginator.js'
|
|
37
40
|
|
|
38
41
|
export class SeamHttpWorkspaces {
|
|
@@ -136,7 +139,7 @@ export class SeamHttpWorkspaces {
|
|
|
136
139
|
}
|
|
137
140
|
|
|
138
141
|
createPaginator<const TResponse, const TResponseKey extends keyof TResponse>(
|
|
139
|
-
request:
|
|
142
|
+
request: SeamPaginatedRequest<TResponse, TResponseKey>,
|
|
140
143
|
): SeamPaginator<TResponse, TResponseKey> {
|
|
141
144
|
return new SeamPaginator<TResponse, TResponseKey>(this, request)
|
|
142
145
|
}
|
|
@@ -174,6 +177,7 @@ export class SeamHttpWorkspaces {
|
|
|
174
177
|
parameters,
|
|
175
178
|
hasRequiredParameters: true,
|
|
176
179
|
requiredParameterNames: ['name'],
|
|
180
|
+
atLeastOneParameterNames: [],
|
|
177
181
|
responseKey: 'workspace',
|
|
178
182
|
options,
|
|
179
183
|
})
|
|
@@ -193,6 +197,7 @@ export class SeamHttpWorkspaces {
|
|
|
193
197
|
parameters,
|
|
194
198
|
hasRequiredParameters: false,
|
|
195
199
|
requiredParameterNames: [],
|
|
200
|
+
atLeastOneParameterNames: [],
|
|
196
201
|
responseKey: 'workspace',
|
|
197
202
|
options,
|
|
198
203
|
})
|
|
@@ -212,6 +217,7 @@ export class SeamHttpWorkspaces {
|
|
|
212
217
|
parameters,
|
|
213
218
|
hasRequiredParameters: false,
|
|
214
219
|
requiredParameterNames: [],
|
|
220
|
+
atLeastOneParameterNames: [],
|
|
215
221
|
responseKey: 'workspaces',
|
|
216
222
|
options,
|
|
217
223
|
})
|
|
@@ -231,12 +237,14 @@ export class SeamHttpWorkspaces {
|
|
|
231
237
|
parameters,
|
|
232
238
|
hasRequiredParameters: false,
|
|
233
239
|
requiredParameterNames: [],
|
|
240
|
+
atLeastOneParameterNames: [],
|
|
234
241
|
responseKey: 'action_attempt',
|
|
235
242
|
options,
|
|
236
|
-
actionAttempts:
|
|
237
|
-
|
|
238
|
-
|
|
239
|
-
|
|
243
|
+
actionAttempts: () =>
|
|
244
|
+
SeamHttpActionAttempts.fromClient(this.client, {
|
|
245
|
+
...this.defaults,
|
|
246
|
+
waitForActionAttempt: false,
|
|
247
|
+
}),
|
|
240
248
|
})
|
|
241
249
|
}
|
|
242
250
|
|
|
@@ -254,6 +262,7 @@ export class SeamHttpWorkspaces {
|
|
|
254
262
|
parameters,
|
|
255
263
|
hasRequiredParameters: false,
|
|
256
264
|
requiredParameterNames: [],
|
|
265
|
+
atLeastOneParameterNames: [],
|
|
257
266
|
responseKey: undefined,
|
|
258
267
|
options,
|
|
259
268
|
})
|
|
@@ -24,10 +24,11 @@ interface SeamHttpRequestConfig<TResponseKey> {
|
|
|
24
24
|
readonly responseKey: TResponseKey
|
|
25
25
|
readonly hasPagination?: boolean
|
|
26
26
|
readonly options?: Pick<SeamHttpRequestOptions, 'waitForActionAttempt'>
|
|
27
|
-
readonly actionAttempts?: ActionAttemptsClient
|
|
27
|
+
readonly actionAttempts?: ActionAttemptsClient | (() => ActionAttemptsClient)
|
|
28
28
|
readonly parameters?: unknown
|
|
29
29
|
readonly hasRequiredParameters?: boolean
|
|
30
30
|
readonly requiredParameterNames?: readonly string[]
|
|
31
|
+
readonly atLeastOneParameterNames?: readonly string[]
|
|
31
32
|
}
|
|
32
33
|
|
|
33
34
|
/**
|
|
@@ -52,6 +53,7 @@ interface SeamHttpRequestConfig<TResponseKey> {
|
|
|
52
53
|
export class SeamHttpRequest<
|
|
53
54
|
const TResponse,
|
|
54
55
|
const TResponseKey extends keyof TResponse | undefined,
|
|
56
|
+
const THasPagination extends boolean = boolean,
|
|
55
57
|
> implements Promise<
|
|
56
58
|
TResponseKey extends keyof TResponse ? TResponse[TResponseKey] : undefined
|
|
57
59
|
> {
|
|
@@ -82,8 +84,8 @@ export class SeamHttpRequest<
|
|
|
82
84
|
return this.#config.responseKey
|
|
83
85
|
}
|
|
84
86
|
|
|
85
|
-
public get hasPagination():
|
|
86
|
-
return this.#config.hasPagination ?? false
|
|
87
|
+
public get hasPagination(): THasPagination {
|
|
88
|
+
return (this.#config.hasPagination ?? false) as THasPagination
|
|
87
89
|
}
|
|
88
90
|
|
|
89
91
|
/**
|
|
@@ -92,10 +94,7 @@ export class SeamHttpRequest<
|
|
|
92
94
|
public get url(): URL {
|
|
93
95
|
const { client } = this.#parent
|
|
94
96
|
|
|
95
|
-
const serializer =
|
|
96
|
-
typeof client.defaults.paramsSerializer === 'function'
|
|
97
|
-
? client.defaults.paramsSerializer
|
|
98
|
-
: serializeUrlSearchParams
|
|
97
|
+
const serializer = getParamsSerializer(client.defaults.paramsSerializer)
|
|
99
98
|
|
|
100
99
|
const origin = getUrlPrefix(client.defaults.baseURL ?? '')
|
|
101
100
|
|
|
@@ -171,9 +170,13 @@ export class SeamHttpRequest<
|
|
|
171
170
|
'Cannot wait for an action attempt without an action attempts client',
|
|
172
171
|
)
|
|
173
172
|
}
|
|
173
|
+
const actionAttempts =
|
|
174
|
+
typeof this.#config.actionAttempts === 'function'
|
|
175
|
+
? this.#config.actionAttempts()
|
|
176
|
+
: this.#config.actionAttempts
|
|
174
177
|
const actionAttempt = await resolveActionAttempt(
|
|
175
178
|
data as unknown as ActionAttempt,
|
|
176
|
-
|
|
179
|
+
actionAttempts,
|
|
177
180
|
typeof waitForActionAttempt === 'boolean' ? {} : waitForActionAttempt,
|
|
178
181
|
)
|
|
179
182
|
return actionAttempt as Response
|
|
@@ -201,6 +204,7 @@ export class SeamHttpRequest<
|
|
|
201
204
|
this.pathname,
|
|
202
205
|
this.#config.hasRequiredParameters ?? false,
|
|
203
206
|
this.#config.requiredParameterNames ?? [],
|
|
207
|
+
this.#config.atLeastOneParameterNames ?? [],
|
|
204
208
|
)
|
|
205
209
|
|
|
206
210
|
const { client } = this.#parent
|
|
@@ -256,6 +260,24 @@ export class SeamHttpRequest<
|
|
|
256
260
|
}
|
|
257
261
|
}
|
|
258
262
|
|
|
263
|
+
const getParamsSerializer = (
|
|
264
|
+
paramsSerializer: Client['defaults']['paramsSerializer'],
|
|
265
|
+
): ((params: Record<string, unknown>) => string) => {
|
|
266
|
+
if (typeof paramsSerializer === 'function') return paramsSerializer
|
|
267
|
+
if (typeof paramsSerializer?.serialize === 'function') {
|
|
268
|
+
return paramsSerializer.serialize
|
|
269
|
+
}
|
|
270
|
+
return serializeUrlSearchParams
|
|
271
|
+
}
|
|
272
|
+
|
|
273
|
+
/**
|
|
274
|
+
* A SeamHttpRequest for an endpoint that supports pagination.
|
|
275
|
+
*/
|
|
276
|
+
export type SeamPaginatedRequest<
|
|
277
|
+
TResponse,
|
|
278
|
+
TResponseKey extends keyof TResponse | undefined,
|
|
279
|
+
> = SeamHttpRequest<TResponse, TResponseKey, true>
|
|
280
|
+
|
|
259
281
|
/**
|
|
260
282
|
* Reads the response data at the response key,
|
|
261
283
|
* throwing a {@link SeamHttpInvalidResponseError} for a success response
|
|
@@ -1,7 +1,11 @@
|
|
|
1
1
|
import type { Client } from './client.js'
|
|
2
2
|
import type { SeamHttpRequestOptions } from './options.js'
|
|
3
3
|
import { SeamHttpInvalidResponseError } from './seam-http-error.js'
|
|
4
|
-
import {
|
|
4
|
+
import {
|
|
5
|
+
readResponseData,
|
|
6
|
+
SeamHttpRequest,
|
|
7
|
+
type SeamPaginatedRequest,
|
|
8
|
+
} from './seam-http-request.js'
|
|
5
9
|
|
|
6
10
|
interface SeamPaginatorParent {
|
|
7
11
|
readonly client: Client
|
|
@@ -34,12 +38,12 @@ export class SeamPaginator<
|
|
|
34
38
|
const TResponse,
|
|
35
39
|
const TResponseKey extends keyof TResponse,
|
|
36
40
|
> implements AsyncIterable<EnsureReadonlyArray<TResponse[TResponseKey]>> {
|
|
37
|
-
readonly #request:
|
|
41
|
+
readonly #request: SeamPaginatedRequest<TResponse, TResponseKey>
|
|
38
42
|
readonly #parent: SeamPaginatorParent
|
|
39
43
|
|
|
40
44
|
constructor(
|
|
41
45
|
parent: SeamPaginatorParent,
|
|
42
|
-
request:
|
|
46
|
+
request: SeamPaginatedRequest<TResponse, TResponseKey>,
|
|
43
47
|
) {
|
|
44
48
|
if (!request.hasPagination) {
|
|
45
49
|
throw new Error(
|
|
@@ -82,18 +86,21 @@ export class SeamPaginator<
|
|
|
82
86
|
throw new Error('Cannot paginate a response without a responseKey')
|
|
83
87
|
}
|
|
84
88
|
|
|
89
|
+
const method = this.#request.method
|
|
90
|
+
|
|
91
|
+
const requestData = {
|
|
92
|
+
...(usesParams(method)
|
|
93
|
+
? (this.#request.params ?? {})
|
|
94
|
+
: ((this.#request.body as Record<string, unknown> | null) ?? {})),
|
|
95
|
+
page_cursor: nextPageCursor,
|
|
96
|
+
}
|
|
97
|
+
|
|
85
98
|
const request = new SeamHttpRequest<TResponse, TResponseKey>(this.#parent, {
|
|
86
99
|
pathname: this.#request.pathname,
|
|
87
|
-
method
|
|
100
|
+
method,
|
|
88
101
|
responseKey,
|
|
89
|
-
params:
|
|
90
|
-
|
|
91
|
-
? { ...this.#request.params, page_cursor: nextPageCursor }
|
|
92
|
-
: undefined,
|
|
93
|
-
body:
|
|
94
|
-
this.#request.body != null
|
|
95
|
-
? { ...this.#request.body, page_cursor: nextPageCursor }
|
|
96
|
-
: undefined,
|
|
102
|
+
params: usesParams(method) ? requestData : undefined,
|
|
103
|
+
body: usesParams(method) ? undefined : requestData,
|
|
97
104
|
})
|
|
98
105
|
|
|
99
106
|
const response = await request.fetchResponse()
|
|
@@ -186,6 +193,9 @@ export class SeamPaginator<
|
|
|
186
193
|
}
|
|
187
194
|
}
|
|
188
195
|
|
|
196
|
+
const usesParams = (method: string): boolean =>
|
|
197
|
+
['GET', 'DELETE'].includes(method.toUpperCase())
|
|
198
|
+
|
|
189
199
|
type EnsureReadonlyArray<T> = T extends readonly any[] ? T : never
|
|
190
200
|
type EnsureMutableArray<T> = T extends any[] ? T : never
|
|
191
201
|
type ElementOfArray<T> =
|
package/src/lib/version.ts
CHANGED