@seamapi/http 2.23.7 → 2.24.1

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.
Files changed (197) hide show
  1. package/README.md +5 -0
  2. package/lib/request-parameters.d.ts +1 -1
  3. package/lib/request-parameters.js +3 -3
  4. package/lib/request-parameters.js.map +1 -1
  5. package/lib/resolve-action-attempt.d.ts +2 -0
  6. package/lib/resolve-action-attempt.js +25 -27
  7. package/lib/resolve-action-attempt.js.map +1 -1
  8. package/lib/routes/access-codes/access-codes.d.ts +5 -5
  9. package/lib/routes/access-codes/access-codes.js +21 -2
  10. package/lib/routes/access-codes/access-codes.js.map +1 -1
  11. package/lib/routes/access-codes/simulate/simulate.d.ts +2 -2
  12. package/lib/routes/access-codes/simulate/simulate.js +3 -2
  13. package/lib/routes/access-codes/simulate/simulate.js.map +1 -1
  14. package/lib/routes/access-codes/unmanaged/unmanaged.d.ts +4 -4
  15. package/lib/routes/access-codes/unmanaged/unmanaged.js +7 -2
  16. package/lib/routes/access-codes/unmanaged/unmanaged.js.map +1 -1
  17. package/lib/routes/access-grants/access-grants.d.ts +6 -6
  18. package/lib/routes/access-grants/access-grants.js +20 -2
  19. package/lib/routes/access-grants/access-grants.js.map +1 -1
  20. package/lib/routes/access-grants/unmanaged/unmanaged.d.ts +3 -3
  21. package/lib/routes/access-grants/unmanaged/unmanaged.js +5 -2
  22. package/lib/routes/access-grants/unmanaged/unmanaged.js.map +1 -1
  23. package/lib/routes/access-methods/access-methods.d.ts +5 -5
  24. package/lib/routes/access-methods/access-methods.js +20 -2
  25. package/lib/routes/access-methods/access-methods.js.map +1 -1
  26. package/lib/routes/access-methods/unmanaged/unmanaged.d.ts +2 -2
  27. package/lib/routes/access-methods/unmanaged/unmanaged.js +4 -2
  28. package/lib/routes/access-methods/unmanaged/unmanaged.js.map +1 -1
  29. package/lib/routes/acs/access-groups/access-groups.d.ts +2 -2
  30. package/lib/routes/acs/access-groups/access-groups.js +9 -2
  31. package/lib/routes/acs/access-groups/access-groups.js.map +1 -1
  32. package/lib/routes/acs/acs.d.ts +2 -2
  33. package/lib/routes/acs/acs.js +1 -1
  34. package/lib/routes/acs/acs.js.map +1 -1
  35. package/lib/routes/acs/credentials/credentials.d.ts +3 -3
  36. package/lib/routes/acs/credentials/credentials.js +10 -2
  37. package/lib/routes/acs/credentials/credentials.js.map +1 -1
  38. package/lib/routes/acs/encoders/encoders.d.ts +3 -3
  39. package/lib/routes/acs/encoders/encoders.js +7 -2
  40. package/lib/routes/acs/encoders/encoders.js.map +1 -1
  41. package/lib/routes/acs/encoders/simulate/simulate.d.ts +2 -2
  42. package/lib/routes/acs/encoders/simulate/simulate.js +6 -2
  43. package/lib/routes/acs/encoders/simulate/simulate.js.map +1 -1
  44. package/lib/routes/acs/entrances/entrances.d.ts +3 -3
  45. package/lib/routes/acs/entrances/entrances.js +7 -2
  46. package/lib/routes/acs/entrances/entrances.js.map +1 -1
  47. package/lib/routes/acs/systems/systems.d.ts +2 -2
  48. package/lib/routes/acs/systems/systems.js +6 -2
  49. package/lib/routes/acs/systems/systems.js.map +1 -1
  50. package/lib/routes/acs/users/users.d.ts +10 -10
  51. package/lib/routes/acs/users/users.js +47 -2
  52. package/lib/routes/acs/users/users.js.map +1 -1
  53. package/lib/routes/action-attempts/action-attempts.d.ts +3 -3
  54. package/lib/routes/action-attempts/action-attempts.js +4 -2
  55. package/lib/routes/action-attempts/action-attempts.js.map +1 -1
  56. package/lib/routes/client-sessions/client-sessions.d.ts +3 -3
  57. package/lib/routes/client-sessions/client-sessions.js +16 -2
  58. package/lib/routes/client-sessions/client-sessions.js.map +1 -1
  59. package/lib/routes/connect-webviews/connect-webviews.d.ts +3 -3
  60. package/lib/routes/connect-webviews/connect-webviews.js +6 -2
  61. package/lib/routes/connect-webviews/connect-webviews.js.map +1 -1
  62. package/lib/routes/connected-accounts/connected-accounts.d.ts +4 -4
  63. package/lib/routes/connected-accounts/connected-accounts.js +7 -2
  64. package/lib/routes/connected-accounts/connected-accounts.js.map +1 -1
  65. package/lib/routes/connected-accounts/simulate/simulate.d.ts +2 -2
  66. package/lib/routes/connected-accounts/simulate/simulate.js +3 -2
  67. package/lib/routes/connected-accounts/simulate/simulate.js.map +1 -1
  68. package/lib/routes/customers/customers.d.ts +2 -2
  69. package/lib/routes/customers/customers.js +5 -2
  70. package/lib/routes/customers/customers.js.map +1 -1
  71. package/lib/routes/devices/devices.d.ts +4 -4
  72. package/lib/routes/devices/devices.js +7 -2
  73. package/lib/routes/devices/devices.js.map +1 -1
  74. package/lib/routes/devices/simulate/simulate.d.ts +2 -2
  75. package/lib/routes/devices/simulate/simulate.js +8 -2
  76. package/lib/routes/devices/simulate/simulate.js.map +1 -1
  77. package/lib/routes/devices/unmanaged/unmanaged.d.ts +4 -4
  78. package/lib/routes/devices/unmanaged/unmanaged.js +5 -2
  79. package/lib/routes/devices/unmanaged/unmanaged.js.map +1 -1
  80. package/lib/routes/events/events.d.ts +4 -4
  81. package/lib/routes/events/events.js +32 -2
  82. package/lib/routes/events/events.js.map +1 -1
  83. package/lib/routes/instant-keys/instant-keys.d.ts +3 -3
  84. package/lib/routes/instant-keys/instant-keys.js +5 -2
  85. package/lib/routes/instant-keys/instant-keys.js.map +1 -1
  86. package/lib/routes/locks/locks.d.ts +3 -3
  87. package/lib/routes/locks/locks.js +7 -2
  88. package/lib/routes/locks/locks.js.map +1 -1
  89. package/lib/routes/locks/simulate/simulate.d.ts +2 -2
  90. package/lib/routes/locks/simulate/simulate.js +4 -2
  91. package/lib/routes/locks/simulate/simulate.js.map +1 -1
  92. package/lib/routes/noise-sensors/noise-sensors.d.ts +2 -2
  93. package/lib/routes/noise-sensors/noise-sensors.js +3 -2
  94. package/lib/routes/noise-sensors/noise-sensors.js.map +1 -1
  95. package/lib/routes/noise-sensors/noise-thresholds/noise-thresholds.d.ts +2 -2
  96. package/lib/routes/noise-sensors/noise-thresholds/noise-thresholds.js +7 -2
  97. package/lib/routes/noise-sensors/noise-thresholds/noise-thresholds.js.map +1 -1
  98. package/lib/routes/noise-sensors/simulate/simulate.d.ts +2 -2
  99. package/lib/routes/noise-sensors/simulate/simulate.js +3 -2
  100. package/lib/routes/noise-sensors/simulate/simulate.js.map +1 -1
  101. package/lib/routes/phones/phones.d.ts +2 -2
  102. package/lib/routes/phones/phones.js +5 -2
  103. package/lib/routes/phones/phones.js.map +1 -1
  104. package/lib/routes/phones/simulate/simulate.d.ts +2 -2
  105. package/lib/routes/phones/simulate/simulate.js +3 -2
  106. package/lib/routes/phones/simulate/simulate.js.map +1 -1
  107. package/lib/routes/seam-http-endpoints.d.ts +2 -2
  108. package/lib/routes/seam-http-endpoints.js +1 -1
  109. package/lib/routes/seam-http-endpoints.js.map +1 -1
  110. package/lib/routes/seam-http.d.ts +2 -2
  111. package/lib/routes/seam-http.js +1 -1
  112. package/lib/routes/seam-http.js.map +1 -1
  113. package/lib/routes/spaces/spaces.d.ts +5 -5
  114. package/lib/routes/spaces/spaces.js +19 -2
  115. package/lib/routes/spaces/spaces.js.map +1 -1
  116. package/lib/routes/thermostats/daily-programs/daily-programs.d.ts +2 -2
  117. package/lib/routes/thermostats/daily-programs/daily-programs.js +5 -2
  118. package/lib/routes/thermostats/daily-programs/daily-programs.js.map +1 -1
  119. package/lib/routes/thermostats/schedules/schedules.d.ts +2 -2
  120. package/lib/routes/thermostats/schedules/schedules.js +7 -2
  121. package/lib/routes/thermostats/schedules/schedules.js.map +1 -1
  122. package/lib/routes/thermostats/simulate/simulate.d.ts +2 -2
  123. package/lib/routes/thermostats/simulate/simulate.js +4 -2
  124. package/lib/routes/thermostats/simulate/simulate.js.map +1 -1
  125. package/lib/routes/thermostats/thermostats.d.ts +2 -2
  126. package/lib/routes/thermostats/thermostats.js +16 -2
  127. package/lib/routes/thermostats/thermostats.js.map +1 -1
  128. package/lib/routes/user-identities/unmanaged/unmanaged.d.ts +3 -3
  129. package/lib/routes/user-identities/unmanaged/unmanaged.js +5 -2
  130. package/lib/routes/user-identities/unmanaged/unmanaged.js.map +1 -1
  131. package/lib/routes/user-identities/user-identities.d.ts +5 -5
  132. package/lib/routes/user-identities/user-identities.js +22 -2
  133. package/lib/routes/user-identities/user-identities.js.map +1 -1
  134. package/lib/routes/webhooks/webhooks.d.ts +2 -2
  135. package/lib/routes/webhooks/webhooks.js +7 -2
  136. package/lib/routes/webhooks/webhooks.js.map +1 -1
  137. package/lib/routes/workspaces/workspaces.d.ts +2 -2
  138. package/lib/routes/workspaces/workspaces.js +7 -2
  139. package/lib/routes/workspaces/workspaces.js.map +1 -1
  140. package/lib/seam-http-request.d.ts +11 -2
  141. package/lib/seam-http-request.js +29 -5
  142. package/lib/seam-http-request.js.map +1 -1
  143. package/lib/seam-paginator.d.ts +2 -8
  144. package/lib/seam-paginator.js +3 -15
  145. package/lib/seam-paginator.js.map +1 -1
  146. package/lib/version.d.ts +1 -1
  147. package/lib/version.js +1 -1
  148. package/package.json +1 -1
  149. package/src/lib/request-parameters.ts +5 -2
  150. package/src/lib/resolve-action-attempt.ts +34 -37
  151. package/src/lib/routes/access-codes/access-codes.ts +95 -60
  152. package/src/lib/routes/access-codes/simulate/simulate.ts +7 -3
  153. package/src/lib/routes/access-codes/unmanaged/unmanaged.ts +29 -18
  154. package/src/lib/routes/access-grants/access-grants.ts +102 -72
  155. package/src/lib/routes/access-grants/unmanaged/unmanaged.ts +10 -4
  156. package/src/lib/routes/access-methods/access-methods.ts +84 -52
  157. package/src/lib/routes/access-methods/unmanaged/unmanaged.ts +8 -3
  158. package/src/lib/routes/acs/access-groups/access-groups.ts +13 -3
  159. package/src/lib/routes/acs/acs.ts +3 -3
  160. package/src/lib/routes/acs/credentials/credentials.ts +15 -4
  161. package/src/lib/routes/acs/encoders/encoders.ts +12 -4
  162. package/src/lib/routes/acs/encoders/simulate/simulate.ts +10 -3
  163. package/src/lib/routes/acs/entrances/entrances.ts +12 -4
  164. package/src/lib/routes/acs/systems/systems.ts +10 -3
  165. package/src/lib/routes/acs/users/users.ts +215 -138
  166. package/src/lib/routes/action-attempts/action-attempts.ts +9 -4
  167. package/src/lib/routes/client-sessions/client-sessions.ts +55 -30
  168. package/src/lib/routes/connect-webviews/connect-webviews.ts +11 -4
  169. package/src/lib/routes/connected-accounts/connected-accounts.ts +25 -14
  170. package/src/lib/routes/connected-accounts/simulate/simulate.ts +7 -3
  171. package/src/lib/routes/customers/customers.ts +9 -3
  172. package/src/lib/routes/devices/devices.ts +28 -14
  173. package/src/lib/routes/devices/simulate/simulate.ts +12 -3
  174. package/src/lib/routes/devices/unmanaged/unmanaged.ts +23 -14
  175. package/src/lib/routes/events/events.ts +428 -363
  176. package/src/lib/routes/instant-keys/instant-keys.ts +22 -13
  177. package/src/lib/routes/locks/locks.ts +24 -13
  178. package/src/lib/routes/locks/simulate/simulate.ts +8 -3
  179. package/src/lib/routes/noise-sensors/noise-sensors.ts +7 -3
  180. package/src/lib/routes/noise-sensors/noise-thresholds/noise-thresholds.ts +11 -3
  181. package/src/lib/routes/noise-sensors/simulate/simulate.ts +7 -3
  182. package/src/lib/routes/phones/phones.ts +9 -3
  183. package/src/lib/routes/phones/simulate/simulate.ts +7 -3
  184. package/src/lib/routes/seam-http-endpoints.ts +3 -3
  185. package/src/lib/routes/seam-http.ts +3 -3
  186. package/src/lib/routes/spaces/spaces.ts +74 -45
  187. package/src/lib/routes/thermostats/daily-programs/daily-programs.ts +9 -3
  188. package/src/lib/routes/thermostats/schedules/schedules.ts +11 -3
  189. package/src/lib/routes/thermostats/simulate/simulate.ts +8 -3
  190. package/src/lib/routes/thermostats/thermostats.ts +20 -3
  191. package/src/lib/routes/user-identities/unmanaged/unmanaged.ts +10 -4
  192. package/src/lib/routes/user-identities/user-identities.ts +61 -29
  193. package/src/lib/routes/webhooks/webhooks.ts +11 -3
  194. package/src/lib/routes/workspaces/workspaces.ts +11 -3
  195. package/src/lib/seam-http-request.ts +47 -6
  196. package/src/lib/seam-paginator.ts +7 -28
  197. 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 { SeamHttpRequest } from 'lib/seam-http-request.js'
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,9 +145,9 @@ export class SeamHttpUserIdentities {
142
145
  }
