@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
@@ -32,7 +32,10 @@ import type { RequireAtLeastOne } from 'lib/request-parameters.js'
32
32
  import type { AccessGrant } from 'lib/resources/access-grant.js'
33
33
  import type { Batch } from 'lib/resources/batch.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
  import { SeamHttpAccessGrantsUnmanaged } from './unmanaged/index.js'
@@ -138,9 +141,9 @@ export class SeamHttpAccessGrants {
138
141
  }
139
142
 
140
143
  createPaginator<const TResponse, const TResponseKey extends keyof TResponse>(
141
- request: SeamHttpRequest<TResponse, TResponseKey>,
144
+ request: SeamPaginatedRequest<TResponse, TResponseKey>,
142
145
  ): SeamPaginator<TResponse, TResponseKey> {
143
- return new SeamPaginator<TResponse, TResponseKey>(this, request)
146
+ return new SeamPaginator<TResponse, TResponseKey>(request)
144
147
  }
145
148
 
146
149
  async updateClientSessionToken(
@@ -180,6 +183,7 @@ export class SeamHttpAccessGrants {
180
183
  parameters,
181
184
  hasRequiredParameters: true,
182
185
  requiredParameterNames: ['requested_access_methods'],
186
+ atLeastOneParameterNames: [],
183
187
  responseKey: 'access_grant',
184
188
  options,
185
189
  })
@@ -199,6 +203,7 @@ export class SeamHttpAccessGrants {
199
203
  parameters,
200
204
  hasRequiredParameters: true,
201
205
  requiredParameterNames: ['access_grant_id'],
206
+ atLeastOneParameterNames: [],
202
207
  responseKey: undefined,
203
208
  options,
204
209
  })
@@ -218,6 +223,7 @@ export class SeamHttpAccessGrants {
218
223
  parameters,
219
224
  hasRequiredParameters: true,
220
225
  requiredParameterNames: [],
226
+ atLeastOneParameterNames: ['access_grant_id', 'access_grant_key'],
221
227
  responseKey: 'access_grant',
222
228
  options,
223
229
  })
@@ -237,6 +243,12 @@ export class SeamHttpAccessGrants {
237
243
  parameters,
238
244
  hasRequiredParameters: true,
239
245
  requiredParameterNames: [],
246
+ atLeastOneParameterNames: [
247
+ 'access_grant_ids',
248
+ 'access_grant_keys',
249
+ 'exclude',
250
+ 'include',
251
+ ],
240
252
  responseKey: 'batch',
241
253
  options,
242
254
  })
@@ -256,6 +268,7 @@ export class SeamHttpAccessGrants {
256
268
  parameters,
257
269
  hasRequiredParameters: false,
258
270
  requiredParameterNames: [],
271
+ atLeastOneParameterNames: [],
259
272
  responseKey: 'access_grants',
260
273
  hasPagination: true,
261
274
  options,
@@ -276,6 +289,7 @@ export class SeamHttpAccessGrants {
276
289
  parameters,
277
290
  hasRequiredParameters: true,
278
291
  requiredParameterNames: ['access_grant_id', 'requested_access_methods'],
292
+ atLeastOneParameterNames: [],
279
293
  responseKey: 'access_grant',
280
294
  options,
281
295
  })
@@ -295,6 +309,13 @@ export class SeamHttpAccessGrants {
295
309
  parameters,
296
310
  hasRequiredParameters: true,
297
311
  requiredParameterNames: [],
312
+ atLeastOneParameterNames: [
313
+ 'access_grant_id',
314
+ 'access_grant_key',
315
+ 'ends_at',
316
+ 'name',
317
+ 'starts_at',
318
+ ],
298
319
  responseKey: undefined,
299
320
  options,
300
321
  })
@@ -438,16 +459,19 @@ export type AccessGrantsDeleteRequest = SeamHttpRequest<void, undefined>
438
459
 
439
460
  export interface AccessGrantsDeleteOptions {}
440
461
 
441
- export type AccessGrantsGetParameters = RequireAtLeastOne<{
442
- /**
443
- * ID of Access Grant to get.
444
- */
445
- access_grant_id?: string | undefined
446
- /**
447
- * Unique key of Access Grant to get.
448
- */
449
- access_grant_key?: string | undefined
450
- }>
462
+ export type AccessGrantsGetParameters = RequireAtLeastOne<
463
+ {
464
+ /**
465
+ * ID of Access Grant to get.
466
+ */
467
+ access_grant_id?: string | undefined
468
+ /**
469
+ * Unique key of Access Grant to get.
470
+ */
471
+ access_grant_key?: string | undefined
472
+ },
473
+ 'access_grant_id' | 'access_grant_key'
474
+ >
451
475
 
