@seamapi/types 1.783.0 → 1.785.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.
@@ -4392,12 +4392,14 @@ export type Routes = {
4392
4392
  commonParams: {
4393
4393
  /** Customer key for which you want to list access codes. */
4394
4394
  customer_key?: string | undefined;
4395
- /** ID of the device for which you want to list access codes. Specify `device_id`, `access_code_ids`, or `access_method_id`. */
4395
+ /** 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`. */
4396
4396
  device_id?: string | undefined;
4397
- /** IDs of the access codes that you want to retrieve. Specify `device_id`, `access_code_ids`, or `access_method_id`. */
4397
+ /** IDs of the access codes that you want to retrieve. Specify `device_id`, `access_code_ids`, `access_method_id`, or `access_grant_id`. */
4398
4398
  access_code_ids?: string[] | undefined;
4399
- /** ID of the access method for which you want to list access codes. Specify `device_id`, `access_code_ids`, or `access_method_id`. */
4399
+ /** 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`. */
4400
4400
  access_method_id?: string | undefined;
4401
+ /** 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`. */
4402
+ access_grant_id?: string | undefined;
4401
4403
  /** Your user ID for the user by which to filter access codes. */
4402
4404
  user_identifier_key?: string | undefined;
4403
4405
  /** Numerical limit on the number of access codes to return. */
@@ -12851,6 +12853,8 @@ export type Routes = {
12851
12853
  location_id?: string | undefined;
12852
12854
  /** ID of the space by which you want to filter the list of Access Grants. */
12853
12855
  space_id?: string | undefined;
12856
+ /** ID of the access code by which you want to filter the list of Access Grants. */
12857
+ access_code_id?: string | undefined;
12854
12858
  /** Filter Access Grants by access_grant_key. Use null to filter for Access Grants without an access_grant_key. */
12855
12859
  access_grant_key?: (string | null) | undefined;
12856
12860
  /** Filter Access Grants by reservation_key. */
@@ -17035,6 +17039,8 @@ export type Routes = {
17035
17039
  acs_entrance_id?: string | undefined;
17036
17040
  /** ID of the space for which you want to retrieve all access methods. */
17037
17041
  space_id?: string | undefined;
17042
+ /** ID of the access code for which you want to retrieve all access methods. */
17043
+ access_code_id?: string | undefined;
17038
17044
  };
17039
17045
  formData: {};
17040
17046
  jsonResponse: {
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@seamapi/types",
3
- "version": "1.783.0",
3
+ "version": "1.785.0",
4
4
  "description": "TypeScript types for the Seam API.",
5
5
  "type": "module",
6
6
  "main": "index.js",
@@ -32406,7 +32406,7 @@ export default {
32406
32406
  '/access_codes/list': {
32407
32407
  get: {
32408
32408
  description:
32409
- '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`.',
32409
+ '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`, `access_method_id`, or `access_grant_id`.',
32410
32410
  operationId: 'accessCodesListGet',
32411
32411
  parameters: [
32412
32412
  {
@@ -32423,7 +32423,7 @@ export default {
32423
32423
  name: 'device_id',
32424
32424
  schema: {
32425
32425
  description:
32426
- 'ID of the device for which you want to list access codes. Specify `device_id`, `access_code_ids`, or `access_method_id`.',
32426
+ '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`.',
32427
32427
  format: 'uuid',
32428
32428
  type: 'string',
32429
32429
  },
@@ -32433,7 +32433,7 @@ export default {
32433
32433
  name: 'access_code_ids',
32434
32434
  schema: {
32435
32435
  description:
32436
- 'IDs of the access codes that you want to retrieve. Specify `device_id`, `access_code_ids`, or `access_method_id`.',
32436
+ 'IDs of the access codes that you want to retrieve. Specify `device_id`, `access_code_ids`, `access_method_id`, or `access_grant_id`.',
32437
32437
  items: { format: 'uuid', type: 'string' },
32438
32438
  type: 'array',
32439
32439
  },
@@ -32443,7 +32443,17 @@ export default {
32443
32443
  name: 'access_method_id',
32444
32444
  schema: {
32445
32445
  description:
32446
- 'ID of the access method for which you want to list access codes. Specify `device_id`, `access_code_ids`, or `access_method_id`.',
32446
+ '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`.',
32447
+ format: 'uuid',
32448
+ type: 'string',
32449
+ },
32450
+ },
32451
+ {
32452
+ in: 'query',
32453
+ name: 'access_grant_id',
32454
+ schema: {
32455
+ description:
32456
+ '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`.',
32447
32457
  format: 'uuid',
32448
32458
  type: 'string',
32449
32459
  },
@@ -32529,7 +32539,7 @@ export default {
32529
32539
  },
32530
32540
  post: {
32531
32541
  description:
32532
- '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`.',
32542
+ '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`, `access_method_id`, or `access_grant_id`.',
32533
32543
  operationId: 'accessCodesListPost',
32534
32544
  requestBody: {
32535
32545
  content: {
@@ -32538,13 +32548,19 @@ export default {
32538
32548
  properties: {
32539
32549
  access_code_ids: {
32540
32550
  description:
32541
- 'IDs of the access codes that you want to retrieve. Specify `device_id`, `access_code_ids`, or `access_method_id`.',
32551
+ 'IDs of the access codes that you want to retrieve. Specify `device_id`, `access_code_ids`, `access_method_id`, or `access_grant_id`.',
32542
32552
  items: { format: 'uuid', type: 'string' },
32543
32553
  type: 'array',
32544
32554
  },
32555
+ access_grant_id: {
32556
+ description:
32557
+ '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`.',
32558
+ format: 'uuid',
32559
+ type: 'string',
32560
+ },
32545
32561
  access_method_id: {
32546
32562
  description:
32547
- 'ID of the access method for which you want to list access codes. Specify `device_id`, `access_code_ids`, or `access_method_id`.',
32563
+ '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`.',
32548
32564
  format: 'uuid',
32549
32565
  type: 'string',
32550
32566
  },
@@ -32555,7 +32571,7 @@ export default {
32555
32571
  },
32556
32572
  device_id: {
32557
32573
  description:
32558
- 'ID of the device for which you want to list access codes. Specify `device_id`, `access_code_ids`, or `access_method_id`.',
32574
+ '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`.',
32559
32575
  format: 'uuid',
32560
32576
  type: 'string',
32561
32577
  },
@@ -34992,6 +35008,16 @@ export default {
34992
35008
  type: 'string',
34993
35009
  },
34994
35010
  },
35011
+ {
35012
+ in: 'query',
35013
+ name: 'access_code_id',
35014
+ schema: {
35015
+ description:
35016
+ 'ID of the access code by which you want to filter the list of Access Grants.',
35017
+ format: 'uuid',
35018
+ type: 'string',
35019
+ },
35020
+ },
34995
35021
  {
34996
35022
  in: 'query',
34997
35023
  name: 'access_grant_key',
@@ -35057,6 +35083,12 @@ export default {
35057
35083
  'application/json': {
35058
35084
  schema: {
35059
35085
  properties: {
35086
+ access_code_id: {
35087
+ description:
35088
+ 'ID of the access code by which you want to filter the list of Access Grants.',
35089
+ format: 'uuid',
35090
+ type: 'string',
35091
+ },
35060
35092
  access_grant_ids: {
35061
35093
  description: 'IDs of the access grants to retrieve.',
35062
35094
  items: { format: 'uuid', type: 'string' },
@@ -38733,6 +38765,16 @@ export default {
38733
38765
  type: 'string',
38734
38766
  },
38735
38767
  },
38768
+ {
38769
+ in: 'query',
38770
+ name: 'access_code_id',
38771
+ schema: {
38772
+ description:
38773
+ 'ID of the access code for which you want to retrieve all access methods.',
38774
+ format: 'uuid',
38775
+ type: 'string',
38776
+ },
38777
+ },
38736
38778
  ],
38737
38779
  responses: {
38738
38780
  200: {
@@ -38780,6 +38822,12 @@ export default {
38780
38822
  'application/json': {
38781
38823
  schema: {
38782
38824
  properties: {
38825
+ access_code_id: {
38826
+ description:
38827
+ 'ID of the access code for which you want to retrieve all access methods.',
38828
+ format: 'uuid',
38829
+ type: 'string',
38830
+ },
38783
38831
  access_grant_id: {
38784
38832
  description:
38785
38833
  'ID of Access Grant to list access methods for.',
@@ -5023,12 +5023,14 @@ export type Routes = {
5023
5023
  commonParams: {
5024
5024
  /** Customer key for which you want to list access codes. */
5025
5025
  customer_key?: string | undefined
5026
- /** ID of the device for which you want to list access codes. Specify `device_id`, `access_code_ids`, or `access_method_id`. */
5026
+ /** 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`. */
5027
5027
  device_id?: string | undefined
5028
- /** IDs of the access codes that you want to retrieve. Specify `device_id`, `access_code_ids`, or `access_method_id`. */
5028
+ /** IDs of the access codes that you want to retrieve. Specify `device_id`, `access_code_ids`, `access_method_id`, or `access_grant_id`. */
5029
5029
  access_code_ids?: string[] | undefined
5030
- /** ID of the access method for which you want to list access codes. Specify `device_id`, `access_code_ids`, or `access_method_id`. */
5030
+ /** 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`. */
5031
5031
  access_method_id?: string | undefined
5032
+ /** 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`. */
5033
+ access_grant_id?: string | undefined
5032
5034
  /** Your user ID for the user by which to filter access codes. */
5033
5035
  user_identifier_key?: string | undefined
5034
5036
  /** Numerical limit on the number of access codes to return. */
@@ -14794,6 +14796,8 @@ export type Routes = {
14794
14796
  location_id?: string | undefined
14795
14797
  /** ID of the space by which you want to filter the list of Access Grants. */
14796
14798
  space_id?: string | undefined
14799
+ /** ID of the access code by which you want to filter the list of Access Grants. */
14800
+ access_code_id?: string | undefined
14797
14801
  /** Filter Access Grants by access_grant_key. Use null to filter for Access Grants without an access_grant_key. */
14798
14802
  access_grant_key?: (string | null) | undefined
14799
14803
  /** Filter Access Grants by reservation_key. */
@@ -19708,6 +19712,8 @@ export type Routes = {
19708
19712
  acs_entrance_id?: string | undefined
19709
19713
  /** ID of the space for which you want to retrieve all access methods. */
19710
19714
  space_id?: string | undefined
19715
+ /** ID of the access code for which you want to retrieve all access methods. */
19716
+ access_code_id?: string | undefined
19711
19717
  }
19712
19718
  formData: {}
19713
19719
  jsonResponse: {