143
146
 
144
147
  createPaginator<const TResponse, const TResponseKey extends keyof TResponse>(
145
- request: SeamHttpRequest<TResponse, TResponseKey>,
148
+ request: SeamPaginatedRequest<TResponse, TResponseKey>,
146
149
  ): SeamPaginator<TResponse, TResponseKey> {
147
- return new SeamPaginator<TResponse, TResponseKey>(this, request)
150
+ return new SeamPaginator<TResponse, TResponseKey>(request)
148
151
  }
149
152
 
150
153
  async updateClientSessionToken(
@@ -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
- * ID of the user identity that you want to get.
578
- */
579
- user_identity_id?: string | undefined
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
- user_identity_key?: string | undefined
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 = SeamHttpRequest<
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
- * IDs of the user identities to merge into the primary user identity. These user identities are deleted.
746
- */
747
- merged_user_identity_ids?: Array<string> | undefined
748
- /**
749
- * ID of the primary user identity to keep.
750
- */
751
- user_identity_id?: string | undefined
752
- /**
753
- * Keys of the user identities to merge into the primary user identity. These user identities are deleted.
754
- */
755
- merged_user_identity_keys?: Array<string> | undefined
756
- /**
757
- * Key of the primary user identity to keep.
758
- */
759
- user_identity_key?: string | undefined
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 { SeamHttpRequest } from 'lib/seam-http-request.js'
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,9 +137,9 @@ export class SeamHttpWebhooks {
134
137
  }
135
138
 
136
139
  createPaginator<const TResponse, const TResponseKey extends keyof TResponse>(
137
- request: SeamHttpRequest<TResponse, TResponseKey>,
140
+ request: SeamPaginatedRequest<TResponse, TResponseKey>,
138
141
  ): SeamPaginator<TResponse, TResponseKey> {
139
- return new SeamPaginator<TResponse, TResponseKey>(this, request)
142
+ return new SeamPaginator<TResponse, TResponseKey>(request)
140
143
  }
141
144
 
142
145
  async updateClientSessionToken(
@@ -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 { SeamHttpRequest } from 'lib/seam-http-request.js'
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,9 +139,9 @@ export class SeamHttpWorkspaces {
136
139
  }
137
140
 
138
141
  createPaginator<const TResponse, const TResponseKey extends keyof TResponse>(
139
- request: SeamHttpRequest<TResponse, TResponseKey>,
142
+ request: SeamPaginatedRequest<TResponse, TResponseKey>,
140
143
  ): SeamPaginator<TResponse, TResponseKey> {
141
- return new SeamPaginator<TResponse, TResponseKey>(this, request)
144
+ return new SeamPaginator<TResponse, TResponseKey>(request)
142
145
  }
143
146
 
144
147
  async updateClientSessionToken(
@@ -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,6 +237,7 @@ export class SeamHttpWorkspaces {
231
237
  parameters,
232
238
  hasRequiredParameters: false,
233
239
  requiredParameterNames: [],
240
+ atLeastOneParameterNames: [],
234
241
  responseKey: 'action_attempt',
235
242
  options,
236
243
  actionAttempts: () =>
@@ -255,6 +262,7 @@ export class SeamHttpWorkspaces {
255
262
  parameters,
256
263
  hasRequiredParameters: false,
257
264
  requiredParameterNames: [],
265
+ atLeastOneParameterNames: [],
258
266
  responseKey: undefined,
259
267
  options,
260
268
  })
@@ -28,6 +28,7 @@ interface SeamHttpRequestConfig<TResponseKey> {
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(): boolean {
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
 
@@ -125,6 +124,29 @@ export class SeamHttpRequest<
125
124
  return this.#config.body
126
125
  }
127
126
 
127
+ /**
128
+ * Returns a copy of this request with the page cursor set.
129
+ */
130
+ withPageCursor(
131
+ pageCursor?: string,
132
+ ): SeamHttpRequest<TResponse, TResponseKey> {
133
+ const usesParams = ['GET', 'DELETE'].includes(this.method.toUpperCase())
134
+
135
+ const requestData = {
136
+ ...(usesParams
137
+ ? (this.#config.params ?? {})
138
+ : ((this.#config.body as Record<string, unknown> | null) ?? {})),
139
+ page_cursor: pageCursor,
140
+ }
141
+
142
+ return new SeamHttpRequest(this.#parent, {
143
+ ...this.#config,
144
+ parameters: requestData,
145
+ params: usesParams ? requestData : undefined,
146
+ body: usesParams ? undefined : requestData,
147
+ })
148
+ }
149
+
128
150
  /**
129
151
  * Sends the request and returns the response data.
130
152
  * If the response contains an action attempt,
@@ -205,6 +227,7 @@ export class SeamHttpRequest<
205
227
  this.pathname,
206
228
  this.#config.hasRequiredParameters ?? false,
207
229
  this.#config.requiredParameterNames ?? [],
230
+ this.#config.atLeastOneParameterNames ?? [],
208
231
  )
209
232
 
210
233
  const { client } = this.#parent
@@ -260,6 +283,24 @@ export class SeamHttpRequest<
260
283
  }
261
284
  }
262
285
 
286
+ const getParamsSerializer = (
287
+ paramsSerializer: Client['defaults']['paramsSerializer'],
288
+ ): ((params: Record<string, unknown>) => string) => {
289
+ if (typeof paramsSerializer === 'function') return paramsSerializer
290
+ if (typeof paramsSerializer?.serialize === 'function') {
291
+ return paramsSerializer.serialize
292
+ }
293
+ return serializeUrlSearchParams
294
+ }
295
+
296
+ /**
297
+ * A SeamHttpRequest for an endpoint that supports pagination.
298
+ */
299
+ export type SeamPaginatedRequest<
300
+ TResponse,
301
+ TResponseKey extends keyof TResponse | undefined,
302
+ > = SeamHttpRequest<TResponse, TResponseKey, true>
303
+
263
304
  /**
264
305
  * Reads the response data at the response key,
265
306
  * throwing a {@link SeamHttpInvalidResponseError} for a success response
@@ -1,12 +1,8 @@
1
- import type { Client } from './client.js'
2
- import type { SeamHttpRequestOptions } from './options.js'
3
1
  import { SeamHttpInvalidResponseError } from './seam-http-error.js'
4
- import { readResponseData, SeamHttpRequest } from './seam-http-request.js'
5
-
6
- interface SeamPaginatorParent {
7
- readonly client: Client
8
- readonly defaults: Required<SeamHttpRequestOptions>
9
- }
2
+ import {
3
+ readResponseData,
4
+ type SeamPaginatedRequest,
5
+ } from './seam-http-request.js'
10
6
 
11
7
  declare const $brand: unique symbol
12
8
 
@@ -34,19 +30,14 @@ export class SeamPaginator<
34
30
  const TResponse,
35
31
  const TResponseKey extends keyof TResponse,
36
32
  > implements AsyncIterable<EnsureReadonlyArray<TResponse[TResponseKey]>> {
37
- readonly #request: SeamHttpRequest<TResponse, TResponseKey>
38
- readonly #parent: SeamPaginatorParent
33
+ readonly #request: SeamPaginatedRequest<TResponse, TResponseKey>
39
34
 
40
- constructor(
41
- parent: SeamPaginatorParent,
42
- request: SeamHttpRequest<TResponse, TResponseKey>,
43
- ) {
35
+ constructor(request: SeamPaginatedRequest<TResponse, TResponseKey>) {
44
36
  if (!request.hasPagination) {
45
37
  throw new Error(
46
38
  `The ${request.pathname} endpoint does not support pagination`,
47
39
  )
48
40
  }
49
- this.#parent = parent
50
41
  this.#request = request
51
42
  }
52
43
 
@@ -82,19 +73,7 @@ export class SeamPaginator<
82
73
  throw new Error('Cannot paginate a response without a responseKey')
83
74
  }
84
75
 
85
- const request = new SeamHttpRequest<TResponse, TResponseKey>(this.#parent, {
86
- pathname: this.#request.pathname,
87
- method: this.#request.method,
88
- responseKey,
89
- params:
90
- this.#request.params != null
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,
97
- })
76
+ const request = this.#request.withPageCursor(nextPageCursor ?? undefined)
98
77
 
99
78
  const response = await request.fetchResponse()
100
79
  const data = readResponseData(response, responseKey, request.pathname)
@@ -1,3 +1,3 @@
1
- const seamapiJavascriptHttpVersion = '2.23.7'
1
+ const seamapiJavascriptHttpVersion = '2.24.1'
2
2
 
3
3
  export default seamapiJavascriptHttpVersion