452
476
  /**
453
477
  * @deprecated Use AccessGrantsGetRequest instead.
@@ -461,42 +485,45 @@ export type AccessGrantsGetRequest = SeamHttpRequest<
461
485
 
462
486
  export interface AccessGrantsGetOptions {}
463
487
 
464
- export type AccessGrantsGetRelatedParameters = RequireAtLeastOne<{
465
- /**
466
- * IDs of the access grants that you want to get along with their related resources.
467
- */
468
- access_grant_ids?: Array<string> | undefined
469
- /**
470
- * Keys of the access grants that you want to get along with their related resources.
471
- */
472
- access_grant_keys?: Array<string> | undefined
473
-
474
- exclude?:
475
- | Array<
476
- | 'spaces'
477
- | 'devices'
478
- | 'acs_entrances'
479
- | 'connected_accounts'
480
- | 'acs_systems'
481
- | 'user_identities'
482
- | 'acs_access_groups'
483
- | 'access_methods'
484
- >
485
- | undefined
486
-
487
- include?:
488
- | Array<
489
- | 'spaces'
490
- | 'devices'
491
- | 'acs_entrances'
492
- | 'connected_accounts'
493
- | 'acs_systems'
494
- | 'user_identities'
495
- | 'acs_access_groups'
496
- | 'access_methods'
497
- >
498
- | undefined
499
- }>
488
+ export type AccessGrantsGetRelatedParameters = RequireAtLeastOne<
489
+ {
490
+ /**
491
+ * IDs of the access grants that you want to get along with their related resources.
492
+ */
493
+ access_grant_ids?: Array<string> | undefined
494
+ /**
495
+ * Keys of the access grants that you want to get along with their related resources.
496
+ */
497
+ access_grant_keys?: Array<string> | undefined
498
+
499
+ exclude?:
500
+ | Array<
501
+ | 'spaces'
502
+ | 'devices'
503
+ | 'acs_entrances'
504
+ | 'connected_accounts'
505
+ | 'acs_systems'
506
+ | 'user_identities'
507
+ | 'acs_access_groups'
508
+ | 'access_methods'
509
+ >
510
+ | undefined
511
+
512
+ include?:
513
+ | Array<
514
+ | 'spaces'
515
+ | 'devices'
516
+ | 'acs_entrances'
517
+ | 'connected_accounts'
518
+ | 'acs_systems'
519
+ | 'user_identities'
520
+ | 'acs_access_groups'
521
+ | 'access_methods'
522
+ >
523
+ | undefined
524
+ },
525
+ 'access_grant_ids' | 'access_grant_keys' | 'exclude' | 'include'
526
+ >
500
527
 
501
528
  /**
502
529
  * @deprecated Use AccessGrantsGetRelatedRequest instead.
@@ -581,7 +608,7 @@ export type AccessGrantsListParameters = {
581
608
  */
582
609
  export type AccessGrantsListResponse = { access_grants: Array<AccessGrant> }
583
610
 
584
- export type AccessGrantsListRequest = SeamHttpRequest<
611
+ export type AccessGrantsListRequest = SeamPaginatedRequest<
585
612
  AccessGrantsListResponse,
586
613
  'access_grants'
587
614
  >
@@ -627,28 +654,31 @@ export type AccessGrantsRequestAccessMethodsRequest = SeamHttpRequest<
627
654
 
628
655
  export interface AccessGrantsRequestAccessMethodsOptions {}
629
656
 
