@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.
@@ -82306,6 +82306,11 @@ declare const _default: {
82306
82306
  };
82307
82307
  type: string;
82308
82308
  };
82309
+ access_method_id: {
82310
+ description: string;
82311
+ format: string;
82312
+ type: string;
82313
+ };
82309
82314
  customer_key: {
82310
82315
  description: string;
82311
82316
  type: string;
@@ -88537,16 +88542,25 @@ declare const _default: {
88537
88542
  get: {
88538
88543
  description: string;
88539
88544
  operationId: string;
88540
- parameters: {
88545
+ parameters: ({
88541
88546
  in: string;
88542
88547
  name: string;
88543
- required: boolean;
88544
88548
  schema: {
88545
88549
  description: string;
88546
88550
  format: string;
88547
88551
  type: string;
88552
+ minLength?: never;
88548
88553
  };
88549
- }[];
88554
+ } | {
88555
+ in: string;
88556
+ name: string;
88557
+ schema: {
88558
+ description: string;
88559
+ minLength: number;
88560
+ type: string;
88561
+ format?: never;
88562
+ };
88563
+ })[];
88550
88564
  responses: {
88551
88565
  200: {
88552
88566
  content: {
@@ -88620,6 +88634,11 @@ declare const _default: {
88620
88634
  format: string;
88621
88635
  type: string;
88622
88636
  };
88637
+ access_grant_key: {
88638
+ description: string;
88639
+ minLength: number;
88640
+ type: string;
88641
+ };
88623
88642
  acs_entrance_id: {
88624
88643
  description: string;
88625
88644
  format: string;
@@ -88636,7 +88655,6 @@ declare const _default: {
88636
88655
  type: string;
88637
88656
  };
88638
88657
  };
88639
- required: string[];
88640
88658
  type: string;
88641
88659
  };
88642
88660
  };
@@ -137071,10 +137089,12 @@ type Routes = {
137071
137089
  commonParams: {
137072
137090
  /** Customer key for which you want to list access codes. */
137073
137091
  customer_key?: string | undefined;
137074
- /** ID of the device for which you want to list access codes. Specify either `device_id` or `access_code_ids`. */
137092
+ /** ID of the device for which you want to list access codes. Specify `device_id`, `access_code_ids`, or `access_method_id`. */
137075
137093
  device_id?: string | undefined;
137076
- /** IDs of the access codes that you want to retrieve. Specify either `device_id` or `access_code_ids`. */
137094
+ /** IDs of the access codes that you want to retrieve. Specify `device_id`, `access_code_ids`, or `access_method_id`. */
137077
137095
  access_code_ids?: string[] | undefined;
137096
+ /** ID of the access method for which you want to list access codes. Specify `device_id`, `access_code_ids`, or `access_method_id`. */
137097
+ access_method_id?: string | undefined;
137078
137098
  /** Your user ID for the user by which to filter access codes. */
137079
137099
  user_identifier_key?: string | undefined;
137080
137100
  /** Numerical limit on the number of access codes to return. */
@@ -149421,7 +149441,9 @@ type Routes = {
149421
149441
  jsonBody: {};
149422
149442
  commonParams: {
149423
149443
  /** ID of Access Grant to list access methods for. */
149424
- access_grant_id: string;
149444
+ access_grant_id?: string | undefined;
149445
+ /** Key of Access Grant to list access methods for. */
149446
+ access_grant_key?: string | undefined;
149425
149447
  /** ID of the device for which you want to retrieve all access methods. */
149426
149448
  device_id?: string | undefined;
149427
149449
  /** ID of the entrance for which you want to retrieve all access methods. */
package/dist/index.cjs CHANGED
@@ -35236,7 +35236,7 @@ var openapi_default = {
35236
35236
  },
35237
35237
  "/access_codes/list": {
35238
35238
  get: {
35239
- 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`.",
35239
+ 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`.",
35240
35240
  operationId: "accessCodesListGet",
35241
35241
  parameters: [
35242
35242
  {
@@ -35251,7 +35251,7 @@ var openapi_default = {
35251
35251
  in: "query",
35252
35252
  name: "device_id",
35253
35253
  schema: {
35254
- description: "ID of the device for which you want to list access codes. Specify either `device_id` or `access_code_ids`.",
35254
+ description: "ID of the device for which you want to list access codes. Specify `device_id`, `access_code_ids`, or `access_method_id`.",
35255
35255
  format: "uuid",
35256
35256
  type: "string"
35257
35257
  }
@@ -35260,11 +35260,20 @@ var openapi_default = {
35260
35260
  in: "query",
35261
35261
  name: "access_code_ids",
35262
35262
  schema: {
35263
- description: "IDs of the access codes that you want to retrieve. Specify either `device_id` or `access_code_ids`.",
35263
+ description: "IDs of the access codes that you want to retrieve. Specify `device_id`, `access_code_ids`, or `access_method_id`.",
35264
35264
  items: { format: "uuid", type: "string" },
35265
35265
  type: "array"
35266
35266
  }
35267
35267
  },
35268
+ {
35269
+ in: "query",
35270
+ name: "access_method_id",
35271
+ schema: {
35272
+ description: "ID of the access method for which you want to list access codes. Specify `device_id`, `access_code_ids`, or `access_method_id`.",
35273
+ format: "uuid",
35274
+ type: "string"
35275
+ }
35276
+ },
35268
35277
  {
35269
35278
  in: "query",
35270
35279
  name: "user_identifier_key",
@@ -35341,7 +35350,7 @@ var openapi_default = {
35341
35350
  "x-title": "List Access Codes"
35342
35351
  },
35343
35352
  post: {
35344
- 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`.",
35353
+ 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`.",
35345
35354
  operationId: "accessCodesListPost",
35346
35355
  requestBody: {
35347
35356
  content: {
@@ -35349,16 +35358,21 @@ var openapi_default = {
35349
35358
  schema: {
35350
35359
  properties: {
35351
35360
  access_code_ids: {
35352
- description: "IDs of the access codes that you want to retrieve. Specify either `device_id` or `access_code_ids`.",
35361
+ description: "IDs of the access codes that you want to retrieve. Specify `device_id`, `access_code_ids`, or `access_method_id`.",
35353
35362
  items: { format: "uuid", type: "string" },
35354
35363
  type: "array"
35355
35364
  },
35365
+ access_method_id: {
35366
+ description: "ID of the access method for which you want to list access codes. Specify `device_id`, `access_code_ids`, or `access_method_id`.",
35367
+ format: "uuid",
35368
+ type: "string"
35369
+ },
35356
35370
  customer_key: {
35357
35371
  description: "Customer key for which you want to list access codes.",
35358
35372
  type: "string"
35359
35373
  },
35360
35374
  device_id: {
35361
- description: "ID of the device for which you want to list access codes. Specify either `device_id` or `access_code_ids`.",
35375
+ description: "ID of the device for which you want to list access codes. Specify `device_id`, `access_code_ids`, or `access_method_id`.",
35362
35376
  format: "uuid",
35363
35377
  type: "string"
35364
35378
  },
@@ -40956,17 +40970,24 @@ var openapi_default = {
40956
40970
  {
40957
40971
  in: "query",
40958
40972
  name: "access_grant_id",
40959
- required: true,
40960
40973
  schema: {
40961
40974
  description: "ID of Access Grant to list access methods for.",
40962
40975
  format: "uuid",
40963
40976
  type: "string"
40964
40977
  }
40965
40978
  },
40979
+ {
40980
+ in: "query",
40981
+ name: "access_grant_key",
40982
+ schema: {
40983
+ description: "Key of Access Grant to list access methods for.",
40984
+ minLength: 1,
40985
+ type: "string"
40986
+ }
40987
+ },
40966
40988
  {
40967
40989
  in: "query",
40968
40990
  name: "device_id",
40969
- required: false,
40970
40991
  schema: {
40971
40992
  description: "ID of the device for which you want to retrieve all access methods.",
40972
40993
  format: "uuid",
@@ -40976,7 +40997,6 @@ var openapi_default = {
40976
40997
  {
40977
40998
  in: "query",
40978
40999
  name: "acs_entrance_id",
40979
- required: false,
40980
41000
  schema: {
40981
41001
  description: "ID of the entrance for which you want to retrieve all access methods.",
40982
41002
  format: "uuid",
@@ -40986,7 +41006,6 @@ var openapi_default = {
40986
41006
  {
40987
41007
  in: "query",
40988
41008
  name: "space_id",
40989
- required: false,
40990
41009
  schema: {
40991
41010
  description: "ID of the space for which you want to retrieve all access methods.",
40992
41011
  format: "uuid",
@@ -41044,6 +41063,11 @@ var openapi_default = {
41044
41063
  format: "uuid",
41045
41064
  type: "string"
41046
41065
  },
41066
+ access_grant_key: {
41067
+ description: "Key of Access Grant to list access methods for.",
41068
+ minLength: 1,
41069
+ type: "string"
41070
+ },
41047
41071
  acs_entrance_id: {
41048
41072
  description: "ID of the entrance for which you want to retrieve all access methods.",
41049
41073
  format: "uuid",
@@ -41060,7 +41084,6 @@ var openapi_default = {
41060
41084
  type: "string"
41061
41085
  }
41062
41086
  },
41063
- required: ["access_grant_id"],
41064
41087
  type: "object"
41065
41088
  }
41066
41089
  }