@seamapi/types 1.842.0 → 1.844.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 +227 -7
- package/dist/connect.cjs.map +1 -1
- package/dist/connect.d.cts +175 -0
- package/dist/index.cjs +227 -7
- package/dist/index.cjs.map +1 -1
- package/lib/seam/connect/models/acs/acs-entrance.d.ts +54 -0
- package/lib/seam/connect/models/acs/acs-entrance.js +28 -0
- package/lib/seam/connect/models/acs/acs-entrance.js.map +1 -1
- package/lib/seam/connect/models/batch.d.ts +34 -0
- package/lib/seam/connect/models/phones/phone-session.d.ts +98 -0
- package/lib/seam/connect/openapi.js +197 -0
- package/lib/seam/connect/openapi.js.map +1 -1
- package/lib/seam/connect/route-types.d.ts +117 -0
- package/package.json +1 -1
- package/src/lib/seam/connect/models/acs/acs-entrance.ts +46 -0
- package/src/lib/seam/connect/openapi.ts +213 -0
- package/src/lib/seam/connect/route-types.ts +117 -0
package/dist/connect.cjs
CHANGED
|
@@ -3708,6 +3708,26 @@ var acs_entrance_avigilon_alta_metadata = zod.z.object({
|
|
|
3708
3708
|
}).describe("Avigilon Alta-specific metadata associated with the entrance.");
|
|
3709
3709
|
|
|
3710
3710
|
// src/lib/seam/connect/models/acs/acs-entrance.ts
|
|
3711
|
+
var warning_code_description8 = "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.";
|
|
3712
|
+
var common_acs_entrance_warning = zod.z.object({
|
|
3713
|
+
created_at: zod.z.string().datetime().describe("Date and time at which Seam created the warning."),
|
|
3714
|
+
message: zod.z.string().describe(
|
|
3715
|
+
"Detailed description of the warning. Provides insights into the issue and potentially how to rectify it."
|
|
3716
|
+
)
|
|
3717
|
+
});
|
|
3718
|
+
var salto_ks_entrance_access_code_support_removed = common_acs_entrance_warning.extend({
|
|
3719
|
+
warning_code: zod.z.literal("salto_ks_entrance_access_code_support_removed").describe(warning_code_description8)
|
|
3720
|
+
}).describe(
|
|
3721
|
+
"Indicates that a change in the reported device model has been detected for this Salto KS entrance, which may occur after an IQ hub reset. Access code support may be affected. See https://help.getseam.com/articles/5098842588-salto-ks-lock-loses-access-code-support for troubleshooting steps."
|
|
3722
|
+
);
|
|
3723
|
+
var acs_entrance_warning = zod.z.discriminatedUnion("warning_code", [
|
|
3724
|
+
salto_ks_entrance_access_code_support_removed
|
|
3725
|
+
]).describe(
|
|
3726
|
+
"Warning associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details)."
|
|
3727
|
+
);
|
|
3728
|
+
zod.z.object({
|
|
3729
|
+
salto_ks_entrance_access_code_support_removed: salto_ks_entrance_access_code_support_removed.optional().nullable()
|
|
3730
|
+
});
|
|
3711
3731
|
var acs_entrance_capability_flags = zod.z.object({
|
|
3712
3732
|
can_unlock_with_mobile_key: zod.z.boolean().optional().describe(
|
|
3713
3733
|
"Indicates whether the ACS entrance can be unlocked with mobile key credentials."
|
|
@@ -3754,6 +3774,9 @@ var acs_entrance = zod.z.object({
|
|
|
3754
3774
|
).describe(
|
|
3755
3775
|
"Errors associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details)."
|
|
3756
3776
|
),
|
|
3777
|
+
warnings: zod.z.array(acs_entrance_warning).describe(
|
|
3778
|
+
"Warnings associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details)."
|
|
3779
|
+
),
|
|
3757
3780
|
latch_metadata: acs_entrance_latch_metadata.optional().describe(
|
|
3758
3781
|
"Latch-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details)."
|
|
3759
3782
|
),
|
|
@@ -3825,7 +3848,7 @@ var common_acs_system_error = zod.z.object({
|
|
|
3825
3848
|
)
|
|
3826
3849
|
});
|
|
3827
3850
|
var error_code_description7 = "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.";
|
|
3828
|
-
var
|
|
3851
|
+
var warning_code_description9 = "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.";
|
|
3829
3852
|
var seam_bridge_disconnected = common_acs_system_error.extend({
|
|
3830
3853
|
error_code: zod.z.literal("seam_bridge_disconnected").describe(error_code_description7)
|
|
3831
3854
|
}).describe(`Indicates that the Seam API cannot communicate with [Seam Bridge](https://docs.seam.co/latest/capability-guides/seam-bridge), for example, if Seam Bridge executable has stopped or if the computer running the Seam Bridge executable is offline.
|
|
@@ -3888,12 +3911,12 @@ var common_acs_system_warning = zod.z.object({
|
|
|
3888
3911
|
)
|
|
3889
3912
|
});
|
|
3890
3913
|
var salto_ks_subscription_limit_almost_reached3 = common_acs_system_warning.extend({
|
|
3891
|
-
warning_code: zod.z.literal("salto_ks_subscription_limit_almost_reached").describe(
|
|
3914
|
+
warning_code: zod.z.literal("salto_ks_subscription_limit_almost_reached").describe(warning_code_description9)
|
|
3892
3915
|
}).describe(
|
|
3893
3916
|
"Indicates that the Salto KS site has exceeded 80% of the maximum number of allowed users. Increase your subscription limit or delete some users from your site to rectify the issue."
|
|
3894
3917
|
);
|
|
3895
3918
|
var time_zone_does_not_match_location = common_acs_system_warning.extend({
|
|
3896
|
-
warning_code: zod.z.literal("time_zone_does_not_match_location").describe(
|
|
3919
|
+
warning_code: zod.z.literal("time_zone_does_not_match_location").describe(warning_code_description9),
|
|
3897
3920
|
misconfigured_acs_entrance_ids: zod.z.array(zod.z.string().uuid()).optional().describe(
|
|
3898
3921
|
`
|
|
3899
3922
|
---
|
|
@@ -5114,7 +5137,7 @@ var common_event = zod.z.object({
|
|
|
5114
5137
|
occurred_at: zod.z.string().datetime().describe("Date and time at which the event occurred.")
|
|
5115
5138
|
});
|
|
5116
5139
|
var error_code_description8 = "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.";
|
|
5117
|
-
var
|
|
5140
|
+
var warning_code_description10 = "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.";
|
|
5118
5141
|
var common_event_error = zod.z.object({
|
|
5119
5142
|
created_at: zod.z.string().datetime().describe("Date and time at which Seam created the error."),
|
|
5120
5143
|
message: zod.z.string().describe(
|
|
@@ -5127,7 +5150,7 @@ var common_event_warning = zod.z.object({
|
|
|
5127
5150
|
message: zod.z.string().describe(
|
|
5128
5151
|
"Detailed description of the warning. Provides insights into the issue and potentially how to rectify it."
|
|
5129
5152
|
),
|
|
5130
|
-
warning_code: zod.z.string().describe(
|
|
5153
|
+
warning_code: zod.z.string().describe(warning_code_description10)
|
|
5131
5154
|
});
|
|
5132
5155
|
|
|
5133
5156
|
// src/lib/seam/connect/models/events/access-codes.ts
|
|
@@ -11059,6 +11082,37 @@ var openapi = {
|
|
|
11059
11082
|
},
|
|
11060
11083
|
required: ["door_name", "door_category"],
|
|
11061
11084
|
type: "object"
|
|
11085
|
+
},
|
|
11086
|
+
warnings: {
|
|
11087
|
+
description: "Warnings associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details).",
|
|
11088
|
+
items: {
|
|
11089
|
+
description: "Warning associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details).",
|
|
11090
|
+
discriminator: { propertyName: "warning_code" },
|
|
11091
|
+
oneOf: [
|
|
11092
|
+
{
|
|
11093
|
+
description: "Indicates that a change in the reported device model has been detected for this Salto KS entrance, which may occur after an IQ hub reset. Access code support may be affected. See https://help.getseam.com/articles/5098842588-salto-ks-lock-loses-access-code-support for troubleshooting steps.",
|
|
11094
|
+
properties: {
|
|
11095
|
+
created_at: {
|
|
11096
|
+
description: "Date and time at which Seam created the warning.",
|
|
11097
|
+
format: "date-time",
|
|
11098
|
+
type: "string"
|
|
11099
|
+
},
|
|
11100
|
+
message: {
|
|
11101
|
+
description: "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.",
|
|
11102
|
+
type: "string"
|
|
11103
|
+
},
|
|
11104
|
+
warning_code: {
|
|
11105
|
+
description: "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.",
|
|
11106
|
+
enum: ["salto_ks_entrance_access_code_support_removed"],
|
|
11107
|
+
type: "string"
|
|
11108
|
+
}
|
|
11109
|
+
},
|
|
11110
|
+
required: ["created_at", "message", "warning_code"],
|
|
11111
|
+
type: "object"
|
|
11112
|
+
}
|
|
11113
|
+
]
|
|
11114
|
+
},
|
|
11115
|
+
type: "array"
|
|
11062
11116
|
}
|
|
11063
11117
|
},
|
|
11064
11118
|
required: [
|
|
@@ -11068,7 +11122,8 @@ var openapi = {
|
|
|
11068
11122
|
"created_at",
|
|
11069
11123
|
"display_name",
|
|
11070
11124
|
"connected_account_id",
|
|
11071
|
-
"errors"
|
|
11125
|
+
"errors",
|
|
11126
|
+
"warnings"
|
|
11072
11127
|
],
|
|
11073
11128
|
type: "object",
|
|
11074
11129
|
"x-route-path": "/acs/entrances"
|
|
@@ -29819,6 +29874,43 @@ var openapi = {
|
|
|
29819
29874
|
},
|
|
29820
29875
|
required: ["door_name", "door_category"],
|
|
29821
29876
|
type: "object"
|
|
29877
|
+
},
|
|
29878
|
+
warnings: {
|
|
29879
|
+
description: "Warnings associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details).",
|
|
29880
|
+
items: {
|
|
29881
|
+
description: "Warning associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details).",
|
|
29882
|
+
discriminator: { propertyName: "warning_code" },
|
|
29883
|
+
oneOf: [
|
|
29884
|
+
{
|
|
29885
|
+
description: "Indicates that a change in the reported device model has been detected for this Salto KS entrance, which may occur after an IQ hub reset. Access code support may be affected. See https://help.getseam.com/articles/5098842588-salto-ks-lock-loses-access-code-support for troubleshooting steps.",
|
|
29886
|
+
properties: {
|
|
29887
|
+
created_at: {
|
|
29888
|
+
description: "Date and time at which Seam created the warning.",
|
|
29889
|
+
format: "date-time",
|
|
29890
|
+
type: "string"
|
|
29891
|
+
},
|
|
29892
|
+
message: {
|
|
29893
|
+
description: "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.",
|
|
29894
|
+
type: "string"
|
|
29895
|
+
},
|
|
29896
|
+
warning_code: {
|
|
29897
|
+
description: "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.",
|
|
29898
|
+
enum: [
|
|
29899
|
+
"salto_ks_entrance_access_code_support_removed"
|
|
29900
|
+
],
|
|
29901
|
+
type: "string"
|
|
29902
|
+
}
|
|
29903
|
+
},
|
|
29904
|
+
required: [
|
|
29905
|
+
"created_at",
|
|
29906
|
+
"message",
|
|
29907
|
+
"warning_code"
|
|
29908
|
+
],
|
|
29909
|
+
type: "object"
|
|
29910
|
+
}
|
|
29911
|
+
]
|
|
29912
|
+
},
|
|
29913
|
+
type: "array"
|
|
29822
29914
|
}
|
|
29823
29915
|
},
|
|
29824
29916
|
required: [
|
|
@@ -29828,7 +29920,8 @@ var openapi = {
|
|
|
29828
29920
|
"created_at",
|
|
29829
29921
|
"display_name",
|
|
29830
29922
|
"connected_account_id",
|
|
29831
|
-
"errors"
|
|
29923
|
+
"errors",
|
|
29924
|
+
"warnings"
|
|
29832
29925
|
],
|
|
29833
29926
|
type: "object",
|
|
29834
29927
|
"x-route-path": "/acs/entrances"
|
|
@@ -67350,6 +67443,133 @@ var openapi = {
|
|
|
67350
67443
|
"x-undocumented": "Internal endpoint for Console."
|
|
67351
67444
|
}
|
|
67352
67445
|
},
|
|
67446
|
+
"/seam/customer/v1/connectors/external_sites/list": {
|
|
67447
|
+
get: {
|
|
67448
|
+
description: "Lists sites/properties available from the external system for a given connected account by calling the connector's live API.",
|
|
67449
|
+
operationId: "seamCustomerV1ConnectorsExternalSitesListGet",
|
|
67450
|
+
parameters: [
|
|
67451
|
+
{
|
|
67452
|
+
in: "query",
|
|
67453
|
+
name: "connected_account_id",
|
|
67454
|
+
required: true,
|
|
67455
|
+
schema: {
|
|
67456
|
+
description: "ID of the connected account to list external sites for",
|
|
67457
|
+
format: "uuid",
|
|
67458
|
+
type: "string"
|
|
67459
|
+
}
|
|
67460
|
+
}
|
|
67461
|
+
],
|
|
67462
|
+
responses: {
|
|
67463
|
+
200: {
|
|
67464
|
+
content: {
|
|
67465
|
+
"application/json": {
|
|
67466
|
+
schema: {
|
|
67467
|
+
properties: {
|
|
67468
|
+
external_sites: {
|
|
67469
|
+
items: {
|
|
67470
|
+
properties: {
|
|
67471
|
+
key: { type: "string" },
|
|
67472
|
+
name: { type: "string" }
|
|
67473
|
+
},
|
|
67474
|
+
required: ["key", "name"],
|
|
67475
|
+
type: "object"
|
|
67476
|
+
},
|
|
67477
|
+
type: "array"
|
|
67478
|
+
},
|
|
67479
|
+
ok: { type: "boolean" }
|
|
67480
|
+
},
|
|
67481
|
+
required: ["external_sites", "ok"],
|
|
67482
|
+
type: "object"
|
|
67483
|
+
}
|
|
67484
|
+
}
|
|
67485
|
+
},
|
|
67486
|
+
description: "OK"
|
|
67487
|
+
},
|
|
67488
|
+
400: { description: "Bad Request" },
|
|
67489
|
+
401: { description: "Unauthorized" }
|
|
67490
|
+
},
|
|
67491
|
+
security: [{ api_key: [] }, { console_session_with_workspace: [] }],
|
|
67492
|
+
summary: "/seam/customer/v1/connectors/external_sites/list",
|
|
67493
|
+
tags: [],
|
|
67494
|
+
"x-fern-sdk-group-name": [
|
|
67495
|
+
"seam",
|
|
67496
|
+
"customer",
|
|
67497
|
+
"v1",
|
|
67498
|
+
"connectors",
|
|
67499
|
+
"external_sites"
|
|
67500
|
+
],
|
|
67501
|
+
"x-fern-sdk-method-name": "list",
|
|
67502
|
+
"x-fern-sdk-return-value": "external_sites",
|
|
67503
|
+
"x-response-key": "external_sites",
|
|
67504
|
+
"x-title": "List External Sites for a Connected Account",
|
|
67505
|
+
"x-undocumented": "Internal endpoint for Console."
|
|
67506
|
+
},
|
|
67507
|
+
post: {
|
|
67508
|
+
description: "Lists sites/properties available from the external system for a given connected account by calling the connector's live API.",
|
|
67509
|
+
operationId: "seamCustomerV1ConnectorsExternalSitesListPost",
|
|
67510
|
+
requestBody: {
|
|
67511
|
+
content: {
|
|
67512
|
+
"application/json": {
|
|
67513
|
+
schema: {
|
|
67514
|
+
properties: {
|
|
67515
|
+
connected_account_id: {
|
|
67516
|
+
description: "ID of the connected account to list external sites for",
|
|
67517
|
+
format: "uuid",
|
|
67518
|
+
type: "string"
|
|
67519
|
+
}
|
|
67520
|
+
},
|
|
67521
|
+
required: ["connected_account_id"],
|
|
67522
|
+
type: "object"
|
|
67523
|
+
}
|
|
67524
|
+
}
|
|
67525
|
+
}
|
|
67526
|
+
},
|
|
67527
|
+
responses: {
|
|
67528
|
+
200: {
|
|
67529
|
+
content: {
|
|
67530
|
+
"application/json": {
|
|
67531
|
+
schema: {
|
|
67532
|
+
properties: {
|
|
67533
|
+
external_sites: {
|
|
67534
|
+
items: {
|
|
67535
|
+
properties: {
|
|
67536
|
+
key: { type: "string" },
|
|
67537
|
+
name: { type: "string" }
|
|
67538
|
+
},
|
|
67539
|
+
required: ["key", "name"],
|
|
67540
|
+
type: "object"
|
|
67541
|
+
},
|
|
67542
|
+
type: "array"
|
|
67543
|
+
},
|
|
67544
|
+
ok: { type: "boolean" }
|
|
67545
|
+
},
|
|
67546
|
+
required: ["external_sites", "ok"],
|
|
67547
|
+
type: "object"
|
|
67548
|
+
}
|
|
67549
|
+
}
|
|
67550
|
+
},
|
|
67551
|
+
description: "OK"
|
|
67552
|
+
},
|
|
67553
|
+
400: { description: "Bad Request" },
|
|
67554
|
+
401: { description: "Unauthorized" }
|
|
67555
|
+
},
|
|
67556
|
+
security: [{ api_key: [] }, { console_session_with_workspace: [] }],
|
|
67557
|
+
summary: "/seam/customer/v1/connectors/external_sites/list",
|
|
67558
|
+
tags: [],
|
|
67559
|
+
"x-fern-sdk-group-name": [
|
|
67560
|
+
"seam",
|
|
67561
|
+
"customer",
|
|
67562
|
+
"v1",
|
|
67563
|
+
"connectors",
|
|
67564
|
+
"external_sites"
|
|
67565
|
+
],
|
|
67566
|
+
"x-fern-sdk-method-name": "list",
|
|
67567
|
+
"x-fern-sdk-return-value": "external_sites",
|
|
67568
|
+
"x-response-key": "external_sites",
|
|
67569
|
+
"x-title": "List External Sites for a Connected Account",
|
|
67570
|
+
"x-undocumented": "Internal endpoint for Console."
|
|
67571
|
+
}
|
|
67572
|
+
},
|
|
67353
67573
|
"/seam/customer/v1/connectors/ical/validate-config": {
|
|
67354
67574
|
post: {
|
|
67355
67575
|
description: "Fetches a sample iCal feed and validates the config against it,\nreturning the parsed reservations so the caller can verify\nextraction is correct.",
|