@seamapi/http 2.46.0 → 2.47.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 (51) hide show
  1. package/README.md +12 -0
  2. package/lib/resources/access-code.d.ts +19 -0
  3. package/lib/resources/acs-entrance.d.ts +1 -1
  4. package/lib/resources/device-provider.d.ts +2 -2
  5. package/lib/resources/device.d.ts +48 -4
  6. package/lib/resources/phone.d.ts +16 -1
  7. package/lib/resources/unmanaged-access-code.d.ts +19 -0
  8. package/lib/resources/unmanaged-device.d.ts +19 -4
  9. package/lib/routes/access-codes/access-codes.d.ts +9 -9
  10. package/lib/routes/access-codes/access-codes.js +3 -12
  11. package/lib/routes/access-codes/access-codes.js.map +1 -1
  12. package/lib/routes/access-grants/unmanaged/unmanaged.d.ts +4 -0
  13. package/lib/routes/access-methods/access-methods.d.ts +5 -1
  14. package/lib/routes/access-methods/access-methods.js +1 -0
  15. package/lib/routes/access-methods/access-methods.js.map +1 -1
  16. package/lib/routes/client-sessions/client-sessions.d.ts +13 -1
  17. package/lib/routes/client-sessions/client-sessions.js +1 -0
  18. package/lib/routes/client-sessions/client-sessions.js.map +1 -1
  19. package/lib/routes/connect-webviews/connect-webviews.d.ts +1 -1
  20. package/lib/routes/customers/customers.d.ts +170 -0
  21. package/lib/routes/devices/devices.d.ts +3 -3
  22. package/lib/routes/devices/unmanaged/unmanaged.d.ts +3 -3
  23. package/lib/routes/events/events.d.ts +4 -4
  24. package/lib/routes/events/events.js +2 -2
  25. package/lib/routes/locks/locks.d.ts +2 -2
  26. package/lib/routes/seam-http-endpoints.d.ts +5 -5
  27. package/lib/routes/seam-http-endpoints.js +3 -3
  28. package/lib/routes/user-identities/user-identities.d.ts +4 -0
  29. package/lib/version.d.ts +1 -1
  30. package/lib/version.js +1 -1
  31. package/package.json +2 -2
  32. package/src/lib/resources/access-code.ts +22 -0
  33. package/src/lib/resources/acs-entrance.ts +1 -1
  34. package/src/lib/resources/device-provider.ts +2 -1
  35. package/src/lib/resources/device.ts +55 -3
  36. package/src/lib/resources/phone.ts +19 -1
  37. package/src/lib/resources/unmanaged-access-code.ts +22 -0
  38. package/src/lib/resources/unmanaged-device.ts +24 -3
  39. package/src/lib/routes/access-codes/access-codes.ts +46 -65
  40. package/src/lib/routes/access-grants/unmanaged/unmanaged.ts +4 -0
  41. package/src/lib/routes/access-methods/access-methods.ts +6 -0
  42. package/src/lib/routes/client-sessions/client-sessions.ts +14 -1
  43. package/src/lib/routes/connect-webviews/connect-webviews.ts +1 -0
  44. package/src/lib/routes/customers/customers.ts +175 -0
  45. package/src/lib/routes/devices/devices.ts +8 -0
  46. package/src/lib/routes/devices/unmanaged/unmanaged.ts +8 -0
  47. package/src/lib/routes/events/events.ts +4 -4
  48. package/src/lib/routes/locks/locks.ts +4 -0
  49. package/src/lib/routes/seam-http-endpoints.ts +5 -4
  50. package/src/lib/routes/user-identities/user-identities.ts +4 -0
  51. package/src/lib/version.ts +1 -1
@@ -163,7 +163,7 @@ export class SeamHttpEvents {
163
163
  }
164
164
 
165
165
  /**
166
- * Returns a specified event. This endpoint returns the same event that would be sent to a [webhook](https://www.seam.co/docs/developer-tools/webhooks), but it enables you to retrieve an event that already took place.
166
+ * Returns a specified event. This endpoint returns the same event that would be sent to a [webhook](https://www.seam.co/docs/developer-tools/webhooks), but it enables you to retrieve an event that already took place. Events older than 90 days are not returned.
167
167
  */
