@seamapi/http 2.23.7 → 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.
Files changed (194) 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 +20 -1
  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 +2 -1
  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 +6 -1
  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 +19 -1
  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 +4 -1
  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 +19 -1
  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 +3 -1
  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 +8 -1
  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.map +1 -1
  34. package/lib/routes/acs/credentials/credentials.d.ts +3 -3
  35. package/lib/routes/acs/credentials/credentials.js +9 -1
  36. package/lib/routes/acs/credentials/credentials.js.map +1 -1
  37. package/lib/routes/acs/encoders/encoders.d.ts +3 -3
  38. package/lib/routes/acs/encoders/encoders.js +6 -1
  39. package/lib/routes/acs/encoders/encoders.js.map +1 -1
  40. package/lib/routes/acs/encoders/simulate/simulate.d.ts +2 -2
  41. package/lib/routes/acs/encoders/simulate/simulate.js +5 -1
  42. package/lib/routes/acs/encoders/simulate/simulate.js.map +1 -1
  43. package/lib/routes/acs/entrances/entrances.d.ts +3 -3
  44. package/lib/routes/acs/entrances/entrances.js +6 -1
  45. package/lib/routes/acs/entrances/entrances.js.map +1 -1
  46. package/lib/routes/acs/systems/systems.d.ts +2 -2
  47. package/lib/routes/acs/systems/systems.js +5 -1
  48. package/lib/routes/acs/systems/systems.js.map +1 -1
  49. package/lib/routes/acs/users/users.d.ts +10 -10
  50. package/lib/routes/acs/users/users.js +46 -1
  51. package/lib/routes/acs/users/users.js.map +1 -1
  52. package/lib/routes/action-attempts/action-attempts.d.ts +3 -3
  53. package/lib/routes/action-attempts/action-attempts.js +3 -1
  54. package/lib/routes/action-attempts/action-attempts.js.map +1 -1
  55. package/lib/routes/client-sessions/client-sessions.d.ts +3 -3
  56. package/lib/routes/client-sessions/client-sessions.js +15 -1
  57. package/lib/routes/client-sessions/client-sessions.js.map +1 -1
  58. package/lib/routes/connect-webviews/connect-webviews.d.ts +3 -3
  59. package/lib/routes/connect-webviews/connect-webviews.js +5 -1
  60. package/lib/routes/connect-webviews/connect-webviews.js.map +1 -1
  61. package/lib/routes/connected-accounts/connected-accounts.d.ts +4 -4
  62. package/lib/routes/connected-accounts/connected-accounts.js +6 -1
  63. package/lib/routes/connected-accounts/connected-accounts.js.map +1 -1
  64. package/lib/routes/connected-accounts/simulate/simulate.d.ts +2 -2
  65. package/lib/routes/connected-accounts/simulate/simulate.js +2 -1
  66. package/lib/routes/connected-accounts/simulate/simulate.js.map +1 -1
  67. package/lib/routes/customers/customers.d.ts +2 -2
  68. package/lib/routes/customers/customers.js +4 -1
  69. package/lib/routes/customers/customers.js.map +1 -1
  70. package/lib/routes/devices/devices.d.ts +4 -4
  71. package/lib/routes/devices/devices.js +6 -1
  72. package/lib/routes/devices/devices.js.map +1 -1
  73. package/lib/routes/devices/simulate/simulate.d.ts +2 -2
  74. package/lib/routes/devices/simulate/simulate.js +7 -1
  75. package/lib/routes/devices/simulate/simulate.js.map +1 -1
  76. package/lib/routes/devices/unmanaged/unmanaged.d.ts +4 -4
  77. package/lib/routes/devices/unmanaged/unmanaged.js +4 -1
  78. package/lib/routes/devices/unmanaged/unmanaged.js.map +1 -1
  79. package/lib/routes/events/events.d.ts +4 -4
  80. package/lib/routes/events/events.js +31 -1
  81. package/lib/routes/events/events.js.map +1 -1
  82. package/lib/routes/instant-keys/instant-keys.d.ts +3 -3
  83. package/lib/routes/instant-keys/instant-keys.js +4 -1
  84. package/lib/routes/instant-keys/instant-keys.js.map +1 -1
  85. package/lib/routes/locks/locks.d.ts +3 -3
  86. package/lib/routes/locks/locks.js +6 -1
  87. package/lib/routes/locks/locks.js.map +1 -1
  88. package/lib/routes/locks/simulate/simulate.d.ts +2 -2
  89. package/lib/routes/locks/simulate/simulate.js +3 -1
  90. package/lib/routes/locks/simulate/simulate.js.map +1 -1
  91. package/lib/routes/noise-sensors/noise-sensors.d.ts +2 -2
  92. package/lib/routes/noise-sensors/noise-sensors.js +2 -1
  93. package/lib/routes/noise-sensors/noise-sensors.js.map +1 -1
  94. package/lib/routes/noise-sensors/noise-thresholds/noise-thresholds.d.ts +2 -2
  95. package/lib/routes/noise-sensors/noise-thresholds/noise-thresholds.js +6 -1
  96. package/lib/routes/noise-sensors/noise-thresholds/noise-thresholds.js.map +1 -1
  97. package/lib/routes/noise-sensors/simulate/simulate.d.ts +2 -2
  98. package/lib/routes/noise-sensors/simulate/simulate.js +2 -1
  99. package/lib/routes/noise-sensors/simulate/simulate.js.map +1 -1
  100. package/lib/routes/phones/phones.d.ts +2 -2
  101. package/lib/routes/phones/phones.js +4 -1
  102. package/lib/routes/phones/phones.js.map +1 -1
  103. package/lib/routes/phones/simulate/simulate.d.ts +2 -2
  104. package/lib/routes/phones/simulate/simulate.js +2 -1
  105. package/lib/routes/phones/simulate/simulate.js.map +1 -1
  106. package/lib/routes/seam-http-endpoints.d.ts +2 -2
  107. package/lib/routes/seam-http-endpoints.js.map +1 -1
  108. package/lib/routes/seam-http.d.ts +2 -2
  109. package/lib/routes/seam-http.js.map +1 -1
  110. package/lib/routes/spaces/spaces.d.ts +5 -5
  111. package/lib/routes/spaces/spaces.js +18 -1
  112. package/lib/routes/spaces/spaces.js.map +1 -1
  113. package/lib/routes/thermostats/daily-programs/daily-programs.d.ts +2 -2
  114. package/lib/routes/thermostats/daily-programs/daily-programs.js +4 -1
  115. package/lib/routes/thermostats/daily-programs/daily-programs.js.map +1 -1
  116. package/lib/routes/thermostats/schedules/schedules.d.ts +2 -2
  117. package/lib/routes/thermostats/schedules/schedules.js +6 -1
  118. package/lib/routes/thermostats/schedules/schedules.js.map +1 -1
  119. package/lib/routes/thermostats/simulate/simulate.d.ts +2 -2
  120. package/lib/routes/thermostats/simulate/simulate.js +3 -1
  121. package/lib/routes/thermostats/simulate/simulate.js.map +1 -1
  122. package/lib/routes/thermostats/thermostats.d.ts +2 -2
  123. package/lib/routes/thermostats/thermostats.js +15 -1
  124. package/lib/routes/thermostats/thermostats.js.map +1 -1
  125. package/lib/routes/user-identities/unmanaged/unmanaged.d.ts +3 -3
  126. package/lib/routes/user-identities/unmanaged/unmanaged.js +4 -1
  127. package/lib/routes/user-identities/unmanaged/unmanaged.js.map +1 -1
  128. package/lib/routes/user-identities/user-identities.d.ts +5 -5
  129. package/lib/routes/user-identities/user-identities.js +21 -1
  130. package/lib/routes/user-identities/user-identities.js.map +1 -1
  131. package/lib/routes/webhooks/webhooks.d.ts +2 -2
  132. package/lib/routes/webhooks/webhooks.js +6 -1
  133. package/lib/routes/webhooks/webhooks.js.map +1 -1
  134. package/lib/routes/workspaces/workspaces.d.ts +2 -2
  135. package/lib/routes/workspaces/workspaces.js +6 -1
  136. package/lib/routes/workspaces/workspaces.js.map +1 -1
  137. package/lib/seam-http-request.d.ts +7 -2
  138. package/lib/seam-http-request.js +11 -5
  139. package/lib/seam-http-request.js.map +1 -1
  140. package/lib/seam-paginator.d.ts +2 -2
  141. package/lib/seam-paginator.js +12 -8
  142. package/lib/seam-paginator.js.map +1 -1
  143. package/lib/version.d.ts +1 -1
  144. package/lib/version.js +1 -1
  145. package/package.json +1 -1
  146. package/src/lib/request-parameters.ts +5 -2
  147. package/src/lib/resolve-action-attempt.ts +34 -37
  148. package/src/lib/routes/access-codes/access-codes.ts +94 -59
  149. package/src/lib/routes/access-codes/simulate/simulate.ts +6 -2
  150. package/src/lib/routes/access-codes/unmanaged/unmanaged.ts +28 -17
  151. package/src/lib/routes/access-grants/access-grants.ts +101 -71
  152. package/src/lib/routes/access-grants/unmanaged/unmanaged.ts +9 -3
  153. package/src/lib/routes/access-methods/access-methods.ts +83 -51
  154. package/src/lib/routes/access-methods/unmanaged/unmanaged.ts +7 -2
  155. package/src/lib/routes/acs/access-groups/access-groups.ts +12 -2
  156. package/src/lib/routes/acs/acs.ts +2 -2
  157. package/src/lib/routes/acs/credentials/credentials.ts +14 -3
  158. package/src/lib/routes/acs/encoders/encoders.ts +11 -3
  159. package/src/lib/routes/acs/encoders/simulate/simulate.ts +9 -2
  160. package/src/lib/routes/acs/entrances/entrances.ts +11 -3
  161. package/src/lib/routes/acs/systems/systems.ts +9 -2
  162. package/src/lib/routes/acs/users/users.ts +214 -137
  163. package/src/lib/routes/action-attempts/action-attempts.ts +8 -3
  164. package/src/lib/routes/client-sessions/client-sessions.ts +54 -29
  165. package/src/lib/routes/connect-webviews/connect-webviews.ts +10 -3
  166. package/src/lib/routes/connected-accounts/connected-accounts.ts +24 -13
  167. package/src/lib/routes/connected-accounts/simulate/simulate.ts +6 -2
  168. package/src/lib/routes/customers/customers.ts +8 -2
  169. package/src/lib/routes/devices/devices.ts +27 -13
  170. package/src/lib/routes/devices/simulate/simulate.ts +11 -2
  171. package/src/lib/routes/devices/unmanaged/unmanaged.ts +22 -13
  172. package/src/lib/routes/events/events.ts +427 -362
  173. package/src/lib/routes/instant-keys/instant-keys.ts +21 -12
  174. package/src/lib/routes/locks/locks.ts +23 -12
  175. package/src/lib/routes/locks/simulate/simulate.ts +7 -2
  176. package/src/lib/routes/noise-sensors/noise-sensors.ts +6 -2
  177. package/src/lib/routes/noise-sensors/noise-thresholds/noise-thresholds.ts +10 -2
  178. package/src/lib/routes/noise-sensors/simulate/simulate.ts +6 -2
  179. package/src/lib/routes/phones/phones.ts +8 -2
  180. package/src/lib/routes/phones/simulate/simulate.ts +6 -2
  181. package/src/lib/routes/seam-http-endpoints.ts +2 -2
  182. package/src/lib/routes/seam-http.ts +2 -2
  183. package/src/lib/routes/spaces/spaces.ts +73 -44
  184. package/src/lib/routes/thermostats/daily-programs/daily-programs.ts +8 -2
  185. package/src/lib/routes/thermostats/schedules/schedules.ts +10 -2
  186. package/src/lib/routes/thermostats/simulate/simulate.ts +7 -2
  187. package/src/lib/routes/thermostats/thermostats.ts +19 -2
  188. package/src/lib/routes/user-identities/unmanaged/unmanaged.ts +9 -3
  189. package/src/lib/routes/user-identities/user-identities.ts +60 -28
  190. package/src/lib/routes/webhooks/webhooks.ts +10 -2
  191. package/src/lib/routes/workspaces/workspaces.ts +10 -2
  192. package/src/lib/seam-http-request.ts +24 -6
  193. package/src/lib/seam-paginator.ts +22 -12
  194. package/src/lib/version.ts +1 -1
