@seamapi/types 1.423.4 → 1.425.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 (47) hide show
  1. package/dist/connect.cjs +225 -24
  2. package/dist/connect.cjs.map +1 -1
  3. package/dist/connect.d.cts +602 -12
  4. package/lib/seam/connect/internal/schemas.d.ts +1 -1
  5. package/lib/seam/connect/internal/schemas.js +1 -1
  6. package/lib/seam/connect/internal/schemas.js.map +1 -1
  7. package/lib/seam/connect/models/acs/acs-credential.d.ts +6 -0
  8. package/lib/seam/connect/models/acs/acs-credential.js +4 -0
  9. package/lib/seam/connect/models/acs/acs-credential.js.map +1 -1
  10. package/lib/seam/connect/models/acs/acs-entrance.d.ts +25 -2
  11. package/lib/seam/connect/models/acs/acs-entrance.js +18 -2
  12. package/lib/seam/connect/models/acs/acs-entrance.js.map +1 -1
  13. package/lib/seam/connect/models/acs/acs-system.js +4 -1
  14. package/lib/seam/connect/models/acs/acs-system.js.map +1 -1
  15. package/lib/seam/connect/models/action-attempts/action-attempt.d.ts +24 -0
  16. package/lib/seam/connect/models/action-attempts/encode-credential.d.ts +10 -0
  17. package/lib/seam/connect/models/action-attempts/scan-credential.d.ts +14 -0
  18. package/lib/seam/connect/models/connect-webviews/connect-webview.d.ts +2 -4
  19. package/lib/seam/connect/models/connect-webviews/connect-webview.js +3 -9
  20. package/lib/seam/connect/models/connect-webviews/connect-webview.js.map +1 -1
  21. package/lib/seam/connect/models/connected-accounts/connected-account.d.ts +3 -0
  22. package/lib/seam/connect/models/connected-accounts/connected-account.js +4 -0
  23. package/lib/seam/connect/models/connected-accounts/connected-account.js.map +1 -1
  24. package/lib/seam/connect/models/devices/device-provider.d.ts +2 -2
  25. package/lib/seam/connect/models/index.d.ts +1 -0
  26. package/lib/seam/connect/models/index.js +1 -0
  27. package/lib/seam/connect/models/index.js.map +1 -1
  28. package/lib/seam/connect/models/phones/phone-session.d.ts +66 -4
  29. package/lib/seam/connect/models/provider-capability.d.ts +3 -0
  30. package/lib/seam/connect/models/provider-capability.js +11 -0
  31. package/lib/seam/connect/models/provider-capability.js.map +1 -0
  32. package/lib/seam/connect/openapi.d.ts +263 -5
  33. package/lib/seam/connect/openapi.js +190 -11
  34. package/lib/seam/connect/openapi.js.map +1 -1
  35. package/lib/seam/connect/route-types.d.ts +292 -3
  36. package/package.json +1 -1
  37. package/src/lib/seam/connect/internal/schemas.ts +2 -0
  38. package/src/lib/seam/connect/models/acs/acs-credential.ts +6 -0
  39. package/src/lib/seam/connect/models/acs/acs-entrance.ts +93 -70
  40. package/src/lib/seam/connect/models/acs/acs-system.ts +4 -1
  41. package/src/lib/seam/connect/models/connect-webviews/connect-webview.ts +3 -16
  42. package/src/lib/seam/connect/models/connected-accounts/connected-account.ts +6 -0
  43. package/src/lib/seam/connect/models/devices/device-provider.ts +2 -2
  44. package/src/lib/seam/connect/models/index.ts +1 -0
  45. package/src/lib/seam/connect/models/provider-capability.ts +13 -0
  46. package/src/lib/seam/connect/openapi.ts +217 -11
  47. package/src/lib/seam/connect/route-types.ts +298 -3
