@seamapi/types 1.920.0 → 1.922.0

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

@@ -43,7 +43,7 @@ export type Routes = {
             /** Indicates whether the [offline access code](https://docs.seam.co/low-level-apis/smart-locks/access-codes/offline-access-codes) is a single-use access code. */
             is_one_time_use?: boolean | undefined;
             /** Maximum rounding adjustment. To create a daily-bound [offline access code](https://docs.seam.co/low-level-apis/smart-locks/access-codes/offline-access-codes) for devices that support this feature, set this parameter to `1d`. */
-            max_time_rounding?: '1hour' | '1day' | '1h' | '1d';
+            max_time_rounding?: ('1hour' | '1day' | '1h' | '1d') | undefined;
         };
         commonParams: {};
         formData: {};
@@ -9848,7 +9848,7 @@ export type Routes = {
             /** Indicates whether the [offline access code](https://docs.seam.co/low-level-apis/smart-locks/access-codes/offline-access-codes) is a single-use access code. */
             is_one_time_use?: boolean | undefined;
             /** Maximum rounding adjustment. To create a daily-bound [offline access code](https://docs.seam.co/low-level-apis/smart-locks/access-codes/offline-access-codes) for devices that support this feature, set this parameter to `1d`. */
-            max_time_rounding?: ('1hour' | '1day' | '1h' | '1d') | undefined;
+            max_time_rounding?: (('1hour' | '1day' | '1h' | '1d') | undefined) | undefined;
             /** ID of the access code that you want to update. */
             access_code_id: string;
             /** ID of the device containing the access code that you want to update. */

package/package.json

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

package/src/lib/seam/connect/models/access-grants/access-grant.ts

@@ -29,7 +29,12 @@ const cannot_create_requested_access_methods_error =
       .describe(
         'IDs of the devices that did not receive an access code at grant creation. Use these to identify which specific devices failed when the message reports a partial failure.',
       ),
-  })
+  }).describe(`
+    ---
+    resource_type: access_grant
+    ---
+    Indicates that Seam could not create one or more of the requested access methods for the access grant.
+    `)
 
 const common_access_grant_warning = z.object({
   created_at: z

package/src/lib/seam/connect/models/bridges/bridge-client-session.ts

@@ -15,8 +15,8 @@ const common_bridge_client_session_error = z.object({
 const error_code_description =
   'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.'
 
-export const bridge_lan_unreachable = common_bridge_client_session_error
-  .extend({
+export const bridge_lan_unreachable = common_bridge_client_session_error.extend(
+  {
     error_code: z
       .literal('bridge_lan_unreachable')
       .describe(error_code_description),
@@ -44,16 +44,25 @@ export const bridge_lan_unreachable = common_bridge_client_session_error
       .boolean()
       .nullable()
       .describe("Indicates whether Seam Bridge's SOCKS server is healthy."),
-  })
-  .describe("Indicates that Seam cannot reach Seam Bridge's LAN.")
+  },
+).describe(`
+    ---
+    resource_type: bridge_client_session
+    ---
+    Indicates that Seam cannot reach Seam Bridge's LAN.
+    `)
 
-export const no_communication_from_bridge = common_bridge_client_session_error
-  .extend({
+export const no_communication_from_bridge =
+  common_bridge_client_session_error.extend({
     error_code: z
       .literal('no_communication_from_bridge')
       .describe(error_code_description),
-  })
-  .describe('Indicates that Seam Bridge has stopped communicating with Seam.')
+  }).describe(`
+    ---
+    resource_type: bridge_client_session
+    ---
+    Indicates that Seam Bridge has stopped communicating with Seam.
+    `)
 
 export const bridge_client_session_error = z
   .discriminatedUnion('error_code', [

package/src/lib/seam/connect/models/user-identities/user-identity.ts

@@ -49,27 +49,28 @@ const acs_user_profile_does_not_match_user_identity =
       "Indicates that the ACS user's profile does not match the user identity's profile",
     )
 
-const user_identity_issue_with_acs_user = common_user_identity_error
-  .extend({
-    error_code: z
-      .literal('issue_with_acs_user')
-      .describe(
-        'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
-      ),
-    acs_user_id: z
-      .string()
-      .uuid()
-      .describe('ID of the access system user that has an issue.'),
-    acs_system_id: z
-      .string()
-      .uuid()
-      .describe(
-        'ID of the access system that the user identity is associated with.',
-      ),
-  })
-  .describe(
-    'Indicates that there is an issue with an access system user associated with this user identity.',
-  )
+const user_identity_issue_with_acs_user = common_user_identity_error.extend({
+  error_code: z
+    .literal('issue_with_acs_user')
+    .describe(
+      'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
+    ),
+  acs_user_id: z
+    .string()
+    .uuid()
+    .describe('ID of the access system user that has an issue.'),
+  acs_system_id: z
+    .string()
+    .uuid()
+    .describe(
+      'ID of the access system that the user identity is associated with.',
+    ),
+}).describe(`
+    ---
+    resource_type: user_identity
+    ---
+    Indicates that there is an issue with an access system user associated with this user identity.
+    `)
 
 const _user_identity_error_map = z.object({
   issue_with_acs_user: z

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

@@ -1926,6 +1926,8 @@ const openapi: OpenAPISpec = {
               discriminator: { propertyName: 'error_code' },
               oneOf: [
                 {
+                  description:
+                    'Indicates that Seam could not create one or more of the requested access methods for the access grant.',
                   properties: {
                     created_at: {
                       description:
@@ -1953,6 +1955,7 @@ const openapi: OpenAPISpec = {
                   },
                   required: ['created_at', 'message', 'error_code'],
                   type: 'object',
+                  'x-resource-type': 'access_grant',
                 },
               ],
             },
@@ -11724,6 +11727,7 @@ const openapi: OpenAPISpec = {
                     'is_bridge_socks_server_healthy',
                   ],
                   type: 'object',
+                  'x-resource-type': 'bridge_client_session',
                 },
                 {
                   description:
@@ -11749,6 +11753,7 @@ const openapi: OpenAPISpec = {
                   },
                   required: ['message', 'created_at', 'error_code'],
                   type: 'object',
+                  'x-resource-type': 'bridge_client_session',
                 },
               ],
             },
@@ -28227,6 +28232,7 @@ const openapi: OpenAPISpec = {
                         'acs_system_id',
                       ],
                       type: 'object',
+                      'x-resource-type': 'user_identity',
                     },
                   ],
                 },
@@ -33984,6 +33990,7 @@ const openapi: OpenAPISpec = {
                     'acs_system_id',
                   ],
                   type: 'object',
+                  'x-resource-type': 'user_identity',
                 },
               ],
             },
