@seamapi/types 1.1085.0 → 1.1087.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/lib/seam/connect/model-types.d.ts +1 -1
- package/lib/seam/connect/models/events/devices.d.ts +12 -6
- package/lib/seam/connect/models/events/devices.js +7 -3
- package/lib/seam/connect/models/events/devices.js.map +1 -1
- package/lib/seam/connect/models/events/seam-event.d.ts +6 -3
- 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/models/instant-keys/instant-key-preview.d.ts +6 -6
- package/lib/seam/connect/models/media/index.d.ts +1 -0
- package/lib/seam/connect/models/media/index.js +2 -0
- package/lib/seam/connect/models/media/index.js.map +1 -0
- package/lib/seam/connect/models/media/media.d.ts +36 -0
- package/lib/seam/connect/models/media/media.js +44 -0
- package/lib/seam/connect/models/media/media.js.map +1 -0
- package/lib/seam/connect/openapi.js +186 -4
- package/lib/seam/connect/openapi.js.map +1 -1
- package/lib/seam/connect/route-types.d.ts +67 -10
- package/lib/seam/connect/schemas.d.ts +1 -1
- package/lib/seam/connect/schemas.js +1 -1
- package/lib/seam/connect/schemas.js.map +1 -1
- package/package.json +1 -1
- package/src/lib/seam/connect/internal/schemas.ts +1 -0
- package/src/lib/seam/connect/model-types.ts +1 -0
- package/src/lib/seam/connect/models/events/devices.ts +9 -3
- package/src/lib/seam/connect/models/index.ts +1 -0
- package/src/lib/seam/connect/models/media/index.ts +1 -0
- package/src/lib/seam/connect/models/media/media.ts +55 -0
- package/src/lib/seam/connect/openapi.ts +194 -4
- package/src/lib/seam/connect/route-types.ts +71 -17
- package/src/lib/seam/connect/schemas.ts +1 -0
|
@@ -26123,10 +26123,10 @@ const openapi = {
|
|
|
26123
26123
|
format: 'uri',
|
|
26124
26124
|
type: 'string',
|
|
26125
26125
|
},
|
|
26126
|
-
|
|
26127
|
-
description: '
|
|
26128
|
-
|
|
26129
|
-
type: '
|
|
26126
|
+
media_ids: {
|
|
26127
|
+
description: 'IDs of the media, such as a video clip and a thumbnail image, captured for this activation. Use `/media/get` to retrieve each one.',
|
|
26128
|
+
items: { format: 'uuid', type: 'string' },
|
|
26129
|
+
type: 'array',
|
|
26130
26130
|
},
|
|
26131
26131
|
motion_sub_type: {
|
|
26132
26132
|
description: 'Sub-type of motion detected, if available.',
|
|
@@ -26213,6 +26213,11 @@ const openapi = {
|
|
|
26213
26213
|
format: 'uri',
|
|
26214
26214
|
type: 'string',
|
|
26215
26215
|
},
|
|
26216
|
+
media_ids: {
|
|
26217
|
+
description: 'IDs of the media, such as a video clip and a thumbnail image, captured when the doorbell was pressed. Use `/media/get` to retrieve each one.',
|
|
26218
|
+
items: { format: 'uuid', type: 'string' },
|
|
26219
|
+
type: 'array',
|
|
26220
|
+
},
|
|
26216
26221
|
occurred_at: {
|
|
26217
26222
|
description: 'Date and time at which the event occurred.',
|
|
26218
26223
|
format: 'date-time',
|
|
@@ -26654,6 +26659,79 @@ const openapi = {
|
|
|
26654
26659
|
'x-route-path': '/unstable_partner/building_blocks',
|
|
26655
26660
|
'x-undocumented': 'Unreleased.',
|
|
26656
26661
|
},
|
|
26662
|
+
media: {
|
|
26663
|
+
description: 'Represents a piece of media, such as a video clip or a thumbnail image, that a device captured for an event. Media is in beta.',
|
|
26664
|
+
properties: {
|
|
26665
|
+
content_type: {
|
|
26666
|
+
description: 'MIME type of the media, such as `video/mp4` or `image/jpeg`.',
|
|
26667
|
+
nullable: true,
|
|
26668
|
+
type: 'string',
|
|
26669
|
+
},
|
|
26670
|
+
created_at: {
|
|
26671
|
+
description: 'Date and time at which the media was created.',
|
|
26672
|
+
format: 'date-time',
|
|
26673
|
+
type: 'string',
|
|
26674
|
+
},
|
|
26675
|
+
device_id: {
|
|
26676
|
+
description: 'ID of the device that captured the media.',
|
|
26677
|
+
format: 'uuid',
|
|
26678
|
+
nullable: true,
|
|
26679
|
+
type: 'string',
|
|
26680
|
+
},
|
|
26681
|
+
event_id: {
|
|
26682
|
+
description: 'ID of the event that the media belongs to.',
|
|
26683
|
+
format: 'uuid',
|
|
26684
|
+
nullable: true,
|
|
26685
|
+
type: 'string',
|
|
26686
|
+
},
|
|
26687
|
+
expires_at: {
|
|
26688
|
+
description: 'Date and time at which the media stops being available. Null when Seam does not know when the media expires.',
|
|
26689
|
+
format: 'date-time',
|
|
26690
|
+
nullable: true,
|
|
26691
|
+
type: 'string',
|
|
26692
|
+
},
|
|
26693
|
+
media_id: {
|
|
26694
|
+
description: 'ID of the media.',
|
|
26695
|
+
format: 'uuid',
|
|
26696
|
+
type: 'string',
|
|
26697
|
+
},
|
|
26698
|
+
media_type: {
|
|
26699
|
+
description: 'Type of the media: a video clip or a still image.',
|
|
26700
|
+
enum: ['video', 'image'],
|
|
26701
|
+
type: 'string',
|
|
26702
|
+
},
|
|
26703
|
+
status: {
|
|
26704
|
+
description: 'Status of the media. `pending` means that Seam is still retrieving the media. `available` means that `url` can be used to download it. `unavailable` means that no media exists for the event, and `failed` means that Seam could not retrieve it.',
|
|
26705
|
+
enum: ['pending', 'available', 'unavailable', 'failed'],
|
|
26706
|
+
type: 'string',
|
|
26707
|
+
},
|
|
26708
|
+
url: {
|
|
26709
|
+
description: 'Short-lived URL from which you can download the media. Null unless `status` is `available`. The URL expires after about five minutes. Call `/media/get` again for a new URL.',
|
|
26710
|
+
format: 'uri',
|
|
26711
|
+
nullable: true,
|
|
26712
|
+
type: 'string',
|
|
26713
|
+
},
|
|
26714
|
+
workspace_id: {
|
|
26715
|
+
description: 'ID of the workspace that contains the media.',
|
|
26716
|
+
format: 'uuid',
|
|
26717
|
+
type: 'string',
|
|
26718
|
+
},
|
|
26719
|
+
},
|
|
26720
|
+
required: [
|
|
26721
|
+
'media_id',
|
|
26722
|
+
'workspace_id',
|
|
26723
|
+
'device_id',
|
|
26724
|
+
'event_id',
|
|
26725
|
+
'media_type',
|
|
26726
|
+
'content_type',
|
|
26727
|
+
'status',
|
|
26728
|
+
'url',
|
|
26729
|
+
'expires_at',
|
|
26730
|
+
'created_at',
|
|
26731
|
+
],
|
|
26732
|
+
type: 'object',
|
|
26733
|
+
'x-route-path': '/media',
|
|
26734
|
+
},
|
|
26657
26735
|
noise_threshold: {
|
|
26658
26736
|
description: 'Represents a [noise threshold](https://www.seam.co/docs/capability-guides/noise-sensors/configure-noise-threshold-settings) for a [noise sensor](https://www.seam.co/docs/capability-guides/noise-sensors). Thresholds represent the limits of noise tolerated at a property, which can be customized for each hour of the day. Each device has its own default thresholds, but you can use the Seam API to modify them.',
|
|
26659
26737
|
properties: {
|
|
@@ -50180,6 +50258,70 @@ const openapi = {
|
|
|
50180
50258
|
'x-title': 'Unlock a Lock',
|
|
50181
50259
|
},
|
|
50182
50260
|
},
|
|
50261
|
+
'/media/get': {
|
|
50262
|
+
get: {
|
|
50263
|
+
description: 'Returns a specified piece of media, such as a video clip or thumbnail image captured for a camera event, with a short-lived URL from which you can download it. Camera events list their media in `media_ids`. This endpoint is in beta.',
|
|
50264
|
+
operationId: 'mediaGetGet',
|
|
50265
|
+
parameters: [
|
|
50266
|
+
{
|
|
50267
|
+
in: 'query',
|
|
50268
|
+
name: 'media_id',
|
|
50269
|
+
required: true,
|
|
50270
|
+
schema: {
|
|
50271
|
+
description: 'ID of the media that you want to get.',
|
|
50272
|
+
format: 'uuid',
|
|
50273
|
+
type: 'string',
|
|
50274
|
+
},
|
|
50275
|
+
},
|
|
50276
|
+
{
|
|
50277
|
+
in: 'query',
|
|
50278
|
+
name: 'format',
|
|
50279
|
+
required: false,
|
|
50280
|
+
schema: {
|
|
50281
|
+
default: 'json',
|
|
50282
|
+
description: "Response format. `json` returns the media object. `redirect` responds with a `302` redirect to the media's download URL, so you can use this endpoint directly as the source of an image or video.",
|
|
50283
|
+
enum: ['json', 'redirect'],
|
|
50284
|
+
type: 'string',
|
|
50285
|
+
},
|
|
50286
|
+
},
|
|
50287
|
+
],
|
|
50288
|
+
responses: {
|
|
50289
|
+
'200': {
|
|
50290
|
+
content: {
|
|
50291
|
+
'application/json': {
|
|
50292
|
+
schema: {
|
|
50293
|
+
properties: {
|
|
50294
|
+
media: { $ref: '#/components/schemas/media' },
|
|
50295
|
+
ok: { type: 'boolean' },
|
|
50296
|
+
},
|
|
50297
|
+
required: ['media', 'ok'],
|
|
50298
|
+
type: 'object',
|
|
50299
|
+
},
|
|
50300
|
+
},
|
|
50301
|
+
},
|
|
50302
|
+
description: 'OK',
|
|
50303
|
+
},
|
|
50304
|
+
'400': { description: 'Bad Request' },
|
|
50305
|
+
'401': { description: 'Unauthorized' },
|
|
50306
|
+
},
|
|
50307
|
+
security: [
|
|
50308
|
+
{ api_key: [] },
|
|
50309
|
+
{ pat_with_workspace: [] },
|
|
50310
|
+
{ console_session_with_workspace: [] },
|
|
50311
|
+
{ client_session: [] },
|
|
50312
|
+
{ client_session_with_customer: [] },
|
|
50313
|
+
{ client_session_with_customer_ro: [] },
|
|
50314
|
+
{ support_read_only_token: [] },
|
|
50315
|
+
],
|
|
50316
|
+
summary: '/media/get',
|
|
50317
|
+
tags: [],
|
|
50318
|
+
'x-fern-sdk-group-name': ['media'],
|
|
50319
|
+
'x-fern-sdk-method-name': 'get',
|
|
50320
|
+
'x-fern-sdk-return-value': 'media',
|
|
50321
|
+
'x-response-key': 'media',
|
|
50322
|
+
'x-title': 'Get Media',
|
|
50323
|
+
},
|
|
50324
|
+
},
|
|
50183
50325
|
'/noise_sensors/list': {
|
|
50184
50326
|
get: {
|
|
50185
50327
|
description: 'Returns a list of all [noise sensors](https://www.seam.co/docs/capability-guides/noise-sensors).',
|
|
@@ -54344,6 +54486,11 @@ const openapi = {
|
|
|
54344
54486
|
properties: {
|
|
54345
54487
|
config: {
|
|
54346
54488
|
properties: {
|
|
54489
|
+
access_ends_minutes_after_reservation: {
|
|
54490
|
+
maximum: 1440,
|
|
54491
|
+
minimum: 0,
|
|
54492
|
+
type: 'integer',
|
|
54493
|
+
},
|
|
54347
54494
|
access_methods: {
|
|
54348
54495
|
items: {
|
|
54349
54496
|
enum: ['card', 'mobile_key', 'code'],
|
|
@@ -54352,6 +54499,11 @@ const openapi = {
|
|
|
54352
54499
|
minItems: 1,
|
|
54353
54500
|
type: 'array',
|
|
54354
54501
|
},
|
|
54502
|
+
access_starts_minutes_before_reservation: {
|
|
54503
|
+
maximum: 1440,
|
|
54504
|
+
minimum: 0,
|
|
54505
|
+
type: 'integer',
|
|
54506
|
+
},
|
|
54355
54507
|
allow_shared_email_and_phone_across_user_identities: { type: 'boolean' },
|
|
54356
54508
|
card_count_on_reservation_create: {
|
|
54357
54509
|
minimum: 0,
|
|
@@ -54628,6 +54780,11 @@ const openapi = {
|
|
|
54628
54780
|
properties: {
|
|
54629
54781
|
config: {
|
|
54630
54782
|
properties: {
|
|
54783
|
+
access_ends_minutes_after_reservation: {
|
|
54784
|
+
maximum: 1440,
|
|
54785
|
+
minimum: 0,
|
|
54786
|
+
type: 'integer',
|
|
54787
|
+
},
|
|
54631
54788
|
access_methods: {
|
|
54632
54789
|
items: {
|
|
54633
54790
|
enum: ['card', 'mobile_key', 'code'],
|
|
@@ -54636,6 +54793,11 @@ const openapi = {
|
|
|
54636
54793
|
minItems: 1,
|
|
54637
54794
|
type: 'array',
|
|
54638
54795
|
},
|
|
54796
|
+
access_starts_minutes_before_reservation: {
|
|
54797
|
+
maximum: 1440,
|
|
54798
|
+
minimum: 0,
|
|
54799
|
+
type: 'integer',
|
|
54800
|
+
},
|
|
54639
54801
|
allow_shared_email_and_phone_across_user_identities: { type: 'boolean' },
|
|
54640
54802
|
card_count_on_reservation_create: {
|
|
54641
54803
|
minimum: 0,
|
|
@@ -55896,6 +56058,11 @@ const openapi = {
|
|
|
55896
56058
|
properties: {
|
|
55897
56059
|
config: {
|
|
55898
56060
|
properties: {
|
|
56061
|
+
access_ends_minutes_after_reservation: {
|
|
56062
|
+
maximum: 1440,
|
|
56063
|
+
minimum: 0,
|
|
56064
|
+
type: 'integer',
|
|
56065
|
+
},
|
|
55899
56066
|
access_methods: {
|
|
55900
56067
|
items: {
|
|
55901
56068
|
enum: ['card', 'mobile_key', 'code'],
|
|
@@ -55904,6 +56071,11 @@ const openapi = {
|
|
|
55904
56071
|
minItems: 1,
|
|
55905
56072
|
type: 'array',
|
|
55906
56073
|
},
|
|
56074
|
+
access_starts_minutes_before_reservation: {
|
|
56075
|
+
maximum: 1440,
|
|
56076
|
+
minimum: 0,
|
|
56077
|
+
type: 'integer',
|
|
56078
|
+
},
|
|
55907
56079
|
allow_shared_email_and_phone_across_user_identities: { type: 'boolean' },
|
|
55908
56080
|
card_count_on_reservation_create: {
|
|
55909
56081
|
minimum: 0,
|
|
@@ -56197,6 +56369,11 @@ const openapi = {
|
|
|
56197
56369
|
properties: {
|
|
56198
56370
|
config: {
|
|
56199
56371
|
properties: {
|
|
56372
|
+
access_ends_minutes_after_reservation: {
|
|
56373
|
+
maximum: 1440,
|
|
56374
|
+
minimum: 0,
|
|
56375
|
+
type: 'integer',
|
|
56376
|
+
},
|
|
56200
56377
|
access_methods: {
|
|
56201
56378
|
items: {
|
|
56202
56379
|
enum: ['card', 'mobile_key', 'code'],
|
|
@@ -56205,6 +56382,11 @@ const openapi = {
|
|
|
56205
56382
|
minItems: 1,
|
|
56206
56383
|
type: 'array',
|
|
56207
56384
|
},
|
|
56385
|
+
access_starts_minutes_before_reservation: {
|
|
56386
|
+
maximum: 1440,
|
|
56387
|
+
minimum: 0,
|
|
56388
|
+
type: 'integer',
|
|
56389
|
+
},
|
|
56208
56390
|
allow_shared_email_and_phone_across_user_identities: { type: 'boolean' },
|
|
56209
56391
|
card_count_on_reservation_create: {
|
|
56210
56392
|
minimum: 0,
|