npm - @seamapi/types - Versions diffs - 1.1010.0 → 1.1012.0 - Mend

@seamapi/types 1.1010.0 → 1.1012.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.

Files changed (18) hide show

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

@@ -1939,6 +1939,15 @@ export type Routes = {
                     created_at?: string | undefined;
                     /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
                     error_code: 'access_code_inactive';
+                } | {
+                    /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
+                    message: string;
+                    /** Indicates that this is an access code error. */
+                    is_access_code_error: true;
+                    /** Date and time at which Seam created the error. */
+                    created_at?: string | undefined;
+                    /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
+                    error_code: 'code_constraints_violated';
                 } | {
                     /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
                     message: string;
@@ -2427,6 +2436,15 @@ export type Routes = {
                     created_at?: string | undefined;
                     /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
                     error_code: 'access_code_inactive';
+                } | {
+                    /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
+                    message: string;
+                    /** Indicates that this is an access code error. */
+                    is_access_code_error: true;
+                    /** Date and time at which Seam created the error. */
+                    created_at?: string | undefined;
+                    /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
+                    error_code: 'code_constraints_violated';
                 } | {
                     /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
                     message: string;
@@ -4719,6 +4737,15 @@ export type Routes = {
                     created_at?: string | undefined;
                     /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
                     error_code: 'access_code_inactive';
+                } | {
+                    /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
+                    message: string;
+                    /** Indicates that this is an access code error. */
+                    is_access_code_error: true;
+                    /** Date and time at which Seam created the error. */
+                    created_at?: string | undefined;
+                    /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
+                    error_code: 'code_constraints_violated';
                 } | {
                     /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
                     message: string;
@@ -5255,6 +5282,15 @@ export type Routes = {
                     created_at?: string | undefined;
                     /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
                     error_code: 'access_code_inactive';
+                } | {
+                    /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
+                    message: string;
+                    /** Indicates that this is an access code error. */
+                    is_access_code_error: true;
+                    /** Date and time at which Seam created the error. */
+                    created_at?: string | undefined;
+                    /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
+                    error_code: 'code_constraints_violated';
                 } | {
                     /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
                     message: string;
@@ -5734,6 +5770,15 @@ export type Routes = {
                     created_at?: string | undefined;
                     /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
                     error_code: 'access_code_inactive';
+                } | {
+                    /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
+                    message: string;
+                    /** Indicates that this is an access code error. */
+                    is_access_code_error: true;
+                    /** Date and time at which Seam created the error. */
+                    created_at?: string | undefined;
+                    /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
+                    error_code: 'code_constraints_violated';
                 } | {
                     /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
                     message: string;
@@ -6190,6 +6235,15 @@ export type Routes = {
                     created_at?: string | undefined;
                     /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
                     error_code: 'access_code_inactive';
+                } | {
+                    /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
+                    message: string;
+                    /** Indicates that this is an access code error. */
+                    is_access_code_error: true;
+                    /** Date and time at which Seam created the error. */
+                    created_at?: string | undefined;
+                    /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
+                    error_code: 'code_constraints_violated';
                 } | {
                     /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
                     message: string;
@@ -6679,6 +6733,15 @@ export type Routes = {
                     created_at?: string | undefined;
                     /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
                     error_code: 'access_code_inactive';
+                } | {
+                    /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
+                    message: string;
+                    /** Indicates that this is an access code error. */
+                    is_access_code_error: true;
+                    /** Date and time at which Seam created the error. */
+                    created_at?: string | undefined;
+                    /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
+                    error_code: 'code_constraints_violated';
                 } | {
                     /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
                     message: string;
@@ -8880,6 +8943,15 @@ export type Routes = {
                     created_at?: string | undefined;
                     /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
                     error_code: 'access_code_inactive';
+                } | {
+                    /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
+                    message: string;
+                    /** Indicates that this is an access code error. */
+                    is_access_code_error: true;
+                    /** Date and time at which Seam created the error. */
+                    created_at?: string | undefined;
+                    /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
+                    error_code: 'code_constraints_violated';
                 } | {
                     /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
                     message: string;
@@ -9255,6 +9327,15 @@ export type Routes = {
                     created_at?: string | undefined;
                     /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
                     error_code: 'access_code_inactive';
+                } | {
+                    /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
+                    message: string;
+                    /** Indicates that this is an access code error. */
+                    is_access_code_error: true;
+                    /** Date and time at which Seam created the error. */
+                    created_at?: string | undefined;
+                    /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
+                    error_code: 'code_constraints_violated';
                 } | {
                     /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
                     message: string;
@@ -124997,6 +125078,15 @@ export type Routes = {
                         created_at?: string | undefined;
                         /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
                         error_code: 'access_code_inactive';
+                    } | {
+                        /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
+                        message: string;
+                        /** Indicates that this is an access code error. */
+                        is_access_code_error: true;
+                        /** Date and time at which Seam created the error. */
+                        created_at?: string | undefined;
+                        /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
+                        error_code: 'code_constraints_violated';
                     } | {
                         /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
                         message: string;
@@ -125356,6 +125446,15 @@ export type Routes = {
                         created_at?: string | undefined;
                         /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
                         error_code: 'access_code_inactive';
+                    } | {
+                        /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
+                        message: string;
+                        /** Indicates that this is an access code error. */
+                        is_access_code_error: true;
+                        /** Date and time at which Seam created the error. */
+                        created_at?: string | undefined;
+                        /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
+                        error_code: 'code_constraints_violated';
                     } | {
                         /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
                         message: string;

package/package.json CHANGED Viewed

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

package/src/lib/seam/connect/models/access-codes/managed-access-code.ts CHANGED Viewed

@@ -135,6 +135,17 @@ const access_code_inactive_error = common_access_code_error.extend({
     Indicates that the access code is disabled or inactive on the device. The code exists but will not grant access until re-enabled.
     `)
+const code_constraints_violated = common_access_code_error.extend({
+  error_code: z
+    .literal('code_constraints_violated')
+    .describe(error_code_description),
+}).describe(`
+    ---
+    resource_type: access_code
+    ---
+    The code cannot be set on the device because it violates the device's code constraints (for example, its length, digits, or a too-simple value). The code will not be retried until you change it. See the device's \`code_constraints\` and \`supported_code_lengths\`.
+    `)
 const access_code_error = z
   .discriminatedUnion('error_code', [
     provider_issue,
@@ -144,6 +155,7 @@ const access_code_error = z
     no_space_for_access_code_on_device,
     conflicting_external_modification_error,
     access_code_inactive_error,
+    code_constraints_violated,
   ])
   .describe(
     'Errors associated with the [access code](https://docs.seam.co/low-level-apis/smart-locks/access-codes).',
@@ -165,6 +177,7 @@ const _access_code_error_map = z.object({
     .optional()
     .nullable(),
   access_code_inactive: access_code_inactive_error.optional().nullable(),
+  code_constraints_violated: code_constraints_violated.optional().nullable(),
 })
 export type AccessCodeErrorMap = z.infer<typeof _access_code_error_map>

package/src/lib/seam/connect/models/custom-metadata.ts CHANGED Viewed

@@ -1,15 +1,22 @@
 import { z } from 'zod'
+const custom_metadata_key = z
+  .string()
+  .max(40)
+  .refine((key) => !key.includes('.'), {
+    message: 'Custom metadata key names cannot contain a period (.)',
+  })
 export const custom_metadata_input = z
   .record(
-    z.string().max(40),
+    custom_metadata_key,
     z.union([z.string().max(500), z.boolean(), z.null()]),
   )
   .refine((val) => Object.keys(val).length <= 50, {
     message: 'Custom metadata is limited to a maximum of 50 keys',
   })
   .describe(
-    'Set of up to 50 key:value pairs, with key names up to 40 characters long. Accepts string or Boolean values. Strings are limited to 500 characters. Adding custom metadata to a resource, such as a [Connect Webview](https://docs.seam.co/core-concepts/connect-webviews/attaching-custom-data-to-the-connect-webview), [connected account](https://docs.seam.co/core-concepts/connected-accounts/adding-custom-metadata-to-a-connected-account), or [device](https://docs.seam.co/core-concepts/devices/adding-custom-metadata-to-a-device), enables you to store custom information, like customer details or internal IDs from your application.',
+    'Set of up to 50 key:value pairs, with key names up to 40 characters long that cannot contain a period (.). Accepts string or Boolean values. Strings are limited to 500 characters. Adding custom metadata to a resource, such as a [Connect Webview](https://docs.seam.co/core-concepts/connect-webviews/attaching-custom-data-to-the-connect-webview), [connected account](https://docs.seam.co/core-concepts/connected-accounts/adding-custom-metadata-to-a-connected-account), or [device](https://docs.seam.co/core-concepts/devices/adding-custom-metadata-to-a-device), enables you to store custom information, like customer details or internal IDs from your application.',
   )
 export const custom_metadata = z

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

@@ -367,6 +367,38 @@ const openapi: OpenAPISpec = {
                   type: 'object',
                   'x-resource-type': 'access_code',
                 },
+                {
+                  description:
+                    "The code cannot be set on the device because it violates the device's code constraints (for example, its length, digits, or a too-simple value). The code will not be retried until you change it. See the device's `code_constraints` and `supported_code_lengths`.",
+                  properties: {
+                    created_at: {
+                      description:
+                        'Date and time at which Seam created the error.',
+                      format: 'date-time',
+                      type: 'string',
+                    },
+                    error_code: {
+                      description:
+                        'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
+                      enum: ['code_constraints_violated'],
+                      type: 'string',
+                    },
+                    is_access_code_error: {
+                      description:
+                        'Indicates that this is an access code error.',
+                      enum: [true],
+                      type: 'boolean',
+                    },
+                    message: {
+                      description:
+                        'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
+                      type: 'string',
+                    },
+                  },
+                  required: ['message', 'is_access_code_error', 'error_code'],
+                  type: 'object',
+                  'x-resource-type': 'access_code',
+                },
                 {
                   description: 'Indicates that the account is disconnected.',
                   properties: {
@@ -30476,6 +30508,38 @@ const openapi: OpenAPISpec = {
                   type: 'object',
                   'x-resource-type': 'access_code',
                 },
+                {
+                  description:
+                    "The code cannot be set on the device because it violates the device's code constraints (for example, its length, digits, or a too-simple value). The code will not be retried until you change it. See the device's `code_constraints` and `supported_code_lengths`.",
+                  properties: {
+                    created_at: {
+                      description:
+                        'Date and time at which Seam created the error.',
+                      format: 'date-time',
+                      type: 'string',
+                    },
+                    error_code: {
+                      description:
+                        'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
+                      enum: ['code_constraints_violated'],
+                      type: 'string',
+                    },
+                    is_access_code_error: {
+                      description:
+                        'Indicates that this is an access code error.',
+                      enum: [true],
+                      type: 'boolean',
+                    },
+                    message: {
+                      description:
+                        'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
+                      type: 'string',
+                    },
+                  },
+                  required: ['message', 'is_access_code_error', 'error_code'],
+                  type: 'object',
+                  'x-resource-type': 'access_code',
+                },
                 {
                   description: 'Indicates that the account is disconnected.',
                   properties: {

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

@@ -2253,6 +2253,16 @@ export type Routes = {
               /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
               error_code: 'access_code_inactive'
             }
+          | {
+              /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
+              message: string
+              /** Indicates that this is an access code error. */
+              is_access_code_error: true
+              /** Date and time at which Seam created the error. */
+              created_at?: string | undefined
+              /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
+              error_code: 'code_constraints_violated'
+            }
           | {
               /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
               message: string
@@ -2788,6 +2798,16 @@ export type Routes = {
               /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
               error_code: 'access_code_inactive'
             }
+          | {
+              /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
+              message: string
+              /** Indicates that this is an access code error. */
+              is_access_code_error: true
+              /** Date and time at which Seam created the error. */
+              created_at?: string | undefined
+              /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
+              error_code: 'code_constraints_violated'
+            }
           | {
               /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
               message: string
@@ -5431,6 +5451,16 @@ export type Routes = {
               /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
               error_code: 'access_code_inactive'
             }
+          | {
+              /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
+              message: string
+              /** Indicates that this is an access code error. */
+              is_access_code_error: true
+              /** Date and time at which Seam created the error. */
+              created_at?: string | undefined
+              /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
+              error_code: 'code_constraints_violated'
+            }
           | {
               /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
               message: string
@@ -6067,6 +6097,16 @@ export type Routes = {
               /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
               error_code: 'access_code_inactive'
             }
+          | {
+              /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
+              message: string
+              /** Indicates that this is an access code error. */
+              is_access_code_error: true
+              /** Date and time at which Seam created the error. */
+              created_at?: string | undefined
+              /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
+              error_code: 'code_constraints_violated'
+            }
           | {
               /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
               message: string
@@ -6593,6 +6633,16 @@ export type Routes = {
               /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
               error_code: 'access_code_inactive'
             }
+          | {
+              /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
+              message: string
+              /** Indicates that this is an access code error. */
+              is_access_code_error: true
+              /** Date and time at which Seam created the error. */
+              created_at?: string | undefined
+              /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
+              error_code: 'code_constraints_violated'
+            }
           | {
               /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
               message: string
@@ -7096,6 +7146,16 @@ export type Routes = {
               /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
               error_code: 'access_code_inactive'
             }
+          | {
+              /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
+              message: string
+              /** Indicates that this is an access code error. */
+              is_access_code_error: true
+              /** Date and time at which Seam created the error. */
+              created_at?: string | undefined
+              /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
+              error_code: 'code_constraints_violated'
+            }
           | {
               /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
               message: string
@@ -7632,6 +7692,16 @@ export type Routes = {
               /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
               error_code: 'access_code_inactive'
             }
+          | {
+              /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
+              message: string
+              /** Indicates that this is an access code error. */
+              is_access_code_error: true
+              /** Date and time at which Seam created the error. */
+              created_at?: string | undefined
+              /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
+              error_code: 'code_constraints_violated'
+            }
           | {
               /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
               message: string
@@ -10177,6 +10247,16 @@ export type Routes = {
               /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
               error_code: 'access_code_inactive'
             }
+          | {
+              /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
+              message: string
+              /** Indicates that this is an access code error. */
+              is_access_code_error: true
+              /** Date and time at which Seam created the error. */
+              created_at?: string | undefined
+              /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
+              error_code: 'code_constraints_violated'
+            }
           | {
               /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
               message: string
@@ -10592,6 +10672,16 @@ export type Routes = {
               /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
               error_code: 'access_code_inactive'
             }
+          | {
+              /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
+              message: string
+              /** Indicates that this is an access code error. */
+              is_access_code_error: true
+              /** Date and time at which Seam created the error. */
+              created_at?: string | undefined
+              /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
+              error_code: 'code_constraints_violated'
+            }
           | {
               /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
               message: string
@@ -149674,6 +149764,16 @@ export type Routes = {
                     /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
                     error_code: 'access_code_inactive'
                   }
+                | {
+                    /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
+                    message: string
+                    /** Indicates that this is an access code error. */
+                    is_access_code_error: true
+                    /** Date and time at which Seam created the error. */
+                    created_at?: string | undefined
+                    /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
+                    error_code: 'code_constraints_violated'
+                  }
                 | {
                     /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
                     message: string
@@ -150075,6 +150175,16 @@ export type Routes = {
                     /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
                     error_code: 'access_code_inactive'
                   }
+                | {
+                    /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
+                    message: string
+                    /** Indicates that this is an access code error. */
+                    is_access_code_error: true
+                    /** Date and time at which Seam created the error. */
+                    created_at?: string | undefined
+                    /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
+                    error_code: 'code_constraints_violated'
+                  }
                 | {
                     /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
                     message: string