@seamapi/types 1.1115.0 → 1.1117.0

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

@@ -46673,6 +46673,8 @@ export type Routes = {
                     exclude_reservation_technical_details?: boolean;
                     /** Indicates whether the customer can manage staff for their properties. */
                     exclude_staff_management?: boolean;
+                    /** Indicates whether to prevent the customer from converting their devices between managed and unmanaged. Managed devices are billed. */
+                    exclude_device_management?: boolean;
                     /** Configuration for event type filtering in the manage feature. */
                     events?: {
                         /** List of event types to show in the events filter. When set, only these event types will be available. Leave empty to show all events. */
@@ -55311,7 +55313,7 @@ export type Routes = {
                 /** Why access was denied, when the provider reports a determinable cause. Omitted when unknown. */
                 reason?: {
                     /** Normalized reason a lock denied access. Provider-agnostic; not all providers report every value. */
-                    reason_code: 'unknown_code' | 'expired_code' | 'blocklisted_code' | 'too_many_attempts' | 'blocked_by_privacy_mode' | 'credential_error';
+                    reason_code: 'unknown_code' | 'expired_code' | 'blocklisted_code' | 'too_many_attempts' | 'blocked_by_privacy_mode' | 'credential_error' | 'connection_error';
                     /** Human-readable explanation of why access was denied. */
                     message: string;
                 } | undefined;
@@ -58946,7 +58948,7 @@ export type Routes = {
                 /** Why access was denied, when the provider reports a determinable cause. Omitted when unknown. */
                 reason?: {
                     /** Normalized reason a lock denied access. Provider-agnostic; not all providers report every value. */
-                    reason_code: 'unknown_code' | 'expired_code' | 'blocklisted_code' | 'too_many_attempts' | 'blocked_by_privacy_mode' | 'credential_error';
+                    reason_code: 'unknown_code' | 'expired_code' | 'blocklisted_code' | 'too_many_attempts' | 'blocked_by_privacy_mode' | 'credential_error' | 'connection_error';
                     /** Human-readable explanation of why access was denied. */
                     message: string;
                 } | undefined;
@@ -95473,7 +95475,7 @@ export type Routes = {
                 /** Why access was denied, when the provider reports a determinable cause. Omitted when unknown. */
                 reason?: {
                     /** Normalized reason a lock denied access. Provider-agnostic; not all providers report every value. */
-                    reason_code: 'unknown_code' | 'expired_code' | 'blocklisted_code' | 'too_many_attempts' | 'blocked_by_privacy_mode' | 'credential_error';
+                    reason_code: 'unknown_code' | 'expired_code' | 'blocklisted_code' | 'too_many_attempts' | 'blocked_by_privacy_mode' | 'credential_error' | 'connection_error';
                     /** Human-readable explanation of why access was denied. */
                     message: string;
                 } | undefined;
@@ -95916,6 +95918,8 @@ export type Routes = {
                         exclude_reservation_technical_details?: boolean;
                         /** Indicates whether the customer can manage staff for their properties. */
                         exclude_staff_management?: boolean;
+                        /** Indicates whether to prevent the customer from converting their devices between managed and unmanaged. Managed devices are billed. */
+                        exclude_device_management?: boolean;
                         /** Configuration for event type filtering in the manage feature. */
                         events?: {
                             /** List of event types to show in the events filter. When set, only these event types will be available. Leave empty to show all events. */
@@ -96069,6 +96073,8 @@ export type Routes = {
                         exclude_reservation_technical_details?: boolean;
                         /** Indicates whether the customer can manage staff for their properties. */
                         exclude_staff_management?: boolean;
+                        /** Indicates whether to prevent the customer from converting their devices between managed and unmanaged. Managed devices are billed. */
+                        exclude_device_management?: boolean;
                         /** Configuration for event type filtering in the manage feature. */
                         events?: {
                             /** List of event types to show in the events filter. When set, only these event types will be available. Leave empty to show all events. */
@@ -97280,6 +97286,25 @@ export type Routes = {
         };
         maxDuration: undefined;
     };
+    '/seam/mobile_sdk/v1/acs/credentials/get_unlock_result': {
+        route: '/seam/mobile_sdk/v1/acs/credentials/get_unlock_result';
+        method: 'POST';
+        queryParams: {};
+        jsonBody: {
+            acs_credential_id: string;
+            unlock_attempted_at: string;
+        };
+        commonParams: {};
+        formData: {};
+        jsonResponse: {
+            unlock_result: {
+                status: 'granted' | 'denied' | 'pending' | 'failed';
+                acs_entrance_id?: string | undefined;
+                occurred_at?: string | undefined;
+            };
+        };
+        maxDuration: undefined;
+    };
     '/seam/mobile_sdk/v1/acs/credentials/list': {
         route: '/seam/mobile_sdk/v1/acs/credentials/list';
         method: 'GET' | 'POST';
@@ -101164,7 +101189,7 @@ export type Routes = {
                 /** Why access was denied, when the provider reports a determinable cause. Omitted when unknown. */
                 reason?: {
                     /** Normalized reason a lock denied access. Provider-agnostic; not all providers report every value. */
-                    reason_code: 'unknown_code' | 'expired_code' | 'blocklisted_code' | 'too_many_attempts' | 'blocked_by_privacy_mode' | 'credential_error';
+                    reason_code: 'unknown_code' | 'expired_code' | 'blocklisted_code' | 'too_many_attempts' | 'blocked_by_privacy_mode' | 'credential_error' | 'connection_error';
                     /** Human-readable explanation of why access was denied. */
                     message: string;
                 } | undefined;
@@ -158131,7 +158156,7 @@ export type Routes = {
                     /** Why access was denied, when the provider reports a determinable cause. Omitted when unknown. */
                     reason?: {
                         /** Normalized reason a lock denied access. Provider-agnostic; not all providers report every value. */
-                        reason_code: 'unknown_code' | 'expired_code' | 'blocklisted_code' | 'too_many_attempts' | 'blocked_by_privacy_mode' | 'credential_error';
+                        reason_code: 'unknown_code' | 'expired_code' | 'blocklisted_code' | 'too_many_attempts' | 'blocked_by_privacy_mode' | 'credential_error' | 'connection_error';
                         /** Human-readable explanation of why access was denied. */
                         message: string;
                     } | undefined;

package/package.json

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

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

@@ -45,6 +45,12 @@ const base_manage_feature = base_feature.extend({
     .describe(
       'Indicates whether the customer can manage staff for their properties.',
     ),
+  exclude_device_management: z
+    .boolean()
+    .default(false)
+    .describe(
+      'Indicates whether to prevent the customer from converting their devices between managed and unmanaged. Managed devices are billed.',
+    ),
   events: z
     .object({
       allowed_events: z
@@ -260,6 +266,7 @@ export const portal_configuration = portal_configuration_base
         exclude_reservation_management: false,
         exclude_reservation_technical_details: false,
         exclude_staff_management: false,
+        exclude_device_management: false,
       },
       manage_devices: {
         exclude: false,

package/src/lib/seam/connect/models/events/common.ts

@@ -65,6 +65,7 @@ export const lock_access_denied_reason = z
     'too_many_attempts',
     'blocked_by_privacy_mode',
     'credential_error',
+    'connection_error',
   ])
   .describe(
     'Normalized reason a lock denied access. Provider-agnostic; not all providers report every value.',

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

@@ -29761,6 +29761,7 @@ const openapi: OpenAPISpec = {
                       'too_many_attempts',
                       'blocked_by_privacy_mode',
                       'credential_error',
+                      'connection_error',
                     ],
                     type: 'string',
                   },
@@ -51448,6 +51449,7 @@ const openapi: OpenAPISpec = {
                         connect: { exclude: false },
                         manage: {
                           exclude: false,
+                          exclude_device_management: false,
                           exclude_reservation_management: false,
                           exclude_reservation_technical_details: false,
                           exclude_staff_management: false,
@@ -51683,6 +51685,12 @@ const openapi: OpenAPISpec = {
                                   'Whether to exclude this feature from the portal.',
                                 type: 'boolean',
                               },
+                              exclude_device_management: {
+                                default: false,
+                                description:
+                                  'Indicates whether to prevent the customer from converting their devices between managed and unmanaged. Managed devices are billed.',
+                                type: 'boolean',
+                              },
                               exclude_reservation_management: {
                                 default: false,
                                 description:
@@ -57091,6 +57099,7 @@ const openapi: OpenAPISpec = {
           { api_key: [] },
           { pat_with_workspace: [] },
           { console_session_with_workspace: [] },
+          { client_session_with_customer: [] },
         ],
         summary: '/devices/unmanaged/update',
         tags: ['/devices'],
@@ -66740,6 +66749,12 @@ const openapi: OpenAPISpec = {
                                     'Whether to exclude this feature from the portal.',
                                   type: 'boolean',
                                 },
+                                exclude_device_management: {
+                                  default: false,
+                                  description:
+                                    'Indicates whether to prevent the customer from converting their devices between managed and unmanaged. Managed devices are billed.',
+                                  type: 'boolean',
+                                },
                                 exclude_reservation_management: {
                                   default: false,
                                   description:
@@ -67206,6 +67221,12 @@ const openapi: OpenAPISpec = {
                                   'Whether to exclude this feature from the portal.',
                                 type: 'boolean',
                               },
+                              exclude_device_management: {
+                                default: false,
+                                description:
+                                  'Indicates whether to prevent the customer from converting their devices between managed and unmanaged. Managed devices are billed.',
+                                type: 'boolean',
+                              },
                               exclude_reservation_management: {
                                 default: false,
                                 description:
@@ -69379,6 +69400,72 @@ const openapi: OpenAPISpec = {
         'x-undocumented': 'Seam support agent only.',
       },
     },
+    '/seam/mobile_sdk/v1/acs/credentials/get_unlock_result': {
+      post: {
+        description:
+          "Returns the lock's decision for a mobile key unlock attempt, read from the access system's event feed. Returns `pending` until the access system reports the attempt, and `failed` if it hasn't within 30 seconds of the attempt.",
+        operationId: 'seamMobileSdkV1AcsCredentialsGetUnlockResultPost',
+        requestBody: {
+          content: {
+            'application/json': {
+              schema: {
+                properties: {
+                  acs_credential_id: { format: 'uuid', type: 'string' },
+                  unlock_attempted_at: { format: 'date-time', type: 'string' },
+                },
+                required: ['acs_credential_id', 'unlock_attempted_at'],
+                type: 'object',
+              },
+            },
+          },
+        },
+        responses: {
+          '200': {
+            content: {
+              'application/json': {
+                schema: {
+                  properties: {
+                    ok: { type: 'boolean' },
+                    unlock_result: {
+                      properties: {
+                        acs_entrance_id: { format: 'uuid', type: 'string' },
+                        occurred_at: { format: 'date-time', type: 'string' },
+                        status: {
+                          enum: ['granted', 'denied', 'pending', 'failed'],
+                          type: 'string',
+                        },
+                      },
+                      required: ['status'],
+                      type: 'object',
+                    },
+                  },
+                  required: ['unlock_result', 'ok'],
+                  type: 'object',
+                },
+              },
+            },
+            description: 'OK',
+          },
+          '400': { description: 'Bad Request' },
+          '401': { description: 'Unauthorized' },
+        },
+        security: [{ client_session: [] }],
+        summary: '/seam/mobile_sdk/v1/acs/credentials/get_unlock_result',
+        tags: ['/acs'],
+        'x-fern-sdk-group-name': [
+          'seam',
+          'mobile_sdk',
+          'v1',
+          'acs',
+          'credentials',
+        ],
+        'x-fern-sdk-method-name': 'get_unlock_result',
+        'x-fern-sdk-return-value': 'unlock_result',
+        'x-response-key': 'unlock_result',
+        'x-title': 'Get Unlock Result',
+        'x-undocumented': 'Mobile SDK only.',
+      },
+    },
     '/seam/mobile_sdk/v1/acs/credentials/list': {
       get: {
         description:

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

@@ -54511,6 +54511,8 @@ export type Routes = {
           exclude_reservation_technical_details?: boolean
           /** Indicates whether the customer can manage staff for their properties. */
           exclude_staff_management?: boolean
+          /** Indicates whether to prevent the customer from converting their devices between managed and unmanaged. Managed devices are billed. */
+          exclude_device_management?: boolean
           /** Configuration for event type filtering in the manage feature. */
           events?:
             | {
@@ -66509,6 +66511,7 @@ export type Routes = {
                         | 'too_many_attempts'
                         | 'blocked_by_privacy_mode'
                         | 'credential_error'
+                        | 'connection_error'
                       /** Human-readable explanation of why access was denied. */
                       message: string
                     }
@@ -70809,6 +70812,7 @@ export type Routes = {
                     | 'too_many_attempts'
                     | 'blocked_by_privacy_mode'
                     | 'credential_error'
+                    | 'connection_error'
                   /** Human-readable explanation of why access was denied. */
                   message: string
                 }
@@ -114021,6 +114025,7 @@ export type Routes = {
                     | 'too_many_attempts'
                     | 'blocked_by_privacy_mode'
                     | 'credential_error'
+                    | 'connection_error'
                   /** Human-readable explanation of why access was denied. */
                   message: string
                 }
@@ -114521,6 +114526,8 @@ export type Routes = {
             exclude_reservation_technical_details?: boolean
             /** Indicates whether the customer can manage staff for their properties. */
             exclude_staff_management?: boolean
+            /** Indicates whether to prevent the customer from converting their devices between managed and unmanaged. Managed devices are billed. */
+            exclude_device_management?: boolean
             /** Configuration for event type filtering in the manage feature. */
             events?:
               | {
@@ -114734,6 +114741,8 @@ export type Routes = {
                 exclude_reservation_technical_details?: boolean
                 /** Indicates whether the customer can manage staff for their properties. */
                 exclude_staff_management?: boolean
+                /** Indicates whether to prevent the customer from converting their devices between managed and unmanaged. Managed devices are billed. */
+                exclude_device_management?: boolean
                 /** Configuration for event type filtering in the manage feature. */
                 events?:
                   | {
@@ -116087,6 +116096,25 @@ export type Routes = {
     }
     maxDuration: undefined
   }
+  '/seam/mobile_sdk/v1/acs/credentials/get_unlock_result': {
+    route: '/seam/mobile_sdk/v1/acs/credentials/get_unlock_result'
+    method: 'POST'
+    queryParams: {}
+    jsonBody: {
+      acs_credential_id: string
+      unlock_attempted_at: string
+    }
+    commonParams: {}
+    formData: {}
+    jsonResponse: {
+      unlock_result: {
+        status: 'granted' | 'denied' | 'pending' | 'failed'
+        acs_entrance_id?: string | undefined
+        occurred_at?: string | undefined
+      }
+    }
+    maxDuration: undefined
+  }
   '/seam/mobile_sdk/v1/acs/credentials/list': {
     route: '/seam/mobile_sdk/v1/acs/credentials/list'
     method: 'GET' | 'POST'
@@ -120705,6 +120733,7 @@ export type Routes = {
                     | 'too_many_attempts'
                     | 'blocked_by_privacy_mode'
                     | 'credential_error'
+                    | 'connection_error'
                   /** Human-readable explanation of why access was denied. */
                   message: string
                 }
@@ -187758,6 +187787,7 @@ export type Routes = {
                           | 'too_many_attempts'
                           | 'blocked_by_privacy_mode'
                           | 'credential_error'
+                          | 'connection_error'
                         /** Human-readable explanation of why access was denied. */
                         message: string
                       }