630
- export type AccessGrantsUpdateParameters = RequireAtLeastOne<{
631
- /**
632
- * ID of the Access Grant to update. Provide either `access_grant_id` or `access_grant_key`.
633
- */
634
- access_grant_id?: string | undefined
635
- /**
636
- * Key of the Access Grant to update. Provide either `access_grant_id` or `access_grant_key`.
637
- */
638
- access_grant_key?: string | undefined
639
- /**
640
- * Date and time at which the validity of the grant ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. Must be a time in the future and after `starts_at`.
641
- */
642
- ends_at?: string | Date | Temporal.Instant | null | undefined
643
- /**
644
- * Display name for the access grant.
645
- */
646
- name?: string | null | undefined
647
- /**
648
- * Date and time at which the validity of the grant starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.
649
- */
650
- starts_at?: string | Date | Temporal.Instant | undefined
651
- }>
657
+ export type AccessGrantsUpdateParameters = RequireAtLeastOne<
658
+ {
659
+ /**
660
+ * ID of the Access Grant to update. Provide either `access_grant_id` or `access_grant_key`.
661
+ */
662
+ access_grant_id?: string | undefined
663
+ /**
664
+ * Key of the Access Grant to update. Provide either `access_grant_id` or `access_grant_key`.
665
+ */
666
+ access_grant_key?: string | undefined
667
+ /**
668
+ * Date and time at which the validity of the grant ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. Must be a time in the future and after `starts_at`.
669
+ */
670
+ ends_at?: string | Date | Temporal.Instant | null | undefined
671
+ /**
672
+ * Display name for the access grant.
673
+ */
674
+ name?: string | null | undefined
675
+ /**
676
+ * Date and time at which the validity of the grant starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.
677
+ */
678
+ starts_at?: string | Date | Temporal.Instant | undefined
679
+ },
680
+ 'access_grant_id' | 'access_grant_key' | 'ends_at' | 'name' | 'starts_at'
681
+ >
652
682
 