@@ -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,7 +137,7 @@ 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
142
  return new SeamPaginator<TResponse, TResponseKey>(this, request)
140
143
  }
@@ -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,7 +143,7 @@ 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
148
  return new SeamPaginator<TResponse, TResponseKey>(this, request)
146
149
  }
@@ -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,7 +137,7 @@ 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
142
  return new SeamPaginator<TResponse, TResponseKey>(this, request)
140
143
  }
@@ -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,7 +139,7 @@ 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
144
  return new SeamPaginator<TResponse, TResponseKey>(this, request)
142
145
  }
@@ -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,7 +140,7 @@ 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
145
  return new SeamPaginator<TResponse, TResponseKey>(this, request)
146
146
  }
@@ -31,7 +31,10 @@ import {
31
31
  import type { AcsCredential } from 'lib/resources/acs-credential.js'
32
32
  import type { AcsEntrance } from 'lib/resources/acs-entrance.js'
33
33
  import { SeamHttpClientSessions } from 'lib/routes/client-sessions/index.js'
34
- import { SeamHttpRequest } from 'lib/seam-http-request.js'
34
+ import {
35
+ SeamHttpRequest,
36
+ type SeamPaginatedRequest,
37
+ } from 'lib/seam-http-request.js'
35
38
  import { SeamPaginator } from 'lib/seam-paginator.js'
36
39
 
37
40
  export class SeamHttpAcsCredentials {
@@ -135,7 +138,7 @@ export class SeamHttpAcsCredentials {
135
138
  }
136
139
 
137
140
  createPaginator<const TResponse, const TResponseKey extends keyof TResponse>(
138
- request: SeamHttpRequest<TResponse, TResponseKey>,
141
+ request: SeamPaginatedRequest<TResponse, TResponseKey>,
139
142
  ): SeamPaginator<TResponse, TResponseKey> {
140
143
  return new SeamPaginator<TResponse, TResponseKey>(this, request)
141
144
  }
@@ -173,6 +176,7 @@ export class SeamHttpAcsCredentials {
173
176
  parameters,
174
177
  hasRequiredParameters: true,
175
178
  requiredParameterNames: ['acs_credential_id'],
179
+ atLeastOneParameterNames: [],
176
180
  responseKey: undefined,
177
181
  options,
178
182
  })
@@ -192,6 +196,7 @@ export class SeamHttpAcsCredentials {
192
196
  parameters,
193
197
  hasRequiredParameters: true,
194
198
  requiredParameterNames: ['access_method'],
199
+ atLeastOneParameterNames: [],
195
200
  responseKey: 'acs_credential',
196
201
  options,
197
202
  })
