@seamapi/types 1.460.1 → 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 +110 -0
- package/dist/connect.cjs.map +1 -1
- package/dist/connect.d.cts +173 -0
- package/dist/index.cjs +110 -0
- package/dist/index.cjs.map +1 -1
- package/lib/seam/connect/openapi.d.ts +142 -0
- package/lib/seam/connect/openapi.js +110 -0
- package/lib/seam/connect/openapi.js.map +1 -1
- package/lib/seam/connect/route-types.d.ts +31 -0
- package/package.json +1 -1
- package/src/lib/seam/connect/openapi.ts +115 -0
- package/src/lib/seam/connect/route-types.ts +31 -0
package/dist/connect.d.cts
CHANGED
|
@@ -45510,6 +45510,13 @@ declare const _default: {
|
|
|
45510
45510
|
};
|
|
45511
45511
|
type: string;
|
|
45512
45512
|
};
|
|
45513
|
+
space_keys: {
|
|
45514
|
+
description: string;
|
|
45515
|
+
items: {
|
|
45516
|
+
type: string;
|
|
45517
|
+
};
|
|
45518
|
+
type: string;
|
|
45519
|
+
};
|
|
45513
45520
|
starts_at: {
|
|
45514
45521
|
description: string;
|
|
45515
45522
|
type: string;
|
|
@@ -61474,6 +61481,141 @@ declare const _default: {
|
|
|
61474
61481
|
'x-title': string;
|
|
61475
61482
|
};
|
|
61476
61483
|
};
|
|
61484
|
+
'/instant_keys/list': {
|
|
61485
|
+
get: {
|
|
61486
|
+
description: string;
|
|
61487
|
+
operationId: string;
|
|
61488
|
+
parameters: {
|
|
61489
|
+
in: string;
|
|
61490
|
+
name: string;
|
|
61491
|
+
schema: {
|
|
61492
|
+
description: string;
|
|
61493
|
+
format: string;
|
|
61494
|
+
type: string;
|
|
61495
|
+
};
|
|
61496
|
+
}[];
|
|
61497
|
+
responses: {
|
|
61498
|
+
200: {
|
|
61499
|
+
content: {
|
|
61500
|
+
'application/json': {
|
|
61501
|
+
schema: {
|
|
61502
|
+
properties: {
|
|
61503
|
+
instant_keys: {
|
|
61504
|
+
items: {
|
|
61505
|
+
$ref: string;
|
|
61506
|
+
};
|
|
61507
|
+
type: string;
|
|
61508
|
+
};
|
|
61509
|
+
ok: {
|
|
61510
|
+
type: string;
|
|
61511
|
+
};
|
|
61512
|
+
};
|
|
61513
|
+
required: string[];
|
|
61514
|
+
type: string;
|
|
61515
|
+
};
|
|
61516
|
+
};
|
|
61517
|
+
};
|
|
61518
|
+
description: string;
|
|
61519
|
+
};
|
|
61520
|
+
400: {
|
|
61521
|
+
description: string;
|
|
61522
|
+
};
|
|
61523
|
+
401: {
|
|
61524
|
+
description: string;
|
|
61525
|
+
};
|
|
61526
|
+
};
|
|
61527
|
+
security: ({
|
|
61528
|
+
api_key: never[];
|
|
61529
|
+
pat_with_workspace?: never;
|
|
61530
|
+
console_session_with_workspace?: never;
|
|
61531
|
+
} | {
|
|
61532
|
+
pat_with_workspace: never[];
|
|
61533
|
+
api_key?: never;
|
|
61534
|
+
console_session_with_workspace?: never;
|
|
61535
|
+
} | {
|
|
61536
|
+
console_session_with_workspace: never[];
|
|
61537
|
+
api_key?: never;
|
|
61538
|
+
pat_with_workspace?: never;
|
|
61539
|
+
})[];
|
|
61540
|
+
summary: string;
|
|
61541
|
+
tags: never[];
|
|
61542
|
+
'x-fern-sdk-group-name': string[];
|
|
61543
|
+
'x-fern-sdk-method-name': string;
|
|
61544
|
+
'x-fern-sdk-return-value': string;
|
|
61545
|
+
'x-response-key': string;
|
|
61546
|
+
'x-title': string;
|
|
61547
|
+
};
|
|
61548
|
+
post: {
|
|
61549
|
+
description: string;
|
|
61550
|
+
operationId: string;
|
|
61551
|
+
requestBody: {
|
|
61552
|
+
content: {
|
|
61553
|
+
'application/json': {
|
|
61554
|
+
schema: {
|
|
61555
|
+
properties: {
|
|
61556
|
+
user_identity_id: {
|
|
61557
|
+
description: string;
|
|
61558
|
+
format: string;
|
|
61559
|
+
type: string;
|
|
61560
|
+
};
|
|
61561
|
+
};
|
|
61562
|
+
type: string;
|
|
61563
|
+
};
|
|
61564
|
+
};
|
|
61565
|
+
};
|
|
61566
|
+
};
|
|
61567
|
+
responses: {
|
|
61568
|
+
200: {
|
|
61569
|
+
content: {
|
|
61570
|
+
'application/json': {
|
|
61571
|
+
schema: {
|
|
61572
|
+
properties: {
|
|
61573
|
+
instant_keys: {
|
|
61574
|
+
items: {
|
|
61575
|
+
$ref: string;
|
|
61576
|
+
};
|
|
61577
|
+
type: string;
|
|
61578
|
+
};
|
|
61579
|
+
ok: {
|
|
61580
|
+
type: string;
|
|
61581
|
+
};
|
|
61582
|
+
};
|
|
61583
|
+
required: string[];
|
|
61584
|
+
type: string;
|
|
61585
|
+
};
|
|
61586
|
+
};
|
|
61587
|
+
};
|
|
61588
|
+
description: string;
|
|
61589
|
+
};
|
|
61590
|
+
400: {
|
|
61591
|
+
description: string;
|
|
61592
|
+
};
|
|
61593
|
+
401: {
|
|
61594
|
+
description: string;
|
|
61595
|
+
};
|
|
61596
|
+
};
|
|
61597
|
+
security: ({
|
|
61598
|
+
api_key: never[];
|
|
61599
|
+
pat_with_workspace?: never;
|
|
61600
|
+
console_session_with_workspace?: never;
|
|
61601
|
+
} | {
|
|
61602
|
+
pat_with_workspace: never[];
|
|
61603
|
+
api_key?: never;
|
|
61604
|
+
console_session_with_workspace?: never;
|
|
61605
|
+
} | {
|
|
61606
|
+
console_session_with_workspace: never[];
|
|
61607
|
+
api_key?: never;
|
|
61608
|
+
pat_with_workspace?: never;
|
|
61609
|
+
})[];
|
|
61610
|
+
summary: string;
|
|
61611
|
+
tags: never[];
|
|
61612
|
+
'x-fern-sdk-group-name': string[];
|
|
61613
|
+
'x-fern-sdk-method-name': string;
|
|
61614
|
+
'x-fern-sdk-return-value': string;
|
|
61615
|
+
'x-response-key': string;
|
|
61616
|
+
'x-title': string;
|
|
61617
|
+
};
|
|
61618
|
+
};
|
|
61477
61619
|
'/locks/get': {
|
|
61478
61620
|
get: {
|
|
61479
61621
|
description: string;
|
|
@@ -88614,6 +88756,8 @@ interface Routes {
|
|
|
88614
88756
|
location_ids?: string[] | undefined;
|
|
88615
88757
|
/** Set of IDs of existing spaces to which access is being granted. */
|
|
88616
88758
|
space_ids?: string[] | undefined;
|
|
88759
|
+
/** Set of keys of existing spaces to which access is being granted. */
|
|
88760
|
+
space_keys?: string[] | undefined;
|
|
88617
88761
|
/** When used, creates a new location with the given entrances and devices, and gives the user access to this location. */
|
|
88618
88762
|
location?: {
|
|
88619
88763
|
/** Name of the location. */
|
|
@@ -111187,6 +111331,35 @@ interface Routes {
|
|
|
111187
111331
|
}>;
|
|
111188
111332
|
};
|
|
111189
111333
|
};
|
|
111334
|
+
'/instant_keys/list': {
|
|
111335
|
+
route: '/instant_keys/list';
|
|
111336
|
+
method: 'GET' | 'POST';
|
|
111337
|
+
queryParams: {};
|
|
111338
|
+
jsonBody: {};
|
|
111339
|
+
commonParams: {
|
|
111340
|
+
/** ID of the user identity by which you want to filter the list of Instant Keys. */
|
|
111341
|
+
user_identity_id?: string | undefined;
|
|
111342
|
+
};
|
|
111343
|
+
formData: {};
|
|
111344
|
+
jsonResponse: {
|
|
111345
|
+
instant_keys: Array<{
|
|
111346
|
+
/** ID of the Instant Key. */
|
|
111347
|
+
instant_key_id: string;
|
|
111348
|
+
/** ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the Instant Key. */
|
|
111349
|
+
workspace_id: string;
|
|
111350
|
+
/** Date and time at which the Instant Key was created. */
|
|
111351
|
+
created_at: string;
|
|
111352
|
+
/** Shareable URL for the Instant Key. Use the URL to deliver the Instant Key to your user through a link in a text message or email or by embedding it in your web app. */
|
|
111353
|
+
instant_key_url: string;
|
|
111354
|
+
/** ID of the [client session](https://docs.seam.co/latest/core-concepts/authentication/client-session-tokens) associated with the Instant Key. */
|
|
111355
|
+
client_session_id: string;
|
|
111356
|
+
/** ID of the user identity associated with the Instant Key. */
|
|
111357
|
+
user_identity_id: string;
|
|
111358
|
+
/** Date and time at which the Instant Key expires. */
|
|
111359
|
+
expires_at: string;
|
|
111360
|
+
}>;
|
|
111361
|
+
};
|
|
111362
|
+
};
|
|
111190
111363
|
'/locks/get': {
|
|
111191
111364
|
route: '/locks/get';
|
|
111192
111365
|
method: 'GET' | 'POST';
|
package/dist/index.cjs
CHANGED
|
@@ -30578,6 +30578,11 @@ var openapi_default = {
|
|
|
30578
30578
|
items: { format: "uuid", type: "string" },
|
|
30579
30579
|
type: "array"
|
|
30580
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
|
+
},
|
|
30581
30586
|
starts_at: {
|
|
30582
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.",
|
|
30583
30588
|
type: "string"
|
|
@@ -44518,6 +44523,111 @@ var openapi_default = {
|
|
|
44518
44523
|
"x-title": "List Events"
|
|
44519
44524
|
}
|
|
44520
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
|
+
},
|
|
44521
44631
|
"/locks/get": {
|
|
44522
44632
|
get: {
|
|
44523
44633
|
description: "Returns a specified [lock](https://docs.seam.co/latest/capability-guides/smart-locks). **Use `/devices/get` instead.**",
|