@seamapi/types 1.687.0 → 1.688.0

package/dist/connect.d.cts

@@ -14946,6 +14946,7 @@ declare const batch: z.ZodObject<{
         }>>;
         account_type: z.ZodOptional<z.ZodString>;
         account_type_display_name: z.ZodString;
+        display_name: z.ZodString;
         errors: z.ZodArray<z.ZodDiscriminatedUnion<"error_code", [z.ZodObject<{
             created_at: z.ZodString;
             message: z.ZodString;
@@ -15158,6 +15159,7 @@ declare const batch: z.ZodObject<{
         customer_key: z.ZodOptional<z.ZodString>;
         accepted_capabilities: z.ZodArray<z.ZodEnum<["lock", "thermostat", "noise_sensor", "access_control"]>, "many">;
     }, "strip", z.ZodTypeAny, {
+        display_name: string;
         errors: ({
             message: string;
             created_at: string;
@@ -15226,6 +15228,7 @@ declare const batch: z.ZodObject<{
         account_type?: string | undefined;
         customer_key?: string | undefined;
     }, {
+        display_name: string;
         errors: ({
             message: string;
             created_at: string;
@@ -32755,6 +32758,7 @@ declare const batch: z.ZodObject<{
         nickname?: string | undefined;
     }[] | undefined;
     connected_accounts?: {
+        display_name: string;
         errors: ({
             message: string;
             created_at: string;
@@ -36813,6 +36817,7 @@ declare const batch: z.ZodObject<{
         nickname?: string | undefined;
     }[] | undefined;
     connected_accounts?: {
+        display_name: string;
         errors: ({
             message: string;
             created_at: string;
@@ -40606,6 +40611,7 @@ declare const connected_account: z.ZodObject<{
     }>>;
     account_type: z.ZodOptional<z.ZodString>;
     account_type_display_name: z.ZodString;
+    display_name: z.ZodString;
     errors: z.ZodArray<z.ZodDiscriminatedUnion<"error_code", [z.ZodObject<{
         created_at: z.ZodString;
         message: z.ZodString;
@@ -40818,6 +40824,7 @@ declare const connected_account: z.ZodObject<{
     customer_key: z.ZodOptional<z.ZodString>;
     accepted_capabilities: z.ZodArray<z.ZodEnum<["lock", "thermostat", "noise_sensor", "access_control"]>, "many">;
 }, "strip", z.ZodTypeAny, {
+    display_name: string;
     errors: ({
         message: string;
         created_at: string;
@@ -40886,6 +40893,7 @@ declare const connected_account: z.ZodObject<{
     account_type?: string | undefined;
     customer_key?: string | undefined;
 }, {
+    display_name: string;
     errors: ({
         message: string;
         created_at: string;
@@ -57428,6 +57436,10 @@ declare const _default: {
                         description: string;
                         type: string;
                     };
+                    display_name: {
+                        description: string;
+                        type: string;
+                    };
                     errors: {
                         description: string;
                         items: {
@@ -57532,6 +57544,7 @@ declare const _default: {
                         type: string;
                     };
                     user_identifier: {
+                        deprecated: boolean;
                         description: string;
                         properties: {
                             api_url: {
@@ -57556,6 +57569,7 @@ declare const _default: {
                             };
                         };
                         type: string;
+                        'x-deprecated': string;
                     };
                     warnings: {
                         description: string;
@@ -125917,7 +125931,8 @@ 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;
@@ -125934,6 +125949,8 @@ 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. */
@@ -140415,7 +140432,8 @@ 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;
@@ -140432,6 +140450,8 @@ 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. */
@@ -140567,7 +140587,8 @@ 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;
@@ -140584,6 +140605,8 @@ 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. */
@@ -140753,7 +140776,8 @@ 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;
@@ -140770,6 +140794,8 @@ 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. */
@@ -171551,7 +171577,8 @@ 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;
@@ -171568,6 +171595,8 @@ 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. */
@@ -195460,7 +195489,8 @@ 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;
@@ -195477,6 +195507,8 @@ 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/dist/index.cjs

@@ -705,9 +705,15 @@ var connected_account = zod.z.object({
     exclusive: zod.z.boolean().optional().describe(
       "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: zod.z.string().optional().describe("Type of connected account."),
   account_type_display_name: zod.z.string().describe("Display name for the connected account type."),
+  display_name: zod.z.string().describe("Display name for the connected account."),
   errors: zod.z.array(connected_account_error).describe("Errors associated with the connected account."),
   warnings: zod.z.array(connected_account_warning).describe("Warnings associated with the connected account."),
   custom_metadata,
@@ -14064,6 +14070,10 @@ var openapi_default = {
             description: "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: {
@@ -14207,6 +14217,7 @@ var openapi_default = {
             type: "array"
           },
           user_identifier: {
+            deprecated: true,
             description: "User identifier associated with the connected account.",
             properties: {
               api_url: {
@@ -14230,7 +14241,8 @@ var openapi_default = {
                 type: "string"
               }
             },
-            type: "object"
+            type: "object",
+            "x-deprecated": "Use `display_name` instead."
           },
           warnings: {
             description: "Warnings associated with the connected account.",
@@ -14376,6 +14388,7 @@ var openapi_default = {
         required: [
           "connected_account_id",
           "account_type_display_name",
+          "display_name",
           "errors",
           "warnings",
           "custom_metadata",