@@ -211,6 +216,7 @@ export class SeamHttpAcsCredentials {
211
216
  parameters,
212
217
  hasRequiredParameters: true,
213
218
  requiredParameterNames: ['acs_credential_id'],
219
+ atLeastOneParameterNames: [],
214
220
  responseKey: undefined,
215
221
  options,
216
222
  })
@@ -230,6 +236,7 @@ export class SeamHttpAcsCredentials {
230
236
  parameters,
231
237
  hasRequiredParameters: true,
232
238
  requiredParameterNames: ['acs_credential_id'],
239
+ atLeastOneParameterNames: [],
233
240
  responseKey: 'acs_credential',
234
241
  options,
235
242
  })
@@ -249,6 +256,7 @@ export class SeamHttpAcsCredentials {
249
256
  parameters,
250
257
  hasRequiredParameters: false,
251
258
  requiredParameterNames: [],
259
+ atLeastOneParameterNames: [],
252
260
  responseKey: 'acs_credentials',
253
261
  hasPagination: true,
254
262
  options,
@@ -269,6 +277,7 @@ export class SeamHttpAcsCredentials {
269
277
  parameters,
270
278
  hasRequiredParameters: true,
271
279
  requiredParameterNames: ['acs_credential_id'],
280
+ atLeastOneParameterNames: [],
272
281
  responseKey: 'acs_entrances',
273
282
  options,
274
283
  })