653
683
  /**
654
684
  * @deprecated Use AccessGrantsUpdateRequest instead.
@@ -30,7 +30,10 @@ import {
30
30
  } from 'lib/parse-options.js'
31
31
  import type { UnmanagedAccessGrant } from 'lib/resources/unmanaged-access-grant.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 SeamHttpAccessGrantsUnmanaged {
@@ -134,9 +137,9 @@ export class SeamHttpAccessGrantsUnmanaged {
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 SeamHttpAccessGrantsUnmanaged {
172
175
  parameters,
173
176
  hasRequiredParameters: true,
174
177
  requiredParameterNames: ['access_grant_id'],
178
+ atLeastOneParameterNames: [],
175
179
  responseKey: 'access_grant',
176
180
  options,
177
181
  })
@@ -191,6 +195,7 @@ export class SeamHttpAccessGrantsUnmanaged {
191
195
  parameters,
192
196
  hasRequiredParameters: false,
193
197
  requiredParameterNames: [],
198
+ atLeastOneParameterNames: [],
194
199
  responseKey: 'access_grants',
195
200
  hasPagination: true,
196
201
  options,
@@ -215,6 +220,7 @@ export class SeamHttpAccessGrantsUnmanaged {
215
220
  parameters,
216
221
  hasRequiredParameters: true,
217
222
  requiredParameterNames: ['access_grant_id', 'is_managed'],
223
+ atLeastOneParameterNames: [],
218
224
  responseKey: undefined,
219
225
  options,
220
226
  })
@@ -276,7 +282,7 @@ export type AccessGrantsUnmanagedListResponse = {
276
282
  access_grants: Array<UnmanagedAccessGrant>
277
283
  }
278
284
 
279
- export type AccessGrantsUnmanagedListRequest = SeamHttpRequest<
285
+ export type AccessGrantsUnmanagedListRequest = SeamPaginatedRequest<
280
286
  AccessGrantsUnmanagedListResponse,
281
287
  'access_grants'
282
288
  >
@@ -34,7 +34,10 @@ import type { ActionAttempt } from 'lib/resources/action-attempt.js'
34
34
  import type { Batch } from 'lib/resources/batch.js'
35
35
  import { SeamHttpActionAttempts } from 'lib/routes/action-attempts/index.js'
36
36
  import { SeamHttpClientSessions } from 'lib/routes/client-sessions/index.js'
37
- import { SeamHttpRequest } from 'lib/seam-http-request.js'
37
+ import {
38
+ SeamHttpRequest,
39
+ type SeamPaginatedRequest,
40
+ } from 'lib/seam-http-request.js'
38
41
  import { SeamPaginator } from 'lib/seam-paginator.js'
39
42
 
40
43
  import { SeamHttpAccessMethodsUnmanaged } from './unmanaged/index.js'
@@ -140,9 +143,9 @@ export class SeamHttpAccessMethods {
140
143
  }
141
144
 
142
145
  createPaginator<const TResponse, const TResponseKey extends keyof TResponse>(
143
- request: SeamHttpRequest<TResponse, TResponseKey>,
146
+ request: SeamPaginatedRequest<TResponse, TResponseKey>,
144
147
  ): SeamPaginator<TResponse, TResponseKey> {
145
- return new SeamPaginator<TResponse, TResponseKey>(this, request)
148
+ return new SeamPaginator<TResponse, TResponseKey>(request)
146
149
  }
147
150
 
148
151
  async updateClientSessionToken(
@@ -182,6 +185,7 @@ export class SeamHttpAccessMethods {
182
185
  parameters,
183
186
  hasRequiredParameters: true,
184
187
  requiredParameterNames: ['access_method_id', 'card_number'],
188
+ atLeastOneParameterNames: [],
185
189
  responseKey: 'action_attempt',
186
190
  options,
187
191
  actionAttempts: () =>
@@ -206,6 +210,11 @@ export class SeamHttpAccessMethods {
206
210
  parameters,
207
211
  hasRequiredParameters: true,
208
212
  requiredParameterNames: [],
213
+ atLeastOneParameterNames: [
214
+ 'access_method_id',
215
+ 'access_grant_id',
216
+ 'reservation_key',
217
+ ],
209
218
  responseKey: undefined,
210
219
  options,
211
220
  })
@@ -225,6 +234,7 @@ export class SeamHttpAccessMethods {
225
234
  parameters,
226
235
  hasRequiredParameters: true,
227
236
  requiredParameterNames: ['access_method_id', 'acs_encoder_id'],
237
+ atLeastOneParameterNames: [],
228
238
  responseKey: 'action_attempt',
229
239
  options,
230
240
  actionAttempts: () =>
@@ -249,6 +259,7 @@ export class SeamHttpAccessMethods {
249
259
  parameters,
250
260
  hasRequiredParameters: true,
251
261
  requiredParameterNames: ['access_method_id'],
262
+ atLeastOneParameterNames: [],
252
263
  responseKey: 'access_method',
253
264
  options,
254
265
  })
@@ -268,6 +279,7 @@ export class SeamHttpAccessMethods {
268
279
  parameters,
269
280
  hasRequiredParameters: true,
270
281
  requiredParameterNames: ['access_method_ids'],
282
+ atLeastOneParameterNames: [],
271
283
  responseKey: 'batch',
272
284
  options,
273
285
  })
@@ -287,6 +299,14 @@ export class SeamHttpAccessMethods {
287
299
  parameters,
288
300
  hasRequiredParameters: true,
289
301
  requiredParameterNames: [],
302
+ atLeastOneParameterNames: [
303
+ 'access_code_id',
304
+ 'access_grant_id',
305
+ 'access_grant_key',
306
+ 'acs_entrance_id',
307
+ 'device_id',
308
+ 'space_id',
309
+ ],
290
310
  responseKey: 'access_methods',
291
311
  hasPagination: true,
292
312
  options,
@@ -307,6 +327,7 @@ export class SeamHttpAccessMethods {
307
327
  parameters,
308
328
  hasRequiredParameters: true,
309
329
  requiredParameterNames: ['access_method_id', 'acs_entrance_id'],
330
+ atLeastOneParameterNames: [],
310
331
  responseKey: 'action_attempt',
311
332
  options,
312
333
  actionAttempts: () =>
@@ -345,20 +366,23 @@ export type AccessMethodsAssignCardOptions = Pick<
345
366
  'waitForActionAttempt'
346
367
  >
347
368
 
348
- export type AccessMethodsDeleteParameters = RequireAtLeastOne<{
349
- /**
350
- * ID of access method to delete.
351
- */
352
- access_method_id?: string | undefined
353
- /**
354
- * ID of access grant whose access methods should be deleted.
355
- */
356
- access_grant_id?: string | undefined
357
- /**
358
- * Reservation key of the access grant whose access methods should be deleted.
359
- */
360
- reservation_key?: string | undefined
361
- }>
369
+ export type AccessMethodsDeleteParameters = RequireAtLeastOne<
370
+ {
371
+ /**
372
+ * ID of access method to delete.
373
+ */
374
+ access_method_id?: string | undefined
375
+ /**
376
+ * ID of access grant whose access methods should be deleted.
377
+ */
378
+ access_grant_id?: string | undefined
379
+ /**
380
+ * Reservation key of the access grant whose access methods should be deleted.
381
+ */
382
+ reservation_key?: string | undefined
383
+ },
384
+ 'access_method_id' | 'access_grant_id' | 'reservation_key'
385
+ >
362
386
 
