@seamapi/types 1.713.0 → 1.715.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.
Files changed (12) hide show
  1. package/dist/connect.cjs +5 -50
  2. package/dist/connect.cjs.map +1 -1
  3. package/dist/connect.d.cts +4 -60
  4. package/dist/index.cjs +5 -50
  5. package/dist/index.cjs.map +1 -1
  6. package/lib/seam/connect/openapi.d.ts +1 -46
  7. package/lib/seam/connect/openapi.js +5 -50
  8. package/lib/seam/connect/openapi.js.map +1 -1
  9. package/lib/seam/connect/route-types.d.ts +3 -14
  10. package/package.json +1 -1
  11. package/src/lib/seam/connect/openapi.ts +5 -58
  12. package/src/lib/seam/connect/route-types.ts +3 -14
package/dist/connect.d.cts CHANGED
@@ -69914,20 +69914,6 @@ declare const _default: {
69914
69914
  description: string;
69915
69915
  type: string;
69916
69916
  };
69917
- is_offline_access_code: {
69918
- description: string;
69919
- type: string;
69920
- };
69921
- is_one_time_use: {
69922
- description: string;
69923
- type: string;
69924
- };
69925
- max_time_rounding: {
69926
- default: string;
69927
- description: string;
69928
- enum: string[];
69929
- type: string;
69930
- };
69931
69917
  name: {
69932
69918
  description: string;
69933
69919
  type: string;
@@ -69945,15 +69931,6 @@ declare const _default: {
69945
69931
  description: string;
69946
69932
  type: string;
69947
69933
  };
69948
- use_backup_access_code_pool: {
69949
- description: string;
69950
- type: string;
69951
- };
69952
- use_offline_access_code: {
69953
- deprecated: boolean;
69954
- type: string;
69955
- 'x-deprecated': string;
69956
- };
69957
69934
  };
69958
69935
  required: string[];
69959
69936
  type: string;
@@ -70075,20 +70052,6 @@ declare const _default: {
70075
70052
  description: string;
70076
70053
  type: string;
70077
70054
  };
70078
- is_offline_access_code: {
70079
- description: string;
70080
- type: string;
70081
- };
70082
- is_one_time_use: {
70083
- description: string;
70084
- type: string;
70085
- };
70086
- max_time_rounding: {
70087
- default: string;
70088
- description: string;
70089
- enum: string[];
70090
- type: string;
70091
- };
70092
70055
  name: {
70093
70056
  description: string;
70094
70057
  type: string;
@@ -70106,15 +70069,6 @@ declare const _default: {
70106
70069
  description: string;
70107
70070
  type: string;
70108
70071
  };
70109
- use_backup_access_code_pool: {
70110
- description: string;
70111
- type: string;
70112
- };
70113
- use_offline_access_code: {
70114
- deprecated: boolean;
70115
- type: string;
70116
- 'x-deprecated': string;
70117
- };
70118
70072
  };
70119
70073
  required: string[];
70120
70074
  type: string;
@@ -100322,6 +100276,7 @@ declare const _default: {
100322
100276
  };
100323
100277
  hotel_id: {
100324
100278
  description: string;
100279
+ minLength: number;
100325
100280
  type: string;
100326
100281
  };