@@ -288,6 +297,7 @@ export class SeamHttpAcsCredentials {
288
297
  parameters,
289
298
  hasRequiredParameters: true,
290
299
  requiredParameterNames: ['acs_credential_id'],
300
+ atLeastOneParameterNames: [],
291
301
  responseKey: undefined,
292
302
  options,
293
303
  })
@@ -307,6 +317,7 @@ export class SeamHttpAcsCredentials {
307
317
  parameters,
308
318
  hasRequiredParameters: true,
309
319
  requiredParameterNames: ['acs_credential_id'],
320
+ atLeastOneParameterNames: [],
310
321
  responseKey: undefined,
311
322
  options,
312
323
  })
@@ -512,7 +523,7 @@ export type AcsCredentialsListResponse = {
512
523
  acs_credentials: Array<AcsCredential>
513
524
  }
514
525
 
515
- export type AcsCredentialsListRequest = SeamHttpRequest<
526
+ export type AcsCredentialsListRequest = SeamPaginatedRequest<
516
527
  AcsCredentialsListResponse,
517
528
  'acs_credentials'
518
529
  >
@@ -32,7 +32,10 @@ import type { AcsEncoder } from 'lib/resources/acs-encoder.js'
32
32
  import type { ActionAttempt } from 'lib/resources/action-attempt.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
  import { SeamHttpAcsEncodersSimulate } from './simulate/index.js'
