@seamapi/types 1.369.1 → 1.370.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 (54) hide show
  1. package/dist/connect.cjs +380 -5
  2. package/dist/connect.cjs.map +1 -1
  3. package/dist/connect.d.cts +525 -28
  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/access-grants/access-grant.d.ts +57 -0
  8. package/lib/seam/connect/models/access-grants/access-grant.js +29 -0
  9. package/lib/seam/connect/models/access-grants/access-grant.js.map +1 -0
  10. package/lib/seam/connect/models/access-grants/access-method.d.ts +21 -0
  11. package/lib/seam/connect/models/access-grants/access-method.js +24 -0
  12. package/lib/seam/connect/models/access-grants/access-method.js.map +1 -0
  13. package/lib/seam/connect/models/access-grants/index.d.ts +2 -0
  14. package/lib/seam/connect/models/access-grants/index.js +3 -0
  15. package/lib/seam/connect/models/access-grants/index.js.map +1 -0
  16. package/lib/seam/connect/models/acs/acs-credential-provisioning-automation.d.ts +4 -4
  17. package/lib/seam/connect/models/acs/acs-credential.d.ts +4 -4
  18. package/lib/seam/connect/models/acs/acs-users/acs-user.d.ts +4 -4
  19. package/lib/seam/connect/models/acs/acs-users/acs-user.js +2 -0
  20. package/lib/seam/connect/models/acs/acs-users/acs-user.js.map +1 -1
  21. package/lib/seam/connect/models/action-attempts/action-attempt.d.ts +20 -20
  22. package/lib/seam/connect/models/action-attempts/encode-credential.d.ts +8 -8
  23. package/lib/seam/connect/models/action-attempts/scan-credential.d.ts +12 -12
  24. package/lib/seam/connect/models/bridges/{bridge_client_session.js → bridge-client-session.js} +1 -1
  25. package/lib/seam/connect/models/bridges/{bridge_client_session.js.map → bridge-client-session.js.map} +1 -1
  26. package/lib/seam/connect/models/bridges/bridge-connected-system.d.ts +30 -0
  27. package/lib/seam/connect/models/bridges/bridge-connected-system.js +17 -0
  28. package/lib/seam/connect/models/bridges/bridge-connected-system.js.map +1 -0
  29. package/lib/seam/connect/models/bridges/index.d.ts +2 -1
  30. package/lib/seam/connect/models/bridges/index.js +2 -1
  31. package/lib/seam/connect/models/bridges/index.js.map +1 -1
  32. package/lib/seam/connect/models/index.d.ts +1 -0
  33. package/lib/seam/connect/models/index.js +1 -0
  34. package/lib/seam/connect/models/index.js.map +1 -1
  35. package/lib/seam/connect/models/pagination.js +1 -0
  36. package/lib/seam/connect/models/pagination.js.map +1 -1
  37. package/lib/seam/connect/openapi.d.ts +408 -0
  38. package/lib/seam/connect/openapi.js +375 -0
  39. package/lib/seam/connect/openapi.js.map +1 -1
  40. package/lib/seam/connect/route-types.d.ts +89 -0
  41. package/package.json +1 -1
  42. package/src/lib/seam/connect/internal/schemas.ts +3 -0
  43. package/src/lib/seam/connect/models/access-grants/access-grant.ts +34 -0
  44. package/src/lib/seam/connect/models/access-grants/access-method.ts +28 -0
  45. package/src/lib/seam/connect/models/access-grants/index.ts +2 -0
  46. package/src/lib/seam/connect/models/acs/acs-users/acs-user.ts +2 -0
  47. package/src/lib/seam/connect/models/bridges/bridge-connected-system.ts +19 -0
  48. package/src/lib/seam/connect/models/bridges/index.ts +2 -1
  49. package/src/lib/seam/connect/models/index.ts +1 -0
  50. package/src/lib/seam/connect/models/pagination.ts +1 -0
  51. package/src/lib/seam/connect/openapi.ts +400 -0
  52. package/src/lib/seam/connect/route-types.ts +96 -0
  53. /package/lib/seam/connect/models/bridges/{bridge_client_session.d.ts → bridge-client-session.d.ts} +0 -0
  54. /package/src/lib/seam/connect/models/bridges/{bridge_client_session.ts → bridge-client-session.ts} +0 -0
