@seamapi/types 1.956.0 → 1.957.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.
@@ -4956,14 +4956,16 @@ export type Routes = {
4956
4956
  commonParams: {
4957
4957
  /** Customer key for which you want to list access codes. */
4958
4958
  customer_key?: string | undefined;
4959
- /** ID of the device for which you want to list access codes. Specify `device_id`, `access_code_ids`, `access_method_id`, or `access_grant_id`. */
4959
+ /** 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`. */
4960
4960
  device_id?: string | undefined;
4961
- /** IDs of the access codes that you want to retrieve. Specify `device_id`, `access_code_ids`, `access_method_id`, or `access_grant_id`. */
4961
+ /** 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`. */
4962
4962
  access_code_ids?: string[] | undefined;
4963
- /** ID of the access method for which you want to list access codes. Specify `device_id`, `access_code_ids`, `access_method_id`, or `access_grant_id`. */
4963
+ /** 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`. */
4964
4964
  access_method_id?: string | undefined;
4965
- /** ID of the access grant for which you want to list access codes. Specify `device_id`, `access_code_ids`, `access_method_id`, or `access_grant_id`. */
4965
+ /** 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`. */
4966
4966
  access_grant_id?: string | undefined;
4967
+ /** 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`. */
4968
+ access_grant_key?: string | undefined;
4967
4969
  /** Your user ID for the user by which to filter access codes. */
4968
4970
  user_identifier_key?: string | undefined;
4969
4971
  /** Numerical limit on the number of access codes to return. */
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@seamapi/types",
3
- "version": "1.956.0",
3
+ "version": "1.957.0",
4
4
  "description": "TypeScript types for the Seam API.",
5
5
  "type": "module",
6
6
  "main": "index.js",
@@ -36270,7 +36270,7 @@ const openapi: OpenAPISpec = {
36270
36270
  '/access_codes/list': {
36271
36271
  get: {
36272
36272
  description:
36273
- 'Returns a list of all [access codes](https://docs.seam.co/low-level-apis/smart-locks/access-codes).\n\nSpecify `device_id`, `access_code_ids`, `access_method_id`, or `access_grant_id`.',
36273
+ 'Returns a list of all [access codes](https://docs.seam.co/low-level-apis/smart-locks/access-codes).\n\nSpecify `device_id`, `access_code_ids`, `access_method_id`, `access_grant_id`, or `access_grant_key`.',
36274
36274
  operationId: 'accessCodesListGet',
36275
36275
  parameters: [
36276
36276
  {
@@ -36287,7 +36287,7 @@ const openapi: OpenAPISpec = {
36287
36287
  name: 'device_id',
36288
36288
  schema: {
36289
36289
  description:
36290
- 'ID of the device for which you want to list access codes. Specify `device_id`, `access_code_ids`, `access_method_id`, or `access_grant_id`.',
36290
+ '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`.',
36291
36291
  format: 'uuid',
36292
36292
  type: 'string',
36293
36293
  },
@@ -36297,7 +36297,7 @@ const openapi: OpenAPISpec = {
36297
36297
  name: 'access_code_ids',
36298
36298
  schema: {
36299
36299
  description:
36300
- 'IDs of the access codes that you want to retrieve. Specify `device_id`, `access_code_ids`, `access_method_id`, or `access_grant_id`.',
36300
+ '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`.',
36301
36301
  items: { format: 'uuid', type: 'string' },
36302
36302
  type: 'array',
36303
36303
  },
@@ -36307,7 +36307,7 @@ const openapi: OpenAPISpec = {
36307
36307
  name: 'access_method_id',
36308
36308
  schema: {
36309
36309
  description:
36310
- 'ID of the access method for which you want to list access codes. Specify `device_id`, `access_code_ids`, `access_method_id`, or `access_grant_id`.',
36310
+ '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`.',
36311
36311
  format: 'uuid',
36312
36312
  type: 'string',
36313
36313
  },
@@ -36317,11 +36317,20 @@ const openapi: OpenAPISpec = {
36317
36317
  name: 'access_grant_id',
36318
36318
  schema: {
36319
36319
  description:
36320
- 'ID of the access grant for which you want to list access codes. Specify `device_id`, `access_code_ids`, `access_method_id`, or `access_grant_id`.',
36320
+ '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`.',
36321
36321
  format: 'uuid',
36322
36322
  type: 'string',
36323
36323
  },
36324
36324
  },
36325
+ {
36326
+ in: 'query',
36327
+ name: 'access_grant_key',
36328
+ schema: {
36329
+ description:
36330
+ '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`.',
36331
+ type: 'string',
36332
+ },
36333
+ },
36325
36334
  {
36326
36335
  in: 'query',
36327
36336
  name: 'user_identifier_key',
@@ -36403,7 +36412,7 @@ const openapi: OpenAPISpec = {
36403
36412
  },
36404
36413
  post: {
36405
36414
  description:
36406
- 'Returns a list of all [access codes](https://docs.seam.co/low-level-apis/smart-locks/access-codes).\n\nSpecify `device_id`, `access_code_ids`, `access_method_id`, or `access_grant_id`.',
36415
+ 'Returns a list of all [access codes](https://docs.seam.co/low-level-apis/smart-locks/access-codes).\n\nSpecify `device_id`, `access_code_ids`, `access_method_id`, `access_grant_id`, or `access_grant_key`.',
36407
36416
  operationId: 'accessCodesListPost',
36408
36417
  requestBody: {
36409
36418
  content: {
@@ -36412,19 +36421,24 @@ const openapi: OpenAPISpec = {
36412
36421
  properties: {
36413
36422
  access_code_ids: {
36414
36423
  description:
36415
- 'IDs of the access codes that you want to retrieve. Specify `device_id`, `access_code_ids`, `access_method_id`, or `access_grant_id`.',
36424
+ '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`.',
36416
36425
  items: { format: 'uuid', type: 'string' },
36417
36426
  type: 'array',
36418
36427
  },
36419
36428
  access_grant_id: {
36420
36429
  description:
36421
- 'ID of the access grant for which you want to list access codes. Specify `device_id`, `access_code_ids`, `access_method_id`, or `access_grant_id`.',
36430
+ '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`.',
36422
36431
  format: 'uuid',
36423
36432
  type: 'string',
36424
36433
  },
36434
+ access_grant_key: {
36435
+ description:
36436
+ '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`.',
36437
+ type: 'string',
36438
+ },
36425
36439
  access_method_id: {
36426
36440
  description:
36427
- 'ID of the access method for which you want to list access codes. Specify `device_id`, `access_code_ids`, `access_method_id`, or `access_grant_id`.',
36441
+ '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`.',
36428
36442
  format: 'uuid',
36429
36443
  type: 'string',
36430
36444
  },
@@ -36435,7 +36449,7 @@ const openapi: OpenAPISpec = {
36435
36449
  },
36436
36450
  device_id: {
36437
36451
  description:
36438
- 'ID of the device for which you want to list access codes. Specify `device_id`, `access_code_ids`, `access_method_id`, or `access_grant_id`.',
36452
+ '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`.',
36439
36453
  format: 'uuid',
36440
36454
  type: 'string',
36441
36455
  },
@@ -5698,14 +5698,16 @@ export type Routes = {
5698
5698
  commonParams: {
5699
5699
  /** Customer key for which you want to list access codes. */
5700
5700
  customer_key?: string | undefined
5701
- /** ID of the device for which you want to list access codes. Specify `device_id`, `access_code_ids`, `access_method_id`, or `access_grant_id`. */
5701
+ /** 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`. */
5702
5702
  device_id?: string | undefined
5703
- /** IDs of the access codes that you want to retrieve. Specify `device_id`, `access_code_ids`, `access_method_id`, or `access_grant_id`. */
5703
+ /** 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`. */
5704
5704
  access_code_ids?: string[] | undefined
5705
- /** ID of the access method for which you want to list access codes. Specify `device_id`, `access_code_ids`, `access_method_id`, or `access_grant_id`. */
5705
+ /** 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`. */
5706
5706
  access_method_id?: string | undefined
5707
- /** ID of the access grant for which you want to list access codes. Specify `device_id`, `access_code_ids`, `access_method_id`, or `access_grant_id`. */
5707
+ /** 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`. */
5708
5708
  access_grant_id?: string | undefined
5709
+ /** 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`. */
5710
+ access_grant_key?: string | undefined
5709
5711
  /** Your user ID for the user by which to filter access codes. */
5710
5712
  user_identifier_key?: string | undefined
5711
5713
  /** Numerical limit on the number of access codes to return. */