@seamapi/types 1.406.9 → 1.408.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.
- package/dist/connect.cjs +2314 -468
- package/dist/connect.cjs.map +1 -1
- package/dist/connect.d.cts +3939 -1272
- package/lib/seam/connect/internal/schemas.d.ts +1 -1
- package/lib/seam/connect/internal/schemas.js +1 -1
- package/lib/seam/connect/internal/schemas.js.map +1 -1
- package/lib/seam/connect/models/access-grants/access-grant.d.ts +3 -0
- package/lib/seam/connect/models/access-grants/access-grant.js +7 -2
- package/lib/seam/connect/models/access-grants/access-grant.js.map +1 -1
- package/lib/seam/connect/models/events/access-methods.d.ts +47 -0
- package/lib/seam/connect/models/events/access-methods.js +9 -0
- package/lib/seam/connect/models/events/access-methods.js.map +1 -1
- package/lib/seam/connect/models/events/seam-event.d.ts +24 -1
- package/lib/seam/connect/models/index.d.ts +1 -0
- package/lib/seam/connect/models/index.js +1 -0
- package/lib/seam/connect/models/index.js.map +1 -1
- package/lib/seam/connect/models/spaces/index.d.ts +1 -0
- package/lib/seam/connect/models/spaces/index.js +2 -0
- package/lib/seam/connect/models/spaces/index.js.map +1 -0
- package/lib/seam/connect/models/spaces/space.d.ts +21 -0
- package/lib/seam/connect/models/spaces/space.js +15 -0
- package/lib/seam/connect/models/spaces/space.js.map +1 -0
- package/lib/seam/connect/openapi.d.ts +5941 -3781
- package/lib/seam/connect/openapi.js +7334 -5497
- package/lib/seam/connect/openapi.js.map +1 -1
- package/lib/seam/connect/route-types.d.ts +499 -15
- package/package.json +2 -2
- package/src/lib/seam/connect/internal/schemas.ts +1 -0
- package/src/lib/seam/connect/models/access-grants/access-grant.ts +7 -2
- package/src/lib/seam/connect/models/events/access-methods.ts +10 -0
- package/src/lib/seam/connect/models/index.ts +1 -0
- package/src/lib/seam/connect/models/spaces/index.ts +1 -0
- package/src/lib/seam/connect/models/spaces/space.ts +19 -0
- package/src/lib/seam/connect/openapi.ts +7987 -6075
- package/src/lib/seam/connect/route-types.ts +506 -13
package/dist/connect.cjs
CHANGED
|
@@ -4237,10 +4237,19 @@ var access_method_revoked_event = access_method_event.extend({
|
|
|
4237
4237
|
---
|
|
4238
4238
|
An access method was revoked.
|
|
4239
4239
|
`);
|
|
4240
|
+
var access_method_deleted_event = access_method_event.extend({
|
|
4241
|
+
event_type: zod.z.literal("access_method.deleted")
|
|
4242
|
+
}).describe(`
|
|
4243
|
+
---
|
|
4244
|
+
route_path: /unstable_access_methods
|
|
4245
|
+
---
|
|
4246
|
+
An access method was deleted.
|
|
4247
|
+
`);
|
|
4240
4248
|
var access_method_events = [
|
|
4241
4249
|
access_method_issued_event,
|
|
4242
4250
|
access_method_revoked_event,
|
|
4243
|
-
access_method_card_encoding_required_event
|
|
4251
|
+
access_method_card_encoding_required_event,
|
|
4252
|
+
access_method_deleted_event
|
|
4244
4253
|
];
|
|
4245
4254
|
var common_acs_event = common_event.extend({
|
|
4246
4255
|
connected_account_id: zod.z.string().uuid().optional().describe("ID of the connected account."),
|
|
@@ -16281,6 +16290,47 @@ var openapi_default = {
|
|
|
16281
16290
|
type: "object",
|
|
16282
16291
|
"x-route-path": "/unstable_access_methods"
|
|
16283
16292
|
},
|
|
16293
|
+
{
|
|
16294
|
+
description: "An access method was deleted.",
|
|
16295
|
+
properties: {
|
|
16296
|
+
access_method_id: {
|
|
16297
|
+
description: "ID of the affected access method.",
|
|
16298
|
+
format: "uuid",
|
|
16299
|
+
type: "string"
|
|
16300
|
+
},
|
|
16301
|
+
created_at: {
|
|
16302
|
+
description: "Date and time at which the event was created.",
|
|
16303
|
+
format: "date-time",
|
|
16304
|
+
type: "string"
|
|
16305
|
+
},
|
|
16306
|
+
event_id: {
|
|
16307
|
+
description: "ID of the event.",
|
|
16308
|
+
format: "uuid",
|
|
16309
|
+
type: "string"
|
|
16310
|
+
},
|
|
16311
|
+
event_type: { enum: ["access_method.deleted"], type: "string" },
|
|
16312
|
+
occurred_at: {
|
|
16313
|
+
description: "Date and time at which the event occurred.",
|
|
16314
|
+
format: "date-time",
|
|
16315
|
+
type: "string"
|
|
16316
|
+
},
|
|
16317
|
+
workspace_id: {
|
|
16318
|
+
description: "ID of the workspace associated with the event.",
|
|
16319
|
+
format: "uuid",
|
|
16320
|
+
type: "string"
|
|
16321
|
+
}
|
|
16322
|
+
},
|
|
16323
|
+
required: [
|
|
16324
|
+
"event_id",
|
|
16325
|
+
"workspace_id",
|
|
16326
|
+
"created_at",
|
|
16327
|
+
"occurred_at",
|
|
16328
|
+
"access_method_id",
|
|
16329
|
+
"event_type"
|
|
16330
|
+
],
|
|
16331
|
+
type: "object",
|
|
16332
|
+
"x-route-path": "/unstable_access_methods"
|
|
16333
|
+
},
|
|
16284
16334
|
{
|
|
16285
16335
|
description: "An [access system](https://docs.seam.co/latest/capability-guides/access-systems) was connected.",
|
|
16286
16336
|
properties: {
|
|
@@ -25728,32 +25778,282 @@ var openapi_default = {
|
|
|
25728
25778
|
"x-title": "Update Multiple Linked Access Codes"
|
|
25729
25779
|
}
|
|
25730
25780
|
},
|
|
25731
|
-
"/
|
|
25781
|
+
"/access_grants/create": {
|
|
25732
25782
|
post: {
|
|
25733
|
-
description: "
|
|
25734
|
-
operationId: "
|
|
25783
|
+
description: "Creates a new access grant.",
|
|
25784
|
+
operationId: "accessGrantsCreatePost",
|
|
25735
25785
|
requestBody: {
|
|
25736
25786
|
content: {
|
|
25737
25787
|
"application/json": {
|
|
25738
25788
|
schema: {
|
|
25739
|
-
|
|
25740
|
-
|
|
25741
|
-
|
|
25742
|
-
|
|
25743
|
-
|
|
25789
|
+
allOf: [
|
|
25790
|
+
{
|
|
25791
|
+
oneOf: [
|
|
25792
|
+
{
|
|
25793
|
+
properties: {
|
|
25794
|
+
user_identity_id: {
|
|
25795
|
+
description: "ID of user identity for whom access is being granted.",
|
|
25796
|
+
format: "uuid",
|
|
25797
|
+
type: "string"
|
|
25798
|
+
}
|
|
25799
|
+
},
|
|
25800
|
+
required: ["user_identity_id"],
|
|
25801
|
+
type: "object"
|
|
25802
|
+
},
|
|
25803
|
+
{
|
|
25804
|
+
properties: {
|
|
25805
|
+
user_identity: {
|
|
25806
|
+
description: "When used, creates a new user identity with the given details, and grants them access.",
|
|
25807
|
+
properties: {
|
|
25808
|
+
email_address: {
|
|
25809
|
+
description: "Unique email address for the user identity.",
|
|
25810
|
+
format: "email",
|
|
25811
|
+
nullable: true,
|
|
25812
|
+
type: "string"
|
|
25813
|
+
},
|
|
25814
|
+
full_name: {
|
|
25815
|
+
minLength: 1,
|
|
25816
|
+
nullable: true,
|
|
25817
|
+
type: "string"
|
|
25818
|
+
},
|
|
25819
|
+
phone_number: {
|
|
25820
|
+
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).",
|
|
25821
|
+
nullable: true,
|
|
25822
|
+
type: "string"
|
|
25823
|
+
}
|
|
25824
|
+
},
|
|
25825
|
+
type: "object"
|
|
25826
|
+
}
|
|
25827
|
+
},
|
|
25828
|
+
required: ["user_identity"],
|
|
25829
|
+
type: "object"
|
|
25830
|
+
}
|
|
25831
|
+
]
|
|
25744
25832
|
},
|
|
25745
|
-
|
|
25746
|
-
|
|
25747
|
-
|
|
25748
|
-
|
|
25833
|
+
{
|
|
25834
|
+
properties: {
|
|
25835
|
+
acs_entrance_ids: {
|
|
25836
|
+
default: [],
|
|
25837
|
+
description: "Set of IDs of the [entrances](https://docs.seam.co/latest/api/acs/systems/list) to which access is being granted.",
|
|
25838
|
+
items: { format: "uuid", type: "string" },
|
|
25839
|
+
type: "array"
|
|
25840
|
+
},
|
|
25841
|
+
device_ids: {
|
|
25842
|
+
default: [],
|
|
25843
|
+
description: "Set of IDs of the [devices](https://docs.seam.co/latest/api/devices/list) to which access is being granted.",
|
|
25844
|
+
items: { format: "uuid", type: "string" },
|
|
25845
|
+
type: "array"
|
|
25846
|
+
},
|
|
25847
|
+
ends_at: {
|
|
25848
|
+
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`.",
|
|
25849
|
+
format: "date-time",
|
|
25850
|
+
type: "string"
|
|
25851
|
+
},
|
|
25852
|
+
location: {
|
|
25853
|
+
description: "When used, creates a new location with the given entrances and devices, and gives the user access to this location.",
|
|
25854
|
+
properties: {
|
|
25855
|
+
acs_entrance_ids: {
|
|
25856
|
+
default: [],
|
|
25857
|
+
deprecated: true,
|
|
25858
|
+
items: { format: "uuid", type: "string" },
|
|
25859
|
+
type: "array",
|
|
25860
|
+
"x-deprecated": "Use `acs_entrance_ids` at the top level."
|
|
25861
|
+
},
|
|
25862
|
+
device_ids: {
|
|
25863
|
+
default: [],
|
|
25864
|
+
deprecated: true,
|
|
25865
|
+
items: { format: "uuid", type: "string" },
|
|
25866
|
+
type: "array",
|
|
25867
|
+
"x-deprecated": "Use `device_ids` at the top level."
|
|
25868
|
+
},
|
|
25869
|
+
name: {
|
|
25870
|
+
description: "Name of the location.",
|
|
25871
|
+
type: "string"
|
|
25872
|
+
}
|
|
25873
|
+
},
|
|
25874
|
+
type: "object"
|
|
25875
|
+
},
|
|
25876
|
+
location_ids: {
|
|
25877
|
+
deprecated: true,
|
|
25878
|
+
items: { format: "uuid", type: "string" },
|
|
25879
|
+
type: "array",
|
|
25880
|
+
"x-deprecated": "Use `space_ids`."
|
|
25881
|
+
},
|
|
25882
|
+
requested_access_methods: {
|
|
25883
|
+
items: {
|
|
25884
|
+
properties: {
|
|
25885
|
+
mode: {
|
|
25886
|
+
description: "Access method mode. Supported values: `code`, `card`, `mobile_key`.",
|
|
25887
|
+
enum: ["code", "card", "mobile_key"],
|
|
25888
|
+
type: "string"
|
|
25889
|
+
}
|
|
25890
|
+
},
|
|
25891
|
+
required: ["mode"],
|
|
25892
|
+
type: "object"
|
|
25893
|
+
},
|
|
25894
|
+
type: "array"
|
|
25895
|
+
},
|
|
25896
|
+
space_ids: {
|
|
25897
|
+
description: "Set of IDs of existing spaces to which access is being granted.",
|
|
25898
|
+
items: { format: "uuid", type: "string" },
|
|
25899
|
+
type: "array"
|
|
25900
|
+
},
|
|
25901
|
+
starts_at: {
|
|
25902
|
+
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.",
|
|
25903
|
+
format: "date-time",
|
|
25904
|
+
type: "string"
|
|
25905
|
+
}
|
|
25906
|
+
},
|
|
25907
|
+
required: ["requested_access_methods"],
|
|
25908
|
+
type: "object"
|
|
25909
|
+
}
|
|
25910
|
+
]
|
|
25911
|
+
}
|
|
25912
|
+
}
|
|
25913
|
+
}
|
|
25914
|
+
},
|
|
25915
|
+
responses: {
|
|
25916
|
+
200: {
|
|
25917
|
+
content: {
|
|
25918
|
+
"application/json": {
|
|
25919
|
+
schema: {
|
|
25920
|
+
properties: {
|
|
25921
|
+
access_grant: {
|
|
25922
|
+
properties: {
|
|
25923
|
+
access_grant_id: {
|
|
25924
|
+
description: "ID of the access grant.",
|
|
25925
|
+
format: "uuid",
|
|
25926
|
+
type: "string"
|
|
25927
|
+
},
|
|
25928
|
+
access_method_ids: {
|
|
25929
|
+
description: "IDs of the access methods that were created for this access grant.",
|
|
25930
|
+
items: { format: "uuid", type: "string" },
|
|
25931
|
+
type: "array"
|
|
25932
|
+
},
|
|
25933
|
+
created_at: {
|
|
25934
|
+
description: "Date and time at which the access grant was created.",
|
|
25935
|
+
format: "date-time",
|
|
25936
|
+
type: "string"
|
|
25937
|
+
},
|
|
25938
|
+
display_name: {
|
|
25939
|
+
description: "Display name of the access grant.",
|
|
25940
|
+
type: "string"
|
|
25941
|
+
},
|
|
25942
|
+
location_ids: {
|
|
25943
|
+
deprecated: true,
|
|
25944
|
+
items: { format: "uuid", type: "string" },
|
|
25945
|
+
type: "array",
|
|
25946
|
+
"x-deprecated": "Use `space_ids`."
|
|
25947
|
+
},
|
|
25948
|
+
requested_access_methods: {
|
|
25949
|
+
description: "Access methods that the user requested for this access grant.",
|
|
25950
|
+
items: {
|
|
25951
|
+
properties: {
|
|
25952
|
+
created_access_method_ids: {
|
|
25953
|
+
description: "IDs of the access methods that were created for this requested access method.",
|
|
25954
|
+
items: { format: "uuid", type: "string" },
|
|
25955
|
+
type: "array"
|
|
25956
|
+
},
|
|
25957
|
+
created_at: {
|
|
25958
|
+
description: "Date and time at which the requested access method was added to this access grant.",
|
|
25959
|
+
format: "date-time",
|
|
25960
|
+
type: "string"
|
|
25961
|
+
},
|
|
25962
|
+
display_name: {
|
|
25963
|
+
description: "Display name of the access method.",
|
|
25964
|
+
type: "string"
|
|
25965
|
+
},
|
|
25966
|
+
mode: {
|
|
25967
|
+
description: "Access method mode. Supported values: `code`, `card`, `mobile_key`.",
|
|
25968
|
+
enum: ["code", "card", "mobile_key"],
|
|
25969
|
+
type: "string"
|
|
25970
|
+
}
|
|
25971
|
+
},
|
|
25972
|
+
required: [
|
|
25973
|
+
"display_name",
|
|
25974
|
+
"mode",
|
|
25975
|
+
"created_at",
|
|
25976
|
+
"created_access_method_ids"
|
|
25977
|
+
],
|
|
25978
|
+
type: "object",
|
|
25979
|
+
"x-undocumented": "Unreleased."
|
|
25980
|
+
},
|
|
25981
|
+
type: "array"
|
|
25982
|
+
},
|
|
25983
|
+
space_ids: {
|
|
25984
|
+
description: "IDs of the spaces to which access is being given.",
|
|
25985
|
+
items: { format: "uuid", type: "string" },
|
|
25986
|
+
type: "array"
|
|
25987
|
+
},
|
|
25988
|
+
user_identity_id: {
|
|
25989
|
+
description: "ID of user identity to which access is being granted.",
|
|
25990
|
+
format: "uuid",
|
|
25991
|
+
type: "string"
|
|
25992
|
+
},
|
|
25993
|
+
workspace_id: {
|
|
25994
|
+
description: "Unique identifier for the Seam workspace associated with the access grant.",
|
|
25995
|
+
format: "uuid",
|
|
25996
|
+
type: "string"
|
|
25997
|
+
}
|
|
25998
|
+
},
|
|
25999
|
+
required: [
|
|
26000
|
+
"workspace_id",
|
|
26001
|
+
"access_grant_id",
|
|
26002
|
+
"user_identity_id",
|
|
26003
|
+
"location_ids",
|
|
26004
|
+
"space_ids",
|
|
26005
|
+
"requested_access_methods",
|
|
26006
|
+
"access_method_ids",
|
|
26007
|
+
"display_name",
|
|
26008
|
+
"created_at"
|
|
26009
|
+
],
|
|
26010
|
+
type: "object",
|
|
26011
|
+
"x-undocumented": "Unreleased."
|
|
26012
|
+
},
|
|
26013
|
+
ok: { type: "boolean" }
|
|
25749
26014
|
},
|
|
25750
|
-
|
|
25751
|
-
|
|
26015
|
+
required: ["access_grant", "ok"],
|
|
26016
|
+
type: "object"
|
|
26017
|
+
}
|
|
26018
|
+
}
|
|
26019
|
+
},
|
|
26020
|
+
description: "OK"
|
|
26021
|
+
},
|
|
26022
|
+
400: { description: "Bad Request" },
|
|
26023
|
+
401: { description: "Unauthorized" }
|
|
26024
|
+
},
|
|
26025
|
+
security: [
|
|
26026
|
+
{ pat_with_workspace: [] },
|
|
26027
|
+
{ console_session_with_workspace: [] },
|
|
26028
|
+
{ api_key: [] },
|
|
26029
|
+
{ client_session_with_customer: [] }
|
|
26030
|
+
],
|
|
26031
|
+
summary: "/access_grants/create",
|
|
26032
|
+
tags: [],
|
|
26033
|
+
"x-fern-sdk-group-name": ["access_grants"],
|
|
26034
|
+
"x-fern-sdk-method-name": "create",
|
|
26035
|
+
"x-fern-sdk-return-value": "access_grant",
|
|
26036
|
+
"x-response-key": "access_grant",
|
|
26037
|
+
"x-title": "Create an Access Grant",
|
|
26038
|
+
"x-undocumented": "Unreleased."
|
|
26039
|
+
}
|
|
26040
|
+
},
|
|
26041
|
+
"/access_grants/delete": {
|
|
26042
|
+
post: {
|
|
26043
|
+
description: "Delete an access grant.",
|
|
26044
|
+
operationId: "accessGrantsDeletePost",
|
|
26045
|
+
requestBody: {
|
|
26046
|
+
content: {
|
|
26047
|
+
"application/json": {
|
|
26048
|
+
schema: {
|
|
26049
|
+
properties: {
|
|
26050
|
+
access_grant_id: {
|
|
26051
|
+
description: "ID of access grant to delete.",
|
|
25752
26052
|
format: "uuid",
|
|
25753
26053
|
type: "string"
|
|
25754
26054
|
}
|
|
25755
26055
|
},
|
|
25756
|
-
required: ["
|
|
26056
|
+
required: ["access_grant_id"],
|
|
25757
26057
|
type: "object"
|
|
25758
26058
|
}
|
|
25759
26059
|
}
|
|
@@ -25778,40 +26078,34 @@ var openapi_default = {
|
|
|
25778
26078
|
security: [
|
|
25779
26079
|
{ pat_with_workspace: [] },
|
|
25780
26080
|
{ console_session_with_workspace: [] },
|
|
25781
|
-
{ api_key: [] }
|
|
26081
|
+
{ api_key: [] },
|
|
26082
|
+
{ client_session_with_customer: [] }
|
|
25782
26083
|
],
|
|
25783
|
-
summary: "/
|
|
25784
|
-
tags: [
|
|
25785
|
-
"x-fern-sdk-group-name": ["
|
|
25786
|
-
"x-fern-sdk-method-name": "
|
|
26084
|
+
summary: "/access_grants/delete",
|
|
26085
|
+
tags: [],
|
|
26086
|
+
"x-fern-sdk-group-name": ["access_grants"],
|
|
26087
|
+
"x-fern-sdk-method-name": "delete",
|
|
25787
26088
|
"x-response-key": null,
|
|
25788
|
-
"x-title": "
|
|
25789
|
-
|
|
25790
|
-
|
|
25791
|
-
|
|
25792
|
-
|
|
26089
|
+
"x-title": "Delete an Access Grant",
|
|
26090
|
+
"x-undocumented": "Unreleased."
|
|
26091
|
+
}
|
|
26092
|
+
},
|
|
26093
|
+
"/access_grants/get": {
|
|
26094
|
+
post: {
|
|
26095
|
+
description: "Get an access grant.",
|
|
26096
|
+
operationId: "accessGrantsGetPost",
|
|
25793
26097
|
requestBody: {
|
|
25794
26098
|
content: {
|
|
25795
26099
|
"application/json": {
|
|
25796
26100
|
schema: {
|
|
25797
26101
|
properties: {
|
|
25798
|
-
|
|
25799
|
-
description: "ID of
|
|
25800
|
-
format: "uuid",
|
|
25801
|
-
type: "string"
|
|
25802
|
-
},
|
|
25803
|
-
acs_user_id: {
|
|
25804
|
-
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.",
|
|
25805
|
-
format: "uuid",
|
|
25806
|
-
type: "string"
|
|
25807
|
-
},
|
|
25808
|
-
user_identity_id: {
|
|
25809
|
-
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.",
|
|
26102
|
+
access_grant_id: {
|
|
26103
|
+
description: "ID of access grant to get.",
|
|
25810
26104
|
format: "uuid",
|
|
25811
26105
|
type: "string"
|
|
25812
26106
|
}
|
|
25813
26107
|
},
|
|
25814
|
-
required: ["
|
|
26108
|
+
required: ["access_grant_id"],
|
|
25815
26109
|
type: "object"
|
|
25816
26110
|
}
|
|
25817
26111
|
}
|
|
@@ -25822,8 +26116,102 @@ var openapi_default = {
|
|
|
25822
26116
|
content: {
|
|
25823
26117
|
"application/json": {
|
|
25824
26118
|
schema: {
|
|
25825
|
-
properties: {
|
|
25826
|
-
|
|
26119
|
+
properties: {
|
|
26120
|
+
access_grant: {
|
|
26121
|
+
properties: {
|
|
26122
|
+
access_grant_id: {
|
|
26123
|
+
description: "ID of the access grant.",
|
|
26124
|
+
format: "uuid",
|
|
26125
|
+
type: "string"
|
|
26126
|
+
},
|
|
26127
|
+
access_method_ids: {
|
|
26128
|
+
description: "IDs of the access methods that were created for this access grant.",
|
|
26129
|
+
items: { format: "uuid", type: "string" },
|
|
26130
|
+
type: "array"
|
|
26131
|
+
},
|
|
26132
|
+
created_at: {
|
|
26133
|
+
description: "Date and time at which the access grant was created.",
|
|
26134
|
+
format: "date-time",
|
|
26135
|
+
type: "string"
|
|
26136
|
+
},
|
|
26137
|
+
display_name: {
|
|
26138
|
+
description: "Display name of the access grant.",
|
|
26139
|
+
type: "string"
|
|
26140
|
+
},
|
|
26141
|
+
location_ids: {
|
|
26142
|
+
deprecated: true,
|
|
26143
|
+
items: { format: "uuid", type: "string" },
|
|
26144
|
+
type: "array",
|
|
26145
|
+
"x-deprecated": "Use `space_ids`."
|
|
26146
|
+
},
|
|
26147
|
+
requested_access_methods: {
|
|
26148
|
+
description: "Access methods that the user requested for this access grant.",
|
|
26149
|
+
items: {
|
|
26150
|
+
properties: {
|
|
26151
|
+
created_access_method_ids: {
|
|
26152
|
+
description: "IDs of the access methods that were created for this requested access method.",
|
|
26153
|
+
items: { format: "uuid", type: "string" },
|
|
26154
|
+
type: "array"
|
|
26155
|
+
},
|
|
26156
|
+
created_at: {
|
|
26157
|
+
description: "Date and time at which the requested access method was added to this access grant.",
|
|
26158
|
+
format: "date-time",
|
|
26159
|
+
type: "string"
|
|
26160
|
+
},
|
|
26161
|
+
display_name: {
|
|
26162
|
+
description: "Display name of the access method.",
|
|
26163
|
+
type: "string"
|
|
26164
|
+
},
|
|
26165
|
+
mode: {
|
|
26166
|
+
description: "Access method mode. Supported values: `code`, `card`, `mobile_key`.",
|
|
26167
|
+
enum: ["code", "card", "mobile_key"],
|
|
26168
|
+
type: "string"
|
|
26169
|
+
}
|
|
26170
|
+
},
|
|
26171
|
+
required: [
|
|
26172
|
+
"display_name",
|
|
26173
|
+
"mode",
|
|
26174
|
+
"created_at",
|
|
26175
|
+
"created_access_method_ids"
|
|
26176
|
+
],
|
|
26177
|
+
type: "object",
|
|
26178
|
+
"x-undocumented": "Unreleased."
|
|
26179
|
+
},
|
|
26180
|
+
type: "array"
|
|
26181
|
+
},
|
|
26182
|
+
space_ids: {
|
|
26183
|
+
description: "IDs of the spaces to which access is being given.",
|
|
26184
|
+
items: { format: "uuid", type: "string" },
|
|
26185
|
+
type: "array"
|
|
26186
|
+
},
|
|
26187
|
+
user_identity_id: {
|
|
26188
|
+
description: "ID of user identity to which access is being granted.",
|
|
26189
|
+
format: "uuid",
|
|
26190
|
+
type: "string"
|
|
26191
|
+
},
|
|
26192
|
+
workspace_id: {
|
|
26193
|
+
description: "Unique identifier for the Seam workspace associated with the access grant.",
|
|
26194
|
+
format: "uuid",
|
|
26195
|
+
type: "string"
|
|
26196
|
+
}
|
|
26197
|
+
},
|
|
26198
|
+
required: [
|
|
26199
|
+
"workspace_id",
|
|
26200
|
+
"access_grant_id",
|
|
26201
|
+
"user_identity_id",
|
|
26202
|
+
"location_ids",
|
|
26203
|
+
"space_ids",
|
|
26204
|
+
"requested_access_methods",
|
|
26205
|
+
"access_method_ids",
|
|
26206
|
+
"display_name",
|
|
26207
|
+
"created_at"
|
|
26208
|
+
],
|
|
26209
|
+
type: "object",
|
|
26210
|
+
"x-undocumented": "Unreleased."
|
|
26211
|
+
},
|
|
26212
|
+
ok: { type: "boolean" }
|
|
26213
|
+
},
|
|
26214
|
+
required: ["access_grant", "ok"],
|
|
25827
26215
|
type: "object"
|
|
25828
26216
|
}
|
|
25829
26217
|
}
|
|
@@ -25836,31 +26224,55 @@ var openapi_default = {
|
|
|
25836
26224
|
security: [
|
|
25837
26225
|
{ pat_with_workspace: [] },
|
|
25838
26226
|
{ console_session_with_workspace: [] },
|
|
25839
|
-
{ api_key: [] }
|
|
26227
|
+
{ api_key: [] },
|
|
26228
|
+
{ client_session_with_customer: [] }
|
|
25840
26229
|
],
|
|
25841
|
-
summary: "/
|
|
25842
|
-
tags: [
|
|
25843
|
-
"x-fern-
|
|
25844
|
-
"x-
|
|
25845
|
-
"x-
|
|
26230
|
+
summary: "/access_grants/get",
|
|
26231
|
+
tags: [],
|
|
26232
|
+
"x-fern-sdk-group-name": ["access_grants"],
|
|
26233
|
+
"x-fern-sdk-method-name": "get",
|
|
26234
|
+
"x-fern-sdk-return-value": "access_grant",
|
|
26235
|
+
"x-response-key": "access_grant",
|
|
26236
|
+
"x-title": "Get an Access Grant",
|
|
26237
|
+
"x-undocumented": "Unreleased."
|
|
25846
26238
|
}
|
|
25847
26239
|
},
|
|
25848
|
-
"/
|
|
26240
|
+
"/access_grants/list": {
|
|
25849
26241
|
post: {
|
|
25850
|
-
description: "
|
|
25851
|
-
operationId: "
|
|
26242
|
+
description: "Get an access grant.",
|
|
26243
|
+
operationId: "accessGrantsListPost",
|
|
25852
26244
|
requestBody: {
|
|
25853
26245
|
content: {
|
|
25854
26246
|
"application/json": {
|
|
25855
26247
|
schema: {
|
|
25856
26248
|
properties: {
|
|
25857
|
-
|
|
25858
|
-
description: "ID of
|
|
26249
|
+
acs_entrance_id: {
|
|
26250
|
+
description: "ID of entrance to filter list of access grants by.",
|
|
26251
|
+
format: "uuid",
|
|
26252
|
+
type: "string"
|
|
26253
|
+
},
|
|
26254
|
+
acs_system_id: {
|
|
26255
|
+
description: "ID of system to filter list of access grants by.",
|
|
26256
|
+
format: "uuid",
|
|
26257
|
+
type: "string"
|
|
26258
|
+
},
|
|
26259
|
+
location_id: {
|
|
26260
|
+
deprecated: true,
|
|
26261
|
+
format: "uuid",
|
|
26262
|
+
type: "string",
|
|
26263
|
+
"x-deprecated": "Use `space_id`."
|
|
26264
|
+
},
|
|
26265
|
+
space_id: {
|
|
26266
|
+
description: "ID of space to filter list of access grants by.",
|
|
26267
|
+
format: "uuid",
|
|
26268
|
+
type: "string"
|
|
26269
|
+
},
|
|
26270
|
+
user_identity_id: {
|
|
26271
|
+
description: "ID of user identity to filter list of access grants by.",
|
|
25859
26272
|
format: "uuid",
|
|
25860
26273
|
type: "string"
|
|
25861
26274
|
}
|
|
25862
26275
|
},
|
|
25863
|
-
required: ["acs_access_group_id"],
|
|
25864
26276
|
type: "object"
|
|
25865
26277
|
}
|
|
25866
26278
|
}
|
|
@@ -25872,12 +26284,104 @@ var openapi_default = {
|
|
|
25872
26284
|
"application/json": {
|
|
25873
26285
|
schema: {
|
|
25874
26286
|
properties: {
|
|
25875
|
-
|
|
25876
|
-
|
|
26287
|
+
access_grants: {
|
|
26288
|
+
items: {
|
|
26289
|
+
properties: {
|
|
26290
|
+
access_grant_id: {
|
|
26291
|
+
description: "ID of the access grant.",
|
|
26292
|
+
format: "uuid",
|
|
26293
|
+
type: "string"
|
|
26294
|
+
},
|
|
26295
|
+
access_method_ids: {
|
|
26296
|
+
description: "IDs of the access methods that were created for this access grant.",
|
|
26297
|
+
items: { format: "uuid", type: "string" },
|
|
26298
|
+
type: "array"
|
|
26299
|
+
},
|
|
26300
|
+
created_at: {
|
|
26301
|
+
description: "Date and time at which the access grant was created.",
|
|
26302
|
+
format: "date-time",
|
|
26303
|
+
type: "string"
|
|
26304
|
+
},
|
|
26305
|
+
display_name: {
|
|
26306
|
+
description: "Display name of the access grant.",
|
|
26307
|
+
type: "string"
|
|
26308
|
+
},
|
|
26309
|
+
location_ids: {
|
|
26310
|
+
deprecated: true,
|
|
26311
|
+
items: { format: "uuid", type: "string" },
|
|
26312
|
+
type: "array",
|
|
26313
|
+
"x-deprecated": "Use `space_ids`."
|
|
26314
|
+
},
|
|
26315
|
+
requested_access_methods: {
|
|
26316
|
+
description: "Access methods that the user requested for this access grant.",
|
|
26317
|
+
items: {
|
|
26318
|
+
properties: {
|
|
26319
|
+
created_access_method_ids: {
|
|
26320
|
+
description: "IDs of the access methods that were created for this requested access method.",
|
|
26321
|
+
items: { format: "uuid", type: "string" },
|
|
26322
|
+
type: "array"
|
|
26323
|
+
},
|
|
26324
|
+
created_at: {
|
|
26325
|
+
description: "Date and time at which the requested access method was added to this access grant.",
|
|
26326
|
+
format: "date-time",
|
|
26327
|
+
type: "string"
|
|
26328
|
+
},
|
|
26329
|
+
display_name: {
|
|
26330
|
+
description: "Display name of the access method.",
|
|
26331
|
+
type: "string"
|
|
26332
|
+
},
|
|
26333
|
+
mode: {
|
|
26334
|
+
description: "Access method mode. Supported values: `code`, `card`, `mobile_key`.",
|
|
26335
|
+
enum: ["code", "card", "mobile_key"],
|
|
26336
|
+
type: "string"
|
|
26337
|
+
}
|
|
26338
|
+
},
|
|
26339
|
+
required: [
|
|
26340
|
+
"display_name",
|
|
26341
|
+
"mode",
|
|
26342
|
+
"created_at",
|
|
26343
|
+
"created_access_method_ids"
|
|
26344
|
+
],
|
|
26345
|
+
type: "object",
|
|
26346
|
+
"x-undocumented": "Unreleased."
|
|
26347
|
+
},
|
|
26348
|
+
type: "array"
|
|
26349
|
+
},
|
|
26350
|
+
space_ids: {
|
|
26351
|
+
description: "IDs of the spaces to which access is being given.",
|
|
26352
|
+
items: { format: "uuid", type: "string" },
|
|
26353
|
+
type: "array"
|
|
26354
|
+
},
|
|
26355
|
+
user_identity_id: {
|
|
26356
|
+
description: "ID of user identity to which access is being granted.",
|
|
26357
|
+
format: "uuid",
|
|
26358
|
+
type: "string"
|
|
26359
|
+
},
|
|
26360
|
+
workspace_id: {
|
|
26361
|
+
description: "Unique identifier for the Seam workspace associated with the access grant.",
|
|
26362
|
+
format: "uuid",
|
|
26363
|
+
type: "string"
|
|
26364
|
+
}
|
|
26365
|
+
},
|
|
26366
|
+
required: [
|
|
26367
|
+
"workspace_id",
|
|
26368
|
+
"access_grant_id",
|
|
26369
|
+
"user_identity_id",
|
|
26370
|
+
"location_ids",
|
|
26371
|
+
"space_ids",
|
|
26372
|
+
"requested_access_methods",
|
|
26373
|
+
"access_method_ids",
|
|
26374
|
+
"display_name",
|
|
26375
|
+
"created_at"
|
|
26376
|
+
],
|
|
26377
|
+
type: "object",
|
|
26378
|
+
"x-undocumented": "Unreleased."
|
|
26379
|
+
},
|
|
26380
|
+
type: "array"
|
|
25877
26381
|
},
|
|
25878
26382
|
ok: { type: "boolean" }
|
|
25879
26383
|
},
|
|
25880
|
-
required: ["
|
|
26384
|
+
required: ["access_grants", "ok"],
|
|
25881
26385
|
type: "object"
|
|
25882
26386
|
}
|
|
25883
26387
|
}
|
|
@@ -25890,42 +26394,35 @@ var openapi_default = {
|
|
|
25890
26394
|
security: [
|
|
25891
26395
|
{ pat_with_workspace: [] },
|
|
25892
26396
|
{ console_session_with_workspace: [] },
|
|
25893
|
-
{ api_key: [] }
|
|
26397
|
+
{ api_key: [] },
|
|
26398
|
+
{ client_session_with_customer: [] }
|
|
25894
26399
|
],
|
|
25895
|
-
summary: "/
|
|
25896
|
-
tags: [
|
|
25897
|
-
"x-fern-sdk-group-name": ["
|
|
25898
|
-
"x-fern-sdk-method-name": "
|
|
25899
|
-
"x-fern-sdk-return-value": "
|
|
25900
|
-
"x-response-key": "
|
|
25901
|
-
"x-title": "
|
|
26400
|
+
summary: "/access_grants/list",
|
|
26401
|
+
tags: [],
|
|
26402
|
+
"x-fern-sdk-group-name": ["access_grants"],
|
|
26403
|
+
"x-fern-sdk-method-name": "list",
|
|
26404
|
+
"x-fern-sdk-return-value": "access_grants",
|
|
26405
|
+
"x-response-key": "access_grants",
|
|
26406
|
+
"x-title": "List Access Grants",
|
|
26407
|
+
"x-undocumented": "Unreleased."
|
|
25902
26408
|
}
|
|
25903
26409
|
},
|
|
25904
|
-
"/
|
|
26410
|
+
"/access_methods/delete": {
|
|
25905
26411
|
post: {
|
|
25906
|
-
description: "
|
|
25907
|
-
operationId: "
|
|
26412
|
+
description: "Delete an access method.",
|
|
26413
|
+
operationId: "accessMethodsDeletePost",
|
|
25908
26414
|
requestBody: {
|
|
25909
26415
|
content: {
|
|
25910
26416
|
"application/json": {
|
|
25911
26417
|
schema: {
|
|
25912
26418
|
properties: {
|
|
25913
|
-
|
|
25914
|
-
description: "ID of
|
|
25915
|
-
format: "uuid",
|
|
25916
|
-
type: "string"
|
|
25917
|
-
},
|
|
25918
|
-
acs_user_id: {
|
|
25919
|
-
description: "ID of the access system user for which you want to retrieve all access groups.",
|
|
25920
|
-
format: "uuid",
|
|
25921
|
-
type: "string"
|
|
25922
|
-
},
|
|
25923
|
-
user_identity_id: {
|
|
25924
|
-
description: "ID of the user identity for which you want to retrieve all access groups.",
|
|
26419
|
+
access_method_id: {
|
|
26420
|
+
description: "ID of access method to get.",
|
|
25925
26421
|
format: "uuid",
|
|
25926
26422
|
type: "string"
|
|
25927
26423
|
}
|
|
25928
26424
|
},
|
|
26425
|
+
required: ["access_method_id"],
|
|
25929
26426
|
type: "object"
|
|
25930
26427
|
}
|
|
25931
26428
|
}
|
|
@@ -25936,14 +26433,8 @@ var openapi_default = {
|
|
|
25936
26433
|
content: {
|
|
25937
26434
|
"application/json": {
|
|
25938
26435
|
schema: {
|
|
25939
|
-
properties: {
|
|
25940
|
-
|
|
25941
|
-
items: { $ref: "#/components/schemas/acs_access_group" },
|
|
25942
|
-
type: "array"
|
|
25943
|
-
},
|
|
25944
|
-
ok: { type: "boolean" }
|
|
25945
|
-
},
|
|
25946
|
-
required: ["acs_access_groups", "ok"],
|
|
26436
|
+
properties: { ok: { type: "boolean" } },
|
|
26437
|
+
required: ["ok"],
|
|
25947
26438
|
type: "object"
|
|
25948
26439
|
}
|
|
25949
26440
|
}
|
|
@@ -25958,31 +26449,31 @@ var openapi_default = {
|
|
|
25958
26449
|
{ console_session_with_workspace: [] },
|
|
25959
26450
|
{ api_key: [] }
|
|
25960
26451
|
],
|
|
25961
|
-
summary: "/
|
|
25962
|
-
tags: [
|
|
25963
|
-
"x-fern-sdk-group-name": ["
|
|
25964
|
-
"x-fern-sdk-method-name": "
|
|
25965
|
-
"x-
|
|
25966
|
-
"x-
|
|
25967
|
-
"x-
|
|
26452
|
+
summary: "/access_methods/delete",
|
|
26453
|
+
tags: [],
|
|
26454
|
+
"x-fern-sdk-group-name": ["access_methods"],
|
|
26455
|
+
"x-fern-sdk-method-name": "delete",
|
|
26456
|
+
"x-response-key": null,
|
|
26457
|
+
"x-title": "Delete an Access Method",
|
|
26458
|
+
"x-undocumented": "Unreleased."
|
|
25968
26459
|
}
|
|
25969
26460
|
},
|
|
25970
|
-
"/
|
|
26461
|
+
"/access_methods/get": {
|
|
25971
26462
|
post: {
|
|
25972
|
-
description: "
|
|
25973
|
-
operationId: "
|
|
26463
|
+
description: "Get an access method.",
|
|
26464
|
+
operationId: "accessMethodsGetPost",
|
|
25974
26465
|
requestBody: {
|
|
25975
26466
|
content: {
|
|
25976
26467
|
"application/json": {
|
|
25977
26468
|
schema: {
|
|
25978
26469
|
properties: {
|
|
25979
|
-
|
|
25980
|
-
description: "ID of
|
|
26470
|
+
access_method_id: {
|
|
26471
|
+
description: "ID of access method to get.",
|
|
25981
26472
|
format: "uuid",
|
|
25982
26473
|
type: "string"
|
|
25983
26474
|
}
|
|
25984
26475
|
},
|
|
25985
|
-
required: ["
|
|
26476
|
+
required: ["access_method_id"],
|
|
25986
26477
|
type: "object"
|
|
25987
26478
|
}
|
|
25988
26479
|
}
|
|
@@ -25994,13 +26485,59 @@ var openapi_default = {
|
|
|
25994
26485
|
"application/json": {
|
|
25995
26486
|
schema: {
|
|
25996
26487
|
properties: {
|
|
25997
|
-
|
|
25998
|
-
|
|
25999
|
-
|
|
26488
|
+
access_method: {
|
|
26489
|
+
properties: {
|
|
26490
|
+
access_method_id: {
|
|
26491
|
+
description: "ID of the access method.",
|
|
26492
|
+
format: "uuid",
|
|
26493
|
+
type: "string"
|
|
26494
|
+
},
|
|
26495
|
+
created_at: {
|
|
26496
|
+
description: "Date and time at which the access method was created.",
|
|
26497
|
+
format: "date-time",
|
|
26498
|
+
type: "string"
|
|
26499
|
+
},
|
|
26500
|
+
display_name: {
|
|
26501
|
+
description: "Display name of the access method.",
|
|
26502
|
+
type: "string"
|
|
26503
|
+
},
|
|
26504
|
+
instant_key_url: {
|
|
26505
|
+
description: "URL of instant key for mobile key access methods.",
|
|
26506
|
+
type: "string"
|
|
26507
|
+
},
|
|
26508
|
+
is_card_encoding_required: {
|
|
26509
|
+
description: "Whether card encoding is required for plastic card access methods.",
|
|
26510
|
+
type: "boolean"
|
|
26511
|
+
},
|
|
26512
|
+
issued_at: {
|
|
26513
|
+
description: "Date and time at which the access method was issued.",
|
|
26514
|
+
format: "date-time",
|
|
26515
|
+
type: "string"
|
|
26516
|
+
},
|
|
26517
|
+
mode: {
|
|
26518
|
+
description: "Access method mode. Supported values: `code`, `card`, `mobile_key`.",
|
|
26519
|
+
enum: ["code", "card", "mobile_key"],
|
|
26520
|
+
type: "string"
|
|
26521
|
+
},
|
|
26522
|
+
workspace_id: {
|
|
26523
|
+
description: "Unique identifier for the Seam workspace associated with the access grant.",
|
|
26524
|
+
format: "uuid",
|
|
26525
|
+
type: "string"
|
|
26526
|
+
}
|
|
26527
|
+
},
|
|
26528
|
+
required: [
|
|
26529
|
+
"workspace_id",
|
|
26530
|
+
"access_method_id",
|
|
26531
|
+
"display_name",
|
|
26532
|
+
"mode",
|
|
26533
|
+
"created_at"
|
|
26534
|
+
],
|
|
26535
|
+
type: "object",
|
|
26536
|
+
"x-undocumented": "Unreleased."
|
|
26000
26537
|
},
|
|
26001
26538
|
ok: { type: "boolean" }
|
|
26002
26539
|
},
|
|
26003
|
-
required: ["
|
|
26540
|
+
required: ["access_method", "ok"],
|
|
26004
26541
|
type: "object"
|
|
26005
26542
|
}
|
|
26006
26543
|
}
|
|
@@ -26011,35 +26548,36 @@ var openapi_default = {
|
|
|
26011
26548
|
401: { description: "Unauthorized" }
|
|
26012
26549
|
},
|
|
26013
26550
|
security: [
|
|
26014
|
-
{ api_key: [] },
|
|
26015
26551
|
{ pat_with_workspace: [] },
|
|
26016
|
-
{ console_session_with_workspace: [] }
|
|
26552
|
+
{ console_session_with_workspace: [] },
|
|
26553
|
+
{ api_key: [] }
|
|
26017
26554
|
],
|
|
26018
|
-
summary: "/
|
|
26019
|
-
tags: [
|
|
26020
|
-
"x-fern-sdk-group-name": ["
|
|
26021
|
-
"x-fern-sdk-method-name": "
|
|
26022
|
-
"x-fern-sdk-return-value": "
|
|
26023
|
-
"x-response-key": "
|
|
26024
|
-
"x-title": "
|
|
26555
|
+
summary: "/access_methods/get",
|
|
26556
|
+
tags: [],
|
|
26557
|
+
"x-fern-sdk-group-name": ["access_methods"],
|
|
26558
|
+
"x-fern-sdk-method-name": "get",
|
|
26559
|
+
"x-fern-sdk-return-value": "access_method",
|
|
26560
|
+
"x-response-key": "access_method",
|
|
26561
|
+
"x-title": "Get an Access Method",
|
|
26562
|
+
"x-undocumented": "Unreleased."
|
|
26025
26563
|
}
|
|
26026
26564
|
},
|
|
26027
|
-
"/
|
|
26565
|
+
"/access_methods/list": {
|
|
26028
26566
|
post: {
|
|
26029
|
-
description: "
|
|
26030
|
-
operationId: "
|
|
26567
|
+
description: "List all access methods, usually filtered by access grant.",
|
|
26568
|
+
operationId: "accessMethodsListPost",
|
|
26031
26569
|
requestBody: {
|
|
26032
26570
|
content: {
|
|
26033
26571
|
"application/json": {
|
|
26034
26572
|
schema: {
|
|
26035
26573
|
properties: {
|
|
26036
|
-
|
|
26037
|
-
description: "ID of
|
|
26574
|
+
access_grant_id: {
|
|
26575
|
+
description: "ID of access grant to list access methods for.",
|
|
26038
26576
|
format: "uuid",
|
|
26039
26577
|
type: "string"
|
|
26040
26578
|
}
|
|
26041
26579
|
},
|
|
26042
|
-
required: ["
|
|
26580
|
+
required: ["access_grant_id"],
|
|
26043
26581
|
type: "object"
|
|
26044
26582
|
}
|
|
26045
26583
|
}
|
|
@@ -26051,13 +26589,62 @@ var openapi_default = {
|
|
|
26051
26589
|
"application/json": {
|
|
26052
26590
|
schema: {
|
|
26053
26591
|
properties: {
|
|
26054
|
-
|
|
26055
|
-
items: {
|
|
26592
|
+
access_methods: {
|
|
26593
|
+
items: {
|
|
26594
|
+
properties: {
|
|
26595
|
+
access_method_id: {
|
|
26596
|
+
description: "ID of the access method.",
|
|
26597
|
+
format: "uuid",
|
|
26598
|
+
type: "string"
|
|
26599
|
+
},
|
|
26600
|
+
created_at: {
|
|
26601
|
+
description: "Date and time at which the access method was created.",
|
|
26602
|
+
format: "date-time",
|
|
26603
|
+
type: "string"
|
|
26604
|
+
},
|
|
26605
|
+
display_name: {
|
|
26606
|
+
description: "Display name of the access method.",
|
|
26607
|
+
type: "string"
|
|
26608
|
+
},
|
|
26609
|
+
instant_key_url: {
|
|
26610
|
+
description: "URL of instant key for mobile key access methods.",
|
|
26611
|
+
type: "string"
|
|
26612
|
+
},
|
|
26613
|
+
is_card_encoding_required: {
|
|
26614
|
+
description: "Whether card encoding is required for plastic card access methods.",
|
|
26615
|
+
type: "boolean"
|
|
26616
|
+
},
|
|
26617
|
+
issued_at: {
|
|
26618
|
+
description: "Date and time at which the access method was issued.",
|
|
26619
|
+
format: "date-time",
|
|
26620
|
+
type: "string"
|
|
26621
|
+
},
|
|
26622
|
+
mode: {
|
|
26623
|
+
description: "Access method mode. Supported values: `code`, `card`, `mobile_key`.",
|
|
26624
|
+
enum: ["code", "card", "mobile_key"],
|
|
26625
|
+
type: "string"
|
|
26626
|
+
},
|
|
26627
|
+
workspace_id: {
|
|
26628
|
+
description: "Unique identifier for the Seam workspace associated with the access grant.",
|
|
26629
|
+
format: "uuid",
|
|
26630
|
+
type: "string"
|
|
26631
|
+
}
|
|
26632
|
+
},
|
|
26633
|
+
required: [
|
|
26634
|
+
"workspace_id",
|
|
26635
|
+
"access_method_id",
|
|
26636
|
+
"display_name",
|
|
26637
|
+
"mode",
|
|
26638
|
+
"created_at"
|
|
26639
|
+
],
|
|
26640
|
+
type: "object",
|
|
26641
|
+
"x-undocumented": "Unreleased."
|
|
26642
|
+
},
|
|
26056
26643
|
type: "array"
|
|
26057
26644
|
},
|
|
26058
26645
|
ok: { type: "boolean" }
|
|
26059
26646
|
},
|
|
26060
|
-
required: ["
|
|
26647
|
+
required: ["access_methods", "ok"],
|
|
26061
26648
|
type: "object"
|
|
26062
26649
|
}
|
|
26063
26650
|
}
|
|
@@ -26072,36 +26659,37 @@ var openapi_default = {
|
|
|
26072
26659
|
{ console_session_with_workspace: [] },
|
|
26073
26660
|
{ api_key: [] }
|
|
26074
26661
|
],
|
|
26075
|
-
summary: "/
|
|
26076
|
-
tags: [
|
|
26077
|
-
"x-fern-sdk-group-name": ["
|
|
26078
|
-
"x-fern-sdk-method-name": "
|
|
26079
|
-
"x-fern-sdk-return-value": "
|
|
26080
|
-
"x-response-key": "
|
|
26081
|
-
"x-title": "List
|
|
26662
|
+
summary: "/access_methods/list",
|
|
26663
|
+
tags: [],
|
|
26664
|
+
"x-fern-sdk-group-name": ["access_methods"],
|
|
26665
|
+
"x-fern-sdk-method-name": "list",
|
|
26666
|
+
"x-fern-sdk-return-value": "access_methods",
|
|
26667
|
+
"x-response-key": "access_methods",
|
|
26668
|
+
"x-title": "List Access Methods",
|
|
26669
|
+
"x-undocumented": "Unreleased."
|
|
26082
26670
|
}
|
|
26083
26671
|
},
|
|
26084
|
-
"/acs/access_groups/
|
|
26672
|
+
"/acs/access_groups/add_user": {
|
|
26085
26673
|
post: {
|
|
26086
|
-
description: "
|
|
26087
|
-
operationId: "
|
|
26674
|
+
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).",
|
|
26675
|
+
operationId: "acsAccessGroupsAddUserPost",
|
|
26088
26676
|
requestBody: {
|
|
26089
26677
|
content: {
|
|
26090
26678
|
"application/json": {
|
|
26091
26679
|
schema: {
|
|
26092
26680
|
properties: {
|
|
26093
26681
|
acs_access_group_id: {
|
|
26094
|
-
description: "ID of the access group
|
|
26682
|
+
description: "ID of the access group to which you want to add an access system user.",
|
|
26095
26683
|
format: "uuid",
|
|
26096
26684
|
type: "string"
|
|
26097
26685
|
},
|
|
26098
26686
|
acs_user_id: {
|
|
26099
|
-
description: "ID of the access system user that you want to
|
|
26687
|
+
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.",
|
|
26100
26688
|
format: "uuid",
|
|
26101
26689
|
type: "string"
|
|
26102
26690
|
},
|
|
26103
26691
|
user_identity_id: {
|
|
26104
|
-
description: "ID of the user identity
|
|
26692
|
+
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.",
|
|
26105
26693
|
format: "uuid",
|
|
26106
26694
|
type: "string"
|
|
26107
26695
|
}
|
|
@@ -26133,30 +26721,383 @@ var openapi_default = {
|
|
|
26133
26721
|
{ console_session_with_workspace: [] },
|
|
26134
26722
|
{ api_key: [] }
|
|
26135
26723
|
],
|
|
26136
|
-
summary: "/acs/access_groups/
|
|
26724
|
+
summary: "/acs/access_groups/add_user",
|
|
26137
26725
|
tags: ["/acs"],
|
|
26138
26726
|
"x-fern-sdk-group-name": ["acs", "access_groups"],
|
|
26139
|
-
"x-fern-sdk-method-name": "
|
|
26727
|
+
"x-fern-sdk-method-name": "add_user",
|
|
26140
26728
|
"x-response-key": null,
|
|
26141
|
-
"x-title": "
|
|
26142
|
-
}
|
|
26143
|
-
|
|
26144
|
-
|
|
26145
|
-
|
|
26146
|
-
description: "Returns a specified unmanaged [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups).",
|
|
26147
|
-
operationId: "acsAccessGroupsUnmanagedGetPost",
|
|
26729
|
+
"x-title": "Add an ACS User to an Access Group"
|
|
26730
|
+
},
|
|
26731
|
+
put: {
|
|
26732
|
+
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).",
|
|
26733
|
+
operationId: "acsAccessGroupsAddUserPut",
|
|
26148
26734
|
requestBody: {
|
|
26149
26735
|
content: {
|
|
26150
26736
|
"application/json": {
|
|
26151
26737
|
schema: {
|
|
26152
26738
|
properties: {
|
|
26153
26739
|
acs_access_group_id: {
|
|
26154
|
-
description: "ID of the
|
|
26740
|
+
description: "ID of the access group to which you want to add an access system user.",
|
|
26155
26741
|
format: "uuid",
|
|
26156
26742
|
type: "string"
|
|
26157
|
-
}
|
|
26158
|
-
|
|
26159
|
-
|
|
26743
|
+
},
|
|
26744
|
+
acs_user_id: {
|
|
26745
|
+
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.",
|
|
26746
|
+
format: "uuid",
|
|
26747
|
+
type: "string"
|
|
26748
|
+
},
|
|
26749
|
+
user_identity_id: {
|
|
26750
|
+
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.",
|
|
26751
|
+
format: "uuid",
|
|
26752
|
+
type: "string"
|
|
26753
|
+
}
|
|
26754
|
+
},
|
|
26755
|
+
required: ["acs_access_group_id"],
|
|
26756
|
+
type: "object"
|
|
26757
|
+
}
|
|
26758
|
+
}
|
|
26759
|
+
}
|
|
26760
|
+
},
|
|
26761
|
+
responses: {
|
|
26762
|
+
200: {
|
|
26763
|
+
content: {
|
|
26764
|
+
"application/json": {
|
|
26765
|
+
schema: {
|
|
26766
|
+
properties: { ok: { type: "boolean" } },
|
|
26767
|
+
required: ["ok"],
|
|
26768
|
+
type: "object"
|
|
26769
|
+
}
|
|
26770
|
+
}
|
|
26771
|
+
},
|
|
26772
|
+
description: "OK"
|
|
26773
|
+
},
|
|
26774
|
+
400: { description: "Bad Request" },
|
|
26775
|
+
401: { description: "Unauthorized" }
|
|
26776
|
+
},
|
|
26777
|
+
security: [
|
|
26778
|
+
{ pat_with_workspace: [] },
|
|
26779
|
+
{ console_session_with_workspace: [] },
|
|
26780
|
+
{ api_key: [] }
|
|
26781
|
+
],
|
|
26782
|
+
summary: "/acs/access_groups/add_user",
|
|
26783
|
+
tags: ["/acs"],
|
|
26784
|
+
"x-fern-ignore": true,
|
|
26785
|
+
"x-response-key": null,
|
|
26786
|
+
"x-title": "Add an ACS User to an Access Group"
|
|
26787
|
+
}
|
|
26788
|
+
},
|
|
26789
|
+
"/acs/access_groups/get": {
|
|
26790
|
+
post: {
|
|
26791
|
+
description: "Returns a specified [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups).",
|
|
26792
|
+
operationId: "acsAccessGroupsGetPost",
|
|
26793
|
+
requestBody: {
|
|
26794
|
+
content: {
|
|
26795
|
+
"application/json": {
|
|
26796
|
+
schema: {
|
|
26797
|
+
properties: {
|
|
26798
|
+
acs_access_group_id: {
|
|
26799
|
+
description: "ID of the access group that you want to get.",
|
|
26800
|
+
format: "uuid",
|
|
26801
|
+
type: "string"
|
|
26802
|
+
}
|
|
26803
|
+
},
|
|
26804
|
+
required: ["acs_access_group_id"],
|
|
26805
|
+
type: "object"
|
|
26806
|
+
}
|
|
26807
|
+
}
|
|
26808
|
+
}
|
|
26809
|
+
},
|
|
26810
|
+
responses: {
|
|
26811
|
+
200: {
|
|
26812
|
+
content: {
|
|
26813
|
+
"application/json": {
|
|
26814
|
+
schema: {
|
|
26815
|
+
properties: {
|
|
26816
|
+
acs_access_group: {
|
|
26817
|
+
$ref: "#/components/schemas/acs_access_group"
|
|
26818
|
+
},
|
|
26819
|
+
ok: { type: "boolean" }
|
|
26820
|
+
},
|
|
26821
|
+
required: ["acs_access_group", "ok"],
|
|
26822
|
+
type: "object"
|
|
26823
|
+
}
|
|
26824
|
+
}
|
|
26825
|
+
},
|
|
26826
|
+
description: "OK"
|
|
26827
|
+
},
|
|
26828
|
+
400: { description: "Bad Request" },
|
|
26829
|
+
401: { description: "Unauthorized" }
|
|
26830
|
+
},
|
|
26831
|
+
security: [
|
|
26832
|
+
{ pat_with_workspace: [] },
|
|
26833
|
+
{ console_session_with_workspace: [] },
|
|
26834
|
+
{ api_key: [] }
|
|
26835
|
+
],
|
|
26836
|
+
summary: "/acs/access_groups/get",
|
|
26837
|
+
tags: ["/acs"],
|
|
26838
|
+
"x-fern-sdk-group-name": ["acs", "access_groups"],
|
|
26839
|
+
"x-fern-sdk-method-name": "get",
|
|
26840
|
+
"x-fern-sdk-return-value": "acs_access_group",
|
|
26841
|
+
"x-response-key": "acs_access_group",
|
|
26842
|
+
"x-title": "Get an Access Group"
|
|
26843
|
+
}
|
|
26844
|
+
},
|
|
26845
|
+
"/acs/access_groups/list": {
|
|
26846
|
+
post: {
|
|
26847
|
+
description: "Returns a list of all [access groups](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups).",
|
|
26848
|
+
operationId: "acsAccessGroupsListPost",
|
|
26849
|
+
requestBody: {
|
|
26850
|
+
content: {
|
|
26851
|
+
"application/json": {
|
|
26852
|
+
schema: {
|
|
26853
|
+
properties: {
|
|
26854
|
+
acs_system_id: {
|
|
26855
|
+
description: "ID of the access system for which you want to retrieve all access groups.",
|
|
26856
|
+
format: "uuid",
|
|
26857
|
+
type: "string"
|
|
26858
|
+
},
|
|
26859
|
+
acs_user_id: {
|
|
26860
|
+
description: "ID of the access system user for which you want to retrieve all access groups.",
|
|
26861
|
+
format: "uuid",
|
|
26862
|
+
type: "string"
|
|
26863
|
+
},
|
|
26864
|
+
user_identity_id: {
|
|
26865
|
+
description: "ID of the user identity for which you want to retrieve all access groups.",
|
|
26866
|
+
format: "uuid",
|
|
26867
|
+
type: "string"
|
|
26868
|
+
}
|
|
26869
|
+
},
|
|
26870
|
+
type: "object"
|
|
26871
|
+
}
|
|
26872
|
+
}
|
|
26873
|
+
}
|
|
26874
|
+
},
|
|
26875
|
+
responses: {
|
|
26876
|
+
200: {
|
|
26877
|
+
content: {
|
|
26878
|
+
"application/json": {
|
|
26879
|
+
schema: {
|
|
26880
|
+
properties: {
|
|
26881
|
+
acs_access_groups: {
|
|
26882
|
+
items: { $ref: "#/components/schemas/acs_access_group" },
|
|
26883
|
+
type: "array"
|
|
26884
|
+
},
|
|
26885
|
+
ok: { type: "boolean" }
|
|
26886
|
+
},
|
|
26887
|
+
required: ["acs_access_groups", "ok"],
|
|
26888
|
+
type: "object"
|
|
26889
|
+
}
|
|
26890
|
+
}
|
|
26891
|
+
},
|
|
26892
|
+
description: "OK"
|
|
26893
|
+
},
|
|
26894
|
+
400: { description: "Bad Request" },
|
|
26895
|
+
401: { description: "Unauthorized" }
|
|
26896
|
+
},
|
|
26897
|
+
security: [
|
|
26898
|
+
{ pat_with_workspace: [] },
|
|
26899
|
+
{ console_session_with_workspace: [] },
|
|
26900
|
+
{ api_key: [] }
|
|
26901
|
+
],
|
|
26902
|
+
summary: "/acs/access_groups/list",
|
|
26903
|
+
tags: ["/acs"],
|
|
26904
|
+
"x-fern-sdk-group-name": ["acs", "access_groups"],
|
|
26905
|
+
"x-fern-sdk-method-name": "list",
|
|
26906
|
+
"x-fern-sdk-return-value": "acs_access_groups",
|
|
26907
|
+
"x-response-key": "acs_access_groups",
|
|
26908
|
+
"x-title": "List Access Groups"
|
|
26909
|
+
}
|
|
26910
|
+
},
|
|
26911
|
+
"/acs/access_groups/list_accessible_entrances": {
|
|
26912
|
+
post: {
|
|
26913
|
+
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).",
|
|
26914
|
+
operationId: "acsAccessGroupsListAccessibleEntrancesPost",
|
|
26915
|
+
requestBody: {
|
|
26916
|
+
content: {
|
|
26917
|
+
"application/json": {
|
|
26918
|
+
schema: {
|
|
26919
|
+
properties: {
|
|
26920
|
+
acs_access_group_id: {
|
|
26921
|
+
description: "ID of the access group for which you want to retrieve all accessible entrances.",
|
|
26922
|
+
format: "uuid",
|
|
26923
|
+
type: "string"
|
|
26924
|
+
}
|
|
26925
|
+
},
|
|
26926
|
+
required: ["acs_access_group_id"],
|
|
26927
|
+
type: "object"
|
|
26928
|
+
}
|
|
26929
|
+
}
|
|
26930
|
+
}
|
|
26931
|
+
},
|
|
26932
|
+
responses: {
|
|
26933
|
+
200: {
|
|
26934
|
+
content: {
|
|
26935
|
+
"application/json": {
|
|
26936
|
+
schema: {
|
|
26937
|
+
properties: {
|
|
26938
|
+
acs_entrances: {
|
|
26939
|
+
items: { $ref: "#/components/schemas/acs_entrance" },
|
|
26940
|
+
type: "array"
|
|
26941
|
+
},
|
|
26942
|
+
ok: { type: "boolean" }
|
|
26943
|
+
},
|
|
26944
|
+
required: ["acs_entrances", "ok"],
|
|
26945
|
+
type: "object"
|
|
26946
|
+
}
|
|
26947
|
+
}
|
|
26948
|
+
},
|
|
26949
|
+
description: "OK"
|
|
26950
|
+
},
|
|
26951
|
+
400: { description: "Bad Request" },
|
|
26952
|
+
401: { description: "Unauthorized" }
|
|
26953
|
+
},
|
|
26954
|
+
security: [
|
|
26955
|
+
{ api_key: [] },
|
|
26956
|
+
{ pat_with_workspace: [] },
|
|
26957
|
+
{ console_session_with_workspace: [] }
|
|
26958
|
+
],
|
|
26959
|
+
summary: "/acs/access_groups/list_accessible_entrances",
|
|
26960
|
+
tags: ["/acs"],
|
|
26961
|
+
"x-fern-sdk-group-name": ["acs", "access_groups"],
|
|
26962
|
+
"x-fern-sdk-method-name": "list_accessible_entrances",
|
|
26963
|
+
"x-fern-sdk-return-value": "acs_entrances",
|
|
26964
|
+
"x-response-key": "acs_entrances",
|
|
26965
|
+
"x-title": "List Entrances Accessible to an Access Group"
|
|
26966
|
+
}
|
|
26967
|
+
},
|
|
26968
|
+
"/acs/access_groups/list_users": {
|
|
26969
|
+
post: {
|
|
26970
|
+
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).",
|
|
26971
|
+
operationId: "acsAccessGroupsListUsersPost",
|
|
26972
|
+
requestBody: {
|
|
26973
|
+
content: {
|
|
26974
|
+
"application/json": {
|
|
26975
|
+
schema: {
|
|
26976
|
+
properties: {
|
|
26977
|
+
acs_access_group_id: {
|
|
26978
|
+
description: "ID of the access group for which you want to retrieve all access system users.",
|
|
26979
|
+
format: "uuid",
|
|
26980
|
+
type: "string"
|
|
26981
|
+
}
|
|
26982
|
+
},
|
|
26983
|
+
required: ["acs_access_group_id"],
|
|
26984
|
+
type: "object"
|
|
26985
|
+
}
|
|
26986
|
+
}
|
|
26987
|
+
}
|
|
26988
|
+
},
|
|
26989
|
+
responses: {
|
|
26990
|
+
200: {
|
|
26991
|
+
content: {
|
|
26992
|
+
"application/json": {
|
|
26993
|
+
schema: {
|
|
26994
|
+
properties: {
|
|
26995
|
+
acs_users: {
|
|
26996
|
+
items: { $ref: "#/components/schemas/acs_user" },
|
|
26997
|
+
type: "array"
|
|
26998
|
+
},
|
|
26999
|
+
ok: { type: "boolean" }
|
|
27000
|
+
},
|
|
27001
|
+
required: ["acs_users", "ok"],
|
|
27002
|
+
type: "object"
|
|
27003
|
+
}
|
|
27004
|
+
}
|
|
27005
|
+
},
|
|
27006
|
+
description: "OK"
|
|
27007
|
+
},
|
|
27008
|
+
400: { description: "Bad Request" },
|
|
27009
|
+
401: { description: "Unauthorized" }
|
|
27010
|
+
},
|
|
27011
|
+
security: [
|
|
27012
|
+
{ pat_with_workspace: [] },
|
|
27013
|
+
{ console_session_with_workspace: [] },
|
|
27014
|
+
{ api_key: [] }
|
|
27015
|
+
],
|
|
27016
|
+
summary: "/acs/access_groups/list_users",
|
|
27017
|
+
tags: ["/acs"],
|
|
27018
|
+
"x-fern-sdk-group-name": ["acs", "access_groups"],
|
|
27019
|
+
"x-fern-sdk-method-name": "list_users",
|
|
27020
|
+
"x-fern-sdk-return-value": "acs_users",
|
|
27021
|
+
"x-response-key": "acs_users",
|
|
27022
|
+
"x-title": "List ACS Users in an Access Group"
|
|
27023
|
+
}
|
|
27024
|
+
},
|
|
27025
|
+
"/acs/access_groups/remove_user": {
|
|
27026
|
+
post: {
|
|
27027
|
+
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).",
|
|
27028
|
+
operationId: "acsAccessGroupsRemoveUserPost",
|
|
27029
|
+
requestBody: {
|
|
27030
|
+
content: {
|
|
27031
|
+
"application/json": {
|
|
27032
|
+
schema: {
|
|
27033
|
+
properties: {
|
|
27034
|
+
acs_access_group_id: {
|
|
27035
|
+
description: "ID of the access group from which you want to remove an access system user.",
|
|
27036
|
+
format: "uuid",
|
|
27037
|
+
type: "string"
|
|
27038
|
+
},
|
|
27039
|
+
acs_user_id: {
|
|
27040
|
+
description: "ID of the access system user that you want to remove from an access group.",
|
|
27041
|
+
format: "uuid",
|
|
27042
|
+
type: "string"
|
|
27043
|
+
},
|
|
27044
|
+
user_identity_id: {
|
|
27045
|
+
description: "ID of the user identity associated with the user that you want to remove from an access group.",
|
|
27046
|
+
format: "uuid",
|
|
27047
|
+
type: "string"
|
|
27048
|
+
}
|
|
27049
|
+
},
|
|
27050
|
+
required: ["acs_access_group_id"],
|
|
27051
|
+
type: "object"
|
|
27052
|
+
}
|
|
27053
|
+
}
|
|
27054
|
+
}
|
|
27055
|
+
},
|
|
27056
|
+
responses: {
|
|
27057
|
+
200: {
|
|
27058
|
+
content: {
|
|
27059
|
+
"application/json": {
|
|
27060
|
+
schema: {
|
|
27061
|
+
properties: { ok: { type: "boolean" } },
|
|
27062
|
+
required: ["ok"],
|
|
27063
|
+
type: "object"
|
|
27064
|
+
}
|
|
27065
|
+
}
|
|
27066
|
+
},
|
|
27067
|
+
description: "OK"
|
|
27068
|
+
},
|
|
27069
|
+
400: { description: "Bad Request" },
|
|
27070
|
+
401: { description: "Unauthorized" }
|
|
27071
|
+
},
|
|
27072
|
+
security: [
|
|
27073
|
+
{ pat_with_workspace: [] },
|
|
27074
|
+
{ console_session_with_workspace: [] },
|
|
27075
|
+
{ api_key: [] }
|
|
27076
|
+
],
|
|
27077
|
+
summary: "/acs/access_groups/remove_user",
|
|
27078
|
+
tags: ["/acs"],
|
|
27079
|
+
"x-fern-sdk-group-name": ["acs", "access_groups"],
|
|
27080
|
+
"x-fern-sdk-method-name": "remove_user",
|
|
27081
|
+
"x-response-key": null,
|
|
27082
|
+
"x-title": "Remove an ACS User from an Access Group"
|
|
27083
|
+
}
|
|
27084
|
+
},
|
|
27085
|
+
"/acs/access_groups/unmanaged/get": {
|
|
27086
|
+
post: {
|
|
27087
|
+
description: "Returns a specified unmanaged [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups).",
|
|
27088
|
+
operationId: "acsAccessGroupsUnmanagedGetPost",
|
|
27089
|
+
requestBody: {
|
|
27090
|
+
content: {
|
|
27091
|
+
"application/json": {
|
|
27092
|
+
schema: {
|
|
27093
|
+
properties: {
|
|
27094
|
+
acs_access_group_id: {
|
|
27095
|
+
description: "ID of the unmanaged access group that you want to get.",
|
|
27096
|
+
format: "uuid",
|
|
27097
|
+
type: "string"
|
|
27098
|
+
}
|
|
27099
|
+
},
|
|
27100
|
+
required: ["acs_access_group_id"],
|
|
26160
27101
|
type: "object"
|
|
26161
27102
|
}
|
|
26162
27103
|
}
|
|
@@ -28268,11 +29209,16 @@ var openapi_default = {
|
|
|
28268
29209
|
type: "string"
|
|
28269
29210
|
},
|
|
28270
29211
|
location_id: {
|
|
28271
|
-
|
|
29212
|
+
deprecated: true,
|
|
28272
29213
|
format: "uuid",
|
|
28273
29214
|
nullable: true,
|
|
28274
29215
|
type: "string",
|
|
28275
|
-
"x-
|
|
29216
|
+
"x-deprecated": "Use `space_id`."
|
|
29217
|
+
},
|
|
29218
|
+
space_id: {
|
|
29219
|
+
description: "ID of the space for which you want to list entrances.",
|
|
29220
|
+
format: "uuid",
|
|
29221
|
+
type: "string"
|
|
28276
29222
|
}
|
|
28277
29223
|
},
|
|
28278
29224
|
type: "object"
|
|
@@ -31480,12 +32426,17 @@ var openapi_default = {
|
|
|
31480
32426
|
nullable: true,
|
|
31481
32427
|
type: "string"
|
|
31482
32428
|
},
|
|
32429
|
+
space_id: {
|
|
32430
|
+
description: "ID of the space for which you want to list devices.",
|
|
32431
|
+
format: "uuid",
|
|
32432
|
+
type: "string"
|
|
32433
|
+
},
|
|
31483
32434
|
unstable_location_id: {
|
|
31484
|
-
|
|
32435
|
+
deprecated: true,
|
|
31485
32436
|
format: "uuid",
|
|
31486
32437
|
nullable: true,
|
|
31487
32438
|
type: "string",
|
|
31488
|
-
"x-
|
|
32439
|
+
"x-deprecated": "Use `space_id`."
|
|
31489
32440
|
},
|
|
31490
32441
|
user_identifier_key: {
|
|
31491
32442
|
description: "Your own internal user ID for the user for which you want to list devices.",
|
|
@@ -32071,12 +33022,17 @@ var openapi_default = {
|
|
|
32071
33022
|
nullable: true,
|
|
32072
33023
|
type: "string"
|
|
32073
33024
|
},
|
|
33025
|
+
space_id: {
|
|
33026
|
+
description: "ID of the space for which you want to list devices.",
|
|
33027
|
+
format: "uuid",
|
|
33028
|
+
type: "string"
|
|
33029
|
+
},
|
|
32074
33030
|
unstable_location_id: {
|
|
32075
|
-
|
|
33031
|
+
deprecated: true,
|
|
32076
33032
|
format: "uuid",
|
|
32077
33033
|
nullable: true,
|
|
32078
33034
|
type: "string",
|
|
32079
|
-
"x-
|
|
33035
|
+
"x-deprecated": "Use `space_id`."
|
|
32080
33036
|
},
|
|
32081
33037
|
user_identifier_key: {
|
|
32082
33038
|
description: "Your own internal user ID for the user for which you want to list devices.",
|
|
@@ -32555,6 +33511,7 @@ var openapi_default = {
|
|
|
32555
33511
|
"access_method.issued",
|
|
32556
33512
|
"access_method.revoked",
|
|
32557
33513
|
"access_method.card_encoding_required",
|
|
33514
|
+
"access_method.deleted",
|
|
32558
33515
|
"acs_system.connected",
|
|
32559
33516
|
"acs_system.added",
|
|
32560
33517
|
"acs_system.disconnected",
|
|
@@ -32650,6 +33607,7 @@ var openapi_default = {
|
|
|
32650
33607
|
"access_method.issued",
|
|
32651
33608
|
"access_method.revoked",
|
|
32652
33609
|
"access_method.card_encoding_required",
|
|
33610
|
+
"access_method.deleted",
|
|
32653
33611
|
"acs_system.connected",
|
|
32654
33612
|
"acs_system.added",
|
|
32655
33613
|
"acs_system.disconnected",
|
|
@@ -33037,12 +33995,17 @@ var openapi_default = {
|
|
|
33037
33995
|
nullable: true,
|
|
33038
33996
|
type: "string"
|
|
33039
33997
|
},
|
|
33998
|
+
space_id: {
|
|
33999
|
+
description: "ID of the space for which you want to list devices.",
|
|
34000
|
+
format: "uuid",
|
|
34001
|
+
type: "string"
|
|
34002
|
+
},
|
|
33040
34003
|
unstable_location_id: {
|
|
33041
|
-
|
|
34004
|
+
deprecated: true,
|
|
33042
34005
|
format: "uuid",
|
|
33043
34006
|
nullable: true,
|
|
33044
34007
|
type: "string",
|
|
33045
|
-
"x-
|
|
34008
|
+
"x-deprecated": "Use `space_id`."
|
|
33046
34009
|
},
|
|
33047
34010
|
user_identifier_key: {
|
|
33048
34011
|
description: "Your own internal user ID for the user for which you want to list devices.",
|
|
@@ -33549,12 +34512,17 @@ var openapi_default = {
|
|
|
33549
34512
|
nullable: true,
|
|
33550
34513
|
type: "string"
|
|
33551
34514
|
},
|
|
34515
|
+
space_id: {
|
|
34516
|
+
description: "ID of the space for which you want to list devices.",
|
|
34517
|
+
format: "uuid",
|
|
34518
|
+
type: "string"
|
|
34519
|
+
},
|
|
33552
34520
|
unstable_location_id: {
|
|
33553
|
-
|
|
34521
|
+
deprecated: true,
|
|
33554
34522
|
format: "uuid",
|
|
33555
34523
|
nullable: true,
|
|
33556
34524
|
type: "string",
|
|
33557
|
-
"x-
|
|
34525
|
+
"x-deprecated": "Use `space_id`."
|
|
33558
34526
|
},
|
|
33559
34527
|
user_identifier_key: {
|
|
33560
34528
|
description: "Your own internal user ID for the user for which you want to list devices.",
|
|
@@ -35364,8 +36332,903 @@ var openapi_default = {
|
|
|
35364
36332
|
content: {
|
|
35365
36333
|
"application/json": {
|
|
35366
36334
|
schema: {
|
|
35367
|
-
properties: { ok: { type: "boolean" } },
|
|
35368
|
-
required: ["ok"],
|
|
36335
|
+
properties: { ok: { type: "boolean" } },
|
|
36336
|
+
required: ["ok"],
|
|
36337
|
+
type: "object"
|
|
36338
|
+
}
|
|
36339
|
+
}
|
|
36340
|
+
},
|
|
36341
|
+
description: "OK"
|
|
36342
|
+
},
|
|
36343
|
+
400: { description: "Bad Request" },
|
|
36344
|
+
401: { description: "Unauthorized" }
|
|
36345
|
+
},
|
|
36346
|
+
security: [{ bridge_client_session: [] }],
|
|
36347
|
+
summary: "/seam/bridge/v1/bridge_client_sessions/report_status",
|
|
36348
|
+
tags: [],
|
|
36349
|
+
"x-fern-sdk-group-name": [
|
|
36350
|
+
"seam",
|
|
36351
|
+
"bridge",
|
|
36352
|
+
"v1",
|
|
36353
|
+
"bridge_client_sessions"
|
|
36354
|
+
],
|
|
36355
|
+
"x-fern-sdk-method-name": "report_status",
|
|
36356
|
+
"x-response-key": null,
|
|
36357
|
+
"x-title": "Report a Bridge Client's Status",
|
|
36358
|
+
"x-undocumented": "Seam Bridge Client only."
|
|
36359
|
+
}
|
|
36360
|
+
},
|
|
36361
|
+
"/seam/bridge/v1/bridge_connected_systems/list": {
|
|
36362
|
+
get: {
|
|
36363
|
+
description: "Returns the bridge connected systems associated with the session token used.",
|
|
36364
|
+
operationId: "seamBridgeV1BridgeConnectedSystemsListGet",
|
|
36365
|
+
responses: {
|
|
36366
|
+
200: {
|
|
36367
|
+
content: {
|
|
36368
|
+
"application/json": {
|
|
36369
|
+
schema: {
|
|
36370
|
+
properties: {
|
|
36371
|
+
bridge_connected_systems: {
|
|
36372
|
+
items: {
|
|
36373
|
+
properties: {
|
|
36374
|
+
acs_system_display_name: { type: "string" },
|
|
36375
|
+
acs_system_id: { format: "uuid", type: "string" },
|
|
36376
|
+
bridge_created_at: {
|
|
36377
|
+
format: "date-time",
|
|
36378
|
+
type: "string"
|
|
36379
|
+
},
|
|
36380
|
+
bridge_id: { format: "uuid", type: "string" },
|
|
36381
|
+
connected_account_created_at: {
|
|
36382
|
+
format: "date-time",
|
|
36383
|
+
type: "string"
|
|
36384
|
+
},
|
|
36385
|
+
connected_account_id: {
|
|
36386
|
+
format: "uuid",
|
|
36387
|
+
type: "string"
|
|
36388
|
+
},
|
|
36389
|
+
workspace_display_name: { type: "string" },
|
|
36390
|
+
workspace_id: { format: "uuid", type: "string" }
|
|
36391
|
+
},
|
|
36392
|
+
required: [
|
|
36393
|
+
"bridge_id",
|
|
36394
|
+
"bridge_created_at",
|
|
36395
|
+
"connected_account_id",
|
|
36396
|
+
"connected_account_created_at",
|
|
36397
|
+
"acs_system_id",
|
|
36398
|
+
"acs_system_display_name",
|
|
36399
|
+
"workspace_id",
|
|
36400
|
+
"workspace_display_name"
|
|
36401
|
+
],
|
|
36402
|
+
type: "object",
|
|
36403
|
+
"x-route-path": "/seam/bridge/v1/bridge_connected_systems",
|
|
36404
|
+
"x-undocumented": "Seam Bridge Client only."
|
|
36405
|
+
},
|
|
36406
|
+
type: "array"
|
|
36407
|
+
},
|
|
36408
|
+
ok: { type: "boolean" }
|
|
36409
|
+
},
|
|
36410
|
+
required: ["bridge_connected_systems", "ok"],
|
|
36411
|
+
type: "object"
|
|
36412
|
+
}
|
|
36413
|
+
}
|
|
36414
|
+
},
|
|
36415
|
+
description: "OK"
|
|
36416
|
+
},
|
|
36417
|
+
400: { description: "Bad Request" },
|
|
36418
|
+
401: { description: "Unauthorized" }
|
|
36419
|
+
},
|
|
36420
|
+
security: [{ bridge_client_session: [] }],
|
|
36421
|
+
summary: "/seam/bridge/v1/bridge_connected_systems/list",
|
|
36422
|
+
tags: [],
|
|
36423
|
+
"x-fern-ignore": true,
|
|
36424
|
+
"x-response-key": "bridge_connected_systems",
|
|
36425
|
+
"x-title": "List Bridge Connected Systems",
|
|
36426
|
+
"x-undocumented": "Seam Bridge Client only."
|
|
36427
|
+
},
|
|
36428
|
+
post: {
|
|
36429
|
+
description: "Returns the bridge connected systems associated with the session token used.",
|
|
36430
|
+
operationId: "seamBridgeV1BridgeConnectedSystemsListPost",
|
|
36431
|
+
responses: {
|
|
36432
|
+
200: {
|
|
36433
|
+
content: {
|
|
36434
|
+
"application/json": {
|
|
36435
|
+
schema: {
|
|
36436
|
+
properties: {
|
|
36437
|
+
bridge_connected_systems: {
|
|
36438
|
+
items: {
|
|
36439
|
+
properties: {
|
|
36440
|
+
acs_system_display_name: { type: "string" },
|
|
36441
|
+
acs_system_id: { format: "uuid", type: "string" },
|
|
36442
|
+
bridge_created_at: {
|
|
36443
|
+
format: "date-time",
|
|
36444
|
+
type: "string"
|
|
36445
|
+
},
|
|
36446
|
+
bridge_id: { format: "uuid", type: "string" },
|
|
36447
|
+
connected_account_created_at: {
|
|
36448
|
+
format: "date-time",
|
|
36449
|
+
type: "string"
|
|
36450
|
+
},
|
|
36451
|
+
connected_account_id: {
|
|
36452
|
+
format: "uuid",
|
|
36453
|
+
type: "string"
|
|
36454
|
+
},
|
|
36455
|
+
workspace_display_name: { type: "string" },
|
|
36456
|
+
workspace_id: { format: "uuid", type: "string" }
|
|
36457
|
+
},
|
|
36458
|
+
required: [
|
|
36459
|
+
"bridge_id",
|
|
36460
|
+
"bridge_created_at",
|
|
36461
|
+
"connected_account_id",
|
|
36462
|
+
"connected_account_created_at",
|
|
36463
|
+
"acs_system_id",
|
|
36464
|
+
"acs_system_display_name",
|
|
36465
|
+
"workspace_id",
|
|
36466
|
+
"workspace_display_name"
|
|
36467
|
+
],
|
|
36468
|
+
type: "object",
|
|
36469
|
+
"x-route-path": "/seam/bridge/v1/bridge_connected_systems",
|
|
36470
|
+
"x-undocumented": "Seam Bridge Client only."
|
|
36471
|
+
},
|
|
36472
|
+
type: "array"
|
|
36473
|
+
},
|
|
36474
|
+
ok: { type: "boolean" }
|
|
36475
|
+
},
|
|
36476
|
+
required: ["bridge_connected_systems", "ok"],
|
|
36477
|
+
type: "object"
|
|
36478
|
+
}
|
|
36479
|
+
}
|
|
36480
|
+
},
|
|
36481
|
+
description: "OK"
|
|
36482
|
+
},
|
|
36483
|
+
400: { description: "Bad Request" },
|
|
36484
|
+
401: { description: "Unauthorized" }
|
|
36485
|
+
},
|
|
36486
|
+
security: [{ bridge_client_session: [] }],
|
|
36487
|
+
summary: "/seam/bridge/v1/bridge_connected_systems/list",
|
|
36488
|
+
tags: [],
|
|
36489
|
+
"x-fern-sdk-group-name": [
|
|
36490
|
+
"seam",
|
|
36491
|
+
"bridge",
|
|
36492
|
+
"v1",
|
|
36493
|
+
"bridge_connected_systems"
|
|
36494
|
+
],
|
|
36495
|
+
"x-fern-sdk-method-name": "list",
|
|
36496
|
+
"x-fern-sdk-return-value": "bridge_connected_systems",
|
|
36497
|
+
"x-response-key": "bridge_connected_systems",
|
|
36498
|
+
"x-title": "List Bridge Connected Systems",
|
|
36499
|
+
"x-undocumented": "Seam Bridge Client only."
|
|
36500
|
+
}
|
|
36501
|
+
},
|
|
36502
|
+
"/seam/instant_key/v1/client_sessions/exchange_short_code": {
|
|
36503
|
+
post: {
|
|
36504
|
+
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.",
|
|
36505
|
+
operationId: "seamInstantKeyV1ClientSessionsExchangeShortCodePost",
|
|
36506
|
+
requestBody: {
|
|
36507
|
+
content: {
|
|
36508
|
+
"application/json": {
|
|
36509
|
+
schema: {
|
|
36510
|
+
properties: {
|
|
36511
|
+
short_code: {
|
|
36512
|
+
description: "The short code to exchange for a client session token",
|
|
36513
|
+
type: "string"
|
|
36514
|
+
}
|
|
36515
|
+
},
|
|
36516
|
+
required: ["short_code"],
|
|
36517
|
+
type: "object"
|
|
36518
|
+
}
|
|
36519
|
+
}
|
|
36520
|
+
}
|
|
36521
|
+
},
|
|
36522
|
+
responses: {
|
|
36523
|
+
200: {
|
|
36524
|
+
content: {
|
|
36525
|
+
"application/json": {
|
|
36526
|
+
schema: {
|
|
36527
|
+
properties: {
|
|
36528
|
+
client_session: {
|
|
36529
|
+
$ref: "#/components/schemas/client_session"
|
|
36530
|
+
},
|
|
36531
|
+
ok: { type: "boolean" }
|
|
36532
|
+
},
|
|
36533
|
+
required: ["client_session", "ok"],
|
|
36534
|
+
type: "object"
|
|
36535
|
+
}
|
|
36536
|
+
}
|
|
36537
|
+
},
|
|
36538
|
+
description: "OK"
|
|
36539
|
+
},
|
|
36540
|
+
400: { description: "Bad Request" },
|
|
36541
|
+
401: { description: "Unauthorized" }
|
|
36542
|
+
},
|
|
36543
|
+
security: [{ certified_client: [] }],
|
|
36544
|
+
summary: "/seam/instant_key/v1/client_sessions/exchange_short_code",
|
|
36545
|
+
tags: ["/client_sessions"],
|
|
36546
|
+
"x-fern-sdk-group-name": [
|
|
36547
|
+
"seam",
|
|
36548
|
+
"instant_key",
|
|
36549
|
+
"v1",
|
|
36550
|
+
"client_sessions"
|
|
36551
|
+
],
|
|
36552
|
+
"x-fern-sdk-method-name": "exchange_short_code",
|
|
36553
|
+
"x-fern-sdk-return-value": "client_session",
|
|
36554
|
+
"x-response-key": "client_session",
|
|
36555
|
+
"x-title": "Exchange Instant Key Short Code",
|
|
36556
|
+
"x-undocumented": "Seam Instant Key only."
|
|
36557
|
+
}
|
|
36558
|
+
},
|
|
36559
|
+
"/seam/mobile_sdk/v1/acs/credentials/list": {
|
|
36560
|
+
post: {
|
|
36561
|
+
description: "Returns a list of all ACS credentials.",
|
|
36562
|
+
operationId: "seamMobileSdkV1AcsCredentialsListPost",
|
|
36563
|
+
requestBody: {
|
|
36564
|
+
content: {
|
|
36565
|
+
"application/json": { schema: { properties: {}, type: "object" } }
|
|
36566
|
+
}
|
|
36567
|
+
},
|
|
36568
|
+
responses: {
|
|
36569
|
+
200: {
|
|
36570
|
+
content: {
|
|
36571
|
+
"application/json": {
|
|
36572
|
+
schema: {
|
|
36573
|
+
properties: {
|
|
36574
|
+
acs_credentials: {
|
|
36575
|
+
items: { $ref: "#/components/schemas/acs_credential" },
|
|
36576
|
+
type: "array"
|
|
36577
|
+
},
|
|
36578
|
+
ok: { type: "boolean" }
|
|
36579
|
+
},
|
|
36580
|
+
required: ["acs_credentials", "ok"],
|
|
36581
|
+
type: "object"
|
|
36582
|
+
}
|
|
36583
|
+
}
|
|
36584
|
+
},
|
|
36585
|
+
description: "OK"
|
|
36586
|
+
},
|
|
36587
|
+
400: { description: "Bad Request" },
|
|
36588
|
+
401: { description: "Unauthorized" }
|
|
36589
|
+
},
|
|
36590
|
+
security: [{ client_session: [] }],
|
|
36591
|
+
summary: "/seam/mobile_sdk/v1/acs/credentials/list",
|
|
36592
|
+
tags: ["/acs"],
|
|
36593
|
+
"x-fern-sdk-group-name": [
|
|
36594
|
+
"seam",
|
|
36595
|
+
"mobile_sdk",
|
|
36596
|
+
"v1",
|
|
36597
|
+
"acs",
|
|
36598
|
+
"credentials"
|
|
36599
|
+
],
|
|
36600
|
+
"x-fern-sdk-method-name": "list",
|
|
36601
|
+
"x-fern-sdk-return-value": "acs_credentials",
|
|
36602
|
+
"x-response-key": "acs_credentials",
|
|
36603
|
+
"x-title": "List Credentials",
|
|
36604
|
+
"x-undocumented": "Mobile SDK only."
|
|
36605
|
+
}
|
|
36606
|
+
},
|
|
36607
|
+
"/seam/mobile_sdk/v1/phone_sessions/get_or_create": {
|
|
36608
|
+
post: {
|
|
36609
|
+
description: "Get or create a session for a mobile SDK phone.",
|
|
36610
|
+
operationId: "seamMobileSdkV1PhoneSessionsGetOrCreatePost",
|
|
36611
|
+
requestBody: {
|
|
36612
|
+
content: {
|
|
36613
|
+
"application/json": {
|
|
36614
|
+
schema: {
|
|
36615
|
+
properties: {
|
|
36616
|
+
custom_sdk_installation_id: { type: "string" },
|
|
36617
|
+
phone_device_metadata: {
|
|
36618
|
+
properties: {
|
|
36619
|
+
manufacturer: { type: "string" },
|
|
36620
|
+
model: { type: "string" },
|
|
36621
|
+
os_version: { type: "string" }
|
|
36622
|
+
},
|
|
36623
|
+
type: "object"
|
|
36624
|
+
},
|
|
36625
|
+
phone_os: { enum: ["ios", "android"], type: "string" }
|
|
36626
|
+
},
|
|
36627
|
+
required: ["custom_sdk_installation_id", "phone_os"],
|
|
36628
|
+
type: "object"
|
|
36629
|
+
}
|
|
36630
|
+
}
|
|
36631
|
+
}
|
|
36632
|
+
},
|
|
36633
|
+
responses: {
|
|
36634
|
+
200: {
|
|
36635
|
+
content: {
|
|
36636
|
+
"application/json": {
|
|
36637
|
+
schema: {
|
|
36638
|
+
properties: {
|
|
36639
|
+
ok: { type: "boolean" },
|
|
36640
|
+
phone_session: {
|
|
36641
|
+
$ref: "#/components/schemas/phone_session"
|
|
36642
|
+
}
|
|
36643
|
+
},
|
|
36644
|
+
required: ["phone_session", "ok"],
|
|
36645
|
+
type: "object"
|
|
36646
|
+
}
|
|
36647
|
+
}
|
|
36648
|
+
},
|
|
36649
|
+
description: "OK"
|
|
36650
|
+
},
|
|
36651
|
+
400: { description: "Bad Request" },
|
|
36652
|
+
401: { description: "Unauthorized" }
|
|
36653
|
+
},
|
|
36654
|
+
security: [{ client_session: [] }],
|
|
36655
|
+
summary: "/seam/mobile_sdk/v1/phone_sessions/get_or_create",
|
|
36656
|
+
tags: [],
|
|
36657
|
+
"x-fern-sdk-group-name": ["seam", "mobile_sdk", "v1", "phone_sessions"],
|
|
36658
|
+
"x-fern-sdk-method-name": "get_or_create",
|
|
36659
|
+
"x-fern-sdk-return-value": "phone_session",
|
|
36660
|
+
"x-response-key": "phone_session",
|
|
36661
|
+
"x-title": "Get or Create a Phone Session",
|
|
36662
|
+
"x-undocumented": "Mobile SDK only."
|
|
36663
|
+
}
|
|
36664
|
+
},
|
|
36665
|
+
"/seam/partner/v1/building_blocks/spaces/auto_map": {
|
|
36666
|
+
post: {
|
|
36667
|
+
description: "Auto map partner resources that have been pushed to Seam.",
|
|
36668
|
+
operationId: "seamPartnerV1BuildingBlocksSpacesAutoMapPost",
|
|
36669
|
+
requestBody: {
|
|
36670
|
+
content: {
|
|
36671
|
+
"application/json": {
|
|
36672
|
+
schema: {
|
|
36673
|
+
properties: { collection_key: { type: "string" } },
|
|
36674
|
+
required: ["collection_key"],
|
|
36675
|
+
type: "object"
|
|
36676
|
+
}
|
|
36677
|
+
}
|
|
36678
|
+
}
|
|
36679
|
+
},
|
|
36680
|
+
responses: {
|
|
36681
|
+
200: {
|
|
36682
|
+
content: {
|
|
36683
|
+
"application/json": {
|
|
36684
|
+
schema: {
|
|
36685
|
+
properties: {
|
|
36686
|
+
ok: { type: "boolean" },
|
|
36687
|
+
spaces: {
|
|
36688
|
+
items: {
|
|
36689
|
+
properties: {
|
|
36690
|
+
acs_entrances: {
|
|
36691
|
+
items: {
|
|
36692
|
+
properties: {
|
|
36693
|
+
acs_entrance_id: { type: "string" },
|
|
36694
|
+
name: { type: "string" }
|
|
36695
|
+
},
|
|
36696
|
+
required: ["acs_entrance_id", "name"],
|
|
36697
|
+
type: "object"
|
|
36698
|
+
},
|
|
36699
|
+
type: "array"
|
|
36700
|
+
},
|
|
36701
|
+
devices: {
|
|
36702
|
+
items: {
|
|
36703
|
+
properties: {
|
|
36704
|
+
device_id: { type: "string" },
|
|
36705
|
+
device_type: {
|
|
36706
|
+
enum: ["lock", "thermostat", "sensor"],
|
|
36707
|
+
type: "string"
|
|
36708
|
+
},
|
|
36709
|
+
name: { type: "string" }
|
|
36710
|
+
},
|
|
36711
|
+
required: ["device_id", "device_type", "name"],
|
|
36712
|
+
type: "object"
|
|
36713
|
+
},
|
|
36714
|
+
type: "array"
|
|
36715
|
+
},
|
|
36716
|
+
name: { type: "string" },
|
|
36717
|
+
needs_review: { type: "boolean" },
|
|
36718
|
+
partner_resource_key: { type: "string" }
|
|
36719
|
+
},
|
|
36720
|
+
required: [
|
|
36721
|
+
"name",
|
|
36722
|
+
"partner_resource_key",
|
|
36723
|
+
"devices",
|
|
36724
|
+
"acs_entrances"
|
|
36725
|
+
],
|
|
36726
|
+
type: "object"
|
|
36727
|
+
},
|
|
36728
|
+
type: "array"
|
|
36729
|
+
}
|
|
36730
|
+
},
|
|
36731
|
+
required: ["spaces", "ok"],
|
|
36732
|
+
type: "object"
|
|
36733
|
+
}
|
|
36734
|
+
}
|
|
36735
|
+
},
|
|
36736
|
+
description: "OK"
|
|
36737
|
+
},
|
|
36738
|
+
400: { description: "Bad Request" },
|
|
36739
|
+
401: { description: "Unauthorized" }
|
|
36740
|
+
},
|
|
36741
|
+
security: [{ client_session_with_customer: [] }],
|
|
36742
|
+
summary: "/seam/partner/v1/building_blocks/spaces/auto_map",
|
|
36743
|
+
tags: [],
|
|
36744
|
+
"x-fern-sdk-group-name": [
|
|
36745
|
+
"seam",
|
|
36746
|
+
"partner",
|
|
36747
|
+
"v1",
|
|
36748
|
+
"building_blocks",
|
|
36749
|
+
"spaces"
|
|
36750
|
+
],
|
|
36751
|
+
"x-fern-sdk-method-name": "auto_map",
|
|
36752
|
+
"x-fern-sdk-return-value": "spaces",
|
|
36753
|
+
"x-response-key": "spaces",
|
|
36754
|
+
"x-title": "Do auto mapping for partner resources that map to spaces",
|
|
36755
|
+
"x-undocumented": "Partner building blocks/UI only."
|
|
36756
|
+
}
|
|
36757
|
+
},
|
|
36758
|
+
"/seam/partner/v1/resources/list": {
|
|
36759
|
+
post: {
|
|
36760
|
+
description: "List partner resources that have been pushed to Seam.",
|
|
36761
|
+
operationId: "seamPartnerV1ResourcesListPost",
|
|
36762
|
+
requestBody: {
|
|
36763
|
+
content: {
|
|
36764
|
+
"application/json": {
|
|
36765
|
+
schema: {
|
|
36766
|
+
properties: {
|
|
36767
|
+
resource_type_alias: {
|
|
36768
|
+
description: "Filter by resource type alias.",
|
|
36769
|
+
type: "string"
|
|
36770
|
+
}
|
|
36771
|
+
},
|
|
36772
|
+
type: "object"
|
|
36773
|
+
}
|
|
36774
|
+
}
|
|
36775
|
+
}
|
|
36776
|
+
},
|
|
36777
|
+
responses: {
|
|
36778
|
+
200: {
|
|
36779
|
+
content: {
|
|
36780
|
+
"application/json": {
|
|
36781
|
+
schema: {
|
|
36782
|
+
properties: {
|
|
36783
|
+
ok: { type: "boolean" },
|
|
36784
|
+
partner_resources: {
|
|
36785
|
+
items: {
|
|
36786
|
+
properties: {
|
|
36787
|
+
custom_metadata: {
|
|
36788
|
+
additionalProperties: { type: "string" },
|
|
36789
|
+
type: "object"
|
|
36790
|
+
},
|
|
36791
|
+
customer_key: { type: "string" },
|
|
36792
|
+
description: { type: "string" },
|
|
36793
|
+
email_address: { type: "string" },
|
|
36794
|
+
ends_at: { type: "string" },
|
|
36795
|
+
location_keys: {
|
|
36796
|
+
items: { type: "string" },
|
|
36797
|
+
type: "array"
|
|
36798
|
+
},
|
|
36799
|
+
name: { type: "string" },
|
|
36800
|
+
partner_resource_key: { type: "string" },
|
|
36801
|
+
partner_resource_type: { type: "string" },
|
|
36802
|
+
phone_number: { type: "string" },
|
|
36803
|
+
starts_at: { type: "string" },
|
|
36804
|
+
user_identity_key: { type: "string" }
|
|
36805
|
+
},
|
|
36806
|
+
required: [
|
|
36807
|
+
"partner_resource_type",
|
|
36808
|
+
"partner_resource_key",
|
|
36809
|
+
"customer_key"
|
|
36810
|
+
],
|
|
36811
|
+
type: "object",
|
|
36812
|
+
"x-route-path": "/unstable_partner/resources",
|
|
36813
|
+
"x-undocumented": "Unreleased."
|
|
36814
|
+
},
|
|
36815
|
+
type: "array"
|
|
36816
|
+
}
|
|
36817
|
+
},
|
|
36818
|
+
required: ["partner_resources", "ok"],
|
|
36819
|
+
type: "object"
|
|
36820
|
+
}
|
|
36821
|
+
}
|
|
36822
|
+
},
|
|
36823
|
+
description: "OK"
|
|
36824
|
+
},
|
|
36825
|
+
400: { description: "Bad Request" },
|
|
36826
|
+
401: { description: "Unauthorized" }
|
|
36827
|
+
},
|
|
36828
|
+
security: [{ client_session_with_customer: [] }],
|
|
36829
|
+
summary: "/seam/partner/v1/resources/list",
|
|
36830
|
+
tags: [],
|
|
36831
|
+
"x-fern-sdk-group-name": ["seam", "partner", "v1", "resources"],
|
|
36832
|
+
"x-fern-sdk-method-name": "list",
|
|
36833
|
+
"x-fern-sdk-return-value": "partner_resources",
|
|
36834
|
+
"x-response-key": "partner_resources",
|
|
36835
|
+
"x-title": "List partner resources at Seam",
|
|
36836
|
+
"x-undocumented": "Partner building blocks/UI only."
|
|
36837
|
+
}
|
|
36838
|
+
},
|
|
36839
|
+
"/spaces/add_acs_entrances": {
|
|
36840
|
+
post: {
|
|
36841
|
+
description: "Add entrances to a specific space.",
|
|
36842
|
+
operationId: "spacesAddAcsEntrancesPost",
|
|
36843
|
+
requestBody: {
|
|
36844
|
+
content: {
|
|
36845
|
+
"application/json": {
|
|
36846
|
+
schema: {
|
|
36847
|
+
properties: {
|
|
36848
|
+
acs_entrance_ids: {
|
|
36849
|
+
items: { format: "uuid", type: "string" },
|
|
36850
|
+
minItems: 1,
|
|
36851
|
+
type: "array"
|
|
36852
|
+
},
|
|
36853
|
+
space_id: { format: "uuid", type: "string" }
|
|
36854
|
+
},
|
|
36855
|
+
required: ["space_id", "acs_entrance_ids"],
|
|
36856
|
+
type: "object"
|
|
36857
|
+
}
|
|
36858
|
+
}
|
|
36859
|
+
}
|
|
36860
|
+
},
|
|
36861
|
+
responses: {
|
|
36862
|
+
200: {
|
|
36863
|
+
content: {
|
|
36864
|
+
"application/json": {
|
|
36865
|
+
schema: {
|
|
36866
|
+
properties: { ok: { type: "boolean" } },
|
|
36867
|
+
required: ["ok"],
|
|
36868
|
+
type: "object"
|
|
36869
|
+
}
|
|
36870
|
+
}
|
|
36871
|
+
},
|
|
36872
|
+
description: "OK"
|
|
36873
|
+
},
|
|
36874
|
+
400: { description: "Bad Request" },
|
|
36875
|
+
401: { description: "Unauthorized" }
|
|
36876
|
+
},
|
|
36877
|
+
security: [
|
|
36878
|
+
{ pat_with_workspace: [] },
|
|
36879
|
+
{ console_session_with_workspace: [] },
|
|
36880
|
+
{ api_key: [] }
|
|
36881
|
+
],
|
|
36882
|
+
summary: "/spaces/add_acs_entrances",
|
|
36883
|
+
tags: [],
|
|
36884
|
+
"x-fern-sdk-group-name": ["spaces"],
|
|
36885
|
+
"x-fern-sdk-method-name": "add_acs_entrances",
|
|
36886
|
+
"x-response-key": null,
|
|
36887
|
+
"x-title": "Add ACS Entrances"
|
|
36888
|
+
},
|
|
36889
|
+
put: {
|
|
36890
|
+
description: "Add entrances to a specific space.",
|
|
36891
|
+
operationId: "spacesAddAcsEntrancesPut",
|
|
36892
|
+
requestBody: {
|
|
36893
|
+
content: {
|
|
36894
|
+
"application/json": {
|
|
36895
|
+
schema: {
|
|
36896
|
+
properties: {
|
|
36897
|
+
acs_entrance_ids: {
|
|
36898
|
+
items: { format: "uuid", type: "string" },
|
|
36899
|
+
minItems: 1,
|
|
36900
|
+
type: "array"
|
|
36901
|
+
},
|
|
36902
|
+
space_id: { format: "uuid", type: "string" }
|
|
36903
|
+
},
|
|
36904
|
+
required: ["space_id", "acs_entrance_ids"],
|
|
36905
|
+
type: "object"
|
|
36906
|
+
}
|
|
36907
|
+
}
|
|
36908
|
+
}
|
|
36909
|
+
},
|
|
36910
|
+
responses: {
|
|
36911
|
+
200: {
|
|
36912
|
+
content: {
|
|
36913
|
+
"application/json": {
|
|
36914
|
+
schema: {
|
|
36915
|
+
properties: { ok: { type: "boolean" } },
|
|
36916
|
+
required: ["ok"],
|
|
36917
|
+
type: "object"
|
|
36918
|
+
}
|
|
36919
|
+
}
|
|
36920
|
+
},
|
|
36921
|
+
description: "OK"
|
|
36922
|
+
},
|
|
36923
|
+
400: { description: "Bad Request" },
|
|
36924
|
+
401: { description: "Unauthorized" }
|
|
36925
|
+
},
|
|
36926
|
+
security: [
|
|
36927
|
+
{ pat_with_workspace: [] },
|
|
36928
|
+
{ console_session_with_workspace: [] },
|
|
36929
|
+
{ api_key: [] }
|
|
36930
|
+
],
|
|
36931
|
+
summary: "/spaces/add_acs_entrances",
|
|
36932
|
+
tags: [],
|
|
36933
|
+
"x-fern-ignore": true,
|
|
36934
|
+
"x-response-key": null,
|
|
36935
|
+
"x-title": "Add ACS Entrances"
|
|
36936
|
+
}
|
|
36937
|
+
},
|
|
36938
|
+
"/spaces/add_devices": {
|
|
36939
|
+
post: {
|
|
36940
|
+
description: "Add devices to a specific space.",
|
|
36941
|
+
operationId: "spacesAddDevicesPost",
|
|
36942
|
+
requestBody: {
|
|
36943
|
+
content: {
|
|
36944
|
+
"application/json": {
|
|
36945
|
+
schema: {
|
|
36946
|
+
properties: {
|
|
36947
|
+
device_ids: {
|
|
36948
|
+
items: { format: "uuid", type: "string" },
|
|
36949
|
+
minItems: 1,
|
|
36950
|
+
type: "array"
|
|
36951
|
+
},
|
|
36952
|
+
space_id: { format: "uuid", type: "string" }
|
|
36953
|
+
},
|
|
36954
|
+
required: ["space_id", "device_ids"],
|
|
36955
|
+
type: "object"
|
|
36956
|
+
}
|
|
36957
|
+
}
|
|
36958
|
+
}
|
|
36959
|
+
},
|
|
36960
|
+
responses: {
|
|
36961
|
+
200: {
|
|
36962
|
+
content: {
|
|
36963
|
+
"application/json": {
|
|
36964
|
+
schema: {
|
|
36965
|
+
properties: { ok: { type: "boolean" } },
|
|
36966
|
+
required: ["ok"],
|
|
36967
|
+
type: "object"
|
|
36968
|
+
}
|
|
36969
|
+
}
|
|
36970
|
+
},
|
|
36971
|
+
description: "OK"
|
|
36972
|
+
},
|
|
36973
|
+
400: { description: "Bad Request" },
|
|
36974
|
+
401: { description: "Unauthorized" }
|
|
36975
|
+
},
|
|
36976
|
+
security: [
|
|
36977
|
+
{ pat_with_workspace: [] },
|
|
36978
|
+
{ console_session_with_workspace: [] },
|
|
36979
|
+
{ api_key: [] }
|
|
36980
|
+
],
|
|
36981
|
+
summary: "/spaces/add_devices",
|
|
36982
|
+
tags: [],
|
|
36983
|
+
"x-fern-sdk-group-name": ["spaces"],
|
|
36984
|
+
"x-fern-sdk-method-name": "add_devices",
|
|
36985
|
+
"x-response-key": null,
|
|
36986
|
+
"x-title": "Add Space Devices"
|
|
36987
|
+
},
|
|
36988
|
+
put: {
|
|
36989
|
+
description: "Add devices to a specific space.",
|
|
36990
|
+
operationId: "spacesAddDevicesPut",
|
|
36991
|
+
requestBody: {
|
|
36992
|
+
content: {
|
|
36993
|
+
"application/json": {
|
|
36994
|
+
schema: {
|
|
36995
|
+
properties: {
|
|
36996
|
+
device_ids: {
|
|
36997
|
+
items: { format: "uuid", type: "string" },
|
|
36998
|
+
minItems: 1,
|
|
36999
|
+
type: "array"
|
|
37000
|
+
},
|
|
37001
|
+
space_id: { format: "uuid", type: "string" }
|
|
37002
|
+
},
|
|
37003
|
+
required: ["space_id", "device_ids"],
|
|
37004
|
+
type: "object"
|
|
37005
|
+
}
|
|
37006
|
+
}
|
|
37007
|
+
}
|
|
37008
|
+
},
|
|
37009
|
+
responses: {
|
|
37010
|
+
200: {
|
|
37011
|
+
content: {
|
|
37012
|
+
"application/json": {
|
|
37013
|
+
schema: {
|
|
37014
|
+
properties: { ok: { type: "boolean" } },
|
|
37015
|
+
required: ["ok"],
|
|
37016
|
+
type: "object"
|
|
37017
|
+
}
|
|
37018
|
+
}
|
|
37019
|
+
},
|
|
37020
|
+
description: "OK"
|
|
37021
|
+
},
|
|
37022
|
+
400: { description: "Bad Request" },
|
|
37023
|
+
401: { description: "Unauthorized" }
|
|
37024
|
+
},
|
|
37025
|
+
security: [
|
|
37026
|
+
{ pat_with_workspace: [] },
|
|
37027
|
+
{ console_session_with_workspace: [] },
|
|
37028
|
+
{ api_key: [] }
|
|
37029
|
+
],
|
|
37030
|
+
summary: "/spaces/add_devices",
|
|
37031
|
+
tags: [],
|
|
37032
|
+
"x-fern-ignore": true,
|
|
37033
|
+
"x-response-key": null,
|
|
37034
|
+
"x-title": "Add Space Devices"
|
|
37035
|
+
}
|
|
37036
|
+
},
|
|
37037
|
+
"/spaces/create": {
|
|
37038
|
+
post: {
|
|
37039
|
+
description: "Create a new space.",
|
|
37040
|
+
operationId: "spacesCreatePost",
|
|
37041
|
+
requestBody: {
|
|
37042
|
+
content: {
|
|
37043
|
+
"application/json": {
|
|
37044
|
+
schema: {
|
|
37045
|
+
properties: {
|
|
37046
|
+
acs_entrance_ids: {
|
|
37047
|
+
items: { format: "uuid", type: "string" },
|
|
37048
|
+
type: "array"
|
|
37049
|
+
},
|
|
37050
|
+
device_ids: {
|
|
37051
|
+
items: { format: "uuid", type: "string" },
|
|
37052
|
+
type: "array"
|
|
37053
|
+
},
|
|
37054
|
+
name: { type: "string" }
|
|
37055
|
+
},
|
|
37056
|
+
required: ["name"],
|
|
37057
|
+
type: "object"
|
|
37058
|
+
}
|
|
37059
|
+
}
|
|
37060
|
+
}
|
|
37061
|
+
},
|
|
37062
|
+
responses: {
|
|
37063
|
+
200: {
|
|
37064
|
+
content: {
|
|
37065
|
+
"application/json": {
|
|
37066
|
+
schema: {
|
|
37067
|
+
properties: {
|
|
37068
|
+
ok: { type: "boolean" },
|
|
37069
|
+
space: {
|
|
37070
|
+
properties: {
|
|
37071
|
+
created_at: {
|
|
37072
|
+
description: "Date and time at which the space object was created.",
|
|
37073
|
+
format: "date-time",
|
|
37074
|
+
type: "string"
|
|
37075
|
+
},
|
|
37076
|
+
display_name: {
|
|
37077
|
+
description: "Display name of the space.",
|
|
37078
|
+
type: "string"
|
|
37079
|
+
},
|
|
37080
|
+
name: {
|
|
37081
|
+
description: "Name of the space.",
|
|
37082
|
+
type: "string"
|
|
37083
|
+
},
|
|
37084
|
+
space_id: {
|
|
37085
|
+
description: "Unique identifier for the space.",
|
|
37086
|
+
format: "uuid",
|
|
37087
|
+
type: "string"
|
|
37088
|
+
},
|
|
37089
|
+
workspace_id: {
|
|
37090
|
+
description: "Unique identifier for the Seam workspace associated with the space.",
|
|
37091
|
+
format: "uuid",
|
|
37092
|
+
type: "string"
|
|
37093
|
+
}
|
|
37094
|
+
},
|
|
37095
|
+
required: [
|
|
37096
|
+
"space_id",
|
|
37097
|
+
"workspace_id",
|
|
37098
|
+
"name",
|
|
37099
|
+
"display_name",
|
|
37100
|
+
"created_at"
|
|
37101
|
+
],
|
|
37102
|
+
type: "object"
|
|
37103
|
+
}
|
|
37104
|
+
},
|
|
37105
|
+
required: ["space", "ok"],
|
|
37106
|
+
type: "object"
|
|
37107
|
+
}
|
|
37108
|
+
}
|
|
37109
|
+
},
|
|
37110
|
+
description: "OK"
|
|
37111
|
+
},
|
|
37112
|
+
400: { description: "Bad Request" },
|
|
37113
|
+
401: { description: "Unauthorized" }
|
|
37114
|
+
},
|
|
37115
|
+
security: [
|
|
37116
|
+
{ pat_with_workspace: [] },
|
|
37117
|
+
{ console_session_with_workspace: [] },
|
|
37118
|
+
{ api_key: [] }
|
|
37119
|
+
],
|
|
37120
|
+
summary: "/spaces/create",
|
|
37121
|
+
tags: [],
|
|
37122
|
+
"x-fern-sdk-group-name": ["spaces"],
|
|
37123
|
+
"x-fern-sdk-method-name": "create",
|
|
37124
|
+
"x-fern-sdk-return-value": "space",
|
|
37125
|
+
"x-response-key": "space",
|
|
37126
|
+
"x-title": "Create Space"
|
|
37127
|
+
}
|
|
37128
|
+
},
|
|
37129
|
+
"/spaces/delete": {
|
|
37130
|
+
post: {
|
|
37131
|
+
description: "Delete a space.",
|
|
37132
|
+
operationId: "spacesDeletePost",
|
|
37133
|
+
requestBody: {
|
|
37134
|
+
content: {
|
|
37135
|
+
"application/json": {
|
|
37136
|
+
schema: {
|
|
37137
|
+
properties: { space_id: { format: "uuid", type: "string" } },
|
|
37138
|
+
required: ["space_id"],
|
|
37139
|
+
type: "object"
|
|
37140
|
+
}
|
|
37141
|
+
}
|
|
37142
|
+
}
|
|
37143
|
+
},
|
|
37144
|
+
responses: {
|
|
37145
|
+
200: {
|
|
37146
|
+
content: {
|
|
37147
|
+
"application/json": {
|
|
37148
|
+
schema: {
|
|
37149
|
+
properties: { ok: { type: "boolean" } },
|
|
37150
|
+
required: ["ok"],
|
|
37151
|
+
type: "object"
|
|
37152
|
+
}
|
|
37153
|
+
}
|
|
37154
|
+
},
|
|
37155
|
+
description: "OK"
|
|
37156
|
+
},
|
|
37157
|
+
400: { description: "Bad Request" },
|
|
37158
|
+
401: { description: "Unauthorized" }
|
|
37159
|
+
},
|
|
37160
|
+
security: [
|
|
37161
|
+
{ pat_with_workspace: [] },
|
|
37162
|
+
{ console_session_with_workspace: [] },
|
|
37163
|
+
{ api_key: [] }
|
|
37164
|
+
],
|
|
37165
|
+
summary: "/spaces/delete",
|
|
37166
|
+
tags: [],
|
|
37167
|
+
"x-fern-sdk-group-name": ["spaces"],
|
|
37168
|
+
"x-fern-sdk-method-name": "delete",
|
|
37169
|
+
"x-response-key": null,
|
|
37170
|
+
"x-title": "Delete Space"
|
|
37171
|
+
}
|
|
37172
|
+
},
|
|
37173
|
+
"/spaces/get": {
|
|
37174
|
+
post: {
|
|
37175
|
+
description: "Get a space.",
|
|
37176
|
+
operationId: "spacesGetPost",
|
|
37177
|
+
requestBody: {
|
|
37178
|
+
content: {
|
|
37179
|
+
"application/json": {
|
|
37180
|
+
schema: {
|
|
37181
|
+
properties: { space_id: { format: "uuid", type: "string" } },
|
|
37182
|
+
required: ["space_id"],
|
|
37183
|
+
type: "object"
|
|
37184
|
+
}
|
|
37185
|
+
}
|
|
37186
|
+
}
|
|
37187
|
+
},
|
|
37188
|
+
responses: {
|
|
37189
|
+
200: {
|
|
37190
|
+
content: {
|
|
37191
|
+
"application/json": {
|
|
37192
|
+
schema: {
|
|
37193
|
+
properties: {
|
|
37194
|
+
ok: { type: "boolean" },
|
|
37195
|
+
space: {
|
|
37196
|
+
properties: {
|
|
37197
|
+
created_at: {
|
|
37198
|
+
description: "Date and time at which the space object was created.",
|
|
37199
|
+
format: "date-time",
|
|
37200
|
+
type: "string"
|
|
37201
|
+
},
|
|
37202
|
+
display_name: {
|
|
37203
|
+
description: "Display name of the space.",
|
|
37204
|
+
type: "string"
|
|
37205
|
+
},
|
|
37206
|
+
name: {
|
|
37207
|
+
description: "Name of the space.",
|
|
37208
|
+
type: "string"
|
|
37209
|
+
},
|
|
37210
|
+
space_id: {
|
|
37211
|
+
description: "Unique identifier for the space.",
|
|
37212
|
+
format: "uuid",
|
|
37213
|
+
type: "string"
|
|
37214
|
+
},
|
|
37215
|
+
workspace_id: {
|
|
37216
|
+
description: "Unique identifier for the Seam workspace associated with the space.",
|
|
37217
|
+
format: "uuid",
|
|
37218
|
+
type: "string"
|
|
37219
|
+
}
|
|
37220
|
+
},
|
|
37221
|
+
required: [
|
|
37222
|
+
"space_id",
|
|
37223
|
+
"workspace_id",
|
|
37224
|
+
"name",
|
|
37225
|
+
"display_name",
|
|
37226
|
+
"created_at"
|
|
37227
|
+
],
|
|
37228
|
+
type: "object"
|
|
37229
|
+
}
|
|
37230
|
+
},
|
|
37231
|
+
required: ["space", "ok"],
|
|
35369
37232
|
type: "object"
|
|
35370
37233
|
}
|
|
35371
37234
|
}
|
|
@@ -35375,71 +37238,71 @@ var openapi_default = {
|
|
|
35375
37238
|
400: { description: "Bad Request" },
|
|
35376
37239
|
401: { description: "Unauthorized" }
|
|
35377
37240
|
},
|
|
35378
|
-
security: [
|
|
35379
|
-
|
|
35380
|
-
|
|
35381
|
-
|
|
35382
|
-
"seam",
|
|
35383
|
-
"bridge",
|
|
35384
|
-
"v1",
|
|
35385
|
-
"bridge_client_sessions"
|
|
37241
|
+
security: [
|
|
37242
|
+
{ pat_with_workspace: [] },
|
|
37243
|
+
{ console_session_with_workspace: [] },
|
|
37244
|
+
{ api_key: [] }
|
|
35386
37245
|
],
|
|
35387
|
-
|
|
35388
|
-
|
|
35389
|
-
"x-
|
|
35390
|
-
"x-
|
|
37246
|
+
summary: "/spaces/get",
|
|
37247
|
+
tags: [],
|
|
37248
|
+
"x-fern-sdk-group-name": ["spaces"],
|
|
37249
|
+
"x-fern-sdk-method-name": "get",
|
|
37250
|
+
"x-fern-sdk-return-value": "space",
|
|
37251
|
+
"x-response-key": "space",
|
|
37252
|
+
"x-title": "Get Space"
|
|
35391
37253
|
}
|
|
35392
37254
|
},
|
|
35393
|
-
"/
|
|
37255
|
+
"/spaces/list": {
|
|
35394
37256
|
get: {
|
|
35395
|
-
description: "Returns
|
|
35396
|
-
operationId: "
|
|
37257
|
+
description: "Returns a list of all spaces.",
|
|
37258
|
+
operationId: "spacesListGet",
|
|
35397
37259
|
responses: {
|
|
35398
37260
|
200: {
|
|
35399
37261
|
content: {
|
|
35400
37262
|
"application/json": {
|
|
35401
37263
|
schema: {
|
|
35402
37264
|
properties: {
|
|
35403
|
-
|
|
37265
|
+
ok: { type: "boolean" },
|
|
37266
|
+
spaces: {
|
|
35404
37267
|
items: {
|
|
35405
37268
|
properties: {
|
|
35406
|
-
|
|
35407
|
-
|
|
35408
|
-
bridge_created_at: {
|
|
37269
|
+
created_at: {
|
|
37270
|
+
description: "Date and time at which the space object was created.",
|
|
35409
37271
|
format: "date-time",
|
|
35410
37272
|
type: "string"
|
|
35411
37273
|
},
|
|
35412
|
-
|
|
35413
|
-
|
|
35414
|
-
format: "date-time",
|
|
37274
|
+
display_name: {
|
|
37275
|
+
description: "Display name of the space.",
|
|
35415
37276
|
type: "string"
|
|
35416
37277
|
},
|
|
35417
|
-
|
|
37278
|
+
name: {
|
|
37279
|
+
description: "Name of the space.",
|
|
37280
|
+
type: "string"
|
|
37281
|
+
},
|
|
37282
|
+
space_id: {
|
|
37283
|
+
description: "Unique identifier for the space.",
|
|
35418
37284
|
format: "uuid",
|
|
35419
37285
|
type: "string"
|
|
35420
37286
|
},
|
|
35421
|
-
|
|
35422
|
-
|
|
37287
|
+
workspace_id: {
|
|
37288
|
+
description: "Unique identifier for the Seam workspace associated with the space.",
|
|
37289
|
+
format: "uuid",
|
|
37290
|
+
type: "string"
|
|
37291
|
+
}
|
|
35423
37292
|
},
|
|
35424
37293
|
required: [
|
|
35425
|
-
"
|
|
35426
|
-
"bridge_created_at",
|
|
35427
|
-
"connected_account_id",
|
|
35428
|
-
"connected_account_created_at",
|
|
35429
|
-
"acs_system_id",
|
|
35430
|
-
"acs_system_display_name",
|
|
37294
|
+
"space_id",
|
|
35431
37295
|
"workspace_id",
|
|
35432
|
-
"
|
|
37296
|
+
"name",
|
|
37297
|
+
"display_name",
|
|
37298
|
+
"created_at"
|
|
35433
37299
|
],
|
|
35434
|
-
type: "object"
|
|
35435
|
-
"x-route-path": "/seam/bridge/v1/bridge_connected_systems",
|
|
35436
|
-
"x-undocumented": "Seam Bridge Client only."
|
|
37300
|
+
type: "object"
|
|
35437
37301
|
},
|
|
35438
37302
|
type: "array"
|
|
35439
|
-
}
|
|
35440
|
-
ok: { type: "boolean" }
|
|
37303
|
+
}
|
|
35441
37304
|
},
|
|
35442
|
-
required: ["
|
|
37305
|
+
required: ["spaces", "ok"],
|
|
35443
37306
|
type: "object"
|
|
35444
37307
|
}
|
|
35445
37308
|
}
|
|
@@ -35449,63 +37312,67 @@ var openapi_default = {
|
|
|
35449
37312
|
400: { description: "Bad Request" },
|
|
35450
37313
|
401: { description: "Unauthorized" }
|
|
35451
37314
|
},
|
|
35452
|
-
security: [
|
|
35453
|
-
|
|
37315
|
+
security: [
|
|
37316
|
+
{ pat_with_workspace: [] },
|
|
37317
|
+
{ console_session_with_workspace: [] },
|
|
37318
|
+
{ api_key: [] }
|
|
37319
|
+
],
|
|
37320
|
+
summary: "/spaces/list",
|
|
35454
37321
|
tags: [],
|
|
35455
37322
|
"x-fern-ignore": true,
|
|
35456
|
-
"x-response-key": "
|
|
35457
|
-
"x-title": "List
|
|
35458
|
-
"x-undocumented": "Seam Bridge Client only."
|
|
37323
|
+
"x-response-key": "spaces",
|
|
37324
|
+
"x-title": "List Spaces"
|
|
35459
37325
|
},
|
|
35460
37326
|
post: {
|
|
35461
|
-
description: "Returns
|
|
35462
|
-
operationId: "
|
|
37327
|
+
description: "Returns a list of all spaces.",
|
|
37328
|
+
operationId: "spacesListPost",
|
|
35463
37329
|
responses: {
|
|
35464
37330
|
200: {
|
|
35465
37331
|
content: {
|
|
35466
37332
|
"application/json": {
|
|
35467
37333
|
schema: {
|
|
35468
37334
|
properties: {
|
|
35469
|
-
|
|
37335
|
+
ok: { type: "boolean" },
|
|
37336
|
+
spaces: {
|
|
35470
37337
|
items: {
|
|
35471
37338
|
properties: {
|
|
35472
|
-
|
|
35473
|
-
|
|
35474
|
-
bridge_created_at: {
|
|
37339
|
+
created_at: {
|
|
37340
|
+
description: "Date and time at which the space object was created.",
|
|
35475
37341
|
format: "date-time",
|
|
35476
37342
|
type: "string"
|
|
35477
37343
|
},
|
|
35478
|
-
|
|
35479
|
-
|
|
35480
|
-
format: "date-time",
|
|
37344
|
+
display_name: {
|
|
37345
|
+
description: "Display name of the space.",
|
|
35481
37346
|
type: "string"
|
|
35482
37347
|
},
|
|
35483
|
-
|
|
37348
|
+
name: {
|
|
37349
|
+
description: "Name of the space.",
|
|
37350
|
+
type: "string"
|
|
37351
|
+
},
|
|
37352
|
+
space_id: {
|
|
37353
|
+
description: "Unique identifier for the space.",
|
|
35484
37354
|
format: "uuid",
|
|
35485
37355
|
type: "string"
|
|
35486
37356
|
},
|
|
35487
|
-
|
|
35488
|
-
|
|
37357
|
+
workspace_id: {
|
|
37358
|
+
description: "Unique identifier for the Seam workspace associated with the space.",
|
|
37359
|
+
format: "uuid",
|
|
37360
|
+
type: "string"
|
|
37361
|
+
}
|
|
35489
37362
|
},
|
|
35490
37363
|
required: [
|
|
35491
|
-
"
|
|
35492
|
-
"bridge_created_at",
|
|
35493
|
-
"connected_account_id",
|
|
35494
|
-
"connected_account_created_at",
|
|
35495
|
-
"acs_system_id",
|
|
35496
|
-
"acs_system_display_name",
|
|
37364
|
+
"space_id",
|
|
35497
37365
|
"workspace_id",
|
|
35498
|
-
"
|
|
37366
|
+
"name",
|
|
37367
|
+
"display_name",
|
|
37368
|
+
"created_at"
|
|
35499
37369
|
],
|
|
35500
|
-
type: "object"
|
|
35501
|
-
"x-route-path": "/seam/bridge/v1/bridge_connected_systems",
|
|
35502
|
-
"x-undocumented": "Seam Bridge Client only."
|
|
37370
|
+
type: "object"
|
|
35503
37371
|
},
|
|
35504
37372
|
type: "array"
|
|
35505
|
-
}
|
|
35506
|
-
ok: { type: "boolean" }
|
|
37373
|
+
}
|
|
35507
37374
|
},
|
|
35508
|
-
required: ["
|
|
37375
|
+
required: ["spaces", "ok"],
|
|
35509
37376
|
type: "object"
|
|
35510
37377
|
}
|
|
35511
37378
|
}
|
|
@@ -35515,37 +37382,36 @@ var openapi_default = {
|
|
|
35515
37382
|
400: { description: "Bad Request" },
|
|
35516
37383
|
401: { description: "Unauthorized" }
|
|
35517
37384
|
},
|
|
35518
|
-
security: [
|
|
35519
|
-
|
|
35520
|
-
|
|
35521
|
-
|
|
35522
|
-
"seam",
|
|
35523
|
-
"bridge",
|
|
35524
|
-
"v1",
|
|
35525
|
-
"bridge_connected_systems"
|
|
37385
|
+
security: [
|
|
37386
|
+
{ pat_with_workspace: [] },
|
|
37387
|
+
{ console_session_with_workspace: [] },
|
|
37388
|
+
{ api_key: [] }
|
|
35526
37389
|
],
|
|
37390
|
+
summary: "/spaces/list",
|
|
37391
|
+
tags: [],
|
|
37392
|
+
"x-fern-sdk-group-name": ["spaces"],
|
|
35527
37393
|
"x-fern-sdk-method-name": "list",
|
|
35528
|
-
"x-fern-sdk-return-value": "
|
|
35529
|
-
"x-response-key": "
|
|
35530
|
-
"x-title": "List
|
|
35531
|
-
"x-undocumented": "Seam Bridge Client only."
|
|
37394
|
+
"x-fern-sdk-return-value": "spaces",
|
|
37395
|
+
"x-response-key": "spaces",
|
|
37396
|
+
"x-title": "List Spaces"
|
|
35532
37397
|
}
|
|
35533
37398
|
},
|
|
35534
|
-
"/
|
|
37399
|
+
"/spaces/remove_acs_entrances": {
|
|
35535
37400
|
post: {
|
|
35536
|
-
description: "
|
|
35537
|
-
operationId: "
|
|
37401
|
+
description: "Remove entrances from a specific space.",
|
|
37402
|
+
operationId: "spacesRemoveAcsEntrancesPost",
|
|
35538
37403
|
requestBody: {
|
|
35539
37404
|
content: {
|
|
35540
37405
|
"application/json": {
|
|
35541
37406
|
schema: {
|
|
35542
37407
|
properties: {
|
|
35543
|
-
|
|
35544
|
-
|
|
35545
|
-
type: "
|
|
35546
|
-
}
|
|
37408
|
+
acs_entrance_ids: {
|
|
37409
|
+
items: { format: "uuid", type: "string" },
|
|
37410
|
+
type: "array"
|
|
37411
|
+
},
|
|
37412
|
+
space_id: { format: "uuid", type: "string" }
|
|
35547
37413
|
},
|
|
35548
|
-
required: ["
|
|
37414
|
+
required: ["space_id", "acs_entrance_ids"],
|
|
35549
37415
|
type: "object"
|
|
35550
37416
|
}
|
|
35551
37417
|
}
|
|
@@ -35556,60 +37422,8 @@ var openapi_default = {
|
|
|
35556
37422
|
content: {
|
|
35557
37423
|
"application/json": {
|
|
35558
37424
|
schema: {
|
|
35559
|
-
properties: {
|
|
35560
|
-
|
|
35561
|
-
$ref: "#/components/schemas/client_session"
|
|
35562
|
-
},
|
|
35563
|
-
ok: { type: "boolean" }
|
|
35564
|
-
},
|
|
35565
|
-
required: ["client_session", "ok"],
|
|
35566
|
-
type: "object"
|
|
35567
|
-
}
|
|
35568
|
-
}
|
|
35569
|
-
},
|
|
35570
|
-
description: "OK"
|
|
35571
|
-
},
|
|
35572
|
-
400: { description: "Bad Request" },
|
|
35573
|
-
401: { description: "Unauthorized" }
|
|
35574
|
-
},
|
|
35575
|
-
security: [{ certified_client: [] }],
|
|
35576
|
-
summary: "/seam/instant_key/v1/client_sessions/exchange_short_code",
|
|
35577
|
-
tags: ["/client_sessions"],
|
|
35578
|
-
"x-fern-sdk-group-name": [
|
|
35579
|
-
"seam",
|
|
35580
|
-
"instant_key",
|
|
35581
|
-
"v1",
|
|
35582
|
-
"client_sessions"
|
|
35583
|
-
],
|
|
35584
|
-
"x-fern-sdk-method-name": "exchange_short_code",
|
|
35585
|
-
"x-fern-sdk-return-value": "client_session",
|
|
35586
|
-
"x-response-key": "client_session",
|
|
35587
|
-
"x-title": "Exchange Instant Key Short Code",
|
|
35588
|
-
"x-undocumented": "Seam Instant Key only."
|
|
35589
|
-
}
|
|
35590
|
-
},
|
|
35591
|
-
"/seam/mobile_sdk/v1/acs/credentials/list": {
|
|
35592
|
-
post: {
|
|
35593
|
-
description: "Returns a list of all ACS credentials.",
|
|
35594
|
-
operationId: "seamMobileSdkV1AcsCredentialsListPost",
|
|
35595
|
-
requestBody: {
|
|
35596
|
-
content: {
|
|
35597
|
-
"application/json": { schema: { properties: {}, type: "object" } }
|
|
35598
|
-
}
|
|
35599
|
-
},
|
|
35600
|
-
responses: {
|
|
35601
|
-
200: {
|
|
35602
|
-
content: {
|
|
35603
|
-
"application/json": {
|
|
35604
|
-
schema: {
|
|
35605
|
-
properties: {
|
|
35606
|
-
acs_credentials: {
|
|
35607
|
-
items: { $ref: "#/components/schemas/acs_credential" },
|
|
35608
|
-
type: "array"
|
|
35609
|
-
},
|
|
35610
|
-
ok: { type: "boolean" }
|
|
35611
|
-
},
|
|
35612
|
-
required: ["acs_credentials", "ok"],
|
|
37425
|
+
properties: { ok: { type: "boolean" } },
|
|
37426
|
+
required: ["ok"],
|
|
35613
37427
|
type: "object"
|
|
35614
37428
|
}
|
|
35615
37429
|
}
|
|
@@ -35619,44 +37433,35 @@ var openapi_default = {
|
|
|
35619
37433
|
400: { description: "Bad Request" },
|
|
35620
37434
|
401: { description: "Unauthorized" }
|
|
35621
37435
|
},
|
|
35622
|
-
security: [
|
|
35623
|
-
|
|
35624
|
-
|
|
35625
|
-
|
|
35626
|
-
"seam",
|
|
35627
|
-
"mobile_sdk",
|
|
35628
|
-
"v1",
|
|
35629
|
-
"acs",
|
|
35630
|
-
"credentials"
|
|
37436
|
+
security: [
|
|
37437
|
+
{ pat_with_workspace: [] },
|
|
37438
|
+
{ console_session_with_workspace: [] },
|
|
37439
|
+
{ api_key: [] }
|
|
35631
37440
|
],
|
|
35632
|
-
|
|
35633
|
-
|
|
35634
|
-
"x-
|
|
35635
|
-
"x-
|
|
35636
|
-
"x-
|
|
37441
|
+
summary: "/spaces/remove_acs_entrances",
|
|
37442
|
+
tags: [],
|
|
37443
|
+
"x-fern-sdk-group-name": ["spaces"],
|
|
37444
|
+
"x-fern-sdk-method-name": "remove_acs_entrances",
|
|
37445
|
+
"x-response-key": null,
|
|
37446
|
+
"x-title": "Remove ACS Entrances"
|
|
35637
37447
|
}
|
|
35638
37448
|
},
|
|
35639
|
-
"/
|
|
37449
|
+
"/spaces/remove_devices": {
|
|
35640
37450
|
post: {
|
|
35641
|
-
description: "
|
|
35642
|
-
operationId: "
|
|
37451
|
+
description: "Remove devices from a specific space.",
|
|
37452
|
+
operationId: "spacesRemoveDevicesPost",
|
|
35643
37453
|
requestBody: {
|
|
35644
37454
|
content: {
|
|
35645
37455
|
"application/json": {
|
|
35646
37456
|
schema: {
|
|
35647
37457
|
properties: {
|
|
35648
|
-
|
|
35649
|
-
|
|
35650
|
-
|
|
35651
|
-
manufacturer: { type: "string" },
|
|
35652
|
-
model: { type: "string" },
|
|
35653
|
-
os_version: { type: "string" }
|
|
35654
|
-
},
|
|
35655
|
-
type: "object"
|
|
37458
|
+
device_ids: {
|
|
37459
|
+
items: { format: "uuid", type: "string" },
|
|
37460
|
+
type: "array"
|
|
35656
37461
|
},
|
|
35657
|
-
|
|
37462
|
+
space_id: { format: "uuid", type: "string" }
|
|
35658
37463
|
},
|
|
35659
|
-
required: ["
|
|
37464
|
+
required: ["space_id", "device_ids"],
|
|
35660
37465
|
type: "object"
|
|
35661
37466
|
}
|
|
35662
37467
|
}
|
|
@@ -35667,13 +37472,8 @@ var openapi_default = {
|
|
|
35667
37472
|
content: {
|
|
35668
37473
|
"application/json": {
|
|
35669
37474
|
schema: {
|
|
35670
|
-
properties: {
|
|
35671
|
-
|
|
35672
|
-
phone_session: {
|
|
35673
|
-
$ref: "#/components/schemas/phone_session"
|
|
35674
|
-
}
|
|
35675
|
-
},
|
|
35676
|
-
required: ["phone_session", "ok"],
|
|
37475
|
+
properties: { ok: { type: "boolean" } },
|
|
37476
|
+
required: ["ok"],
|
|
35677
37477
|
type: "object"
|
|
35678
37478
|
}
|
|
35679
37479
|
}
|
|
@@ -35683,27 +37483,32 @@ var openapi_default = {
|
|
|
35683
37483
|
400: { description: "Bad Request" },
|
|
35684
37484
|
401: { description: "Unauthorized" }
|
|
35685
37485
|
},
|
|
35686
|
-
security: [
|
|
35687
|
-
|
|
37486
|
+
security: [
|
|
37487
|
+
{ pat_with_workspace: [] },
|
|
37488
|
+
{ console_session_with_workspace: [] },
|
|
37489
|
+
{ api_key: [] }
|
|
37490
|
+
],
|
|
37491
|
+
summary: "/spaces/remove_devices",
|
|
35688
37492
|
tags: [],
|
|
35689
|
-
"x-fern-sdk-group-name": ["
|
|
35690
|
-
"x-fern-sdk-method-name": "
|
|
35691
|
-
"x-
|
|
35692
|
-
"x-
|
|
35693
|
-
"x-title": "Get or Create a Phone Session",
|
|
35694
|
-
"x-undocumented": "Mobile SDK only."
|
|
37493
|
+
"x-fern-sdk-group-name": ["spaces"],
|
|
37494
|
+
"x-fern-sdk-method-name": "remove_devices",
|
|
37495
|
+
"x-response-key": null,
|
|
37496
|
+
"x-title": "Remove Space Devices"
|
|
35695
37497
|
}
|
|
35696
37498
|
},
|
|
35697
|
-
"/
|
|
35698
|
-
|
|
35699
|
-
description: "
|
|
35700
|
-
operationId: "
|
|
37499
|
+
"/spaces/update": {
|
|
37500
|
+
patch: {
|
|
37501
|
+
description: "Update an existing space.",
|
|
37502
|
+
operationId: "spacesUpdatePatch",
|
|
35701
37503
|
requestBody: {
|
|
35702
37504
|
content: {
|
|
35703
37505
|
"application/json": {
|
|
35704
37506
|
schema: {
|
|
35705
|
-
properties: {
|
|
35706
|
-
|
|
37507
|
+
properties: {
|
|
37508
|
+
name: { type: "string" },
|
|
37509
|
+
space_id: { format: "uuid", type: "string" }
|
|
37510
|
+
},
|
|
37511
|
+
required: ["space_id"],
|
|
35707
37512
|
type: "object"
|
|
35708
37513
|
}
|
|
35709
37514
|
}
|
|
@@ -35716,51 +37521,43 @@ var openapi_default = {
|
|
|
35716
37521
|
schema: {
|
|
35717
37522
|
properties: {
|
|
35718
37523
|
ok: { type: "boolean" },
|
|
35719
|
-
|
|
35720
|
-
|
|
35721
|
-
|
|
35722
|
-
|
|
35723
|
-
|
|
35724
|
-
|
|
35725
|
-
acs_entrance_id: { type: "string" },
|
|
35726
|
-
name: { type: "string" }
|
|
35727
|
-
},
|
|
35728
|
-
required: ["acs_entrance_id", "name"],
|
|
35729
|
-
type: "object"
|
|
35730
|
-
},
|
|
35731
|
-
type: "array"
|
|
35732
|
-
},
|
|
35733
|
-
devices: {
|
|
35734
|
-
items: {
|
|
35735
|
-
properties: {
|
|
35736
|
-
device_id: { type: "string" },
|
|
35737
|
-
device_type: {
|
|
35738
|
-
enum: ["lock", "thermostat", "sensor"],
|
|
35739
|
-
type: "string"
|
|
35740
|
-
},
|
|
35741
|
-
name: { type: "string" }
|
|
35742
|
-
},
|
|
35743
|
-
required: ["device_id", "device_type", "name"],
|
|
35744
|
-
type: "object"
|
|
35745
|
-
},
|
|
35746
|
-
type: "array"
|
|
35747
|
-
},
|
|
35748
|
-
name: { type: "string" },
|
|
35749
|
-
needs_review: { type: "boolean" },
|
|
35750
|
-
partner_resource_key: { type: "string" }
|
|
37524
|
+
space: {
|
|
37525
|
+
properties: {
|
|
37526
|
+
created_at: {
|
|
37527
|
+
description: "Date and time at which the space object was created.",
|
|
37528
|
+
format: "date-time",
|
|
37529
|
+
type: "string"
|
|
35751
37530
|
},
|
|
35752
|
-
|
|
35753
|
-
"name",
|
|
35754
|
-
"
|
|
35755
|
-
|
|
35756
|
-
|
|
35757
|
-
|
|
35758
|
-
|
|
37531
|
+
display_name: {
|
|
37532
|
+
description: "Display name of the space.",
|
|
37533
|
+
type: "string"
|
|
37534
|
+
},
|
|
37535
|
+
name: {
|
|
37536
|
+
description: "Name of the space.",
|
|
37537
|
+
type: "string"
|
|
37538
|
+
},
|
|
37539
|
+
space_id: {
|
|
37540
|
+
description: "Unique identifier for the space.",
|
|
37541
|
+
format: "uuid",
|
|
37542
|
+
type: "string"
|
|
37543
|
+
},
|
|
37544
|
+
workspace_id: {
|
|
37545
|
+
description: "Unique identifier for the Seam workspace associated with the space.",
|
|
37546
|
+
format: "uuid",
|
|
37547
|
+
type: "string"
|
|
37548
|
+
}
|
|
35759
37549
|
},
|
|
35760
|
-
|
|
37550
|
+
required: [
|
|
37551
|
+
"space_id",
|
|
37552
|
+
"workspace_id",
|
|
37553
|
+
"name",
|
|
37554
|
+
"display_name",
|
|
37555
|
+
"created_at"
|
|
37556
|
+
],
|
|
37557
|
+
type: "object"
|
|
35761
37558
|
}
|
|
35762
37559
|
},
|
|
35763
|
-
required: ["
|
|
37560
|
+
required: ["space", "ok"],
|
|
35764
37561
|
type: "object"
|
|
35765
37562
|
}
|
|
35766
37563
|
}
|
|
@@ -35770,37 +37567,29 @@ var openapi_default = {
|
|
|
35770
37567
|
400: { description: "Bad Request" },
|
|
35771
37568
|
401: { description: "Unauthorized" }
|
|
35772
37569
|
},
|
|
35773
|
-
security: [
|
|
35774
|
-
|
|
35775
|
-
|
|
35776
|
-
|
|
35777
|
-
"seam",
|
|
35778
|
-
"partner",
|
|
35779
|
-
"v1",
|
|
35780
|
-
"building_blocks",
|
|
35781
|
-
"spaces"
|
|
37570
|
+
security: [
|
|
37571
|
+
{ pat_with_workspace: [] },
|
|
37572
|
+
{ console_session_with_workspace: [] },
|
|
37573
|
+
{ api_key: [] }
|
|
35782
37574
|
],
|
|
35783
|
-
|
|
35784
|
-
|
|
35785
|
-
"x-
|
|
35786
|
-
"x-
|
|
35787
|
-
"x-
|
|
35788
|
-
}
|
|
35789
|
-
},
|
|
35790
|
-
"/seam/partner/v1/resources/list": {
|
|
37575
|
+
summary: "/spaces/update",
|
|
37576
|
+
tags: [],
|
|
37577
|
+
"x-fern-ignore": true,
|
|
37578
|
+
"x-response-key": "space",
|
|
37579
|
+
"x-title": "Update Space"
|
|
37580
|
+
},
|
|
35791
37581
|
post: {
|
|
35792
|
-
description: "
|
|
35793
|
-
operationId: "
|
|
37582
|
+
description: "Update an existing space.",
|
|
37583
|
+
operationId: "spacesUpdatePost",
|
|
35794
37584
|
requestBody: {
|
|
35795
37585
|
content: {
|
|
35796
37586
|
"application/json": {
|
|
35797
37587
|
schema: {
|
|
35798
37588
|
properties: {
|
|
35799
|
-
|
|
35800
|
-
|
|
35801
|
-
type: "string"
|
|
35802
|
-
}
|
|
37589
|
+
name: { type: "string" },
|
|
37590
|
+
space_id: { format: "uuid", type: "string" }
|
|
35803
37591
|
},
|
|
37592
|
+
required: ["space_id"],
|
|
35804
37593
|
type: "object"
|
|
35805
37594
|
}
|
|
35806
37595
|
}
|
|
@@ -35813,41 +37602,43 @@ var openapi_default = {
|
|
|
35813
37602
|
schema: {
|
|
35814
37603
|
properties: {
|
|
35815
37604
|
ok: { type: "boolean" },
|
|
35816
|
-
|
|
35817
|
-
|
|
35818
|
-
|
|
35819
|
-
|
|
35820
|
-
|
|
35821
|
-
|
|
35822
|
-
},
|
|
35823
|
-
customer_key: { type: "string" },
|
|
35824
|
-
description: { type: "string" },
|
|
35825
|
-
email_address: { type: "string" },
|
|
35826
|
-
ends_at: { type: "string" },
|
|
35827
|
-
location_keys: {
|
|
35828
|
-
items: { type: "string" },
|
|
35829
|
-
type: "array"
|
|
35830
|
-
},
|
|
35831
|
-
name: { type: "string" },
|
|
35832
|
-
partner_resource_key: { type: "string" },
|
|
35833
|
-
partner_resource_type: { type: "string" },
|
|
35834
|
-
phone_number: { type: "string" },
|
|
35835
|
-
starts_at: { type: "string" },
|
|
35836
|
-
user_identity_key: { type: "string" }
|
|
37605
|
+
space: {
|
|
37606
|
+
properties: {
|
|
37607
|
+
created_at: {
|
|
37608
|
+
description: "Date and time at which the space object was created.",
|
|
37609
|
+
format: "date-time",
|
|
37610
|
+
type: "string"
|
|
35837
37611
|
},
|
|
35838
|
-
|
|
35839
|
-
"
|
|
35840
|
-
"
|
|
35841
|
-
|
|
35842
|
-
|
|
35843
|
-
|
|
35844
|
-
|
|
35845
|
-
|
|
37612
|
+
display_name: {
|
|
37613
|
+
description: "Display name of the space.",
|
|
37614
|
+
type: "string"
|
|
37615
|
+
},
|
|
37616
|
+
name: {
|
|
37617
|
+
description: "Name of the space.",
|
|
37618
|
+
type: "string"
|
|
37619
|
+
},
|
|
37620
|
+
space_id: {
|
|
37621
|
+
description: "Unique identifier for the space.",
|
|
37622
|
+
format: "uuid",
|
|
37623
|
+
type: "string"
|
|
37624
|
+
},
|
|
37625
|
+
workspace_id: {
|
|
37626
|
+
description: "Unique identifier for the Seam workspace associated with the space.",
|
|
37627
|
+
format: "uuid",
|
|
37628
|
+
type: "string"
|
|
37629
|
+
}
|
|
35846
37630
|
},
|
|
35847
|
-
|
|
37631
|
+
required: [
|
|
37632
|
+
"space_id",
|
|
37633
|
+
"workspace_id",
|
|
37634
|
+
"name",
|
|
37635
|
+
"display_name",
|
|
37636
|
+
"created_at"
|
|
37637
|
+
],
|
|
37638
|
+
type: "object"
|
|
35848
37639
|
}
|
|
35849
37640
|
},
|
|
35850
|
-
required: ["
|
|
37641
|
+
required: ["space", "ok"],
|
|
35851
37642
|
type: "object"
|
|
35852
37643
|
}
|
|
35853
37644
|
}
|
|
@@ -35857,15 +37648,18 @@ var openapi_default = {
|
|
|
35857
37648
|
400: { description: "Bad Request" },
|
|
35858
37649
|
401: { description: "Unauthorized" }
|
|
35859
37650
|
},
|
|
35860
|
-
security: [
|
|
35861
|
-
|
|
37651
|
+
security: [
|
|
37652
|
+
{ pat_with_workspace: [] },
|
|
37653
|
+
{ console_session_with_workspace: [] },
|
|
37654
|
+
{ api_key: [] }
|
|
37655
|
+
],
|
|
37656
|
+
summary: "/spaces/update",
|
|
35862
37657
|
tags: [],
|
|
35863
|
-
"x-fern-sdk-group-name": ["
|
|
35864
|
-
"x-fern-sdk-method-name": "
|
|
35865
|
-
"x-fern-sdk-return-value": "
|
|
35866
|
-
"x-response-key": "
|
|
35867
|
-
"x-title": "
|
|
35868
|
-
"x-undocumented": "Partner building blocks/UI only."
|
|
37658
|
+
"x-fern-sdk-group-name": ["spaces"],
|
|
37659
|
+
"x-fern-sdk-method-name": "update",
|
|
37660
|
+
"x-fern-sdk-return-value": "space",
|
|
37661
|
+
"x-response-key": "space",
|
|
37662
|
+
"x-title": "Update Space"
|
|
35869
37663
|
}
|
|
35870
37664
|
},
|
|
35871
37665
|
"/thermostats/activate_climate_preset": {
|
|
@@ -36856,12 +38650,17 @@ var openapi_default = {
|
|
|
36856
38650
|
nullable: true,
|
|
36857
38651
|
type: "string"
|
|
36858
38652
|
},
|
|
38653
|
+
space_id: {
|
|
38654
|
+
description: "ID of the space for which you want to list devices.",
|
|
38655
|
+
format: "uuid",
|
|
38656
|
+
type: "string"
|
|
38657
|
+
},
|
|
36859
38658
|
unstable_location_id: {
|
|
36860
|
-
|
|
38659
|
+
deprecated: true,
|
|
36861
38660
|
format: "uuid",
|
|
36862
38661
|
nullable: true,
|
|
36863
38662
|
type: "string",
|
|
36864
|
-
"x-
|
|
38663
|
+
"x-deprecated": "Use `space_id`."
|
|
36865
38664
|
},
|
|
36866
38665
|
user_identifier_key: {
|
|
36867
38666
|
description: "Your own internal user ID for the user for which you want to list devices.",
|
|
@@ -38375,6 +40174,18 @@ var openapi_default = {
|
|
|
38375
40174
|
},
|
|
38376
40175
|
{
|
|
38377
40176
|
properties: {
|
|
40177
|
+
acs_entrance_ids: {
|
|
40178
|
+
default: [],
|
|
40179
|
+
description: "Set of IDs of the [entrances](https://docs.seam.co/latest/api/acs/systems/list) to which access is being granted.",
|
|
40180
|
+
items: { format: "uuid", type: "string" },
|
|
40181
|
+
type: "array"
|
|
40182
|
+
},
|
|
40183
|
+
device_ids: {
|
|
40184
|
+
default: [],
|
|
40185
|
+
description: "Set of IDs of the [devices](https://docs.seam.co/latest/api/devices/list) to which access is being granted.",
|
|
40186
|
+
items: { format: "uuid", type: "string" },
|
|
40187
|
+
type: "array"
|
|
40188
|
+
},
|
|
38378
40189
|
ends_at: {
|
|
38379
40190
|
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`.",
|
|
38380
40191
|
format: "date-time",
|
|
@@ -38385,15 +40196,17 @@ var openapi_default = {
|
|
|
38385
40196
|
properties: {
|
|
38386
40197
|
acs_entrance_ids: {
|
|
38387
40198
|
default: [],
|
|
38388
|
-
|
|
40199
|
+
deprecated: true,
|
|
38389
40200
|
items: { format: "uuid", type: "string" },
|
|
38390
|
-
type: "array"
|
|
40201
|
+
type: "array",
|
|
40202
|
+
"x-deprecated": "Use `acs_entrance_ids` at the top level."
|
|
38391
40203
|
},
|
|
38392
40204
|
device_ids: {
|
|
38393
40205
|
default: [],
|
|
38394
|
-
|
|
40206
|
+
deprecated: true,
|
|
38395
40207
|
items: { format: "uuid", type: "string" },
|
|
38396
|
-
type: "array"
|
|
40208
|
+
type: "array",
|
|
40209
|
+
"x-deprecated": "Use `device_ids` at the top level."
|
|
38397
40210
|
},
|
|
38398
40211
|
name: {
|
|
38399
40212
|
description: "Name of the location.",
|
|
@@ -38403,9 +40216,10 @@ var openapi_default = {
|
|
|
38403
40216
|
type: "object"
|
|
38404
40217
|
},
|
|
38405
40218
|
location_ids: {
|
|
38406
|
-
|
|
40219
|
+
deprecated: true,
|
|
38407
40220
|
items: { format: "uuid", type: "string" },
|
|
38408
|
-
type: "array"
|
|
40221
|
+
type: "array",
|
|
40222
|
+
"x-deprecated": "Use `space_ids`."
|
|
38409
40223
|
},
|
|
38410
40224
|
requested_access_methods: {
|
|
38411
40225
|
items: {
|
|
@@ -38421,6 +40235,11 @@ var openapi_default = {
|
|
|
38421
40235
|
},
|
|
38422
40236
|
type: "array"
|
|
38423
40237
|
},
|
|
40238
|
+
space_ids: {
|
|
40239
|
+
description: "Set of IDs of existing spaces to which access is being granted.",
|
|
40240
|
+
items: { format: "uuid", type: "string" },
|
|
40241
|
+
type: "array"
|
|
40242
|
+
},
|
|
38424
40243
|
starts_at: {
|
|
38425
40244
|
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.",
|
|
38426
40245
|
format: "date-time",
|
|
@@ -38463,9 +40282,10 @@ var openapi_default = {
|
|
|
38463
40282
|
type: "string"
|
|
38464
40283
|
},
|
|
38465
40284
|
location_ids: {
|
|
38466
|
-
|
|
40285
|
+
deprecated: true,
|
|
38467
40286
|
items: { format: "uuid", type: "string" },
|
|
38468
|
-
type: "array"
|
|
40287
|
+
type: "array",
|
|
40288
|
+
"x-deprecated": "Use `space_ids`."
|
|
38469
40289
|
},
|
|
38470
40290
|
requested_access_methods: {
|
|
38471
40291
|
description: "Access methods that the user requested for this access grant.",
|
|
@@ -38502,6 +40322,11 @@ var openapi_default = {
|
|
|
38502
40322
|
},
|
|
38503
40323
|
type: "array"
|
|
38504
40324
|
},
|
|
40325
|
+
space_ids: {
|
|
40326
|
+
description: "IDs of the spaces to which access is being given.",
|
|
40327
|
+
items: { format: "uuid", type: "string" },
|
|
40328
|
+
type: "array"
|
|
40329
|
+
},
|
|
38505
40330
|
user_identity_id: {
|
|
38506
40331
|
description: "ID of user identity to which access is being granted.",
|
|
38507
40332
|
format: "uuid",
|
|
@@ -38518,6 +40343,7 @@ var openapi_default = {
|
|
|
38518
40343
|
"access_grant_id",
|
|
38519
40344
|
"user_identity_id",
|
|
38520
40345
|
"location_ids",
|
|
40346
|
+
"space_ids",
|
|
38521
40347
|
"requested_access_methods",
|
|
38522
40348
|
"access_method_ids",
|
|
38523
40349
|
"display_name",
|
|
@@ -38655,9 +40481,10 @@ var openapi_default = {
|
|
|
38655
40481
|
type: "string"
|
|
38656
40482
|
},
|
|
38657
40483
|
location_ids: {
|
|
38658
|
-
|
|
40484
|
+
deprecated: true,
|
|
38659
40485
|
items: { format: "uuid", type: "string" },
|
|
38660
|
-
type: "array"
|
|
40486
|
+
type: "array",
|
|
40487
|
+
"x-deprecated": "Use `space_ids`."
|
|
38661
40488
|
},
|
|
38662
40489
|
requested_access_methods: {
|
|
38663
40490
|
description: "Access methods that the user requested for this access grant.",
|
|
@@ -38694,6 +40521,11 @@ var openapi_default = {
|
|
|
38694
40521
|
},
|
|
38695
40522
|
type: "array"
|
|
38696
40523
|
},
|
|
40524
|
+
space_ids: {
|
|
40525
|
+
description: "IDs of the spaces to which access is being given.",
|
|
40526
|
+
items: { format: "uuid", type: "string" },
|
|
40527
|
+
type: "array"
|
|
40528
|
+
},
|
|
38697
40529
|
user_identity_id: {
|
|
38698
40530
|
description: "ID of user identity to which access is being granted.",
|
|
38699
40531
|
format: "uuid",
|
|
@@ -38710,6 +40542,7 @@ var openapi_default = {
|
|
|
38710
40542
|
"access_grant_id",
|
|
38711
40543
|
"user_identity_id",
|
|
38712
40544
|
"location_ids",
|
|
40545
|
+
"space_ids",
|
|
38713
40546
|
"requested_access_methods",
|
|
38714
40547
|
"access_method_ids",
|
|
38715
40548
|
"display_name",
|
|
@@ -38766,7 +40599,13 @@ var openapi_default = {
|
|
|
38766
40599
|
type: "string"
|
|
38767
40600
|
},
|
|
38768
40601
|
location_id: {
|
|
38769
|
-
|
|
40602
|
+
deprecated: true,
|
|
40603
|
+
format: "uuid",
|
|
40604
|
+
type: "string",
|
|
40605
|
+
"x-deprecated": "Use `space_id`."
|
|
40606
|
+
},
|
|
40607
|
+
space_id: {
|
|
40608
|
+
description: "ID of space to filter list of access grants by.",
|
|
38770
40609
|
format: "uuid",
|
|
38771
40610
|
type: "string"
|
|
38772
40611
|
},
|
|
@@ -38810,9 +40649,10 @@ var openapi_default = {
|
|
|
38810
40649
|
type: "string"
|
|
38811
40650
|
},
|
|
38812
40651
|
location_ids: {
|
|
38813
|
-
|
|
40652
|
+
deprecated: true,
|
|
38814
40653
|
items: { format: "uuid", type: "string" },
|
|
38815
|
-
type: "array"
|
|
40654
|
+
type: "array",
|
|
40655
|
+
"x-deprecated": "Use `space_ids`."
|
|
38816
40656
|
},
|
|
38817
40657
|
requested_access_methods: {
|
|
38818
40658
|
description: "Access methods that the user requested for this access grant.",
|
|
@@ -38849,6 +40689,11 @@ var openapi_default = {
|
|
|
38849
40689
|
},
|
|
38850
40690
|
type: "array"
|
|
38851
40691
|
},
|
|
40692
|
+
space_ids: {
|
|
40693
|
+
description: "IDs of the spaces to which access is being given.",
|
|
40694
|
+
items: { format: "uuid", type: "string" },
|
|
40695
|
+
type: "array"
|
|
40696
|
+
},
|
|
38852
40697
|
user_identity_id: {
|
|
38853
40698
|
description: "ID of user identity to which access is being granted.",
|
|
38854
40699
|
format: "uuid",
|
|
@@ -38865,6 +40710,7 @@ var openapi_default = {
|
|
|
38865
40710
|
"access_grant_id",
|
|
38866
40711
|
"user_identity_id",
|
|
38867
40712
|
"location_ids",
|
|
40713
|
+
"space_ids",
|
|
38868
40714
|
"requested_access_methods",
|
|
38869
40715
|
"access_method_ids",
|
|
38870
40716
|
"display_name",
|