363
387
  /**
364
388
  * @deprecated Use AccessMethodsDeleteRequest instead.
@@ -471,47 +495,55 @@ export type AccessMethodsGetRelatedRequest = SeamHttpRequest<
471
495
 
472
496
  export interface AccessMethodsGetRelatedOptions {}
473
497
 
474
- export type AccessMethodsListParameters = RequireAtLeastOne<{
475
- /**
476
- * ID of the access code by which to filter the returned access methods. Must be combined with `access_grant_id`, `access_grant_key`, or `acs_entrance_id`.
477
- */
478
- access_code_id?: string | undefined
479
- /**
480
- * ID of Access Grant to list access methods for.
481
- */
482
- access_grant_id?: string | undefined
483
- /**
484
- * Key of Access Grant to list access methods for.
485
- */
486
- access_grant_key?: string | undefined
487
- /**
488
- * ID of the entrance for which you want to retrieve all access methods that grant access to it.
489
- */
490
- acs_entrance_id?: string | undefined
491
- /**
492
- * ID of the device by which to filter the returned access methods. Must be combined with `access_grant_id`, `access_grant_key`, or `acs_entrance_id`.
493
- */
494
- device_id?: string | undefined
495
- /**
496
- * Maximum number of records to return per page.
497
- */
498
- limit?: number | undefined
499
- /**
500
- * Identifies the specific page of results to return, obtained from the previous page's `next_page_cursor`.
501
- */
502
- page_cursor?: string | null | undefined
503
- /**
504
- * ID of the space by which to filter the returned access methods. Must be combined with `access_grant_id`, `access_grant_key`, or `acs_entrance_id`.
505
- */
506
- space_id?: string | undefined
507
- }>
498
+ export type AccessMethodsListParameters = RequireAtLeastOne<
499
+ {
500
+ /**
501
+ * ID of the access code by which to filter the returned access methods. Must be combined with `access_grant_id`, `access_grant_key`, or `acs_entrance_id`.
502
+ */
503
+ access_code_id?: string | undefined
504
+ /**
505
+ * ID of Access Grant to list access methods for.
506
+ */
507
+ access_grant_id?: string | undefined
508
+ /**
509
+ * Key of Access Grant to list access methods for.
510
+ */
511
+ access_grant_key?: string | undefined
512
+ /**
513
+ * ID of the entrance for which you want to retrieve all access methods that grant access to it.
514
+ */
515
+ acs_entrance_id?: string | undefined
516
+ /**
517
+ * ID of the device by which to filter the returned access methods. Must be combined with `access_grant_id`, `access_grant_key`, or `acs_entrance_id`.
518
+ */
519
+ device_id?: string | undefined
520
+ /**
521
+ * Maximum number of records to return per page.
522
+ */
523
+ limit?: number | undefined
524
+ /**
525
+ * Identifies the specific page of results to return, obtained from the previous page's `next_page_cursor`.
526
+ */
527
+ page_cursor?: string | null | undefined
528
+ /**
529
+ * ID of the space by which to filter the returned access methods. Must be combined with `access_grant_id`, `access_grant_key`, or `acs_entrance_id`.
530
+ */
531
+ space_id?: string | undefined
532
+ },
533
+ | 'access_code_id'
534
+ | 'access_grant_id'
535
+ | 'access_grant_key'
536
+ | 'acs_entrance_id'
537
+ | 'device_id'
538
+ | 'space_id'
539
+ >
508
540
 
509
541
  /**
510
542
  * @deprecated Use AccessMethodsListRequest instead.
511
543
  */
512
544
  export type AccessMethodsListResponse = { access_methods: Array<AccessMethod> }
513
545
 
514
- export type AccessMethodsListRequest = SeamHttpRequest<
546
+ export type AccessMethodsListRequest = SeamPaginatedRequest<
515
547
  AccessMethodsListResponse,
516
548
  'access_methods'
517
549
  >
@@ -30,7 +30,10 @@ import {
30
30
  } from 'lib/parse-options.js'
31
31
  import type { UnmanagedAccessMethod } from 'lib/resources/unmanaged-access-method.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 SeamHttpAccessMethodsUnmanaged {
@@ -134,9 +137,9 @@ export class SeamHttpAccessMethodsUnmanaged {
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 SeamHttpAccessMethodsUnmanaged {
172
175
  parameters,
173
176
  hasRequiredParameters: true,
174
177
  requiredParameterNames: ['access_method_id'],
178
+ atLeastOneParameterNames: [],
175
179
  responseKey: 'access_method',
176
180
  options,
177
181
  })
