@seamapi/types 1.406.4 → 1.406.5

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 (10) hide show
  1. package/dist/connect.cjs +86 -36
  2. package/dist/connect.cjs.map +1 -1
  3. package/dist/connect.d.cts +44 -12
  4. package/lib/seam/connect/openapi.d.ts +23 -0
  5. package/lib/seam/connect/openapi.js +80 -30
  6. package/lib/seam/connect/openapi.js.map +1 -1
  7. package/lib/seam/connect/route-types.d.ts +21 -12
  8. package/package.json +1 -1
  9. package/src/lib/seam/connect/openapi.ts +91 -30
  10. package/src/lib/seam/connect/route-types.ts +21 -12
package/dist/connect.cjs CHANGED
@@ -23850,7 +23850,7 @@ var openapi_default = {
23850
23850
  schema: {
23851
23851
  properties: {
23852
23852
  allow_external_modification: {
23853
- description: "Indicates whether [external modification](https://docs.seam.co/latest/api/access_codes#external-modification) of the code is allowed. Default: `false`.",
23853
+ 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`.",
23854
23854
  type: "boolean"
23855
23855
  },
23856
23856
  attempt_for_offline_device: {
@@ -23878,7 +23878,7 @@ var openapi_default = {
23878
23878
  type: "string"
23879
23879
  },
23880
23880
  is_external_modification_allowed: {
23881
- description: "Indicates whether [external modification](https://docs.seam.co/latest/api/access_codes#external-modification) of the code is allowed. Default: `false`.",
23881
+ 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`.",
23882
23882
  type: "boolean"
23883
23883
  },
23884
23884
  is_offline_access_code: {
@@ -23918,7 +23918,7 @@ var openapi_default = {
23918
23918
  "x-undocumented": "Only used internally."
23919
23919
  },
23920
23920
  use_backup_access_code_pool: {
23921
- 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-clients/access_codes/pull_backup_access_code).",
23921
+ 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).",
23922
23922
  type: "boolean"
23923
23923
  },
23924
23924
  use_offline_access_code: { type: "boolean" }
@@ -23977,7 +23977,7 @@ var openapi_default = {
23977
23977
  schema: {
23978
23978
  properties: {
23979
23979
  allow_external_modification: {
23980
- description: "Indicates whether [external modification](https://docs.seam.co/latest/api/access_codes#external-modification) of the code is allowed. Default: `false`.",
23980
+ 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`.",
23981
23981
  type: "boolean"
23982
23982
  },
23983
23983
  attempt_for_offline_device: {
@@ -24007,7 +24007,7 @@ var openapi_default = {
24007
24007
  type: "string"
24008
24008
  },
24009
24009
  is_external_modification_allowed: {
24010
- description: "Indicates whether [external modification](https://docs.seam.co/latest/api/access_codes#external-modification) of the code is allowed. Default: `false`.",
24010
+ 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`.",
24011
24011
  type: "boolean"
24012
24012
  },
24013
24013
  is_offline_access_code: {
@@ -24042,7 +24042,7 @@ var openapi_default = {
24042
24042
  type: "string"
24043
24043
  },
24044
24044
  use_backup_access_code_pool: {
24045
- 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-clients/access_codes/pull_backup_access_code).",
24045
+ 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).",
24046
24046
  type: "boolean"
24047
24047
  },
24048
24048
  use_offline_access_code: { type: "boolean" }
@@ -24098,7 +24098,7 @@ var openapi_default = {
24098
24098
  schema: {
24099
24099
  properties: {
24100
24100
  allow_external_modification: {
24101
- description: "Indicates whether [external modification](https://docs.seam.co/latest/api/access_codes#external-modification) of the code is allowed. Default: `false`.",
24101
+ 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`.",
24102
24102
  type: "boolean"
24103
24103
  },
24104
24104
  attempt_for_offline_device: {
@@ -24128,7 +24128,7 @@ var openapi_default = {
24128
24128
  type: "string"
24129
24129
  },
24130
24130
  is_external_modification_allowed: {
24131
- description: "Indicates whether [external modification](https://docs.seam.co/latest/api/access_codes#external-modification) of the code is allowed. Default: `false`.",
24131
+ 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`.",
24132
24132
  type: "boolean"
24133
24133
  },
24134
24134
  is_offline_access_code: {
@@ -24163,7 +24163,7 @@ var openapi_default = {
24163
24163
  type: "string"
24164
24164
  },
24165
24165
  use_backup_access_code_pool: {
24166
- 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-clients/access_codes/pull_backup_access_code).",
24166
+ 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).",
24167
24167
  type: "boolean"
24168
24168
  },
24169
24169
  use_offline_access_code: { type: "boolean" }
@@ -25135,7 +25135,7 @@ var openapi_default = {
25135
25135
  type: "string"
25136
25136
  },
25137
25137
  allow_external_modification: {
25138
- description: "Indicates whether [external modification](https://docs.seam.co/latest/api/access_codes#external-modification) of the code is allowed. Default: `false`.",
25138
+ 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`.",
25139
25139
  type: "boolean"
25140
25140
  },
25141
25141
  attempt_for_offline_device: {
@@ -25159,7 +25159,7 @@ var openapi_default = {
25159
25159
  type: "string"
25160
25160
  },
25161
25161
  is_external_modification_allowed: {
25162
- description: "Indicates whether [external modification](https://docs.seam.co/latest/api/access_codes#external-modification) of the code is allowed. Default: `false`.",
25162
+ 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`.",
25163
25163
  type: "boolean"
25164
25164
  },
25165
25165
  is_managed: {
@@ -25208,7 +25208,7 @@ var openapi_default = {
25208
25208
  type: "string"
25209
25209
  },
25210
25210
  use_backup_access_code_pool: {
25211
- 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-clients/access_codes/pull_backup_access_code).",
25211
+ 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).",
25212
25212
  type: "boolean"
25213
25213
  },
25214
25214
  use_offline_access_code: { type: "boolean" }
@@ -25267,7 +25267,7 @@ var openapi_default = {
25267
25267
  type: "string"
25268
25268
  },
25269
25269
  allow_external_modification: {
25270
- description: "Indicates whether [external modification](https://docs.seam.co/latest/api/access_codes#external-modification) of the code is allowed. Default: `false`.",
25270
+ 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`.",
25271
25271
  type: "boolean"
25272
25272
  },
25273
25273
  attempt_for_offline_device: {
@@ -25291,7 +25291,7 @@ var openapi_default = {
25291
25291
  type: "string"
25292
25292
  },
25293
25293
  is_external_modification_allowed: {
25294
- description: "Indicates whether [external modification](https://docs.seam.co/latest/api/access_codes#external-modification) of the code is allowed. Default: `false`.",
25294
+ 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`.",
25295
25295
  type: "boolean"
25296
25296
  },
25297
25297
  is_managed: {
@@ -25340,7 +25340,7 @@ var openapi_default = {
25340
25340
  type: "string"
25341
25341
  },
25342
25342
  use_backup_access_code_pool: {
25343
- 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-clients/access_codes/pull_backup_access_code).",
25343
+ 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).",
25344
25344
  type: "boolean"
25345
25345
  },
25346
25346
  use_offline_access_code: { type: "boolean" }
@@ -25400,7 +25400,7 @@ var openapi_default = {
25400
25400
  type: "string"
25401
25401
  },
25402
25402
  allow_external_modification: {
25403
- description: "Indicates whether [external modification](https://docs.seam.co/latest/api/access_codes#external-modification) of the code is allowed. Default: `false`.",
25403
+ 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`.",
25404
25404
  type: "boolean"
25405
25405
  },
25406
25406
  attempt_for_offline_device: {
@@ -25424,7 +25424,7 @@ var openapi_default = {
25424
25424
  type: "string"
25425
25425
  },
25426
25426
  is_external_modification_allowed: {
25427
- description: "Indicates whether [external modification](https://docs.seam.co/latest/api/access_codes#external-modification) of the code is allowed. Default: `false`.",
25427
+ 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`.",
25428
25428
  type: "boolean"
25429
25429
  },
25430
25430
  is_managed: {
@@ -25473,7 +25473,7 @@ var openapi_default = {
25473
25473
  type: "string"
25474
25474
  },
25475
25475
  use_backup_access_code_pool: {
25476
- 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-clients/access_codes/pull_backup_access_code).",
25476
+ 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).",
25477
25477
  type: "boolean"
25478
25478
  },
25479
25479
  use_offline_access_code: { type: "boolean" }
@@ -32691,14 +32691,22 @@ var openapi_default = {
32691
32691
  },
32692
32692
  "/locks/get": {
32693
32693
  post: {
32694
+ description: "Returns a specified [lock](https://docs.seam.co/latest/capability-guides/smart-locks). **Use `/devices/get` instead.**",
32694
32695
  operationId: "locksGetPost",
32695
32696
  requestBody: {
32696
32697
  content: {
32697
32698
  "application/json": {
32698
32699
  schema: {
32699
32700
  properties: {
32700
- device_id: { format: "uuid", type: "string" },
32701
- name: { type: "string" }
32701
+ device_id: {
32702
+ description: "ID of the lock that you want to get.",
32703
+ format: "uuid",
32704
+ type: "string"
32705
+ },
32706
+ name: {
32707
+ description: "Name of the lock that you want to get.",
32708
+ type: "string"
32709
+ }
32702
32710
  },
32703
32711
  type: "object"
32704
32712
  }
@@ -32737,11 +32745,13 @@ var openapi_default = {
32737
32745
  "x-fern-sdk-group-name": ["locks"],
32738
32746
  "x-fern-sdk-method-name": "get",
32739
32747
  "x-fern-sdk-return-value": "device",
32740
- "x-response-key": "device"
32748
+ "x-response-key": "device",
32749
+ "x-title": "Get a Lock"
32741
32750
  }
32742
32751
  },
32743
32752
  "/locks/list": {
32744
32753
  post: {
32754
+ description: "Returns a list of all [locks](https://docs.seam.co/latest/capability-guides/smart-locks).",
32745
32755
  operationId: "locksListPost",
32746
32756
  requestBody: {
32747
32757
  content: {
@@ -32785,7 +32795,7 @@ var openapi_default = {
32785
32795
  type: "array"
32786
32796
  },
32787
32797
  device_type: {
32788
- description: "Device type by which to filter devices.",
32798
+ description: "Device type of the locks that you want to list.",
32789
32799
  enum: [
32790
32800
  "akuvox_lock",
32791
32801
  "august_lock",
@@ -32818,7 +32828,7 @@ var openapi_default = {
32818
32828
  type: "string"
32819
32829
  },
32820
32830
  device_types: {
32821
- description: "Array of device types by which to filter devices.",
32831
+ description: "Device types of the locks that you want to list.",
32822
32832
  items: {
32823
32833
  description: "Device type for smartlocks.\n ",
32824
32834
  enum: [
@@ -32901,7 +32911,7 @@ var openapi_default = {
32901
32911
  type: "number"
32902
32912
  },
32903
32913
  manufacturer: {
32904
- description: "Manufacturer by which to filter devices.",
32914
+ description: "Manufacturer of the locks that you want to list.",
32905
32915
  enum: [
32906
32916
  "akuvox",
32907
32917
  "august",
@@ -32993,19 +33003,29 @@ var openapi_default = {
32993
33003
  "x-fern-sdk-group-name": ["locks"],
32994
33004
  "x-fern-sdk-method-name": "list",
32995
33005
  "x-fern-sdk-return-value": "devices",
32996
- "x-response-key": "devices"
33006
+ "x-response-key": "devices",
33007
+ "x-title": "List Locks"
32997
33008
  }
32998
33009
  },
32999
33010
  "/locks/lock_door": {
33000
33011
  post: {
33012
+ description: "Locks a [lock](https://docs.seam.co/latest/capability-guides/smart-locks). See also [Locking and Unlocking Smart Locks](https://docs.seam.co/latest/capability-guides/smart-locks/lock-and-unlock).",
33001
33013
  operationId: "locksLockDoorPost",
33002
33014
  requestBody: {
33003
33015
  content: {
33004
33016
  "application/json": {
33005
33017
  schema: {
33006
33018
  properties: {
33007
- device_id: { format: "uuid", type: "string" },
33008
- sync: { default: false, type: "boolean" }
33019
+ device_id: {
33020
+ description: "ID of the lock that you want to lock.",
33021
+ format: "uuid",
33022
+ type: "string"
33023
+ },
33024
+ sync: {
33025
+ default: false,
33026
+ type: "boolean",
33027
+ "x-undocumented": "Only used internally."
33028
+ }
33009
33029
  },
33010
33030
  required: ["device_id"],
33011
33031
  type: "object"
@@ -33046,19 +33066,28 @@ var openapi_default = {
33046
33066
  "x-fern-sdk-group-name": ["locks"],
33047
33067
  "x-fern-sdk-method-name": "lock_door",
33048
33068
  "x-fern-sdk-return-value": "action_attempt",
33049
- "x-response-key": "action_attempt"
33069
+ "x-response-key": "action_attempt",
33070
+ "x-title": "Lock a Lock"
33050
33071
  }
33051
33072
  },
33052
33073
  "/locks/simulate/keypad_code_entry": {
33053
33074
  post: {
33075
+ description: "Simulates the entry of a code on a keypad. You can only perform this action for [August](https://docs.seam.co/latest/device-and-system-integration-guides/august-locks) devices within [sandbox workspaces](https://docs.seam.co/latest/core-concepts/workspaces#sandbox-workspaces).",
33054
33076
  operationId: "locksSimulateKeypadCodeEntryPost",
33055
33077
  requestBody: {
33056
33078
  content: {
33057
33079
  "application/json": {
33058
33080
  schema: {
33059
33081
  properties: {
33060
- code: { type: "string" },
33061
- device_id: { format: "uuid", type: "string" }
33082
+ code: {
33083
+ description: "Code that you want to simulate entering on a keypad.",
33084
+ type: "string"
33085
+ },
33086
+ device_id: {
33087
+ description: "ID of the device for which you want to simulate a keypad code entry.",
33088
+ format: "uuid",
33089
+ type: "string"
33090
+ }
33062
33091
  },
33063
33092
  required: ["device_id", "code"],
33064
33093
  type: "object"
@@ -33104,12 +33133,19 @@ var openapi_default = {
33104
33133
  },
33105
33134
  "/locks/simulate/manual_lock_via_keypad": {
33106
33135
  post: {
33136
+ description: "Simulates a manual lock action using a keypad. You can only perform this action for [August](https://docs.seam.co/latest/device-and-system-integration-guides/august-locks) devices within [sandbox workspaces](https://docs.seam.co/latest/core-concepts/workspaces#sandbox-workspaces).",
33107
33137
  operationId: "locksSimulateManualLockViaKeypadPost",
33108
33138
  requestBody: {
33109
33139
  content: {
33110
33140
  "application/json": {
33111
33141
  schema: {
33112
- properties: { device_id: { format: "uuid", type: "string" } },
33142
+ properties: {
33143
+ device_id: {
33144
+ description: "ID of the device for which you want to simulate a manual lock action using a keypad.",
33145
+ format: "uuid",
33146
+ type: "string"
33147
+ }
33148
+ },
33113
33149
  required: ["device_id"],
33114
33150
  type: "object"
33115
33151
  }
@@ -33154,14 +33190,23 @@ var openapi_default = {
33154
33190
  },
33155
33191
  "/locks/unlock_door": {
33156
33192
  post: {
33193
+ description: "Unlocks a [lock](https://docs.seam.co/latest/capability-guides/smart-locks). See also [Locking and Unlocking Smart Locks](https://docs.seam.co/latest/capability-guides/smart-locks/lock-and-unlock).",
33157
33194
  operationId: "locksUnlockDoorPost",
33158
33195
  requestBody: {
33159
33196
  content: {
33160
33197
  "application/json": {
33161
33198
  schema: {
33162
33199
  properties: {
33163
- device_id: { format: "uuid", type: "string" },
33164
- sync: { default: false, type: "boolean" }
33200
+ device_id: {
33201
+ description: "ID of the lock that you want to unlock.",
33202
+ format: "uuid",
33203
+ type: "string"
33204
+ },
33205
+ sync: {
33206
+ default: false,
33207
+ type: "boolean",
33208
+ "x-undocumented": "Only used internally."
33209
+ }
33165
33210
  },
33166
33211
  required: ["device_id"],
33167
33212
  type: "object"
@@ -33202,7 +33247,8 @@ var openapi_default = {
33202
33247
  "x-fern-sdk-group-name": ["locks"],
33203
33248
  "x-fern-sdk-method-name": "unlock_door",
33204
33249
  "x-fern-sdk-return-value": "action_attempt",
33205
- "x-response-key": "action_attempt"
33250
+ "x-response-key": "action_attempt",
33251
+ "x-title": "Unlock a Lock"
33206
33252
  }
33207
33253
  },
33208
33254
  "/networks/get": {
@@ -33245,10 +33291,12 @@ var openapi_default = {
33245
33291
  ],
33246
33292
  summary: "/networks/get",
33247
33293
  tags: ["/networks"],
33294
+ "x-deprecated": "Will be removed.",
33248
33295
  "x-fern-sdk-group-name": ["networks"],
33249
33296
  "x-fern-sdk-method-name": "get",
33250
33297
  "x-fern-sdk-return-value": "network",
33251
- "x-response-key": "network"
33298
+ "x-response-key": "network",
33299
+ "x-undocumented": "Deprecated."
33252
33300
  }
33253
33301
  },
33254
33302
  "/networks/list": {
@@ -33288,10 +33336,12 @@ var openapi_default = {
33288
33336
  ],
33289
33337
  summary: "/networks/list",
33290
33338
  tags: ["/networks"],
33339
+ "x-deprecated": "Will be removed.",
33291
33340
  "x-fern-sdk-group-name": ["networks"],
33292
33341
  "x-fern-sdk-method-name": "list",
33293
33342
  "x-fern-sdk-return-value": "networks",
33294
- "x-response-key": "networks"
33343
+ "x-response-key": "networks",
33344
+ "x-undocumented": "Deprecated."
33295
33345
  }
33296
33346
  },
33297
33347
  "/noise_sensors/list": {