package/dist/connect.cjs CHANGED
@@ -2536,7 +2536,7 @@ zod.z.object({
2536
2536
  profile: acs_user_profile_modification.optional().nullable()
2537
2537
  });
2538
2538
  var user_fields = zod.z.object({
2539
- full_name: zod.z.string().optional().describe(
2539
+ full_name: zod.z.string().trim().min(1).optional().describe(
2540
2540
  "Full name of the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management)."
2541
2541
  ),
2542
2542
  email: zod.z.string().email().optional().describe(`
@@ -4099,7 +4099,7 @@ var noise_threshold = zod.z.object({
4099
4099
  ---
4100
4100
  `);
4101
4101
  var pagination = zod.z.object({
4102
- next_page_cursor: zod.z.string().nullable().describe(
4102
+ next_page_cursor: zod.z.string().base64().nullable().describe(
4103
4103
  "Opaque value that can be used to select the next page of results via the `page_cursor` parameter."
4104
4104
  ),
4105
4105
  has_next_page: zod.z.boolean().describe(
@@ -6330,6 +6330,7 @@ var openapi_default = {
6330
6330
  },
6331
6331
  full_name: {
6332
6332
  description: "Full name of the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).",
6333
+ minLength: 1,
6333
6334
  type: "string"
6334
6335
  },
6335
6336
  hid_acs_system_id: { format: "uuid", type: "string" },
@@ -17882,6 +17883,7 @@ var openapi_default = {
17882
17883
  },
17883
17884
  full_name: {
17884
17885
  description: "Full name of the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).",
17886
+ minLength: 1,
17885
17887
  type: "string"
17886
17888
  },
17887
17889
  hid_acs_system_id: { format: "uuid", type: "string" },
@@ -23753,6 +23755,7 @@ var openapi_default = {
23753
23755
  },
23754
23756
  full_name: {
23755
23757
  description: "Full name of the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).",
23758
+ minLength: 1,
23756
23759
  type: "string"
23757
23760
  },
23758
23761
  hid_acs_system_id: { format: "uuid", type: "string" },
@@ -23830,6 +23833,7 @@ var openapi_default = {
23830
23833
  },
23831
23834
  full_name: {
23832
23835
  description: "Full name of the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).",
23836
+ minLength: 1,
23833
23837
  type: "string"
23834
23838
  },
23835
23839
  hid_acs_system_id: { format: "uuid", type: "string" },
@@ -25593,7 +25597,8 @@ var openapi_default = {
25593
25597
  tags: ["/devices"],
25594
25598
  "x-fern-sdk-group-name": ["devices", "simulate"],
25595
25599
  "x-fern-sdk-method-name": "access_code_lock",
25596
- "x-response-key": null
25600
+ "x-response-key": null,
25601
+ "x-undocumented": "Unreleased."
25597
25602
  }
25598
25603
  },
25599
25604
  "/devices/simulate/access_code_unlock": {
@@ -25638,7 +25643,8 @@ var openapi_default = {
25638
25643
  tags: ["/devices"],
25639
25644
  "x-fern-sdk-group-name": ["devices", "simulate"],
25640
25645
  "x-fern-sdk-method-name": "access_code_unlock",
25641
- "x-response-key": null
25646
+ "x-response-key": null,
25647
+ "x-undocumented": "Unreleased."
25642
25648
  }
25643
25649
  },
25644
25650
  "/devices/simulate/connect": {
@@ -28804,6 +28810,147 @@ var openapi_default = {
28804
28810
  "x-undocumented": "Seam Bridge Client only."
28805
28811
  }
28806
28812
  },
28813
+ "/seam/bridge/v1/bridge_connected_systems/list": {
28814
+ get: {
28815
+ description: "Returns the bridge connected systems associated with the session token used.",
28816
+ operationId: "seamBridgeV1BridgeConnectedSystemsListGet",
28817
+ responses: {
28818
+ 200: {
28819
+ content: {
28820
+ "application/json": {
28821
+ schema: {
28822
+ properties: {
28823
+ bridge_connected_systems: {
28824
+ items: {
28825
+ properties: {
28826
+ acs_system_display_name: { type: "string" },
28827
+ acs_system_id: { format: "uuid", type: "string" },
28828
+ bridge_created_at: {
28829
+ format: "date-time",
28830
+ type: "string"
28831
+ },
28832
+ bridge_id: { format: "uuid", type: "string" },
28833
+ connected_account_created_at: {
28834
+ format: "date-time",
28835
+ type: "string"
28836
+ },
28837
+ connected_account_id: {
28838
+ format: "uuid",
28839
+ type: "string"
28840
+ },
28841
+ workspace_display_name: { type: "string" },
28842
+ workspace_id: { format: "uuid", type: "string" }
28843
+ },
28844
+ required: [
28845
+ "bridge_id",
28846
+ "bridge_created_at",
28847
+ "connected_account_id",
28848
+ "connected_account_created_at",
28849
+ "acs_system_id",
28850
+ "acs_system_display_name",
28851
+ "workspace_id",
28852
+ "workspace_display_name"
28853
+ ],
28854
+ type: "object",
28855
+ "x-route-path": "/seam/bridge/v1/bridge_connected_systems",
28856
+ "x-undocumented": "Seam Bridge Client only."
28857
+ },
28858
+ type: "array"
28859
+ },
28860
+ ok: { type: "boolean" }
28861
+ },
28862
+ required: ["bridge_connected_systems", "ok"],
28863
+ type: "object"
28864
+ }
28865
+ }
28866
+ },
28867
+ description: "OK"
28868
+ },
28869
+ 400: { description: "Bad Request" },
28870
+ 401: { description: "Unauthorized" }
28871
+ },
28872
+ security: [{ bridge_client_session: [] }],
28873
+ summary: "/seam/bridge/v1/bridge_connected_systems/list",
28874
+ tags: [],
28875
+ "x-fern-ignore": true,
28876
+ "x-response-key": "bridge_connected_systems",
28877
+ "x-title": "List Bridge Connected Systems",
28878
+ "x-undocumented": "Seam Bridge Client only."
28879
+ },
28880
+ post: {
28881
+ description: "Returns the bridge connected systems associated with the session token used.",
28882
+ operationId: "seamBridgeV1BridgeConnectedSystemsListPost",
28883
+ responses: {
28884
+ 200: {
28885
+ content: {
28886
+ "application/json": {
28887
+ schema: {
28888
+ properties: {
28889
+ bridge_connected_systems: {
28890
+ items: {
28891
+ properties: {
28892
+ acs_system_display_name: { type: "string" },
28893
+ acs_system_id: { format: "uuid", type: "string" },
28894
+ bridge_created_at: {
28895
+ format: "date-time",
28896
+ type: "string"
28897
+ },
28898
+ bridge_id: { format: "uuid", type: "string" },
28899
+ connected_account_created_at: {
28900
+ format: "date-time",
28901
+ type: "string"
28902
+ },
28903
+ connected_account_id: {
28904
+ format: "uuid",
28905
+ type: "string"
28906
+ },
28907
+ workspace_display_name: { type: "string" },
28908
+ workspace_id: { format: "uuid", type: "string" }
28909
+ },
28910
+ required: [
28911
+ "bridge_id",
28912
+ "bridge_created_at",
28913
+ "connected_account_id",
28914
+ "connected_account_created_at",
28915
+ "acs_system_id",
28916
+ "acs_system_display_name",
28917
+ "workspace_id",
28918
+ "workspace_display_name"
28919
+ ],
28920
+ type: "object",
28921
+ "x-route-path": "/seam/bridge/v1/bridge_connected_systems",
28922
+ "x-undocumented": "Seam Bridge Client only."
28923
+ },
28924
+ type: "array"
28925
+ },
28926
+ ok: { type: "boolean" }
28927
+ },
28928
+ required: ["bridge_connected_systems", "ok"],
28929
+ type: "object"
28930
+ }
28931
+ }
28932
+ },
28933
+ description: "OK"
28934
+ },
28935
+ 400: { description: "Bad Request" },
28936
+ 401: { description: "Unauthorized" }
28937
+ },
28938
+ security: [{ bridge_client_session: [] }],
28939
+ summary: "/seam/bridge/v1/bridge_connected_systems/list",
28940
+ tags: [],
28941
+ "x-fern-sdk-group-name": [
28942
+ "seam",
28943
+ "bridge",
28944
+ "v1",
28945
+ "bridge_connected_systems"
28946
+ ],
28947
+ "x-fern-sdk-method-name": "list",
28948
+ "x-fern-sdk-return-value": "bridge_connected_systems",
28949
+ "x-response-key": "bridge_connected_systems",
28950
+ "x-title": "List Bridge Connected Systems",
28951
+ "x-undocumented": "Seam Bridge Client only."
28952
+ }
28953
+ },
28807
28954
  "/thermostats/activate_climate_preset": {
28808
28955
  post: {
28809
28956
  description: "Activates a specified [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) for a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats).",
@@ -30905,6 +31052,233 @@ var openapi_default = {
30905
31052
  "x-title": "Update a Climate Preset"
30906
31053
  }
30907
31054
  },
31055
+ "/unstable_access_grants/create": {
31056
+ post: {
31057
+ description: "Creates a new access grant.",
31058
+ operationId: "unstableAccessGrantsCreatePost",
31059
+ requestBody: {
31060
+ content: {
31061
+ "application/json": {
31062
+ schema: {
31063
+ allOf: [
31064
+ {
31065
+ oneOf: [
31066
+ {
31067
+ properties: {
31068
+ user_identity_id: {
31069
+ description: "ID of user identity for whom access is being granted.",
31070
+ format: "uuid",
31071
+ type: "string"
31072
+ }
31073
+ },
31074
+ type: "object"
31075
+ },
31076
+ {
31077
+ properties: {
31078
+ user_identity: {
31079
+ description: "When used, creates a new user identity with the given details, and grants them access.",
31080
+ properties: {
31081
+ email_address: {
31082
+ description: "Unique email address for the user identity.",
31083
+ format: "email",
31084
+ nullable: true,
31085
+ type: "string"
31086
+ },
31087
+ full_name: {
31088
+ minLength: 1,
31089
+ nullable: true,
31090
+ type: "string"
31091
+ },
31092
+ phone_number: {
31093
+ description: "Unique phone number for the user identity in [E.164 format](https://www.itu.int/rec/T-REC-E.164/en) (for example, +15555550100).",
31094
+ nullable: true,
31095
+ type: "string"
31096
+ }
31097
+ },
31098
+ type: "object",
31099
+ "x-route-path": "/user_identities"
31100
+ }
31101
+ },
31102
+ type: "object"
31103
+ }
31104
+ ]
31105
+ },
31106
+ {
31107
+ properties: {
31108
+ desired_access_methods: {
31109
+ items: {
31110
+ properties: {
31111
+ mode: {
31112
+ description: "Access method mode. Supported values: `code`, `card`, `mobile_key`.",
31113
+ enum: ["code", "card", "mobile_key"],
31114
+ type: "string"
31115
+ }
31116
+ },
31117
+ required: ["mode"],
31118
+ type: "object"
31119
+ },
31120
+ type: "array"
31121
+ },
31122
+ ends_at: {
31123
+ 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`.",
31124
+ format: "date-time",
31125
+ type: "string"
31126
+ },
31127
+ location: {
31128
+ description: "When used, creates a new location with the given entrances and devices, and gives the user access to this location.",
31129
+ properties: {
31130
+ acs_entrance_ids: {
31131
+ default: [],
31132
+ description: "Set of IDs of the [entrances](https://docs.seam.co/latest/api/acs/systems/list) to add to the location to which access is being granted.",
31133
+ items: { format: "uuid", type: "string" },
31134
+ type: "array"
31135
+ },
31136
+ device_ids: {
31137
+ default: [],
31138
+ description: "Set of IDs of the [devices](https://docs.seam.co/latest/api/devices/list) to add to the location to which access is being granted.",
31139
+ items: { format: "uuid", type: "string" },
31140
+ type: "array"
31141
+ }
31142
+ },
31143
+ type: "object"
31144
+ },
31145
+ location_ids: {
31146
+ description: "Set of IDs of existing locations to which access is being granted.",
31147
+ items: { format: "uuid", type: "string" },
31148
+ type: "array"
31149
+ },
31150
+ starts_at: {
31151
+ 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.",
31152
+ format: "date-time",
31153
+ type: "string"
31154
+ }
31155
+ },
31156
+ required: ["desired_access_methods"],
31157
+ type: "object"
31158
+ }
31159
+ ]
31160
+ }
31161
+ }
31162
+ }
31163
+ },
31164
+ responses: {
31165
+ 200: {
31166
+ content: {
31167
+ "application/json": {
31168
+ schema: {
31169
+ properties: {
31170
+ access_grant: {
31171
+ properties: {
31172
+ access_grant_id: {
31173
+ description: "ID of the access grant.",
31174
+ format: "uuid",
31175
+ type: "string"
31176
+ },
31177
+ access_methods: {
31178
+ description: "Access methods associated with this access grant.",
31179
+ items: {
31180
+ properties: {
31181
+ access_method_key: {
31182
+ description: "Key for the access method - unique within an access grant.",
31183
+ type: "string"
31184
+ },
31185
+ created_at: {
31186
+ description: "Date and time at which the access method was created.",
31187
+ format: "date-time",
31188
+ type: "string"
31189
+ },
31190
+ display_name: {
31191
+ description: "Display name of the access method.",
31192
+ type: "string"
31193
+ },
31194
+ issued_at: {
31195
+ description: "Date and time at which the access method was issued.",
31196
+ format: "date-time",
31197
+ nullable: true,
31198
+ type: "string"
31199
+ },
31200
+ mode: {
31201
+ description: "Access method mode. Supported values: `code`, `card`, `mobile_key`.",
31202
+ enum: ["code", "card", "mobile_key"],
31203
+ type: "string"
31204
+ }
31205
+ },
31206
+ required: [
31207
+ "access_method_key",
31208
+ "display_name",
31209
+ "mode",
31210
+ "created_at",
31211
+ "issued_at"
31212
+ ],
31213
+ type: "object",
31214
+ "x-undocumented": "Unreleased."
31215
+ },
31216
+ type: "array"
31217
+ },
31218
+ created_at: {
31219
+ description: "Date and time at which the access grant was created.",
31220
+ format: "date-time",
31221
+ type: "string"
31222
+ },
31223
+ display_name: {
31224
+ description: "Display name of the access grant.",
31225
+ type: "string"
31226
+ },
31227
+ location_ids: {
31228
+ description: "IDs of the locations to which access is being given.",
31229
+ items: { format: "uuid", type: "string" },
31230
+ type: "array"
31231
+ },
31232
+ user_identity_id: {
31233
+ description: "ID of user identity to which access is being granted.",
31234
+ format: "uuid",
31235
+ type: "string"
31236
+ },
31237
+ workspace_id: {
31238
+ description: "Unique identifier for the Seam workspace associated with the access grant.",
31239
+ format: "uuid",
31240
+ type: "string"
31241
+ }
31242
+ },
31243
+ required: [
31244
+ "workspace_id",
31245
+ "access_grant_id",
31246
+ "user_identity_id",
31247
+ "location_ids",
31248
+ "access_methods",
31249
+ "display_name",
31250
+ "created_at"
31251
+ ],
31252
+ type: "object",
31253
+ "x-undocumented": "Unreleased."
31254
+ },
31255
+ ok: { type: "boolean" }
31256
+ },
31257
+ required: ["access_grant", "ok"],
31258
+ type: "object"
31259
+ }
31260
+ }
31261
+ },
31262
+ description: "OK"
31263
+ },
31264
+ 400: { description: "Bad Request" },
31265
+ 401: { description: "Unauthorized" }
31266
+ },
31267
+ security: [
31268
+ { pat_with_workspace: [] },
31269
+ { console_session_with_workspace: [] },
31270
+ { api_key: [] }
31271
+ ],
31272
+ summary: "/unstable_access_grants/create",
31273
+ tags: [],
31274
+ "x-fern-sdk-group-name": ["unstable_access_grants"],
31275
+ "x-fern-sdk-method-name": "create",
31276
+ "x-fern-sdk-return-value": "access_grant",
31277
+ "x-response-key": "access_grant",
31278
+ "x-title": "Create an Access Grant",
31279
+ "x-undocumented": "Unreleased."
31280
+ }
31281
+ },
30908
31282
  "/unstable_locations/add_devices": {
30909
31283
  post: {
30910
31284
  description: "Add devices to a specific location. If a device already belongs to a location it will be moved.",
@@ -33158,7 +33532,8 @@ var openapi_default = {
33158
33532
  type: "string"
33159
33533
  },
33160
33534
  webview_primary_button_color: { type: "string" },
33161
- webview_primary_button_text_color: { type: "string" }
33535
+ webview_primary_button_text_color: { type: "string" },
33536
+ webview_success_message: { type: "string" }
33162
33537
  },
33163
33538
  required: ["name"],
33164
33539
  type: "object"