@seamapi/types 1.755.0 → 1.757.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.
@@ -4251,10 +4251,12 @@ export type Routes = {
4251
4251
  commonParams: {
4252
4252
  /** Customer key for which you want to list access codes. */
4253
4253
  customer_key?: string | undefined;
4254
- /** ID of the device for which you want to list access codes. Specify either `device_id` or `access_code_ids`. */
4254
+ /** ID of the device for which you want to list access codes. Specify `device_id`, `access_code_ids`, or `access_method_id`. */
4255
4255
  device_id?: string | undefined;
4256
- /** IDs of the access codes that you want to retrieve. Specify either `device_id` or `access_code_ids`. */
4256
+ /** IDs of the access codes that you want to retrieve. Specify `device_id`, `access_code_ids`, or `access_method_id`. */
4257
4257
  access_code_ids?: string[] | undefined;
4258
+ /** ID of the access method for which you want to list access codes. Specify `device_id`, `access_code_ids`, or `access_method_id`. */
4259
+ access_method_id?: string | undefined;
4258
4260
  /** Your user ID for the user by which to filter access codes. */
4259
4261
  user_identifier_key?: string | undefined;
4260
4262
  /** Numerical limit on the number of access codes to return. */
@@ -16601,7 +16603,9 @@ export type Routes = {
16601
16603
  jsonBody: {};
16602
16604
  commonParams: {
16603
16605
  /** ID of Access Grant to list access methods for. */
16604
- access_grant_id: string;
16606
+ access_grant_id?: string | undefined;
16607
+ /** Key of Access Grant to list access methods for. */
16608
+ access_grant_key?: string | undefined;
16605
16609
  /** ID of the device for which you want to retrieve all access methods. */
16606
16610
  device_id?: string | undefined;
16607
16611
  /** ID of the entrance for which you want to retrieve all access methods. */
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@seamapi/types",
3
- "version": "1.755.0",
3
+ "version": "1.757.0",
4
4
  "description": "TypeScript types for the Seam API.",
5
5
  "type": "module",
6
6
  "main": "index.js",
@@ -31979,7 +31979,7 @@ export default {
31979
31979
  '/access_codes/list': {
31980
31980
  get: {
31981
31981
  description:
31982
- 'Returns a list of all [access codes](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).\n\nSpecify either `device_id` or `access_code_ids`.',
31982
+ 'Returns a list of all [access codes](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).\n\nSpecify `device_id`, `access_code_ids`, or `access_method_id`.',
31983
31983
  operationId: 'accessCodesListGet',
31984
31984
  parameters: [
31985
31985
  {
@@ -31996,7 +31996,7 @@ export default {
31996
31996
  name: 'device_id',
31997
31997
  schema: {
31998
31998
  description:
31999
- 'ID of the device for which you want to list access codes. Specify either `device_id` or `access_code_ids`.',
31999
+ 'ID of the device for which you want to list access codes. Specify `device_id`, `access_code_ids`, or `access_method_id`.',
32000
32000
  format: 'uuid',
32001
32001
  type: 'string',
32002
32002
  },
@@ -32006,11 +32006,21 @@ export default {
32006
32006
  name: 'access_code_ids',
32007
32007
  schema: {
32008
32008
  description:
32009
- 'IDs of the access codes that you want to retrieve. Specify either `device_id` or `access_code_ids`.',
32009
+ 'IDs of the access codes that you want to retrieve. Specify `device_id`, `access_code_ids`, or `access_method_id`.',
32010
32010
  items: { format: 'uuid', type: 'string' },
32011
32011
  type: 'array',
32012
32012
  },
32013
32013
  },
32014
+ {
32015
+ in: 'query',
32016
+ name: 'access_method_id',
32017
+ schema: {
32018
+ description:
32019
+ 'ID of the access method for which you want to list access codes. Specify `device_id`, `access_code_ids`, or `access_method_id`.',
32020
+ format: 'uuid',
32021
+ type: 'string',
32022
+ },
32023
+ },
32014
32024
  {
32015
32025
  in: 'query',
32016
32026
  name: 'user_identifier_key',
@@ -32092,7 +32102,7 @@ export default {
32092
32102
  },
32093
32103
  post: {
32094
32104
  description:
32095
- 'Returns a list of all [access codes](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).\n\nSpecify either `device_id` or `access_code_ids`.',
32105
+ 'Returns a list of all [access codes](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).\n\nSpecify `device_id`, `access_code_ids`, or `access_method_id`.',
32096
32106
  operationId: 'accessCodesListPost',
32097
32107
  requestBody: {
32098
32108
  content: {
@@ -32101,10 +32111,16 @@ export default {
32101
32111
  properties: {
32102
32112
  access_code_ids: {
32103
32113
  description:
32104
- 'IDs of the access codes that you want to retrieve. Specify either `device_id` or `access_code_ids`.',
32114
+ 'IDs of the access codes that you want to retrieve. Specify `device_id`, `access_code_ids`, or `access_method_id`.',
32105
32115
  items: { format: 'uuid', type: 'string' },
32106
32116
  type: 'array',
32107
32117
  },
32118
+ access_method_id: {
32119
+ description:
32120
+ 'ID of the access method for which you want to list access codes. Specify `device_id`, `access_code_ids`, or `access_method_id`.',
32121
+ format: 'uuid',
32122
+ type: 'string',
32123
+ },
32108
32124
  customer_key: {
32109
32125
  description:
32110
32126
  'Customer key for which you want to list access codes.',
@@ -32112,7 +32128,7 @@ export default {
32112
32128
  },
32113
32129
  device_id: {
32114
32130
  description:
32115
- 'ID of the device for which you want to list access codes. Specify either `device_id` or `access_code_ids`.',
32131
+ 'ID of the device for which you want to list access codes. Specify `device_id`, `access_code_ids`, or `access_method_id`.',
32116
32132
  format: 'uuid',
32117
32133
  type: 'string',
32118
32134
  },
@@ -38185,17 +38201,24 @@ export default {
38185
38201
  {
38186
38202
  in: 'query',
38187
38203
  name: 'access_grant_id',
38188
- required: true,
38189
38204
  schema: {
38190
38205
  description: 'ID of Access Grant to list access methods for.',
38191
38206
  format: 'uuid',
38192
38207
  type: 'string',
38193
38208
  },
38194
38209
  },
38210
+ {
38211
+ in: 'query',
38212
+ name: 'access_grant_key',
38213
+ schema: {
38214
+ description: 'Key of Access Grant to list access methods for.',
38215
+ minLength: 1,
38216
+ type: 'string',
38217
+ },
38218
+ },
38195
38219
  {
38196
38220
  in: 'query',
38197
38221
  name: 'device_id',
38198
- required: false,
38199
38222
  schema: {
38200
38223
  description:
38201
38224
  'ID of the device for which you want to retrieve all access methods.',
@@ -38206,7 +38229,6 @@ export default {
38206
38229
  {
38207
38230
  in: 'query',
38208
38231
  name: 'acs_entrance_id',
38209
- required: false,
38210
38232
  schema: {
38211
38233
  description:
38212
38234
  'ID of the entrance for which you want to retrieve all access methods.',
@@ -38217,7 +38239,6 @@ export default {
38217
38239
  {
38218
38240
  in: 'query',
38219
38241
  name: 'space_id',
38220
- required: false,
38221
38242
  schema: {
38222
38243
  description:
38223
38244
  'ID of the space for which you want to retrieve all access methods.',
@@ -38278,6 +38299,12 @@ export default {
38278
38299
  format: 'uuid',
38279
38300
  type: 'string',
38280
38301
  },
38302
+ access_grant_key: {
38303
+ description:
38304
+ 'Key of Access Grant to list access methods for.',
38305
+ minLength: 1,
38306
+ type: 'string',
38307
+ },
38281
38308
  acs_entrance_id: {
38282
38309
  description:
38283
38310
  'ID of the entrance for which you want to retrieve all access methods.',
@@ -38297,7 +38324,6 @@ export default {
38297
38324
  type: 'string',
38298
38325
  },
38299
38326
  },
38300
- required: ['access_grant_id'],
38301
38327
  type: 'object',
38302
38328
  },
38303
38329
  },
@@ -4863,10 +4863,12 @@ export type Routes = {
4863
4863
  commonParams: {
4864
4864
  /** Customer key for which you want to list access codes. */
4865
4865
  customer_key?: string | undefined
4866
- /** ID of the device for which you want to list access codes. Specify either `device_id` or `access_code_ids`. */
4866
+ /** ID of the device for which you want to list access codes. Specify `device_id`, `access_code_ids`, or `access_method_id`. */
4867
4867
  device_id?: string | undefined
4868
- /** IDs of the access codes that you want to retrieve. Specify either `device_id` or `access_code_ids`. */
4868
+ /** IDs of the access codes that you want to retrieve. Specify `device_id`, `access_code_ids`, or `access_method_id`. */
4869
4869
  access_code_ids?: string[] | undefined
4870
+ /** ID of the access method for which you want to list access codes. Specify `device_id`, `access_code_ids`, or `access_method_id`. */
4871
+ access_method_id?: string | undefined
4870
4872
  /** Your user ID for the user by which to filter access codes. */
4871
4873
  user_identifier_key?: string | undefined
4872
4874
  /** Numerical limit on the number of access codes to return. */
@@ -19219,7 +19221,9 @@ export type Routes = {
19219
19221
  jsonBody: {}
19220
19222
  commonParams: {
19221
19223
  /** ID of Access Grant to list access methods for. */
19222
- access_grant_id: string
19224
+ access_grant_id?: string | undefined
19225
+ /** Key of Access Grant to list access methods for. */
19226
+ access_grant_key?: string | undefined
19223
19227
  /** ID of the device for which you want to retrieve all access methods. */
19224
19228
  device_id?: string | undefined
19225
19229
  /** ID of the entrance for which you want to retrieve all access methods. */