@seamapi/types 1.687.0 → 1.689.0

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

@@ -11653,7 +11653,8 @@ export type Routes = {
                     connected_account_id: string;
                     /** Date and time at which the connected account was created. */
                     created_at?: string | undefined;
-                    /** User identifier associated with the connected account. */
+                    /** User identifier associated with the connected account.
+                     * @deprecated Use `display_name` instead.*/
                     user_identifier?: {
                         /** Username of the user identifier associated with the connected account. */
                         username?: string | undefined;
@@ -11670,6 +11671,8 @@ export type Routes = {
                     account_type?: string | undefined;
                     /** Display name for the connected account type. */
                     account_type_display_name: string;
+                    /** Display name for the connected account. */
+                    display_name: string;
                     /** Errors associated with the connected account. */
                     errors: ({
                         /** Date and time at which Seam created the error. */
@@ -26151,7 +26154,8 @@ export type Routes = {
                 connected_account_id: string;
                 /** Date and time at which the connected account was created. */
                 created_at?: string | undefined;
-                /** User identifier associated with the connected account. */
+                /** User identifier associated with the connected account.
+                 * @deprecated Use `display_name` instead.*/
                 user_identifier?: {
                     /** Username of the user identifier associated with the connected account. */
                     username?: string | undefined;
@@ -26168,6 +26172,8 @@ export type Routes = {
                 account_type?: string | undefined;
                 /** Display name for the connected account type. */
                 account_type_display_name: string;
+                /** Display name for the connected account. */
+                display_name: string;
                 /** Errors associated with the connected account. */
                 errors: ({
                     /** Date and time at which Seam created the error. */
@@ -26303,7 +26309,8 @@ export type Routes = {
                 connected_account_id: string;
                 /** Date and time at which the connected account was created. */
                 created_at?: string | undefined;
-                /** User identifier associated with the connected account. */
+                /** User identifier associated with the connected account.
+                 * @deprecated Use `display_name` instead.*/
                 user_identifier?: {
                     /** Username of the user identifier associated with the connected account. */
                     username?: string | undefined;
@@ -26320,6 +26327,8 @@ export type Routes = {
                 account_type?: string | undefined;
                 /** Display name for the connected account type. */
                 account_type_display_name: string;
+                /** Display name for the connected account. */
+                display_name: string;
                 /** Errors associated with the connected account. */
                 errors: ({
                     /** Date and time at which Seam created the error. */
@@ -26489,7 +26498,8 @@ export type Routes = {
                 connected_account_id: string;
                 /** Date and time at which the connected account was created. */
                 created_at?: string | undefined;
-                /** User identifier associated with the connected account. */
+                /** User identifier associated with the connected account.
+                 * @deprecated Use `display_name` instead.*/
                 user_identifier?: {
                     /** Username of the user identifier associated with the connected account. */
                     username?: string | undefined;
@@ -26506,6 +26516,8 @@ export type Routes = {
                 account_type?: string | undefined;
                 /** Display name for the connected account type. */
                 account_type_display_name: string;
+                /** Display name for the connected account. */
+                display_name: string;
                 /** Errors associated with the connected account. */
                 errors: ({
                     /** Date and time at which Seam created the error. */
@@ -52549,6 +52561,10 @@ export type Routes = {
         jsonBody: {
             /** ID of the connector to delete */
             connector_id: string;
+            customer_key?: string | undefined;
+            customer_id?: string | undefined;
+            connector_customer_id?: string | undefined;
+            unique_provider_resource_key?: string | undefined;
         };
         commonParams: {};
         formData: {};
@@ -52590,11 +52606,20 @@ export type Routes = {
         commonParams: {
             /** ID of the connector to sync */
             connector_id: string;
+            /** Type of the connector to sync */
+            connector_type: string;
+            /** ID of the customer to sync */
+            customer_id: string;
+            /** Key of the customer to sync */
+            customer_key: string;
+            /** ID of the connector customer to sync */
+            connector_customer_id: string | null;
+            /** Unique provider resource key of the connector to sync */
+            unique_provider_resource_key: string | null;
         };
         formData: {};
         jsonResponse: {
             connector_sync: {
-                connector_id: string;
                 status: string;
                 message: string;
             };
@@ -57287,7 +57312,8 @@ export type Routes = {
                     connected_account_id: string;
                     /** Date and time at which the connected account was created. */
                     created_at?: string | undefined;
-                    /** User identifier associated with the connected account. */
+                    /** User identifier associated with the connected account.
+                     * @deprecated Use `display_name` instead.*/
                     user_identifier?: {
                         /** Username of the user identifier associated with the connected account. */
                         username?: string | undefined;
@@ -57304,6 +57330,8 @@ export type Routes = {
                     account_type?: string | undefined;
                     /** Display name for the connected account type. */
                     account_type_display_name: string;
+                    /** Display name for the connected account. */
+                    display_name: string;
                     /** Errors associated with the connected account. */
                     errors: ({
                         /** Date and time at which Seam created the error. */
@@ -81196,7 +81224,8 @@ export type Routes = {
                     connected_account_id: string;
                     /** Date and time at which the connected account was created. */
                     created_at?: string | undefined;
-                    /** User identifier associated with the connected account. */
+                    /** User identifier associated with the connected account.
+                     * @deprecated Use `display_name` instead.*/
                     user_identifier?: {
                         /** Username of the user identifier associated with the connected account. */
                         username?: string | undefined;
@@ -81213,6 +81242,8 @@ export type Routes = {
                     account_type?: string | undefined;
                     /** Display name for the connected account type. */
                     account_type_display_name: string;
+                    /** Display name for the connected account. */
+                    display_name: string;
                     /** Errors associated with the connected account. */
                     errors: ({
                         /** Date and time at which Seam created the error. */

package/package.json

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

package/src/lib/seam/connect/models/connected-accounts/connected-account.ts

@@ -292,12 +292,17 @@ export const connected_account = z.object({
           'Indicates whether the user identifier associated with the connected account is exclusive.',
         ),
     })
-    .optional()
-    .describe('User identifier associated with the connected account.'),
+    .optional().describe(`
+      ---
+      deprecated: Use \`display_name\` instead.
+      ---
+      User identifier associated with the connected account.
+    `),
   account_type: z.string().optional().describe('Type of connected account.'),
   account_type_display_name: z
     .string()
     .describe('Display name for the connected account type.'),
+  display_name: z.string().describe('Display name for the connected account.'),
   errors: z
     .array(connected_account_error)
     .describe('Errors associated with the connected account.'),

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

@@ -9227,6 +9227,10 @@ export default {
               'Your unique key for the customer associated with this connected account.',
             type: 'string',
           },
+          display_name: {
+            description: 'Display name for the connected account.',
+            type: 'string',
+          },
           errors: {
             description: 'Errors associated with the connected account.',
             items: {
@@ -9394,6 +9398,7 @@ export default {
             type: 'array',
           },
           user_identifier: {
+            deprecated: true,
             description:
               'User identifier associated with the connected account.',
             properties: {
@@ -9424,6 +9429,7 @@ export default {
               },
             },
             type: 'object',
+            'x-deprecated': 'Use `display_name` instead.',
           },
           warnings: {
             description: 'Warnings associated with the connected account.',
@@ -9592,6 +9598,7 @@ export default {
         required: [
           'connected_account_id',
           'account_type_display_name',
+          'display_name',
           'errors',
           'warnings',
           'custom_metadata',
@@ -54124,7 +54131,7 @@ export default {
     '/seam/customer/v1/connectors/create': {
       post: {
         description:
-          'Creates a new connector for a customer in a workspace. The connector will be activated and start syncing data from the external API.\nIf a connector already exists for the same customer, it will be updated instead of creating a new one.',
+          'Creates a new connector for a customer in a workspace. The connector will be activated and start syncing data from the external API.',
         operationId: 'seamCustomerV1ConnectorsCreatePost',
         requestBody: {
           content: {
@@ -54213,11 +54220,7 @@ export default {
           400: { description: 'Bad Request' },
           401: { description: 'Unauthorized' },
         },
-        security: [
-          { api_key: [] },
-          { client_session_with_customer: [] },
-          { console_session_with_workspace: [] },
-        ],
+        security: [{ api_key: [] }, { console_session_with_workspace: [] }],
         summary: '/seam/customer/v1/connectors/create',
         tags: [],
         'x-fern-sdk-group-name': ['seam', 'customer', 'v1', 'connectors'],
@@ -54238,11 +54241,15 @@ export default {
             'application/json': {
               schema: {
                 properties: {
+                  connector_customer_id: { type: 'string' },
                   connector_id: {
                     description: 'ID of the connector to delete',
                     minLength: 1,
                     type: 'string',
                   },
+                  customer_id: { type: 'string' },
+                  customer_key: { type: 'string' },
+                  unique_provider_resource_key: { type: 'string' },
                 },
                 required: ['connector_id'],
                 type: 'object',
@@ -54277,11 +54284,7 @@ export default {
           400: { description: 'Bad Request' },
           401: { description: 'Unauthorized' },
         },
-        security: [
-          { api_key: [] },
-          { client_session_with_customer: [] },
-          { console_session_with_workspace: [] },
-        ],
+        security: [{ api_key: [] }, { console_session_with_workspace: [] }],
         summary: '/seam/customer/v1/connectors/delete',
         tags: [],
         'x-fern-sdk-group-name': ['seam', 'customer', 'v1', 'connectors'],
@@ -54436,13 +54439,44 @@ export default {
             'application/json': {
               schema: {
                 properties: {
+                  connector_customer_id: {
+                    description: 'ID of the connector customer to sync',
+                    format: 'uuid',
+                    nullable: true,
+                    type: 'string',
+                  },
                   connector_id: {
                     description: 'ID of the connector to sync',
                     format: 'uuid',
                     type: 'string',
                   },
+                  connector_type: {
+                    description: 'Type of the connector to sync',
+                    type: 'string',
+                  },
+                  customer_id: {
+                    description: 'ID of the customer to sync',
+                    type: 'string',
+                  },
+                  customer_key: {
+                    description: 'Key of the customer to sync',
+                    type: 'string',
+                  },
+                  unique_provider_resource_key: {
+                    description:
+                      'Unique provider resource key of the connector to sync',
+                    nullable: true,
+                    type: 'string',
+                  },
                 },
-                required: ['connector_id'],
+                required: [
+                  'connector_id',
+                  'connector_type',
+                  'customer_id',
+                  'customer_key',
+                  'connector_customer_id',
+                  'unique_provider_resource_key',
+                ],
                 type: 'object',
               },
             },
@@ -54456,11 +54490,10 @@ export default {
                   properties: {
                     connector_sync: {
                       properties: {
-                        connector_id: { type: 'string' },
                         message: { type: 'string' },
                         status: { type: 'string' },
                       },
-                      required: ['connector_id', 'status', 'message'],
+                      required: ['status', 'message'],
                       type: 'object',
                     },
                     ok: { type: 'boolean' },

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

@@ -13320,7 +13320,8 @@ export type Routes = {
               connected_account_id: string
               /** Date and time at which the connected account was created. */
               created_at?: string | undefined
-              /** User identifier associated with the connected account. */
+              /** User identifier associated with the connected account.
+               * @deprecated Use `display_name` instead.*/
               user_identifier?:
                 | {
                     /** Username of the user identifier associated with the connected account. */
@@ -13339,6 +13340,8 @@ export type Routes = {
               account_type?: string | undefined
               /** Display name for the connected account type. */
               account_type_display_name: string
+              /** Display name for the connected account. */
+              display_name: string
               /** Errors associated with the connected account. */
               errors: (
                 | {
@@ -30276,7 +30279,8 @@ export type Routes = {
         connected_account_id: string
         /** Date and time at which the connected account was created. */
         created_at?: string | undefined
-        /** User identifier associated with the connected account. */
+        /** User identifier associated with the connected account.
+         * @deprecated Use `display_name` instead.*/
         user_identifier?:
           | {
               /** Username of the user identifier associated with the connected account. */
@@ -30295,6 +30299,8 @@ export type Routes = {
         account_type?: string | undefined
         /** Display name for the connected account type. */
         account_type_display_name: string
+        /** Display name for the connected account. */
+        display_name: string
         /** Errors associated with the connected account. */
         errors: (
           | {
@@ -30446,7 +30452,8 @@ export type Routes = {
         connected_account_id: string
         /** Date and time at which the connected account was created. */
         created_at?: string | undefined
-        /** User identifier associated with the connected account. */
+        /** User identifier associated with the connected account.
+         * @deprecated Use `display_name` instead.*/
         user_identifier?:
           | {
               /** Username of the user identifier associated with the connected account. */
@@ -30465,6 +30472,8 @@ export type Routes = {
         account_type?: string | undefined
         /** Display name for the connected account type. */
         account_type_display_name: string
+        /** Display name for the connected account. */
+        display_name: string
         /** Errors associated with the connected account. */
         errors: (
           | {
@@ -30652,7 +30661,8 @@ export type Routes = {
         connected_account_id: string
         /** Date and time at which the connected account was created. */
         created_at?: string | undefined
-        /** User identifier associated with the connected account. */
+        /** User identifier associated with the connected account.
+         * @deprecated Use `display_name` instead.*/
         user_identifier?:
           | {
               /** Username of the user identifier associated with the connected account. */
@@ -30671,6 +30681,8 @@ export type Routes = {
         account_type?: string | undefined
         /** Display name for the connected account type. */
         account_type_display_name: string
+        /** Display name for the connected account. */
+        display_name: string
         /** Errors associated with the connected account. */
         errors: (
           | {
@@ -62864,6 +62876,10 @@ export type Routes = {
     jsonBody: {
       /** ID of the connector to delete */
       connector_id: string
+      customer_key?: string | undefined
+      customer_id?: string | undefined
+      connector_customer_id?: string | undefined
+      unique_provider_resource_key?: string | undefined
     }
     commonParams: {}
     formData: {}
@@ -62905,11 +62921,20 @@ export type Routes = {
     commonParams: {
       /** ID of the connector to sync */
       connector_id: string
+      /** Type of the connector to sync */
+      connector_type: string
+      /** ID of the customer to sync */
+      customer_id: string
+      /** Key of the customer to sync */
+      customer_key: string
+      /** ID of the connector customer to sync */
+      connector_customer_id: string | null
+      /** Unique provider resource key of the connector to sync */
+      unique_provider_resource_key: string | null
     }
     formData: {}
     jsonResponse: {
       connector_sync: {
-        connector_id: string
         status: string
         message: string
       }
@@ -68658,7 +68683,8 @@ export type Routes = {
               connected_account_id: string
               /** Date and time at which the connected account was created. */
               created_at?: string | undefined
-              /** User identifier associated with the connected account. */
+              /** User identifier associated with the connected account.
+               * @deprecated Use `display_name` instead.*/
               user_identifier?:
                 | {
                     /** Username of the user identifier associated with the connected account. */
@@ -68677,6 +68703,8 @@ export type Routes = {
               account_type?: string | undefined
               /** Display name for the connected account type. */
               account_type_display_name: string
+              /** Display name for the connected account. */
+              display_name: string
               /** Errors associated with the connected account. */
               errors: (
                 | {
@@ -97012,7 +97040,8 @@ export type Routes = {
               connected_account_id: string
               /** Date and time at which the connected account was created. */
               created_at?: string | undefined
-              /** User identifier associated with the connected account. */
+              /** User identifier associated with the connected account.
+               * @deprecated Use `display_name` instead.*/
               user_identifier?:
                 | {
                     /** Username of the user identifier associated with the connected account. */
@@ -97031,6 +97060,8 @@ export type Routes = {
               account_type?: string | undefined
               /** Display name for the connected account type. */
               account_type_display_name: string
+              /** Display name for the connected account. */
+              display_name: string
               /** Errors associated with the connected account. */
               errors: (
                 | {