168
168
  get(
169
169
  parameters: EventsGetParameters,
@@ -183,7 +183,7 @@ export class SeamHttpEvents {
183
183
  }
184
184
 
185
185
  /**
186
- * Returns a list of all events. This endpoint returns the same events that would be sent to a [webhook](https://www.seam.co/docs/developer-tools/webhooks), but it enables you to filter or see events that already took place.
186
+ * Returns a list of all events. This endpoint returns the same events that would be sent to a [webhook](https://www.seam.co/docs/developer-tools/webhooks), but it enables you to filter or see events that already took place. Only events from the last 90 days are returned.
187
187
  */
188
188
  list(
189
189
  parameters: EventsListParameters,
@@ -313,7 +313,7 @@ export type EventsListParameters = RequireAtLeastOne<
313
313
  */
314
314
  acs_user_id?: string | undefined
315
315
  /**
316
- * Lower and upper timestamps to define an exclusive interval containing the events that you want to list. You must include `since` or `between`.
316
+ * Lower and upper timestamps to define an exclusive interval containing the events that you want to list. You must include `since` or `between`. Only events from the last 90 days are returned, so a lower timestamp older than 90 days is treated as 90 days ago.
317
317
  */
318
318
  between?: Array<string> | undefined
319
319
  /**
@@ -585,7 +585,7 @@ export type EventsListParameters = RequireAtLeastOne<
585
585
  */
586
586
  limit?: number | undefined
587
587
  /**
588
- * Timestamp to indicate the beginning generation time for the events that you want to list. You must include `since` or `between`.
588
+ * Timestamp to indicate the beginning generation time for the events that you want to list. You must include `since` or `between`. Only events from the last 90 days are returned, so a `since` older than 90 days is treated as 90 days ago.
589
589
  */
590
590
  since?: string | undefined
591
591
  /**
@@ -375,6 +375,8 @@ export type LocksListParameters = {
375
375
  | 'smartthings_lock'
376
376
  | 'wyze_lock'
377
377
  | 'yale_lock'
378
+ | 'yale_access_lock'
379
+ | 'yale_home_lock'
378
380
  | 'two_n_intercom'
379
381
  | 'controlbyweb_device'
380
382
  | 'ttlock_lock'
@@ -413,6 +415,8 @@ export type LocksListParameters = {
413
415
  | 'smartthings_lock'
414
416
  | 'wyze_lock'
415
417
  | 'yale_lock'
418
+ | 'yale_access_lock'
419
+ | 'yale_home_lock'
416
420
  | 'two_n_intercom'
417
421
  | 'controlbyweb_device'
418
422
  | 'ttlock_lock'
@@ -1002,10 +1002,10 @@ export class SeamHttpEndpoints {
1002
1002
  /**
1003
1003
  * Returns a list of all [access codes](https://www.seam.co/docs/low-level-apis/smart-locks/access-codes).
1004
1004
  *
1005
- * Specify `device_id`, `access_code_ids`, `access_method_id`, `access_grant_id`, or `access_grant_key`.
1005
+ * Without `device_id`, `access_code_ids`, `access_method_id`, `access_grant_id`, or `access_grant_key`, returns access codes across the workspace, or across the customer when `customer_key` is set. Use `limit` and `page_cursor` to page through them.
1006
1006
  */
1007
1007
  get '/access_codes/list'(): (
1008
- parameters: AccessCodesListParameters,
1008
+ parameters?: AccessCodesListParameters,
1009
1009
  options?: AccessCodesListOptions,
1010
1010
  ) => AccessCodesListRequest {
1011
1011
  const { client, defaults } = this
@@ -2910,7 +2910,7 @@ export class SeamHttpEndpoints {
2910
2910
  }
2911
2911
 
2912
2912
  /**
2913
- * Returns a specified event. This endpoint returns the same event that would be sent to a [webhook](https://www.seam.co/docs/developer-tools/webhooks), but it enables you to retrieve an event that already took place.
2913
+ * Returns a specified event. This endpoint returns the same event that would be sent to a [webhook](https://www.seam.co/docs/developer-tools/webhooks), but it enables you to retrieve an event that already took place. Events older than 90 days are not returned.
2914
2914
  */
2915
2915
  get '/events/get'(): (
2916
2916
  parameters: EventsGetParameters,
@@ -2926,7 +2926,7 @@ export class SeamHttpEndpoints {
2926
2926
  }
2927
2927
 
2928
2928
  /**
2929
- * Returns a list of all events. This endpoint returns the same events that would be sent to a [webhook](https://www.seam.co/docs/developer-tools/webhooks), but it enables you to filter or see events that already took place.
2929
+ * Returns a list of all events. This endpoint returns the same events that would be sent to a [webhook](https://www.seam.co/docs/developer-tools/webhooks), but it enables you to filter or see events that already took place. Only events from the last 90 days are returned.
2930
2930
  */
2931
2931
  get '/events/list'(): (
2932
2932
  parameters: EventsListParameters,
@@ -4451,6 +4451,7 @@ export type SeamHttpEndpointPaginatedQueryPaths =
4451
4451
  | '/acs/entrances/list'
4452
4452
  | '/acs/users/list'
4453
4453
  | '/action_attempts/list'
4454
+ | '/client_sessions/list'
4454
4455
  | '/connect_webviews/list'
4455
4456
  | '/connected_accounts/list'
4456
4457
  | '/devices/list'
@@ -656,6 +656,10 @@ export type UserIdentitiesListParameters = {
656
656
  * `acs_system_id` of the credential manager by which you want to filter the list of user identities.
657
657
  */
658
658
  credential_manager_acs_system_id?: string | undefined
659
+ /**
660
+ * Customer key for which you want to list user identities.
661
+ */
662
+ customer_key?: string | undefined
659
663
  /**
660
664
  * Maximum number of records to return per page.
661
665
  */
@@ -1,3 +1,3 @@
1
- const seamapiJavascriptHttpVersion = '2.46.0'
1
+ const seamapiJavascriptHttpVersion = '2.47.0'
2
2
 
3
3
  export default seamapiJavascriptHttpVersion