@seamapi/types 1.444.0 → 1.445.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.
@@ -15988,6 +15988,7 @@ declare const connect_webview: z.ZodObject<{
15988
15988
  wait_for_device_creation: z.ZodBoolean;
15989
15989
  authorized_at: z.ZodNullable<z.ZodString>;
15990
15990
  selected_provider: z.ZodNullable<z.ZodString>;
15991
+ customer_key: z.ZodOptional<z.ZodString>;
15991
15992
  }, "strip", z.ZodTypeAny, {
15992
15993
  status: "pending" | "failed" | "authorized";
15993
15994
  workspace_id: string;
@@ -16009,6 +16010,7 @@ declare const connect_webview: z.ZodObject<{
16009
16010
  wait_for_device_creation: boolean;
16010
16011
  authorized_at: string | null;
16011
16012
  selected_provider: string | null;
16013
+ customer_key?: string | undefined;
16012
16014
  }, {
16013
16015
  status: "pending" | "failed" | "authorized";
16014
16016
  workspace_id: string;
@@ -16030,6 +16032,7 @@ declare const connect_webview: z.ZodObject<{
16030
16032
  wait_for_device_creation: boolean;
16031
16033
  authorized_at: string | null;
16032
16034
  selected_provider: string | null;
16035
+ customer_key?: string | undefined;
16033
16036
  }>;
16034
16037
  type ConnectWebview = z.infer<typeof connect_webview>;
16035
16038
 
@@ -27604,6 +27607,77 @@ declare const space: z.ZodObject<{
27604
27607
  }>;
27605
27608
  type Space = z.infer<typeof space>;
27606
27609
 
27610
+ declare const climate_preset: z.ZodObject<{
27611
+ climate_preset_key: z.ZodString;
27612
+ can_edit: z.ZodBoolean;
27613
+ can_delete: z.ZodBoolean;
27614
+ can_program: z.ZodBoolean;
27615
+ name: z.ZodOptional<z.ZodDefault<z.ZodNullable<z.ZodString>>>;
27616
+ display_name: z.ZodString;
27617
+ climate_preset_mode: z.ZodOptional<z.ZodEnum<["home", "away", "wake", "sleep", "occupied", "unoccupied"]>>;
27618
+ fan_mode_setting: z.ZodOptional<z.ZodEnum<["auto", "on", "circulate"]>>;
27619
+ hvac_mode_setting: z.ZodOptional<z.ZodEnum<["off", "heat", "cool", "heat_cool"]>>;
27620
+ cooling_set_point_celsius: z.ZodOptional<z.ZodNumber>;
27621
+ heating_set_point_celsius: z.ZodOptional<z.ZodNumber>;
27622
+ cooling_set_point_fahrenheit: z.ZodOptional<z.ZodNumber>;
27623
+ heating_set_point_fahrenheit: z.ZodOptional<z.ZodNumber>;
27624
+ manual_override_allowed: z.ZodBoolean;
27625
+ ecobee_metadata: z.ZodOptional<z.ZodObject<{
27626
+ climate_ref: z.ZodString;
27627
+ is_optimized: z.ZodBoolean;
27628
+ owner: z.ZodEnum<["user", "system"]>;
27629
+ }, "strip", z.ZodTypeAny, {
27630
+ climate_ref: string;
27631
+ is_optimized: boolean;
27632
+ owner: "user" | "system";
27633
+ }, {
27634
+ climate_ref: string;
27635
+ is_optimized: boolean;
27636
+ owner: "user" | "system";
27637
+ }>>;
27638
+ }, "strip", z.ZodTypeAny, {
27639
+ climate_preset_key: string;
27640
+ can_edit: boolean;
27641
+ can_delete: boolean;
27642
+ can_program: boolean;
27643
+ display_name: string;
27644
+ manual_override_allowed: boolean;
27645
+ name?: string | null | undefined;
27646
+ climate_preset_mode?: "home" | "away" | "wake" | "sleep" | "occupied" | "unoccupied" | undefined;
27647
+ fan_mode_setting?: "auto" | "on" | "circulate" | undefined;
27648
+ hvac_mode_setting?: "off" | "heat" | "cool" | "heat_cool" | undefined;
27649
+ cooling_set_point_celsius?: number | undefined;
27650
+ heating_set_point_celsius?: number | undefined;
27651
+ cooling_set_point_fahrenheit?: number | undefined;
27652
+ heating_set_point_fahrenheit?: number | undefined;
27653
+ ecobee_metadata?: {
27654
+ climate_ref: string;
27655
+ is_optimized: boolean;
27656
+ owner: "user" | "system";
27657
+ } | undefined;
27658
+ }, {
27659
+ climate_preset_key: string;
27660
+ can_edit: boolean;
27661
+ can_delete: boolean;
27662
+ can_program: boolean;
27663
+ display_name: string;
27664
+ manual_override_allowed: boolean;
27665
+ name?: string | null | undefined;
27666
+ climate_preset_mode?: "home" | "away" | "wake" | "sleep" | "occupied" | "unoccupied" | undefined;
27667
+ fan_mode_setting?: "auto" | "on" | "circulate" | undefined;
27668
+ hvac_mode_setting?: "off" | "heat" | "cool" | "heat_cool" | undefined;
27669
+ cooling_set_point_celsius?: number | undefined;
27670
+ heating_set_point_celsius?: number | undefined;
27671
+ cooling_set_point_fahrenheit?: number | undefined;
27672
+ heating_set_point_fahrenheit?: number | undefined;
27673
+ ecobee_metadata?: {
27674
+ climate_ref: string;
27675
+ is_optimized: boolean;
27676
+ owner: "user" | "system";
27677
+ } | undefined;
27678
+ }>;
27679
+ type ClimatePreset = z.infer<typeof climate_preset>;
27680
+
27607
27681
  declare const thermostat_daily_program: z.ZodObject<{
27608
27682
  thermostat_daily_program_id: z.ZodString;
27609
27683
  device_id: z.ZodString;
@@ -27669,6 +27743,8 @@ declare const thermostat_weekly_program: z.ZodObject<{
27669
27743
  saturday_program_id: string | null;
27670
27744
  sunday_program_id: string | null;
27671
27745
  }>;
27746
+ type ThermostatDailyProgram = z.infer<typeof thermostat_daily_program>;
27747
+ type ThermostatWeeklyProgram = z.infer<typeof thermostat_weekly_program>;
27672
27748
 
27673
27749
  declare const thermostat_schedule: z.ZodObject<{
27674
27750
  thermostat_schedule_id: z.ZodString;
@@ -31855,6 +31931,10 @@ declare const _default: {
31855
31931
  nullable: boolean;
31856
31932
  type: string;
31857
31933
  };
31934
+ customer_key: {
31935
+ description: string;
31936
+ type: string;
31937
+ };
31858
31938
  device_selection_mode: {
31859
31939
  enum: string[];
31860
31940
  type: string;
@@ -53994,8 +54074,8 @@ declare const _default: {
53994
54074
  description: string;
53995
54075
  type: string;
53996
54076
  };
53997
- customer_id: {
53998
- format: string;
54077
+ customer_key: {
54078
+ description: string;
53999
54079
  type: string;
54000
54080
  };
54001
54081
  device_selection_mode: {
@@ -54388,26 +54468,11 @@ declare const _default: {
54388
54468
  description: string;
54389
54469
  operationId: string;
54390
54470
  parameters: ({
54391
- in: string;
54392
- name: string;
54393
- schema: {
54394
- items: {
54395
- type: string;
54396
- };
54397
- type: string;
54398
- description?: never;
54399
- additionalProperties?: never;
54400
- default?: never;
54401
- format?: never;
54402
- nullable?: never;
54403
- };
54404
- } | {
54405
54471
  in: string;
54406
54472
  name: string;
54407
54473
  schema: {
54408
54474
  description: string;
54409
54475
  type: string;
54410
- items?: never;
54411
54476
  additionalProperties?: never;
54412
54477
  default?: never;
54413
54478
  format?: never;
@@ -54424,7 +54489,6 @@ declare const _default: {
54424
54489
  };
54425
54490
  description: string;
54426
54491
  type: string;
54427
- items?: never;
54428
54492
  default?: never;
54429
54493
  format?: never;
54430
54494
  nullable?: never;
@@ -54437,7 +54501,6 @@ declare const _default: {
54437
54501
  description: string;
54438
54502
  format: string;
54439
54503
  type: string;
54440
- items?: never;
54441
54504
  additionalProperties?: never;
54442
54505
  nullable?: never;
54443
54506
  };
@@ -54448,7 +54511,6 @@ declare const _default: {
54448
54511
  description: string;
54449
54512
  nullable: boolean;
54450
54513
  type: string;
54451
- items?: never;
54452
54514
  additionalProperties?: never;
54453
54515
  default?: never;
54454
54516
  format?: never;
@@ -54543,12 +54605,6 @@ declare const _default: {
54543
54605
  description: string;
54544
54606
  type: string;
54545
54607
  };
54546
- customer_ids: {
54547
- items: {
54548
- type: string;
54549
- };
54550
- type: string;
54551
- };
54552
54608
  limit: {
54553
54609
  default: number;
54554
54610
  description: string;
@@ -98121,7 +98177,8 @@ interface Routes {
98121
98177
  custom_redirect_url?: string | undefined;
98122
98178
  /** Alternative URL that you want to redirect the user to on an error. If you do not set this parameter, the Connect Webview falls back to the `custom_redirect_url`. */
98123
98179
  custom_redirect_failure_url?: string | undefined;
98124
- customer_id?: string | undefined;
98180
+ /** Optional unique string key that can be used to identify the customer. If provided, the customer will be created or retrieved based on this key. */
98181
+ customer_key?: string | undefined;
98125
98182
  /** 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/latest/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/latest/api/devices/list_device_providers) with no filters. */
98126
98183
  accepted_providers?: Array<'dormakaba_community' | 'legic_connect' | 'akuvox' | 'august' | 'avigilon_alta' | 'brivo' | 'butterflymx' | 'schlage' | 'smartthings' | 'yale' | 'genie' | 'doorking' | 'salto' | 'salto_ks' | 'lockly' | 'ttlock' | 'linear' | 'noiseaware' | 'nuki' | 'seam_relay_admin' | 'igloo' | 'kwikset' | 'minut' | 'my_2n' | 'controlbyweb' | 'nest' | 'igloohome' | 'ecobee' | 'hubitat' | 'four_suites' | 'dormakaba_oracode' | 'pti' | 'wyze' | 'seam_passport' | 'visionline' | 'assa_abloy_credential_service' | 'seam_bridge' | 'tedee' | 'honeywell_resideo' | 'latch' | 'akiles' | 'assa_abloy_vostio' | 'assa_abloy_vostio_credential_service' | 'tado' | 'salto_space' | 'sensi' | 'kwikset2' | 'yale_access' | 'hid_cm' | 'google_nest'> | undefined;
98127
98184
  /** 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/latest/api/devices/list_device_providers) with the desired `provider_category` filter. */
@@ -98191,6 +98248,8 @@ interface Routes {
98191
98248
  authorized_at: string | null;
98192
98249
  /** Selected provider of the Connect Webview, one of the [provider keys](https://docs.seam.co/latest/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-brands-to-display-in-your-connect-webviews). */
98193
98250
  selected_provider: string | null;
98251
+ /** The customer key associated with this webview, if any. */
98252
+ customer_key?: string | undefined;
98194
98253
  };
98195
98254
  };
98196
98255
  };
@@ -98270,6 +98329,8 @@ interface Routes {
98270
98329
  authorized_at: string | null;
98271
98330
  /** Selected provider of the Connect Webview, one of the [provider keys](https://docs.seam.co/latest/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-brands-to-display-in-your-connect-webviews). */
98272
98331
  selected_provider: string | null;
98332
+ /** The customer key associated with this webview, if any. */
98333
+ customer_key?: string | undefined;
98273
98334
  };
98274
98335
  };
98275
98336
  };
@@ -98279,7 +98340,6 @@ interface Routes {
98279
98340
  queryParams: {};
98280
98341
  jsonBody: {};
98281
98342
  commonParams: {
98282
- customer_ids?: string[] | undefined;
98283
98343
  /** Your user ID for the user by which you want to filter Connect Webviews. */
98284
98344
  user_identifier_key?: string | undefined;
98285
98345
  /** Custom metadata pairs by which you want to [filter Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews/filtering-connect-webviews-by-custom-metadata). Returns Connect Webviews with `custom_metadata` that contains all of the provided key:value pairs. */
@@ -98333,6 +98393,8 @@ interface Routes {
98333
98393
  authorized_at: string | null;
98334
98394
  /** Selected provider of the Connect Webview, one of the [provider keys](https://docs.seam.co/latest/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-brands-to-display-in-your-connect-webviews). */
98335
98395
  selected_provider: string | null;
98396
+ /** The customer key associated with this webview, if any. */
98397
+ customer_key?: string | undefined;
98336
98398
  }>;
98337
98399
  /** Information about the current page of results. */
98338
98400
  pagination: {
@@ -145382,4 +145444,4 @@ type RouteRequestParams<Path extends keyof Routes> = Routes[Path]['queryParams']
145382
145444
 
145383
145445
  declare const routes: {};
145384
145446
 
145385
- export { type AccessCode, type AccessCodeError, type AccessCodeWarning, type AccessGrant, type AccessMethod, type AcsAccessGroup, type AcsCredential, type AcsEncoder, type AcsEntrance, type AcsSystem, type AcsUser, type ActionAttempt, type Bridge, type BuildingBlockType, type Bundle, type ClientSession, type ConnectWebview, type ConnectedAccount, type ConnectedAccountError, type ConnectedAccountWarning, type CustomMetadata, type Device, type DeviceError, type DeviceProvider, type DeviceWarning, type InstantKey, type MagicLink, type NoiseThreshold, type Pagination, type RouteRequestBody, type RouteRequestParams, type RouteResponse, type Routes, type SeamEvent, type SeamEventType, type Space, type ThermostatSchedule, type UnmanagedAccessCode, type UnmanagedDevice, type UserIdentity, type Webhook, type Workspace, _default as openapi, routes, schemas };
145447
+ export { type AccessCode, type AccessCodeError, type AccessCodeWarning, type AccessGrant, type AccessMethod, type AcsAccessGroup, type AcsCredential, type AcsEncoder, type AcsEntrance, type AcsSystem, type AcsUser, type ActionAttempt, type Bridge, type BuildingBlockType, type Bundle, type ClientSession, type ClimatePreset, type ConnectWebview, type ConnectedAccount, type ConnectedAccountError, type ConnectedAccountWarning, type CustomMetadata, type Device, type DeviceError, type DeviceProvider, type DeviceWarning, type InstantKey, type MagicLink, type NoiseThreshold, type Pagination, type RouteRequestBody, type RouteRequestParams, type RouteResponse, type Routes, type SeamEvent, type SeamEventType, type Space, type ThermostatDailyProgram, type ThermostatSchedule, type ThermostatWeeklyProgram, type UnmanagedAccessCode, type UnmanagedDevice, type UserIdentity, type Webhook, type Workspace, _default as openapi, routes, schemas };
package/dist/index.cjs CHANGED
@@ -4191,7 +4191,8 @@ var connect_webview = zod.z.object({
4191
4191
  ),
4192
4192
  selected_provider: zod.z.string().nullable().describe(
4193
4193
  "Selected provider of the Connect Webview, one of the [provider keys](https://docs.seam.co/latest/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-brands-to-display-in-your-connect-webviews)."
4194
- )
4194
+ ),
4195
+ customer_key: zod.z.string().optional().describe("The customer key associated with this webview, if any.")
4195
4196
  }).describe(`
4196
4197
  ---
4197
4198
  route_path: /connect_webviews
@@ -13157,6 +13158,10 @@ var openapi_default = {
13157
13158
  nullable: true,
13158
13159
  type: "string"
13159
13160
  },
13161
+ customer_key: {
13162
+ description: "The customer key associated with this webview, if any.",
13163
+ type: "string"
13164
+ },
13160
13165
  device_selection_mode: {
13161
13166
  enum: ["none", "single", "multiple"],
13162
13167
  type: "string"
@@ -38270,7 +38275,10 @@ var openapi_default = {
38270
38275
  description: "URL that you want to redirect the user to after the provider login is complete.",
38271
38276
  type: "string"
38272
38277
  },
38273
- customer_id: { format: "uuid", type: "string" },
38278
+ customer_key: {
38279
+ description: "Optional unique string key that can be used to identify the customer. If provided, the customer will be created or retrieved based on this key.",
38280
+ type: "string"
38281
+ },
38274
38282
  device_selection_mode: {
38275
38283
  enum: ["none", "single", "multiple"],
38276
38284
  type: "string",
@@ -38548,11 +38556,6 @@ var openapi_default = {
38548
38556
  description: "Returns a list of all [Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews).",
38549
38557
  operationId: "connectWebviewsListGet",
38550
38558
  parameters: [
38551
- {
38552
- in: "query",
38553
- name: "customer_ids",
38554
- schema: { items: { type: "string" }, type: "array" }
38555
- },
38556
38559
  {
38557
38560
  in: "query",
38558
38561
  name: "user_identifier_key",
@@ -38645,7 +38648,6 @@ var openapi_default = {
38645
38648
  description: "Custom metadata pairs by which you want to [filter Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews/filtering-connect-webviews-by-custom-metadata). Returns Connect Webviews with `custom_metadata` that contains all of the provided key:value pairs.",
38646
38649
  type: "object"
38647
38650
  },
38648
- customer_ids: { items: { type: "string" }, type: "array" },
38649
38651
  limit: {
38650
38652
  default: 500,
38651
38653
  description: "Maximum number of records to return per page.",