@seamapi/types 1.444.1 → 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
 
@@ -31928,6 +31931,10 @@ declare const _default: {
31928
31931
  nullable: boolean;
31929
31932
  type: string;
31930
31933
  };
31934
+ customer_key: {
31935
+ description: string;
31936
+ type: string;
31937
+ };
31931
31938
  device_selection_mode: {
31932
31939
  enum: string[];
31933
31940
  type: string;
@@ -54067,8 +54074,8 @@ declare const _default: {
54067
54074
  description: string;
54068
54075
  type: string;
54069
54076
  };
54070
- customer_id: {
54071
- format: string;
54077
+ customer_key: {
54078
+ description: string;
54072
54079
  type: string;
54073
54080
  };
54074
54081
  device_selection_mode: {
@@ -54461,26 +54468,11 @@ declare const _default: {
54461
54468
  description: string;
54462
54469
  operationId: string;
54463
54470
  parameters: ({
54464
- in: string;
54465
- name: string;
54466
- schema: {
54467
- items: {
54468
- type: string;
54469
- };
54470
- type: string;
54471
- description?: never;
54472
- additionalProperties?: never;
54473
- default?: never;
54474
- format?: never;
54475
- nullable?: never;
54476
- };
54477
- } | {
54478
54471
  in: string;
54479
54472
  name: string;
54480
54473
  schema: {
54481
54474
  description: string;
54482
54475
  type: string;
54483
- items?: never;
54484
54476
  additionalProperties?: never;
54485
54477
  default?: never;
54486
54478
  format?: never;
@@ -54497,7 +54489,6 @@ declare const _default: {
54497
54489
  };
54498
54490
  description: string;
54499
54491
  type: string;
54500
- items?: never;
54501
54492
  default?: never;
54502
54493
  format?: never;
54503
54494
  nullable?: never;
@@ -54510,7 +54501,6 @@ declare const _default: {
54510
54501
  description: string;
54511
54502
  format: string;
54512
54503
  type: string;
54513
- items?: never;
54514
54504
  additionalProperties?: never;
54515
54505
  nullable?: never;
54516
54506
  };
@@ -54521,7 +54511,6 @@ declare const _default: {
54521
54511
  description: string;
54522
54512
  nullable: boolean;
54523
54513
  type: string;
54524
- items?: never;
54525
54514
  additionalProperties?: never;
54526
54515
  default?: never;
54527
54516
  format?: never;
@@ -54616,12 +54605,6 @@ declare const _default: {
54616
54605
  description: string;
54617
54606
  type: string;
54618
54607
  };
54619
- customer_ids: {
54620
- items: {
54621
- type: string;
54622
- };
54623
- type: string;
54624
- };
54625
54608
  limit: {
54626
54609
  default: number;
54627
54610
  description: string;
@@ -98194,7 +98177,8 @@ interface Routes {
98194
98177
  custom_redirect_url?: string | undefined;
98195
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`. */
98196
98179
  custom_redirect_failure_url?: string | undefined;
98197
- 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;
98198
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. */
98199
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;
98200
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. */
@@ -98264,6 +98248,8 @@ interface Routes {
98264
98248
  authorized_at: string | null;
98265
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). */
98266
98250
  selected_provider: string | null;
98251
+ /** The customer key associated with this webview, if any. */
98252
+ customer_key?: string | undefined;
98267
98253
  };
98268
98254
  };
98269
98255
  };
@@ -98343,6 +98329,8 @@ interface Routes {
98343
98329
  authorized_at: string | null;
98344
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). */
98345
98331
  selected_provider: string | null;
98332
+ /** The customer key associated with this webview, if any. */
98333
+ customer_key?: string | undefined;
98346
98334
  };
98347
98335
  };
98348
98336
  };
@@ -98352,7 +98340,6 @@ interface Routes {
98352
98340
  queryParams: {};
98353
98341
  jsonBody: {};
98354
98342
  commonParams: {
98355
- customer_ids?: string[] | undefined;
98356
98343
  /** Your user ID for the user by which you want to filter Connect Webviews. */
98357
98344
  user_identifier_key?: string | undefined;
98358
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. */
@@ -98406,6 +98393,8 @@ interface Routes {
98406
98393
  authorized_at: string | null;
98407
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). */
98408
98395
  selected_provider: string | null;
98396
+ /** The customer key associated with this webview, if any. */
98397
+ customer_key?: string | undefined;
98409
98398
  }>;
98410
98399
  /** Information about the current page of results. */
98411
98400
  pagination: {
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.",