@seamapi/types 1.502.0 → 1.504.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 +331 -0
- package/dist/connect.cjs.map +1 -1
- package/dist/connect.d.cts +333 -0
- package/dist/index.cjs +331 -0
- package/dist/index.cjs.map +1 -1
- package/lib/seam/connect/models/access-codes/managed-access-code.d.ts +3 -0
- package/lib/seam/connect/models/access-codes/managed-access-code.js +4 -0
- package/lib/seam/connect/models/access-codes/managed-access-code.js.map +1 -1
- package/lib/seam/connect/models/access-codes/unmanaged-access-code.d.ts +3 -0
- package/lib/seam/connect/models/access-codes/unmanaged-access-code.js +1 -0
- package/lib/seam/connect/models/access-codes/unmanaged-access-code.js.map +1 -1
- package/lib/seam/connect/models/batch.d.ts +20 -0
- package/lib/seam/connect/models/customer/customer-delete-data.d.ts +57 -0
- package/lib/seam/connect/models/customer/customer-delete-data.js +75 -0
- package/lib/seam/connect/models/customer/customer-delete-data.js.map +1 -0
- package/lib/seam/connect/models/customer/index.d.ts +1 -0
- package/lib/seam/connect/models/customer/index.js +1 -0
- package/lib/seam/connect/models/customer/index.js.map +1 -1
- package/lib/seam/connect/models/index.d.ts +1 -0
- package/lib/seam/connect/models/index.js +1 -0
- package/lib/seam/connect/models/index.js.map +1 -1
- package/lib/seam/connect/openapi.d.ts +247 -0
- package/lib/seam/connect/openapi.js +327 -0
- package/lib/seam/connect/openapi.js.map +1 -1
- package/lib/seam/connect/route-types.d.ts +70 -0
- package/package.json +1 -1
- package/src/lib/seam/connect/models/access-codes/managed-access-code.ts +6 -0
- package/src/lib/seam/connect/models/access-codes/unmanaged-access-code.ts +1 -0
- package/src/lib/seam/connect/models/customer/customer-delete-data.ts +79 -0
- package/src/lib/seam/connect/models/customer/index.ts +1 -0
- package/src/lib/seam/connect/models/index.ts +1 -0
- package/src/lib/seam/connect/openapi.ts +331 -0
- package/src/lib/seam/connect/route-types.ts +70 -0
package/dist/index.cjs
CHANGED
|
@@ -2112,6 +2112,9 @@ zod.z.object({
|
|
|
2112
2112
|
kwikset_unable_to_confirm_code_warning: kwikset_unable_to_confirm_code_warning.optional().nullable()
|
|
2113
2113
|
});
|
|
2114
2114
|
var access_code = zod.z.object({
|
|
2115
|
+
workspace_id: zod.z.string().uuid().describe(
|
|
2116
|
+
"Unique identifier for the Seam workspace associated with the access code."
|
|
2117
|
+
),
|
|
2115
2118
|
common_code_key: zod.z.string().nullable().describe(
|
|
2116
2119
|
"Unique identifier for a group of access codes that share the same code."
|
|
2117
2120
|
),
|
|
@@ -2219,6 +2222,7 @@ var access_code = zod.z.object({
|
|
|
2219
2222
|
In addition, for certain devices, Seam also supports [offline access codes](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#offline-access-codes). Offline access (PIN) codes are designed for door locks that might not always maintain an internet connection. For this type of access code, the device manufacturer uses encryption keys (tokens) to create server-based registries of algorithmically-generated offline PIN codes. Because the tokens remain synchronized with the managed devices, the locks do not require an active internet connection\u2014and you do not need to be near the locks\u2014to create an offline access code. Then, owners or managers can share these offline codes with users through a variety of mechanisms, such as messaging applications. That is, lock users do not need to install a smartphone application to receive an offline access code.
|
|
2220
2223
|
`);
|
|
2221
2224
|
var unmanaged_access_code = access_code.pick({
|
|
2225
|
+
workspace_id: true,
|
|
2222
2226
|
type: true,
|
|
2223
2227
|
access_code_id: true,
|
|
2224
2228
|
device_id: true,
|
|
@@ -7075,9 +7079,15 @@ var openapi_default = {
|
|
|
7075
7079
|
provider_metadata: { name: "Provider Metadata" },
|
|
7076
7080
|
thermostats: { name: "Thermostats" }
|
|
7077
7081
|
}
|
|
7082
|
+
},
|
|
7083
|
+
workspace_id: {
|
|
7084
|
+
description: "Unique identifier for the Seam workspace associated with the access code.",
|
|
7085
|
+
format: "uuid",
|
|
7086
|
+
type: "string"
|
|
7078
7087
|
}
|
|
7079
7088
|
},
|
|
7080
7089
|
required: [
|
|
7090
|
+
"workspace_id",
|
|
7081
7091
|
"common_code_key",
|
|
7082
7092
|
"type",
|
|
7083
7093
|
"access_code_id",
|
|
@@ -25490,9 +25500,15 @@ var openapi_default = {
|
|
|
25490
25500
|
provider_metadata: { name: "Provider Metadata" },
|
|
25491
25501
|
thermostats: { name: "Thermostats" }
|
|
25492
25502
|
}
|
|
25503
|
+
},
|
|
25504
|
+
workspace_id: {
|
|
25505
|
+
description: "Unique identifier for the Seam workspace associated with the access code.",
|
|
25506
|
+
format: "uuid",
|
|
25507
|
+
type: "string"
|
|
25493
25508
|
}
|
|
25494
25509
|
},
|
|
25495
25510
|
required: [
|
|
25511
|
+
"workspace_id",
|
|
25496
25512
|
"type",
|
|
25497
25513
|
"access_code_id",
|
|
25498
25514
|
"device_id",
|
|
@@ -41007,6 +41023,321 @@ var openapi_default = {
|
|
|
41007
41023
|
"x-title": "Create Customer Portal"
|
|
41008
41024
|
}
|
|
41009
41025
|
},
|
|
41026
|
+
"/customers/delete_data": {
|
|
41027
|
+
delete: {
|
|
41028
|
+
description: "Deletes customer data including resources like spaces, properties, rooms, users, etc.\nThis will delete the partner resources and any related Seam resources (user identities, access grants, spaces).",
|
|
41029
|
+
operationId: "customersDeleteDataDelete",
|
|
41030
|
+
parameters: [
|
|
41031
|
+
{
|
|
41032
|
+
in: "query",
|
|
41033
|
+
name: "space_keys",
|
|
41034
|
+
schema: {
|
|
41035
|
+
description: "List of space keys to delete.",
|
|
41036
|
+
items: { type: "string" },
|
|
41037
|
+
type: "array"
|
|
41038
|
+
}
|
|
41039
|
+
},
|
|
41040
|
+
{
|
|
41041
|
+
in: "query",
|
|
41042
|
+
name: "property_keys",
|
|
41043
|
+
schema: {
|
|
41044
|
+
description: "List of property keys to delete.",
|
|
41045
|
+
items: { type: "string" },
|
|
41046
|
+
type: "array"
|
|
41047
|
+
}
|
|
41048
|
+
},
|
|
41049
|
+
{
|
|
41050
|
+
in: "query",
|
|
41051
|
+
name: "room_keys",
|
|
41052
|
+
schema: {
|
|
41053
|
+
description: "List of room keys to delete.",
|
|
41054
|
+
items: { type: "string" },
|
|
41055
|
+
type: "array"
|
|
41056
|
+
}
|
|
41057
|
+
},
|
|
41058
|
+
{
|
|
41059
|
+
in: "query",
|
|
41060
|
+
name: "common_area_keys",
|
|
41061
|
+
schema: {
|
|
41062
|
+
description: "List of common area keys to delete.",
|
|
41063
|
+
items: { type: "string" },
|
|
41064
|
+
type: "array"
|
|
41065
|
+
}
|
|
41066
|
+
},
|
|
41067
|
+
{
|
|
41068
|
+
in: "query",
|
|
41069
|
+
name: "unit_keys",
|
|
41070
|
+
schema: {
|
|
41071
|
+
description: "List of unit keys to delete.",
|
|
41072
|
+
items: { type: "string" },
|
|
41073
|
+
type: "array"
|
|
41074
|
+
}
|
|
41075
|
+
},
|
|
41076
|
+
{
|
|
41077
|
+
in: "query",
|
|
41078
|
+
name: "facility_keys",
|
|
41079
|
+
schema: {
|
|
41080
|
+
description: "List of facility keys to delete.",
|
|
41081
|
+
items: { type: "string" },
|
|
41082
|
+
type: "array"
|
|
41083
|
+
}
|
|
41084
|
+
},
|
|
41085
|
+
{
|
|
41086
|
+
in: "query",
|
|
41087
|
+
name: "building_keys",
|
|
41088
|
+
schema: {
|
|
41089
|
+
description: "List of building keys to delete.",
|
|
41090
|
+
items: { type: "string" },
|
|
41091
|
+
type: "array"
|
|
41092
|
+
}
|
|
41093
|
+
},
|
|
41094
|
+
{
|
|
41095
|
+
in: "query",
|
|
41096
|
+
name: "listing_keys",
|
|
41097
|
+
schema: {
|
|
41098
|
+
description: "List of listing keys to delete.",
|
|
41099
|
+
items: { type: "string" },
|
|
41100
|
+
type: "array"
|
|
41101
|
+
}
|
|
41102
|
+
},
|
|
41103
|
+
{
|
|
41104
|
+
in: "query",
|
|
41105
|
+
name: "property_listing_keys",
|
|
41106
|
+
schema: {
|
|
41107
|
+
description: "List of property listing keys to delete.",
|
|
41108
|
+
items: { type: "string" },
|
|
41109
|
+
type: "array"
|
|
41110
|
+
}
|
|
41111
|
+
},
|
|
41112
|
+
{
|
|
41113
|
+
in: "query",
|
|
41114
|
+
name: "guest_keys",
|
|
41115
|
+
schema: {
|
|
41116
|
+
description: "List of guest keys to delete.",
|
|
41117
|
+
items: { type: "string" },
|
|
41118
|
+
type: "array"
|
|
41119
|
+
}
|
|
41120
|
+
},
|
|
41121
|
+
{
|
|
41122
|
+
in: "query",
|
|
41123
|
+
name: "tenant_keys",
|
|
41124
|
+
schema: {
|
|
41125
|
+
description: "List of tenant keys to delete.",
|
|
41126
|
+
items: { type: "string" },
|
|
41127
|
+
type: "array"
|
|
41128
|
+
}
|
|
41129
|
+
},
|
|
41130
|
+
{
|
|
41131
|
+
in: "query",
|
|
41132
|
+
name: "resident_keys",
|
|
41133
|
+
schema: {
|
|
41134
|
+
description: "List of resident keys to delete.",
|
|
41135
|
+
items: { type: "string" },
|
|
41136
|
+
type: "array"
|
|
41137
|
+
}
|
|
41138
|
+
},
|
|
41139
|
+
{
|
|
41140
|
+
in: "query",
|
|
41141
|
+
name: "user_keys",
|
|
41142
|
+
schema: {
|
|
41143
|
+
description: "List of user keys to delete.",
|
|
41144
|
+
items: { type: "string" },
|
|
41145
|
+
type: "array"
|
|
41146
|
+
}
|
|
41147
|
+
},
|
|
41148
|
+
{
|
|
41149
|
+
in: "query",
|
|
41150
|
+
name: "user_identity_keys",
|
|
41151
|
+
schema: {
|
|
41152
|
+
description: "List of user identity keys to delete.",
|
|
41153
|
+
items: { type: "string" },
|
|
41154
|
+
type: "array"
|
|
41155
|
+
}
|
|
41156
|
+
},
|
|
41157
|
+
{
|
|
41158
|
+
in: "query",
|
|
41159
|
+
name: "reservation_keys",
|
|
41160
|
+
schema: {
|
|
41161
|
+
description: "List of reservation keys to delete.",
|
|
41162
|
+
items: { type: "string" },
|
|
41163
|
+
type: "array"
|
|
41164
|
+
}
|
|
41165
|
+
},
|
|
41166
|
+
{
|
|
41167
|
+
in: "query",
|
|
41168
|
+
name: "booking_keys",
|
|
41169
|
+
schema: {
|
|
41170
|
+
description: "List of booking keys to delete.",
|
|
41171
|
+
items: { type: "string" },
|
|
41172
|
+
type: "array"
|
|
41173
|
+
}
|
|
41174
|
+
},
|
|
41175
|
+
{
|
|
41176
|
+
in: "query",
|
|
41177
|
+
name: "access_grant_keys",
|
|
41178
|
+
schema: {
|
|
41179
|
+
description: "List of access grant keys to delete.",
|
|
41180
|
+
items: { type: "string" },
|
|
41181
|
+
type: "array"
|
|
41182
|
+
}
|
|
41183
|
+
}
|
|
41184
|
+
],
|
|
41185
|
+
responses: {
|
|
41186
|
+
200: {
|
|
41187
|
+
content: {
|
|
41188
|
+
"application/json": {
|
|
41189
|
+
schema: {
|
|
41190
|
+
properties: { ok: { type: "boolean" } },
|
|
41191
|
+
required: ["ok"],
|
|
41192
|
+
type: "object"
|
|
41193
|
+
}
|
|
41194
|
+
}
|
|
41195
|
+
},
|
|
41196
|
+
description: "OK"
|
|
41197
|
+
},
|
|
41198
|
+
400: { description: "Bad Request" },
|
|
41199
|
+
401: { description: "Unauthorized" }
|
|
41200
|
+
},
|
|
41201
|
+
security: [
|
|
41202
|
+
{ pat_with_workspace: [] },
|
|
41203
|
+
{ console_session_with_workspace: [] },
|
|
41204
|
+
{ api_key: [] }
|
|
41205
|
+
],
|
|
41206
|
+
summary: "/customers/delete_data",
|
|
41207
|
+
tags: [],
|
|
41208
|
+
"x-fern-sdk-group-name": ["customers"],
|
|
41209
|
+
"x-fern-sdk-method-name": "delete_data",
|
|
41210
|
+
"x-response-key": null,
|
|
41211
|
+
"x-title": "Delete Customer Data"
|
|
41212
|
+
},
|
|
41213
|
+
post: {
|
|
41214
|
+
description: "Deletes customer data including resources like spaces, properties, rooms, users, etc.\nThis will delete the partner resources and any related Seam resources (user identities, access grants, spaces).",
|
|
41215
|
+
operationId: "customersDeleteDataPost",
|
|
41216
|
+
requestBody: {
|
|
41217
|
+
content: {
|
|
41218
|
+
"application/json": {
|
|
41219
|
+
schema: {
|
|
41220
|
+
properties: {
|
|
41221
|
+
access_grant_keys: {
|
|
41222
|
+
description: "List of access grant keys to delete.",
|
|
41223
|
+
items: { type: "string" },
|
|
41224
|
+
type: "array"
|
|
41225
|
+
},
|
|
41226
|
+
booking_keys: {
|
|
41227
|
+
description: "List of booking keys to delete.",
|
|
41228
|
+
items: { type: "string" },
|
|
41229
|
+
type: "array"
|
|
41230
|
+
},
|
|
41231
|
+
building_keys: {
|
|
41232
|
+
description: "List of building keys to delete.",
|
|
41233
|
+
items: { type: "string" },
|
|
41234
|
+
type: "array"
|
|
41235
|
+
},
|
|
41236
|
+
common_area_keys: {
|
|
41237
|
+
description: "List of common area keys to delete.",
|
|
41238
|
+
items: { type: "string" },
|
|
41239
|
+
type: "array"
|
|
41240
|
+
},
|
|
41241
|
+
facility_keys: {
|
|
41242
|
+
description: "List of facility keys to delete.",
|
|
41243
|
+
items: { type: "string" },
|
|
41244
|
+
type: "array"
|
|
41245
|
+
},
|
|
41246
|
+
guest_keys: {
|
|
41247
|
+
description: "List of guest keys to delete.",
|
|
41248
|
+
items: { type: "string" },
|
|
41249
|
+
type: "array"
|
|
41250
|
+
},
|
|
41251
|
+
listing_keys: {
|
|
41252
|
+
description: "List of listing keys to delete.",
|
|
41253
|
+
items: { type: "string" },
|
|
41254
|
+
type: "array"
|
|
41255
|
+
},
|
|
41256
|
+
property_keys: {
|
|
41257
|
+
description: "List of property keys to delete.",
|
|
41258
|
+
items: { type: "string" },
|
|
41259
|
+
type: "array"
|
|
41260
|
+
},
|
|
41261
|
+
property_listing_keys: {
|
|
41262
|
+
description: "List of property listing keys to delete.",
|
|
41263
|
+
items: { type: "string" },
|
|
41264
|
+
type: "array"
|
|
41265
|
+
},
|
|
41266
|
+
reservation_keys: {
|
|
41267
|
+
description: "List of reservation keys to delete.",
|
|
41268
|
+
items: { type: "string" },
|
|
41269
|
+
type: "array"
|
|
41270
|
+
},
|
|
41271
|
+
resident_keys: {
|
|
41272
|
+
description: "List of resident keys to delete.",
|
|
41273
|
+
items: { type: "string" },
|
|
41274
|
+
type: "array"
|
|
41275
|
+
},
|
|
41276
|
+
room_keys: {
|
|
41277
|
+
description: "List of room keys to delete.",
|
|
41278
|
+
items: { type: "string" },
|
|
41279
|
+
type: "array"
|
|
41280
|
+
},
|
|
41281
|
+
space_keys: {
|
|
41282
|
+
description: "List of space keys to delete.",
|
|
41283
|
+
items: { type: "string" },
|
|
41284
|
+
type: "array"
|
|
41285
|
+
},
|
|
41286
|
+
tenant_keys: {
|
|
41287
|
+
description: "List of tenant keys to delete.",
|
|
41288
|
+
items: { type: "string" },
|
|
41289
|
+
type: "array"
|
|
41290
|
+
},
|
|
41291
|
+
unit_keys: {
|
|
41292
|
+
description: "List of unit keys to delete.",
|
|
41293
|
+
items: { type: "string" },
|
|
41294
|
+
type: "array"
|
|
41295
|
+
},
|
|
41296
|
+
user_identity_keys: {
|
|
41297
|
+
description: "List of user identity keys to delete.",
|
|
41298
|
+
items: { type: "string" },
|
|
41299
|
+
type: "array"
|
|
41300
|
+
},
|
|
41301
|
+
user_keys: {
|
|
41302
|
+
description: "List of user keys to delete.",
|
|
41303
|
+
items: { type: "string" },
|
|
41304
|
+
type: "array"
|
|
41305
|
+
}
|
|
41306
|
+
},
|
|
41307
|
+
type: "object"
|
|
41308
|
+
}
|
|
41309
|
+
}
|
|
41310
|
+
}
|
|
41311
|
+
},
|
|
41312
|
+
responses: {
|
|
41313
|
+
200: {
|
|
41314
|
+
content: {
|
|
41315
|
+
"application/json": {
|
|
41316
|
+
schema: {
|
|
41317
|
+
properties: { ok: { type: "boolean" } },
|
|
41318
|
+
required: ["ok"],
|
|
41319
|
+
type: "object"
|
|
41320
|
+
}
|
|
41321
|
+
}
|
|
41322
|
+
},
|
|
41323
|
+
description: "OK"
|
|
41324
|
+
},
|
|
41325
|
+
400: { description: "Bad Request" },
|
|
41326
|
+
401: { description: "Unauthorized" }
|
|
41327
|
+
},
|
|
41328
|
+
security: [
|
|
41329
|
+
{ pat_with_workspace: [] },
|
|
41330
|
+
{ console_session_with_workspace: [] },
|
|
41331
|
+
{ api_key: [] }
|
|
41332
|
+
],
|
|
41333
|
+
summary: "/customers/delete_data",
|
|
41334
|
+
tags: [],
|
|
41335
|
+
"x-fern-sdk-group-name": ["customers"],
|
|
41336
|
+
"x-fern-sdk-method-name": "delete_data",
|
|
41337
|
+
"x-response-key": null,
|
|
41338
|
+
"x-title": "Delete Customer Data"
|
|
41339
|
+
}
|
|
41340
|
+
},
|
|
41010
41341
|
"/customers/push_data": {
|
|
41011
41342
|
post: {
|
|
41012
41343
|
description: "Pushes customer data including resources like spaces, properties, rooms, users, etc.",
|