100327
100282
  id: {
@@ -118771,7 +118726,7 @@ type Routes = {
118771
118726
  device_ids: string[];
118772
118727
  /** Desired behavior if any device cannot share a code. If `throw` (default), no access codes will be created if any device cannot share a code. If `create_random_code`, a random code will be created on devices that cannot share a code. */
118773
118728
  behavior_when_code_cannot_be_shared?: 'throw' | 'create_random_code';
118774
- /** Preferred code length. Only applicable if you do not specify a `code`. If the affected device does not support the preferred code length, Seam reverts to using the shortest supported code length. */
118729
+ /** Preferred code length. If the affected devices do not support the preferred code length, Seam reverts to using the shortest supported code length. */
118775
118730
  preferred_code_length?: number | undefined;
118776
118731
  /** Name of the new access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes.
118777
118732
 
@@ -118790,21 +118745,10 @@ type Routes = {
118790
118745
  attempt_for_offline_device?: boolean;
118791
118746
  /** Indicates whether [native scheduling](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#native-scheduling) should be used for time-bound codes when supported by the provider. Default: `true`. */
118792
118747
  prefer_native_scheduling?: boolean | undefined;
118793
- /** Indicates whether to use a [backup access code pool](https://docs.seam.co/latest/core-concepts/access-codes#backup-access-codes) provided by Seam. If `true`, you can use [`/access_codes/pull_backup_access_code`](https://docs.seam.co/latest/api/access_codes/pull_backup_access_code). */
118794
- use_backup_access_code_pool?: boolean | undefined;
118795
118748
  /** Indicates whether [external modification](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#external-modification) of the code is allowed. Default: `false`. */
118796
118749
  allow_external_modification?: boolean | undefined;
118797
118750
  /** Indicates whether [external modification](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#external-modification) of the code is allowed. Default: `false`. */
118798
118751
  is_external_modification_allowed?: boolean | undefined;
118799
- /**
118800
- * @deprecated Use `is_offline_access_code` instead.*/
118801
- use_offline_access_code?: boolean | undefined;
118802
- /** Indicates whether the access code is an [offline access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/offline-access-codes). */
118803
- is_offline_access_code?: boolean | undefined;
118804
- /** Indicates whether the [offline access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/offline-access-codes) is a single-use access code. */
118805
- is_one_time_use?: boolean | undefined;
118806
- /** Maximum rounding adjustment. To create a daily-bound [offline access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/offline-access-codes) for devices that support this feature, set this parameter to `1d`. */
118807
- max_time_rounding?: '1hour' | '1day' | '1h' | '1d';
118808
118752
  };
118809
118753
  commonParams: {};
118810
118754
  formData: {};
@@ -170107,8 +170051,8 @@ type Routes = {
170107
170051
  id: string;
170108
170052
  /** Zonal Secret for login request body (required) */
170109
170053
  secret: string;
170110
- /** Optional hotel ID for single-property mode */
170111
- hotel_id?: string | undefined;
170054
+ /** Hotel ID - required for identifying the customer */
170055
+ hotel_id: string;
170112
170056
  /** Use staging API instead of production */
170113
170057
  is_staging?: boolean;
170114
170058
  auth_token?: string | undefined;
package/dist/index.cjs CHANGED
@@ -30207,20 +30207,6 @@ var openapi_default = {
30207
30207
  description: "Indicates whether [external modification](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#external-modification) of the code is allowed. Default: `false`.",
30208
30208
  type: "boolean"
30209
30209
  },
30210
- is_offline_access_code: {
30211
- description: "Indicates whether the access code is an [offline access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/offline-access-codes).",
30212
- type: "boolean"
30213
- },
30214
- is_one_time_use: {
30215
- description: "Indicates whether the [offline access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/offline-access-codes) is a single-use access code.",
30216
- type: "boolean"
30217
- },
30218
- max_time_rounding: {
30219
- default: "1hour",
30220
- description: "Maximum rounding adjustment. To create a daily-bound [offline access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/offline-access-codes) for devices that support this feature, set this parameter to `1d`.",
30221
- enum: ["1hour", "1day", "1h", "1d"],
30222
- type: "string"
30223
- },
30224
30210
  name: {
30225
30211
  description: "Name of the new access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes.\n\n Note that the name provided on Seam is used to identify the code on Seam and is not necessarily the name that will appear in the lock provider's app or on the device. This is because lock providers may have constraints on names, such as length, uniqueness, or characters that can be used. In addition, some lock providers may break down names into components such as `first_name` and `last_name`.\n\n To provide a consistent experience, Seam identifies the code on Seam by its name but may modify the name that appears on the lock provider's app or on the device. For example, Seam may add additional characters or truncate the name to meet provider constraints.\n\n To help your users identify codes set by Seam, Seam provides the name exactly as it appears on the lock provider's app or on the device as a separate property called `appearance`. This is an object with a `name` property and, optionally, `first_name` and `last_name` properties (for providers that break down a name into components).",
30226
30212
  type: "string"
@@ -30230,22 +30216,13 @@ var openapi_default = {
30230
30216
  type: "boolean"
30231
30217
  },
30232
30218
  preferred_code_length: {
30233
- description: "Preferred code length. Only applicable if you do not specify a `code`. If the affected device does not support the preferred code length, Seam reverts to using the shortest supported code length.",
30219
+ description: "Preferred code length. If the affected devices do not support the preferred code length, Seam reverts to using the shortest supported code length.",
30234
30220
  format: "float",
30235
30221
  type: "number"
30236
30222
  },
30237
30223
  starts_at: {
30238
30224
  description: "Date and time at which the validity of the new access code starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.",
30239
30225
  type: "string"
30240
- },
30241
- use_backup_access_code_pool: {
30242
- description: "Indicates whether to use a [backup access code pool](https://docs.seam.co/latest/core-concepts/access-codes#backup-access-codes) provided by Seam. If `true`, you can use [`/access_codes/pull_backup_access_code`](https://docs.seam.co/latest/api/access_codes/pull_backup_access_code).",
30243
- type: "boolean"
30244
- },
30245
- use_offline_access_code: {
30246
- deprecated: true,
30247
- type: "boolean",
30248
- "x-deprecated": "Use `is_offline_access_code` instead."
30249
30226
  }
30250
30227
  },
30251
30228
  required: ["device_ids"],
@@ -30333,20 +30310,6 @@ var openapi_default = {
30333
30310
  description: "Indicates whether [external modification](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#external-modification) of the code is allowed. Default: `false`.",
30334
30311
  type: "boolean"
30335
30312
  },
30336
- is_offline_access_code: {
30337
- description: "Indicates whether the access code is an [offline access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/offline-access-codes).",
30338
- type: "boolean"
30339
- },
30340
- is_one_time_use: {
30341
- description: "Indicates whether the [offline access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/offline-access-codes) is a single-use access code.",
30342
- type: "boolean"
30343
- },
30344
- max_time_rounding: {
30345
- default: "1hour",
30346
- description: "Maximum rounding adjustment. To create a daily-bound [offline access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/offline-access-codes) for devices that support this feature, set this parameter to `1d`.",
30347
- enum: ["1hour", "1day", "1h", "1d"],
30348
- type: "string"
30349
- },
30350
30313
  name: {
30351
30314
  description: "Name of the new access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes.\n\n Note that the name provided on Seam is used to identify the code on Seam and is not necessarily the name that will appear in the lock provider's app or on the device. This is because lock providers may have constraints on names, such as length, uniqueness, or characters that can be used. In addition, some lock providers may break down names into components such as `first_name` and `last_name`.\n\n To provide a consistent experience, Seam identifies the code on Seam by its name but may modify the name that appears on the lock provider's app or on the device. For example, Seam may add additional characters or truncate the name to meet provider constraints.\n\n To help your users identify codes set by Seam, Seam provides the name exactly as it appears on the lock provider's app or on the device as a separate property called `appearance`. This is an object with a `name` property and, optionally, `first_name` and `last_name` properties (for providers that break down a name into components).",
30352
30315
  type: "string"
@@ -30356,22 +30319,13 @@ var openapi_default = {
30356
30319
  type: "boolean"
30357
30320
  },
30358
30321
  preferred_code_length: {
30359
- description: "Preferred code length. Only applicable if you do not specify a `code`. If the affected device does not support the preferred code length, Seam reverts to using the shortest supported code length.",
30322
+ description: "Preferred code length. If the affected devices do not support the preferred code length, Seam reverts to using the shortest supported code length.",
30360
30323
  format: "float",
30361
30324
  type: "number"
30362
30325
  },
30363
30326
  starts_at: {
30364
30327
  description: "Date and time at which the validity of the new access code starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.",
30365
30328
  type: "string"
30366
- },
30367
- use_backup_access_code_pool: {
30368
- description: "Indicates whether to use a [backup access code pool](https://docs.seam.co/latest/core-concepts/access-codes#backup-access-codes) provided by Seam. If `true`, you can use [`/access_codes/pull_backup_access_code`](https://docs.seam.co/latest/api/access_codes/pull_backup_access_code).",
30369
- type: "boolean"
30370
- },
30371
- use_offline_access_code: {
30372
- deprecated: true,
30373
- type: "boolean",
30374
- "x-deprecated": "Use `is_offline_access_code` instead."
30375
30329
  }
30376
30330
  },
30377
30331
  required: ["device_ids"],
@@ -57202,7 +57156,8 @@ var openapi_default = {
57202
57156
  },
57203
57157
  auth_token: { type: "string" },
57204
57158
  hotel_id: {
57205
- description: "Optional hotel ID for single-property mode",
57159
+ description: "Hotel ID - required for identifying the customer",
57160
+ minLength: 1,
57206
57161
  type: "string"
57207
57162
  },
57208
57163
  id: {
@@ -57221,7 +57176,7 @@ var openapi_default = {
57221
57176
  type: "string"
57222
57177
  }
57223
57178
  },
57224
- required: ["api_key", "id", "secret"],
57179
+ required: ["api_key", "id", "secret", "hotel_id"],
57225
57180
  type: "object"
57226
57181
  }
57227
57182
  ]