@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.
@@ -20583,6 +20583,11 @@ declare const _default: {
20583
20583
  };
20584
20584
  type: string;
20585
20585
  };
20586
+ access_method_id: {
20587
+ description: string;
20588
+ format: string;
20589
+ type: string;
20590
+ };
20586
20591
  customer_key: {
20587
20592
  description: string;
20588
20593
  type: string;
@@ -26814,16 +26819,25 @@ declare const _default: {
26814
26819
  get: {
26815
26820
  description: string;
26816
26821
  operationId: string;
26817
- parameters: {
26822
+ parameters: ({
26818
26823
  in: string;
26819
26824
  name: string;
26820
- required: boolean;
26821
26825
  schema: {
26822
26826
  description: string;
26823
26827
  format: string;
26824
26828
  type: string;
26829
+ minLength?: never;
26825
26830
  };
26826
- }[];
26831
+ } | {
26832
+ in: string;
26833
+ name: string;
26834
+ schema: {
26835
+ description: string;
26836
+ minLength: number;
26837
+ type: string;
26838
+ format?: never;
26839
+ };
26840
+ })[];
26827
26841
  responses: {
26828
26842
  200: {
26829
26843
  content: {
@@ -26897,6 +26911,11 @@ declare const _default: {
26897
26911
  format: string;
26898
26912
  type: string;
26899
26913
  };
26914
+ access_grant_key: {
26915
+ description: string;
26916
+ minLength: number;
26917
+ type: string;
26918
+ };
26900
26919
  acs_entrance_id: {
26901
26920
  description: string;
26902
26921
  format: string;
@@ -26913,7 +26932,6 @@ declare const _default: {
26913
26932
  type: string;
26914
26933
  };
26915
26934
  };
26916
- required: string[];
26917
26935
  type: string;
26918
26936
  };
26919
26937
  };
@@ -28675,7 +28675,7 @@ export default {
28675
28675
  },
28676
28676
  '/access_codes/list': {
28677
28677
  get: {
28678
- description: '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`.',
28678
+ description: '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`.',
28679
28679
  operationId: 'accessCodesListGet',
28680
28680
  parameters: [
28681
28681
  {
@@ -28690,7 +28690,7 @@ export default {
28690
28690
  in: 'query',
28691
28691
  name: 'device_id',
28692
28692
  schema: {
28693
- description: 'ID of the device for which you want to list access codes. Specify either `device_id` or `access_code_ids`.',
28693
+ description: 'ID of the device for which you want to list access codes. Specify `device_id`, `access_code_ids`, or `access_method_id`.',
28694
28694
  format: 'uuid',
28695
28695
  type: 'string',
28696
28696
  },
@@ -28699,11 +28699,20 @@ export default {
28699
28699
  in: 'query',
28700
28700
  name: 'access_code_ids',
28701
28701
  schema: {
28702
- description: 'IDs of the access codes that you want to retrieve. Specify either `device_id` or `access_code_ids`.',
28702
+ description: 'IDs of the access codes that you want to retrieve. Specify `device_id`, `access_code_ids`, or `access_method_id`.',
28703
28703
  items: { format: 'uuid', type: 'string' },
28704
28704
  type: 'array',
28705
28705
  },
28706
28706
  },
28707
+ {
28708
+ in: 'query',
28709
+ name: 'access_method_id',
28710
+ schema: {
28711
+ description: 'ID of the access method for which you want to list access codes. Specify `device_id`, `access_code_ids`, or `access_method_id`.',
28712
+ format: 'uuid',
28713
+ type: 'string',
28714
+ },
28715
+ },
28707
28716
  {
28708
28717
  in: 'query',
28709
28718
  name: 'user_identifier_key',
@@ -28780,7 +28789,7 @@ export default {
28780
28789
  'x-title': 'List Access Codes',
28781
28790
  },
28782
28791
  post: {
28783
- description: '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`.',
28792
+ description: '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`.',
28784
28793
  operationId: 'accessCodesListPost',
28785
28794
  requestBody: {
28786
28795
  content: {
@@ -28788,16 +28797,21 @@ export default {
28788
28797
  schema: {
28789
28798
  properties: {
28790
28799
  access_code_ids: {
28791
- description: 'IDs of the access codes that you want to retrieve. Specify either `device_id` or `access_code_ids`.',
28800
+ description: 'IDs of the access codes that you want to retrieve. Specify `device_id`, `access_code_ids`, or `access_method_id`.',
28792
28801
  items: { format: 'uuid', type: 'string' },
28793
28802
  type: 'array',
28794
28803
  },
28804
+ access_method_id: {
28805
+ description: 'ID of the access method for which you want to list access codes. Specify `device_id`, `access_code_ids`, or `access_method_id`.',
28806
+ format: 'uuid',
28807
+ type: 'string',
28808
+ },
28795
28809
  customer_key: {
28796
28810
  description: 'Customer key for which you want to list access codes.',
28797
28811
  type: 'string',
28798
28812
  },
28799
28813
  device_id: {
28800
- description: 'ID of the device for which you want to list access codes. Specify either `device_id` or `access_code_ids`.',
28814
+ description: 'ID of the device for which you want to list access codes. Specify `device_id`, `access_code_ids`, or `access_method_id`.',
28801
28815
  format: 'uuid',
28802
28816
  type: 'string',
28803
28817
  },
@@ -34395,17 +34409,24 @@ export default {
34395
34409
  {
34396
34410
  in: 'query',
34397
34411
  name: 'access_grant_id',
34398
- required: true,
34399
34412
  schema: {
34400
34413
  description: 'ID of Access Grant to list access methods for.',
34401
34414
  format: 'uuid',
34402
34415
  type: 'string',
34403
34416
  },
34404
34417
  },
34418
+ {
34419
+ in: 'query',
34420
+ name: 'access_grant_key',
34421
+ schema: {
34422
+ description: 'Key of Access Grant to list access methods for.',
34423
+ minLength: 1,
34424
+ type: 'string',
34425
+ },
34426
+ },
34405
34427
  {
34406
34428
  in: 'query',
34407
34429
  name: 'device_id',
34408
- required: false,
34409
34430
  schema: {
34410
34431
  description: 'ID of the device for which you want to retrieve all access methods.',
34411
34432
  format: 'uuid',
@@ -34415,7 +34436,6 @@ export default {
34415
34436
  {
34416
34437
  in: 'query',
34417
34438
  name: 'acs_entrance_id',
34418
- required: false,
34419
34439
  schema: {
34420
34440
  description: 'ID of the entrance for which you want to retrieve all access methods.',
34421
34441
  format: 'uuid',
@@ -34425,7 +34445,6 @@ export default {
34425
34445
  {
34426
34446
  in: 'query',
34427
34447
  name: 'space_id',
34428
- required: false,
34429
34448
  schema: {
34430
34449
  description: 'ID of the space for which you want to retrieve all access methods.',
34431
34450
  format: 'uuid',
@@ -34483,6 +34502,11 @@ export default {
34483
34502
  format: 'uuid',
34484
34503
  type: 'string',
34485
34504
  },
34505
+ access_grant_key: {
34506
+ description: 'Key of Access Grant to list access methods for.',
34507
+ minLength: 1,
34508
+ type: 'string',
34509
+ },
34486
34510
  acs_entrance_id: {
34487
34511
  description: 'ID of the entrance for which you want to retrieve all access methods.',
34488
34512
  format: 'uuid',
@@ -34499,7 +34523,6 @@ export default {
34499
34523
  type: 'string',
34500
34524
  },
34501
34525
  },
34502
- required: ['access_grant_id'],
34503
34526
  type: 'object',
34504
34527
  },
34505
34528
  },