@@ -138,7 +141,7 @@ export class SeamHttpAcsEncoders {
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
146
  return new SeamPaginator<TResponse, TResponseKey>(this, request)
144
147
  }
@@ -180,6 +183,7 @@ export class SeamHttpAcsEncoders {
180
183
  parameters,
181
184
  hasRequiredParameters: true,
182
185
  requiredParameterNames: ['acs_encoder_id'],
186
+ atLeastOneParameterNames: [],
183
187
  responseKey: 'action_attempt',
184
188
  options,
185
189
  actionAttempts: () =>
@@ -204,6 +208,7 @@ export class SeamHttpAcsEncoders {
204
208
  parameters,
205
209
  hasRequiredParameters: true,
206
210
  requiredParameterNames: ['acs_encoder_id'],
211
+ atLeastOneParameterNames: [],
207
212
  responseKey: 'acs_encoder',
208
213
  options,
209
214
  })
@@ -223,6 +228,7 @@ export class SeamHttpAcsEncoders {
223
228
  parameters,
224
229
  hasRequiredParameters: false,
225
230
  requiredParameterNames: [],
231
+ atLeastOneParameterNames: [],
226
232
  responseKey: 'acs_encoders',
227
233
  hasPagination: true,
228
234
  options,
@@ -243,6 +249,7 @@ export class SeamHttpAcsEncoders {
243
249
  parameters,
244
250
  hasRequiredParameters: true,
245
251
  requiredParameterNames: ['acs_encoder_id'],
252
+ atLeastOneParameterNames: [],
246
253
  responseKey: 'action_attempt',
247
254
  options,
248
255
  actionAttempts: () =>
@@ -267,6 +274,7 @@ export class SeamHttpAcsEncoders {
267
274
  parameters,
268
275
  hasRequiredParameters: true,
269
276
  requiredParameterNames: ['acs_encoder_id'],
277
+ atLeastOneParameterNames: [],
270
278
  responseKey: 'action_attempt',
271
279
  options,
272
280
  actionAttempts: () =>
@@ -357,7 +365,7 @@ export type AcsEncodersListParameters = {
357
365
  */
358
366
  export type AcsEncodersListResponse = { acs_encoders: Array<AcsEncoder> }
359
367
 
360
- export type AcsEncodersListRequest = SeamHttpRequest<
368
+ export type AcsEncodersListRequest = SeamPaginatedRequest<
361
369
  AcsEncodersListResponse,
362
370
  'acs_encoders'
363
371
  >
@@ -29,7 +29,10 @@ import {
29
29
  parseOptions,
30
30
  } from 'lib/parse-options.js'
31
31
  import { SeamHttpClientSessions } from 'lib/routes/client-sessions/index.js'
32
- import { SeamHttpRequest } from 'lib/seam-http-request.js'
32
+ import {
33
+ SeamHttpRequest,
34
+ type SeamPaginatedRequest,
35
+ } from 'lib/seam-http-request.js'
33
36
  import { SeamPaginator } from 'lib/seam-paginator.js'
34
37
 
35
38
  export class SeamHttpAcsEncodersSimulate {
@@ -133,7 +136,7 @@ export class SeamHttpAcsEncodersSimulate {
133
136
  }
134
137
 
135
138
  createPaginator<const TResponse, const TResponseKey extends keyof TResponse>(
136
- request: SeamHttpRequest<TResponse, TResponseKey>,
139
+ request: SeamPaginatedRequest<TResponse, TResponseKey>,
137
140
  ): SeamPaginator<TResponse, TResponseKey> {
138
141
  return new SeamPaginator<TResponse, TResponseKey>(this, request)
139
142
  }
@@ -171,6 +174,7 @@ export class SeamHttpAcsEncodersSimulate {
171
174
  parameters,
172
175
  hasRequiredParameters: true,
173
176
  requiredParameterNames: ['acs_encoder_id'],
177
+ atLeastOneParameterNames: [],
174
178
  responseKey: undefined,
175
179
  options,
176
180
  })
@@ -190,6 +194,7 @@ export class SeamHttpAcsEncodersSimulate {
190
194
  parameters,
191
195
  hasRequiredParameters: true,
192
196
  requiredParameterNames: ['acs_encoder_id'],
197
+ atLeastOneParameterNames: [],
193
198
  responseKey: undefined,
194
199
  options,
195
200
  })
@@ -209,6 +214,7 @@ export class SeamHttpAcsEncodersSimulate {
209
214
  parameters,
210
215
  hasRequiredParameters: true,
211
216
  requiredParameterNames: ['acs_encoder_id'],
217
+ atLeastOneParameterNames: [],
212
218
  responseKey: undefined,
213
219
  options,
214
220
  })
@@ -228,6 +234,7 @@ export class SeamHttpAcsEncodersSimulate {
228
234
  parameters,
229
235
  hasRequiredParameters: true,
230
236
  requiredParameterNames: ['acs_encoder_id'],
237
+ atLeastOneParameterNames: [],
231
238
  responseKey: undefined,
232
239
  options,
233
240
  })
@@ -33,7 +33,10 @@ import type { AcsEntrance } from 'lib/resources/acs-entrance.js'
33
33
  import type { ActionAttempt } from 'lib/resources/action-attempt.js'
34
34
  import { SeamHttpActionAttempts } from 'lib/routes/action-attempts/index.js'
35
35
  import { SeamHttpClientSessions } from 'lib/routes/client-sessions/index.js'
36
- import { SeamHttpRequest } from 'lib/seam-http-request.js'
36
+ import {
37
+ SeamHttpRequest,
38
+ type SeamPaginatedRequest,
39
+ } from 'lib/seam-http-request.js'
37
40
  import { SeamPaginator } from 'lib/seam-paginator.js'
38
41
 
39
42
  export class SeamHttpAcsEntrances {
@@ -137,7 +140,7 @@ export class SeamHttpAcsEntrances {
137
140
  }
138
141
 
139
142
  createPaginator<const TResponse, const TResponseKey extends keyof TResponse>(
140
- request: SeamHttpRequest<TResponse, TResponseKey>,
143
+ request: SeamPaginatedRequest<TResponse, TResponseKey>,
141
144
  ): SeamPaginator<TResponse, TResponseKey> {
142
145
  return new SeamPaginator<TResponse, TResponseKey>(this, request)
143
146
  }
@@ -175,6 +178,7 @@ export class SeamHttpAcsEntrances {
175
178
  parameters,
176
179
  hasRequiredParameters: true,
177
180
  requiredParameterNames: ['acs_entrance_id'],
181
+ atLeastOneParameterNames: [],
178
182
  responseKey: 'acs_entrance',
179
183
  options,
180
184
  })
@@ -194,6 +198,7 @@ export class SeamHttpAcsEntrances {
194
198
  parameters,
195
199
  hasRequiredParameters: true,
196
200
  requiredParameterNames: ['acs_entrance_id'],
201
+ atLeastOneParameterNames: [],
197
202
  responseKey: undefined,
198
203
  options,
199
204
  })
