@seamapi/types 1.1150.0 → 1.1152.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.
@@ -6082,15 +6082,15 @@ export type Routes = {
6082
6082
  commonParams: {
6083
6083
  /** Customer key for which you want to list access codes. */
6084
6084
  customer_key?: string | undefined;
6085
- /** ID of the device for which you want to list access codes. Specify `device_id`, `access_code_ids`, `access_method_id`, `access_grant_id`, or `access_grant_key`. */
6085
+ /** ID of the device for which you want to list access codes. */
6086
6086
  device_id?: string | undefined;
6087
- /** IDs of the access codes that you want to retrieve. Specify `device_id`, `access_code_ids`, `access_method_id`, `access_grant_id`, or `access_grant_key`. */
6087
+ /** IDs of the access codes that you want to retrieve. */
6088
6088
  access_code_ids?: string[] | undefined;
6089
- /** ID of the access method for which you want to list access codes. Specify `device_id`, `access_code_ids`, `access_method_id`, `access_grant_id`, or `access_grant_key`. */
6089
+ /** ID of the access method for which you want to list access codes. */
6090
6090
  access_method_id?: string | undefined;
6091
- /** ID of the access grant for which you want to list access codes. Specify `device_id`, `access_code_ids`, `access_method_id`, `access_grant_id`, or `access_grant_key`. */
6091
+ /** ID of the access grant for which you want to list access codes. */
6092
6092
  access_grant_id?: string | undefined;
6093
- /** Key of the access grant for which you want to list access codes. Specify `device_id`, `access_code_ids`, `access_method_id`, `access_grant_id`, or `access_grant_key`. */
6093
+ /** Key of the access grant for which you want to list access codes. */
6094
6094
  access_grant_key?: string | undefined;
6095
6095
  /** Your user ID for the user by which to filter access codes. */
6096
6096
  user_identifier_key?: string | undefined;
@@ -17266,6 +17266,8 @@ export type Routes = {
17266
17266
  queryParams: {};
17267
17267
  jsonBody: {};
17268
17268
  commonParams: {
17269
+ /** Customer key for which you want to list unmanaged Access Grants. */
17270
+ customer_key?: string | undefined;
17269
17271
  /** ID of user identity by which you want to filter the list of unmanaged Access Grants. */
17270
17272
  user_identity_id?: string | undefined;
17271
17273
  /** ID of the access system by which you want to filter the list of unmanaged Access Grants. */
@@ -24775,6 +24777,8 @@ export type Routes = {
24775
24777
  queryParams: {};
24776
24778
  jsonBody: {};
24777
24779
  commonParams: {
24780
+ /** Customer key for which you want to list access methods. */
24781
+ customer_key?: string | undefined;
24778
24782
  /** ID of Access Grant to list access methods for. */
24779
24783
  access_grant_id?: string | undefined;
24780
24784
  /** Key of Access Grant to list access methods for. */
@@ -154342,6 +154346,8 @@ export type Routes = {
154342
154346
  queryParams: {};
154343
154347
  jsonBody: {};
154344
154348
  commonParams: {
154349
+ /** Customer key for which you want to list user identities. */
154350
+ customer_key?: string | undefined;
154345
154351
  /** Array of user identity IDs by which to filter the list of user identities. */
154346
154352
  user_identity_ids?: string[] | undefined;
154347
154353
  /** String for which to search. Filters returned user identities to include all records that satisfy a partial match using `full_name`, `phone_number`, `email_address` or `user_identity_id`. */
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@seamapi/types",
3
- "version": "1.1150.0",
3
+ "version": "1.1152.0",
4
4
  "description": "TypeScript types for the Seam API.",
5
5
  "type": "module",
6
6
  "main": "index.js",
@@ -72,7 +72,7 @@ const salto_ks_entrance_access_code_support_removed =
72
72
  .describe(warning_code_description),
73
73
  })
74
74
  .describe(
75
- 'Indicates that a change in the reported device model has been detected for this Salto KS entrance, which may occur after an IQ hub reset. Access code support may be affected. See https://help.getseam.com/articles/5098842588-salto-ks-lock-loses-access-code-support for troubleshooting steps.',
75
+ 'Indicates that a change in the reported device model has been detected for this Salto KS entrance, which may occur after an IQ hub reset. Access code support may be affected. See https://www.seam.co/help/salto-ks-lock-loses-access-code-support for troubleshooting steps.',
76
76
  )
77
77
 
78
78
  const entrance_shares_zone = common_acs_entrance_warning
@@ -490,7 +490,7 @@ const salto_ks_lock_access_code_support_removed = common_device_warning.extend({
490
490
  ---
491
491
  variant_group_key: access_codes
492
492
  ---
493
- Indicates that a change in the reported device model has been detected for this Salto KS lock, which may occur after an IQ hub reset. Access code support may be affected. See https://help.getseam.com/articles/5098842588-salto-ks-lock-loses-access-code-support for troubleshooting steps.
493
+ Indicates that a change in the reported device model has been detected for this Salto KS lock, which may occur after an IQ hub reset. Access code support may be affected. See https://www.seam.co/help/salto-ks-lock-loses-access-code-support for troubleshooting steps.
494
494
  `)
495
495
 
496
496
  const third_party_integration_detected = common_device_warning
@@ -4765,7 +4765,7 @@ const openapi: OpenAPISpec = {
4765
4765
  oneOf: [
4766
4766
  {
4767
4767
  description:
4768
- 'Indicates that a change in the reported device model has been detected for this Salto KS entrance, which may occur after an IQ hub reset. Access code support may be affected. See https://help.getseam.com/articles/5098842588-salto-ks-lock-loses-access-code-support for troubleshooting steps.',
4768
+ 'Indicates that a change in the reported device model has been detected for this Salto KS entrance, which may occur after an IQ hub reset. Access code support may be affected. See https://www.seam.co/help/salto-ks-lock-loses-access-code-support for troubleshooting steps.',
4769
4769
  properties: {
4770
4770
  created_at: {
4771
4771
  description:
@@ -20093,7 +20093,7 @@ const openapi: OpenAPISpec = {
20093
20093
  },
20094
20094
  {
20095
20095
  description:
20096
- 'Indicates that a change in the reported device model has been detected for this Salto KS lock, which may occur after an IQ hub reset. Access code support may be affected. See https://help.getseam.com/articles/5098842588-salto-ks-lock-loses-access-code-support for troubleshooting steps.',
20096
+ 'Indicates that a change in the reported device model has been detected for this Salto KS lock, which may occur after an IQ hub reset. Access code support may be affected. See https://www.seam.co/help/salto-ks-lock-loses-access-code-support for troubleshooting steps.',
20097
20097
  properties: {
20098
20098
  created_at: {
20099
20099
  description:
@@ -33582,7 +33582,7 @@ const openapi: OpenAPISpec = {
33582
33582
  },
33583
33583
  {
33584
33584
  description:
33585
- 'Indicates that a change in the reported device model has been detected for this Salto KS lock, which may occur after an IQ hub reset. Access code support may be affected. See https://help.getseam.com/articles/5098842588-salto-ks-lock-loses-access-code-support for troubleshooting steps.',
33585
+ 'Indicates that a change in the reported device model has been detected for this Salto KS lock, which may occur after an IQ hub reset. Access code support may be affected. See https://www.seam.co/help/salto-ks-lock-loses-access-code-support for troubleshooting steps.',
33586
33586
  properties: {
33587
33587
  created_at: {
33588
33588
  description:
@@ -34552,7 +34552,7 @@ const openapi: OpenAPISpec = {
34552
34552
  oneOf: [
34553
34553
  {
34554
34554
  description:
34555
- 'Indicates that a change in the reported device model has been detected for this Salto KS entrance, which may occur after an IQ hub reset. Access code support may be affected. See https://help.getseam.com/articles/5098842588-salto-ks-lock-loses-access-code-support for troubleshooting steps.',
34555
+ 'Indicates that a change in the reported device model has been detected for this Salto KS entrance, which may occur after an IQ hub reset. Access code support may be affected. See https://www.seam.co/help/salto-ks-lock-loses-access-code-support for troubleshooting steps.',
34556
34556
  properties: {
34557
34557
  created_at: {
34558
34558
  description:
@@ -42104,7 +42104,7 @@ const openapi: OpenAPISpec = {
42104
42104
  },
42105
42105
  {
42106
42106
  description:
42107
- 'Indicates that a change in the reported device model has been detected for this Salto KS lock, which may occur after an IQ hub reset. Access code support may be affected. See https://help.getseam.com/articles/5098842588-salto-ks-lock-loses-access-code-support for troubleshooting steps.',
42107
+ 'Indicates that a change in the reported device model has been detected for this Salto KS lock, which may occur after an IQ hub reset. Access code support may be affected. See https://www.seam.co/help/salto-ks-lock-loses-access-code-support for troubleshooting steps.',
42108
42108
  properties: {
42109
42109
  created_at: {
42110
42110
  description:
@@ -43923,7 +43923,7 @@ const openapi: OpenAPISpec = {
43923
43923
  '/access_codes/list': {
43924
43924
  get: {
43925
43925
  description:
43926
- 'Returns a list of all [access codes](https://www.seam.co/docs/low-level-apis/smart-locks/access-codes).\n\nSpecify `device_id`, `access_code_ids`, `access_method_id`, `access_grant_id`, or `access_grant_key`.',
43926
+ 'Returns a list of all [access codes](https://www.seam.co/docs/low-level-apis/smart-locks/access-codes).\n\nWithout `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.',
43927
43927
  operationId: 'accessCodesListGet',
43928
43928
  parameters: [
43929
43929
  {
@@ -43941,7 +43941,7 @@ const openapi: OpenAPISpec = {
43941
43941
  name: 'device_id',
43942
43942
  schema: {
43943
43943
  description:
43944
- 'ID of the device for which you want to list access codes. Specify `device_id`, `access_code_ids`, `access_method_id`, `access_grant_id`, or `access_grant_key`.',
43944
+ 'ID of the device for which you want to list access codes.',
43945
43945
  format: 'uuid',
43946
43946
  type: 'string',
43947
43947
  },
@@ -43950,8 +43950,7 @@ const openapi: OpenAPISpec = {
43950
43950
  in: 'query',
43951
43951
  name: 'access_code_ids',
43952
43952
  schema: {
43953
- description:
43954
- 'IDs of the access codes that you want to retrieve. Specify `device_id`, `access_code_ids`, `access_method_id`, `access_grant_id`, or `access_grant_key`.',
43953
+ description: 'IDs of the access codes that you want to retrieve.',
43955
43954
  items: { format: 'uuid', type: 'string' },
43956
43955
  type: 'array',
43957
43956
  },
@@ -43961,7 +43960,7 @@ const openapi: OpenAPISpec = {
43961
43960
  name: 'access_method_id',
43962
43961
  schema: {
43963
43962
  description:
43964
- 'ID of the access method for which you want to list access codes. Specify `device_id`, `access_code_ids`, `access_method_id`, `access_grant_id`, or `access_grant_key`.',
43963
+ 'ID of the access method for which you want to list access codes.',
43965
43964
  format: 'uuid',
43966
43965
  type: 'string',
43967
43966
  },
@@ -43971,7 +43970,7 @@ const openapi: OpenAPISpec = {
43971
43970
  name: 'access_grant_id',
43972
43971
  schema: {
43973
43972
  description:
43974
- 'ID of the access grant for which you want to list access codes. Specify `device_id`, `access_code_ids`, `access_method_id`, `access_grant_id`, or `access_grant_key`.',
43973
+ 'ID of the access grant for which you want to list access codes.',
43975
43974
  format: 'uuid',
43976
43975
  type: 'string',
43977
43976
  },
@@ -43981,7 +43980,7 @@ const openapi: OpenAPISpec = {
43981
43980
  name: 'access_grant_key',
43982
43981
  schema: {
43983
43982
  description:
43984
- 'Key of the access grant for which you want to list access codes. Specify `device_id`, `access_code_ids`, `access_method_id`, `access_grant_id`, or `access_grant_key`.',
43983
+ 'Key of the access grant for which you want to list access codes.',
43985
43984
  minLength: 1,
43986
43985
  type: 'string',
43987
43986
  },
@@ -44065,7 +44064,6 @@ const openapi: OpenAPISpec = {
44065
44064
  'x-fern-sdk-group-name': ['access_codes'],
44066
44065
  'x-fern-sdk-method-name': 'list',
44067
44066
  'x-fern-sdk-return-value': 'access_codes',
44068
- 'x-has-required-parameters': true,
44069
44067
  'x-response-key': 'access_codes',
44070
44068
  'x-title': 'List Access Codes',
44071
44069
  },
@@ -45685,6 +45683,16 @@ const openapi: OpenAPISpec = {
45685
45683
  description: 'Gets unmanaged Access Grants (where is_managed = false).',
45686
45684
  operationId: 'accessGrantsUnmanagedListGet',
45687
45685
  parameters: [
45686
+ {
45687
+ in: 'query',
45688
+ name: 'customer_key',
45689
+ schema: {
45690
+ description:
45691
+ 'Customer key for which you want to list unmanaged Access Grants.',
45692
+ minLength: 1,
45693
+ type: 'string',
45694
+ },
45695
+ },
45688
45696
  {
45689
45697
  in: 'query',
45690
45698
  name: 'user_identity_id',
@@ -46328,6 +46336,16 @@ const openapi: OpenAPISpec = {
46328
46336
  'Lists all access methods, usually filtered by Access Grant.',
46329
46337
  operationId: 'accessMethodsListGet',
46330
46338
  parameters: [
46339
+ {
46340
+ in: 'query',
46341
+ name: 'customer_key',
46342
+ schema: {
46343
+ description:
46344
+ 'Customer key for which you want to list access methods.',
46345
+ minLength: 1,
46346
+ type: 'string',
46347
+ },
46348
+ },
46331
46349
  {
46332
46350
  in: 'query',
46333
46351
  name: 'access_grant_id',
@@ -77687,6 +77705,16 @@ const openapi: OpenAPISpec = {
77687
77705
  'Returns a list of all [user identities](https://www.seam.co/docs/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity).',
77688
77706
  operationId: 'userIdentitiesListGet',
77689
77707
  parameters: [
77708
+ {
77709
+ in: 'query',
77710
+ name: 'customer_key',
77711
+ schema: {
77712
+ description:
77713
+ 'Customer key for which you want to list user identities.',
77714
+ minLength: 1,
77715
+ type: 'string',
77716
+ },
77717
+ },
77690
77718
  {
77691
77719
  in: 'query',
77692
77720
  name: 'user_identity_ids',
@@ -6989,15 +6989,15 @@ export type Routes = {
6989
6989
  commonParams: {
6990
6990
  /** Customer key for which you want to list access codes. */
6991
6991
  customer_key?: string | undefined
6992
- /** ID of the device for which you want to list access codes. Specify `device_id`, `access_code_ids`, `access_method_id`, `access_grant_id`, or `access_grant_key`. */
6992
+ /** ID of the device for which you want to list access codes. */
6993
6993
  device_id?: string | undefined
6994
- /** IDs of the access codes that you want to retrieve. Specify `device_id`, `access_code_ids`, `access_method_id`, `access_grant_id`, or `access_grant_key`. */
6994
+ /** IDs of the access codes that you want to retrieve. */
6995
6995
  access_code_ids?: string[] | undefined
6996
- /** ID of the access method for which you want to list access codes. Specify `device_id`, `access_code_ids`, `access_method_id`, `access_grant_id`, or `access_grant_key`. */
6996
+ /** ID of the access method for which you want to list access codes. */
6997
6997
  access_method_id?: string | undefined
6998
- /** ID of the access grant for which you want to list access codes. Specify `device_id`, `access_code_ids`, `access_method_id`, `access_grant_id`, or `access_grant_key`. */
6998
+ /** ID of the access grant for which you want to list access codes. */
6999
6999
  access_grant_id?: string | undefined
7000
- /** Key of the access grant for which you want to list access codes. Specify `device_id`, `access_code_ids`, `access_method_id`, `access_grant_id`, or `access_grant_key`. */
7000
+ /** Key of the access grant for which you want to list access codes. */
7001
7001
  access_grant_key?: string | undefined
7002
7002
  /** Your user ID for the user by which to filter access codes. */
7003
7003
  user_identifier_key?: string | undefined
@@ -19988,6 +19988,8 @@ export type Routes = {
19988
19988
  queryParams: {}
19989
19989
  jsonBody: {}
19990
19990
  commonParams: {
19991
+ /** Customer key for which you want to list unmanaged Access Grants. */
19992
+ customer_key?: string | undefined
19991
19993
  /** ID of user identity by which you want to filter the list of unmanaged Access Grants. */
19992
19994
  user_identity_id?: string | undefined
19993
19995
  /** ID of the access system by which you want to filter the list of unmanaged Access Grants. */
@@ -28886,6 +28888,8 @@ export type Routes = {
28886
28888
  queryParams: {}
28887
28889
  jsonBody: {}
28888
28890
  commonParams: {
28891
+ /** Customer key for which you want to list access methods. */
28892
+ customer_key?: string | undefined
28889
28893
  /** ID of Access Grant to list access methods for. */
28890
28894
  access_grant_id?: string | undefined
28891
28895
  /** Key of Access Grant to list access methods for. */
@@ -182685,6 +182689,8 @@ export type Routes = {
182685
182689
  queryParams: {}
182686
182690
  jsonBody: {}
182687
182691
  commonParams: {
182692
+ /** Customer key for which you want to list user identities. */
182693
+ customer_key?: string | undefined
182688
182694
  /** Array of user identity IDs by which to filter the list of user identities. */
182689
182695
  user_identity_ids?: string[] | undefined
182690
182696
  /** String for which to search. Filters returned user identities to include all records that satisfy a partial match using `full_name`, `phone_number`, `email_address` or `user_identity_id`. */