@@ -34342,7 +34349,6 @@ const openapi: OpenAPISpec = {
                     type: 'boolean',
                   },
                   max_time_rounding: {
-                    default: '1hour',
                     description:
                       'Maximum rounding adjustment. To create a daily-bound [offline access code](https://docs.seam.co/low-level-apis/smart-locks/access-codes/offline-access-codes) for devices that support this feature, set this parameter to `1d`.',
                     enum: ['1hour', '1day', '1h', '1d'],
@@ -36781,7 +36787,6 @@ const openapi: OpenAPISpec = {
                     type: 'boolean',
                   },
                   max_time_rounding: {
-                    default: '1hour',
                     description:
                       'Maximum rounding adjustment. To create a daily-bound [offline access code](https://docs.seam.co/low-level-apis/smart-locks/access-codes/offline-access-codes) for devices that support this feature, set this parameter to `1d`.',
                     enum: ['1hour', '1day', '1h', '1d'],
@@ -36935,7 +36940,6 @@ const openapi: OpenAPISpec = {
                     type: 'boolean',
                   },
                   max_time_rounding: {
-                    default: '1hour',
                     description:
                       'Maximum rounding adjustment. To create a daily-bound [offline access code](https://docs.seam.co/low-level-apis/smart-locks/access-codes/offline-access-codes) for devices that support this feature, set this parameter to `1d`.',
                     enum: ['1hour', '1day', '1h', '1d'],
@@ -37089,7 +37093,6 @@ const openapi: OpenAPISpec = {
                     type: 'boolean',
                   },
                   max_time_rounding: {
-                    default: '1hour',
                     description:
                       'Maximum rounding adjustment. To create a daily-bound [offline access code](https://docs.seam.co/low-level-apis/smart-locks/access-codes/offline-access-codes) for devices that support this feature, set this parameter to `1d`.',
                     enum: ['1hour', '1day', '1h', '1d'],
@@ -38491,6 +38494,8 @@ const openapi: OpenAPISpec = {
                             discriminator: { propertyName: 'error_code' },
                             oneOf: [
                               {
+                                description:
+                                  'Indicates that Seam could not create one or more of the requested access methods for the access grant.',
                                 properties: {
                                   created_at: {
                                     description:
@@ -38524,6 +38529,7 @@ const openapi: OpenAPISpec = {
                                   'error_code',
                                 ],
                                 type: 'object',
+                                'x-resource-type': 'access_grant',
                               },
                             ],
                           },
@@ -39200,6 +39206,8 @@ const openapi: OpenAPISpec = {
                             discriminator: { propertyName: 'error_code' },
                             oneOf: [
                               {
+                                description:
+                                  'Indicates that Seam could not create one or more of the requested access methods for the access grant.',
                                 properties: {
                                   created_at: {
                                     description:
@@ -39233,6 +39241,7 @@ const openapi: OpenAPISpec = {
                                   'error_code',
                                 ],
                                 type: 'object',
+                                'x-resource-type': 'access_grant',
                               },
                             ],
                           },
@@ -39955,6 +39964,8 @@ const openapi: OpenAPISpec = {
                               discriminator: { propertyName: 'error_code' },
                               oneOf: [
                                 {
+                                  description:
+                                    'Indicates that Seam could not create one or more of the requested access methods for the access grant.',
                                   properties: {
                                     created_at: {
                                       description:
@@ -39988,6 +39999,7 @@ const openapi: OpenAPISpec = {
                                     'error_code',
                                   ],
                                   type: 'object',
+                                  'x-resource-type': 'access_grant',
                                 },
                               ],
                             },
@@ -40702,6 +40714,8 @@ const openapi: OpenAPISpec = {
                               discriminator: { propertyName: 'error_code' },
                               oneOf: [
                                 {
+                                  description:
+                                    'Indicates that Seam could not create one or more of the requested access methods for the access grant.',
                                   properties: {
                                     created_at: {
                                       description:
@@ -40735,6 +40749,7 @@ const openapi: OpenAPISpec = {
                                     'error_code',
                                   ],
                                   type: 'object',
+                                  'x-resource-type': 'access_grant',
                                 },
                               ],
                             },
@@ -85562,6 +85577,7 @@ const openapi: OpenAPISpec = {
                                   'acs_system_id',
                                 ],
                                 type: 'object',
+                                'x-resource-type': 'user_identity',
                               },
                             ],
                           },
@@ -85811,6 +85827,7 @@ const openapi: OpenAPISpec = {
                                   'acs_system_id',
                                 ],
                                 type: 'object',
+                                'x-resource-type': 'user_identity',
                               },
                             ],
                           },
@@ -86088,6 +86105,7 @@ const openapi: OpenAPISpec = {
                                     'acs_system_id',
                                   ],
                                   type: 'object',
+                                  'x-resource-type': 'user_identity',
                                 },
                               ],
                             },
@@ -86360,6 +86378,7 @@ const openapi: OpenAPISpec = {
                                     'acs_system_id',
                                   ],
                                   type: 'object',
+                                  'x-resource-type': 'user_identity',
                                 },
                               ],
                             },

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