@@ -213,6 +218,7 @@ export class SeamHttpAcsEntrances {
213
218
  parameters,
214
219
  hasRequiredParameters: false,
215
220
  requiredParameterNames: [],
221
+ atLeastOneParameterNames: [],
216
222
  responseKey: 'acs_entrances',
217
223
  hasPagination: true,
218
224
  options,
@@ -233,6 +239,7 @@ export class SeamHttpAcsEntrances {
233
239
  parameters,
234
240
  hasRequiredParameters: true,
235
241
  requiredParameterNames: ['acs_entrance_id'],
242
+ atLeastOneParameterNames: [],
236
243
  responseKey: 'acs_credentials',
237
244
  options,
238
245
  })
@@ -252,6 +259,7 @@ export class SeamHttpAcsEntrances {
252
259
  parameters,
253
260
  hasRequiredParameters: true,
254
261
  requiredParameterNames: ['acs_credential_id', 'acs_entrance_id'],
262
+ atLeastOneParameterNames: [],
255
263
  responseKey: 'action_attempt',
256
264
  options,
257
265
  actionAttempts: () =>
@@ -359,7 +367,7 @@ export type AcsEntrancesListParameters = {
359
367
  */
360
368
  export type AcsEntrancesListResponse = { acs_entrances: Array<AcsEntrance> }
361
369
 
362
- export type AcsEntrancesListRequest = SeamHttpRequest<
370
+ export type AcsEntrancesListRequest = SeamPaginatedRequest<
363
371
  AcsEntrancesListResponse,
364
372
  'acs_entrances'
365
373
  >