@seamapi/types 1.460.0 → 1.461.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 +441 -120
- package/dist/connect.cjs.map +1 -1
- package/dist/connect.d.cts +1135 -352
- package/dist/index.cjs +441 -120
- package/dist/index.cjs.map +1 -1
- package/lib/seam/connect/models/batch.d.ts +2338 -276
- package/lib/seam/connect/models/batch.js +7 -0
- package/lib/seam/connect/models/batch.js.map +1 -1
- package/lib/seam/connect/models/customer/access-grant-resources.d.ts +18 -18
- package/lib/seam/connect/models/customer/access-grant-resources.js +2 -1
- package/lib/seam/connect/models/customer/access-grant-resources.js.map +1 -1
- package/lib/seam/connect/models/customer/customer-data.d.ts +15 -15
- package/lib/seam/connect/models/phones/phone-session.d.ts +167 -0
- package/lib/seam/connect/models/phones/phone-session.js +3 -0
- package/lib/seam/connect/models/phones/phone-session.js.map +1 -1
- package/lib/seam/connect/openapi.d.ts +341 -33
- package/lib/seam/connect/openapi.js +429 -113
- package/lib/seam/connect/openapi.js.map +1 -1
- package/lib/seam/connect/route-types.d.ts +650 -175
- package/package.json +1 -1
- package/src/lib/seam/connect/internal/schemas.ts +1 -0
- package/src/lib/seam/connect/models/batch.ts +7 -0
- package/src/lib/seam/connect/models/customer/access-grant-resources.ts +2 -1
- package/src/lib/seam/connect/models/phones/phone-session.ts +5 -0
- package/src/lib/seam/connect/openapi.ts +456 -113
- package/src/lib/seam/connect/route-types.ts +820 -189
package/dist/index.cjs
CHANGED
|
@@ -3944,13 +3944,18 @@ zod.z.object({
|
|
|
3944
3944
|
batch_type: zod.z.literal("spaces"),
|
|
3945
3945
|
spaces: space.array().optional(),
|
|
3946
3946
|
devices: device.array().optional(),
|
|
3947
|
-
acs_entrances: acs_entrance.array().optional()
|
|
3947
|
+
acs_entrances: acs_entrance.array().optional(),
|
|
3948
|
+
connected_accounts: connected_account.array().optional(),
|
|
3949
|
+
acs_systems: acs_system.array().optional()
|
|
3948
3950
|
}).describe("ID of the affected access system user.");
|
|
3949
3951
|
zod.z.object({
|
|
3950
3952
|
batch_type: zod.z.literal("access_grants"),
|
|
3951
3953
|
spaces: space.array().optional(),
|
|
3952
3954
|
devices: device.array().optional(),
|
|
3953
|
-
acs_entrances: acs_entrance.array().optional()
|
|
3955
|
+
acs_entrances: acs_entrance.array().optional(),
|
|
3956
|
+
user_identities: user_identity.array().optional(),
|
|
3957
|
+
connected_accounts: connected_account.array().optional(),
|
|
3958
|
+
acs_systems: acs_system.array().optional()
|
|
3954
3959
|
});
|
|
3955
3960
|
zod.z.object({
|
|
3956
3961
|
batch_type: zod.z.literal("access_methods"),
|
|
@@ -23562,9 +23567,169 @@ var openapi_default = {
|
|
|
23562
23567
|
type: "object"
|
|
23563
23568
|
},
|
|
23564
23569
|
type: "array"
|
|
23565
|
-
}
|
|
23570
|
+
},
|
|
23571
|
+
user_identity: {
|
|
23572
|
+
description: "User identity.",
|
|
23573
|
+
properties: {
|
|
23574
|
+
acs_user_ids: {
|
|
23575
|
+
description: "Array of access system user IDs associated with the user identity.",
|
|
23576
|
+
items: { format: "uuid", type: "string" },
|
|
23577
|
+
type: "array"
|
|
23578
|
+
},
|
|
23579
|
+
created_at: {
|
|
23580
|
+
description: "Date and time at which the user identity was created.",
|
|
23581
|
+
format: "date-time",
|
|
23582
|
+
type: "string"
|
|
23583
|
+
},
|
|
23584
|
+
display_name: { minLength: 1, type: "string" },
|
|
23585
|
+
email_address: {
|
|
23586
|
+
description: "Unique email address for the user identity.",
|
|
23587
|
+
format: "email",
|
|
23588
|
+
nullable: true,
|
|
23589
|
+
type: "string"
|
|
23590
|
+
},
|
|
23591
|
+
errors: {
|
|
23592
|
+
description: 'Array of errors associated with the user identity. Each error object within the array contains fields like "error_code" and "message." "error_code" is a string that uniquely identifies the type of error, enabling quick recognition and categorization of the issue. "message" provides a more detailed description of the error, offering insights into the issue and potentially how to rectify it.',
|
|
23593
|
+
items: {
|
|
23594
|
+
description: "Errors associated with the user identity.",
|
|
23595
|
+
discriminator: { propertyName: "error_code" },
|
|
23596
|
+
oneOf: [
|
|
23597
|
+
{
|
|
23598
|
+
description: "Indicates that there is an issue with an access system user associated with this user identity.",
|
|
23599
|
+
properties: {
|
|
23600
|
+
acs_system_id: {
|
|
23601
|
+
description: "ID of the access system that the user identity is associated with.",
|
|
23602
|
+
format: "uuid",
|
|
23603
|
+
type: "string"
|
|
23604
|
+
},
|
|
23605
|
+
acs_user_id: {
|
|
23606
|
+
description: "ID of the access system user that has an issue.",
|
|
23607
|
+
format: "uuid",
|
|
23608
|
+
type: "string"
|
|
23609
|
+
},
|
|
23610
|
+
created_at: {
|
|
23611
|
+
description: "Date and time at which Seam created the error.",
|
|
23612
|
+
format: "date-time",
|
|
23613
|
+
type: "string"
|
|
23614
|
+
},
|
|
23615
|
+
error_code: {
|
|
23616
|
+
description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
|
|
23617
|
+
enum: ["issue_with_acs_user"],
|
|
23618
|
+
type: "string"
|
|
23619
|
+
},
|
|
23620
|
+
message: {
|
|
23621
|
+
description: "Detailed description of the error. Provides insights into the issue and potentially how to rectify it.",
|
|
23622
|
+
type: "string"
|
|
23623
|
+
}
|
|
23624
|
+
},
|
|
23625
|
+
required: [
|
|
23626
|
+
"created_at",
|
|
23627
|
+
"message",
|
|
23628
|
+
"error_code",
|
|
23629
|
+
"acs_user_id",
|
|
23630
|
+
"acs_system_id"
|
|
23631
|
+
],
|
|
23632
|
+
type: "object"
|
|
23633
|
+
}
|
|
23634
|
+
]
|
|
23635
|
+
},
|
|
23636
|
+
type: "array"
|
|
23637
|
+
},
|
|
23638
|
+
full_name: { minLength: 1, nullable: true, type: "string" },
|
|
23639
|
+
phone_number: {
|
|
23640
|
+
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).",
|
|
23641
|
+
nullable: true,
|
|
23642
|
+
type: "string"
|
|
23643
|
+
},
|
|
23644
|
+
user_identity_id: {
|
|
23645
|
+
description: "ID of the user identity.",
|
|
23646
|
+
format: "uuid",
|
|
23647
|
+
type: "string"
|
|
23648
|
+
},
|
|
23649
|
+
user_identity_key: {
|
|
23650
|
+
description: "Unique key for the user identity.",
|
|
23651
|
+
minLength: 1,
|
|
23652
|
+
nullable: true,
|
|
23653
|
+
type: "string"
|
|
23654
|
+
},
|
|
23655
|
+
warnings: {
|
|
23656
|
+
description: 'Array of warnings associated with the user identity. Each warning object within the array contains two fields: "warning_code" and "message." "warning_code" is a string that uniquely identifies the type of warning, enabling quick recognition and categorization of the issue. "message" provides a more detailed description of the warning, offering insights into the issue and potentially how to rectify it.',
|
|
23657
|
+
items: {
|
|
23658
|
+
description: "Warnings associated with the user identity.",
|
|
23659
|
+
discriminator: { propertyName: "warning_code" },
|
|
23660
|
+
oneOf: [
|
|
23661
|
+
{
|
|
23662
|
+
description: "Indicates that the user identity is currently being deleted.",
|
|
23663
|
+
properties: {
|
|
23664
|
+
created_at: {
|
|
23665
|
+
description: "Date and time at which Seam created the warning.",
|
|
23666
|
+
format: "date-time",
|
|
23667
|
+
type: "string"
|
|
23668
|
+
},
|
|
23669
|
+
message: {
|
|
23670
|
+
description: "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.",
|
|
23671
|
+
type: "string"
|
|
23672
|
+
},
|
|
23673
|
+
warning_code: {
|
|
23674
|
+
description: "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.",
|
|
23675
|
+
enum: ["being_deleted"],
|
|
23676
|
+
type: "string"
|
|
23677
|
+
}
|
|
23678
|
+
},
|
|
23679
|
+
required: ["created_at", "message", "warning_code"],
|
|
23680
|
+
type: "object"
|
|
23681
|
+
},
|
|
23682
|
+
{
|
|
23683
|
+
description: "Indicates that the ACS user's profile does not match the user identity's profile",
|
|
23684
|
+
properties: {
|
|
23685
|
+
created_at: {
|
|
23686
|
+
description: "Date and time at which Seam created the warning.",
|
|
23687
|
+
format: "date-time",
|
|
23688
|
+
type: "string"
|
|
23689
|
+
},
|
|
23690
|
+
message: {
|
|
23691
|
+
description: "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.",
|
|
23692
|
+
type: "string"
|
|
23693
|
+
},
|
|
23694
|
+
warning_code: {
|
|
23695
|
+
description: "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.",
|
|
23696
|
+
enum: [
|
|
23697
|
+
"acs_user_profile_does_not_match_user_identity"
|
|
23698
|
+
],
|
|
23699
|
+
type: "string"
|
|
23700
|
+
}
|
|
23701
|
+
},
|
|
23702
|
+
required: ["created_at", "message", "warning_code"],
|
|
23703
|
+
type: "object"
|
|
23704
|
+
}
|
|
23705
|
+
]
|
|
23706
|
+
},
|
|
23707
|
+
type: "array"
|
|
23708
|
+
},
|
|
23709
|
+
workspace_id: {
|
|
23710
|
+
description: "ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the user identity.",
|
|
23711
|
+
format: "uuid",
|
|
23712
|
+
type: "string"
|
|
23713
|
+
}
|
|
23714
|
+
},
|
|
23715
|
+
required: [
|
|
23716
|
+
"user_identity_id",
|
|
23717
|
+
"user_identity_key",
|
|
23718
|
+
"email_address",
|
|
23719
|
+
"phone_number",
|
|
23720
|
+
"display_name",
|
|
23721
|
+
"full_name",
|
|
23722
|
+
"created_at",
|
|
23723
|
+
"workspace_id",
|
|
23724
|
+
"errors",
|
|
23725
|
+
"warnings",
|
|
23726
|
+
"acs_user_ids"
|
|
23727
|
+
],
|
|
23728
|
+
type: "object"
|
|
23729
|
+
},
|
|
23730
|
+
workspace_id: { description: "Workspace ID.", type: "string" }
|
|
23566
23731
|
},
|
|
23567
|
-
required: ["provider_sessions"],
|
|
23732
|
+
required: ["provider_sessions", "user_identity", "workspace_id"],
|
|
23568
23733
|
type: "object",
|
|
23569
23734
|
"x-route-path": "/seam/mobile_sdk/v1/phone_sessions",
|
|
23570
23735
|
"x-undocumented": "Seam Mobile SDK only."
|
|
@@ -30413,6 +30578,11 @@ var openapi_default = {
|
|
|
30413
30578
|
items: { format: "uuid", type: "string" },
|
|
30414
30579
|
type: "array"
|
|
30415
30580
|
},
|
|
30581
|
+
space_keys: {
|
|
30582
|
+
description: "Set of keys of existing spaces to which access is being granted.",
|
|
30583
|
+
items: { type: "string" },
|
|
30584
|
+
type: "array"
|
|
30585
|
+
},
|
|
30416
30586
|
starts_at: {
|
|
30417
30587
|
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.",
|
|
30418
30588
|
type: "string"
|
|
@@ -30686,7 +30856,14 @@ var openapi_default = {
|
|
|
30686
30856
|
required: false,
|
|
30687
30857
|
schema: {
|
|
30688
30858
|
items: {
|
|
30689
|
-
enum: [
|
|
30859
|
+
enum: [
|
|
30860
|
+
"spaces",
|
|
30861
|
+
"devices",
|
|
30862
|
+
"acs_entrances",
|
|
30863
|
+
"connected_accounts",
|
|
30864
|
+
"acs_systems",
|
|
30865
|
+
"user_identity"
|
|
30866
|
+
],
|
|
30690
30867
|
type: "string"
|
|
30691
30868
|
},
|
|
30692
30869
|
type: "array"
|
|
@@ -30698,7 +30875,14 @@ var openapi_default = {
|
|
|
30698
30875
|
required: false,
|
|
30699
30876
|
schema: {
|
|
30700
30877
|
items: {
|
|
30701
|
-
enum: [
|
|
30878
|
+
enum: [
|
|
30879
|
+
"spaces",
|
|
30880
|
+
"devices",
|
|
30881
|
+
"acs_entrances",
|
|
30882
|
+
"connected_accounts",
|
|
30883
|
+
"acs_systems",
|
|
30884
|
+
"user_identity"
|
|
30885
|
+
],
|
|
30702
30886
|
type: "string"
|
|
30703
30887
|
},
|
|
30704
30888
|
type: "array"
|
|
@@ -30712,20 +30896,21 @@ var openapi_default = {
|
|
|
30712
30896
|
schema: {
|
|
30713
30897
|
properties: {
|
|
30714
30898
|
batch: {
|
|
30715
|
-
description: "Represents a resource batch.",
|
|
30716
30899
|
properties: {
|
|
30717
30900
|
acs_entrances: {
|
|
30718
30901
|
items: { $ref: "#/components/schemas/acs_entrance" },
|
|
30719
30902
|
type: "array"
|
|
30720
30903
|
},
|
|
30721
|
-
|
|
30722
|
-
|
|
30723
|
-
|
|
30724
|
-
|
|
30725
|
-
|
|
30726
|
-
|
|
30727
|
-
|
|
30728
|
-
|
|
30904
|
+
acs_systems: {
|
|
30905
|
+
items: { $ref: "#/components/schemas/acs_system" },
|
|
30906
|
+
type: "array"
|
|
30907
|
+
},
|
|
30908
|
+
batch_type: { enum: ["access_grants"], type: "string" },
|
|
30909
|
+
connected_accounts: {
|
|
30910
|
+
items: {
|
|
30911
|
+
$ref: "#/components/schemas/connected_account"
|
|
30912
|
+
},
|
|
30913
|
+
type: "array"
|
|
30729
30914
|
},
|
|
30730
30915
|
devices: {
|
|
30731
30916
|
items: { $ref: "#/components/schemas/device" },
|
|
@@ -30738,15 +30923,10 @@ var openapi_default = {
|
|
|
30738
30923
|
user_identities: {
|
|
30739
30924
|
items: { $ref: "#/components/schemas/user_identity" },
|
|
30740
30925
|
type: "array"
|
|
30741
|
-
},
|
|
30742
|
-
workspaces: {
|
|
30743
|
-
items: { $ref: "#/components/schemas/workspace" },
|
|
30744
|
-
type: "array"
|
|
30745
30926
|
}
|
|
30746
30927
|
},
|
|
30747
30928
|
required: ["batch_type"],
|
|
30748
|
-
type: "object"
|
|
30749
|
-
"x-route-path": "/"
|
|
30929
|
+
type: "object"
|
|
30750
30930
|
},
|
|
30751
30931
|
ok: { type: "boolean" }
|
|
30752
30932
|
},
|
|
@@ -30790,14 +30970,28 @@ var openapi_default = {
|
|
|
30790
30970
|
},
|
|
30791
30971
|
exclude: {
|
|
30792
30972
|
items: {
|
|
30793
|
-
enum: [
|
|
30973
|
+
enum: [
|
|
30974
|
+
"spaces",
|
|
30975
|
+
"devices",
|
|
30976
|
+
"acs_entrances",
|
|
30977
|
+
"connected_accounts",
|
|
30978
|
+
"acs_systems",
|
|
30979
|
+
"user_identity"
|
|
30980
|
+
],
|
|
30794
30981
|
type: "string"
|
|
30795
30982
|
},
|
|
30796
30983
|
type: "array"
|
|
30797
30984
|
},
|
|
30798
30985
|
include: {
|
|
30799
30986
|
items: {
|
|
30800
|
-
enum: [
|
|
30987
|
+
enum: [
|
|
30988
|
+
"spaces",
|
|
30989
|
+
"devices",
|
|
30990
|
+
"acs_entrances",
|
|
30991
|
+
"connected_accounts",
|
|
30992
|
+
"acs_systems",
|
|
30993
|
+
"user_identity"
|
|
30994
|
+
],
|
|
30801
30995
|
type: "string"
|
|
30802
30996
|
},
|
|
30803
30997
|
type: "array"
|
|
@@ -30816,20 +31010,21 @@ var openapi_default = {
|
|
|
30816
31010
|
schema: {
|
|
30817
31011
|
properties: {
|
|
30818
31012
|
batch: {
|
|
30819
|
-
description: "Represents a resource batch.",
|
|
30820
31013
|
properties: {
|
|
30821
31014
|
acs_entrances: {
|
|
30822
31015
|
items: { $ref: "#/components/schemas/acs_entrance" },
|
|
30823
31016
|
type: "array"
|
|
30824
31017
|
},
|
|
30825
|
-
|
|
30826
|
-
|
|
30827
|
-
|
|
30828
|
-
|
|
30829
|
-
|
|
30830
|
-
|
|
30831
|
-
|
|
30832
|
-
|
|
31018
|
+
acs_systems: {
|
|
31019
|
+
items: { $ref: "#/components/schemas/acs_system" },
|
|
31020
|
+
type: "array"
|
|
31021
|
+
},
|
|
31022
|
+
batch_type: { enum: ["access_grants"], type: "string" },
|
|
31023
|
+
connected_accounts: {
|
|
31024
|
+
items: {
|
|
31025
|
+
$ref: "#/components/schemas/connected_account"
|
|
31026
|
+
},
|
|
31027
|
+
type: "array"
|
|
30833
31028
|
},
|
|
30834
31029
|
devices: {
|
|
30835
31030
|
items: { $ref: "#/components/schemas/device" },
|
|
@@ -30842,15 +31037,10 @@ var openapi_default = {
|
|
|
30842
31037
|
user_identities: {
|
|
30843
31038
|
items: { $ref: "#/components/schemas/user_identity" },
|
|
30844
31039
|
type: "array"
|
|
30845
|
-
},
|
|
30846
|
-
workspaces: {
|
|
30847
|
-
items: { $ref: "#/components/schemas/workspace" },
|
|
30848
|
-
type: "array"
|
|
30849
31040
|
}
|
|
30850
31041
|
},
|
|
30851
31042
|
required: ["batch_type"],
|
|
30852
|
-
type: "object"
|
|
30853
|
-
"x-route-path": "/"
|
|
31043
|
+
type: "object"
|
|
30854
31044
|
},
|
|
30855
31045
|
ok: { type: "boolean" }
|
|
30856
31046
|
},
|
|
@@ -39891,7 +40081,7 @@ var openapi_default = {
|
|
|
39891
40081
|
type: "array"
|
|
39892
40082
|
},
|
|
39893
40083
|
name: {
|
|
39894
|
-
description: "Your
|
|
40084
|
+
description: "Your name for this access grant resource.",
|
|
39895
40085
|
type: "string"
|
|
39896
40086
|
},
|
|
39897
40087
|
property_keys: {
|
|
@@ -39935,7 +40125,7 @@ var openapi_default = {
|
|
|
39935
40125
|
type: "string"
|
|
39936
40126
|
}
|
|
39937
40127
|
},
|
|
39938
|
-
required: ["
|
|
40128
|
+
required: ["access_grant_key"],
|
|
39939
40129
|
type: "object"
|
|
39940
40130
|
},
|
|
39941
40131
|
type: "array"
|
|
@@ -39977,7 +40167,7 @@ var openapi_default = {
|
|
|
39977
40167
|
type: "array"
|
|
39978
40168
|
},
|
|
39979
40169
|
name: {
|
|
39980
|
-
description: "Your
|
|
40170
|
+
description: "Your name for this access grant resource.",
|
|
39981
40171
|
type: "string"
|
|
39982
40172
|
},
|
|
39983
40173
|
property_keys: {
|
|
@@ -40021,7 +40211,7 @@ var openapi_default = {
|
|
|
40021
40211
|
type: "string"
|
|
40022
40212
|
}
|
|
40023
40213
|
},
|
|
40024
|
-
required: ["
|
|
40214
|
+
required: ["booking_key"],
|
|
40025
40215
|
type: "object"
|
|
40026
40216
|
},
|
|
40027
40217
|
type: "array"
|
|
@@ -40197,7 +40387,7 @@ var openapi_default = {
|
|
|
40197
40387
|
type: "array"
|
|
40198
40388
|
},
|
|
40199
40389
|
name: {
|
|
40200
|
-
description: "Your
|
|
40390
|
+
description: "Your name for this access grant resource.",
|
|
40201
40391
|
type: "string"
|
|
40202
40392
|
},
|
|
40203
40393
|
property_keys: {
|
|
@@ -40245,7 +40435,7 @@ var openapi_default = {
|
|
|
40245
40435
|
type: "string"
|
|
40246
40436
|
}
|
|
40247
40437
|
},
|
|
40248
|
-
required: ["
|
|
40438
|
+
required: ["reservation_key"],
|
|
40249
40439
|
type: "object"
|
|
40250
40440
|
},
|
|
40251
40441
|
type: "array"
|
|
@@ -40499,7 +40689,7 @@ var openapi_default = {
|
|
|
40499
40689
|
type: "array"
|
|
40500
40690
|
},
|
|
40501
40691
|
name: {
|
|
40502
|
-
description: "Your
|
|
40692
|
+
description: "Your name for this access grant resource.",
|
|
40503
40693
|
type: "string"
|
|
40504
40694
|
},
|
|
40505
40695
|
property_keys: {
|
|
@@ -40543,7 +40733,7 @@ var openapi_default = {
|
|
|
40543
40733
|
type: "string"
|
|
40544
40734
|
}
|
|
40545
40735
|
},
|
|
40546
|
-
required: ["
|
|
40736
|
+
required: ["access_grant_key"],
|
|
40547
40737
|
type: "object"
|
|
40548
40738
|
},
|
|
40549
40739
|
type: "array"
|
|
@@ -40585,7 +40775,7 @@ var openapi_default = {
|
|
|
40585
40775
|
type: "array"
|
|
40586
40776
|
},
|
|
40587
40777
|
name: {
|
|
40588
|
-
description: "Your
|
|
40778
|
+
description: "Your name for this access grant resource.",
|
|
40589
40779
|
type: "string"
|
|
40590
40780
|
},
|
|
40591
40781
|
property_keys: {
|
|
@@ -40629,7 +40819,7 @@ var openapi_default = {
|
|
|
40629
40819
|
type: "string"
|
|
40630
40820
|
}
|
|
40631
40821
|
},
|
|
40632
|
-
required: ["
|
|
40822
|
+
required: ["booking_key"],
|
|
40633
40823
|
type: "object"
|
|
40634
40824
|
},
|
|
40635
40825
|
type: "array"
|
|
@@ -40805,7 +40995,7 @@ var openapi_default = {
|
|
|
40805
40995
|
type: "array"
|
|
40806
40996
|
},
|
|
40807
40997
|
name: {
|
|
40808
|
-
description: "Your
|
|
40998
|
+
description: "Your name for this access grant resource.",
|
|
40809
40999
|
type: "string"
|
|
40810
41000
|
},
|
|
40811
41001
|
property_keys: {
|
|
@@ -40853,7 +41043,7 @@ var openapi_default = {
|
|
|
40853
41043
|
type: "string"
|
|
40854
41044
|
}
|
|
40855
41045
|
},
|
|
40856
|
-
required: ["
|
|
41046
|
+
required: ["reservation_key"],
|
|
40857
41047
|
type: "object"
|
|
40858
41048
|
},
|
|
40859
41049
|
type: "array"
|
|
@@ -42279,7 +42469,7 @@ var openapi_default = {
|
|
|
42279
42469
|
},
|
|
42280
42470
|
"/devices/simulate/disconnect_from_hub": {
|
|
42281
42471
|
post: {
|
|
42282
|
-
description: "Simulates taking the Wi
|
|
42472
|
+
description: "Simulates taking the Wi\u2011Fi hub (bridge) offline for a device.\nOnly applicable for sandbox workspaces and currently\nimplemented for August and TTLock locks.\nThis will set the corresponding `hub_disconnected` or\n`ttlock_lock_not_paired_to_gateway` error on the device.",
|
|
42283
42473
|
operationId: "devicesSimulateDisconnectFromHubPost",
|
|
42284
42474
|
requestBody: {
|
|
42285
42475
|
content: {
|
|
@@ -44333,6 +44523,111 @@ var openapi_default = {
|
|
|
44333
44523
|
"x-title": "List Events"
|
|
44334
44524
|
}
|
|
44335
44525
|
},
|
|
44526
|
+
"/instant_keys/list": {
|
|
44527
|
+
get: {
|
|
44528
|
+
description: "Returns a list of all [instant keys](https://docs.seam.co/latest/capability-guides/mobile-access/instant-keys).",
|
|
44529
|
+
operationId: "instantKeysListGet",
|
|
44530
|
+
parameters: [
|
|
44531
|
+
{
|
|
44532
|
+
in: "query",
|
|
44533
|
+
name: "user_identity_id",
|
|
44534
|
+
schema: {
|
|
44535
|
+
description: "ID of the user identity by which you want to filter the list of Instant Keys.",
|
|
44536
|
+
format: "uuid",
|
|
44537
|
+
type: "string"
|
|
44538
|
+
}
|
|
44539
|
+
}
|
|
44540
|
+
],
|
|
44541
|
+
responses: {
|
|
44542
|
+
200: {
|
|
44543
|
+
content: {
|
|
44544
|
+
"application/json": {
|
|
44545
|
+
schema: {
|
|
44546
|
+
properties: {
|
|
44547
|
+
instant_keys: {
|
|
44548
|
+
items: { $ref: "#/components/schemas/instant_key" },
|
|
44549
|
+
type: "array"
|
|
44550
|
+
},
|
|
44551
|
+
ok: { type: "boolean" }
|
|
44552
|
+
},
|
|
44553
|
+
required: ["instant_keys", "ok"],
|
|
44554
|
+
type: "object"
|
|
44555
|
+
}
|
|
44556
|
+
}
|
|
44557
|
+
},
|
|
44558
|
+
description: "OK"
|
|
44559
|
+
},
|
|
44560
|
+
400: { description: "Bad Request" },
|
|
44561
|
+
401: { description: "Unauthorized" }
|
|
44562
|
+
},
|
|
44563
|
+
security: [
|
|
44564
|
+
{ api_key: [] },
|
|
44565
|
+
{ pat_with_workspace: [] },
|
|
44566
|
+
{ console_session_with_workspace: [] }
|
|
44567
|
+
],
|
|
44568
|
+
summary: "/instant_keys/list",
|
|
44569
|
+
tags: [],
|
|
44570
|
+
"x-fern-sdk-group-name": ["instant_keys"],
|
|
44571
|
+
"x-fern-sdk-method-name": "list",
|
|
44572
|
+
"x-fern-sdk-return-value": "instant_keys",
|
|
44573
|
+
"x-response-key": "instant_keys",
|
|
44574
|
+
"x-title": "List Instant Keys"
|
|
44575
|
+
},
|
|
44576
|
+
post: {
|
|
44577
|
+
description: "Returns a list of all [instant keys](https://docs.seam.co/latest/capability-guides/mobile-access/instant-keys).",
|
|
44578
|
+
operationId: "instantKeysListPost",
|
|
44579
|
+
requestBody: {
|
|
44580
|
+
content: {
|
|
44581
|
+
"application/json": {
|
|
44582
|
+
schema: {
|
|
44583
|
+
properties: {
|
|
44584
|
+
user_identity_id: {
|
|
44585
|
+
description: "ID of the user identity by which you want to filter the list of Instant Keys.",
|
|
44586
|
+
format: "uuid",
|
|
44587
|
+
type: "string"
|
|
44588
|
+
}
|
|
44589
|
+
},
|
|
44590
|
+
type: "object"
|
|
44591
|
+
}
|
|
44592
|
+
}
|
|
44593
|
+
}
|
|
44594
|
+
},
|
|
44595
|
+
responses: {
|
|
44596
|
+
200: {
|
|
44597
|
+
content: {
|
|
44598
|
+
"application/json": {
|
|
44599
|
+
schema: {
|
|
44600
|
+
properties: {
|
|
44601
|
+
instant_keys: {
|
|
44602
|
+
items: { $ref: "#/components/schemas/instant_key" },
|
|
44603
|
+
type: "array"
|
|
44604
|
+
},
|
|
44605
|
+
ok: { type: "boolean" }
|
|
44606
|
+
},
|
|
44607
|
+
required: ["instant_keys", "ok"],
|
|
44608
|
+
type: "object"
|
|
44609
|
+
}
|
|
44610
|
+
}
|
|
44611
|
+
},
|
|
44612
|
+
description: "OK"
|
|
44613
|
+
},
|
|
44614
|
+
400: { description: "Bad Request" },
|
|
44615
|
+
401: { description: "Unauthorized" }
|
|
44616
|
+
},
|
|
44617
|
+
security: [
|
|
44618
|
+
{ api_key: [] },
|
|
44619
|
+
{ pat_with_workspace: [] },
|
|
44620
|
+
{ console_session_with_workspace: [] }
|
|
44621
|
+
],
|
|
44622
|
+
summary: "/instant_keys/list",
|
|
44623
|
+
tags: [],
|
|
44624
|
+
"x-fern-sdk-group-name": ["instant_keys"],
|
|
44625
|
+
"x-fern-sdk-method-name": "list",
|
|
44626
|
+
"x-fern-sdk-return-value": "instant_keys",
|
|
44627
|
+
"x-response-key": "instant_keys",
|
|
44628
|
+
"x-title": "List Instant Keys"
|
|
44629
|
+
}
|
|
44630
|
+
},
|
|
44336
44631
|
"/locks/get": {
|
|
44337
44632
|
get: {
|
|
44338
44633
|
description: "Returns a specified [lock](https://docs.seam.co/latest/capability-guides/smart-locks). **Use `/devices/get` instead.**",
|
|
@@ -47328,10 +47623,10 @@ var openapi_default = {
|
|
|
47328
47623
|
"x-undocumented": "Seam Bridge Client only."
|
|
47329
47624
|
}
|
|
47330
47625
|
},
|
|
47331
|
-
"/seam/console/v1/
|
|
47626
|
+
"/seam/console/v1/get_resource_locator": {
|
|
47332
47627
|
get: {
|
|
47333
|
-
description: "Returns the type of a resource given its UUID.",
|
|
47334
|
-
operationId: "
|
|
47628
|
+
description: "Returns the type and system information of a resource given its UUID.",
|
|
47629
|
+
operationId: "seamConsoleV1GetResourceLocatorGet",
|
|
47335
47630
|
parameters: [
|
|
47336
47631
|
{
|
|
47337
47632
|
in: "query",
|
|
@@ -47347,9 +47642,17 @@ var openapi_default = {
|
|
|
47347
47642
|
schema: {
|
|
47348
47643
|
properties: {
|
|
47349
47644
|
ok: { type: "boolean" },
|
|
47350
|
-
|
|
47645
|
+
resource_locator: {
|
|
47646
|
+
properties: {
|
|
47647
|
+
acs_system_id: { format: "uuid", type: "string" },
|
|
47648
|
+
device_id: { format: "uuid", type: "string" },
|
|
47649
|
+
resource_type: { type: "string" }
|
|
47650
|
+
},
|
|
47651
|
+
required: ["resource_type"],
|
|
47652
|
+
type: "object"
|
|
47653
|
+
}
|
|
47351
47654
|
},
|
|
47352
|
-
required: ["
|
|
47655
|
+
required: ["resource_locator", "ok"],
|
|
47353
47656
|
type: "object"
|
|
47354
47657
|
}
|
|
47355
47658
|
}
|
|
@@ -47365,18 +47668,18 @@ var openapi_default = {
|
|
|
47365
47668
|
{ console_session_with_workspace: [] },
|
|
47366
47669
|
{ api_key: [] }
|
|
47367
47670
|
],
|
|
47368
|
-
summary: "/seam/console/v1/
|
|
47671
|
+
summary: "/seam/console/v1/get_resource_locator",
|
|
47369
47672
|
tags: [],
|
|
47370
47673
|
"x-fern-sdk-group-name": ["seam", "console", "v1"],
|
|
47371
|
-
"x-fern-sdk-method-name": "
|
|
47372
|
-
"x-fern-sdk-return-value": "
|
|
47373
|
-
"x-response-key": "
|
|
47374
|
-
"x-title": "Get Resource
|
|
47674
|
+
"x-fern-sdk-method-name": "get_resource_locator",
|
|
47675
|
+
"x-fern-sdk-return-value": "resource_locator",
|
|
47676
|
+
"x-response-key": "resource_locator",
|
|
47677
|
+
"x-title": "Get Resource Locator",
|
|
47375
47678
|
"x-undocumented": "Internal endpoint for Console"
|
|
47376
47679
|
},
|
|
47377
47680
|
post: {
|
|
47378
|
-
description: "Returns the type of a resource given its UUID.",
|
|
47379
|
-
operationId: "
|
|
47681
|
+
description: "Returns the type and system information of a resource given its UUID.",
|
|
47682
|
+
operationId: "seamConsoleV1GetResourceLocatorPost",
|
|
47380
47683
|
parameters: [
|
|
47381
47684
|
{
|
|
47382
47685
|
in: "query",
|
|
@@ -47392,9 +47695,17 @@ var openapi_default = {
|
|
|
47392
47695
|
schema: {
|
|
47393
47696
|
properties: {
|
|
47394
47697
|
ok: { type: "boolean" },
|
|
47395
|
-
|
|
47698
|
+
resource_locator: {
|
|
47699
|
+
properties: {
|
|
47700
|
+
acs_system_id: { format: "uuid", type: "string" },
|
|
47701
|
+
device_id: { format: "uuid", type: "string" },
|
|
47702
|
+
resource_type: { type: "string" }
|
|
47703
|
+
},
|
|
47704
|
+
required: ["resource_type"],
|
|
47705
|
+
type: "object"
|
|
47706
|
+
}
|
|
47396
47707
|
},
|
|
47397
|
-
required: ["
|
|
47708
|
+
required: ["resource_locator", "ok"],
|
|
47398
47709
|
type: "object"
|
|
47399
47710
|
}
|
|
47400
47711
|
}
|
|
@@ -47410,13 +47721,13 @@ var openapi_default = {
|
|
|
47410
47721
|
{ console_session_with_workspace: [] },
|
|
47411
47722
|
{ api_key: [] }
|
|
47412
47723
|
],
|
|
47413
|
-
summary: "/seam/console/v1/
|
|
47724
|
+
summary: "/seam/console/v1/get_resource_locator",
|
|
47414
47725
|
tags: [],
|
|
47415
47726
|
"x-fern-sdk-group-name": ["seam", "console", "v1"],
|
|
47416
|
-
"x-fern-sdk-method-name": "
|
|
47417
|
-
"x-fern-sdk-return-value": "
|
|
47418
|
-
"x-response-key": "
|
|
47419
|
-
"x-title": "Get Resource
|
|
47727
|
+
"x-fern-sdk-method-name": "get_resource_locator",
|
|
47728
|
+
"x-fern-sdk-return-value": "resource_locator",
|
|
47729
|
+
"x-response-key": "resource_locator",
|
|
47730
|
+
"x-title": "Get Resource Locator",
|
|
47420
47731
|
"x-undocumented": "Internal endpoint for Console"
|
|
47421
47732
|
}
|
|
47422
47733
|
},
|
|
@@ -47870,7 +48181,7 @@ var openapi_default = {
|
|
|
47870
48181
|
type: "string"
|
|
47871
48182
|
}
|
|
47872
48183
|
},
|
|
47873
|
-
required: ["rule"
|
|
48184
|
+
required: ["rule"],
|
|
47874
48185
|
type: "object"
|
|
47875
48186
|
},
|
|
47876
48187
|
reservation_time_updated: {
|
|
@@ -47883,7 +48194,7 @@ var openapi_default = {
|
|
|
47883
48194
|
type: "string"
|
|
47884
48195
|
}
|
|
47885
48196
|
},
|
|
47886
|
-
required: ["rule"
|
|
48197
|
+
required: ["rule"],
|
|
47887
48198
|
type: "object"
|
|
47888
48199
|
}
|
|
47889
48200
|
},
|
|
@@ -47970,7 +48281,7 @@ var openapi_default = {
|
|
|
47970
48281
|
type: "string"
|
|
47971
48282
|
}
|
|
47972
48283
|
},
|
|
47973
|
-
required: ["rule"
|
|
48284
|
+
required: ["rule"],
|
|
47974
48285
|
type: "object"
|
|
47975
48286
|
},
|
|
47976
48287
|
reservation_time_updated: {
|
|
@@ -47983,7 +48294,7 @@ var openapi_default = {
|
|
|
47983
48294
|
type: "string"
|
|
47984
48295
|
}
|
|
47985
48296
|
},
|
|
47986
|
-
required: ["rule"
|
|
48297
|
+
required: ["rule"],
|
|
47987
48298
|
type: "object"
|
|
47988
48299
|
}
|
|
47989
48300
|
},
|
|
@@ -48070,7 +48381,7 @@ var openapi_default = {
|
|
|
48070
48381
|
type: "string"
|
|
48071
48382
|
}
|
|
48072
48383
|
},
|
|
48073
|
-
required: ["rule"
|
|
48384
|
+
required: ["rule"],
|
|
48074
48385
|
type: "object"
|
|
48075
48386
|
},
|
|
48076
48387
|
reservation_time_updated: {
|
|
@@ -48081,7 +48392,7 @@ var openapi_default = {
|
|
|
48081
48392
|
type: "string"
|
|
48082
48393
|
}
|
|
48083
48394
|
},
|
|
48084
|
-
required: ["rule"
|
|
48395
|
+
required: ["rule"],
|
|
48085
48396
|
type: "object"
|
|
48086
48397
|
}
|
|
48087
48398
|
},
|
|
@@ -48176,7 +48487,7 @@ var openapi_default = {
|
|
|
48176
48487
|
type: "string"
|
|
48177
48488
|
}
|
|
48178
48489
|
},
|
|
48179
|
-
required: ["rule"
|
|
48490
|
+
required: ["rule"],
|
|
48180
48491
|
type: "object"
|
|
48181
48492
|
},
|
|
48182
48493
|
reservation_time_updated: {
|
|
@@ -48187,7 +48498,7 @@ var openapi_default = {
|
|
|
48187
48498
|
type: "string"
|
|
48188
48499
|
}
|
|
48189
48500
|
},
|
|
48190
|
-
required: ["rule"
|
|
48501
|
+
required: ["rule"],
|
|
48191
48502
|
type: "object"
|
|
48192
48503
|
}
|
|
48193
48504
|
},
|
|
@@ -49411,7 +49722,13 @@ var openapi_default = {
|
|
|
49411
49722
|
required: false,
|
|
49412
49723
|
schema: {
|
|
49413
49724
|
items: {
|
|
49414
|
-
enum: [
|
|
49725
|
+
enum: [
|
|
49726
|
+
"spaces",
|
|
49727
|
+
"devices",
|
|
49728
|
+
"acs_entrances",
|
|
49729
|
+
"connected_accounts",
|
|
49730
|
+
"acs_systems"
|
|
49731
|
+
],
|
|
49415
49732
|
type: "string"
|
|
49416
49733
|
},
|
|
49417
49734
|
type: "array"
|
|
@@ -49423,7 +49740,13 @@ var openapi_default = {
|
|
|
49423
49740
|
required: false,
|
|
49424
49741
|
schema: {
|
|
49425
49742
|
items: {
|
|
49426
|
-
enum: [
|
|
49743
|
+
enum: [
|
|
49744
|
+
"spaces",
|
|
49745
|
+
"devices",
|
|
49746
|
+
"acs_entrances",
|
|
49747
|
+
"connected_accounts",
|
|
49748
|
+
"acs_systems"
|
|
49749
|
+
],
|
|
49427
49750
|
type: "string"
|
|
49428
49751
|
},
|
|
49429
49752
|
type: "array"
|
|
@@ -49437,20 +49760,22 @@ var openapi_default = {
|
|
|
49437
49760
|
schema: {
|
|
49438
49761
|
properties: {
|
|
49439
49762
|
batch: {
|
|
49440
|
-
description: "
|
|
49763
|
+
description: "ID of the affected access system user.",
|
|
49441
49764
|
properties: {
|
|
49442
49765
|
acs_entrances: {
|
|
49443
49766
|
items: { $ref: "#/components/schemas/acs_entrance" },
|
|
49444
49767
|
type: "array"
|
|
49445
49768
|
},
|
|
49446
|
-
|
|
49447
|
-
|
|
49448
|
-
|
|
49449
|
-
|
|
49450
|
-
|
|
49451
|
-
|
|
49452
|
-
|
|
49453
|
-
|
|
49769
|
+
acs_systems: {
|
|
49770
|
+
items: { $ref: "#/components/schemas/acs_system" },
|
|
49771
|
+
type: "array"
|
|
49772
|
+
},
|
|
49773
|
+
batch_type: { enum: ["spaces"], type: "string" },
|
|
49774
|
+
connected_accounts: {
|
|
49775
|
+
items: {
|
|
49776
|
+
$ref: "#/components/schemas/connected_account"
|
|
49777
|
+
},
|
|
49778
|
+
type: "array"
|
|
49454
49779
|
},
|
|
49455
49780
|
devices: {
|
|
49456
49781
|
items: { $ref: "#/components/schemas/device" },
|
|
@@ -49459,19 +49784,10 @@ var openapi_default = {
|
|
|
49459
49784
|
spaces: {
|
|
49460
49785
|
items: { $ref: "#/components/schemas/space" },
|
|
49461
49786
|
type: "array"
|
|
49462
|
-
},
|
|
49463
|
-
user_identities: {
|
|
49464
|
-
items: { $ref: "#/components/schemas/user_identity" },
|
|
49465
|
-
type: "array"
|
|
49466
|
-
},
|
|
49467
|
-
workspaces: {
|
|
49468
|
-
items: { $ref: "#/components/schemas/workspace" },
|
|
49469
|
-
type: "array"
|
|
49470
49787
|
}
|
|
49471
49788
|
},
|
|
49472
49789
|
required: ["batch_type"],
|
|
49473
|
-
type: "object"
|
|
49474
|
-
"x-route-path": "/"
|
|
49790
|
+
type: "object"
|
|
49475
49791
|
},
|
|
49476
49792
|
ok: { type: "boolean" }
|
|
49477
49793
|
},
|
|
@@ -49510,14 +49826,26 @@ var openapi_default = {
|
|
|
49510
49826
|
properties: {
|
|
49511
49827
|
exclude: {
|
|
49512
49828
|
items: {
|
|
49513
|
-
enum: [
|
|
49829
|
+
enum: [
|
|
49830
|
+
"spaces",
|
|
49831
|
+
"devices",
|
|
49832
|
+
"acs_entrances",
|
|
49833
|
+
"connected_accounts",
|
|
49834
|
+
"acs_systems"
|
|
49835
|
+
],
|
|
49514
49836
|
type: "string"
|
|
49515
49837
|
},
|
|
49516
49838
|
type: "array"
|
|
49517
49839
|
},
|
|
49518
49840
|
include: {
|
|
49519
49841
|
items: {
|
|
49520
|
-
enum: [
|
|
49842
|
+
enum: [
|
|
49843
|
+
"spaces",
|
|
49844
|
+
"devices",
|
|
49845
|
+
"acs_entrances",
|
|
49846
|
+
"connected_accounts",
|
|
49847
|
+
"acs_systems"
|
|
49848
|
+
],
|
|
49521
49849
|
type: "string"
|
|
49522
49850
|
},
|
|
49523
49851
|
type: "array"
|
|
@@ -49541,20 +49869,22 @@ var openapi_default = {
|
|
|
49541
49869
|
schema: {
|
|
49542
49870
|
properties: {
|
|
49543
49871
|
batch: {
|
|
49544
|
-
description: "
|
|
49872
|
+
description: "ID of the affected access system user.",
|
|
49545
49873
|
properties: {
|
|
49546
49874
|
acs_entrances: {
|
|
49547
49875
|
items: { $ref: "#/components/schemas/acs_entrance" },
|
|
49548
49876
|
type: "array"
|
|
49549
49877
|
},
|
|
49550
|
-
|
|
49551
|
-
|
|
49552
|
-
|
|
49553
|
-
|
|
49554
|
-
|
|
49555
|
-
|
|
49556
|
-
|
|
49557
|
-
|
|
49878
|
+
acs_systems: {
|
|
49879
|
+
items: { $ref: "#/components/schemas/acs_system" },
|
|
49880
|
+
type: "array"
|
|
49881
|
+
},
|
|
49882
|
+
batch_type: { enum: ["spaces"], type: "string" },
|
|
49883
|
+
connected_accounts: {
|
|
49884
|
+
items: {
|
|
49885
|
+
$ref: "#/components/schemas/connected_account"
|
|
49886
|
+
},
|
|
49887
|
+
type: "array"
|
|
49558
49888
|
},
|
|
49559
49889
|
devices: {
|
|
49560
49890
|
items: { $ref: "#/components/schemas/device" },
|
|
@@ -49563,19 +49893,10 @@ var openapi_default = {
|
|
|
49563
49893
|
spaces: {
|
|
49564
49894
|
items: { $ref: "#/components/schemas/space" },
|
|
49565
49895
|
type: "array"
|
|
49566
|
-
},
|
|
49567
|
-
user_identities: {
|
|
49568
|
-
items: { $ref: "#/components/schemas/user_identity" },
|
|
49569
|
-
type: "array"
|
|
49570
|
-
},
|
|
49571
|
-
workspaces: {
|
|
49572
|
-
items: { $ref: "#/components/schemas/workspace" },
|
|
49573
|
-
type: "array"
|
|
49574
49896
|
}
|
|
49575
49897
|
},
|
|
49576
49898
|
required: ["batch_type"],
|
|
49577
|
-
type: "object"
|
|
49578
|
-
"x-route-path": "/"
|
|
49899
|
+
type: "object"
|
|
49579
49900
|
},
|
|
49580
49901
|
ok: { type: "boolean" }
|
|
49581
49902
|
},
|