@seamapi/types 1.407.0 → 1.409.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 (44) hide show
  1. package/dist/connect.cjs +2194 -526
  2. package/dist/connect.cjs.map +1 -1
  3. package/dist/connect.d.cts +4416 -1760
  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/model-types.d.ts +1 -1
  8. package/lib/seam/connect/models/access-grants/access-grant.d.ts +3 -0
  9. package/lib/seam/connect/models/access-grants/access-grant.js +9 -3
  10. package/lib/seam/connect/models/access-grants/access-grant.js.map +1 -1
  11. package/lib/seam/connect/models/access-grants/access-method.js +2 -1
  12. package/lib/seam/connect/models/access-grants/access-method.js.map +1 -1
  13. package/lib/seam/connect/models/access-grants/requested-access-method.js +1 -5
  14. package/lib/seam/connect/models/access-grants/requested-access-method.js.map +1 -1
  15. package/lib/seam/connect/models/index.d.ts +1 -0
  16. package/lib/seam/connect/models/index.js +1 -0
  17. package/lib/seam/connect/models/index.js.map +1 -1
  18. package/lib/seam/connect/models/pagination.d.ts +1 -0
  19. package/lib/seam/connect/models/spaces/index.d.ts +1 -0
  20. package/lib/seam/connect/models/spaces/index.js +2 -0
  21. package/lib/seam/connect/models/spaces/index.js.map +1 -0
  22. package/lib/seam/connect/models/spaces/space.d.ts +21 -0
  23. package/lib/seam/connect/models/spaces/space.js +20 -0
  24. package/lib/seam/connect/models/spaces/space.js.map +1 -0
  25. package/lib/seam/connect/openapi.d.ts +5805 -3750
  26. package/lib/seam/connect/openapi.js +6538 -4891
  27. package/lib/seam/connect/openapi.js.map +1 -1
  28. package/lib/seam/connect/route-types.d.ts +476 -13
  29. package/lib/seam/connect/schemas.d.ts +1 -1
  30. package/lib/seam/connect/schemas.js +1 -1
  31. package/lib/seam/connect/schemas.js.map +1 -1
  32. package/package.json +1 -1
  33. package/src/lib/seam/connect/internal/schemas.ts +1 -0
  34. package/src/lib/seam/connect/model-types.ts +6 -0
  35. package/src/lib/seam/connect/models/access-grants/access-grant.ts +9 -3
  36. package/src/lib/seam/connect/models/access-grants/access-method.ts +2 -1
  37. package/src/lib/seam/connect/models/access-grants/requested-access-method.ts +1 -5
  38. package/src/lib/seam/connect/models/index.ts +1 -0
  39. package/src/lib/seam/connect/models/pagination.ts +2 -0
  40. package/src/lib/seam/connect/models/spaces/index.ts +1 -0
  41. package/src/lib/seam/connect/models/spaces/space.ts +24 -0
  42. package/src/lib/seam/connect/openapi.ts +7562 -5851
  43. package/src/lib/seam/connect/route-types.ts +481 -13
  44. package/src/lib/seam/connect/schemas.ts +2 -0