package/dist/connect.cjs CHANGED
@@ -711,6 +711,15 @@ zod.z.record(
711
711
  var custom_metadata = zod.z.record(zod.z.string(), zod.z.union([zod.z.string(), zod.z.boolean()])).describe(
712
712
  "Set of key:value pairs. Adding custom metadata to a resource, such as a [Connect Webview](https://docs.seam.co/latest/core-concepts/connect-webviews/attaching-custom-data-to-the-connect-webview), [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts/adding-custom-metadata-to-a-connected-account), or [device](https://docs.seam.co/latest/core-concepts/devices/adding-custom-metadata-to-a-device), enables you to store custom information, like customer details or internal IDs from your application."
713
713
  );
714
+ var provider_capability = zod.z.enum([
715
+ "lock",
716
+ "thermostat",
717
+ "noise_sensor",
718
+ "access_control"
719
+ ]).describe(`
720
+ High-level device capabilities that can be restricted in connect webviews.
721
+ These represent the main device categories that customers can opt into.
722
+ `);
714
723
 
715
724
  // src/lib/seam/connect/models/connected-accounts/connected-account.ts
716
725
  var common_connected_account_error = zod.z.object({
@@ -864,6 +873,9 @@ var connected_account = zod.z.object({
864
873
  ),
865
874
  customer_key: zod.z.string().optional().describe(
866
875
  "Your unique key for the customer associated with this connected account."
876
+ ),
877
+ accepted_capabilities: zod.z.array(provider_capability).describe(
878
+ "List of capabilities that were accepted during the account connection process."
867
879
  )
868
880
  }).describe(`
869
881
  ---
@@ -2639,6 +2651,9 @@ var common_acs_credential = zod.z.object({
2639
2651
  acs_user_id: zod.z.string().uuid().optional().describe(
2640
2652
  "ID of the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) to whom the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) belongs."
2641
2653
  ),
2654
+ connected_account_id: zod.z.string().uuid().describe(
2655
+ "ID of the [connected account](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials#connected-accounts) to which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) belongs."
2656
+ ),
2642
2657
  acs_credential_pool_id: zod.z.string().uuid().optional(),
2643
2658
  acs_system_id: zod.z.string().uuid().describe(
2644
2659
  "ID of the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) that contains the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials)."
@@ -2860,6 +2875,17 @@ var acs_entrance_salto_space_metadata = zod.z.object({
2860
2875
  }).describe("Salto Space-specific metadata associated with the entrance.");
2861
2876
 
2862
2877
  // src/lib/seam/connect/models/acs/acs-entrance.ts
2878
+ var acs_entrance_capability_flags = zod.z.object({
2879
+ can_unlock_with_mobile_key: zod.z.boolean().optional().describe(
2880
+ "Indicates whether the ACS entrance can be unlocked with mobile key credentials."
2881
+ ),
2882
+ can_unlock_with_card: zod.z.boolean().optional().describe(
2883
+ "Indicates whether the ACS entrance can be unlocked with card credentials."
2884
+ ),
2885
+ can_unlock_with_code: zod.z.boolean().optional().describe(
2886
+ "Indicates whether the ACS entrance can be unlocked with pin codes."
2887
+ )
2888
+ });
2863
2889
  var acs_entrance = zod.z.object({
2864
2890
  acs_system_id: zod.z.string().uuid().describe(
2865
2891
  "ID of the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) that contains the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details)."
@@ -2906,7 +2932,7 @@ var acs_entrance = zod.z.object({
2906
2932
  salto_space_metadata: acs_entrance_salto_space_metadata.optional().describe(
2907
2933
  "Salto Space-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details)."
2908
2934
  )
2909
- }).describe(`
2935
+ }).merge(acs_entrance_capability_flags).describe(`
2910
2936
  ---
2911
2937
  route_path: /acs/entrances
2912
2938
  ---
@@ -2914,7 +2940,10 @@ var acs_entrance = zod.z.object({
2914
2940
 
2915
2941
  In an access control system, an entrance is a secured door, gate, zone, or other method of entry. You can list details for all the \`acs_entrance\` resources in your workspace or get these details for a specific \`acs_entrance\`. You can also list all entrances associated with a specific credential, and you can list all credentials associated with a specific entrance.
2916
2942
  `);
2917
- var acs_system_capability_flags = zod.z.object({});
2943
+ var acs_system_capability_flags = zod.z.object({
2944
+ // Access method type capability flags are not publicly exposed for ACS systems
2945
+ // They are only available for ACS entrances
2946
+ });
2918
2947
  var acs_location = zod.z.object({
2919
2948
  time_zone: zod.z.string().nullable().describe(
2920
2949
  "Time zone in which the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) is located."
@@ -4105,14 +4134,7 @@ var connect_webview_device_selection_mode = zod.z.enum([
4105
4134
  "none",
4106
4135
  "single",
4107
4136
  "multiple"
4108
- ]).describe(`
4109
- ---
4110
- undocumented: Not implemented.
4111
- ---
4112
- `);
4113
- var connect_webview_accepted_capabilities = zod.z.enum(["lock", "thermostat", "noise_sensor", "access_control"]).describe(
4114
- "High-level device capabilities that the Connect Webview can accept."
4115
- );
4137
+ ]);
4116
4138
  var connect_webview = zod.z.object({
4117
4139
  connect_webview_id: zod.z.string().uuid().describe("ID of the Connect Webview."),
4118
4140
  workspace_id: zod.z.string().uuid().describe(
@@ -4130,7 +4152,7 @@ var connect_webview = zod.z.object({
4130
4152
  accepted_providers: zod.z.array(zod.z.string()).describe(
4131
4153
  "List of accepted [provider keys](https://docs.seam.co/latest/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-brands-to-display-in-your-connect-webviews)."
4132
4154
  ),
4133
- accepted_capabilities: zod.z.array(connect_webview_accepted_capabilities).describe(
4155
+ accepted_capabilities: zod.z.array(provider_capability).describe(
4134
4156
  "High-level device capabilities that the Connect Webview can accept. When creating a Connect Webview, you can specify the types of devices that it can connect to Seam. If you do not set custom `accepted_capabilities`, Seam uses a default set of `accepted_capabilities` for each provider. For example, if you create a Connect Webview that accepts SmartThing devices, without specifying `accepted_capabilities`, Seam accepts only SmartThings locks. To connect SmartThings thermostats and locks to Seam, create a Connect Webview and include both `thermostat` and `lock` in the `accepted_capabilities`."
4135
4157
  ),
4136
4158
  accepted_devices: zod.z.array(zod.z.string()).describe(
@@ -7353,6 +7375,11 @@ var openapi_default = {
7353
7375
  nullable: true,
7354
7376
  type: "string"
7355
7377
  },
7378
+ connected_account_id: {
7379
+ description: "ID of the [connected account](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials#connected-accounts) to which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) belongs.",
7380
+ format: "uuid",
7381
+ type: "string"
7382
+ },
7356
7383
  created_at: {
7357
7384
  description: "Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was created.",
7358
7385
  format: "date-time",
@@ -7623,6 +7650,7 @@ var openapi_default = {
7623
7650
  },
7624
7651
  required: [
7625
7652
  "acs_credential_id",
7653
+ "connected_account_id",
7626
7654
  "acs_system_id",
7627
7655
  "display_name",
7628
7656
  "access_method",
@@ -7796,6 +7824,18 @@ var openapi_default = {
7796
7824
  required: ["door_type", "door_name"],
7797
7825
  type: "object"
7798
7826
  },
7827
+ can_unlock_with_card: {
7828
+ description: "Indicates whether the ACS entrance can be unlocked with card credentials.",
7829
+ type: "boolean"
7830
+ },
7831
+ can_unlock_with_code: {
7832
+ description: "Indicates whether the ACS entrance can be unlocked with pin codes.",
7833
+ type: "boolean"
7834
+ },
7835
+ can_unlock_with_mobile_key: {
7836
+ description: "Indicates whether the ACS entrance can be unlocked with mobile key credentials.",
7837
+ type: "boolean"
7838
+ },
7799
7839
  connected_account_id: {
7800
7840
  description: "ID of the [connected account](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details) associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details).",
7801
7841
  format: "uuid",
@@ -9425,6 +9465,11 @@ var openapi_default = {
9425
9465
  nullable: true,
9426
9466
  type: "string"
9427
9467
  },
9468
+ connected_account_id: {
9469
+ description: "ID of the [connected account](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials#connected-accounts) to which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) belongs.",
9470
+ format: "uuid",
9471
+ type: "string"
9472
+ },
9428
9473
  created_at: {
9429
9474
  description: "Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was created.",
9430
9475
  format: "date-time",
@@ -9721,6 +9766,7 @@ var openapi_default = {
9721
9766
  },
9722
9767
  required: [
9723
9768
  "acs_credential_id",
9769
+ "connected_account_id",
9724
9770
  "acs_system_id",
9725
9771
  "display_name",
9726
9772
  "access_method",
@@ -9802,6 +9848,11 @@ var openapi_default = {
9802
9848
  nullable: true,
9803
9849
  type: "string"
9804
9850
  },
9851
+ connected_account_id: {
9852
+ description: "ID of the [connected account](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials#connected-accounts) to which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) belongs.",
9853
+ format: "uuid",
9854
+ type: "string"
9855
+ },
9805
9856
  created_at: {
9806
9857
  description: "Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was created.",
9807
9858
  format: "date-time",
@@ -10098,6 +10149,7 @@ var openapi_default = {
10098
10149
  },
10099
10150
  required: [
10100
10151
  "acs_credential_id",
10152
+ "connected_account_id",
10101
10153
  "acs_system_id",
10102
10154
  "display_name",
10103
10155
  "access_method",
@@ -10579,6 +10631,11 @@ var openapi_default = {
10579
10631
  nullable: true,
10580
10632
  type: "string"
10581
10633
  },
10634
+ connected_account_id: {
10635
+ description: "ID of the [connected account](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials#connected-accounts) to which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) belongs.",
10636
+ format: "uuid",
10637
+ type: "string"
10638
+ },
10582
10639
  created_at: {
10583
10640
  description: "Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was created.",
10584
10641
  format: "date-time",
@@ -10873,6 +10930,7 @@ var openapi_default = {
10873
10930
  },
10874
10931
  required: [
10875
10932
  "acs_credential_id",
10933
+ "connected_account_id",
10876
10934
  "acs_system_id",
10877
10935
  "display_name",
10878
10936
  "access_method",
@@ -10954,6 +11012,11 @@ var openapi_default = {
10954
11012
  nullable: true,
10955
11013
  type: "string"
10956
11014
  },
11015
+ connected_account_id: {
11016
+ description: "ID of the [connected account](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials#connected-accounts) to which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) belongs.",
11017
+ format: "uuid",
11018
+ type: "string"
11019
+ },
10957
11020
  created_at: {
10958
11021
  description: "Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was created.",
10959
11022
  format: "date-time",
@@ -11248,6 +11311,7 @@ var openapi_default = {
11248
11311
  },
11249
11312
  required: [
11250
11313
  "acs_credential_id",
11314
+ "connected_account_id",
11251
11315
  "acs_system_id",
11252
11316
  "display_name",
11253
11317
  "access_method",
@@ -13160,7 +13224,7 @@ var openapi_default = {
13160
13224
  accepted_capabilities: {
13161
13225
  description: "High-level device capabilities that the Connect Webview can accept. When creating a Connect Webview, you can specify the types of devices that it can connect to Seam. If you do not set custom `accepted_capabilities`, Seam uses a default set of `accepted_capabilities` for each provider. For example, if you create a Connect Webview that accepts SmartThing devices, without specifying `accepted_capabilities`, Seam accepts only SmartThings locks. To connect SmartThings thermostats and locks to Seam, create a Connect Webview and include both `thermostat` and `lock` in the `accepted_capabilities`.",
13162
13226
  items: {
13163
- description: "High-level device capabilities that the Connect Webview can accept.",
13227
+ description: "\n High-level device capabilities that can be restricted in connect webviews.\n These represent the main device categories that customers can opt into.\n",
13164
13228
  enum: ["lock", "thermostat", "noise_sensor", "access_control"],
13165
13229
  type: "string"
13166
13230
  },
@@ -13235,8 +13299,7 @@ var openapi_default = {
13235
13299
  },
13236
13300
  device_selection_mode: {
13237
13301
  enum: ["none", "single", "multiple"],
13238
- type: "string",
13239
- "x-undocumented": "Not implemented."
13302
+ type: "string"
13240
13303
  },
13241
13304
  login_successful: {
13242
13305
  description: "Indicates whether the user logged in successfully using the Connect Webview.",
@@ -13295,6 +13358,15 @@ var openapi_default = {
13295
13358
  connected_account: {
13296
13359
  description: "Represents a [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts). A connected account is an external third-party account to which your user has authorized Seam to get access, for example, an August account with a list of door locks.",
13297
13360
  properties: {
13361
+ accepted_capabilities: {
13362
+ description: "List of capabilities that were accepted during the account connection process.",
13363
+ items: {
13364
+ description: "\n High-level device capabilities that can be restricted in connect webviews.\n These represent the main device categories that customers can opt into.\n",
13365
+ enum: ["lock", "thermostat", "noise_sensor", "access_control"],
13366
+ type: "string"
13367
+ },
13368
+ type: "array"
13369
+ },
13298
13370
  account_type: {
13299
13371
  description: "Type of connected account.",
13300
13372
  type: "string"
@@ -13650,7 +13722,8 @@ var openapi_default = {
13650
13722
  "errors",
13651
13723
  "warnings",
13652
13724
  "custom_metadata",
13653
- "automatically_manage_new_devices"
13725
+ "automatically_manage_new_devices",
13726
+ "accepted_capabilities"
13654
13727
  ],
13655
13728
  type: "object",
13656
13729
  "x-route-path": "/connected_accounts"
@@ -22096,6 +22169,18 @@ var openapi_default = {
22096
22169
  required: ["door_type", "door_name"],
22097
22170
  type: "object"
22098
22171
  },
22172
+ can_unlock_with_card: {
22173
+ description: "Indicates whether the ACS entrance can be unlocked with card credentials.",
22174
+ type: "boolean"
22175
+ },
22176
+ can_unlock_with_code: {
22177
+ description: "Indicates whether the ACS entrance can be unlocked with pin codes.",
22178
+ type: "boolean"
22179
+ },
22180
+ can_unlock_with_mobile_key: {
22181
+ description: "Indicates whether the ACS entrance can be unlocked with mobile key credentials.",
22182
+ type: "boolean"
22183
+ },
22099
22184
  connected_account_id: {
22100
22185
  description: "ID of the [connected account](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details) associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details).",
22101
22186
  format: "uuid",
@@ -22340,6 +22425,11 @@ var openapi_default = {
22340
22425
  nullable: true,
22341
22426
  type: "string"
22342
22427
  },
22428
+ connected_account_id: {
22429
+ description: "ID of the [connected account](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials#connected-accounts) to which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) belongs.",
22430
+ format: "uuid",
22431
+ type: "string"
22432
+ },
22343
22433
  created_at: {
22344
22434
  description: "Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was created.",
22345
22435
  format: "date-time",
@@ -22633,6 +22723,7 @@ var openapi_default = {
22633
22723
  }
22634
22724
  },
22635
22725
  required: [
22726
+ "connected_account_id",
22636
22727
  "acs_system_id",
22637
22728
  "display_name",
22638
22729
  "access_method",
@@ -24569,6 +24660,11 @@ var openapi_default = {
24569
24660
  nullable: true,
24570
24661
  type: "string"
24571
24662
  },
24663
+ connected_account_id: {
24664
+ description: "ID of the [connected account](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials#connected-accounts) to which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) belongs.",
24665
+ format: "uuid",
24666
+ type: "string"
24667
+ },
24572
24668
  created_at: {
24573
24669
  description: "Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was created.",
24574
24670
  format: "date-time",
@@ -24839,6 +24935,7 @@ var openapi_default = {
24839
24935
  },
24840
24936
  required: [
24841
24937
  "acs_credential_id",
24938
+ "connected_account_id",
24842
24939
  "acs_system_id",
24843
24940
  "display_name",
24844
24941
  "access_method",
@@ -27056,7 +27153,11 @@ var openapi_default = {
27056
27153
  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).",
27057
27154
  type: "boolean"
27058
27155
  },
27059
- use_offline_access_code: { type: "boolean" }
27156
+ use_offline_access_code: {
27157
+ deprecated: true,
27158
+ type: "boolean",
27159
+ "x-deprecated": "Use `is_offline_access_code` instead."
27160
+ }
27060
27161
  },
27061
27162
  required: ["device_id"],
27062
27163
  type: "object"
@@ -27181,7 +27282,11 @@ var openapi_default = {
27181
27282
  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).",
27182
27283
  type: "boolean"
27183
27284
  },
27184
- use_offline_access_code: { type: "boolean" }
27285
+ use_offline_access_code: {
27286
+ deprecated: true,
27287
+ type: "boolean",
27288
+ "x-deprecated": "Use `is_offline_access_code` instead."
27289
+ }
27185
27290
  },
27186
27291
  required: ["device_ids"],
27187
27292
  type: "object"
@@ -27302,7 +27407,11 @@ var openapi_default = {
27302
27407
  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).",
27303
27408
  type: "boolean"
27304
27409
  },
27305
- use_offline_access_code: { type: "boolean" }
27410
+ use_offline_access_code: {
27411
+ deprecated: true,
27412
+ type: "boolean",
27413
+ "x-deprecated": "Use `is_offline_access_code` instead."
27414
+ }
27306
27415
  },
27307
27416
  required: ["device_ids"],
27308
27417
  type: "object"
@@ -28828,7 +28937,11 @@ var openapi_default = {
28828
28937
  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).",
28829
28938
  type: "boolean"
28830
28939
  },
28831
- use_offline_access_code: { type: "boolean" }
28940
+ use_offline_access_code: {
28941
+ deprecated: true,
28942
+ type: "boolean",
28943
+ "x-deprecated": "Use `is_offline_access_code` instead."
28944
+ }
28832
28945
  },
28833
28946
  required: ["access_code_id"],
28834
28947
  type: "object"
@@ -28962,7 +29075,11 @@ var openapi_default = {
28962
29075
  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).",
28963
29076
  type: "boolean"
28964
29077
  },
28965
- use_offline_access_code: { type: "boolean" }
29078
+ use_offline_access_code: {
29079
+ deprecated: true,
29080
+ type: "boolean",
29081
+ "x-deprecated": "Use `is_offline_access_code` instead."
29082
+ }
28966
29083
  },
28967
29084
  required: ["access_code_id"],
28968
29085
  type: "object"
@@ -29096,7 +29213,11 @@ var openapi_default = {
29096
29213
  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).",
29097
29214
  type: "boolean"
29098
29215
  },
29099
- use_offline_access_code: { type: "boolean" }
29216
+ use_offline_access_code: {
29217
+ deprecated: true,
29218
+ type: "boolean",
29219
+ "x-deprecated": "Use `is_offline_access_code` instead."
29220
+ }
29100
29221
  },
29101
29222
  required: ["access_code_id"],
29102
29223
  type: "object"
@@ -29331,7 +29452,6 @@ var openapi_default = {
29331
29452
  },
29332
29453
  ends_at: {
29333
29454
  description: "Date and time at which the validity of the new grant ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. Must be a time in the future and after `starts_at`.",
29334
- format: "date-time",
29335
29455
  type: "string"
29336
29456
  },
29337
29457
  location: {
@@ -29385,7 +29505,6 @@ var openapi_default = {
29385
29505
  },
29386
29506
  starts_at: {
29387
29507
  description: "Date and time at which the validity of the new grant starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.",
29388
- format: "date-time",
29389
29508
  type: "string"
29390
29509
  }
29391
29510
  },
@@ -37137,7 +37256,7 @@ var openapi_default = {
37137
37256
  accepted_capabilities: {
37138
37257
  description: "List of accepted device capabilities that restrict the types of devices that can be connected through the Connect Webview. If not provided, defaults will be determined based on the accepted providers.",
37139
37258
  items: {
37140
- description: "High-level device capabilities that the Connect Webview can accept.",
37259
+ description: "\n High-level device capabilities that can be restricted in connect webviews.\n These represent the main device categories that customers can opt into.\n",
37141
37260
  enum: [
37142
37261
  "lock",
37143
37262
  "thermostat",
@@ -40005,6 +40124,15 @@ var openapi_default = {
40005
40124
  format: "uuid",
40006
40125
  type: "string"
40007
40126
  }
40127
+ },
40128
+ {
40129
+ in: "query",
40130
+ name: "search",
40131
+ schema: {
40132
+ description: "String for which to search. Filters returned devices to include all records that satisfy a partial match using `device_id`, `display_name`, `custom_metadata` or `location.location_name`.",
40133
+ minLength: 1,
40134
+ type: "string"
40135
+ }
40008
40136
  }
40009
40137
  ],
40010
40138
  responses: {
@@ -40308,6 +40436,11 @@ var openapi_default = {
40308
40436
  nullable: true,
40309
40437
  type: "string"
40310
40438
  },
40439
+ search: {
40440
+ description: "String for which to search. Filters returned devices to include all records that satisfy a partial match using `device_id`, `display_name`, `custom_metadata` or `location.location_name`.",
40441
+ minLength: 1,
40442
+ type: "string"
40443
+ },
40311
40444
  space_id: {
40312
40445
  description: "ID of the space for which you want to list devices.",
40313
40446
  format: "uuid",
@@ -41097,6 +41230,15 @@ var openapi_default = {
41097
41230
  format: "uuid",
41098
41231
  type: "string"
41099
41232
  }
41233
+ },
41234
+ {
41235
+ in: "query",
41236
+ name: "search",
41237
+ schema: {
41238
+ description: "String for which to search. Filters returned devices to include all records that satisfy a partial match using `device_id`, `display_name`, `custom_metadata` or `location.location_name`.",
41239
+ minLength: 1,
41240
+ type: "string"
41241
+ }
41100
41242
  }
41101
41243
  ],
41102
41244
  responses: {
@@ -41397,6 +41539,11 @@ var openapi_default = {
41397
41539
  nullable: true,
41398
41540
  type: "string"
41399
41541
  },
41542
+ search: {
41543
+ description: "String for which to search. Filters returned devices to include all records that satisfy a partial match using `device_id`, `display_name`, `custom_metadata` or `location.location_name`.",
41544
+ minLength: 1,
41545
+ type: "string"
41546
+ },
41400
41547
  space_id: {
41401
41548
  description: "ID of the space for which you want to list devices.",
41402
41549
  format: "uuid",
@@ -42957,6 +43104,15 @@ var openapi_default = {
42957
43104
  format: "uuid",
42958
43105
  type: "string"
42959
43106
  }
43107
+ },
43108
+ {
43109
+ in: "query",
43110
+ name: "search",
43111
+ schema: {
43112
+ description: "String for which to search. Filters returned devices to include all records that satisfy a partial match using `device_id`, `display_name`, `custom_metadata` or `location.location_name`.",
43113
+ minLength: 1,
43114
+ type: "string"
43115
+ }
42960
43116
  }
42961
43117
  ],
42962
43118
  responses: {
@@ -43198,6 +43354,11 @@ var openapi_default = {
43198
43354
  nullable: true,
43199
43355
  type: "string"
43200
43356
  },
43357
+ search: {
43358
+ description: "String for which to search. Filters returned devices to include all records that satisfy a partial match using `device_id`, `display_name`, `custom_metadata` or `location.location_name`.",
43359
+ minLength: 1,
43360
+ type: "string"
43361
+ },
43201
43362
  space_id: {
43202
43363
  description: "ID of the space for which you want to list devices.",
43203
43364
  format: "uuid",
@@ -43936,6 +44097,15 @@ var openapi_default = {
43936
44097
  format: "uuid",
43937
44098
  type: "string"
43938
44099
  }
44100
+ },
44101
+ {
44102
+ in: "query",
44103
+ name: "search",
44104
+ schema: {
44105
+ description: "String for which to search. Filters returned devices to include all records that satisfy a partial match using `device_id`, `display_name`, `custom_metadata` or `location.location_name`.",
44106
+ minLength: 1,
44107
+ type: "string"
44108
+ }
43939
44109
  }
43940
44110
  ],
43941
44111
  responses: {
@@ -44092,6 +44262,11 @@ var openapi_default = {
44092
44262
  nullable: true,
44093
44263
  type: "string"
44094
44264
  },
44265
+ search: {
44266
+ description: "String for which to search. Filters returned devices to include all records that satisfy a partial match using `device_id`, `display_name`, `custom_metadata` or `location.location_name`.",
44267
+ minLength: 1,
44268
+ type: "string"
44269
+ },
44095
44270
  space_id: {
44096
44271
  description: "ID of the space for which you want to list devices.",
44097
44272
  format: "uuid",
@@ -48449,6 +48624,15 @@ var openapi_default = {
48449
48624
  format: "uuid",
48450
48625
  type: "string"
48451
48626
  }
48627
+ },
48628
+ {
48629
+ in: "query",
48630
+ name: "search",
48631
+ schema: {
48632
+ description: "String for which to search. Filters returned devices to include all records that satisfy a partial match using `device_id`, `display_name`, `custom_metadata` or `location.location_name`.",
48633
+ minLength: 1,
48634
+ type: "string"
48635
+ }
48452
48636
  }
48453
48637
  ],
48454
48638
  responses: {
@@ -48626,6 +48810,11 @@ var openapi_default = {
48626
48810
  nullable: true,
48627
48811
  type: "string"
48628
48812
  },
48813
+ search: {
48814
+ description: "String for which to search. Filters returned devices to include all records that satisfy a partial match using `device_id`, `display_name`, `custom_metadata` or `location.location_name`.",
48815
+ minLength: 1,
48816
+ type: "string"
48817
+ },
48629
48818
  space_id: {
48630
48819
  description: "ID of the space for which you want to list devices.",
48631
48820
  format: "uuid",
@@ -53341,6 +53530,14 @@ var openapi_default = {
53341
53530
  description: "Returns a list of all [user identities](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity).",
53342
53531
  operationId: "userIdentitiesListGet",
53343
53532
  parameters: [
53533
+ {
53534
+ in: "query",
53535
+ name: "search",
53536
+ schema: {
53537
+ description: "String for which to search. Filters returned user identities to include all records that satisfy a partial match using `full_name`, `phone_number`, `email_address` or `user_identity_id`.",
53538
+ type: "string"
53539
+ }
53540
+ },
53344
53541
  {
53345
53542
  in: "query",
53346
53543
  name: "credential_manager_acs_system_id",
@@ -53399,6 +53596,10 @@ var openapi_default = {
53399
53596
  description: "`acs_system_id` of the credential manager by which you want to filter the list of user identities.",
53400
53597
  format: "uuid",
53401
53598
  type: "string"
53599
+ },
53600
+ search: {
53601
+ description: "String for which to search. Filters returned user identities to include all records that satisfy a partial match using `full_name`, `phone_number`, `email_address` or `user_identity_id`.",
53602
+ type: "string"
53402
53603
  }
53403
53604
  },
53404
53605
  type: "object"