@seamapi/types 1.406.4 → 1.406.6

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.
package/dist/connect.cjs CHANGED
@@ -3876,6 +3876,7 @@ var client_session = zod.z.object({
3876
3876
  token: zod.z.string(),
3877
3877
  user_identifier_key: zod.z.string().nullable(),
3878
3878
  device_count: zod.z.number(),
3879
+ customer_id: zod.z.string().uuid().optional(),
3879
3880
  connected_account_ids: zod.z.array(zod.z.string().uuid()),
3880
3881
  connect_webview_ids: zod.z.array(zod.z.string().uuid()),
3881
3882
  user_identity_ids: zod.z.array(zod.z.string().uuid())
@@ -3884,11 +3885,11 @@ var client_session = zod.z.object({
3884
3885
  route_path: /client_sessions
3885
3886
  ---
3886
3887
  Represents a [client session](https://docs.seam.co/latest/core-concepts/authentication/client-session-tokens). If you want to restrict your users' access to their own devices, use client sessions.
3887
-
3888
+
3888
3889
  You create each client session with a custom \`user_identifier_key\`. Normally, the \`user_identifier_key\` is a user ID that your application provides.
3889
-
3890
+
3890
3891
  When calling the Seam API from your backend using an API key, you can pass the \`user_identifier_key\` as a parameter to limit results to the associated client session. For example, \`/devices/list?user_identifier_key=123\` only returns devices associated with the client session created with the \`user_identifier_key\` \`123\`.
3891
-
3892
+
3892
3893
  A client session has a token that you can use with the Seam JavaScript SDK to make requests from the client (browser) directly to the Seam API. The token restricts the user's access to only the devices that they own.
3893
3894
 
3894
3895
  See also [Get Started with React](https://docs.seam.co/latest/ui-components/overview/getting-started-with-seam-components/get-started-with-react-components-and-client-session-tokens).
@@ -11530,6 +11531,7 @@ var openapi_default = {
11530
11531
  type: "array"
11531
11532
  },
11532
11533
  created_at: { format: "date-time", type: "string" },
11534
+ customer_id: { format: "uuid", type: "string" },
11533
11535
  device_count: { format: "float", type: "number" },
11534
11536
  expires_at: { format: "date-time", type: "string" },
11535
11537
  token: { type: "string" },
@@ -23799,18 +23801,18 @@ var openapi_default = {
23799
23801
  name: "client-session-token",
23800
23802
  type: "apiKey"
23801
23803
  },
23802
- console_session_with_workspace: {
23803
- bearerFormat: "Console Session Token",
23804
+ client_session_with_customer: {
23805
+ bearerFormat: "Customer Client Session Token",
23804
23806
  scheme: "bearer",
23805
23807
  type: "http"
23806
23808
  },
23807
- console_session_without_workspace: {
23809
+ console_session_with_workspace: {
23808
23810
  bearerFormat: "Console Session Token",
23809
23811
  scheme: "bearer",
23810
23812
  type: "http"
23811
23813
  },
23812
- customer_client_session: {
23813
- bearerFormat: "Customer Client Session Token",
23814
+ console_session_without_workspace: {
23815
+ bearerFormat: "Console Session Token",
23814
23816
  scheme: "bearer",
23815
23817
  type: "http"
23816
23818
  },
@@ -23850,7 +23852,7 @@ var openapi_default = {
23850
23852
  schema: {
23851
23853
  properties: {
23852
23854
  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`.",
23855
+ 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
23856
  type: "boolean"
23855
23857
  },
23856
23858
  attempt_for_offline_device: {
@@ -23878,7 +23880,7 @@ var openapi_default = {
23878
23880
  type: "string"
23879
23881
  },
23880
23882
  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`.",
23883
+ 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
23884
  type: "boolean"
23883
23885
  },
23884
23886
  is_offline_access_code: {
@@ -23918,7 +23920,7 @@ var openapi_default = {
23918
23920
  "x-undocumented": "Only used internally."
23919
23921
  },
23920
23922
  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).",
23923
+ 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
23924
  type: "boolean"
23923
23925
  },
23924
23926
  use_offline_access_code: { type: "boolean" }
@@ -23977,7 +23979,7 @@ var openapi_default = {
23977
23979
  schema: {
23978
23980
  properties: {
23979
23981
  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`.",
23982
+ 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
23983
  type: "boolean"
23982
23984
  },
23983
23985
  attempt_for_offline_device: {
@@ -24007,7 +24009,7 @@ var openapi_default = {
24007
24009
  type: "string"
24008
24010
  },
24009
24011
  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`.",
24012
+ 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
24013
  type: "boolean"
24012
24014
  },
24013
24015
  is_offline_access_code: {
@@ -24042,7 +24044,7 @@ var openapi_default = {
24042
24044
  type: "string"
24043
24045
  },
24044
24046
  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).",
24047
+ 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
24048
  type: "boolean"
24047
24049
  },
24048
24050
  use_offline_access_code: { type: "boolean" }
@@ -24098,7 +24100,7 @@ var openapi_default = {
24098
24100
  schema: {
24099
24101
  properties: {
24100
24102
  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`.",
24103
+ 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
24104
  type: "boolean"
24103
24105
  },
24104
24106
  attempt_for_offline_device: {
@@ -24128,7 +24130,7 @@ var openapi_default = {
24128
24130
  type: "string"
24129
24131
  },
24130
24132
  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`.",
24133
+ 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
24134
  type: "boolean"
24133
24135
  },
24134
24136
  is_offline_access_code: {
@@ -24163,7 +24165,7 @@ var openapi_default = {
24163
24165
  type: "string"
24164
24166
  },
24165
24167
  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).",
24168
+ 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
24169
  type: "boolean"
24168
24170
  },
24169
24171
  use_offline_access_code: { type: "boolean" }
@@ -25135,7 +25137,7 @@ var openapi_default = {
25135
25137
  type: "string"
25136
25138
  },
25137
25139
  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`.",
25140
+ 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
25141
  type: "boolean"
25140
25142
  },
25141
25143
  attempt_for_offline_device: {
@@ -25159,7 +25161,7 @@ var openapi_default = {
25159
25161
  type: "string"
25160
25162
  },
25161
25163
  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`.",
25164
+ 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
25165
  type: "boolean"
25164
25166
  },
25165
25167
  is_managed: {
@@ -25208,7 +25210,7 @@ var openapi_default = {
25208
25210
  type: "string"
25209
25211
  },
25210
25212
  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).",
25213
+ 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
25214
  type: "boolean"
25213
25215
  },
25214
25216
  use_offline_access_code: { type: "boolean" }
@@ -25267,7 +25269,7 @@ var openapi_default = {
25267
25269
  type: "string"
25268
25270
  },
25269
25271
  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`.",
25272
+ 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
25273
  type: "boolean"
25272
25274
  },
25273
25275
  attempt_for_offline_device: {
@@ -25291,7 +25293,7 @@ var openapi_default = {
25291
25293
  type: "string"
25292
25294
  },
25293
25295
  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`.",
25296
+ 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
25297
  type: "boolean"
25296
25298
  },
25297
25299
  is_managed: {
@@ -25340,7 +25342,7 @@ var openapi_default = {
25340
25342
  type: "string"
25341
25343
  },
25342
25344
  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).",
25345
+ 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
25346
  type: "boolean"
25345
25347
  },
25346
25348
  use_offline_access_code: { type: "boolean" }
@@ -25400,7 +25402,7 @@ var openapi_default = {
25400
25402
  type: "string"
25401
25403
  },
25402
25404
  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`.",
25405
+ 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
25406
  type: "boolean"
25405
25407
  },
25406
25408
  attempt_for_offline_device: {
@@ -25424,7 +25426,7 @@ var openapi_default = {
25424
25426
  type: "string"
25425
25427
  },
25426
25428
  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`.",
25429
+ 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
25430
  type: "boolean"
25429
25431
  },
25430
25432
  is_managed: {
@@ -25473,7 +25475,7 @@ var openapi_default = {
25473
25475
  type: "string"
25474
25476
  },
25475
25477
  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).",
25478
+ 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
25479
  type: "boolean"
25478
25480
  },
25479
25481
  use_offline_access_code: { type: "boolean" }
@@ -30496,7 +30498,7 @@ var openapi_default = {
30496
30498
  },
30497
30499
  security: [
30498
30500
  { client_session: [] },
30499
- { customer_client_session: [] },
30501
+ { client_session_with_customer: [] },
30500
30502
  { pat_with_workspace: [] },
30501
30503
  { console_session_with_workspace: [] },
30502
30504
  { api_key: [] }
@@ -30604,7 +30606,7 @@ var openapi_default = {
30604
30606
  },
30605
30607
  security: [
30606
30608
  { client_session: [] },
30607
- { customer_client_session: [] },
30609
+ { client_session_with_customer: [] },
30608
30610
  { pat_with_workspace: [] },
30609
30611
  { console_session_with_workspace: [] },
30610
30612
  { api_key: [] }
@@ -30634,7 +30636,7 @@ var openapi_default = {
30634
30636
  description: "Custom metadata pairs by which you want to [filter Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews/filtering-connect-webviews-by-custom-metadata). Returns Connect Webviews with `custom_metadata` that contains all of the provided key:value pairs.",
30635
30637
  type: "object"
30636
30638
  },
30637
- customer_id: { type: "string" },
30639
+ customer_ids: { items: { type: "string" }, type: "array" },
30638
30640
  limit: {
30639
30641
  default: 500,
30640
30642
  description: "Maximum number of records to return per page.",
@@ -30675,7 +30677,7 @@ var openapi_default = {
30675
30677
  },
30676
30678
  security: [
30677
30679
  { client_session: [] },
30678
- { customer_client_session: [] },
30680
+ { client_session_with_customer: [] },
30679
30681
  { pat_with_workspace: [] },
30680
30682
  { console_session_with_workspace: [] },
30681
30683
  { api_key: [] }
@@ -30735,7 +30737,7 @@ var openapi_default = {
30735
30737
  { api_key: [] },
30736
30738
  { pat_with_workspace: [] },
30737
30739
  { console_session_with_workspace: [] },
30738
- { customer_client_session: [] }
30740
+ { client_session_with_customer: [] }
30739
30741
  ],
30740
30742
  summary: "/connected_accounts/delete",
30741
30743
  tags: ["/connected_accounts"],
@@ -30886,7 +30888,7 @@ var openapi_default = {
30886
30888
  { api_key: [] },
30887
30889
  { pat_with_workspace: [] },
30888
30890
  { console_session_with_workspace: [] },
30889
- { customer_client_session: [] }
30891
+ { client_session_with_customer: [] }
30890
30892
  ],
30891
30893
  summary: "/connected_accounts/list",
30892
30894
  tags: ["/connected_accounts"],
@@ -31114,7 +31116,7 @@ var openapi_default = {
31114
31116
  },
31115
31117
  security: [
31116
31118
  { client_session: [] },
31117
- { customer_client_session: [] },
31119
+ { client_session_with_customer: [] },
31118
31120
  { pat_with_workspace: [] },
31119
31121
  { console_session_with_workspace: [] },
31120
31122
  { api_key: [] }
@@ -31433,7 +31435,7 @@ var openapi_default = {
31433
31435
  401: { description: "Unauthorized" }
31434
31436
  },
31435
31437
  security: [
31436
- { customer_client_session: [] },
31438
+ { client_session_with_customer: [] },
31437
31439
  { client_session: [] },
31438
31440
  { pat_with_workspace: [] },
31439
31441
  { console_session_with_workspace: [] },
@@ -32678,7 +32680,7 @@ var openapi_default = {
32678
32680
  { api_key: [] },
32679
32681
  { pat_with_workspace: [] },
32680
32682
  { console_session_with_workspace: [] },
32681
- { customer_client_session: [] }
32683
+ { client_session_with_customer: [] }
32682
32684
  ],
32683
32685
  summary: "/events/list",
32684
32686
  tags: ["/events"],
@@ -32691,14 +32693,22 @@ var openapi_default = {
32691
32693
  },
32692
32694
  "/locks/get": {
32693
32695
  post: {
32696
+ description: "Returns a specified [lock](https://docs.seam.co/latest/capability-guides/smart-locks). **Use `/devices/get` instead.**",
32694
32697
  operationId: "locksGetPost",
32695
32698
  requestBody: {
32696
32699
  content: {
32697
32700
  "application/json": {
32698
32701
  schema: {
32699
32702
  properties: {
32700
- device_id: { format: "uuid", type: "string" },
32701
- name: { type: "string" }
32703
+ device_id: {
32704
+ description: "ID of the lock that you want to get.",
32705
+ format: "uuid",
32706
+ type: "string"
32707
+ },
32708
+ name: {
32709
+ description: "Name of the lock that you want to get.",
32710
+ type: "string"
32711
+ }
32702
32712
  },
32703
32713
  type: "object"
32704
32714
  }
@@ -32737,11 +32747,13 @@ var openapi_default = {
32737
32747
  "x-fern-sdk-group-name": ["locks"],
32738
32748
  "x-fern-sdk-method-name": "get",
32739
32749
  "x-fern-sdk-return-value": "device",
32740
- "x-response-key": "device"
32750
+ "x-response-key": "device",
32751
+ "x-title": "Get a Lock"
32741
32752
  }
32742
32753
  },
32743
32754
  "/locks/list": {
32744
32755
  post: {
32756
+ description: "Returns a list of all [locks](https://docs.seam.co/latest/capability-guides/smart-locks).",
32745
32757
  operationId: "locksListPost",
32746
32758
  requestBody: {
32747
32759
  content: {
@@ -32785,7 +32797,7 @@ var openapi_default = {
32785
32797
  type: "array"
32786
32798
  },
32787
32799
  device_type: {
32788
- description: "Device type by which to filter devices.",
32800
+ description: "Device type of the locks that you want to list.",
32789
32801
  enum: [
32790
32802
  "akuvox_lock",
32791
32803
  "august_lock",
@@ -32818,7 +32830,7 @@ var openapi_default = {
32818
32830
  type: "string"
32819
32831
  },
32820
32832
  device_types: {
32821
- description: "Array of device types by which to filter devices.",
32833
+ description: "Device types of the locks that you want to list.",
32822
32834
  items: {
32823
32835
  description: "Device type for smartlocks.\n ",
32824
32836
  enum: [
@@ -32901,7 +32913,7 @@ var openapi_default = {
32901
32913
  type: "number"
32902
32914
  },
32903
32915
  manufacturer: {
32904
- description: "Manufacturer by which to filter devices.",
32916
+ description: "Manufacturer of the locks that you want to list.",
32905
32917
  enum: [
32906
32918
  "akuvox",
32907
32919
  "august",
@@ -32993,19 +33005,29 @@ var openapi_default = {
32993
33005
  "x-fern-sdk-group-name": ["locks"],
32994
33006
  "x-fern-sdk-method-name": "list",
32995
33007
  "x-fern-sdk-return-value": "devices",
32996
- "x-response-key": "devices"
33008
+ "x-response-key": "devices",
33009
+ "x-title": "List Locks"
32997
33010
  }
32998
33011
  },
32999
33012
  "/locks/lock_door": {
33000
33013
  post: {
33014
+ 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
33015
  operationId: "locksLockDoorPost",
33002
33016
  requestBody: {
33003
33017
  content: {
33004
33018
  "application/json": {
33005
33019
  schema: {
33006
33020
  properties: {
33007
- device_id: { format: "uuid", type: "string" },
33008
- sync: { default: false, type: "boolean" }
33021
+ device_id: {
33022
+ description: "ID of the lock that you want to lock.",
33023
+ format: "uuid",
33024
+ type: "string"
33025
+ },
33026
+ sync: {
33027
+ default: false,
33028
+ type: "boolean",
33029
+ "x-undocumented": "Only used internally."
33030
+ }
33009
33031
  },
33010
33032
  required: ["device_id"],
33011
33033
  type: "object"
@@ -33046,19 +33068,28 @@ var openapi_default = {
33046
33068
  "x-fern-sdk-group-name": ["locks"],
33047
33069
  "x-fern-sdk-method-name": "lock_door",
33048
33070
  "x-fern-sdk-return-value": "action_attempt",
33049
- "x-response-key": "action_attempt"
33071
+ "x-response-key": "action_attempt",
33072
+ "x-title": "Lock a Lock"
33050
33073
  }
33051
33074
  },
33052
33075
  "/locks/simulate/keypad_code_entry": {
33053
33076
  post: {
33077
+ 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
33078
  operationId: "locksSimulateKeypadCodeEntryPost",
33055
33079
  requestBody: {
33056
33080
  content: {
33057
33081
  "application/json": {
33058
33082
  schema: {
33059
33083
  properties: {
33060
- code: { type: "string" },
33061
- device_id: { format: "uuid", type: "string" }
33084
+ code: {
33085
+ description: "Code that you want to simulate entering on a keypad.",
33086
+ type: "string"
33087
+ },
33088
+ device_id: {
33089
+ description: "ID of the device for which you want to simulate a keypad code entry.",
33090
+ format: "uuid",
33091
+ type: "string"
33092
+ }
33062
33093
  },
33063
33094
  required: ["device_id", "code"],
33064
33095
  type: "object"
@@ -33104,12 +33135,19 @@ var openapi_default = {
33104
33135
  },
33105
33136
  "/locks/simulate/manual_lock_via_keypad": {
33106
33137
  post: {
33138
+ 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
33139
  operationId: "locksSimulateManualLockViaKeypadPost",
33108
33140
  requestBody: {
33109
33141
  content: {
33110
33142
  "application/json": {
33111
33143
  schema: {
33112
- properties: { device_id: { format: "uuid", type: "string" } },
33144
+ properties: {
33145
+ device_id: {
33146
+ description: "ID of the device for which you want to simulate a manual lock action using a keypad.",
33147
+ format: "uuid",
33148
+ type: "string"
33149
+ }
33150
+ },
33113
33151
  required: ["device_id"],
33114
33152
  type: "object"
33115
33153
  }
@@ -33154,14 +33192,23 @@ var openapi_default = {
33154
33192
  },
33155
33193
  "/locks/unlock_door": {
33156
33194
  post: {
33195
+ 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
33196
  operationId: "locksUnlockDoorPost",
33158
33197
  requestBody: {
33159
33198
  content: {
33160
33199
  "application/json": {
33161
33200
  schema: {
33162
33201
  properties: {
33163
- device_id: { format: "uuid", type: "string" },
33164
- sync: { default: false, type: "boolean" }
33202
+ device_id: {
33203
+ description: "ID of the lock that you want to unlock.",
33204
+ format: "uuid",
33205
+ type: "string"
33206
+ },
33207
+ sync: {
33208
+ default: false,
33209
+ type: "boolean",
33210
+ "x-undocumented": "Only used internally."
33211
+ }
33165
33212
  },
33166
33213
  required: ["device_id"],
33167
33214
  type: "object"
@@ -33202,7 +33249,8 @@ var openapi_default = {
33202
33249
  "x-fern-sdk-group-name": ["locks"],
33203
33250
  "x-fern-sdk-method-name": "unlock_door",
33204
33251
  "x-fern-sdk-return-value": "action_attempt",
33205
- "x-response-key": "action_attempt"
33252
+ "x-response-key": "action_attempt",
33253
+ "x-title": "Unlock a Lock"
33206
33254
  }
33207
33255
  },
33208
33256
  "/networks/get": {
@@ -33245,10 +33293,12 @@ var openapi_default = {
33245
33293
  ],
33246
33294
  summary: "/networks/get",
33247
33295
  tags: ["/networks"],
33296
+ "x-deprecated": "Will be removed.",
33248
33297
  "x-fern-sdk-group-name": ["networks"],
33249
33298
  "x-fern-sdk-method-name": "get",
33250
33299
  "x-fern-sdk-return-value": "network",
33251
- "x-response-key": "network"
33300
+ "x-response-key": "network",
33301
+ "x-undocumented": "Deprecated."
33252
33302
  }
33253
33303
  },
33254
33304
  "/networks/list": {
@@ -33288,10 +33338,12 @@ var openapi_default = {
33288
33338
  ],
33289
33339
  summary: "/networks/list",
33290
33340
  tags: ["/networks"],
33341
+ "x-deprecated": "Will be removed.",
33291
33342
  "x-fern-sdk-group-name": ["networks"],
33292
33343
  "x-fern-sdk-method-name": "list",
33293
33344
  "x-fern-sdk-return-value": "networks",
33294
- "x-response-key": "networks"
33345
+ "x-response-key": "networks",
33346
+ "x-undocumented": "Deprecated."
33295
33347
  }
33296
33348
  },
33297
33349
  "/noise_sensors/list": {
@@ -35462,7 +35514,7 @@ var openapi_default = {
35462
35514
  400: { description: "Bad Request" },
35463
35515
  401: { description: "Unauthorized" }
35464
35516
  },
35465
- security: [{ customer_client_session: [] }],
35517
+ security: [{ client_session_with_customer: [] }],
35466
35518
  summary: "/seam/partner/v1/resources/list",
35467
35519
  tags: [],
35468
35520
  "x-fern-sdk-group-name": ["seam", "partner", "v1", "resources"],
@@ -38147,7 +38199,7 @@ var openapi_default = {
38147
38199
  { pat_with_workspace: [] },
38148
38200
  { console_session_with_workspace: [] },
38149
38201
  { api_key: [] },
38150
- { customer_client_session: [] }
38202
+ { client_session_with_customer: [] }
38151
38203
  ],
38152
38204
  summary: "/unstable_access_grants/create",
38153
38205
  tags: [],
@@ -38200,7 +38252,7 @@ var openapi_default = {
38200
38252
  { pat_with_workspace: [] },
38201
38253
  { console_session_with_workspace: [] },
38202
38254
  { api_key: [] },
38203
- { customer_client_session: [] }
38255
+ { client_session_with_customer: [] }
38204
38256
  ],
38205
38257
  summary: "/unstable_access_grants/delete",
38206
38258
  tags: [],
@@ -38339,7 +38391,7 @@ var openapi_default = {
38339
38391
  { pat_with_workspace: [] },
38340
38392
  { console_session_with_workspace: [] },
38341
38393
  { api_key: [] },
38342
- { customer_client_session: [] }
38394
+ { client_session_with_customer: [] }
38343
38395
  ],
38344
38396
  summary: "/unstable_access_grants/get",
38345
38397
  tags: [],
@@ -38496,7 +38548,7 @@ var openapi_default = {
38496
38548
  { pat_with_workspace: [] },
38497
38549
  { console_session_with_workspace: [] },
38498
38550
  { api_key: [] },
38499
- { customer_client_session: [] }
38551
+ { client_session_with_customer: [] }
38500
38552
  ],
38501
38553
  summary: "/unstable_access_grants/list",
38502
38554
  tags: [],