@seamapi/types 1.745.0 → 1.747.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.
@@ -35924,6 +35924,10 @@ export type Routes = {
35924
35924
  activation_reason: 'motion_detected';
35925
35925
  /** Sub-type of motion detected, if available. */
35926
35926
  motion_sub_type?: ('human' | 'vehicle' | 'package' | 'other') | undefined;
35927
+ /** URL to a thumbnail image captured at the time of activation. */
35928
+ image_url?: string | undefined;
35929
+ /** URL to a short video clip captured at the time of activation. */
35930
+ video_url?: string | undefined;
35927
35931
  } | {
35928
35932
  /** ID of the event. */
35929
35933
  event_id: string;
@@ -35948,6 +35952,10 @@ export type Routes = {
35948
35952
  [x: string]: string | boolean;
35949
35953
  } | undefined;
35950
35954
  event_type: 'device.doorbell_rang';
35955
+ /** URL to a thumbnail image captured at the time the doorbell was pressed. */
35956
+ image_url?: string | undefined;
35957
+ /** URL to a short video clip captured at the time the doorbell was pressed. */
35958
+ video_url?: string | undefined;
35951
35959
  } | {
35952
35960
  /** ID of the event. */
35953
35961
  event_id: string;
@@ -38744,6 +38752,10 @@ export type Routes = {
38744
38752
  activation_reason: 'motion_detected';
38745
38753
  /** Sub-type of motion detected, if available. */
38746
38754
  motion_sub_type?: ('human' | 'vehicle' | 'package' | 'other') | undefined;
38755
+ /** URL to a thumbnail image captured at the time of activation. */
38756
+ image_url?: string | undefined;
38757
+ /** URL to a short video clip captured at the time of activation. */
38758
+ video_url?: string | undefined;
38747
38759
  } | {
38748
38760
  /** ID of the event. */
38749
38761
  event_id: string;
@@ -38768,6 +38780,10 @@ export type Routes = {
38768
38780
  [x: string]: string | boolean;
38769
38781
  } | undefined;
38770
38782
  event_type: 'device.doorbell_rang';
38783
+ /** URL to a thumbnail image captured at the time the doorbell was pressed. */
38784
+ image_url?: string | undefined;
38785
+ /** URL to a short video clip captured at the time the doorbell was pressed. */
38786
+ video_url?: string | undefined;
38771
38787
  } | {
38772
38788
  /** ID of the event. */
38773
38789
  event_id: string;
@@ -58723,8 +58739,6 @@ export type Routes = {
58723
58739
  method: 'PATCH' | 'POST';
58724
58740
  queryParams: {};
58725
58741
  jsonBody: {
58726
- /** Key of the customer. */
58727
- customer_key: string;
58728
58742
  /** Access automation rules configuration. */
58729
58743
  access_rules?: {
58730
58744
  reservation_created?: {
@@ -61568,6 +61582,10 @@ export type Routes = {
61568
61582
  activation_reason: 'motion_detected';
61569
61583
  /** Sub-type of motion detected, if available. */
61570
61584
  motion_sub_type?: ('human' | 'vehicle' | 'package' | 'other') | undefined;
61585
+ /** URL to a thumbnail image captured at the time of activation. */
61586
+ image_url?: string | undefined;
61587
+ /** URL to a short video clip captured at the time of activation. */
61588
+ video_url?: string | undefined;
61571
61589
  } | {
61572
61590
  /** ID of the event. */
61573
61591
  event_id: string;
@@ -61592,6 +61610,10 @@ export type Routes = {
61592
61610
  [x: string]: string | boolean;
61593
61611
  } | undefined;
61594
61612
  event_type: 'device.doorbell_rang';
61613
+ /** URL to a thumbnail image captured at the time the doorbell was pressed. */
61614
+ image_url?: string | undefined;
61615
+ /** URL to a short video clip captured at the time the doorbell was pressed. */
61616
+ video_url?: string | undefined;
61595
61617
  } | {
61596
61618
  /** ID of the event. */
61597
61619
  event_id: string;
@@ -92474,6 +92496,10 @@ export type Routes = {
92474
92496
  activation_reason: 'motion_detected';
92475
92497
  /** Sub-type of motion detected, if available. */
92476
92498
  motion_sub_type?: ('human' | 'vehicle' | 'package' | 'other') | undefined;
92499
+ /** URL to a thumbnail image captured at the time of activation. */
92500
+ image_url?: string | undefined;
92501
+ /** URL to a short video clip captured at the time of activation. */
92502
+ video_url?: string | undefined;
92477
92503
  } | {
92478
92504
  /** ID of the event. */
92479
92505
  event_id: string;
@@ -92498,6 +92524,10 @@ export type Routes = {
92498
92524
  [x: string]: string | boolean;
92499
92525
  } | undefined;
92500
92526
  event_type: 'device.doorbell_rang';
92527
+ /** URL to a thumbnail image captured at the time the doorbell was pressed. */
92528
+ image_url?: string | undefined;
92529
+ /** URL to a short video clip captured at the time the doorbell was pressed. */
92530
+ video_url?: string | undefined;
92501
92531
  } | {
92502
92532
  /** ID of the event. */
92503
92533
  event_id: string;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@seamapi/types",
3
- "version": "1.745.0",
3
+ "version": "1.747.0",
4
4
  "description": "TypeScript types for the Seam API.",
5
5
  "type": "module",
6
6
  "main": "index.js",
@@ -715,6 +715,16 @@ export const camera_activated_event = device_event.extend({
715
715
  .enum(['human', 'vehicle', 'package', 'other'])
716
716
  .optional()
717
717
  .describe('Sub-type of motion detected, if available.'),
718
+ image_url: z
719
+ .string()
720
+ .url()
721
+ .optional()
722
+ .describe('URL to a thumbnail image captured at the time of activation.'),
723
+ video_url: z
724
+ .string()
725
+ .url()
726
+ .optional()
727
+ .describe('URL to a short video clip captured at the time of activation.'),
718
728
  }).describe(`
719
729
  ---
720
730
  route_path: /devices
@@ -726,6 +736,20 @@ export type CameraActivatedEvent = z.infer<typeof camera_activated_event>
726
736
 
727
737
  export const device_doorbell_rang_event = device_event.extend({
728
738
  event_type: z.literal('device.doorbell_rang'),
739
+ image_url: z
740
+ .string()
741
+ .url()
742
+ .optional()
743
+ .describe(
744
+ 'URL to a thumbnail image captured at the time the doorbell was pressed.',
745
+ ),
746
+ video_url: z
747
+ .string()
748
+ .url()
749
+ .optional()
750
+ .describe(
751
+ 'URL to a short video clip captured at the time the doorbell was pressed.',
752
+ ),
729
753
  }).describe(`
730
754
  ---
731
755
  route_path: /devices
@@ -23162,6 +23162,12 @@ export default {
23162
23162
  type: 'string',
23163
23163
  },
23164
23164
  event_type: { enum: ['camera.activated'], type: 'string' },
23165
+ image_url: {
23166
+ description:
23167
+ 'URL to a thumbnail image captured at the time of activation.',
23168
+ format: 'uri',
23169
+ type: 'string',
23170
+ },
23165
23171
  motion_sub_type: {
23166
23172
  description: 'Sub-type of motion detected, if available.',
23167
23173
  enum: ['human', 'vehicle', 'package', 'other'],
@@ -23172,6 +23178,12 @@ export default {
23172
23178
  format: 'date-time',
23173
23179
  type: 'string',
23174
23180
  },
23181
+ video_url: {
23182
+ description:
23183
+ 'URL to a short video clip captured at the time of activation.',
23184
+ format: 'uri',
23185
+ type: 'string',
23186
+ },
23175
23187
  workspace_id: {
23176
23188
  description:
23177
23189
  'ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) associated with the event.',
@@ -23239,11 +23251,23 @@ export default {
23239
23251
  type: 'string',
23240
23252
  },
23241
23253
  event_type: { enum: ['device.doorbell_rang'], type: 'string' },
23254
+ image_url: {
23255
+ description:
23256
+ 'URL to a thumbnail image captured at the time the doorbell was pressed.',
23257
+ format: 'uri',
23258
+ type: 'string',
23259
+ },
23242
23260
  occurred_at: {
23243
23261
  description: 'Date and time at which the event occurred.',
23244
23262
  format: 'date-time',
23245
23263
  type: 'string',
23246
23264
  },
23265
+ video_url: {
23266
+ description:
23267
+ 'URL to a short video clip captured at the time the doorbell was pressed.',
23268
+ format: 'uri',
23269
+ type: 'string',
23270
+ },
23247
23271
  workspace_id: {
23248
23272
  description:
23249
23273
  'ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) associated with the event.',
@@ -61625,7 +61649,7 @@ export default {
61625
61649
  '/seam/customer/v1/automations/update': {
61626
61650
  patch: {
61627
61651
  description:
61628
- 'Updates the automation configuration for a customer portal workspace.\nSupports both console session and customer client session authentication.',
61652
+ 'Updates the automation configuration for a customer portal workspace.',
61629
61653
  operationId: 'seamCustomerV1AutomationsUpdatePatch',
61630
61654
  requestBody: {
61631
61655
  content: {
@@ -61894,11 +61918,7 @@ export default {
61894
61918
  400: { description: 'Bad Request' },
61895
61919
  401: { description: 'Unauthorized' },
61896
61920
  },
61897
- security: [
61898
- { console_session_with_workspace: [] },
61899
- { api_key: [] },
61900
- { client_session_with_customer: [] },
61901
- ],
61921
+ security: [{ console_session_with_workspace: [] }, { api_key: [] }],
61902
61922
  summary: '/seam/customer/v1/automations/update',
61903
61923
  tags: [],
61904
61924
  'x-fern-sdk-group-name': ['seam', 'customer', 'v1', 'automations'],
@@ -61909,7 +61929,7 @@ export default {
61909
61929
  },
61910
61930
  post: {
61911
61931
  description:
61912
- 'Updates the automation configuration for a customer portal workspace.\nSupports both console session and customer client session authentication.',
61932
+ 'Updates the automation configuration for a customer portal workspace.',
61913
61933
  operationId: 'seamCustomerV1AutomationsUpdatePost',
61914
61934
  requestBody: {
61915
61935
  content: {
@@ -62178,11 +62198,7 @@ export default {
62178
62198
  400: { description: 'Bad Request' },
62179
62199
  401: { description: 'Unauthorized' },
62180
62200
  },
62181
- security: [
62182
- { console_session_with_workspace: [] },
62183
- { api_key: [] },
62184
- { client_session_with_customer: [] },
62185
- ],
62201
+ security: [{ console_session_with_workspace: [] }, { api_key: [] }],
62186
62202
  summary: '/seam/customer/v1/automations/update',
62187
62203
  tags: [],
62188
62204
  'x-fern-sdk-group-name': ['seam', 'customer', 'v1', 'automations'],
@@ -64041,12 +64057,7 @@ export default {
64041
64057
  },
64042
64058
  type: 'object',
64043
64059
  },
64044
- customer_key: {
64045
- description: 'Key of the customer.',
64046
- type: 'string',
64047
- },
64048
64060
  },
64049
- required: ['customer_key'],
64050
64061
  type: 'object',
64051
64062
  },
64052
64063
  },
@@ -64068,11 +64079,7 @@ export default {
64068
64079
  400: { description: 'Bad Request' },
64069
64080
  401: { description: 'Unauthorized' },
64070
64081
  },
64071
- security: [
64072
- { pat_with_workspace: [] },
64073
- { console_session_with_workspace: [] },
64074
- { api_key: [] },
64075
- ],
64082
+ security: [{ client_session_with_customer: [] }],
64076
64083
  summary: '/seam/customer/v1/customers/automations/update',
64077
64084
  tags: [],
64078
64085
  'x-fern-sdk-group-name': [
@@ -64335,12 +64342,7 @@ export default {
64335
64342
  },
64336
64343
  type: 'object',
64337
64344
  },
64338
- customer_key: {
64339
- description: 'Key of the customer.',
64340
- type: 'string',
64341
- },
64342
64345
  },
64343
- required: ['customer_key'],
64344
64346
  type: 'object',
64345
64347
  },
64346
64348
  },
@@ -64362,11 +64364,7 @@ export default {
64362
64364
  400: { description: 'Bad Request' },
64363
64365
  401: { description: 'Unauthorized' },
64364
64366
  },
64365
- security: [
64366
- { pat_with_workspace: [] },
64367
- { console_session_with_workspace: [] },
64368
- { api_key: [] },
64369
- ],
64367
+ security: [{ client_session_with_customer: [] }],
64370
64368
  summary: '/seam/customer/v1/customers/automations/update',
64371
64369
  tags: [],
64372
64370
  'x-fern-sdk-group-name': [
@@ -42531,6 +42531,10 @@ export type Routes = {
42531
42531
  motion_sub_type?:
42532
42532
  | ('human' | 'vehicle' | 'package' | 'other')
42533
42533
  | undefined
42534
+ /** URL to a thumbnail image captured at the time of activation. */
42535
+ image_url?: string | undefined
42536
+ /** URL to a short video clip captured at the time of activation. */
42537
+ video_url?: string | undefined
42534
42538
  }
42535
42539
  | {
42536
42540
  /** ID of the event. */
@@ -42560,6 +42564,10 @@ export type Routes = {
42560
42564
  }
42561
42565
  | undefined
42562
42566
  event_type: 'device.doorbell_rang'
42567
+ /** URL to a thumbnail image captured at the time the doorbell was pressed. */
42568
+ image_url?: string | undefined
42569
+ /** URL to a short video clip captured at the time the doorbell was pressed. */
42570
+ video_url?: string | undefined
42563
42571
  }
42564
42572
  | {
42565
42573
  /** ID of the event. */
@@ -45912,6 +45920,10 @@ export type Routes = {
45912
45920
  motion_sub_type?:
45913
45921
  | ('human' | 'vehicle' | 'package' | 'other')
45914
45922
  | undefined
45923
+ /** URL to a thumbnail image captured at the time of activation. */
45924
+ image_url?: string | undefined
45925
+ /** URL to a short video clip captured at the time of activation. */
45926
+ video_url?: string | undefined
45915
45927
  }
45916
45928
  | {
45917
45929
  /** ID of the event. */
@@ -45941,6 +45953,10 @@ export type Routes = {
45941
45953
  }
45942
45954
  | undefined
45943
45955
  event_type: 'device.doorbell_rang'
45956
+ /** URL to a thumbnail image captured at the time the doorbell was pressed. */
45957
+ image_url?: string | undefined
45958
+ /** URL to a short video clip captured at the time the doorbell was pressed. */
45959
+ video_url?: string | undefined
45944
45960
  }
45945
45961
  | {
45946
45962
  /** ID of the event. */
@@ -69725,8 +69741,6 @@ export type Routes = {
69725
69741
  method: 'PATCH' | 'POST'
69726
69742
  queryParams: {}
69727
69743
  jsonBody: {
69728
- /** Key of the customer. */
69729
- customer_key: string
69730
69744
  /** Access automation rules configuration. */
69731
69745
  access_rules?:
69732
69746
  | {
@@ -73152,6 +73166,10 @@ export type Routes = {
73152
73166
  motion_sub_type?:
73153
73167
  | ('human' | 'vehicle' | 'package' | 'other')
73154
73168
  | undefined
73169
+ /** URL to a thumbnail image captured at the time of activation. */
73170
+ image_url?: string | undefined
73171
+ /** URL to a short video clip captured at the time of activation. */
73172
+ video_url?: string | undefined
73155
73173
  }
73156
73174
  | {
73157
73175
  /** ID of the event. */
@@ -73181,6 +73199,10 @@ export type Routes = {
73181
73199
  }
73182
73200
  | undefined
73183
73201
  event_type: 'device.doorbell_rang'
73202
+ /** URL to a thumbnail image captured at the time the doorbell was pressed. */
73203
+ image_url?: string | undefined
73204
+ /** URL to a short video clip captured at the time the doorbell was pressed. */
73205
+ video_url?: string | undefined
73184
73206
  }
73185
73207
  | {
73186
73208
  /** ID of the event. */
@@ -109588,6 +109610,10 @@ export type Routes = {
109588
109610
  motion_sub_type?:
109589
109611
  | ('human' | 'vehicle' | 'package' | 'other')
109590
109612
  | undefined
109613
+ /** URL to a thumbnail image captured at the time of activation. */
109614
+ image_url?: string | undefined
109615
+ /** URL to a short video clip captured at the time of activation. */
109616
+ video_url?: string | undefined
109591
109617
  }
109592
109618
  | {
109593
109619
  /** ID of the event. */
@@ -109617,6 +109643,10 @@ export type Routes = {
109617
109643
  }
109618
109644
  | undefined
109619
109645
  event_type: 'device.doorbell_rang'
109646
+ /** URL to a thumbnail image captured at the time the doorbell was pressed. */
109647
+ image_url?: string | undefined
109648
+ /** URL to a short video clip captured at the time the doorbell was pressed. */
109649
+ video_url?: string | undefined
109620
109650
  }
109621
109651
  | {
109622
109652
  /** ID of the event. */