@seamapi/types 1.590.0 → 1.592.0

package/lib/seam/connect/route-types.d.ts

@@ -30612,7 +30612,7 @@ export type Routes = {
             custom_redirect_url?: string | undefined;
             /** 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`. */
             custom_redirect_failure_url?: string | undefined;
-            /** 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. */
+            /** Associate the Connect Webview, the connected account, and all resources under the connected account with a customer. If the connected account already exists, it will be associated with the customer. If the connected account already exists, but is already associated with a customer, the Connect Webview will show an error. */
             customer_key?: string | undefined;
             /** 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. */
             accepted_providers?: ('hotek' | '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' | 'tedee' | 'honeywell_resideo' | 'latch' | 'akiles' | 'assa_abloy_vostio' | 'assa_abloy_vostio_credential_service' | 'tado' | 'salto_space' | 'sensi' | 'kwikset2' | 'keynest' | 'dormakaba_ambiance' | 'yale_access' | 'hid_cm' | 'google_nest')[] | undefined;
@@ -31187,7 +31187,7 @@ export type Routes = {
     };
     '/connected_accounts/update': {
         route: '/connected_accounts/update';
-        method: 'POST';
+        method: 'PATCH' | 'POST';
         queryParams: {};
         jsonBody: {
             /** ID of the connected account that you want to update. */
@@ -31200,7 +31200,7 @@ export type Routes = {
             } | undefined;
             /** List of accepted device capabilities that restrict the types of devices that can be connected through this connected account. Valid values are `lock`, `thermostat`, `noise_sensor`, and `access_control`. */
             accepted_capabilities?: ('lock' | 'thermostat' | 'noise_sensor' | 'access_control')[] | undefined;
-            /** The customer key to associate with this connected account. If provided, the connected account and all resources under the connected account will be moved to this customer.  */
+            /** The customer key to associate with this connected account. If provided, the connected account and all resources under the connected account will be moved to this customer. May only be provided if the connected account is not already associated with a customer. */
             customer_key?: string | undefined;
         };
         commonParams: {};
@@ -31346,6 +31346,8 @@ export type Routes = {
                 connect?: {
                     /** Whether to exclude this feature from the portal. */
                     exclude?: boolean;
+                    /** List of provider keys to allow for the connect feature. These providers will be shown when the customer tries to connect an account. */
+                    accepted_providers?: string[] | undefined;
                     /** List of provider keys to exclude from the connect feature. These providers will not be shown when the customer tries to connect an account. */
                     excluded_providers?: string[] | undefined;
                 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@seamapi/types",
-  "version": "1.590.0",
+  "version": "1.592.0",
   "description": "TypeScript types for the Seam API.",
   "type": "module",
   "main": "index.js",

package/src/lib/seam/connect/models/customer/customer-portal.ts

@@ -11,6 +11,12 @@ const base_feature = z.object({
 })
 
 const base_connect_feature = base_feature.extend({
+  accepted_providers: z
+    .array(z.string())
+    .optional()
+    .describe(
+      'List of provider keys to allow for the connect feature. These providers will be shown when the customer tries to connect an account.',
+    ),
   excluded_providers: z
     .array(z.string())
     .optional()

package/src/lib/seam/connect/openapi.ts

@@ -39282,7 +39282,7 @@ export default {
                   },
                   customer_key: {
                     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.',
+                      'Associate the Connect Webview, the connected account, and all resources under the connected account with a customer. If the connected account already exists, it will be associated with the customer. If the connected account already exists, but is already associated with a customer, the Connect Webview will show an error.',
                     type: 'string',
                   },
                   device_selection_mode: {
@@ -40231,6 +40231,100 @@ export default {
       },
     },
     '/connected_accounts/update': {
+      patch: {
+        description:
+          'Updates a [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts).',
+        operationId: 'connectedAccountsUpdatePatch',
+        requestBody: {
+          content: {
+            'application/json': {
+              schema: {
+                properties: {
+                  accepted_capabilities: {
+                    description:
+                      'List of accepted device capabilities that restrict the types of devices that can be connected through this connected account. Valid values are `lock`, `thermostat`, `noise_sensor`, and `access_control`.',
+                    items: {
+                      description:
+                        '\n  High-level device capabilities that can be restricted in connect webviews.\n  These represent the main device categories that customers can opt into.\n',
+                      enum: [
+                        'lock',
+                        'thermostat',
+                        'noise_sensor',
+                        'access_control',
+                      ],
+                      type: 'string',
+                    },
+                    type: 'array',
+                  },
+                  automatically_manage_new_devices: {
+                    description:
+                      'Indicates whether newly-added devices should appear as [managed devices](https://docs.seam.co/latest/core-concepts/devices/managed-and-unmanaged-devices).',
+                    type: 'boolean',
+                  },
+                  connected_account_id: {
+                    description:
+                      'ID of the connected account that you want to update.',
+                    format: 'uuid',
+                    type: 'string',
+                  },
+                  custom_metadata: {
+                    additionalProperties: {
+                      nullable: true,
+                      oneOf: [
+                        { maxLength: 500, type: 'string' },
+                        { type: 'boolean' },
+                      ],
+                    },
+                    description:
+                      'Custom metadata that you want to associate with the connected account. Entirely replaces the existing custom metadata object. If a new Connect Webview contains custom metadata and is used to reconnect a connected account, the custom metadata from the Connect Webview will entirely replace the entire custom metadata object on the connected account. Supports up to 50 JSON key:value pairs. [Adding custom metadata to a connected account](https://docs.seam.co/latest/core-concepts/connected-accounts/adding-custom-metadata-to-a-connected-account) enables you to store custom information, like customer details or internal IDs from your application. Then, you can [filter connected accounts by the desired metadata](https://docs.seam.co/latest/core-concepts/connected-accounts/filtering-connected-accounts-by-custom-metadata).',
+                    type: 'object',
+                  },
+                  customer_key: {
+                    description:
+                      'The customer key to associate with this connected account. If provided, the connected account and all resources under the connected account will be moved to this customer. May only be provided if the connected account is not already associated with a customer.',
+                    minLength: 1,
+                    type: 'string',
+                  },
+                },
+                required: ['connected_account_id'],
+                type: 'object',
+              },
+            },
+          },
+        },
+        responses: {
+          200: {
+            content: {
+              'application/json': {
+                schema: {
+                  properties: {
+                    connected_account: {
+                      $ref: '#/components/schemas/connected_account',
+                    },
+                    ok: { type: 'boolean' },
+                  },
+                  required: ['connected_account', 'ok'],
+                  type: 'object',
+                },
+              },
+            },
+            description: 'OK',
+          },
+          400: { description: 'Bad Request' },
+          401: { description: 'Unauthorized' },
+        },
+        security: [
+          { pat_with_workspace: [] },
+          { console_session_with_workspace: [] },
+          { api_key: [] },
+        ],
+        summary: '/connected_accounts/update',
+        tags: ['/connected_accounts'],
+        'x-fern-sdk-group-name': ['connected_accounts'],
+        'x-fern-sdk-method-name': 'update',
+        'x-response-key': null,
+        'x-title': 'Update a Connected Account',
+      },
       post: {
         description:
           'Updates a [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts).',
@@ -40281,7 +40375,7 @@ export default {
                   },
                   customer_key: {
                     description:
-                      'The customer key to associate with this connected account. If provided, the connected account and all resources under the connected account will be moved to this customer. ',
+                      'The customer key to associate with this connected account. If provided, the connected account and all resources under the connected account will be moved to this customer. May only be provided if the connected account is not already associated with a customer.',
                     minLength: 1,
                     type: 'string',
                   },
@@ -40386,6 +40480,12 @@ export default {
                             description:
                               'Configuration for the connect accounts feature.',
                             properties: {
+                              accepted_providers: {
+                                description:
+                                  'List of provider keys to allow for the connect feature. These providers will be shown when the customer tries to connect an account.',
+                                items: { type: 'string' },
+                                type: 'array',
+                              },
                               exclude: {
                                 default: false,
                                 description:

package/src/lib/seam/connect/route-types.ts

@@ -35548,7 +35548,7 @@ export type Routes = {
       custom_redirect_url?: string | undefined
       /** 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`. */
       custom_redirect_failure_url?: string | undefined
-      /** 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. */
+      /** Associate the Connect Webview, the connected account, and all resources under the connected account with a customer. If the connected account already exists, it will be associated with the customer. If the connected account already exists, but is already associated with a customer, the Connect Webview will show an error. */
       customer_key?: string | undefined
       /** 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. */
       accepted_providers?:
@@ -36244,7 +36244,7 @@ export type Routes = {
   }
   '/connected_accounts/update': {
     route: '/connected_accounts/update'
-    method: 'POST'
+    method: 'PATCH' | 'POST'
     queryParams: {}
     jsonBody: {
       /** ID of the connected account that you want to update. */
@@ -36261,7 +36261,7 @@ export type Routes = {
       accepted_capabilities?:
         | ('lock' | 'thermostat' | 'noise_sensor' | 'access_control')[]
         | undefined
-      /** The customer key to associate with this connected account. If provided, the connected account and all resources under the connected account will be moved to this customer.  */
+      /** The customer key to associate with this connected account. If provided, the connected account and all resources under the connected account will be moved to this customer. May only be provided if the connected account is not already associated with a customer. */
       customer_key?: string | undefined
     }
     commonParams: {}
@@ -36423,6 +36423,8 @@ export type Routes = {
         connect?: {
           /** Whether to exclude this feature from the portal. */
           exclude?: boolean
+          /** List of provider keys to allow for the connect feature. These providers will be shown when the customer tries to connect an account. */
+          accepted_providers?: string[] | undefined
           /** List of provider keys to exclude from the connect feature. These providers will not be shown when the customer tries to connect an account. */
           excluded_providers?: string[] | undefined
         }