@seamapi/types 1.893.0 → 1.895.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 +46 -3
- package/dist/connect.cjs.map +1 -1
- package/dist/connect.d.cts +73 -2
- package/dist/index.cjs +46 -3
- package/dist/index.cjs.map +1 -1
- package/lib/seam/connect/models/devices/device-provider.d.ts +3 -2
- package/lib/seam/connect/models/devices/device-provider.js +3 -0
- package/lib/seam/connect/models/devices/device-provider.js.map +1 -1
- package/lib/seam/connect/models/events/access-codes.d.ts +52 -0
- package/lib/seam/connect/models/events/access-codes.js +20 -0
- package/lib/seam/connect/models/events/access-codes.js.map +1 -1
- package/lib/seam/connect/models/events/seam-event.d.ts +26 -0
- package/lib/seam/connect/openapi.js +30 -0
- package/lib/seam/connect/openapi.js.map +1 -1
- package/lib/seam/connect/route-types.d.ts +46 -2
- package/package.json +1 -1
- package/src/lib/seam/connect/models/devices/device-provider.ts +3 -0
- package/src/lib/seam/connect/models/events/access-codes.ts +24 -0
- package/src/lib/seam/connect/openapi.ts +35 -0
- package/src/lib/seam/connect/route-types.ts +54 -0
package/dist/connect.d.cts
CHANGED
|
@@ -20665,6 +20665,7 @@ declare const DEVICE_PROVIDERS: {
|
|
|
20665
20665
|
readonly ULTRALOQ: "ultraloq";
|
|
20666
20666
|
readonly DUSAW: "dusaw";
|
|
20667
20667
|
readonly SIFELY: "sifely";
|
|
20668
|
+
readonly THIRTY_THREE_LOCK: "thirty_three_lock";
|
|
20668
20669
|
readonly RING: "ring";
|
|
20669
20670
|
readonly ICAL: "ical";
|
|
20670
20671
|
readonly LODGIFY: "lodgify";
|
|
@@ -24680,6 +24681,20 @@ declare const seam_event: z.ZodDiscriminatedUnion<"event_type", [z.ZodObject<{
|
|
|
24680
24681
|
connected_account_custom_metadata: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnion<[z.ZodString, z.ZodBoolean]>>>;
|
|
24681
24682
|
} & {
|
|
24682
24683
|
event_type: z.ZodLiteral<"access_code.changed">;
|
|
24684
|
+
changed_properties: z.ZodOptional<z.ZodArray<z.ZodObject<{
|
|
24685
|
+
property: z.ZodString;
|
|
24686
|
+
previous_value: z.ZodNullable<z.ZodString>;
|
|
24687
|
+
new_value: z.ZodNullable<z.ZodString>;
|
|
24688
|
+
}, "strip", z.ZodTypeAny, {
|
|
24689
|
+
property: string;
|
|
24690
|
+
previous_value: string | null;
|
|
24691
|
+
new_value: string | null;
|
|
24692
|
+
}, {
|
|
24693
|
+
property: string;
|
|
24694
|
+
previous_value: string | null;
|
|
24695
|
+
new_value: string | null;
|
|
24696
|
+
}>, "many">>;
|
|
24697
|
+
change_reason: z.ZodOptional<z.ZodString>;
|
|
24683
24698
|
}, "strip", z.ZodTypeAny, {
|
|
24684
24699
|
device_id: string;
|
|
24685
24700
|
workspace_id: string;
|
|
@@ -24691,6 +24706,12 @@ declare const seam_event: z.ZodDiscriminatedUnion<"event_type", [z.ZodObject<{
|
|
|
24691
24706
|
event_type: "access_code.changed";
|
|
24692
24707
|
device_custom_metadata?: Record<string, string | boolean> | undefined;
|
|
24693
24708
|
connected_account_custom_metadata?: Record<string, string | boolean> | undefined;
|
|
24709
|
+
changed_properties?: {
|
|
24710
|
+
property: string;
|
|
24711
|
+
previous_value: string | null;
|
|
24712
|
+
new_value: string | null;
|
|
24713
|
+
}[] | undefined;
|
|
24714
|
+
change_reason?: string | undefined;
|
|
24694
24715
|
}, {
|
|
24695
24716
|
device_id: string;
|
|
24696
24717
|
workspace_id: string;
|
|
@@ -24702,6 +24723,12 @@ declare const seam_event: z.ZodDiscriminatedUnion<"event_type", [z.ZodObject<{
|
|
|
24702
24723
|
event_type: "access_code.changed";
|
|
24703
24724
|
device_custom_metadata?: Record<string, string | boolean> | undefined;
|
|
24704
24725
|
connected_account_custom_metadata?: Record<string, string | boolean> | undefined;
|
|
24726
|
+
changed_properties?: {
|
|
24727
|
+
property: string;
|
|
24728
|
+
previous_value: string | null;
|
|
24729
|
+
new_value: string | null;
|
|
24730
|
+
}[] | undefined;
|
|
24731
|
+
change_reason?: string | undefined;
|
|
24705
24732
|
}>, z.ZodObject<{
|
|
24706
24733
|
event_id: z.ZodString;
|
|
24707
24734
|
workspace_id: z.ZodString;
|
|
@@ -70453,7 +70480,7 @@ type Routes = {
|
|
|
70453
70480
|
/** Associate the Connect Webview, the connected account, and all resources under the connected account with a customer. If the connected account already exists, it will be associated with the customer. If the connected account already exists, but is already associated with a customer, the Connect Webview will show an error. */
|
|
70454
70481
|
customer_key?: string | undefined;
|
|
70455
70482
|
/** Accepted device provider keys as an alternative to `provider_category`. Use this parameter to specify accepted providers explicitly. See [Customize the Brands to Display in Your Connect Webviews](https://docs.seam.co/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-brands-to-display-in-your-connect-webviews). To list all provider keys, use [`/devices/list_device_providers`](https://docs.seam.co/api/devices/list_device_providers) with no filters. */
|
|
70456
|
-
accepted_providers?: ('hotek' | 'dormakaba_community' | 'legic_connect' | 'akuvox' | 'august' | 'avigilon_alta' | 'brivo' | 'butterflymx' | 'schlage' | 'smartthings' | 'yale' | 'genie' | 'doorking' | 'salto' | 'salto_ks' | 'lockly' | 'ttlock' | 'linear' | 'noiseaware' | 'nuki' | 'igloo' | 'kwikset' | 'minut' | 'my_2n' | 'controlbyweb' | 'nest' | 'igloohome' | 'ecobee' | 'four_suites' | 'dormakaba_oracode' | 'pti' | 'wyze' | 'seam_passport' | 'visionline' | 'assa_abloy_credential_service' | 'tedee' | 'honeywell_resideo' | 'first_alert' | 'latch' | 'akiles' | 'assa_abloy_vostio' | 'assa_abloy_vostio_credential_service' | 'tado' | 'salto_space' | 'sensi' | 'keynest' | 'korelock' | 'keyincode' | 'dormakaba_ambiance' | 'ultraloq' | 'dusaw' | 'sifely' | 'ring' | 'ical' | 'lodgify' | 'hostaway' | 'guesty' | 'acuity_scheduling' | 'omnitec' | 'yale_access' | 'hid_cm' | 'google_nest')[] | undefined;
|
|
70483
|
+
accepted_providers?: ('hotek' | 'dormakaba_community' | 'legic_connect' | 'akuvox' | 'august' | 'avigilon_alta' | 'brivo' | 'butterflymx' | 'schlage' | 'smartthings' | 'yale' | 'genie' | 'doorking' | 'salto' | 'salto_ks' | 'lockly' | 'ttlock' | 'linear' | 'noiseaware' | 'nuki' | 'igloo' | 'kwikset' | 'minut' | 'my_2n' | 'controlbyweb' | 'nest' | 'igloohome' | 'ecobee' | 'four_suites' | 'dormakaba_oracode' | 'pti' | 'wyze' | 'seam_passport' | 'visionline' | 'assa_abloy_credential_service' | 'tedee' | 'honeywell_resideo' | 'first_alert' | 'latch' | 'akiles' | 'assa_abloy_vostio' | 'assa_abloy_vostio_credential_service' | 'tado' | 'salto_space' | 'sensi' | 'keynest' | 'korelock' | 'keyincode' | 'dormakaba_ambiance' | 'ultraloq' | 'dusaw' | 'sifely' | 'thirty_three_lock' | 'ring' | 'ical' | 'lodgify' | 'hostaway' | 'guesty' | 'acuity_scheduling' | 'omnitec' | 'yale_access' | 'hid_cm' | 'google_nest')[] | undefined;
|
|
70457
70484
|
/** Specifies the category of providers that you want to include. To list all providers within a category, use [`/devices/list_device_providers`](https://docs.seam.co/api/devices/list_device_providers) with the desired `provider_category` filter. */
|
|
70458
70485
|
provider_category?: ('stable' | 'consumer_smartlocks' | 'beta' | 'thermostats' | 'noise_sensors' | 'access_control_systems' | 'cameras' | 'connectors' | 'internal_beta') | undefined;
|
|
70459
70486
|
/** Custom metadata that you want to associate with the Connect Webview. Supports up to 50 JSON key:value pairs. [Adding custom metadata to a Connect Webview](https://docs.seam.co/core-concepts/connect-webviews/attaching-custom-data-to-the-connect-webview) enables you to store custom information, like customer details or internal IDs from your application. The custom metadata is then transferred to any [connected accounts](https://docs.seam.co/core-concepts/connected-accounts) that were connected using the Connect Webview, making it easy to find and filter these resources in your [workspace](https://docs.seam.co/core-concepts/workspaces). You can also [filter Connect Webviews by custom metadata](https://docs.seam.co/core-concepts/connect-webviews/filtering-connect-webviews-by-custom-metadata). */
|
|
@@ -75035,7 +75062,7 @@ type Routes = {
|
|
|
75035
75062
|
formData: {};
|
|
75036
75063
|
jsonResponse: {
|
|
75037
75064
|
device_providers: {
|
|
75038
|
-
device_provider_name: 'hotek' | 'dormakaba_community' | 'legic_connect' | 'akuvox' | 'august' | 'avigilon_alta' | 'brivo' | 'butterflymx' | 'schlage' | 'smartthings' | 'yale' | 'genie' | 'doorking' | 'salto' | 'salto_ks' | 'lockly' | 'ttlock' | 'linear' | 'noiseaware' | 'nuki' | 'igloo' | 'kwikset' | 'minut' | 'my_2n' | 'controlbyweb' | 'nest' | 'igloohome' | 'ecobee' | 'four_suites' | 'dormakaba_oracode' | 'pti' | 'wyze' | 'seam_passport' | 'visionline' | 'assa_abloy_credential_service' | 'tedee' | 'honeywell_resideo' | 'first_alert' | 'latch' | 'akiles' | 'assa_abloy_vostio' | 'assa_abloy_vostio_credential_service' | 'tado' | 'salto_space' | 'sensi' | 'keynest' | 'korelock' | 'keyincode' | 'dormakaba_ambiance' | 'ultraloq' | 'dusaw' | 'sifely' | 'ring' | 'ical' | 'lodgify' | 'hostaway' | 'guesty' | 'acuity_scheduling' | 'omnitec';
|
|
75065
|
+
device_provider_name: 'hotek' | 'dormakaba_community' | 'legic_connect' | 'akuvox' | 'august' | 'avigilon_alta' | 'brivo' | 'butterflymx' | 'schlage' | 'smartthings' | 'yale' | 'genie' | 'doorking' | 'salto' | 'salto_ks' | 'lockly' | 'ttlock' | 'linear' | 'noiseaware' | 'nuki' | 'igloo' | 'kwikset' | 'minut' | 'my_2n' | 'controlbyweb' | 'nest' | 'igloohome' | 'ecobee' | 'four_suites' | 'dormakaba_oracode' | 'pti' | 'wyze' | 'seam_passport' | 'visionline' | 'assa_abloy_credential_service' | 'tedee' | 'honeywell_resideo' | 'first_alert' | 'latch' | 'akiles' | 'assa_abloy_vostio' | 'assa_abloy_vostio_credential_service' | 'tado' | 'salto_space' | 'sensi' | 'keynest' | 'korelock' | 'keyincode' | 'dormakaba_ambiance' | 'ultraloq' | 'dusaw' | 'sifely' | 'thirty_three_lock' | 'ring' | 'ical' | 'lodgify' | 'hostaway' | 'guesty' | 'acuity_scheduling' | 'omnitec';
|
|
75039
75066
|
display_name: string;
|
|
75040
75067
|
image_url: string;
|
|
75041
75068
|
provider_categories: ('stable' | 'consumer_smartlocks' | 'beta' | 'thermostats' | 'noise_sensors' | 'access_control_systems' | 'cameras' | 'connectors')[];
|
|
@@ -76289,6 +76316,17 @@ type Routes = {
|
|
|
76289
76316
|
[x: string]: string | boolean;
|
|
76290
76317
|
} | undefined;
|
|
76291
76318
|
event_type: 'access_code.changed';
|
|
76319
|
+
/** List of properties that changed on the access code. */
|
|
76320
|
+
changed_properties?: {
|
|
76321
|
+
/** Name of the property that changed (e.g. `code`). */
|
|
76322
|
+
property: string;
|
|
76323
|
+
/** Previous value of the property, or null if not set. */
|
|
76324
|
+
previous_value: string | null;
|
|
76325
|
+
/** New value of the property, or null if cleared. */
|
|
76326
|
+
new_value: string | null;
|
|
76327
|
+
}[] | undefined;
|
|
76328
|
+
/** Human-readable reason for the change (e.g. `ongoing code auto-renewed`). */
|
|
76329
|
+
change_reason?: string | undefined;
|
|
76292
76330
|
} | {
|
|
76293
76331
|
/** ID of the event. */
|
|
76294
76332
|
event_id: string;
|
|
@@ -79135,6 +79173,17 @@ type Routes = {
|
|
|
79135
79173
|
[x: string]: string | boolean;
|
|
79136
79174
|
} | undefined;
|
|
79137
79175
|
event_type: 'access_code.changed';
|
|
79176
|
+
/** List of properties that changed on the access code. */
|
|
79177
|
+
changed_properties?: {
|
|
79178
|
+
/** Name of the property that changed (e.g. `code`). */
|
|
79179
|
+
property: string;
|
|
79180
|
+
/** Previous value of the property, or null if not set. */
|
|
79181
|
+
previous_value: string | null;
|
|
79182
|
+
/** New value of the property, or null if cleared. */
|
|
79183
|
+
new_value: string | null;
|
|
79184
|
+
}[] | undefined;
|
|
79185
|
+
/** Human-readable reason for the change (e.g. `ongoing code auto-renewed`). */
|
|
79186
|
+
change_reason?: string | undefined;
|
|
79138
79187
|
} | {
|
|
79139
79188
|
/** ID of the event. */
|
|
79140
79189
|
event_id: string;
|
|
@@ -107424,6 +107473,17 @@ type Routes = {
|
|
|
107424
107473
|
[x: string]: string | boolean;
|
|
107425
107474
|
} | undefined;
|
|
107426
107475
|
event_type: 'access_code.changed';
|
|
107476
|
+
/** List of properties that changed on the access code. */
|
|
107477
|
+
changed_properties?: {
|
|
107478
|
+
/** Name of the property that changed (e.g. `code`). */
|
|
107479
|
+
property: string;
|
|
107480
|
+
/** Previous value of the property, or null if not set. */
|
|
107481
|
+
previous_value: string | null;
|
|
107482
|
+
/** New value of the property, or null if cleared. */
|
|
107483
|
+
new_value: string | null;
|
|
107484
|
+
}[] | undefined;
|
|
107485
|
+
/** Human-readable reason for the change (e.g. `ongoing code auto-renewed`). */
|
|
107486
|
+
change_reason?: string | undefined;
|
|
107427
107487
|
} | {
|
|
107428
107488
|
/** ID of the event. */
|
|
107429
107489
|
event_id: string;
|
|
@@ -143948,6 +144008,17 @@ type Routes = {
|
|
|
143948
144008
|
[x: string]: string | boolean;
|
|
143949
144009
|
} | undefined;
|
|
143950
144010
|
event_type: 'access_code.changed';
|
|
144011
|
+
/** List of properties that changed on the access code. */
|
|
144012
|
+
changed_properties?: {
|
|
144013
|
+
/** Name of the property that changed (e.g. `code`). */
|
|
144014
|
+
property: string;
|
|
144015
|
+
/** Previous value of the property, or null if not set. */
|
|
144016
|
+
previous_value: string | null;
|
|
144017
|
+
/** New value of the property, or null if cleared. */
|
|
144018
|
+
new_value: string | null;
|
|
144019
|
+
}[] | undefined;
|
|
144020
|
+
/** Human-readable reason for the change (e.g. `ongoing code auto-renewed`). */
|
|
144021
|
+
change_reason?: string | undefined;
|
|
143951
144022
|
} | {
|
|
143952
144023
|
/** ID of the event. */
|
|
143953
144024
|
event_id: string;
|
package/dist/index.cjs
CHANGED
|
@@ -2086,6 +2086,7 @@ var DEVICE_PROVIDERS = {
|
|
|
2086
2086
|
ULTRALOQ: "ultraloq",
|
|
2087
2087
|
DUSAW: "dusaw",
|
|
2088
2088
|
SIFELY: "sifely",
|
|
2089
|
+
THIRTY_THREE_LOCK: "thirty_three_lock",
|
|
2089
2090
|
RING: "ring",
|
|
2090
2091
|
ICAL: "ical",
|
|
2091
2092
|
LODGIFY: "lodgify",
|
|
@@ -2135,7 +2136,8 @@ var PROVIDER_CATEGORY_MAP = {
|
|
|
2135
2136
|
"keyincode",
|
|
2136
2137
|
"sifely",
|
|
2137
2138
|
"omnitec",
|
|
2138
|
-
"dusaw"
|
|
2139
|
+
"dusaw",
|
|
2140
|
+
"thirty_three_lock"
|
|
2139
2141
|
],
|
|
2140
2142
|
consumer_smartlocks: [
|
|
2141
2143
|
"akiles",
|
|
@@ -2155,7 +2157,8 @@ var PROVIDER_CATEGORY_MAP = {
|
|
|
2155
2157
|
"korelock",
|
|
2156
2158
|
"dusaw",
|
|
2157
2159
|
"keyincode",
|
|
2158
|
-
"sifely"
|
|
2160
|
+
"sifely",
|
|
2161
|
+
"thirty_three_lock"
|
|
2159
2162
|
],
|
|
2160
2163
|
beta: [],
|
|
2161
2164
|
thermostats: ["ecobee", "nest", "sensi", "honeywell_resideo", "first_alert"],
|
|
@@ -5537,7 +5540,17 @@ var access_code_created_event = access_code_event.extend({
|
|
|
5537
5540
|
An [access code](https://docs.seam.co/low-level-apis/smart-locks/access-codes) was created.
|
|
5538
5541
|
`);
|
|
5539
5542
|
var access_code_changed_event = access_code_event.extend({
|
|
5540
|
-
event_type: zod.z.literal("access_code.changed")
|
|
5543
|
+
event_type: zod.z.literal("access_code.changed"),
|
|
5544
|
+
changed_properties: zod.z.array(
|
|
5545
|
+
zod.z.object({
|
|
5546
|
+
property: zod.z.string().describe("Name of the property that changed (e.g. `code`)."),
|
|
5547
|
+
previous_value: zod.z.string().nullable().describe("Previous value of the property, or null if not set."),
|
|
5548
|
+
new_value: zod.z.string().nullable().describe("New value of the property, or null if cleared.")
|
|
5549
|
+
})
|
|
5550
|
+
).optional().describe("List of properties that changed on the access code."),
|
|
5551
|
+
change_reason: zod.z.string().optional().describe(
|
|
5552
|
+
"Human-readable reason for the change (e.g. `ongoing code auto-renewed`)."
|
|
5553
|
+
)
|
|
5541
5554
|
}).describe(`
|
|
5542
5555
|
---
|
|
5543
5556
|
route_path: /access_codes
|
|
@@ -22894,6 +22907,7 @@ var openapi = {
|
|
|
22894
22907
|
"ultraloq",
|
|
22895
22908
|
"dusaw",
|
|
22896
22909
|
"sifely",
|
|
22910
|
+
"thirty_three_lock",
|
|
22897
22911
|
"ring",
|
|
22898
22912
|
"ical",
|
|
22899
22913
|
"lodgify",
|
|
@@ -23051,6 +23065,34 @@ var openapi = {
|
|
|
23051
23065
|
format: "uuid",
|
|
23052
23066
|
type: "string"
|
|
23053
23067
|
},
|
|
23068
|
+
change_reason: {
|
|
23069
|
+
description: "Human-readable reason for the change (e.g. `ongoing code auto-renewed`).",
|
|
23070
|
+
type: "string"
|
|
23071
|
+
},
|
|
23072
|
+
changed_properties: {
|
|
23073
|
+
description: "List of properties that changed on the access code.",
|
|
23074
|
+
items: {
|
|
23075
|
+
properties: {
|
|
23076
|
+
new_value: {
|
|
23077
|
+
description: "New value of the property, or null if cleared.",
|
|
23078
|
+
nullable: true,
|
|
23079
|
+
type: "string"
|
|
23080
|
+
},
|
|
23081
|
+
previous_value: {
|
|
23082
|
+
description: "Previous value of the property, or null if not set.",
|
|
23083
|
+
nullable: true,
|
|
23084
|
+
type: "string"
|
|
23085
|
+
},
|
|
23086
|
+
property: {
|
|
23087
|
+
description: "Name of the property that changed (e.g. `code`).",
|
|
23088
|
+
type: "string"
|
|
23089
|
+
}
|
|
23090
|
+
},
|
|
23091
|
+
required: ["property", "previous_value", "new_value"],
|
|
23092
|
+
type: "object"
|
|
23093
|
+
},
|
|
23094
|
+
type: "array"
|
|
23095
|
+
},
|
|
23054
23096
|
connected_account_custom_metadata: {
|
|
23055
23097
|
additionalProperties: {
|
|
23056
23098
|
oneOf: [{ type: "string" }, { type: "boolean" }]
|
|
@@ -54621,6 +54663,7 @@ var openapi = {
|
|
|
54621
54663
|
"ultraloq",
|
|
54622
54664
|
"dusaw",
|
|
54623
54665
|
"sifely",
|
|
54666
|
+
"thirty_three_lock",
|
|
54624
54667
|
"ring",
|
|
54625
54668
|
"ical",
|
|
54626
54669
|
"lodgify",
|