@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.
@@ -21420,7 +21420,8 @@ export interface Routes {
21420
21420
  custom_redirect_url?: string | undefined;
21421
21421
  /** 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`. */
21422
21422
  custom_redirect_failure_url?: string | undefined;
21423
- customer_id?: string | undefined;
21423
+ /** 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. */
21424
+ customer_key?: string | undefined;
21424
21425
  /** 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. */
21425
21426
  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;
21426
21427
  /** 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. */
@@ -21490,6 +21491,8 @@ export interface Routes {
21490
21491
  authorized_at: string | null;
21491
21492
  /** 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). */
21492
21493
  selected_provider: string | null;
21494
+ /** The customer key associated with this webview, if any. */
21495
+ customer_key?: string | undefined;
21493
21496
  };
21494
21497
  };
21495
21498
  };
@@ -21569,6 +21572,8 @@ export interface Routes {
21569
21572
  authorized_at: string | null;
21570
21573
  /** 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). */
21571
21574
  selected_provider: string | null;
21575
+ /** The customer key associated with this webview, if any. */
21576
+ customer_key?: string | undefined;
21572
21577
  };
21573
21578
  };
21574
21579
  };
@@ -21578,7 +21583,6 @@ export interface Routes {
21578
21583
  queryParams: {};
21579
21584
  jsonBody: {};
21580
21585
  commonParams: {
21581
- customer_ids?: string[] | undefined;
21582
21586
  /** Your user ID for the user by which you want to filter Connect Webviews. */
21583
21587
  user_identifier_key?: string | undefined;
21584
21588
  /** 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. */
@@ -21632,6 +21636,8 @@ export interface Routes {
21632
21636
  authorized_at: string | null;
21633
21637
  /** 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). */
21634
21638
  selected_provider: string | null;
21639
+ /** The customer key associated with this webview, if any. */
21640
+ customer_key?: string | undefined;
21635
21641
  }>;
21636
21642
  /** Information about the current page of results. */
21637
21643
  pagination: {
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@seamapi/types",
3
- "version": "1.444.1",
3
+ "version": "1.445.0",
4
4
  "description": "TypeScript types for the Seam API.",
5
5
  "type": "module",
6
6
  "main": "index.js",
@@ -117,6 +117,10 @@ export const connect_webview = z.object({
117
117
  .describe(
118
118
  '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).',
119
119
  ),
120
+ customer_key: z
121
+ .string()
122
+ .optional()
123
+ .describe('The customer key associated with this webview, if any.'),
120
124
  }).describe(`
121
125
  ---
122
126
  route_path: /connect_webviews
@@ -8633,6 +8633,11 @@ export default {
8633
8633
  nullable: true,
8634
8634
  type: 'string',
8635
8635
  },
8636
+ customer_key: {
8637
+ description:
8638
+ 'The customer key associated with this webview, if any.',
8639
+ type: 'string',
8640
+ },
8636
8641
  device_selection_mode: {
8637
8642
  enum: ['none', 'single', 'multiple'],
8638
8643
  type: 'string',
@@ -35999,7 +36004,11 @@ export default {
35999
36004
  'URL that you want to redirect the user to after the provider login is complete.',
36000
36005
  type: 'string',
36001
36006
  },
36002
- customer_id: { format: 'uuid', type: 'string' },
36007
+ customer_key: {
36008
+ description:
36009
+ '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.',
36010
+ type: 'string',
36011
+ },
36003
36012
  device_selection_mode: {
36004
36013
  enum: ['none', 'single', 'multiple'],
36005
36014
  type: 'string',
@@ -36287,11 +36296,6 @@ export default {
36287
36296
  'Returns a list of all [Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews).',
36288
36297
  operationId: 'connectWebviewsListGet',
36289
36298
  parameters: [
36290
- {
36291
- in: 'query',
36292
- name: 'customer_ids',
36293
- schema: { items: { type: 'string' }, type: 'array' },
36294
- },
36295
36299
  {
36296
36300
  in: 'query',
36297
36301
  name: 'user_identifier_key',
@@ -36389,7 +36393,6 @@ export default {
36389
36393
  '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.',
36390
36394
  type: 'object',
36391
36395
  },
36392
- customer_ids: { items: { type: 'string' }, type: 'array' },
36393
36396
  limit: {
36394
36397
  default: 500,
36395
36398
  description:
@@ -24340,7 +24340,8 @@ export interface Routes {
24340
24340
  custom_redirect_url?: string | undefined
24341
24341
  /** 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`. */
24342
24342
  custom_redirect_failure_url?: string | undefined
24343
- customer_id?: string | undefined
24343
+ /** 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. */
24344
+ customer_key?: string | undefined
24344
24345
  /** 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. */
24345
24346
  accepted_providers?:
24346
24347
  | Array<
@@ -24476,6 +24477,8 @@ export interface Routes {
24476
24477
  authorized_at: string | null
24477
24478
  /** 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). */
24478
24479
  selected_provider: string | null
24480
+ /** The customer key associated with this webview, if any. */
24481
+ customer_key?: string | undefined
24479
24482
  }
24480
24483
  }
24481
24484
  }
@@ -24557,6 +24560,8 @@ export interface Routes {
24557
24560
  authorized_at: string | null
24558
24561
  /** 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). */
24559
24562
  selected_provider: string | null
24563
+ /** The customer key associated with this webview, if any. */
24564
+ customer_key?: string | undefined
24560
24565
  }
24561
24566
  }
24562
24567
  }
@@ -24566,7 +24571,6 @@ export interface Routes {
24566
24571
  queryParams: {}
24567
24572
  jsonBody: {}
24568
24573
  commonParams: {
24569
- customer_ids?: string[] | undefined
24570
24574
  /** Your user ID for the user by which you want to filter Connect Webviews. */
24571
24575
  user_identifier_key?: string | undefined
24572
24576
  /** 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. */
@@ -24622,6 +24626,8 @@ export interface Routes {
24622
24626
  authorized_at: string | null
24623
24627
  /** 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). */
24624
24628
  selected_provider: string | null
24629
+ /** The customer key associated with this webview, if any. */
24630
+ customer_key?: string | undefined
24625
24631
  }>
24626
24632
  /** Information about the current page of results. */
24627
24633
  pagination: {