@seamapi/types 1.469.0 → 1.470.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 +0 -849
- package/dist/connect.cjs.map +1 -1
- package/dist/connect.d.cts +0 -1396
- package/dist/index.cjs +0 -849
- package/dist/index.cjs.map +1 -1
- package/lib/seam/connect/openapi.d.ts +0 -1083
- package/lib/seam/connect/openapi.js +0 -849
- package/lib/seam/connect/openapi.js.map +1 -1
- package/lib/seam/connect/route-types.d.ts +0 -313
- package/package.json +1 -1
- package/src/lib/seam/connect/openapi.ts +0 -875
- package/src/lib/seam/connect/route-types.ts +0 -318
package/dist/index.cjs
CHANGED
|
@@ -54553,855 +54553,6 @@ var openapi_default = {
|
|
|
54553
54553
|
"x-title": "Update the Thermostat Weekly Program"
|
|
54554
54554
|
}
|
|
54555
54555
|
},
|
|
54556
|
-
"/unstable_access_grants/create": {
|
|
54557
|
-
post: {
|
|
54558
|
-
description: "Creates a new access grant.",
|
|
54559
|
-
operationId: "unstableAccessGrantsCreatePost",
|
|
54560
|
-
requestBody: {
|
|
54561
|
-
content: {
|
|
54562
|
-
"application/json": {
|
|
54563
|
-
schema: {
|
|
54564
|
-
allOf: [
|
|
54565
|
-
{
|
|
54566
|
-
oneOf: [
|
|
54567
|
-
{
|
|
54568
|
-
properties: {
|
|
54569
|
-
user_identity_id: {
|
|
54570
|
-
description: "ID of user identity for whom you want to grant access.",
|
|
54571
|
-
format: "uuid",
|
|
54572
|
-
type: "string"
|
|
54573
|
-
}
|
|
54574
|
-
},
|
|
54575
|
-
required: ["user_identity_id"],
|
|
54576
|
-
type: "object"
|
|
54577
|
-
},
|
|
54578
|
-
{
|
|
54579
|
-
properties: {
|
|
54580
|
-
user_identity: {
|
|
54581
|
-
description: "User identity. When used, creates a new user identity with the specified details and grants them access.",
|
|
54582
|
-
properties: {
|
|
54583
|
-
email_address: {
|
|
54584
|
-
description: "Unique email address for the user identity.",
|
|
54585
|
-
format: "email",
|
|
54586
|
-
nullable: true,
|
|
54587
|
-
type: "string"
|
|
54588
|
-
},
|
|
54589
|
-
full_name: {
|
|
54590
|
-
minLength: 1,
|
|
54591
|
-
nullable: true,
|
|
54592
|
-
type: "string"
|
|
54593
|
-
},
|
|
54594
|
-
phone_number: {
|
|
54595
|
-
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).",
|
|
54596
|
-
nullable: true,
|
|
54597
|
-
type: "string"
|
|
54598
|
-
}
|
|
54599
|
-
},
|
|
54600
|
-
type: "object"
|
|
54601
|
-
}
|
|
54602
|
-
},
|
|
54603
|
-
required: ["user_identity"],
|
|
54604
|
-
type: "object"
|
|
54605
|
-
}
|
|
54606
|
-
]
|
|
54607
|
-
},
|
|
54608
|
-
{
|
|
54609
|
-
properties: {
|
|
54610
|
-
acs_entrance_ids: {
|
|
54611
|
-
default: [],
|
|
54612
|
-
description: "IDs of the [entrances](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details) to which you want to grant access.",
|
|
54613
|
-
items: { format: "uuid", type: "string" },
|
|
54614
|
-
type: "array"
|
|
54615
|
-
},
|
|
54616
|
-
device_ids: {
|
|
54617
|
-
default: [],
|
|
54618
|
-
description: "IDs of the devices to which you want to grant access.",
|
|
54619
|
-
items: { format: "uuid", type: "string" },
|
|
54620
|
-
type: "array"
|
|
54621
|
-
},
|
|
54622
|
-
ends_at: {
|
|
54623
|
-
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`.",
|
|
54624
|
-
format: "date-time",
|
|
54625
|
-
type: "string"
|
|
54626
|
-
},
|
|
54627
|
-
location: {
|
|
54628
|
-
description: "Location. When used, creates a new location with the specified entrances and devices, and gives the user access to this location.",
|
|
54629
|
-
properties: {
|
|
54630
|
-
acs_entrance_ids: {
|
|
54631
|
-
default: [],
|
|
54632
|
-
deprecated: true,
|
|
54633
|
-
items: { format: "uuid", type: "string" },
|
|
54634
|
-
type: "array",
|
|
54635
|
-
"x-deprecated": "Use `acs_entrance_ids` at the top level."
|
|
54636
|
-
},
|
|
54637
|
-
device_ids: {
|
|
54638
|
-
default: [],
|
|
54639
|
-
deprecated: true,
|
|
54640
|
-
items: { format: "uuid", type: "string" },
|
|
54641
|
-
type: "array",
|
|
54642
|
-
"x-deprecated": "Use `device_ids` at the top level."
|
|
54643
|
-
},
|
|
54644
|
-
name: {
|
|
54645
|
-
description: "Name of the location.",
|
|
54646
|
-
type: "string"
|
|
54647
|
-
}
|
|
54648
|
-
},
|
|
54649
|
-
type: "object"
|
|
54650
|
-
},
|
|
54651
|
-
location_ids: {
|
|
54652
|
-
deprecated: true,
|
|
54653
|
-
items: { format: "uuid", type: "string" },
|
|
54654
|
-
type: "array",
|
|
54655
|
-
"x-deprecated": "Use `space_ids`."
|
|
54656
|
-
},
|
|
54657
|
-
requested_access_methods: {
|
|
54658
|
-
items: {
|
|
54659
|
-
properties: {
|
|
54660
|
-
mode: {
|
|
54661
|
-
description: "Access method mode.",
|
|
54662
|
-
enum: ["code", "card", "mobile_key"],
|
|
54663
|
-
type: "string"
|
|
54664
|
-
}
|
|
54665
|
-
},
|
|
54666
|
-
required: ["mode"],
|
|
54667
|
-
type: "object"
|
|
54668
|
-
},
|
|
54669
|
-
type: "array"
|
|
54670
|
-
},
|
|
54671
|
-
space_ids: {
|
|
54672
|
-
description: "IDs of the existing spaces to which you want to grant access.",
|
|
54673
|
-
items: { format: "uuid", type: "string" },
|
|
54674
|
-
type: "array"
|
|
54675
|
-
},
|
|
54676
|
-
starts_at: {
|
|
54677
|
-
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.",
|
|
54678
|
-
format: "date-time",
|
|
54679
|
-
type: "string"
|
|
54680
|
-
}
|
|
54681
|
-
},
|
|
54682
|
-
required: ["requested_access_methods"],
|
|
54683
|
-
type: "object"
|
|
54684
|
-
}
|
|
54685
|
-
]
|
|
54686
|
-
}
|
|
54687
|
-
}
|
|
54688
|
-
}
|
|
54689
|
-
},
|
|
54690
|
-
responses: {
|
|
54691
|
-
200: {
|
|
54692
|
-
content: {
|
|
54693
|
-
"application/json": {
|
|
54694
|
-
schema: {
|
|
54695
|
-
properties: {
|
|
54696
|
-
access_grant: { $ref: "#/components/schemas/access_grant" },
|
|
54697
|
-
ok: { type: "boolean" }
|
|
54698
|
-
},
|
|
54699
|
-
required: ["access_grant", "ok"],
|
|
54700
|
-
type: "object"
|
|
54701
|
-
}
|
|
54702
|
-
}
|
|
54703
|
-
},
|
|
54704
|
-
description: "OK"
|
|
54705
|
-
},
|
|
54706
|
-
400: { description: "Bad Request" },
|
|
54707
|
-
401: { description: "Unauthorized" }
|
|
54708
|
-
},
|
|
54709
|
-
security: [
|
|
54710
|
-
{ pat_with_workspace: [] },
|
|
54711
|
-
{ console_session_with_workspace: [] },
|
|
54712
|
-
{ api_key: [] },
|
|
54713
|
-
{ client_session_with_customer: [] }
|
|
54714
|
-
],
|
|
54715
|
-
summary: "/unstable_access_grants/create",
|
|
54716
|
-
tags: [],
|
|
54717
|
-
"x-fern-sdk-group-name": ["unstable_access_grants"],
|
|
54718
|
-
"x-fern-sdk-method-name": "create",
|
|
54719
|
-
"x-fern-sdk-return-value": "access_grant",
|
|
54720
|
-
"x-response-key": "access_grant",
|
|
54721
|
-
"x-title": "Create an Access Grant",
|
|
54722
|
-
"x-undocumented": "Unreleased."
|
|
54723
|
-
}
|
|
54724
|
-
},
|
|
54725
|
-
"/unstable_access_grants/delete": {
|
|
54726
|
-
delete: {
|
|
54727
|
-
description: "Deletes an access grant.",
|
|
54728
|
-
operationId: "unstableAccessGrantsDeleteDelete",
|
|
54729
|
-
parameters: [
|
|
54730
|
-
{
|
|
54731
|
-
in: "query",
|
|
54732
|
-
name: "access_grant_id",
|
|
54733
|
-
required: true,
|
|
54734
|
-
schema: {
|
|
54735
|
-
description: "ID of access grant that you want to delete.",
|
|
54736
|
-
format: "uuid",
|
|
54737
|
-
type: "string"
|
|
54738
|
-
}
|
|
54739
|
-
}
|
|
54740
|
-
],
|
|
54741
|
-
responses: {
|
|
54742
|
-
200: {
|
|
54743
|
-
content: {
|
|
54744
|
-
"application/json": {
|
|
54745
|
-
schema: {
|
|
54746
|
-
properties: { ok: { type: "boolean" } },
|
|
54747
|
-
required: ["ok"],
|
|
54748
|
-
type: "object"
|
|
54749
|
-
}
|
|
54750
|
-
}
|
|
54751
|
-
},
|
|
54752
|
-
description: "OK"
|
|
54753
|
-
},
|
|
54754
|
-
400: { description: "Bad Request" },
|
|
54755
|
-
401: { description: "Unauthorized" }
|
|
54756
|
-
},
|
|
54757
|
-
security: [
|
|
54758
|
-
{ pat_with_workspace: [] },
|
|
54759
|
-
{ console_session_with_workspace: [] },
|
|
54760
|
-
{ api_key: [] },
|
|
54761
|
-
{ client_session_with_customer: [] }
|
|
54762
|
-
],
|
|
54763
|
-
summary: "/unstable_access_grants/delete",
|
|
54764
|
-
tags: [],
|
|
54765
|
-
"x-fern-sdk-group-name": ["unstable_access_grants"],
|
|
54766
|
-
"x-fern-sdk-method-name": "delete",
|
|
54767
|
-
"x-response-key": null,
|
|
54768
|
-
"x-title": "Delete an Access Grant",
|
|
54769
|
-
"x-undocumented": "Unreleased."
|
|
54770
|
-
},
|
|
54771
|
-
post: {
|
|
54772
|
-
description: "Deletes an access grant.",
|
|
54773
|
-
operationId: "unstableAccessGrantsDeletePost",
|
|
54774
|
-
requestBody: {
|
|
54775
|
-
content: {
|
|
54776
|
-
"application/json": {
|
|
54777
|
-
schema: {
|
|
54778
|
-
properties: {
|
|
54779
|
-
access_grant_id: {
|
|
54780
|
-
description: "ID of access grant that you want to delete.",
|
|
54781
|
-
format: "uuid",
|
|
54782
|
-
type: "string"
|
|
54783
|
-
}
|
|
54784
|
-
},
|
|
54785
|
-
required: ["access_grant_id"],
|
|
54786
|
-
type: "object"
|
|
54787
|
-
}
|
|
54788
|
-
}
|
|
54789
|
-
}
|
|
54790
|
-
},
|
|
54791
|
-
responses: {
|
|
54792
|
-
200: {
|
|
54793
|
-
content: {
|
|
54794
|
-
"application/json": {
|
|
54795
|
-
schema: {
|
|
54796
|
-
properties: { ok: { type: "boolean" } },
|
|
54797
|
-
required: ["ok"],
|
|
54798
|
-
type: "object"
|
|
54799
|
-
}
|
|
54800
|
-
}
|
|
54801
|
-
},
|
|
54802
|
-
description: "OK"
|
|
54803
|
-
},
|
|
54804
|
-
400: { description: "Bad Request" },
|
|
54805
|
-
401: { description: "Unauthorized" }
|
|
54806
|
-
},
|
|
54807
|
-
security: [
|
|
54808
|
-
{ pat_with_workspace: [] },
|
|
54809
|
-
{ console_session_with_workspace: [] },
|
|
54810
|
-
{ api_key: [] },
|
|
54811
|
-
{ client_session_with_customer: [] }
|
|
54812
|
-
],
|
|
54813
|
-
summary: "/unstable_access_grants/delete",
|
|
54814
|
-
tags: [],
|
|
54815
|
-
"x-fern-sdk-group-name": ["unstable_access_grants"],
|
|
54816
|
-
"x-fern-sdk-method-name": "delete",
|
|
54817
|
-
"x-response-key": null,
|
|
54818
|
-
"x-title": "Delete an Access Grant",
|
|
54819
|
-
"x-undocumented": "Unreleased."
|
|
54820
|
-
}
|
|
54821
|
-
},
|
|
54822
|
-
"/unstable_access_grants/get": {
|
|
54823
|
-
get: {
|
|
54824
|
-
description: "Gets an access grant.",
|
|
54825
|
-
operationId: "unstableAccessGrantsGetGet",
|
|
54826
|
-
parameters: [
|
|
54827
|
-
{
|
|
54828
|
-
in: "query",
|
|
54829
|
-
name: "access_grant_id",
|
|
54830
|
-
required: true,
|
|
54831
|
-
schema: {
|
|
54832
|
-
description: "ID of access grant that you want to get.",
|
|
54833
|
-
format: "uuid",
|
|
54834
|
-
type: "string"
|
|
54835
|
-
}
|
|
54836
|
-
}
|
|
54837
|
-
],
|
|
54838
|
-
responses: {
|
|
54839
|
-
200: {
|
|
54840
|
-
content: {
|
|
54841
|
-
"application/json": {
|
|
54842
|
-
schema: {
|
|
54843
|
-
properties: {
|
|
54844
|
-
access_grant: { $ref: "#/components/schemas/access_grant" },
|
|
54845
|
-
ok: { type: "boolean" }
|
|
54846
|
-
},
|
|
54847
|
-
required: ["access_grant", "ok"],
|
|
54848
|
-
type: "object"
|
|
54849
|
-
}
|
|
54850
|
-
}
|
|
54851
|
-
},
|
|
54852
|
-
description: "OK"
|
|
54853
|
-
},
|
|
54854
|
-
400: { description: "Bad Request" },
|
|
54855
|
-
401: { description: "Unauthorized" }
|
|
54856
|
-
},
|
|
54857
|
-
security: [
|
|
54858
|
-
{ pat_with_workspace: [] },
|
|
54859
|
-
{ console_session_with_workspace: [] },
|
|
54860
|
-
{ api_key: [] },
|
|
54861
|
-
{ client_session_with_customer: [] }
|
|
54862
|
-
],
|
|
54863
|
-
summary: "/unstable_access_grants/get",
|
|
54864
|
-
tags: [],
|
|
54865
|
-
"x-fern-sdk-group-name": ["unstable_access_grants"],
|
|
54866
|
-
"x-fern-sdk-method-name": "get",
|
|
54867
|
-
"x-fern-sdk-return-value": "access_grant",
|
|
54868
|
-
"x-response-key": "access_grant",
|
|
54869
|
-
"x-title": "Get an Access Grant",
|
|
54870
|
-
"x-undocumented": "Unreleased."
|
|
54871
|
-
},
|
|
54872
|
-
post: {
|
|
54873
|
-
description: "Gets an access grant.",
|
|
54874
|
-
operationId: "unstableAccessGrantsGetPost",
|
|
54875
|
-
requestBody: {
|
|
54876
|
-
content: {
|
|
54877
|
-
"application/json": {
|
|
54878
|
-
schema: {
|
|
54879
|
-
properties: {
|
|
54880
|
-
access_grant_id: {
|
|
54881
|
-
description: "ID of access grant that you want to get.",
|
|
54882
|
-
format: "uuid",
|
|
54883
|
-
type: "string"
|
|
54884
|
-
}
|
|
54885
|
-
},
|
|
54886
|
-
required: ["access_grant_id"],
|
|
54887
|
-
type: "object"
|
|
54888
|
-
}
|
|
54889
|
-
}
|
|
54890
|
-
}
|
|
54891
|
-
},
|
|
54892
|
-
responses: {
|
|
54893
|
-
200: {
|
|
54894
|
-
content: {
|
|
54895
|
-
"application/json": {
|
|
54896
|
-
schema: {
|
|
54897
|
-
properties: {
|
|
54898
|
-
access_grant: { $ref: "#/components/schemas/access_grant" },
|
|
54899
|
-
ok: { type: "boolean" }
|
|
54900
|
-
},
|
|
54901
|
-
required: ["access_grant", "ok"],
|
|
54902
|
-
type: "object"
|
|
54903
|
-
}
|
|
54904
|
-
}
|
|
54905
|
-
},
|
|
54906
|
-
description: "OK"
|
|
54907
|
-
},
|
|
54908
|
-
400: { description: "Bad Request" },
|
|
54909
|
-
401: { description: "Unauthorized" }
|
|
54910
|
-
},
|
|
54911
|
-
security: [
|
|
54912
|
-
{ pat_with_workspace: [] },
|
|
54913
|
-
{ console_session_with_workspace: [] },
|
|
54914
|
-
{ api_key: [] },
|
|
54915
|
-
{ client_session_with_customer: [] }
|
|
54916
|
-
],
|
|
54917
|
-
summary: "/unstable_access_grants/get",
|
|
54918
|
-
tags: [],
|
|
54919
|
-
"x-fern-sdk-group-name": ["unstable_access_grants"],
|
|
54920
|
-
"x-fern-sdk-method-name": "get",
|
|
54921
|
-
"x-fern-sdk-return-value": "access_grant",
|
|
54922
|
-
"x-response-key": "access_grant",
|
|
54923
|
-
"x-title": "Get an Access Grant",
|
|
54924
|
-
"x-undocumented": "Unreleased."
|
|
54925
|
-
}
|
|
54926
|
-
},
|
|
54927
|
-
"/unstable_access_grants/list": {
|
|
54928
|
-
get: {
|
|
54929
|
-
description: "Returns a list of all access grants.",
|
|
54930
|
-
operationId: "unstableAccessGrantsListGet",
|
|
54931
|
-
parameters: [
|
|
54932
|
-
{
|
|
54933
|
-
in: "query",
|
|
54934
|
-
name: "user_identity_id",
|
|
54935
|
-
schema: {
|
|
54936
|
-
description: "ID of the user identity by which you want to filter the list of access grants.",
|
|
54937
|
-
format: "uuid",
|
|
54938
|
-
type: "string"
|
|
54939
|
-
}
|
|
54940
|
-
},
|
|
54941
|
-
{
|
|
54942
|
-
in: "query",
|
|
54943
|
-
name: "acs_system_id",
|
|
54944
|
-
schema: {
|
|
54945
|
-
description: "ID of the access system by which you want to filter the list of access grants.",
|
|
54946
|
-
format: "uuid",
|
|
54947
|
-
type: "string"
|
|
54948
|
-
}
|
|
54949
|
-
},
|
|
54950
|
-
{
|
|
54951
|
-
in: "query",
|
|
54952
|
-
name: "acs_entrance_id",
|
|
54953
|
-
schema: {
|
|
54954
|
-
description: "ID of the entrance by which you want to filter the list of access grants.",
|
|
54955
|
-
format: "uuid",
|
|
54956
|
-
type: "string"
|
|
54957
|
-
}
|
|
54958
|
-
},
|
|
54959
|
-
{
|
|
54960
|
-
in: "query",
|
|
54961
|
-
name: "location_id",
|
|
54962
|
-
schema: {
|
|
54963
|
-
deprecated: true,
|
|
54964
|
-
format: "uuid",
|
|
54965
|
-
type: "string",
|
|
54966
|
-
"x-deprecated": "Use `space_id`."
|
|
54967
|
-
}
|
|
54968
|
-
},
|
|
54969
|
-
{
|
|
54970
|
-
in: "query",
|
|
54971
|
-
name: "space_id",
|
|
54972
|
-
schema: {
|
|
54973
|
-
description: "ID of the space by which you want to filter the list of access grants.",
|
|
54974
|
-
format: "uuid",
|
|
54975
|
-
type: "string"
|
|
54976
|
-
}
|
|
54977
|
-
}
|
|
54978
|
-
],
|
|
54979
|
-
responses: {
|
|
54980
|
-
200: {
|
|
54981
|
-
content: {
|
|
54982
|
-
"application/json": {
|
|
54983
|
-
schema: {
|
|
54984
|
-
properties: {
|
|
54985
|
-
access_grants: {
|
|
54986
|
-
items: { $ref: "#/components/schemas/access_grant" },
|
|
54987
|
-
type: "array"
|
|
54988
|
-
},
|
|
54989
|
-
ok: { type: "boolean" }
|
|
54990
|
-
},
|
|
54991
|
-
required: ["access_grants", "ok"],
|
|
54992
|
-
type: "object"
|
|
54993
|
-
}
|
|
54994
|
-
}
|
|
54995
|
-
},
|
|
54996
|
-
description: "OK"
|
|
54997
|
-
},
|
|
54998
|
-
400: { description: "Bad Request" },
|
|
54999
|
-
401: { description: "Unauthorized" }
|
|
55000
|
-
},
|
|
55001
|
-
security: [
|
|
55002
|
-
{ pat_with_workspace: [] },
|
|
55003
|
-
{ console_session_with_workspace: [] },
|
|
55004
|
-
{ api_key: [] },
|
|
55005
|
-
{ client_session_with_customer: [] }
|
|
55006
|
-
],
|
|
55007
|
-
summary: "/unstable_access_grants/list",
|
|
55008
|
-
tags: [],
|
|
55009
|
-
"x-fern-sdk-group-name": ["unstable_access_grants"],
|
|
55010
|
-
"x-fern-sdk-method-name": "list",
|
|
55011
|
-
"x-fern-sdk-return-value": "access_grants",
|
|
55012
|
-
"x-response-key": "access_grants",
|
|
55013
|
-
"x-title": "List Access Grants",
|
|
55014
|
-
"x-undocumented": "Unreleased."
|
|
55015
|
-
},
|
|
55016
|
-
post: {
|
|
55017
|
-
description: "Returns a list of all access grants.",
|
|
55018
|
-
operationId: "unstableAccessGrantsListPost",
|
|
55019
|
-
requestBody: {
|
|
55020
|
-
content: {
|
|
55021
|
-
"application/json": {
|
|
55022
|
-
schema: {
|
|
55023
|
-
properties: {
|
|
55024
|
-
acs_entrance_id: {
|
|
55025
|
-
description: "ID of the entrance by which you want to filter the list of access grants.",
|
|
55026
|
-
format: "uuid",
|
|
55027
|
-
type: "string"
|
|
55028
|
-
},
|
|
55029
|
-
acs_system_id: {
|
|
55030
|
-
description: "ID of the access system by which you want to filter the list of access grants.",
|
|
55031
|
-
format: "uuid",
|
|
55032
|
-
type: "string"
|
|
55033
|
-
},
|
|
55034
|
-
location_id: {
|
|
55035
|
-
deprecated: true,
|
|
55036
|
-
format: "uuid",
|
|
55037
|
-
type: "string",
|
|
55038
|
-
"x-deprecated": "Use `space_id`."
|
|
55039
|
-
},
|
|
55040
|
-
space_id: {
|
|
55041
|
-
description: "ID of the space by which you want to filter the list of access grants.",
|
|
55042
|
-
format: "uuid",
|
|
55043
|
-
type: "string"
|
|
55044
|
-
},
|
|
55045
|
-
user_identity_id: {
|
|
55046
|
-
description: "ID of the user identity by which you want to filter the list of access grants.",
|
|
55047
|
-
format: "uuid",
|
|
55048
|
-
type: "string"
|
|
55049
|
-
}
|
|
55050
|
-
},
|
|
55051
|
-
type: "object"
|
|
55052
|
-
}
|
|
55053
|
-
}
|
|
55054
|
-
}
|
|
55055
|
-
},
|
|
55056
|
-
responses: {
|
|
55057
|
-
200: {
|
|
55058
|
-
content: {
|
|
55059
|
-
"application/json": {
|
|
55060
|
-
schema: {
|
|
55061
|
-
properties: {
|
|
55062
|
-
access_grants: {
|
|
55063
|
-
items: { $ref: "#/components/schemas/access_grant" },
|
|
55064
|
-
type: "array"
|
|
55065
|
-
},
|
|
55066
|
-
ok: { type: "boolean" }
|
|
55067
|
-
},
|
|
55068
|
-
required: ["access_grants", "ok"],
|
|
55069
|
-
type: "object"
|
|
55070
|
-
}
|
|
55071
|
-
}
|
|
55072
|
-
},
|
|
55073
|
-
description: "OK"
|
|
55074
|
-
},
|
|
55075
|
-
400: { description: "Bad Request" },
|
|
55076
|
-
401: { description: "Unauthorized" }
|
|
55077
|
-
},
|
|
55078
|
-
security: [
|
|
55079
|
-
{ pat_with_workspace: [] },
|
|
55080
|
-
{ console_session_with_workspace: [] },
|
|
55081
|
-
{ api_key: [] },
|
|
55082
|
-
{ client_session_with_customer: [] }
|
|
55083
|
-
],
|
|
55084
|
-
summary: "/unstable_access_grants/list",
|
|
55085
|
-
tags: [],
|
|
55086
|
-
"x-fern-sdk-group-name": ["unstable_access_grants"],
|
|
55087
|
-
"x-fern-sdk-method-name": "list",
|
|
55088
|
-
"x-fern-sdk-return-value": "access_grants",
|
|
55089
|
-
"x-response-key": "access_grants",
|
|
55090
|
-
"x-title": "List Access Grants",
|
|
55091
|
-
"x-undocumented": "Unreleased."
|
|
55092
|
-
}
|
|
55093
|
-
},
|
|
55094
|
-
"/unstable_access_methods/delete": {
|
|
55095
|
-
delete: {
|
|
55096
|
-
description: "Deletes an access method.",
|
|
55097
|
-
operationId: "unstableAccessMethodsDeleteDelete",
|
|
55098
|
-
parameters: [
|
|
55099
|
-
{
|
|
55100
|
-
in: "query",
|
|
55101
|
-
name: "access_method_id",
|
|
55102
|
-
required: true,
|
|
55103
|
-
schema: {
|
|
55104
|
-
description: "ID of the access method that you want to delete.",
|
|
55105
|
-
format: "uuid",
|
|
55106
|
-
type: "string"
|
|
55107
|
-
}
|
|
55108
|
-
}
|
|
55109
|
-
],
|
|
55110
|
-
responses: {
|
|
55111
|
-
200: {
|
|
55112
|
-
content: {
|
|
55113
|
-
"application/json": {
|
|
55114
|
-
schema: {
|
|
55115
|
-
properties: { ok: { type: "boolean" } },
|
|
55116
|
-
required: ["ok"],
|
|
55117
|
-
type: "object"
|
|
55118
|
-
}
|
|
55119
|
-
}
|
|
55120
|
-
},
|
|
55121
|
-
description: "OK"
|
|
55122
|
-
},
|
|
55123
|
-
400: { description: "Bad Request" },
|
|
55124
|
-
401: { description: "Unauthorized" }
|
|
55125
|
-
},
|
|
55126
|
-
security: [
|
|
55127
|
-
{ pat_with_workspace: [] },
|
|
55128
|
-
{ console_session_with_workspace: [] },
|
|
55129
|
-
{ api_key: [] }
|
|
55130
|
-
],
|
|
55131
|
-
summary: "/unstable_access_methods/delete",
|
|
55132
|
-
tags: [],
|
|
55133
|
-
"x-fern-sdk-group-name": ["unstable_access_methods"],
|
|
55134
|
-
"x-fern-sdk-method-name": "delete",
|
|
55135
|
-
"x-response-key": null,
|
|
55136
|
-
"x-title": "Delete an Access Method",
|
|
55137
|
-
"x-undocumented": "Unreleased."
|
|
55138
|
-
},
|
|
55139
|
-
post: {
|
|
55140
|
-
description: "Deletes an access method.",
|
|
55141
|
-
operationId: "unstableAccessMethodsDeletePost",
|
|
55142
|
-
requestBody: {
|
|
55143
|
-
content: {
|
|
55144
|
-
"application/json": {
|
|
55145
|
-
schema: {
|
|
55146
|
-
properties: {
|
|
55147
|
-
access_method_id: {
|
|
55148
|
-
description: "ID of the access method that you want to delete.",
|
|
55149
|
-
format: "uuid",
|
|
55150
|
-
type: "string"
|
|
55151
|
-
}
|
|
55152
|
-
},
|
|
55153
|
-
required: ["access_method_id"],
|
|
55154
|
-
type: "object"
|
|
55155
|
-
}
|
|
55156
|
-
}
|
|
55157
|
-
}
|
|
55158
|
-
},
|
|
55159
|
-
responses: {
|
|
55160
|
-
200: {
|
|
55161
|
-
content: {
|
|
55162
|
-
"application/json": {
|
|
55163
|
-
schema: {
|
|
55164
|
-
properties: { ok: { type: "boolean" } },
|
|
55165
|
-
required: ["ok"],
|
|
55166
|
-
type: "object"
|
|
55167
|
-
}
|
|
55168
|
-
}
|
|
55169
|
-
},
|
|
55170
|
-
description: "OK"
|
|
55171
|
-
},
|
|
55172
|
-
400: { description: "Bad Request" },
|
|
55173
|
-
401: { description: "Unauthorized" }
|
|
55174
|
-
},
|
|
55175
|
-
security: [
|
|
55176
|
-
{ pat_with_workspace: [] },
|
|
55177
|
-
{ console_session_with_workspace: [] },
|
|
55178
|
-
{ api_key: [] }
|
|
55179
|
-
],
|
|
55180
|
-
summary: "/unstable_access_methods/delete",
|
|
55181
|
-
tags: [],
|
|
55182
|
-
"x-fern-sdk-group-name": ["unstable_access_methods"],
|
|
55183
|
-
"x-fern-sdk-method-name": "delete",
|
|
55184
|
-
"x-response-key": null,
|
|
55185
|
-
"x-title": "Delete an Access Method",
|
|
55186
|
-
"x-undocumented": "Unreleased."
|
|
55187
|
-
}
|
|
55188
|
-
},
|
|
55189
|
-
"/unstable_access_methods/get": {
|
|
55190
|
-
get: {
|
|
55191
|
-
description: "Gets an access method.",
|
|
55192
|
-
operationId: "unstableAccessMethodsGetGet",
|
|
55193
|
-
parameters: [
|
|
55194
|
-
{
|
|
55195
|
-
in: "query",
|
|
55196
|
-
name: "access_method_id",
|
|
55197
|
-
required: true,
|
|
55198
|
-
schema: {
|
|
55199
|
-
description: "ID of the access method that you want to get.",
|
|
55200
|
-
format: "uuid",
|
|
55201
|
-
type: "string"
|
|
55202
|
-
}
|
|
55203
|
-
}
|
|
55204
|
-
],
|
|
55205
|
-
responses: {
|
|
55206
|
-
200: {
|
|
55207
|
-
content: {
|
|
55208
|
-
"application/json": {
|
|
55209
|
-
schema: {
|
|
55210
|
-
properties: {
|
|
55211
|
-
access_method: {
|
|
55212
|
-
$ref: "#/components/schemas/access_method"
|
|
55213
|
-
},
|
|
55214
|
-
ok: { type: "boolean" }
|
|
55215
|
-
},
|
|
55216
|
-
required: ["access_method", "ok"],
|
|
55217
|
-
type: "object"
|
|
55218
|
-
}
|
|
55219
|
-
}
|
|
55220
|
-
},
|
|
55221
|
-
description: "OK"
|
|
55222
|
-
},
|
|
55223
|
-
400: { description: "Bad Request" },
|
|
55224
|
-
401: { description: "Unauthorized" }
|
|
55225
|
-
},
|
|
55226
|
-
security: [
|
|
55227
|
-
{ pat_with_workspace: [] },
|
|
55228
|
-
{ console_session_with_workspace: [] },
|
|
55229
|
-
{ api_key: [] }
|
|
55230
|
-
],
|
|
55231
|
-
summary: "/unstable_access_methods/get",
|
|
55232
|
-
tags: [],
|
|
55233
|
-
"x-fern-sdk-group-name": ["unstable_access_methods"],
|
|
55234
|
-
"x-fern-sdk-method-name": "get",
|
|
55235
|
-
"x-fern-sdk-return-value": "access_method",
|
|
55236
|
-
"x-response-key": "access_method",
|
|
55237
|
-
"x-title": "Get an Access Method",
|
|
55238
|
-
"x-undocumented": "Unreleased."
|
|
55239
|
-
},
|
|
55240
|
-
post: {
|
|
55241
|
-
description: "Gets an access method.",
|
|
55242
|
-
operationId: "unstableAccessMethodsGetPost",
|
|
55243
|
-
requestBody: {
|
|
55244
|
-
content: {
|
|
55245
|
-
"application/json": {
|
|
55246
|
-
schema: {
|
|
55247
|
-
properties: {
|
|
55248
|
-
access_method_id: {
|
|
55249
|
-
description: "ID of the access method that you want to get.",
|
|
55250
|
-
format: "uuid",
|
|
55251
|
-
type: "string"
|
|
55252
|
-
}
|
|
55253
|
-
},
|
|
55254
|
-
required: ["access_method_id"],
|
|
55255
|
-
type: "object"
|
|
55256
|
-
}
|
|
55257
|
-
}
|
|
55258
|
-
}
|
|
55259
|
-
},
|
|
55260
|
-
responses: {
|
|
55261
|
-
200: {
|
|
55262
|
-
content: {
|
|
55263
|
-
"application/json": {
|
|
55264
|
-
schema: {
|
|
55265
|
-
properties: {
|
|
55266
|
-
access_method: {
|
|
55267
|
-
$ref: "#/components/schemas/access_method"
|
|
55268
|
-
},
|
|
55269
|
-
ok: { type: "boolean" }
|
|
55270
|
-
},
|
|
55271
|
-
required: ["access_method", "ok"],
|
|
55272
|
-
type: "object"
|
|
55273
|
-
}
|
|
55274
|
-
}
|
|
55275
|
-
},
|
|
55276
|
-
description: "OK"
|
|
55277
|
-
},
|
|
55278
|
-
400: { description: "Bad Request" },
|
|
55279
|
-
401: { description: "Unauthorized" }
|
|
55280
|
-
},
|
|
55281
|
-
security: [
|
|
55282
|
-
{ pat_with_workspace: [] },
|
|
55283
|
-
{ console_session_with_workspace: [] },
|
|
55284
|
-
{ api_key: [] }
|
|
55285
|
-
],
|
|
55286
|
-
summary: "/unstable_access_methods/get",
|
|
55287
|
-
tags: [],
|
|
55288
|
-
"x-fern-sdk-group-name": ["unstable_access_methods"],
|
|
55289
|
-
"x-fern-sdk-method-name": "get",
|
|
55290
|
-
"x-fern-sdk-return-value": "access_method",
|
|
55291
|
-
"x-response-key": "access_method",
|
|
55292
|
-
"x-title": "Get an Access Method",
|
|
55293
|
-
"x-undocumented": "Unreleased."
|
|
55294
|
-
}
|
|
55295
|
-
},
|
|
55296
|
-
"/unstable_access_methods/list": {
|
|
55297
|
-
get: {
|
|
55298
|
-
description: "Lists all access methods, usually filtered by access grant.",
|
|
55299
|
-
operationId: "unstableAccessMethodsListGet",
|
|
55300
|
-
parameters: [
|
|
55301
|
-
{
|
|
55302
|
-
in: "query",
|
|
55303
|
-
name: "access_grant_id",
|
|
55304
|
-
required: true,
|
|
55305
|
-
schema: {
|
|
55306
|
-
description: "ID of the access grant by which to filter the list of access methods.",
|
|
55307
|
-
format: "uuid",
|
|
55308
|
-
type: "string"
|
|
55309
|
-
}
|
|
55310
|
-
}
|
|
55311
|
-
],
|
|
55312
|
-
responses: {
|
|
55313
|
-
200: {
|
|
55314
|
-
content: {
|
|
55315
|
-
"application/json": {
|
|
55316
|
-
schema: {
|
|
55317
|
-
properties: {
|
|
55318
|
-
access_methods: {
|
|
55319
|
-
items: { $ref: "#/components/schemas/access_method" },
|
|
55320
|
-
type: "array"
|
|
55321
|
-
},
|
|
55322
|
-
ok: { type: "boolean" }
|
|
55323
|
-
},
|
|
55324
|
-
required: ["access_methods", "ok"],
|
|
55325
|
-
type: "object"
|
|
55326
|
-
}
|
|
55327
|
-
}
|
|
55328
|
-
},
|
|
55329
|
-
description: "OK"
|
|
55330
|
-
},
|
|
55331
|
-
400: { description: "Bad Request" },
|
|
55332
|
-
401: { description: "Unauthorized" }
|
|
55333
|
-
},
|
|
55334
|
-
security: [
|
|
55335
|
-
{ pat_with_workspace: [] },
|
|
55336
|
-
{ console_session_with_workspace: [] },
|
|
55337
|
-
{ api_key: [] }
|
|
55338
|
-
],
|
|
55339
|
-
summary: "/unstable_access_methods/list",
|
|
55340
|
-
tags: [],
|
|
55341
|
-
"x-fern-sdk-group-name": ["unstable_access_methods"],
|
|
55342
|
-
"x-fern-sdk-method-name": "list",
|
|
55343
|
-
"x-fern-sdk-return-value": "access_methods",
|
|
55344
|
-
"x-response-key": "access_methods",
|
|
55345
|
-
"x-title": "List Access Methods",
|
|
55346
|
-
"x-undocumented": "Unreleased."
|
|
55347
|
-
},
|
|
55348
|
-
post: {
|
|
55349
|
-
description: "Lists all access methods, usually filtered by access grant.",
|
|
55350
|
-
operationId: "unstableAccessMethodsListPost",
|
|
55351
|
-
requestBody: {
|
|
55352
|
-
content: {
|
|
55353
|
-
"application/json": {
|
|
55354
|
-
schema: {
|
|
55355
|
-
properties: {
|
|
55356
|
-
access_grant_id: {
|
|
55357
|
-
description: "ID of the access grant by which to filter the list of access methods.",
|
|
55358
|
-
format: "uuid",
|
|
55359
|
-
type: "string"
|
|
55360
|
-
}
|
|
55361
|
-
},
|
|
55362
|
-
required: ["access_grant_id"],
|
|
55363
|
-
type: "object"
|
|
55364
|
-
}
|
|
55365
|
-
}
|
|
55366
|
-
}
|
|
55367
|
-
},
|
|
55368
|
-
responses: {
|
|
55369
|
-
200: {
|
|
55370
|
-
content: {
|
|
55371
|
-
"application/json": {
|
|
55372
|
-
schema: {
|
|
55373
|
-
properties: {
|
|
55374
|
-
access_methods: {
|
|
55375
|
-
items: { $ref: "#/components/schemas/access_method" },
|
|
55376
|
-
type: "array"
|
|
55377
|
-
},
|
|
55378
|
-
ok: { type: "boolean" }
|
|
55379
|
-
},
|
|
55380
|
-
required: ["access_methods", "ok"],
|
|
55381
|
-
type: "object"
|
|
55382
|
-
}
|
|
55383
|
-
}
|
|
55384
|
-
},
|
|
55385
|
-
description: "OK"
|
|
55386
|
-
},
|
|
55387
|
-
400: { description: "Bad Request" },
|
|
55388
|
-
401: { description: "Unauthorized" }
|
|
55389
|
-
},
|
|
55390
|
-
security: [
|
|
55391
|
-
{ pat_with_workspace: [] },
|
|
55392
|
-
{ console_session_with_workspace: [] },
|
|
55393
|
-
{ api_key: [] }
|
|
55394
|
-
],
|
|
55395
|
-
summary: "/unstable_access_methods/list",
|
|
55396
|
-
tags: [],
|
|
55397
|
-
"x-fern-sdk-group-name": ["unstable_access_methods"],
|
|
55398
|
-
"x-fern-sdk-method-name": "list",
|
|
55399
|
-
"x-fern-sdk-return-value": "access_methods",
|
|
55400
|
-
"x-response-key": "access_methods",
|
|
55401
|
-
"x-title": "List Access Methods",
|
|
55402
|
-
"x-undocumented": "Unreleased."
|
|
55403
|
-
}
|
|
55404
|
-
},
|
|
55405
54556
|
"/unstable_locations/add_acs_entrances": {
|
|
55406
54557
|
post: {
|
|
55407
54558
|
description: "Adds [entrances](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details) to a specific location.",
|