@@ -191,6 +195,7 @@ export class SeamHttpAccessMethodsUnmanaged {
191
195
  parameters,
192
196
  hasRequiredParameters: true,
193
197
  requiredParameterNames: ['access_grant_id'],
198
+ atLeastOneParameterNames: [],
194
199
  responseKey: 'access_methods',
195
200
  options,
196
201
  })
@@ -32,7 +32,10 @@ import type { AcsAccessGroup } from 'lib/resources/acs-access-group.js'
32
32
  import type { AcsEntrance } from 'lib/resources/acs-entrance.js'
33
33
  import type { AcsUser } from 'lib/resources/acs-user.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 SeamHttpAcsAccessGroups {
@@ -136,9 +139,9 @@ export class SeamHttpAcsAccessGroups {
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 SeamHttpAcsAccessGroups {
174
177
  parameters,
175
178
  hasRequiredParameters: true,
176
179
  requiredParameterNames: ['acs_access_group_id'],
180
+ atLeastOneParameterNames: [],
177
181
  responseKey: undefined,
178
182
  options,
179
183
  })
@@ -193,6 +197,7 @@ export class SeamHttpAcsAccessGroups {
193
197
  parameters,
194
198
  hasRequiredParameters: true,
195
199
  requiredParameterNames: ['acs_access_group_id'],
200
+ atLeastOneParameterNames: [],
196
201
  responseKey: undefined,
197
202
  options,
198
203
  })
@@ -212,6 +217,7 @@ export class SeamHttpAcsAccessGroups {
212
217
  parameters,
213
218
  hasRequiredParameters: true,
214
219
  requiredParameterNames: ['acs_access_group_id'],
220
+ atLeastOneParameterNames: [],
215
221
  responseKey: 'acs_access_group',
216
222
  options,
217
223
  })
@@ -231,6 +237,7 @@ export class SeamHttpAcsAccessGroups {
231
237
  parameters,
232
238
  hasRequiredParameters: false,
233
239
  requiredParameterNames: [],
240
+ atLeastOneParameterNames: [],
234
241
  responseKey: 'acs_access_groups',
235
242
  options,
236
243
  })
@@ -250,6 +257,7 @@ export class SeamHttpAcsAccessGroups {
250
257
  parameters,
251
258
  hasRequiredParameters: true,
252
259
  requiredParameterNames: ['acs_access_group_id'],
260
+ atLeastOneParameterNames: [],
253
261
  responseKey: 'acs_entrances',
254
262
  options,
255
263
  })
@@ -269,6 +277,7 @@ export class SeamHttpAcsAccessGroups {
269
277
  parameters,
270
278
  hasRequiredParameters: true,
271
279
  requiredParameterNames: ['acs_access_group_id'],
280
+ atLeastOneParameterNames: [],
272
281
  responseKey: 'acs_users',
273
282
  options,
274
283
  })
@@ -288,6 +297,7 @@ export class SeamHttpAcsAccessGroups {
288
297
  parameters,
289
298
  hasRequiredParameters: true,
290
299
  requiredParameterNames: ['acs_access_group_id'],
300
+ atLeastOneParameterNames: [],
291
301
  responseKey: undefined,
292
302
  options,
293
303
  })
@@ -29,7 +29,7 @@ import {
29
29
  parseOptions,
30
30
  } from 'lib/parse-options.js'
31
31
  import { SeamHttpClientSessions } from 'lib/routes/client-sessions/index.js'
32
- import type { SeamHttpRequest } from 'lib/seam-http-request.js'
32
+ import type { SeamPaginatedRequest } from 'lib/seam-http-request.js'
33
33
  import { SeamPaginator } from 'lib/seam-paginator.js'
34
34
 
35
35
  import { SeamHttpAcsAccessGroups } from './access-groups/index.js'
@@ -140,9 +140,9 @@ export class SeamHttpAcs {
140
140
  }
141
141
 
142
142
  createPaginator<const TResponse, const TResponseKey extends keyof TResponse>(
143
- request: SeamHttpRequest<TResponse, TResponseKey>,
143
+ request: SeamPaginatedRequest<TResponse, TResponseKey>,
144
144
  ): SeamPaginator<TResponse, TResponseKey> {
145
- return new SeamPaginator<TResponse, TResponseKey>(this, request)
145
+ return new SeamPaginator<TResponse, TResponseKey>(request)
146
146
  }
147
147
 
148
148
  async updateClientSessionToken(