@@ -43,7 +43,7 @@ export type Routes = {
       /** Indicates whether the [offline access code](https://docs.seam.co/low-level-apis/smart-locks/access-codes/offline-access-codes) is a single-use access code. */
       is_one_time_use?: boolean | undefined
       /** Maximum rounding adjustment. To create a daily-bound [offline access code](https://docs.seam.co/low-level-apis/smart-locks/access-codes/offline-access-codes) for devices that support this feature, set this parameter to `1d`. */
-      max_time_rounding?: '1hour' | '1day' | '1h' | '1d'
+      max_time_rounding?: ('1hour' | '1day' | '1h' | '1d') | undefined
     }
     commonParams: {}
     formData: {}
@@ -11161,7 +11161,9 @@ export type Routes = {
       /** Indicates whether the [offline access code](https://docs.seam.co/low-level-apis/smart-locks/access-codes/offline-access-codes) is a single-use access code. */
       is_one_time_use?: boolean | undefined
       /** Maximum rounding adjustment. To create a daily-bound [offline access code](https://docs.seam.co/low-level-apis/smart-locks/access-codes/offline-access-codes) for devices that support this feature, set this parameter to `1d`. */
-      max_time_rounding?: ('1hour' | '1day' | '1h' | '1d') | undefined
+      max_time_rounding?:
+        | (('1hour' | '1day' | '1h' | '1d') | undefined)
+        | undefined
       /** ID of the access code that you want to update. */
       access_code_id: string
       /** ID of the device containing the access code that you want to update. */