package/dist/connect.cjs CHANGED
@@ -21,6 +21,7 @@ __export(schemas_exports, {
21
21
  action_attempt: () => action_attempt,
22
22
  bridge: () => bridge,
23
23
  bridge_client_session: () => bridge_client_session,
24
+ building_block_type: () => building_block_type,
24
25
  client_session: () => client_session,
25
26
  common_failed_action_attempt: () => common_failed_action_attempt,
26
27
  common_pending_action_attempt: () => common_pending_action_attempt,
@@ -31,6 +32,7 @@ __export(schemas_exports, {
31
32
  device: () => device,
32
33
  device_provider: () => device_provider,
33
34
  instant_key: () => instant_key,
35
+ magic_link: () => magic_link,
34
36
  noise_threshold: () => noise_threshold,
35
37
  pagination: () => pagination,
36
38
  seam_event: () => seam_event,
@@ -2366,7 +2368,8 @@ var access_method = zod.z.object({
2366
2368
  )
2367
2369
  }).describe(`
2368
2370
  ---
2369
- undocumented: Unreleased.
2371
+ draft: Early access.
2372
+ route_path: /access_methods
2370
2373
  ---
2371
2374
  `);
2372
2375
  var acs_access_group_external_type = zod.z.enum([
@@ -5069,6 +5072,24 @@ var pagination = zod.z.object({
5069
5072
  ),
5070
5073
  next_page_url: zod.z.string().url().nullable().describe("URL to get the next page of results.")
5071
5074
  }).describe("Information about the current page of results.");
5075
+ var building_block_type = zod.z.enum([
5076
+ "connect_accounts",
5077
+ "manage_devices",
5078
+ "organize_spaces"
5079
+ ]);
5080
+ var magic_link = zod.z.object({
5081
+ url: zod.z.string().url(),
5082
+ building_block_type,
5083
+ customer_key: zod.z.string(),
5084
+ expires_at: zod.z.string().datetime(),
5085
+ workspace_id: zod.z.string().uuid(),
5086
+ created_at: zod.z.string().datetime()
5087
+ }).describe(`
5088
+ ---
5089
+ undocumented: Unreleased.
5090
+ route_path: /unstable_partner/building_blocks
5091
+ ---
5092
+ `);
5072
5093
  var user_identity = zod.z.object({
5073
5094
  user_identity_id: zod.z.string().uuid().describe("ID of the user identity."),
5074
5095
  user_identity_key: zod.z.string().min(1).nullable().describe("Unique key for the user identity."),
@@ -19732,17 +19753,6 @@ var openapi_default = {
19732
19753
  "x-route-path": "/unstable_partner/building_blocks",
19733
19754
  "x-undocumented": "Unreleased."
19734
19755
  },
19735
- network: {
19736
- properties: {
19737
- created_at: { format: "date-time", type: "string" },
19738
- display_name: { type: "string" },
19739
- network_id: { format: "uuid", type: "string" },
19740
- workspace_id: { format: "uuid", type: "string" }
19741
- },
19742
- required: ["network_id", "workspace_id", "display_name", "created_at"],
19743
- type: "object",
19744
- "x-route-path": "/networks"
19745
- },
19746
19756
  noise_threshold: {
19747
19757
  description: "Represents a [noise threshold](https://docs.seam.co/latest/capability-guides/noise-sensors/configure-noise-threshold-settings) for a [noise sensor](https://docs.seam.co/latest/capability-guides/noise-sensors). Thresholds represent the limits of noise tolerated at a property, which can be customized for each hour of the day. Each device has its own default thresholds, but you can use the Seam API to modify them.",
19748
19758
  properties: {
@@ -20499,6 +20509,40 @@ var openapi_default = {
20499
20509
  "x-route-path": "/seam/mobile_sdk/v1/phone_sessions",
20500
20510
  "x-undocumented": "Seam Mobile SDK only."
20501
20511
  },
20512
+ space: {
20513
+ properties: {
20514
+ created_at: {
20515
+ description: "Date and time at which the space object was created.",
20516
+ format: "date-time",
20517
+ type: "string"
20518
+ },
20519
+ display_name: {
20520
+ description: "Display name of the space.",
20521
+ type: "string"
20522
+ },
20523
+ name: { description: "Name of the space.", type: "string" },
20524
+ space_id: {
20525
+ description: "Unique identifier for the space.",
20526
+ format: "uuid",
20527
+ type: "string"
20528
+ },
20529
+ workspace_id: {
20530
+ description: "Unique identifier for the Seam workspace associated with the space.",
20531
+ format: "uuid",
20532
+ type: "string"
20533
+ }
20534
+ },
20535
+ required: [
20536
+ "space_id",
20537
+ "workspace_id",
20538
+ "name",
20539
+ "display_name",
20540
+ "created_at"
20541
+ ],
20542
+ type: "object",
20543
+ "x-draft": "Early access.",
20544
+ "x-route-path": "/spaces"
20545
+ },
20502
20546
  thermostat_schedule: {
20503
20547
  description: "Represents a [thermostat schedule](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules) that activates a configured [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) on a [thermostat](https://docs.seam.co/latest/capability-guides/thermostats) at a specified starting time and deactivates the climate preset at a specified ending time.",
20504
20548
  properties: {
@@ -25778,32 +25822,282 @@ var openapi_default = {
25778
25822
  "x-title": "Update Multiple Linked Access Codes"
25779
25823
  }
25780
25824
  },
25781
- "/acs/access_groups/add_user": {
25825
+ "/access_grants/create": {
25782
25826
  post: {
25783
- description: "Adds a specified [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) to a specified [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups).",
25784
- operationId: "acsAccessGroupsAddUserPost",
25827
+ description: "Creates a new access grant.",
25828
+ operationId: "accessGrantsCreatePost",
25785
25829
  requestBody: {
25786
25830
  content: {
25787
25831
  "application/json": {
25788
25832
  schema: {
25789
- properties: {
25790
- acs_access_group_id: {
25791
- description: "ID of the access group to which you want to add an access system user.",
25792
- format: "uuid",
25793
- type: "string"
25833
+ allOf: [
25834
+ {
25835
+ oneOf: [
25836
+ {
25837
+ properties: {
25838
+ user_identity_id: {
25839
+ description: "ID of user identity for whom access is being granted.",
25840
+ format: "uuid",
25841
+ type: "string"
25842
+ }
25843
+ },
25844
+ required: ["user_identity_id"],
25845
+ type: "object"
25846
+ },
25847
+ {
25848
+ properties: {
25849
+ user_identity: {
25850
+ description: "When used, creates a new user identity with the given details, and grants them access.",
25851
+ properties: {
25852
+ email_address: {
25853
+ description: "Unique email address for the user identity.",
25854
+ format: "email",
25855
+ nullable: true,
25856
+ type: "string"
25857
+ },
25858
+ full_name: {
25859
+ minLength: 1,
25860
+ nullable: true,
25861
+ type: "string"
25862
+ },
25863
+ phone_number: {
25864
+ 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).",
25865
+ nullable: true,
25866
+ type: "string"
25867
+ }
25868
+ },
25869
+ type: "object"
25870
+ }
25871
+ },
25872
+ required: ["user_identity"],
25873
+ type: "object"
25874
+ }
25875
+ ]
25794
25876
  },
25795
- acs_user_id: {
25796
- description: "ID of the access system user that you want to add to an access group. You can only provide one of acs_user_id or user_identity_id.",
25797
- format: "uuid",
25798
- type: "string"
25877
+ {
25878
+ properties: {
25879
+ acs_entrance_ids: {
25880
+ default: [],
25881
+ description: "Set of IDs of the [entrances](https://docs.seam.co/latest/api/acs/systems/list) to which access is being granted.",
25882
+ items: { format: "uuid", type: "string" },
25883
+ type: "array"
25884
+ },
25885
+ device_ids: {
25886
+ default: [],
25887
+ description: "Set of IDs of the [devices](https://docs.seam.co/latest/api/devices/list) to which access is being granted.",
25888
+ items: { format: "uuid", type: "string" },
25889
+ type: "array"
25890
+ },
25891
+ ends_at: {
25892
+ 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`.",
25893
+ format: "date-time",
25894
+ type: "string"
25895
+ },
25896
+ location: {
25897
+ description: "When used, creates a new location with the given entrances and devices, and gives the user access to this location.",
25898
+ properties: {
25899
+ acs_entrance_ids: {
25900
+ default: [],
25901
+ deprecated: true,
25902
+ items: { format: "uuid", type: "string" },
25903
+ type: "array",
25904
+ "x-deprecated": "Use `acs_entrance_ids` at the top level."
25905
+ },
25906
+ device_ids: {
25907
+ default: [],
25908
+ deprecated: true,
25909
+ items: { format: "uuid", type: "string" },
25910
+ type: "array",
25911
+ "x-deprecated": "Use `device_ids` at the top level."
25912
+ },
25913
+ name: {
25914
+ description: "Name of the location.",
25915
+ type: "string"
25916
+ }
25917
+ },
25918
+ type: "object"
25919
+ },
25920
+ location_ids: {
25921
+ deprecated: true,
25922
+ items: { format: "uuid", type: "string" },
25923
+ type: "array",
25924
+ "x-deprecated": "Use `space_ids`."
25925
+ },
25926
+ requested_access_methods: {
25927
+ items: {
25928
+ properties: {
25929
+ mode: {
25930
+ description: "Access method mode. Supported values: `code`, `card`, `mobile_key`.",
25931
+ enum: ["code", "card", "mobile_key"],
25932
+ type: "string"
25933
+ }
25934
+ },
25935
+ required: ["mode"],
25936
+ type: "object"
25937
+ },
25938
+ type: "array"
25939
+ },
25940
+ space_ids: {
25941
+ description: "Set of IDs of existing spaces to which access is being granted.",
25942
+ items: { format: "uuid", type: "string" },
25943
+ type: "array"
25944
+ },
25945
+ starts_at: {
25946
+ 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.",
25947
+ format: "date-time",
25948
+ type: "string"
25949
+ }
25950
+ },
25951
+ required: ["requested_access_methods"],
25952
+ type: "object"
25953
+ }
25954
+ ]
25955
+ }
25956
+ }
25957
+ }
25958
+ },
25959
+ responses: {
25960
+ 200: {
25961
+ content: {
25962
+ "application/json": {
25963
+ schema: {
25964
+ properties: {
25965
+ access_grant: {
25966
+ properties: {
25967
+ access_grant_id: {
25968
+ description: "ID of the access grant.",
25969
+ format: "uuid",
25970
+ type: "string"
25971
+ },
25972
+ access_method_ids: {
25973
+ description: "IDs of the access methods that were created for this access grant.",
25974
+ items: { format: "uuid", type: "string" },
25975
+ type: "array"
25976
+ },
25977
+ created_at: {
25978
+ description: "Date and time at which the access grant was created.",
25979
+ format: "date-time",
25980
+ type: "string"
25981
+ },
25982
+ display_name: {
25983
+ description: "Display name of the access grant.",
25984
+ type: "string"
25985
+ },
25986
+ location_ids: {
25987
+ deprecated: true,
25988
+ items: { format: "uuid", type: "string" },
25989
+ type: "array",
25990
+ "x-deprecated": "Use `space_ids`."
25991
+ },
25992
+ requested_access_methods: {
25993
+ description: "Access methods that the user requested for this access grant.",
25994
+ items: {
25995
+ properties: {
25996
+ created_access_method_ids: {
25997
+ description: "IDs of the access methods that were created for this requested access method.",
25998
+ items: { format: "uuid", type: "string" },
25999
+ type: "array"
26000
+ },
26001
+ created_at: {
26002
+ description: "Date and time at which the requested access method was added to this access grant.",
26003
+ format: "date-time",
26004
+ type: "string"
26005
+ },
26006
+ display_name: {
26007
+ description: "Display name of the access method.",
26008
+ type: "string"
26009
+ },
26010
+ mode: {
26011
+ description: "Access method mode. Supported values: `code`, `card`, `mobile_key`.",
26012
+ enum: ["code", "card", "mobile_key"],
26013
+ type: "string"
26014
+ }
26015
+ },
26016
+ required: [
26017
+ "display_name",
26018
+ "mode",
26019
+ "created_at",
26020
+ "created_access_method_ids"
26021
+ ],
26022
+ type: "object"
26023
+ },
26024
+ type: "array"
26025
+ },
26026
+ space_ids: {
26027
+ description: "IDs of the spaces to which access is being given.",
26028
+ items: { format: "uuid", type: "string" },
26029
+ type: "array"
26030
+ },
26031
+ user_identity_id: {
26032
+ description: "ID of user identity to which access is being granted.",
26033
+ format: "uuid",
26034
+ type: "string"
26035
+ },
26036
+ workspace_id: {
26037
+ description: "Unique identifier for the Seam workspace associated with the access grant.",
26038
+ format: "uuid",
26039
+ type: "string"
26040
+ }
26041
+ },
26042
+ required: [
26043
+ "workspace_id",
26044
+ "access_grant_id",
26045
+ "user_identity_id",
26046
+ "location_ids",
26047
+ "space_ids",
26048
+ "requested_access_methods",
26049
+ "access_method_ids",
26050
+ "display_name",
26051
+ "created_at"
26052
+ ],
26053
+ type: "object",
26054
+ "x-draft": "Early access.",
26055
+ "x-route-path": "/access_grants"
26056
+ },
26057
+ ok: { type: "boolean" }
25799
26058
  },
25800
- user_identity_id: {
25801
- description: "ID of the desired user identity that you want to add to an access group. You can only provide one of acs_user_id or user_identity_id. If the ACS system contains an ACS user with the same `email_address` or `phone_number` as the user identity that you specify, they are linked, and the access group membership belongs to the ACS user. If the ACS system does not have a corresponding ACS user, one is created.",
26059
+ required: ["access_grant", "ok"],
26060
+ type: "object"
26061
+ }
26062
+ }
26063
+ },
26064
+ description: "OK"
26065
+ },
26066
+ 400: { description: "Bad Request" },
26067
+ 401: { description: "Unauthorized" }
26068
+ },
26069
+ security: [
26070
+ { pat_with_workspace: [] },
26071
+ { console_session_with_workspace: [] },
26072
+ { api_key: [] },
26073
+ { client_session_with_customer: [] }
26074
+ ],
26075
+ summary: "/access_grants/create",
26076
+ tags: [],
26077
+ "x-fern-sdk-group-name": ["access_grants"],
26078
+ "x-fern-sdk-method-name": "create",
26079
+ "x-fern-sdk-return-value": "access_grant",
26080
+ "x-response-key": "access_grant",
26081
+ "x-title": "Create an Access Grant",
26082
+ "x-undocumented": "Unreleased."
26083
+ }
26084
+ },
26085
+ "/access_grants/delete": {
26086
+ post: {
26087
+ description: "Delete an access grant.",
26088
+ operationId: "accessGrantsDeletePost",
26089
+ requestBody: {
26090
+ content: {
26091
+ "application/json": {
26092
+ schema: {
26093
+ properties: {
26094
+ access_grant_id: {
26095
+ description: "ID of access grant to delete.",
25802
26096
  format: "uuid",
25803
26097
  type: "string"
25804
26098
  }
25805
26099
  },
25806
- required: ["acs_access_group_id"],
26100
+ required: ["access_grant_id"],
25807
26101
  type: "object"
25808
26102
  }
25809
26103
  }
@@ -25828,40 +26122,34 @@ var openapi_default = {
25828
26122
  security: [
25829
26123
  { pat_with_workspace: [] },
25830
26124
  { console_session_with_workspace: [] },
25831
- { api_key: [] }
26125
+ { api_key: [] },
26126
+ { client_session_with_customer: [] }
25832
26127
  ],
25833
- summary: "/acs/access_groups/add_user",
25834
- tags: ["/acs"],
25835
- "x-fern-sdk-group-name": ["acs", "access_groups"],
25836
- "x-fern-sdk-method-name": "add_user",
26128
+ summary: "/access_grants/delete",
26129
+ tags: [],
26130
+ "x-fern-sdk-group-name": ["access_grants"],
26131
+ "x-fern-sdk-method-name": "delete",
25837
26132
  "x-response-key": null,
25838
- "x-title": "Add an ACS User to an Access Group"
25839
- },
25840
- put: {
25841
- description: "Adds a specified [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) to a specified [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups).",
25842
- operationId: "acsAccessGroupsAddUserPut",
26133
+ "x-title": "Delete an Access Grant",
26134
+ "x-undocumented": "Unreleased."
26135
+ }
26136
+ },
26137
+ "/access_grants/get": {
26138
+ post: {
26139
+ description: "Get an access grant.",
26140
+ operationId: "accessGrantsGetPost",
25843
26141
  requestBody: {
25844
26142
  content: {
25845
26143
  "application/json": {
25846
26144
  schema: {
25847
26145
  properties: {
25848
- acs_access_group_id: {
25849
- description: "ID of the access group to which you want to add an access system user.",
25850
- format: "uuid",
25851
- type: "string"
25852
- },
25853
- acs_user_id: {
25854
- description: "ID of the access system user that you want to add to an access group. You can only provide one of acs_user_id or user_identity_id.",
25855
- format: "uuid",
25856
- type: "string"
25857
- },
25858
- user_identity_id: {
25859
- description: "ID of the desired user identity that you want to add to an access group. You can only provide one of acs_user_id or user_identity_id. If the ACS system contains an ACS user with the same `email_address` or `phone_number` as the user identity that you specify, they are linked, and the access group membership belongs to the ACS user. If the ACS system does not have a corresponding ACS user, one is created.",
26146
+ access_grant_id: {
26147
+ description: "ID of access grant to get.",
25860
26148
  format: "uuid",
25861
26149
  type: "string"
25862
26150
  }
25863
26151
  },
25864
- required: ["acs_access_group_id"],
26152
+ required: ["access_grant_id"],
25865
26153
  type: "object"
25866
26154
  }
25867
26155
  }
@@ -25872,8 +26160,102 @@ var openapi_default = {
25872
26160
  content: {
25873
26161
  "application/json": {
25874
26162
  schema: {
25875
- properties: { ok: { type: "boolean" } },
25876
- required: ["ok"],
26163
+ properties: {
26164
+ access_grant: {
26165
+ properties: {
26166
+ access_grant_id: {
26167
+ description: "ID of the access grant.",
26168
+ format: "uuid",
26169
+ type: "string"
26170
+ },
26171
+ access_method_ids: {
26172
+ description: "IDs of the access methods that were created for this access grant.",
26173
+ items: { format: "uuid", type: "string" },
26174
+ type: "array"
26175
+ },
26176
+ created_at: {
26177
+ description: "Date and time at which the access grant was created.",
26178
+ format: "date-time",
26179
+ type: "string"
26180
+ },
26181
+ display_name: {
26182
+ description: "Display name of the access grant.",
26183
+ type: "string"
26184
+ },
26185
+ location_ids: {
26186
+ deprecated: true,
26187
+ items: { format: "uuid", type: "string" },
26188
+ type: "array",
26189
+ "x-deprecated": "Use `space_ids`."
26190
+ },
26191
+ requested_access_methods: {
26192
+ description: "Access methods that the user requested for this access grant.",
26193
+ items: {
26194
+ properties: {
26195
+ created_access_method_ids: {
26196
+ description: "IDs of the access methods that were created for this requested access method.",
26197
+ items: { format: "uuid", type: "string" },
26198
+ type: "array"
26199
+ },
26200
+ created_at: {
26201
+ description: "Date and time at which the requested access method was added to this access grant.",
26202
+ format: "date-time",
26203
+ type: "string"
26204
+ },
26205
+ display_name: {
26206
+ description: "Display name of the access method.",
26207
+ type: "string"
26208
+ },
26209
+ mode: {
26210
+ description: "Access method mode. Supported values: `code`, `card`, `mobile_key`.",
26211
+ enum: ["code", "card", "mobile_key"],
26212
+ type: "string"
26213
+ }
26214
+ },
26215
+ required: [
26216
+ "display_name",
26217
+ "mode",
26218
+ "created_at",
26219
+ "created_access_method_ids"
26220
+ ],
26221
+ type: "object"
26222
+ },
26223
+ type: "array"
26224
+ },
26225
+ space_ids: {
26226
+ description: "IDs of the spaces to which access is being given.",
26227
+ items: { format: "uuid", type: "string" },
26228
+ type: "array"
26229
+ },
26230
+ user_identity_id: {
26231
+ description: "ID of user identity to which access is being granted.",
26232
+ format: "uuid",
26233
+ type: "string"
26234
+ },
26235
+ workspace_id: {
26236
+ description: "Unique identifier for the Seam workspace associated with the access grant.",
26237
+ format: "uuid",
26238
+ type: "string"
26239
+ }
26240
+ },
26241
+ required: [
26242
+ "workspace_id",
26243
+ "access_grant_id",
26244
+ "user_identity_id",
26245
+ "location_ids",
26246
+ "space_ids",
26247
+ "requested_access_methods",
26248
+ "access_method_ids",
26249
+ "display_name",
26250
+ "created_at"
26251
+ ],
26252
+ type: "object",
26253
+ "x-draft": "Early access.",
26254
+ "x-route-path": "/access_grants"
26255
+ },
26256
+ ok: { type: "boolean" }
26257
+ },
26258
+ required: ["access_grant", "ok"],
25877
26259
  type: "object"
25878
26260
  }
25879
26261
  }
@@ -25886,31 +26268,55 @@ var openapi_default = {
25886
26268
  security: [
25887
26269
  { pat_with_workspace: [] },
25888
26270
  { console_session_with_workspace: [] },
25889
- { api_key: [] }
26271
+ { api_key: [] },
26272
+ { client_session_with_customer: [] }
25890
26273
  ],
25891
- summary: "/acs/access_groups/add_user",
25892
- tags: ["/acs"],
25893
- "x-fern-ignore": true,
25894
- "x-response-key": null,
25895
- "x-title": "Add an ACS User to an Access Group"
26274
+ summary: "/access_grants/get",
26275
+ tags: [],
26276
+ "x-fern-sdk-group-name": ["access_grants"],
26277
+ "x-fern-sdk-method-name": "get",
26278
+ "x-fern-sdk-return-value": "access_grant",
26279
+ "x-response-key": "access_grant",
26280
+ "x-title": "Get an Access Grant",
26281
+ "x-undocumented": "Unreleased."
25896
26282
  }
25897
26283
  },
25898
- "/acs/access_groups/get": {
26284
+ "/access_grants/list": {
25899
26285
  post: {
25900
- description: "Returns a specified [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups).",
25901
- operationId: "acsAccessGroupsGetPost",
26286
+ description: "Get an access grant.",
26287
+ operationId: "accessGrantsListPost",
25902
26288
  requestBody: {
25903
26289
  content: {
25904
26290
  "application/json": {
25905
26291
  schema: {
25906
26292
  properties: {
25907
- acs_access_group_id: {
25908
- description: "ID of the access group that you want to get.",
26293
+ acs_entrance_id: {
26294
+ description: "ID of entrance to filter list of access grants by.",
26295
+ format: "uuid",
26296
+ type: "string"
26297
+ },
26298
+ acs_system_id: {
26299
+ description: "ID of system to filter list of access grants by.",
26300
+ format: "uuid",
26301
+ type: "string"
26302
+ },
26303
+ location_id: {
26304
+ deprecated: true,
26305
+ format: "uuid",
26306
+ type: "string",
26307
+ "x-deprecated": "Use `space_id`."
26308
+ },
26309
+ space_id: {
26310
+ description: "ID of space to filter list of access grants by.",
26311
+ format: "uuid",
26312
+ type: "string"
26313
+ },
26314
+ user_identity_id: {
26315
+ description: "ID of user identity to filter list of access grants by.",
25909
26316
  format: "uuid",
25910
26317
  type: "string"
25911
26318
  }
25912
26319
  },
25913
- required: ["acs_access_group_id"],
25914
26320
  type: "object"
25915
26321
  }
25916
26322
  }
@@ -25922,12 +26328,104 @@ var openapi_default = {
25922
26328
  "application/json": {
25923
26329
  schema: {
25924
26330
  properties: {
25925
- acs_access_group: {
25926
- $ref: "#/components/schemas/acs_access_group"
26331
+ access_grants: {
26332
+ items: {
26333
+ properties: {
26334
+ access_grant_id: {
26335
+ description: "ID of the access grant.",
26336
+ format: "uuid",
26337
+ type: "string"
26338
+ },
26339
+ access_method_ids: {
26340
+ description: "IDs of the access methods that were created for this access grant.",
26341
+ items: { format: "uuid", type: "string" },
26342
+ type: "array"
26343
+ },
26344
+ created_at: {
26345
+ description: "Date and time at which the access grant was created.",
26346
+ format: "date-time",
26347
+ type: "string"
26348
+ },
26349
+ display_name: {
26350
+ description: "Display name of the access grant.",
26351
+ type: "string"
26352
+ },
26353
+ location_ids: {
26354
+ deprecated: true,
26355
+ items: { format: "uuid", type: "string" },
26356
+ type: "array",
26357
+ "x-deprecated": "Use `space_ids`."
26358
+ },
26359
+ requested_access_methods: {
26360
+ description: "Access methods that the user requested for this access grant.",
26361
+ items: {
26362
+ properties: {
26363
+ created_access_method_ids: {
26364
+ description: "IDs of the access methods that were created for this requested access method.",
26365
+ items: { format: "uuid", type: "string" },
26366
+ type: "array"
26367
+ },
26368
+ created_at: {
26369
+ description: "Date and time at which the requested access method was added to this access grant.",
26370
+ format: "date-time",
26371
+ type: "string"
26372
+ },
26373
+ display_name: {
26374
+ description: "Display name of the access method.",
26375
+ type: "string"
26376
+ },
26377
+ mode: {
26378
+ description: "Access method mode. Supported values: `code`, `card`, `mobile_key`.",
26379
+ enum: ["code", "card", "mobile_key"],
26380
+ type: "string"
26381
+ }
26382
+ },
26383
+ required: [
26384
+ "display_name",
26385
+ "mode",
26386
+ "created_at",
26387
+ "created_access_method_ids"
26388
+ ],
26389
+ type: "object"
26390
+ },
26391
+ type: "array"
26392
+ },
26393
+ space_ids: {
26394
+ description: "IDs of the spaces to which access is being given.",
26395
+ items: { format: "uuid", type: "string" },
26396
+ type: "array"
26397
+ },
26398
+ user_identity_id: {
26399
+ description: "ID of user identity to which access is being granted.",
26400
+ format: "uuid",
26401
+ type: "string"
26402
+ },
26403
+ workspace_id: {
26404
+ description: "Unique identifier for the Seam workspace associated with the access grant.",
26405
+ format: "uuid",
26406
+ type: "string"
26407
+ }
26408
+ },
26409
+ required: [
26410
+ "workspace_id",
26411
+ "access_grant_id",
26412
+ "user_identity_id",
26413
+ "location_ids",
26414
+ "space_ids",
26415
+ "requested_access_methods",
26416
+ "access_method_ids",
26417
+ "display_name",
26418
+ "created_at"
26419
+ ],
26420
+ type: "object",
26421
+ "x-draft": "Early access.",
26422
+ "x-route-path": "/access_grants"
26423
+ },
26424
+ type: "array"
25927
26425
  },
25928
26426
  ok: { type: "boolean" }
25929
26427
  },
25930
- required: ["acs_access_group", "ok"],
26428
+ required: ["access_grants", "ok"],
25931
26429
  type: "object"
25932
26430
  }
25933
26431
  }
@@ -25940,42 +26438,35 @@ var openapi_default = {
25940
26438
  security: [
25941
26439
  { pat_with_workspace: [] },
25942
26440
  { console_session_with_workspace: [] },
25943
- { api_key: [] }
26441
+ { api_key: [] },
26442
+ { client_session_with_customer: [] }
25944
26443
  ],
25945
- summary: "/acs/access_groups/get",
25946
- tags: ["/acs"],
25947
- "x-fern-sdk-group-name": ["acs", "access_groups"],
25948
- "x-fern-sdk-method-name": "get",
25949
- "x-fern-sdk-return-value": "acs_access_group",
25950
- "x-response-key": "acs_access_group",
25951
- "x-title": "Get an Access Group"
26444
+ summary: "/access_grants/list",
26445
+ tags: [],
26446
+ "x-fern-sdk-group-name": ["access_grants"],
26447
+ "x-fern-sdk-method-name": "list",
26448
+ "x-fern-sdk-return-value": "access_grants",
26449
+ "x-response-key": "access_grants",
26450
+ "x-title": "List Access Grants",
26451
+ "x-undocumented": "Unreleased."
25952
26452
  }
25953
26453
  },
25954
- "/acs/access_groups/list": {
26454
+ "/access_methods/delete": {
25955
26455
  post: {
25956
- description: "Returns a list of all [access groups](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups).",
25957
- operationId: "acsAccessGroupsListPost",
26456
+ description: "Delete an access method.",
26457
+ operationId: "accessMethodsDeletePost",
25958
26458
  requestBody: {
25959
26459
  content: {
25960
26460
  "application/json": {
25961
26461
  schema: {
25962
26462
  properties: {
25963
- acs_system_id: {
25964
- description: "ID of the access system for which you want to retrieve all access groups.",
25965
- format: "uuid",
25966
- type: "string"
25967
- },
25968
- acs_user_id: {
25969
- description: "ID of the access system user for which you want to retrieve all access groups.",
25970
- format: "uuid",
25971
- type: "string"
25972
- },
25973
- user_identity_id: {
25974
- description: "ID of the user identity for which you want to retrieve all access groups.",
26463
+ access_method_id: {
26464
+ description: "ID of access method to get.",
25975
26465
  format: "uuid",
25976
26466
  type: "string"
25977
26467
  }
25978
26468
  },
26469
+ required: ["access_method_id"],
25979
26470
  type: "object"
25980
26471
  }
25981
26472
  }
@@ -25986,14 +26477,8 @@ var openapi_default = {
25986
26477
  content: {
25987
26478
  "application/json": {
25988
26479
  schema: {
25989
- properties: {
25990
- acs_access_groups: {
25991
- items: { $ref: "#/components/schemas/acs_access_group" },
25992
- type: "array"
25993
- },
25994
- ok: { type: "boolean" }
25995
- },
25996
- required: ["acs_access_groups", "ok"],
26480
+ properties: { ok: { type: "boolean" } },
26481
+ required: ["ok"],
25997
26482
  type: "object"
25998
26483
  }
25999
26484
  }
@@ -26008,31 +26493,31 @@ var openapi_default = {
26008
26493
  { console_session_with_workspace: [] },
26009
26494
  { api_key: [] }
26010
26495
  ],
26011
- summary: "/acs/access_groups/list",
26012
- tags: ["/acs"],
26013
- "x-fern-sdk-group-name": ["acs", "access_groups"],
26014
- "x-fern-sdk-method-name": "list",
26015
- "x-fern-sdk-return-value": "acs_access_groups",
26016
- "x-response-key": "acs_access_groups",
26017
- "x-title": "List Access Groups"
26496
+ summary: "/access_methods/delete",
26497
+ tags: [],
26498
+ "x-fern-sdk-group-name": ["access_methods"],
26499
+ "x-fern-sdk-method-name": "delete",
26500
+ "x-response-key": null,
26501
+ "x-title": "Delete an Access Method",
26502
+ "x-undocumented": "Unreleased."
26018
26503
  }
26019
26504
  },
26020
- "/acs/access_groups/list_accessible_entrances": {
26505
+ "/access_methods/get": {
26021
26506
  post: {
26022
- description: "Returns a list of all accessible entrances for a specified [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups).",
26023
- operationId: "acsAccessGroupsListAccessibleEntrancesPost",
26507
+ description: "Get an access method.",
26508
+ operationId: "accessMethodsGetPost",
26024
26509
  requestBody: {
26025
26510
  content: {
26026
26511
  "application/json": {
26027
26512
  schema: {
26028
26513
  properties: {
26029
- acs_access_group_id: {
26030
- description: "ID of the access group for which you want to retrieve all accessible entrances.",
26514
+ access_method_id: {
26515
+ description: "ID of access method to get.",
26031
26516
  format: "uuid",
26032
26517
  type: "string"
26033
26518
  }
26034
26519
  },
26035
- required: ["acs_access_group_id"],
26520
+ required: ["access_method_id"],
26036
26521
  type: "object"
26037
26522
  }
26038
26523
  }
@@ -26044,13 +26529,60 @@ var openapi_default = {
26044
26529
  "application/json": {
26045
26530
  schema: {
26046
26531
  properties: {
26047
- acs_entrances: {
26048
- items: { $ref: "#/components/schemas/acs_entrance" },
26049
- type: "array"
26532
+ access_method: {
26533
+ properties: {
26534
+ access_method_id: {
26535
+ description: "ID of the access method.",
26536
+ format: "uuid",
26537
+ type: "string"
26538
+ },
26539
+ created_at: {
26540
+ description: "Date and time at which the access method was created.",
26541
+ format: "date-time",
26542
+ type: "string"
26543
+ },
26544
+ display_name: {
26545
+ description: "Display name of the access method.",
26546
+ type: "string"
26547
+ },
26548
+ instant_key_url: {
26549
+ description: "URL of instant key for mobile key access methods.",
26550
+ type: "string"
26551
+ },
26552
+ is_card_encoding_required: {
26553
+ description: "Whether card encoding is required for plastic card access methods.",
26554
+ type: "boolean"
26555
+ },
26556
+ issued_at: {
26557
+ description: "Date and time at which the access method was issued.",
26558
+ format: "date-time",
26559
+ type: "string"
26560
+ },
26561
+ mode: {
26562
+ description: "Access method mode. Supported values: `code`, `card`, `mobile_key`.",
26563
+ enum: ["code", "card", "mobile_key"],
26564
+ type: "string"
26565
+ },
26566
+ workspace_id: {
26567
+ description: "Unique identifier for the Seam workspace associated with the access grant.",
26568
+ format: "uuid",
26569
+ type: "string"
26570
+ }
26571
+ },
26572
+ required: [
26573
+ "workspace_id",
26574
+ "access_method_id",
26575
+ "display_name",
26576
+ "mode",
26577
+ "created_at"
26578
+ ],
26579
+ type: "object",
26580
+ "x-draft": "Early access.",
26581
+ "x-route-path": "/access_methods"
26050
26582
  },
26051
26583
  ok: { type: "boolean" }
26052
26584
  },
26053
- required: ["acs_entrances", "ok"],
26585
+ required: ["access_method", "ok"],
26054
26586
  type: "object"
26055
26587
  }
26056
26588
  }
@@ -26061,35 +26593,36 @@ var openapi_default = {
26061
26593
  401: { description: "Unauthorized" }
26062
26594
  },
26063
26595
  security: [
26064
- { api_key: [] },
26065
26596
  { pat_with_workspace: [] },
26066
- { console_session_with_workspace: [] }
26597
+ { console_session_with_workspace: [] },
26598
+ { api_key: [] }
26067
26599
  ],
26068
- summary: "/acs/access_groups/list_accessible_entrances",
26069
- tags: ["/acs"],
26070
- "x-fern-sdk-group-name": ["acs", "access_groups"],
26071
- "x-fern-sdk-method-name": "list_accessible_entrances",
26072
- "x-fern-sdk-return-value": "acs_entrances",
26073
- "x-response-key": "acs_entrances",
26074
- "x-title": "List Entrances Accessible to an Access Group"
26600
+ summary: "/access_methods/get",
26601
+ tags: [],
26602
+ "x-fern-sdk-group-name": ["access_methods"],
26603
+ "x-fern-sdk-method-name": "get",
26604
+ "x-fern-sdk-return-value": "access_method",
26605
+ "x-response-key": "access_method",
26606
+ "x-title": "Get an Access Method",
26607
+ "x-undocumented": "Unreleased."
26075
26608
  }
26076
26609
  },
26077
- "/acs/access_groups/list_users": {
26610
+ "/access_methods/list": {
26078
26611
  post: {
26079
- description: "Returns a list of all [access system users](https://docs.seam.co/latest/capability-guides/access-systems/user-management) in an [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups).",
26080
- operationId: "acsAccessGroupsListUsersPost",
26612
+ description: "List all access methods, usually filtered by access grant.",
26613
+ operationId: "accessMethodsListPost",
26081
26614
  requestBody: {
26082
26615
  content: {
26083
26616
  "application/json": {
26084
26617
  schema: {
26085
26618
  properties: {
26086
- acs_access_group_id: {
26087
- description: "ID of the access group for which you want to retrieve all access system users.",
26619
+ access_grant_id: {
26620
+ description: "ID of access grant to list access methods for.",
26088
26621
  format: "uuid",
26089
26622
  type: "string"
26090
26623
  }
26091
26624
  },
26092
- required: ["acs_access_group_id"],
26625
+ required: ["access_grant_id"],
26093
26626
  type: "object"
26094
26627
  }
26095
26628
  }
@@ -26101,13 +26634,63 @@ var openapi_default = {
26101
26634
  "application/json": {
26102
26635
  schema: {
26103
26636
  properties: {
26104
- acs_users: {
26105
- items: { $ref: "#/components/schemas/acs_user" },
26637
+ access_methods: {
26638
+ items: {
26639
+ properties: {
26640
+ access_method_id: {
26641
+ description: "ID of the access method.",
26642
+ format: "uuid",
26643
+ type: "string"
26644
+ },
26645
+ created_at: {
26646
+ description: "Date and time at which the access method was created.",
26647
+ format: "date-time",
26648
+ type: "string"
26649
+ },
26650
+ display_name: {
26651
+ description: "Display name of the access method.",
26652
+ type: "string"
26653
+ },
26654
+ instant_key_url: {
26655
+ description: "URL of instant key for mobile key access methods.",
26656
+ type: "string"
26657
+ },
26658
+ is_card_encoding_required: {
26659
+ description: "Whether card encoding is required for plastic card access methods.",
26660
+ type: "boolean"
26661
+ },
26662
+ issued_at: {
26663
+ description: "Date and time at which the access method was issued.",
26664
+ format: "date-time",
26665
+ type: "string"
26666
+ },
26667
+ mode: {
26668
+ description: "Access method mode. Supported values: `code`, `card`, `mobile_key`.",
26669
+ enum: ["code", "card", "mobile_key"],
26670
+ type: "string"
26671
+ },
26672
+ workspace_id: {
26673
+ description: "Unique identifier for the Seam workspace associated with the access grant.",
26674
+ format: "uuid",
26675
+ type: "string"
26676
+ }
26677
+ },
26678
+ required: [
26679
+ "workspace_id",
26680
+ "access_method_id",
26681
+ "display_name",
26682
+ "mode",
26683
+ "created_at"
26684
+ ],
26685
+ type: "object",
26686
+ "x-draft": "Early access.",
26687
+ "x-route-path": "/access_methods"
26688
+ },
26106
26689
  type: "array"
26107
26690
  },
26108
26691
  ok: { type: "boolean" }
26109
26692
  },
26110
- required: ["acs_users", "ok"],
26693
+ required: ["access_methods", "ok"],
26111
26694
  type: "object"
26112
26695
  }
26113
26696
  }
@@ -26122,36 +26705,37 @@ var openapi_default = {
26122
26705
  { console_session_with_workspace: [] },
26123
26706
  { api_key: [] }
26124
26707
  ],
26125
- summary: "/acs/access_groups/list_users",
26126
- tags: ["/acs"],
26127
- "x-fern-sdk-group-name": ["acs", "access_groups"],
26128
- "x-fern-sdk-method-name": "list_users",
26129
- "x-fern-sdk-return-value": "acs_users",
26130
- "x-response-key": "acs_users",
26131
- "x-title": "List ACS Users in an Access Group"
26708
+ summary: "/access_methods/list",
26709
+ tags: [],
26710
+ "x-fern-sdk-group-name": ["access_methods"],
26711
+ "x-fern-sdk-method-name": "list",
26712
+ "x-fern-sdk-return-value": "access_methods",
26713
+ "x-response-key": "access_methods",
26714
+ "x-title": "List Access Methods",
26715
+ "x-undocumented": "Unreleased."
26132
26716
  }
26133
26717
  },
26134
- "/acs/access_groups/remove_user": {
26718
+ "/acs/access_groups/add_user": {
26135
26719
  post: {
26136
- description: "Removes a specified [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) from a specified [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups).",
26137
- operationId: "acsAccessGroupsRemoveUserPost",
26720
+ description: "Adds a specified [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) to a specified [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups).",
26721
+ operationId: "acsAccessGroupsAddUserPost",
26138
26722
  requestBody: {
26139
26723
  content: {
26140
26724
  "application/json": {
26141
26725
  schema: {
26142
26726
  properties: {
26143
26727
  acs_access_group_id: {
26144
- description: "ID of the access group from which you want to remove an access system user.",
26728
+ description: "ID of the access group to which you want to add an access system user.",
26145
26729
  format: "uuid",
26146
26730
  type: "string"
26147
26731
  },
26148
26732
  acs_user_id: {
26149
- description: "ID of the access system user that you want to remove from an access group.",
26733
+ description: "ID of the access system user that you want to add to an access group. You can only provide one of acs_user_id or user_identity_id.",
26150
26734
  format: "uuid",
26151
26735
  type: "string"
26152
26736
  },
26153
26737
  user_identity_id: {
26154
- description: "ID of the user identity associated with the user that you want to remove from an access group.",
26738
+ description: "ID of the desired user identity that you want to add to an access group. You can only provide one of acs_user_id or user_identity_id. If the ACS system contains an ACS user with the same `email_address` or `phone_number` as the user identity that you specify, they are linked, and the access group membership belongs to the ACS user. If the ACS system does not have a corresponding ACS user, one is created.",
26155
26739
  format: "uuid",
26156
26740
  type: "string"
26157
26741
  }
@@ -26183,36 +26767,389 @@ var openapi_default = {
26183
26767
  { console_session_with_workspace: [] },
26184
26768
  { api_key: [] }
26185
26769
  ],
26186
- summary: "/acs/access_groups/remove_user",
26770
+ summary: "/acs/access_groups/add_user",
26187
26771
  tags: ["/acs"],
26188
26772
  "x-fern-sdk-group-name": ["acs", "access_groups"],
26189
- "x-fern-sdk-method-name": "remove_user",
26773
+ "x-fern-sdk-method-name": "add_user",
26190
26774
  "x-response-key": null,
26191
- "x-title": "Remove an ACS User from an Access Group"
26192
- }
26193
- },
26194
- "/acs/access_groups/unmanaged/get": {
26195
- post: {
26196
- description: "Returns a specified unmanaged [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups).",
26197
- operationId: "acsAccessGroupsUnmanagedGetPost",
26775
+ "x-title": "Add an ACS User to an Access Group"
26776
+ },
26777
+ put: {
26778
+ description: "Adds a specified [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) to a specified [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups).",
26779
+ operationId: "acsAccessGroupsAddUserPut",
26198
26780
  requestBody: {
26199
26781
  content: {
26200
26782
  "application/json": {
26201
26783
  schema: {
26202
26784
  properties: {
26203
26785
  acs_access_group_id: {
26204
- description: "ID of the unmanaged access group that you want to get.",
26786
+ description: "ID of the access group to which you want to add an access system user.",
26205
26787
  format: "uuid",
26206
26788
  type: "string"
26207
- }
26208
- },
26209
- required: ["acs_access_group_id"],
26210
- type: "object"
26211
- }
26212
- }
26213
- }
26214
- },
26215
- responses: {
26789
+ },
26790
+ acs_user_id: {
26791
+ description: "ID of the access system user that you want to add to an access group. You can only provide one of acs_user_id or user_identity_id.",
26792
+ format: "uuid",
26793
+ type: "string"
26794
+ },
26795
+ user_identity_id: {
26796
+ description: "ID of the desired user identity that you want to add to an access group. You can only provide one of acs_user_id or user_identity_id. If the ACS system contains an ACS user with the same `email_address` or `phone_number` as the user identity that you specify, they are linked, and the access group membership belongs to the ACS user. If the ACS system does not have a corresponding ACS user, one is created.",
26797
+ format: "uuid",
26798
+ type: "string"
26799
+ }
26800
+ },
26801
+ required: ["acs_access_group_id"],
26802
+ type: "object"
26803
+ }
26804
+ }
26805
+ }
26806
+ },
26807
+ responses: {
26808
+ 200: {
26809
+ content: {
26810
+ "application/json": {
26811
+ schema: {
26812
+ properties: { ok: { type: "boolean" } },
26813
+ required: ["ok"],
26814
+ type: "object"
26815
+ }
26816
+ }
26817
+ },
26818
+ description: "OK"
26819
+ },
26820
+ 400: { description: "Bad Request" },
26821
+ 401: { description: "Unauthorized" }
26822
+ },
26823
+ security: [
26824
+ { pat_with_workspace: [] },
26825
+ { console_session_with_workspace: [] },
26826
+ { api_key: [] }
26827
+ ],
26828
+ summary: "/acs/access_groups/add_user",
26829
+ tags: ["/acs"],
26830
+ "x-fern-ignore": true,
26831
+ "x-response-key": null,
26832
+ "x-title": "Add an ACS User to an Access Group"
26833
+ }
26834
+ },
26835
+ "/acs/access_groups/get": {
26836
+ post: {
26837
+ description: "Returns a specified [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups).",
26838
+ operationId: "acsAccessGroupsGetPost",
26839
+ requestBody: {
26840
+ content: {
26841
+ "application/json": {
26842
+ schema: {
26843
+ properties: {
26844
+ acs_access_group_id: {
26845
+ description: "ID of the access group that you want to get.",
26846
+ format: "uuid",
26847
+ type: "string"
26848
+ }
26849
+ },
26850
+ required: ["acs_access_group_id"],
26851
+ type: "object"
26852
+ }
26853
+ }
26854
+ }
26855
+ },
26856
+ responses: {
26857
+ 200: {
26858
+ content: {
26859
+ "application/json": {
26860
+ schema: {
26861
+ properties: {
26862
+ acs_access_group: {
26863
+ $ref: "#/components/schemas/acs_access_group"
26864
+ },
26865
+ ok: { type: "boolean" }
26866
+ },
26867
+ required: ["acs_access_group", "ok"],
26868
+ type: "object"
26869
+ }
26870
+ }
26871
+ },
26872
+ description: "OK"
26873
+ },
26874
+ 400: { description: "Bad Request" },
26875
+ 401: { description: "Unauthorized" }
26876
+ },
26877
+ security: [
26878
+ { pat_with_workspace: [] },
26879
+ { console_session_with_workspace: [] },
26880
+ { api_key: [] }
26881
+ ],
26882
+ summary: "/acs/access_groups/get",
26883
+ tags: ["/acs"],
26884
+ "x-fern-sdk-group-name": ["acs", "access_groups"],
26885
+ "x-fern-sdk-method-name": "get",
26886
+ "x-fern-sdk-return-value": "acs_access_group",
26887
+ "x-response-key": "acs_access_group",
26888
+ "x-title": "Get an Access Group"
26889
+ }
26890
+ },
26891
+ "/acs/access_groups/list": {
26892
+ post: {
26893
+ description: "Returns a list of all [access groups](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups).",
26894
+ operationId: "acsAccessGroupsListPost",
26895
+ requestBody: {
26896
+ content: {
26897
+ "application/json": {
26898
+ schema: {
26899
+ properties: {
26900
+ acs_system_id: {
26901
+ description: "ID of the access system for which you want to retrieve all access groups.",
26902
+ format: "uuid",
26903
+ type: "string"
26904
+ },
26905
+ acs_user_id: {
26906
+ description: "ID of the access system user for which you want to retrieve all access groups.",
26907
+ format: "uuid",
26908
+ type: "string"
26909
+ },
26910
+ user_identity_id: {
26911
+ description: "ID of the user identity for which you want to retrieve all access groups.",
26912
+ format: "uuid",
26913
+ type: "string"
26914
+ }
26915
+ },
26916
+ type: "object"
26917
+ }
26918
+ }
26919
+ }
26920
+ },
26921
+ responses: {
26922
+ 200: {
26923
+ content: {
26924
+ "application/json": {
26925
+ schema: {
26926
+ properties: {
26927
+ acs_access_groups: {
26928
+ items: { $ref: "#/components/schemas/acs_access_group" },
26929
+ type: "array"
26930
+ },
26931
+ ok: { type: "boolean" }
26932
+ },
26933
+ required: ["acs_access_groups", "ok"],
26934
+ type: "object"
26935
+ }
26936
+ }
26937
+ },
26938
+ description: "OK"
26939
+ },
26940
+ 400: { description: "Bad Request" },
26941
+ 401: { description: "Unauthorized" }
26942
+ },
26943
+ security: [
26944
+ { pat_with_workspace: [] },
26945
+ { console_session_with_workspace: [] },
26946
+ { api_key: [] }
26947
+ ],
26948
+ summary: "/acs/access_groups/list",
26949
+ tags: ["/acs"],
26950
+ "x-fern-sdk-group-name": ["acs", "access_groups"],
26951
+ "x-fern-sdk-method-name": "list",
26952
+ "x-fern-sdk-return-value": "acs_access_groups",
26953
+ "x-response-key": "acs_access_groups",
26954
+ "x-title": "List Access Groups"
26955
+ }
26956
+ },
26957
+ "/acs/access_groups/list_accessible_entrances": {
26958
+ post: {
26959
+ description: "Returns a list of all accessible entrances for a specified [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups).",
26960
+ operationId: "acsAccessGroupsListAccessibleEntrancesPost",
26961
+ requestBody: {
26962
+ content: {
26963
+ "application/json": {
26964
+ schema: {
26965
+ properties: {
26966
+ acs_access_group_id: {
26967
+ description: "ID of the access group for which you want to retrieve all accessible entrances.",
26968
+ format: "uuid",
26969
+ type: "string"
26970
+ }
26971
+ },
26972
+ required: ["acs_access_group_id"],
26973
+ type: "object"
26974
+ }
26975
+ }
26976
+ }
26977
+ },
26978
+ responses: {
26979
+ 200: {
26980
+ content: {
26981
+ "application/json": {
26982
+ schema: {
26983
+ properties: {
26984
+ acs_entrances: {
26985
+ items: { $ref: "#/components/schemas/acs_entrance" },
26986
+ type: "array"
26987
+ },
26988
+ ok: { type: "boolean" }
26989
+ },
26990
+ required: ["acs_entrances", "ok"],
26991
+ type: "object"
26992
+ }
26993
+ }
26994
+ },
26995
+ description: "OK"
26996
+ },
26997
+ 400: { description: "Bad Request" },
26998
+ 401: { description: "Unauthorized" }
26999
+ },
27000
+ security: [
27001
+ { api_key: [] },
27002
+ { pat_with_workspace: [] },
27003
+ { console_session_with_workspace: [] }
27004
+ ],
27005
+ summary: "/acs/access_groups/list_accessible_entrances",
27006
+ tags: ["/acs"],
27007
+ "x-fern-sdk-group-name": ["acs", "access_groups"],
27008
+ "x-fern-sdk-method-name": "list_accessible_entrances",
27009
+ "x-fern-sdk-return-value": "acs_entrances",
27010
+ "x-response-key": "acs_entrances",
27011
+ "x-title": "List Entrances Accessible to an Access Group"
27012
+ }
27013
+ },
27014
+ "/acs/access_groups/list_users": {
27015
+ post: {
27016
+ description: "Returns a list of all [access system users](https://docs.seam.co/latest/capability-guides/access-systems/user-management) in an [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups).",
27017
+ operationId: "acsAccessGroupsListUsersPost",
27018
+ requestBody: {
27019
+ content: {
27020
+ "application/json": {
27021
+ schema: {
27022
+ properties: {
27023
+ acs_access_group_id: {
27024
+ description: "ID of the access group for which you want to retrieve all access system users.",
27025
+ format: "uuid",
27026
+ type: "string"
27027
+ }
27028
+ },
27029
+ required: ["acs_access_group_id"],
27030
+ type: "object"
27031
+ }
27032
+ }
27033
+ }
27034
+ },
27035
+ responses: {
27036
+ 200: {
27037
+ content: {
27038
+ "application/json": {
27039
+ schema: {
27040
+ properties: {
27041
+ acs_users: {
27042
+ items: { $ref: "#/components/schemas/acs_user" },
27043
+ type: "array"
27044
+ },
27045
+ ok: { type: "boolean" }
27046
+ },
27047
+ required: ["acs_users", "ok"],
27048
+ type: "object"
27049
+ }
27050
+ }
27051
+ },
27052
+ description: "OK"
27053
+ },
27054
+ 400: { description: "Bad Request" },
27055
+ 401: { description: "Unauthorized" }
27056
+ },
27057
+ security: [
27058
+ { pat_with_workspace: [] },
27059
+ { console_session_with_workspace: [] },
27060
+ { api_key: [] }
27061
+ ],
27062
+ summary: "/acs/access_groups/list_users",
27063
+ tags: ["/acs"],
27064
+ "x-fern-sdk-group-name": ["acs", "access_groups"],
27065
+ "x-fern-sdk-method-name": "list_users",
27066
+ "x-fern-sdk-return-value": "acs_users",
27067
+ "x-response-key": "acs_users",
27068
+ "x-title": "List ACS Users in an Access Group"
27069
+ }
27070
+ },
27071
+ "/acs/access_groups/remove_user": {
27072
+ post: {
27073
+ description: "Removes a specified [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) from a specified [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups).",
27074
+ operationId: "acsAccessGroupsRemoveUserPost",
27075
+ requestBody: {
27076
+ content: {
27077
+ "application/json": {
27078
+ schema: {
27079
+ properties: {
27080
+ acs_access_group_id: {
27081
+ description: "ID of the access group from which you want to remove an access system user.",
27082
+ format: "uuid",
27083
+ type: "string"
27084
+ },
27085
+ acs_user_id: {
27086
+ description: "ID of the access system user that you want to remove from an access group.",
27087
+ format: "uuid",
27088
+ type: "string"
27089
+ },
27090
+ user_identity_id: {
27091
+ description: "ID of the user identity associated with the user that you want to remove from an access group.",
27092
+ format: "uuid",
27093
+ type: "string"
27094
+ }
27095
+ },
27096
+ required: ["acs_access_group_id"],
27097
+ type: "object"
27098
+ }
27099
+ }
27100
+ }
27101
+ },
27102
+ responses: {
27103
+ 200: {
27104
+ content: {
27105
+ "application/json": {
27106
+ schema: {
27107
+ properties: { ok: { type: "boolean" } },
27108
+ required: ["ok"],
27109
+ type: "object"
27110
+ }
27111
+ }
27112
+ },
27113
+ description: "OK"
27114
+ },
27115
+ 400: { description: "Bad Request" },
27116
+ 401: { description: "Unauthorized" }
27117
+ },
27118
+ security: [
27119
+ { pat_with_workspace: [] },
27120
+ { console_session_with_workspace: [] },
27121
+ { api_key: [] }
27122
+ ],
27123
+ summary: "/acs/access_groups/remove_user",
27124
+ tags: ["/acs"],
27125
+ "x-fern-sdk-group-name": ["acs", "access_groups"],
27126
+ "x-fern-sdk-method-name": "remove_user",
27127
+ "x-response-key": null,
27128
+ "x-title": "Remove an ACS User from an Access Group"
27129
+ }
27130
+ },
27131
+ "/acs/access_groups/unmanaged/get": {
27132
+ post: {
27133
+ description: "Returns a specified unmanaged [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups).",
27134
+ operationId: "acsAccessGroupsUnmanagedGetPost",
27135
+ requestBody: {
27136
+ content: {
27137
+ "application/json": {
27138
+ schema: {
27139
+ properties: {
27140
+ acs_access_group_id: {
27141
+ description: "ID of the unmanaged access group that you want to get.",
27142
+ format: "uuid",
27143
+ type: "string"
27144
+ }
27145
+ },
27146
+ required: ["acs_access_group_id"],
27147
+ type: "object"
27148
+ }
27149
+ }
27150
+ }
27151
+ },
27152
+ responses: {
26216
27153
  200: {
26217
27154
  content: {
26218
27155
  "application/json": {
@@ -28318,11 +29255,16 @@ var openapi_default = {
28318
29255
  type: "string"
28319
29256
  },
28320
29257
  location_id: {
28321
- description: "ID of the location for which you want to retrieve all entrances.",
29258
+ deprecated: true,
28322
29259
  format: "uuid",
28323
29260
  nullable: true,
28324
29261
  type: "string",
28325
- "x-undocumented": "Experimental locations."
29262
+ "x-deprecated": "Use `space_id`."
29263
+ },
29264
+ space_id: {
29265
+ description: "ID of the space for which you want to list entrances.",
29266
+ format: "uuid",
29267
+ type: "string"
28326
29268
  }
28327
29269
  },
28328
29270
  type: "object"
@@ -31530,12 +32472,17 @@ var openapi_default = {
31530
32472
  nullable: true,
31531
32473
  type: "string"
31532
32474
  },
32475
+ space_id: {
32476
+ description: "ID of the space for which you want to list devices.",
32477
+ format: "uuid",
32478
+ type: "string"
32479
+ },
31533
32480
  unstable_location_id: {
31534
- description: "ID of the location for which you want to list devices.",
32481
+ deprecated: true,
31535
32482
  format: "uuid",
31536
32483
  nullable: true,
31537
32484
  type: "string",
31538
- "x-undocumented": "Experimental locations."
32485
+ "x-deprecated": "Use `space_id`."
31539
32486
  },
31540
32487
  user_identifier_key: {
31541
32488
  description: "Your own internal user ID for the user for which you want to list devices.",
@@ -32121,12 +33068,17 @@ var openapi_default = {
32121
33068
  nullable: true,
32122
33069
  type: "string"
32123
33070
  },
33071
+ space_id: {
33072
+ description: "ID of the space for which you want to list devices.",
33073
+ format: "uuid",
33074
+ type: "string"
33075
+ },
32124
33076
  unstable_location_id: {
32125
- description: "ID of the location for which you want to list devices.",
33077
+ deprecated: true,
32126
33078
  format: "uuid",
32127
33079
  nullable: true,
32128
33080
  type: "string",
32129
- "x-undocumented": "Experimental locations."
33081
+ "x-deprecated": "Use `space_id`."
32130
33082
  },
32131
33083
  user_identifier_key: {
32132
33084
  description: "Your own internal user ID for the user for which you want to list devices.",
@@ -33089,12 +34041,17 @@ var openapi_default = {
33089
34041
  nullable: true,
33090
34042
  type: "string"
33091
34043
  },
34044
+ space_id: {
34045
+ description: "ID of the space for which you want to list devices.",
34046
+ format: "uuid",
34047
+ type: "string"
34048
+ },
33092
34049
  unstable_location_id: {
33093
- description: "ID of the location for which you want to list devices.",
34050
+ deprecated: true,
33094
34051
  format: "uuid",
33095
34052
  nullable: true,
33096
34053
  type: "string",
33097
- "x-undocumented": "Experimental locations."
34054
+ "x-deprecated": "Use `space_id`."
33098
34055
  },
33099
34056
  user_identifier_key: {
33100
34057
  description: "Your own internal user ID for the user for which you want to list devices.",
@@ -33413,7 +34370,22 @@ var openapi_default = {
33413
34370
  "application/json": {
33414
34371
  schema: {
33415
34372
  properties: {
33416
- network: { $ref: "#/components/schemas/network" },
34373
+ network: {
34374
+ properties: {
34375
+ created_at: { format: "date-time", type: "string" },
34376
+ display_name: { type: "string" },
34377
+ network_id: { format: "uuid", type: "string" },
34378
+ workspace_id: { format: "uuid", type: "string" }
34379
+ },
34380
+ required: [
34381
+ "network_id",
34382
+ "workspace_id",
34383
+ "display_name",
34384
+ "created_at"
34385
+ ],
34386
+ type: "object",
34387
+ "x-route-path": "/networks"
34388
+ },
33417
34389
  ok: { type: "boolean" }
33418
34390
  },
33419
34391
  required: ["network", "ok"],
@@ -33456,7 +34428,22 @@ var openapi_default = {
33456
34428
  schema: {
33457
34429
  properties: {
33458
34430
  networks: {
33459
- items: { $ref: "#/components/schemas/network" },
34431
+ items: {
34432
+ properties: {
34433
+ created_at: { format: "date-time", type: "string" },
34434
+ display_name: { type: "string" },
34435
+ network_id: { format: "uuid", type: "string" },
34436
+ workspace_id: { format: "uuid", type: "string" }
34437
+ },
34438
+ required: [
34439
+ "network_id",
34440
+ "workspace_id",
34441
+ "display_name",
34442
+ "created_at"
34443
+ ],
34444
+ type: "object",
34445
+ "x-route-path": "/networks"
34446
+ },
33460
34447
  type: "array"
33461
34448
  },
33462
34449
  ok: { type: "boolean" }
@@ -33601,12 +34588,17 @@ var openapi_default = {
33601
34588
  nullable: true,
33602
34589
  type: "string"
33603
34590
  },
34591
+ space_id: {
34592
+ description: "ID of the space for which you want to list devices.",
34593
+ format: "uuid",
34594
+ type: "string"
34595
+ },
33604
34596
  unstable_location_id: {
33605
- description: "ID of the location for which you want to list devices.",
34597
+ deprecated: true,
33606
34598
  format: "uuid",
33607
34599
  nullable: true,
33608
34600
  type: "string",
33609
- "x-undocumented": "Experimental locations."
34601
+ "x-deprecated": "Use `space_id`."
33610
34602
  },
33611
34603
  user_identifier_key: {
33612
34604
  description: "Your own internal user ID for the user for which you want to list devices.",
@@ -35427,71 +36419,824 @@ var openapi_default = {
35427
36419
  400: { description: "Bad Request" },
35428
36420
  401: { description: "Unauthorized" }
35429
36421
  },
35430
- security: [{ bridge_client_session: [] }],
35431
- summary: "/seam/bridge/v1/bridge_client_sessions/report_status",
35432
- tags: [],
35433
- "x-fern-sdk-group-name": [
35434
- "seam",
35435
- "bridge",
35436
- "v1",
35437
- "bridge_client_sessions"
36422
+ security: [{ bridge_client_session: [] }],
36423
+ summary: "/seam/bridge/v1/bridge_client_sessions/report_status",
36424
+ tags: [],
36425
+ "x-fern-sdk-group-name": [
36426
+ "seam",
36427
+ "bridge",
36428
+ "v1",
36429
+ "bridge_client_sessions"
36430
+ ],
36431
+ "x-fern-sdk-method-name": "report_status",
36432
+ "x-response-key": null,
36433
+ "x-title": "Report a Bridge Client's Status",
36434
+ "x-undocumented": "Seam Bridge Client only."
36435
+ }
36436
+ },
36437
+ "/seam/bridge/v1/bridge_connected_systems/list": {
36438
+ get: {
36439
+ description: "Returns the bridge connected systems associated with the session token used.",
36440
+ operationId: "seamBridgeV1BridgeConnectedSystemsListGet",
36441
+ responses: {
36442
+ 200: {
36443
+ content: {
36444
+ "application/json": {
36445
+ schema: {
36446
+ properties: {
36447
+ bridge_connected_systems: {
36448
+ items: {
36449
+ properties: {
36450
+ acs_system_display_name: { type: "string" },
36451
+ acs_system_id: { format: "uuid", type: "string" },
36452
+ bridge_created_at: {
36453
+ format: "date-time",
36454
+ type: "string"
36455
+ },
36456
+ bridge_id: { format: "uuid", type: "string" },
36457
+ connected_account_created_at: {
36458
+ format: "date-time",
36459
+ type: "string"
36460
+ },
36461
+ connected_account_id: {
36462
+ format: "uuid",
36463
+ type: "string"
36464
+ },
36465
+ workspace_display_name: { type: "string" },
36466
+ workspace_id: { format: "uuid", type: "string" }
36467
+ },
36468
+ required: [
36469
+ "bridge_id",
36470
+ "bridge_created_at",
36471
+ "connected_account_id",
36472
+ "connected_account_created_at",
36473
+ "acs_system_id",
36474
+ "acs_system_display_name",
36475
+ "workspace_id",
36476
+ "workspace_display_name"
36477
+ ],
36478
+ type: "object",
36479
+ "x-route-path": "/seam/bridge/v1/bridge_connected_systems",
36480
+ "x-undocumented": "Seam Bridge Client only."
36481
+ },
36482
+ type: "array"
36483
+ },
36484
+ ok: { type: "boolean" }
36485
+ },
36486
+ required: ["bridge_connected_systems", "ok"],
36487
+ type: "object"
36488
+ }
36489
+ }
36490
+ },
36491
+ description: "OK"
36492
+ },
36493
+ 400: { description: "Bad Request" },
36494
+ 401: { description: "Unauthorized" }
36495
+ },
36496
+ security: [{ bridge_client_session: [] }],
36497
+ summary: "/seam/bridge/v1/bridge_connected_systems/list",
36498
+ tags: [],
36499
+ "x-fern-ignore": true,
36500
+ "x-response-key": "bridge_connected_systems",
36501
+ "x-title": "List Bridge Connected Systems",
36502
+ "x-undocumented": "Seam Bridge Client only."
36503
+ },
36504
+ post: {
36505
+ description: "Returns the bridge connected systems associated with the session token used.",
36506
+ operationId: "seamBridgeV1BridgeConnectedSystemsListPost",
36507
+ responses: {
36508
+ 200: {
36509
+ content: {
36510
+ "application/json": {
36511
+ schema: {
36512
+ properties: {
36513
+ bridge_connected_systems: {
36514
+ items: {
36515
+ properties: {
36516
+ acs_system_display_name: { type: "string" },
36517
+ acs_system_id: { format: "uuid", type: "string" },
36518
+ bridge_created_at: {
36519
+ format: "date-time",
36520
+ type: "string"
36521
+ },
36522
+ bridge_id: { format: "uuid", type: "string" },
36523
+ connected_account_created_at: {
36524
+ format: "date-time",
36525
+ type: "string"
36526
+ },
36527
+ connected_account_id: {
36528
+ format: "uuid",
36529
+ type: "string"
36530
+ },
36531
+ workspace_display_name: { type: "string" },
36532
+ workspace_id: { format: "uuid", type: "string" }
36533
+ },
36534
+ required: [
36535
+ "bridge_id",
36536
+ "bridge_created_at",
36537
+ "connected_account_id",
36538
+ "connected_account_created_at",
36539
+ "acs_system_id",
36540
+ "acs_system_display_name",
36541
+ "workspace_id",
36542
+ "workspace_display_name"
36543
+ ],
36544
+ type: "object",
36545
+ "x-route-path": "/seam/bridge/v1/bridge_connected_systems",
36546
+ "x-undocumented": "Seam Bridge Client only."
36547
+ },
36548
+ type: "array"
36549
+ },
36550
+ ok: { type: "boolean" }
36551
+ },
36552
+ required: ["bridge_connected_systems", "ok"],
36553
+ type: "object"
36554
+ }
36555
+ }
36556
+ },
36557
+ description: "OK"
36558
+ },
36559
+ 400: { description: "Bad Request" },
36560
+ 401: { description: "Unauthorized" }
36561
+ },
36562
+ security: [{ bridge_client_session: [] }],
36563
+ summary: "/seam/bridge/v1/bridge_connected_systems/list",
36564
+ tags: [],
36565
+ "x-fern-sdk-group-name": [
36566
+ "seam",
36567
+ "bridge",
36568
+ "v1",
36569
+ "bridge_connected_systems"
36570
+ ],
36571
+ "x-fern-sdk-method-name": "list",
36572
+ "x-fern-sdk-return-value": "bridge_connected_systems",
36573
+ "x-response-key": "bridge_connected_systems",
36574
+ "x-title": "List Bridge Connected Systems",
36575
+ "x-undocumented": "Seam Bridge Client only."
36576
+ }
36577
+ },
36578
+ "/seam/instant_key/v1/client_sessions/exchange_short_code": {
36579
+ post: {
36580
+ description: "Exchanges a short code for a Client Session Token (CST).\nThis endpoint is used by mobile apps to securely retrieve a client session token\nusing a short code obtained from an instant key URL.",
36581
+ operationId: "seamInstantKeyV1ClientSessionsExchangeShortCodePost",
36582
+ requestBody: {
36583
+ content: {
36584
+ "application/json": {
36585
+ schema: {
36586
+ properties: {
36587
+ short_code: {
36588
+ description: "The short code to exchange for a client session token",
36589
+ type: "string"
36590
+ }
36591
+ },
36592
+ required: ["short_code"],
36593
+ type: "object"
36594
+ }
36595
+ }
36596
+ }
36597
+ },
36598
+ responses: {
36599
+ 200: {
36600
+ content: {
36601
+ "application/json": {
36602
+ schema: {
36603
+ properties: {
36604
+ client_session: {
36605
+ $ref: "#/components/schemas/client_session"
36606
+ },
36607
+ ok: { type: "boolean" }
36608
+ },
36609
+ required: ["client_session", "ok"],
36610
+ type: "object"
36611
+ }
36612
+ }
36613
+ },
36614
+ description: "OK"
36615
+ },
36616
+ 400: { description: "Bad Request" },
36617
+ 401: { description: "Unauthorized" }
36618
+ },
36619
+ security: [{ certified_client: [] }],
36620
+ summary: "/seam/instant_key/v1/client_sessions/exchange_short_code",
36621
+ tags: ["/client_sessions"],
36622
+ "x-fern-sdk-group-name": [
36623
+ "seam",
36624
+ "instant_key",
36625
+ "v1",
36626
+ "client_sessions"
36627
+ ],
36628
+ "x-fern-sdk-method-name": "exchange_short_code",
36629
+ "x-fern-sdk-return-value": "client_session",
36630
+ "x-response-key": "client_session",
36631
+ "x-title": "Exchange Instant Key Short Code",
36632
+ "x-undocumented": "Seam Instant Key only."
36633
+ }
36634
+ },
36635
+ "/seam/mobile_sdk/v1/acs/credentials/list": {
36636
+ post: {
36637
+ description: "Returns a list of all ACS credentials.",
36638
+ operationId: "seamMobileSdkV1AcsCredentialsListPost",
36639
+ requestBody: {
36640
+ content: {
36641
+ "application/json": { schema: { properties: {}, type: "object" } }
36642
+ }
36643
+ },
36644
+ responses: {
36645
+ 200: {
36646
+ content: {
36647
+ "application/json": {
36648
+ schema: {
36649
+ properties: {
36650
+ acs_credentials: {
36651
+ items: { $ref: "#/components/schemas/acs_credential" },
36652
+ type: "array"
36653
+ },
36654
+ ok: { type: "boolean" }
36655
+ },
36656
+ required: ["acs_credentials", "ok"],
36657
+ type: "object"
36658
+ }
36659
+ }
36660
+ },
36661
+ description: "OK"
36662
+ },
36663
+ 400: { description: "Bad Request" },
36664
+ 401: { description: "Unauthorized" }
36665
+ },
36666
+ security: [{ client_session: [] }],
36667
+ summary: "/seam/mobile_sdk/v1/acs/credentials/list",
36668
+ tags: ["/acs"],
36669
+ "x-fern-sdk-group-name": [
36670
+ "seam",
36671
+ "mobile_sdk",
36672
+ "v1",
36673
+ "acs",
36674
+ "credentials"
36675
+ ],
36676
+ "x-fern-sdk-method-name": "list",
36677
+ "x-fern-sdk-return-value": "acs_credentials",
36678
+ "x-response-key": "acs_credentials",
36679
+ "x-title": "List Credentials",
36680
+ "x-undocumented": "Mobile SDK only."
36681
+ }
36682
+ },
36683
+ "/seam/mobile_sdk/v1/phone_sessions/get_or_create": {
36684
+ post: {
36685
+ description: "Get or create a session for a mobile SDK phone.",
36686
+ operationId: "seamMobileSdkV1PhoneSessionsGetOrCreatePost",
36687
+ requestBody: {
36688
+ content: {
36689
+ "application/json": {
36690
+ schema: {
36691
+ properties: {
36692
+ custom_sdk_installation_id: { type: "string" },
36693
+ phone_device_metadata: {
36694
+ properties: {
36695
+ manufacturer: { type: "string" },
36696
+ model: { type: "string" },
36697
+ os_version: { type: "string" }
36698
+ },
36699
+ type: "object"
36700
+ },
36701
+ phone_os: { enum: ["ios", "android"], type: "string" }
36702
+ },
36703
+ required: ["custom_sdk_installation_id", "phone_os"],
36704
+ type: "object"
36705
+ }
36706
+ }
36707
+ }
36708
+ },
36709
+ responses: {
36710
+ 200: {
36711
+ content: {
36712
+ "application/json": {
36713
+ schema: {
36714
+ properties: {
36715
+ ok: { type: "boolean" },
36716
+ phone_session: {
36717
+ $ref: "#/components/schemas/phone_session"
36718
+ }
36719
+ },
36720
+ required: ["phone_session", "ok"],
36721
+ type: "object"
36722
+ }
36723
+ }
36724
+ },
36725
+ description: "OK"
36726
+ },
36727
+ 400: { description: "Bad Request" },
36728
+ 401: { description: "Unauthorized" }
36729
+ },
36730
+ security: [{ client_session: [] }],
36731
+ summary: "/seam/mobile_sdk/v1/phone_sessions/get_or_create",
36732
+ tags: [],
36733
+ "x-fern-sdk-group-name": ["seam", "mobile_sdk", "v1", "phone_sessions"],
36734
+ "x-fern-sdk-method-name": "get_or_create",
36735
+ "x-fern-sdk-return-value": "phone_session",
36736
+ "x-response-key": "phone_session",
36737
+ "x-title": "Get or Create a Phone Session",
36738
+ "x-undocumented": "Mobile SDK only."
36739
+ }
36740
+ },
36741
+ "/seam/partner/v1/building_blocks/spaces/auto_map": {
36742
+ post: {
36743
+ description: "Auto map partner resources that have been pushed to Seam.",
36744
+ operationId: "seamPartnerV1BuildingBlocksSpacesAutoMapPost",
36745
+ requestBody: {
36746
+ content: {
36747
+ "application/json": {
36748
+ schema: {
36749
+ properties: { collection_key: { type: "string" } },
36750
+ required: ["collection_key"],
36751
+ type: "object"
36752
+ }
36753
+ }
36754
+ }
36755
+ },
36756
+ responses: {
36757
+ 200: {
36758
+ content: {
36759
+ "application/json": {
36760
+ schema: {
36761
+ properties: {
36762
+ ok: { type: "boolean" },
36763
+ spaces: {
36764
+ items: {
36765
+ properties: {
36766
+ acs_entrances: {
36767
+ items: {
36768
+ properties: {
36769
+ acs_entrance_id: { type: "string" },
36770
+ name: { type: "string" }
36771
+ },
36772
+ required: ["acs_entrance_id", "name"],
36773
+ type: "object"
36774
+ },
36775
+ type: "array"
36776
+ },
36777
+ devices: {
36778
+ items: {
36779
+ properties: {
36780
+ device_id: { type: "string" },
36781
+ device_type: {
36782
+ enum: ["lock", "thermostat", "sensor"],
36783
+ type: "string"
36784
+ },
36785
+ name: { type: "string" }
36786
+ },
36787
+ required: ["device_id", "device_type", "name"],
36788
+ type: "object"
36789
+ },
36790
+ type: "array"
36791
+ },
36792
+ name: { type: "string" },
36793
+ needs_review: { type: "boolean" },
36794
+ partner_resource_key: { type: "string" }
36795
+ },
36796
+ required: [
36797
+ "name",
36798
+ "partner_resource_key",
36799
+ "devices",
36800
+ "acs_entrances"
36801
+ ],
36802
+ type: "object"
36803
+ },
36804
+ type: "array"
36805
+ }
36806
+ },
36807
+ required: ["spaces", "ok"],
36808
+ type: "object"
36809
+ }
36810
+ }
36811
+ },
36812
+ description: "OK"
36813
+ },
36814
+ 400: { description: "Bad Request" },
36815
+ 401: { description: "Unauthorized" }
36816
+ },
36817
+ security: [{ client_session_with_customer: [] }],
36818
+ summary: "/seam/partner/v1/building_blocks/spaces/auto_map",
36819
+ tags: [],
36820
+ "x-fern-sdk-group-name": [
36821
+ "seam",
36822
+ "partner",
36823
+ "v1",
36824
+ "building_blocks",
36825
+ "spaces"
36826
+ ],
36827
+ "x-fern-sdk-method-name": "auto_map",
36828
+ "x-fern-sdk-return-value": "spaces",
36829
+ "x-response-key": "spaces",
36830
+ "x-title": "Do auto mapping for partner resources that map to spaces",
36831
+ "x-undocumented": "Partner building blocks/UI only."
36832
+ }
36833
+ },
36834
+ "/seam/partner/v1/resources/list": {
36835
+ post: {
36836
+ description: "List partner resources that have been pushed to Seam.",
36837
+ operationId: "seamPartnerV1ResourcesListPost",
36838
+ requestBody: {
36839
+ content: {
36840
+ "application/json": {
36841
+ schema: {
36842
+ properties: {
36843
+ resource_type_alias: {
36844
+ description: "Filter by resource type alias.",
36845
+ type: "string"
36846
+ }
36847
+ },
36848
+ type: "object"
36849
+ }
36850
+ }
36851
+ }
36852
+ },
36853
+ responses: {
36854
+ 200: {
36855
+ content: {
36856
+ "application/json": {
36857
+ schema: {
36858
+ properties: {
36859
+ ok: { type: "boolean" },
36860
+ partner_resources: {
36861
+ items: {
36862
+ properties: {
36863
+ custom_metadata: {
36864
+ additionalProperties: { type: "string" },
36865
+ type: "object"
36866
+ },
36867
+ customer_key: { type: "string" },
36868
+ description: { type: "string" },
36869
+ email_address: { type: "string" },
36870
+ ends_at: { type: "string" },
36871
+ location_keys: {
36872
+ items: { type: "string" },
36873
+ type: "array"
36874
+ },
36875
+ name: { type: "string" },
36876
+ partner_resource_key: { type: "string" },
36877
+ partner_resource_type: { type: "string" },
36878
+ phone_number: { type: "string" },
36879
+ starts_at: { type: "string" },
36880
+ user_identity_key: { type: "string" }
36881
+ },
36882
+ required: [
36883
+ "partner_resource_type",
36884
+ "partner_resource_key",
36885
+ "customer_key"
36886
+ ],
36887
+ type: "object",
36888
+ "x-route-path": "/unstable_partner/resources",
36889
+ "x-undocumented": "Unreleased."
36890
+ },
36891
+ type: "array"
36892
+ }
36893
+ },
36894
+ required: ["partner_resources", "ok"],
36895
+ type: "object"
36896
+ }
36897
+ }
36898
+ },
36899
+ description: "OK"
36900
+ },
36901
+ 400: { description: "Bad Request" },
36902
+ 401: { description: "Unauthorized" }
36903
+ },
36904
+ security: [{ client_session_with_customer: [] }],
36905
+ summary: "/seam/partner/v1/resources/list",
36906
+ tags: [],
36907
+ "x-fern-sdk-group-name": ["seam", "partner", "v1", "resources"],
36908
+ "x-fern-sdk-method-name": "list",
36909
+ "x-fern-sdk-return-value": "partner_resources",
36910
+ "x-response-key": "partner_resources",
36911
+ "x-title": "List partner resources at Seam",
36912
+ "x-undocumented": "Partner building blocks/UI only."
36913
+ }
36914
+ },
36915
+ "/spaces/add_acs_entrances": {
36916
+ post: {
36917
+ description: "Add entrances to a specific space.",
36918
+ operationId: "spacesAddAcsEntrancesPost",
36919
+ requestBody: {
36920
+ content: {
36921
+ "application/json": {
36922
+ schema: {
36923
+ properties: {
36924
+ acs_entrance_ids: {
36925
+ items: { format: "uuid", type: "string" },
36926
+ minItems: 1,
36927
+ type: "array"
36928
+ },
36929
+ space_id: { format: "uuid", type: "string" }
36930
+ },
36931
+ required: ["space_id", "acs_entrance_ids"],
36932
+ type: "object"
36933
+ }
36934
+ }
36935
+ }
36936
+ },
36937
+ responses: {
36938
+ 200: {
36939
+ content: {
36940
+ "application/json": {
36941
+ schema: {
36942
+ properties: { ok: { type: "boolean" } },
36943
+ required: ["ok"],
36944
+ type: "object"
36945
+ }
36946
+ }
36947
+ },
36948
+ description: "OK"
36949
+ },
36950
+ 400: { description: "Bad Request" },
36951
+ 401: { description: "Unauthorized" }
36952
+ },
36953
+ security: [
36954
+ { pat_with_workspace: [] },
36955
+ { console_session_with_workspace: [] },
36956
+ { api_key: [] }
36957
+ ],
36958
+ summary: "/spaces/add_acs_entrances",
36959
+ tags: [],
36960
+ "x-fern-sdk-group-name": ["spaces"],
36961
+ "x-fern-sdk-method-name": "add_acs_entrances",
36962
+ "x-response-key": null,
36963
+ "x-title": "Add ACS Entrances"
36964
+ },
36965
+ put: {
36966
+ description: "Add entrances to a specific space.",
36967
+ operationId: "spacesAddAcsEntrancesPut",
36968
+ requestBody: {
36969
+ content: {
36970
+ "application/json": {
36971
+ schema: {
36972
+ properties: {
36973
+ acs_entrance_ids: {
36974
+ items: { format: "uuid", type: "string" },
36975
+ minItems: 1,
36976
+ type: "array"
36977
+ },
36978
+ space_id: { format: "uuid", type: "string" }
36979
+ },
36980
+ required: ["space_id", "acs_entrance_ids"],
36981
+ type: "object"
36982
+ }
36983
+ }
36984
+ }
36985
+ },
36986
+ responses: {
36987
+ 200: {
36988
+ content: {
36989
+ "application/json": {
36990
+ schema: {
36991
+ properties: { ok: { type: "boolean" } },
36992
+ required: ["ok"],
36993
+ type: "object"
36994
+ }
36995
+ }
36996
+ },
36997
+ description: "OK"
36998
+ },
36999
+ 400: { description: "Bad Request" },
37000
+ 401: { description: "Unauthorized" }
37001
+ },
37002
+ security: [
37003
+ { pat_with_workspace: [] },
37004
+ { console_session_with_workspace: [] },
37005
+ { api_key: [] }
37006
+ ],
37007
+ summary: "/spaces/add_acs_entrances",
37008
+ tags: [],
37009
+ "x-fern-ignore": true,
37010
+ "x-response-key": null,
37011
+ "x-title": "Add ACS Entrances"
37012
+ }
37013
+ },
37014
+ "/spaces/add_devices": {
37015
+ post: {
37016
+ description: "Add devices to a specific space.",
37017
+ operationId: "spacesAddDevicesPost",
37018
+ requestBody: {
37019
+ content: {
37020
+ "application/json": {
37021
+ schema: {
37022
+ properties: {
37023
+ device_ids: {
37024
+ items: { format: "uuid", type: "string" },
37025
+ minItems: 1,
37026
+ type: "array"
37027
+ },
37028
+ space_id: { format: "uuid", type: "string" }
37029
+ },
37030
+ required: ["space_id", "device_ids"],
37031
+ type: "object"
37032
+ }
37033
+ }
37034
+ }
37035
+ },
37036
+ responses: {
37037
+ 200: {
37038
+ content: {
37039
+ "application/json": {
37040
+ schema: {
37041
+ properties: { ok: { type: "boolean" } },
37042
+ required: ["ok"],
37043
+ type: "object"
37044
+ }
37045
+ }
37046
+ },
37047
+ description: "OK"
37048
+ },
37049
+ 400: { description: "Bad Request" },
37050
+ 401: { description: "Unauthorized" }
37051
+ },
37052
+ security: [
37053
+ { pat_with_workspace: [] },
37054
+ { console_session_with_workspace: [] },
37055
+ { api_key: [] }
37056
+ ],
37057
+ summary: "/spaces/add_devices",
37058
+ tags: [],
37059
+ "x-fern-sdk-group-name": ["spaces"],
37060
+ "x-fern-sdk-method-name": "add_devices",
37061
+ "x-response-key": null,
37062
+ "x-title": "Add Space Devices"
37063
+ },
37064
+ put: {
37065
+ description: "Add devices to a specific space.",
37066
+ operationId: "spacesAddDevicesPut",
37067
+ requestBody: {
37068
+ content: {
37069
+ "application/json": {
37070
+ schema: {
37071
+ properties: {
37072
+ device_ids: {
37073
+ items: { format: "uuid", type: "string" },
37074
+ minItems: 1,
37075
+ type: "array"
37076
+ },
37077
+ space_id: { format: "uuid", type: "string" }
37078
+ },
37079
+ required: ["space_id", "device_ids"],
37080
+ type: "object"
37081
+ }
37082
+ }
37083
+ }
37084
+ },
37085
+ responses: {
37086
+ 200: {
37087
+ content: {
37088
+ "application/json": {
37089
+ schema: {
37090
+ properties: { ok: { type: "boolean" } },
37091
+ required: ["ok"],
37092
+ type: "object"
37093
+ }
37094
+ }
37095
+ },
37096
+ description: "OK"
37097
+ },
37098
+ 400: { description: "Bad Request" },
37099
+ 401: { description: "Unauthorized" }
37100
+ },
37101
+ security: [
37102
+ { pat_with_workspace: [] },
37103
+ { console_session_with_workspace: [] },
37104
+ { api_key: [] }
37105
+ ],
37106
+ summary: "/spaces/add_devices",
37107
+ tags: [],
37108
+ "x-fern-ignore": true,
37109
+ "x-response-key": null,
37110
+ "x-title": "Add Space Devices"
37111
+ }
37112
+ },
37113
+ "/spaces/create": {
37114
+ post: {
37115
+ description: "Create a new space.",
37116
+ operationId: "spacesCreatePost",
37117
+ requestBody: {
37118
+ content: {
37119
+ "application/json": {
37120
+ schema: {
37121
+ properties: {
37122
+ acs_entrance_ids: {
37123
+ items: { format: "uuid", type: "string" },
37124
+ type: "array"
37125
+ },
37126
+ device_ids: {
37127
+ items: { format: "uuid", type: "string" },
37128
+ type: "array"
37129
+ },
37130
+ name: { type: "string" }
37131
+ },
37132
+ required: ["name"],
37133
+ type: "object"
37134
+ }
37135
+ }
37136
+ }
37137
+ },
37138
+ responses: {
37139
+ 200: {
37140
+ content: {
37141
+ "application/json": {
37142
+ schema: {
37143
+ properties: {
37144
+ ok: { type: "boolean" },
37145
+ space: { $ref: "#/components/schemas/space" }
37146
+ },
37147
+ required: ["space", "ok"],
37148
+ type: "object"
37149
+ }
37150
+ }
37151
+ },
37152
+ description: "OK"
37153
+ },
37154
+ 400: { description: "Bad Request" },
37155
+ 401: { description: "Unauthorized" }
37156
+ },
37157
+ security: [
37158
+ { pat_with_workspace: [] },
37159
+ { console_session_with_workspace: [] },
37160
+ { api_key: [] }
37161
+ ],
37162
+ summary: "/spaces/create",
37163
+ tags: [],
37164
+ "x-fern-sdk-group-name": ["spaces"],
37165
+ "x-fern-sdk-method-name": "create",
37166
+ "x-fern-sdk-return-value": "space",
37167
+ "x-response-key": "space",
37168
+ "x-title": "Create Space"
37169
+ }
37170
+ },
37171
+ "/spaces/delete": {
37172
+ post: {
37173
+ description: "Delete a space.",
37174
+ operationId: "spacesDeletePost",
37175
+ requestBody: {
37176
+ content: {
37177
+ "application/json": {
37178
+ schema: {
37179
+ properties: { space_id: { format: "uuid", type: "string" } },
37180
+ required: ["space_id"],
37181
+ type: "object"
37182
+ }
37183
+ }
37184
+ }
37185
+ },
37186
+ responses: {
37187
+ 200: {
37188
+ content: {
37189
+ "application/json": {
37190
+ schema: {
37191
+ properties: { ok: { type: "boolean" } },
37192
+ required: ["ok"],
37193
+ type: "object"
37194
+ }
37195
+ }
37196
+ },
37197
+ description: "OK"
37198
+ },
37199
+ 400: { description: "Bad Request" },
37200
+ 401: { description: "Unauthorized" }
37201
+ },
37202
+ security: [
37203
+ { pat_with_workspace: [] },
37204
+ { console_session_with_workspace: [] },
37205
+ { api_key: [] }
35438
37206
  ],
35439
- "x-fern-sdk-method-name": "report_status",
37207
+ summary: "/spaces/delete",
37208
+ tags: [],
37209
+ "x-fern-sdk-group-name": ["spaces"],
37210
+ "x-fern-sdk-method-name": "delete",
35440
37211
  "x-response-key": null,
35441
- "x-title": "Report a Bridge Client's Status",
35442
- "x-undocumented": "Seam Bridge Client only."
37212
+ "x-title": "Delete Space"
35443
37213
  }
35444
37214
  },
35445
- "/seam/bridge/v1/bridge_connected_systems/list": {
35446
- get: {
35447
- description: "Returns the bridge connected systems associated with the session token used.",
35448
- operationId: "seamBridgeV1BridgeConnectedSystemsListGet",
37215
+ "/spaces/get": {
37216
+ post: {
37217
+ description: "Get a space.",
37218
+ operationId: "spacesGetPost",
37219
+ requestBody: {
37220
+ content: {
37221
+ "application/json": {
37222
+ schema: {
37223
+ properties: { space_id: { format: "uuid", type: "string" } },
37224
+ required: ["space_id"],
37225
+ type: "object"
37226
+ }
37227
+ }
37228
+ }
37229
+ },
35449
37230
  responses: {
35450
37231
  200: {
35451
37232
  content: {
35452
37233
  "application/json": {
35453
37234
  schema: {
35454
37235
  properties: {
35455
- bridge_connected_systems: {
35456
- items: {
35457
- properties: {
35458
- acs_system_display_name: { type: "string" },
35459
- acs_system_id: { format: "uuid", type: "string" },
35460
- bridge_created_at: {
35461
- format: "date-time",
35462
- type: "string"
35463
- },
35464
- bridge_id: { format: "uuid", type: "string" },
35465
- connected_account_created_at: {
35466
- format: "date-time",
35467
- type: "string"
35468
- },
35469
- connected_account_id: {
35470
- format: "uuid",
35471
- type: "string"
35472
- },
35473
- workspace_display_name: { type: "string" },
35474
- workspace_id: { format: "uuid", type: "string" }
35475
- },
35476
- required: [
35477
- "bridge_id",
35478
- "bridge_created_at",
35479
- "connected_account_id",
35480
- "connected_account_created_at",
35481
- "acs_system_id",
35482
- "acs_system_display_name",
35483
- "workspace_id",
35484
- "workspace_display_name"
35485
- ],
35486
- type: "object",
35487
- "x-route-path": "/seam/bridge/v1/bridge_connected_systems",
35488
- "x-undocumented": "Seam Bridge Client only."
35489
- },
35490
- type: "array"
35491
- },
35492
- ok: { type: "boolean" }
37236
+ ok: { type: "boolean" },
37237
+ space: { $ref: "#/components/schemas/space" }
35493
37238
  },
35494
- required: ["bridge_connected_systems", "ok"],
37239
+ required: ["space", "ok"],
35495
37240
  type: "object"
35496
37241
  }
35497
37242
  }
@@ -35501,63 +37246,37 @@ var openapi_default = {
35501
37246
  400: { description: "Bad Request" },
35502
37247
  401: { description: "Unauthorized" }
35503
37248
  },
35504
- security: [{ bridge_client_session: [] }],
35505
- summary: "/seam/bridge/v1/bridge_connected_systems/list",
37249
+ security: [
37250
+ { pat_with_workspace: [] },
37251
+ { console_session_with_workspace: [] },
37252
+ { api_key: [] }
37253
+ ],
37254
+ summary: "/spaces/get",
35506
37255
  tags: [],
35507
- "x-fern-ignore": true,
35508
- "x-response-key": "bridge_connected_systems",
35509
- "x-title": "List Bridge Connected Systems",
35510
- "x-undocumented": "Seam Bridge Client only."
35511
- },
35512
- post: {
35513
- description: "Returns the bridge connected systems associated with the session token used.",
35514
- operationId: "seamBridgeV1BridgeConnectedSystemsListPost",
37256
+ "x-fern-sdk-group-name": ["spaces"],
37257
+ "x-fern-sdk-method-name": "get",
37258
+ "x-fern-sdk-return-value": "space",
37259
+ "x-response-key": "space",
37260
+ "x-title": "Get Space"
37261
+ }
37262
+ },
37263
+ "/spaces/list": {
37264
+ get: {
37265
+ description: "Returns a list of all spaces.",
37266
+ operationId: "spacesListGet",
35515
37267
  responses: {
35516
37268
  200: {
35517
37269
  content: {
35518
37270
  "application/json": {
35519
37271
  schema: {
35520
37272
  properties: {
35521
- bridge_connected_systems: {
35522
- items: {
35523
- properties: {
35524
- acs_system_display_name: { type: "string" },
35525
- acs_system_id: { format: "uuid", type: "string" },
35526
- bridge_created_at: {
35527
- format: "date-time",
35528
- type: "string"
35529
- },
35530
- bridge_id: { format: "uuid", type: "string" },
35531
- connected_account_created_at: {
35532
- format: "date-time",
35533
- type: "string"
35534
- },
35535
- connected_account_id: {
35536
- format: "uuid",
35537
- type: "string"
35538
- },
35539
- workspace_display_name: { type: "string" },
35540
- workspace_id: { format: "uuid", type: "string" }
35541
- },
35542
- required: [
35543
- "bridge_id",
35544
- "bridge_created_at",
35545
- "connected_account_id",
35546
- "connected_account_created_at",
35547
- "acs_system_id",
35548
- "acs_system_display_name",
35549
- "workspace_id",
35550
- "workspace_display_name"
35551
- ],
35552
- type: "object",
35553
- "x-route-path": "/seam/bridge/v1/bridge_connected_systems",
35554
- "x-undocumented": "Seam Bridge Client only."
35555
- },
37273
+ ok: { type: "boolean" },
37274
+ spaces: {
37275
+ items: { $ref: "#/components/schemas/space" },
35556
37276
  type: "array"
35557
- },
35558
- ok: { type: "boolean" }
37277
+ }
35559
37278
  },
35560
- required: ["bridge_connected_systems", "ok"],
37279
+ required: ["spaces", "ok"],
35561
37280
  type: "object"
35562
37281
  }
35563
37282
  }
@@ -35567,54 +37286,33 @@ var openapi_default = {
35567
37286
  400: { description: "Bad Request" },
35568
37287
  401: { description: "Unauthorized" }
35569
37288
  },
35570
- security: [{ bridge_client_session: [] }],
35571
- summary: "/seam/bridge/v1/bridge_connected_systems/list",
35572
- tags: [],
35573
- "x-fern-sdk-group-name": [
35574
- "seam",
35575
- "bridge",
35576
- "v1",
35577
- "bridge_connected_systems"
37289
+ security: [
37290
+ { pat_with_workspace: [] },
37291
+ { console_session_with_workspace: [] },
37292
+ { api_key: [] }
35578
37293
  ],
35579
- "x-fern-sdk-method-name": "list",
35580
- "x-fern-sdk-return-value": "bridge_connected_systems",
35581
- "x-response-key": "bridge_connected_systems",
35582
- "x-title": "List Bridge Connected Systems",
35583
- "x-undocumented": "Seam Bridge Client only."
35584
- }
35585
- },
35586
- "/seam/instant_key/v1/client_sessions/exchange_short_code": {
37294
+ summary: "/spaces/list",
37295
+ tags: [],
37296
+ "x-fern-ignore": true,
37297
+ "x-response-key": "spaces",
37298
+ "x-title": "List Spaces"
37299
+ },
35587
37300
  post: {
35588
- description: "Exchanges a short code for a Client Session Token (CST).\nThis endpoint is used by mobile apps to securely retrieve a client session token\nusing a short code obtained from an instant key URL.",
35589
- operationId: "seamInstantKeyV1ClientSessionsExchangeShortCodePost",
35590
- requestBody: {
35591
- content: {
35592
- "application/json": {
35593
- schema: {
35594
- properties: {
35595
- short_code: {
35596
- description: "The short code to exchange for a client session token",
35597
- type: "string"
35598
- }
35599
- },
35600
- required: ["short_code"],
35601
- type: "object"
35602
- }
35603
- }
35604
- }
35605
- },
37301
+ description: "Returns a list of all spaces.",
37302
+ operationId: "spacesListPost",
35606
37303
  responses: {
35607
37304
  200: {
35608
37305
  content: {
35609
37306
  "application/json": {
35610
37307
  schema: {
35611
37308
  properties: {
35612
- client_session: {
35613
- $ref: "#/components/schemas/client_session"
35614
- },
35615
- ok: { type: "boolean" }
37309
+ ok: { type: "boolean" },
37310
+ spaces: {
37311
+ items: { $ref: "#/components/schemas/space" },
37312
+ type: "array"
37313
+ }
35616
37314
  },
35617
- required: ["client_session", "ok"],
37315
+ required: ["spaces", "ok"],
35618
37316
  type: "object"
35619
37317
  }
35620
37318
  }
@@ -35624,29 +37322,39 @@ var openapi_default = {
35624
37322
  400: { description: "Bad Request" },
35625
37323
  401: { description: "Unauthorized" }
35626
37324
  },
35627
- security: [{ certified_client: [] }],
35628
- summary: "/seam/instant_key/v1/client_sessions/exchange_short_code",
35629
- tags: ["/client_sessions"],
35630
- "x-fern-sdk-group-name": [
35631
- "seam",
35632
- "instant_key",
35633
- "v1",
35634
- "client_sessions"
37325
+ security: [
37326
+ { pat_with_workspace: [] },
37327
+ { console_session_with_workspace: [] },
37328
+ { api_key: [] }
35635
37329
  ],
35636
- "x-fern-sdk-method-name": "exchange_short_code",
35637
- "x-fern-sdk-return-value": "client_session",
35638
- "x-response-key": "client_session",
35639
- "x-title": "Exchange Instant Key Short Code",
35640
- "x-undocumented": "Seam Instant Key only."
37330
+ summary: "/spaces/list",
37331
+ tags: [],
37332
+ "x-fern-sdk-group-name": ["spaces"],
37333
+ "x-fern-sdk-method-name": "list",
37334
+ "x-fern-sdk-return-value": "spaces",
37335
+ "x-response-key": "spaces",
37336
+ "x-title": "List Spaces"
35641
37337
  }
35642
37338
  },
35643
- "/seam/mobile_sdk/v1/acs/credentials/list": {
37339
+ "/spaces/remove_acs_entrances": {
35644
37340
  post: {
35645
- description: "Returns a list of all ACS credentials.",
35646
- operationId: "seamMobileSdkV1AcsCredentialsListPost",
37341
+ description: "Remove entrances from a specific space.",
37342
+ operationId: "spacesRemoveAcsEntrancesPost",
35647
37343
  requestBody: {
35648
37344
  content: {
35649
- "application/json": { schema: { properties: {}, type: "object" } }
37345
+ "application/json": {
37346
+ schema: {
37347
+ properties: {
37348
+ acs_entrance_ids: {
37349
+ items: { format: "uuid", type: "string" },
37350
+ type: "array"
37351
+ },
37352
+ space_id: { format: "uuid", type: "string" }
37353
+ },
37354
+ required: ["space_id", "acs_entrance_ids"],
37355
+ type: "object"
37356
+ }
37357
+ }
35650
37358
  }
35651
37359
  },
35652
37360
  responses: {
@@ -35654,14 +37362,8 @@ var openapi_default = {
35654
37362
  content: {
35655
37363
  "application/json": {
35656
37364
  schema: {
35657
- properties: {
35658
- acs_credentials: {
35659
- items: { $ref: "#/components/schemas/acs_credential" },
35660
- type: "array"
35661
- },
35662
- ok: { type: "boolean" }
35663
- },
35664
- required: ["acs_credentials", "ok"],
37365
+ properties: { ok: { type: "boolean" } },
37366
+ required: ["ok"],
35665
37367
  type: "object"
35666
37368
  }
35667
37369
  }
@@ -35671,44 +37373,35 @@ var openapi_default = {
35671
37373
  400: { description: "Bad Request" },
35672
37374
  401: { description: "Unauthorized" }
35673
37375
  },
35674
- security: [{ client_session: [] }],
35675
- summary: "/seam/mobile_sdk/v1/acs/credentials/list",
35676
- tags: ["/acs"],
35677
- "x-fern-sdk-group-name": [
35678
- "seam",
35679
- "mobile_sdk",
35680
- "v1",
35681
- "acs",
35682
- "credentials"
37376
+ security: [
37377
+ { pat_with_workspace: [] },
37378
+ { console_session_with_workspace: [] },
37379
+ { api_key: [] }
35683
37380
  ],
35684
- "x-fern-sdk-method-name": "list",
35685
- "x-fern-sdk-return-value": "acs_credentials",
35686
- "x-response-key": "acs_credentials",
35687
- "x-title": "List Credentials",
35688
- "x-undocumented": "Mobile SDK only."
37381
+ summary: "/spaces/remove_acs_entrances",
37382
+ tags: [],
37383
+ "x-fern-sdk-group-name": ["spaces"],
37384
+ "x-fern-sdk-method-name": "remove_acs_entrances",
37385
+ "x-response-key": null,
37386
+ "x-title": "Remove ACS Entrances"
35689
37387
  }
35690
37388
  },
35691
- "/seam/mobile_sdk/v1/phone_sessions/get_or_create": {
37389
+ "/spaces/remove_devices": {
35692
37390
  post: {
35693
- description: "Get or create a session for a mobile SDK phone.",
35694
- operationId: "seamMobileSdkV1PhoneSessionsGetOrCreatePost",
37391
+ description: "Remove devices from a specific space.",
37392
+ operationId: "spacesRemoveDevicesPost",
35695
37393
  requestBody: {
35696
37394
  content: {
35697
37395
  "application/json": {
35698
37396
  schema: {
35699
37397
  properties: {
35700
- custom_sdk_installation_id: { type: "string" },
35701
- phone_device_metadata: {
35702
- properties: {
35703
- manufacturer: { type: "string" },
35704
- model: { type: "string" },
35705
- os_version: { type: "string" }
35706
- },
35707
- type: "object"
37398
+ device_ids: {
37399
+ items: { format: "uuid", type: "string" },
37400
+ type: "array"
35708
37401
  },
35709
- phone_os: { enum: ["ios", "android"], type: "string" }
37402
+ space_id: { format: "uuid", type: "string" }
35710
37403
  },
35711
- required: ["custom_sdk_installation_id", "phone_os"],
37404
+ required: ["space_id", "device_ids"],
35712
37405
  type: "object"
35713
37406
  }
35714
37407
  }
@@ -35719,13 +37412,8 @@ var openapi_default = {
35719
37412
  content: {
35720
37413
  "application/json": {
35721
37414
  schema: {
35722
- properties: {
35723
- ok: { type: "boolean" },
35724
- phone_session: {
35725
- $ref: "#/components/schemas/phone_session"
35726
- }
35727
- },
35728
- required: ["phone_session", "ok"],
37415
+ properties: { ok: { type: "boolean" } },
37416
+ required: ["ok"],
35729
37417
  type: "object"
35730
37418
  }
35731
37419
  }
@@ -35735,27 +37423,32 @@ var openapi_default = {
35735
37423
  400: { description: "Bad Request" },
35736
37424
  401: { description: "Unauthorized" }
35737
37425
  },
35738
- security: [{ client_session: [] }],
35739
- summary: "/seam/mobile_sdk/v1/phone_sessions/get_or_create",
37426
+ security: [
37427
+ { pat_with_workspace: [] },
37428
+ { console_session_with_workspace: [] },
37429
+ { api_key: [] }
37430
+ ],
37431
+ summary: "/spaces/remove_devices",
35740
37432
  tags: [],
35741
- "x-fern-sdk-group-name": ["seam", "mobile_sdk", "v1", "phone_sessions"],
35742
- "x-fern-sdk-method-name": "get_or_create",
35743
- "x-fern-sdk-return-value": "phone_session",
35744
- "x-response-key": "phone_session",
35745
- "x-title": "Get or Create a Phone Session",
35746
- "x-undocumented": "Mobile SDK only."
37433
+ "x-fern-sdk-group-name": ["spaces"],
37434
+ "x-fern-sdk-method-name": "remove_devices",
37435
+ "x-response-key": null,
37436
+ "x-title": "Remove Space Devices"
35747
37437
  }
35748
37438
  },
35749
- "/seam/partner/v1/building_blocks/spaces/auto_map": {
35750
- post: {
35751
- description: "Auto map partner resources that have been pushed to Seam.",
35752
- operationId: "seamPartnerV1BuildingBlocksSpacesAutoMapPost",
37439
+ "/spaces/update": {
37440
+ patch: {
37441
+ description: "Update an existing space.",
37442
+ operationId: "spacesUpdatePatch",
35753
37443
  requestBody: {
35754
37444
  content: {
35755
37445
  "application/json": {
35756
37446
  schema: {
35757
- properties: { collection_key: { type: "string" } },
35758
- required: ["collection_key"],
37447
+ properties: {
37448
+ name: { type: "string" },
37449
+ space_id: { format: "uuid", type: "string" }
37450
+ },
37451
+ required: ["space_id"],
35759
37452
  type: "object"
35760
37453
  }
35761
37454
  }
@@ -35768,51 +37461,9 @@ var openapi_default = {
35768
37461
  schema: {
35769
37462
  properties: {
35770
37463
  ok: { type: "boolean" },
35771
- spaces: {
35772
- items: {
35773
- properties: {
35774
- acs_entrances: {
35775
- items: {
35776
- properties: {
35777
- acs_entrance_id: { type: "string" },
35778
- name: { type: "string" }
35779
- },
35780
- required: ["acs_entrance_id", "name"],
35781
- type: "object"
35782
- },
35783
- type: "array"
35784
- },
35785
- devices: {
35786
- items: {
35787
- properties: {
35788
- device_id: { type: "string" },
35789
- device_type: {
35790
- enum: ["lock", "thermostat", "sensor"],
35791
- type: "string"
35792
- },
35793
- name: { type: "string" }
35794
- },
35795
- required: ["device_id", "device_type", "name"],
35796
- type: "object"
35797
- },
35798
- type: "array"
35799
- },
35800
- name: { type: "string" },
35801
- needs_review: { type: "boolean" },
35802
- partner_resource_key: { type: "string" }
35803
- },
35804
- required: [
35805
- "name",
35806
- "partner_resource_key",
35807
- "devices",
35808
- "acs_entrances"
35809
- ],
35810
- type: "object"
35811
- },
35812
- type: "array"
35813
- }
37464
+ space: { $ref: "#/components/schemas/space" }
35814
37465
  },
35815
- required: ["spaces", "ok"],
37466
+ required: ["space", "ok"],
35816
37467
  type: "object"
35817
37468
  }
35818
37469
  }
@@ -35822,37 +37473,29 @@ var openapi_default = {
35822
37473
  400: { description: "Bad Request" },
35823
37474
  401: { description: "Unauthorized" }
35824
37475
  },
35825
- security: [{ client_session_with_customer: [] }],
35826
- summary: "/seam/partner/v1/building_blocks/spaces/auto_map",
35827
- tags: [],
35828
- "x-fern-sdk-group-name": [
35829
- "seam",
35830
- "partner",
35831
- "v1",
35832
- "building_blocks",
35833
- "spaces"
37476
+ security: [
37477
+ { pat_with_workspace: [] },
37478
+ { console_session_with_workspace: [] },
37479
+ { api_key: [] }
35834
37480
  ],
35835
- "x-fern-sdk-method-name": "auto_map",
35836
- "x-fern-sdk-return-value": "spaces",
35837
- "x-response-key": "spaces",
35838
- "x-title": "Do auto mapping for partner resources that map to spaces",
35839
- "x-undocumented": "Partner building blocks/UI only."
35840
- }
35841
- },
35842
- "/seam/partner/v1/resources/list": {
37481
+ summary: "/spaces/update",
37482
+ tags: [],
37483
+ "x-fern-ignore": true,
37484
+ "x-response-key": "space",
37485
+ "x-title": "Update Space"
37486
+ },
35843
37487
  post: {
35844
- description: "List partner resources that have been pushed to Seam.",
35845
- operationId: "seamPartnerV1ResourcesListPost",
37488
+ description: "Update an existing space.",
37489
+ operationId: "spacesUpdatePost",
35846
37490
  requestBody: {
35847
37491
  content: {
35848
37492
  "application/json": {
35849
37493
  schema: {
35850
37494
  properties: {
35851
- resource_type_alias: {
35852
- description: "Filter by resource type alias.",
35853
- type: "string"
35854
- }
37495
+ name: { type: "string" },
37496
+ space_id: { format: "uuid", type: "string" }
35855
37497
  },
37498
+ required: ["space_id"],
35856
37499
  type: "object"
35857
37500
  }
35858
37501
  }
@@ -35865,41 +37508,9 @@ var openapi_default = {
35865
37508
  schema: {
35866
37509
  properties: {
35867
37510
  ok: { type: "boolean" },
35868
- partner_resources: {
35869
- items: {
35870
- properties: {
35871
- custom_metadata: {
35872
- additionalProperties: { type: "string" },
35873
- type: "object"
35874
- },
35875
- customer_key: { type: "string" },
35876
- description: { type: "string" },
35877
- email_address: { type: "string" },
35878
- ends_at: { type: "string" },
35879
- location_keys: {
35880
- items: { type: "string" },
35881
- type: "array"
35882
- },
35883
- name: { type: "string" },
35884
- partner_resource_key: { type: "string" },
35885
- partner_resource_type: { type: "string" },
35886
- phone_number: { type: "string" },
35887
- starts_at: { type: "string" },
35888
- user_identity_key: { type: "string" }
35889
- },
35890
- required: [
35891
- "partner_resource_type",
35892
- "partner_resource_key",
35893
- "customer_key"
35894
- ],
35895
- type: "object",
35896
- "x-route-path": "/unstable_partner/resources",
35897
- "x-undocumented": "Unreleased."
35898
- },
35899
- type: "array"
35900
- }
37511
+ space: { $ref: "#/components/schemas/space" }
35901
37512
  },
35902
- required: ["partner_resources", "ok"],
37513
+ required: ["space", "ok"],
35903
37514
  type: "object"
35904
37515
  }
35905
37516
  }
@@ -35909,15 +37520,18 @@ var openapi_default = {
35909
37520
  400: { description: "Bad Request" },
35910
37521
  401: { description: "Unauthorized" }
35911
37522
  },
35912
- security: [{ client_session_with_customer: [] }],
35913
- summary: "/seam/partner/v1/resources/list",
37523
+ security: [
37524
+ { pat_with_workspace: [] },
37525
+ { console_session_with_workspace: [] },
37526
+ { api_key: [] }
37527
+ ],
37528
+ summary: "/spaces/update",
35914
37529
  tags: [],
35915
- "x-fern-sdk-group-name": ["seam", "partner", "v1", "resources"],
35916
- "x-fern-sdk-method-name": "list",
35917
- "x-fern-sdk-return-value": "partner_resources",
35918
- "x-response-key": "partner_resources",
35919
- "x-title": "List partner resources at Seam",
35920
- "x-undocumented": "Partner building blocks/UI only."
37530
+ "x-fern-sdk-group-name": ["spaces"],
37531
+ "x-fern-sdk-method-name": "update",
37532
+ "x-fern-sdk-return-value": "space",
37533
+ "x-response-key": "space",
37534
+ "x-title": "Update Space"
35921
37535
  }
35922
37536
  },
35923
37537
  "/thermostats/activate_climate_preset": {
@@ -36908,12 +38522,17 @@ var openapi_default = {
36908
38522
  nullable: true,
36909
38523
  type: "string"
36910
38524
  },
38525
+ space_id: {
38526
+ description: "ID of the space for which you want to list devices.",
38527
+ format: "uuid",
38528
+ type: "string"
38529
+ },
36911
38530
  unstable_location_id: {
36912
- description: "ID of the location for which you want to list devices.",
38531
+ deprecated: true,
36913
38532
  format: "uuid",
36914
38533
  nullable: true,
36915
38534
  type: "string",
36916
- "x-undocumented": "Experimental locations."
38535
+ "x-deprecated": "Use `space_id`."
36917
38536
  },
36918
38537
  user_identifier_key: {
36919
38538
  description: "Your own internal user ID for the user for which you want to list devices.",
@@ -38427,6 +40046,18 @@ var openapi_default = {
38427
40046
  },
38428
40047
  {
38429
40048
  properties: {
40049
+ acs_entrance_ids: {
40050
+ default: [],
40051
+ description: "Set of IDs of the [entrances](https://docs.seam.co/latest/api/acs/systems/list) to which access is being granted.",
40052
+ items: { format: "uuid", type: "string" },
40053
+ type: "array"
40054
+ },
40055
+ device_ids: {
40056
+ default: [],
40057
+ description: "Set of IDs of the [devices](https://docs.seam.co/latest/api/devices/list) to which access is being granted.",
40058
+ items: { format: "uuid", type: "string" },
40059
+ type: "array"
40060
+ },
38430
40061
  ends_at: {
38431
40062
  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`.",
38432
40063
  format: "date-time",
@@ -38437,15 +40068,17 @@ var openapi_default = {
38437
40068
  properties: {
38438
40069
  acs_entrance_ids: {
38439
40070
  default: [],
38440
- 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.",
40071
+ deprecated: true,
38441
40072
  items: { format: "uuid", type: "string" },
38442
- type: "array"
40073
+ type: "array",
40074
+ "x-deprecated": "Use `acs_entrance_ids` at the top level."
38443
40075
  },
38444
40076
  device_ids: {
38445
40077
  default: [],
38446
- 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.",
40078
+ deprecated: true,
38447
40079
  items: { format: "uuid", type: "string" },
38448
- type: "array"
40080
+ type: "array",
40081
+ "x-deprecated": "Use `device_ids` at the top level."
38449
40082
  },
38450
40083
  name: {
38451
40084
  description: "Name of the location.",
@@ -38455,9 +40088,10 @@ var openapi_default = {
38455
40088
  type: "object"
38456
40089
  },
38457
40090
  location_ids: {
38458
- description: "Set of IDs of existing locations to which access is being granted.",
40091
+ deprecated: true,
38459
40092
  items: { format: "uuid", type: "string" },
38460
- type: "array"
40093
+ type: "array",
40094
+ "x-deprecated": "Use `space_ids`."
38461
40095
  },
38462
40096
  requested_access_methods: {
38463
40097
  items: {
@@ -38473,6 +40107,11 @@ var openapi_default = {
38473
40107
  },
38474
40108
  type: "array"
38475
40109
  },
40110
+ space_ids: {
40111
+ description: "Set of IDs of existing spaces to which access is being granted.",
40112
+ items: { format: "uuid", type: "string" },
40113
+ type: "array"
40114
+ },
38476
40115
  starts_at: {
38477
40116
  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.",
38478
40117
  format: "date-time",
@@ -38515,9 +40154,10 @@ var openapi_default = {
38515
40154
  type: "string"
38516
40155
  },
38517
40156
  location_ids: {
38518
- description: "IDs of the locations to which access is being given.",
40157
+ deprecated: true,
38519
40158
  items: { format: "uuid", type: "string" },
38520
- type: "array"
40159
+ type: "array",
40160
+ "x-deprecated": "Use `space_ids`."
38521
40161
  },
38522
40162
  requested_access_methods: {
38523
40163
  description: "Access methods that the user requested for this access grant.",
@@ -38549,11 +40189,15 @@ var openapi_default = {
38549
40189
  "created_at",
38550
40190
  "created_access_method_ids"
38551
40191
  ],
38552
- type: "object",
38553
- "x-undocumented": "Unreleased."
40192
+ type: "object"
38554
40193
  },
38555
40194
  type: "array"
38556
40195
  },
40196
+ space_ids: {
40197
+ description: "IDs of the spaces to which access is being given.",
40198
+ items: { format: "uuid", type: "string" },
40199
+ type: "array"
40200
+ },
38557
40201
  user_identity_id: {
38558
40202
  description: "ID of user identity to which access is being granted.",
38559
40203
  format: "uuid",
@@ -38570,13 +40214,15 @@ var openapi_default = {
38570
40214
  "access_grant_id",
38571
40215
  "user_identity_id",
38572
40216
  "location_ids",
40217
+ "space_ids",
38573
40218
  "requested_access_methods",
38574
40219
  "access_method_ids",
38575
40220
  "display_name",
38576
40221
  "created_at"
38577
40222
  ],
38578
40223
  type: "object",
38579
- "x-undocumented": "Unreleased."
40224
+ "x-draft": "Early access.",
40225
+ "x-route-path": "/access_grants"
38580
40226
  },
38581
40227
  ok: { type: "boolean" }
38582
40228
  },
@@ -38707,9 +40353,10 @@ var openapi_default = {
38707
40353
  type: "string"
38708
40354
  },
38709
40355
  location_ids: {
38710
- description: "IDs of the locations to which access is being given.",
40356
+ deprecated: true,
38711
40357
  items: { format: "uuid", type: "string" },
38712
- type: "array"
40358
+ type: "array",
40359
+ "x-deprecated": "Use `space_ids`."
38713
40360
  },
38714
40361
  requested_access_methods: {
38715
40362
  description: "Access methods that the user requested for this access grant.",
@@ -38741,11 +40388,15 @@ var openapi_default = {
38741
40388
  "created_at",
38742
40389
  "created_access_method_ids"
38743
40390
  ],
38744
- type: "object",
38745
- "x-undocumented": "Unreleased."
40391
+ type: "object"
38746
40392
  },
38747
40393
  type: "array"
38748
40394
  },
40395
+ space_ids: {
40396
+ description: "IDs of the spaces to which access is being given.",
40397
+ items: { format: "uuid", type: "string" },
40398
+ type: "array"
40399
+ },
38749
40400
  user_identity_id: {
38750
40401
  description: "ID of user identity to which access is being granted.",
38751
40402
  format: "uuid",
@@ -38762,13 +40413,15 @@ var openapi_default = {
38762
40413
  "access_grant_id",
38763
40414
  "user_identity_id",
38764
40415
  "location_ids",
40416
+ "space_ids",
38765
40417
  "requested_access_methods",
38766
40418
  "access_method_ids",
38767
40419
  "display_name",
38768
40420
  "created_at"
38769
40421
  ],
38770
40422
  type: "object",
38771
- "x-undocumented": "Unreleased."
40423
+ "x-draft": "Early access.",
40424
+ "x-route-path": "/access_grants"
38772
40425
  },
38773
40426
  ok: { type: "boolean" }
38774
40427
  },
@@ -38818,7 +40471,13 @@ var openapi_default = {
38818
40471
  type: "string"
38819
40472
  },
38820
40473
  location_id: {
38821
- description: "ID of location to filter list of access grants by.",
40474
+ deprecated: true,
40475
+ format: "uuid",
40476
+ type: "string",
40477
+ "x-deprecated": "Use `space_id`."
40478
+ },
40479
+ space_id: {
40480
+ description: "ID of space to filter list of access grants by.",
38822
40481
  format: "uuid",
38823
40482
  type: "string"
38824
40483
  },
@@ -38862,9 +40521,10 @@ var openapi_default = {
38862
40521
  type: "string"
38863
40522
  },
38864
40523
  location_ids: {
38865
- description: "IDs of the locations to which access is being given.",
40524
+ deprecated: true,
38866
40525
  items: { format: "uuid", type: "string" },
38867
- type: "array"
40526
+ type: "array",
40527
+ "x-deprecated": "Use `space_ids`."
38868
40528
  },
38869
40529
  requested_access_methods: {
38870
40530
  description: "Access methods that the user requested for this access grant.",
@@ -38896,11 +40556,15 @@ var openapi_default = {
38896
40556
  "created_at",
38897
40557
  "created_access_method_ids"
38898
40558
  ],
38899
- type: "object",
38900
- "x-undocumented": "Unreleased."
40559
+ type: "object"
38901
40560
  },
38902
40561
  type: "array"
38903
40562
  },
40563
+ space_ids: {
40564
+ description: "IDs of the spaces to which access is being given.",
40565
+ items: { format: "uuid", type: "string" },
40566
+ type: "array"
40567
+ },
38904
40568
  user_identity_id: {
38905
40569
  description: "ID of user identity to which access is being granted.",
38906
40570
  format: "uuid",
@@ -38917,13 +40581,15 @@ var openapi_default = {
38917
40581
  "access_grant_id",
38918
40582
  "user_identity_id",
38919
40583
  "location_ids",
40584
+ "space_ids",
38920
40585
  "requested_access_methods",
38921
40586
  "access_method_ids",
38922
40587
  "display_name",
38923
40588
  "created_at"
38924
40589
  ],
38925
40590
  type: "object",
38926
- "x-undocumented": "Unreleased."
40591
+ "x-draft": "Early access.",
40592
+ "x-route-path": "/access_grants"
38927
40593
  },
38928
40594
  type: "array"
38929
40595
  },
@@ -39081,7 +40747,8 @@ var openapi_default = {
39081
40747
  "created_at"
39082
40748
  ],
39083
40749
  type: "object",
39084
- "x-undocumented": "Unreleased."
40750
+ "x-draft": "Early access.",
40751
+ "x-route-path": "/access_methods"
39085
40752
  },
39086
40753
  ok: { type: "boolean" }
39087
40754
  },
@@ -39186,7 +40853,8 @@ var openapi_default = {
39186
40853
  "created_at"
39187
40854
  ],
39188
40855
  type: "object",
39189
- "x-undocumented": "Unreleased."
40856
+ "x-draft": "Early access.",
40857
+ "x-route-path": "/access_methods"
39190
40858
  },
39191
40859
  type: "array"
39192
40860
  },