@seamapi/types 1.770.0 → 1.771.0

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

@@ -825,6 +825,11 @@ export type Routes = {
                     type: 'bridge_disconnected';
                     /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
                     message: string;
+                } | {
+                    /** Error type to indicate that encoding was interrupted, for example, if the card was removed from the encoder before writing was complete. */
+                    type: 'encoding_interrupted';
+                    /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
+                    message: string;
                 };
             } | {
                 /** ID of the action attempt. */
@@ -3223,6 +3228,11 @@ export type Routes = {
                     type: 'bridge_disconnected';
                     /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
                     message: string;
+                } | {
+                    /** Error type to indicate that encoding was interrupted, for example, if the card was removed from the encoder before writing was complete. */
+                    type: 'encoding_interrupted';
+                    /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
+                    message: string;
                 };
             } | {
                 /** ID of the action attempt. */
@@ -7316,6 +7326,11 @@ export type Routes = {
                     type: 'bridge_disconnected';
                     /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
                     message: string;
+                } | {
+                    /** Error type to indicate that encoding was interrupted, for example, if the card was removed from the encoder before writing was complete. */
+                    type: 'encoding_interrupted';
+                    /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
+                    message: string;
                 };
             } | {
                 /** ID of the action attempt. */
@@ -9750,6 +9765,11 @@ export type Routes = {
                     type: 'bridge_disconnected';
                     /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
                     message: string;
+                } | {
+                    /** Error type to indicate that encoding was interrupted, for example, if the card was removed from the encoder before writing was complete. */
+                    type: 'encoding_interrupted';
+                    /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
+                    message: string;
                 };
             } | {
                 /** ID of the action attempt. */
@@ -14365,6 +14385,11 @@ export type Routes = {
                     type: 'bridge_disconnected';
                     /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
                     message: string;
+                } | {
+                    /** Error type to indicate that encoding was interrupted, for example, if the card was removed from the encoder before writing was complete. */
+                    type: 'encoding_interrupted';
+                    /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
+                    message: string;
                 };
             } | {
                 /** ID of the action attempt. */
@@ -20939,6 +20964,11 @@ export type Routes = {
                     type: 'bridge_disconnected';
                     /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
                     message: string;
+                } | {
+                    /** Error type to indicate that encoding was interrupted, for example, if the card was removed from the encoder before writing was complete. */
+                    type: 'encoding_interrupted';
+                    /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
+                    message: string;
                 };
             } | {
                 /** ID of the action attempt. */
@@ -22377,6 +22407,11 @@ export type Routes = {
                     type: 'bridge_disconnected';
                     /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
                     message: string;
+                } | {
+                    /** Error type to indicate that encoding was interrupted, for example, if the card was removed from the encoder before writing was complete. */
+                    type: 'encoding_interrupted';
+                    /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
+                    message: string;
                 };
             } | {
                 /** ID of the action attempt. */
@@ -22927,7 +22962,7 @@ export type Routes = {
             /** ID of the `acs_encoder` that will be used in the next request to encode the `acs_credential`. */
             acs_encoder_id: string;
             /** Code of the error to simulate. */
-            error_code?: 'no_credential_on_encoder';
+            error_code?: 'no_credential_on_encoder' | 'encoding_interrupted';
         } | {
             /** ID of the `acs_encoder` that will be used in the next request to encode the `acs_credential`. */
             acs_encoder_id: string;
@@ -24277,6 +24312,11 @@ export type Routes = {
                     type: 'bridge_disconnected';
                     /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
                     message: string;
+                } | {
+                    /** Error type to indicate that encoding was interrupted, for example, if the card was removed from the encoder before writing was complete. */
+                    type: 'encoding_interrupted';
+                    /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
+                    message: string;
                 };
             } | {
                 /** ID of the action attempt. */
@@ -27644,6 +27684,11 @@ export type Routes = {
                     type: 'bridge_disconnected';
                     /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
                     message: string;
+                } | {
+                    /** Error type to indicate that encoding was interrupted, for example, if the card was removed from the encoder before writing was complete. */
+                    type: 'encoding_interrupted';
+                    /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
+                    message: string;
                 };
             } | {
                 /** ID of the action attempt. */
@@ -28975,6 +29020,11 @@ export type Routes = {
                     type: 'bridge_disconnected';
                     /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
                     message: string;
+                } | {
+                    /** Error type to indicate that encoding was interrupted, for example, if the card was removed from the encoder before writing was complete. */
+                    type: 'encoding_interrupted';
+                    /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
+                    message: string;
                 };
             } | {
                 /** ID of the action attempt. */
@@ -41827,6 +41877,11 @@ export type Routes = {
                     type: 'bridge_disconnected';
                     /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
                     message: string;
+                } | {
+                    /** Error type to indicate that encoding was interrupted, for example, if the card was removed from the encoder before writing was complete. */
+                    type: 'encoding_interrupted';
+                    /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
+                    message: string;
                 };
             } | {
                 /** ID of the action attempt. */
@@ -48504,6 +48559,11 @@ export type Routes = {
                     type: 'bridge_disconnected';
                     /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
                     message: string;
+                } | {
+                    /** Error type to indicate that encoding was interrupted, for example, if the card was removed from the encoder before writing was complete. */
+                    type: 'encoding_interrupted';
+                    /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
+                    message: string;
                 };
             } | {
                 /** ID of the action attempt. */
@@ -49836,6 +49896,11 @@ export type Routes = {
                     type: 'bridge_disconnected';
                     /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
                     message: string;
+                } | {
+                    /** Error type to indicate that encoding was interrupted, for example, if the card was removed from the encoder before writing was complete. */
+                    type: 'encoding_interrupted';
+                    /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
+                    message: string;
                 };
             } | {
                 /** ID of the action attempt. */
@@ -51166,6 +51231,11 @@ export type Routes = {
                     type: 'bridge_disconnected';
                     /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
                     message: string;
+                } | {
+                    /** Error type to indicate that encoding was interrupted, for example, if the card was removed from the encoder before writing was complete. */
+                    type: 'encoding_interrupted';
+                    /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
+                    message: string;
                 };
             } | {
                 /** ID of the action attempt. */
@@ -52498,6 +52568,11 @@ export type Routes = {
                     type: 'bridge_disconnected';
                     /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
                     message: string;
+                } | {
+                    /** Error type to indicate that encoding was interrupted, for example, if the card was removed from the encoder before writing was complete. */
+                    type: 'encoding_interrupted';
+                    /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
+                    message: string;
                 };
             } | {
                 /** ID of the action attempt. */
@@ -56529,6 +56604,11 @@ export type Routes = {
                     type: 'bridge_disconnected';
                     /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
                     message: string;
+                } | {
+                    /** Error type to indicate that encoding was interrupted, for example, if the card was removed from the encoder before writing was complete. */
+                    type: 'encoding_interrupted';
+                    /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
+                    message: string;
                 };
             } | {
                 /** ID of the action attempt. */
@@ -57880,6 +57960,11 @@ export type Routes = {
                     type: 'bridge_disconnected';
                     /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
                     message: string;
+                } | {
+                    /** Error type to indicate that encoding was interrupted, for example, if the card was removed from the encoder before writing was complete. */
+                    type: 'encoding_interrupted';
+                    /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
+                    message: string;
                 };
             } | {
                 /** ID of the action attempt. */
@@ -59287,6 +59372,11 @@ export type Routes = {
                     type: 'bridge_disconnected';
                     /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
                     message: string;
+                } | {
+                    /** Error type to indicate that encoding was interrupted, for example, if the card was removed from the encoder before writing was complete. */
+                    type: 'encoding_interrupted';
+                    /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
+                    message: string;
                 };
             } | {
                 /** ID of the action attempt. */
@@ -61588,6 +61678,11 @@ export type Routes = {
                     type: 'bridge_disconnected';
                     /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
                     message: string;
+                } | {
+                    /** Error type to indicate that encoding was interrupted, for example, if the card was removed from the encoder before writing was complete. */
+                    type: 'encoding_interrupted';
+                    /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
+                    message: string;
                 };
             } | {
                 /** ID of the action attempt. */
@@ -65757,6 +65852,129 @@ export type Routes = {
         };
         maxDuration: undefined;
     };
+    '/seam/customer/v1/portals/update': {
+        route: '/seam/customer/v1/portals/update';
+        method: 'PATCH' | 'POST';
+        queryParams: {};
+        jsonBody: {
+            /** ID of the customer portal to update. */
+            customer_portal_id: string;
+            /** Partial portal configuration to merge with the existing configuration. */
+            portal_configuration: {
+                features?: {
+                    /** Configuration for the connect accounts feature. */
+                    connect?: {
+                        /** Whether to exclude this feature from the portal. */
+                        exclude?: boolean;
+                        /** List of provider keys to allow for the connect feature. These providers will be shown when the customer tries to connect an account. */
+                        accepted_providers?: string[] | undefined;
+                        /** List of provider keys to exclude from the connect feature. These providers will not be shown when the customer tries to connect an account. */
+                        excluded_providers?: string[] | undefined;
+                    };
+                    /** Configuration for the manage feature. */
+                    manage?: {
+                        /** Whether to exclude this feature from the portal. */
+                        exclude?: boolean;
+                        /** Indicates whether the customer can manage reservations for their properties. */
+                        exclude_reservation_management?: boolean;
+                        /** Indicates whether to exclude technical details from reservation views. */
+                        exclude_reservation_technical_details?: boolean;
+                        /** Indicates whether the customer can manage staff for their properties. */
+                        exclude_staff_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. */
+                            allowed_events?: string[] | undefined;
+                            /** List of event types that are pre-selected in the events filter when the user first loads the events tab. */
+                            default_events?: string[] | undefined;
+                        } | undefined;
+                    };
+                    /** Configuration for the manage devices feature.
+                  ---
+                  deprecated: Use `manage` instead.
+                  --- */
+                    manage_devices?: {
+                        /** Whether to exclude this feature from the portal. */
+                        exclude?: boolean;
+                    };
+                    /** Configuration for the organize feature. */
+                    organize?: {
+                        /** Whether to exclude this feature from the portal. */
+                        exclude?: boolean;
+                    };
+                    /** Configuration for the configure feature. */
+                    configure?: {
+                        /** Whether to exclude this feature from the portal. */
+                        exclude?: boolean;
+                        /** Indicates whether the customer can customize the access automation rules for their properties. */
+                        allow_access_automation_rule_customization?: boolean;
+                        /** Indicates whether the customer can customize the climate automation rules for their properties. */
+                        allow_climate_automation_rule_customization?: boolean;
+                        /** Indicates whether the customer can customize the Instant Key profile for their properties. */
+                        allow_instant_key_customization?: boolean;
+                    };
+                } | undefined;
+                /** Whether the portal is embedded in another application. */
+                is_embedded?: boolean | undefined;
+                /** Configuration for the landing page when the portal loads. */
+                landing_page?: ({
+                    manage?: (({
+                        space_key: string;
+                    } | {
+                        property_key: string;
+                    } | {
+                        room_key: string;
+                    } | {
+                        common_area_key: string;
+                    } | {
+                        unit_key: string;
+                    } | {
+                        facility_key: string;
+                    } | {
+                        building_key: string;
+                    } | {
+                        listing_key: string;
+                    } | {
+                        property_listing_key: string;
+                    } | {
+                        site_key: string;
+                    }) | ({
+                        reservation_key: string;
+                    } | {
+                        booking_key: string;
+                    } | {
+                        access_grant_key: string;
+                    })) | undefined;
+                } | undefined) | undefined;
+                /** The locale to use for the portal. */
+                locale?: (('en-US' | 'pt-PT' | 'fr-FR' | 'it-IT' | 'es-ES') | undefined) | undefined;
+                /** Whether to exclude the option to select a locale within the portal UI. */
+                exclude_locale_picker?: boolean | undefined;
+                /** The ID of the customization profile to use for the portal. */
+                customization_profile_id?: (string | undefined) | undefined;
+                /** Filter configuration for resources based on their custom_metadata. Each filter specifies a field, operation, and value to match against resource custom_metadata. */
+                customer_resources_filters?: ({
+                    /** The custom_metadata field name to filter on. */
+                    field: string;
+                    /** The comparison operation. Currently only '=' is supported. */
+                    operation: '=';
+                    /** The value to compare against. */
+                    value: string | boolean;
+                }[] | undefined) | undefined;
+                /** Navigation mode for the portal. 'restricted' tells frontend to hide navigation UI, typically used for embedded deep links. */
+                navigation_mode?: ('full' | 'restricted') | undefined;
+                /** Deep link target resource for initial redirect. When set, the portal will navigate directly to the specified resource. */
+                deep_link?: ({
+                    resource_type: 'reservation' | 'space';
+                    resource_key: string;
+                } | undefined) | undefined;
+            };
+        };
+        commonParams: {};
+        formData: {};
+        jsonResponse: {};
+        maxDuration: undefined;
+    };
     '/seam/customer/v1/reservations/get': {
         route: '/seam/customer/v1/reservations/get';
         method: 'GET' | 'POST';
@@ -70111,6 +70329,11 @@ export type Routes = {
                     type: 'bridge_disconnected';
                     /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
                     message: string;
+                } | {
+                    /** Error type to indicate that encoding was interrupted, for example, if the card was removed from the encoder before writing was complete. */
+                    type: 'encoding_interrupted';
+                    /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
+                    message: string;
                 };
             } | {
                 /** ID of the action attempt. */
@@ -71447,6 +71670,11 @@ export type Routes = {
                     type: 'bridge_disconnected';
                     /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
                     message: string;
+                } | {
+                    /** Error type to indicate that encoding was interrupted, for example, if the card was removed from the encoder before writing was complete. */
+                    type: 'encoding_interrupted';
+                    /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
+                    message: string;
                 };
             } | {
                 /** ID of the action attempt. */
@@ -72889,6 +73117,11 @@ export type Routes = {
                     type: 'bridge_disconnected';
                     /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
                     message: string;
+                } | {
+                    /** Error type to indicate that encoding was interrupted, for example, if the card was removed from the encoder before writing was complete. */
+                    type: 'encoding_interrupted';
+                    /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
+                    message: string;
                 };
             } | {
                 /** ID of the action attempt. */
@@ -75576,6 +75809,11 @@ export type Routes = {
                     type: 'bridge_disconnected';
                     /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
                     message: string;
+                } | {
+                    /** Error type to indicate that encoding was interrupted, for example, if the card was removed from the encoder before writing was complete. */
+                    type: 'encoding_interrupted';
+                    /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
+                    message: string;
                 };
             } | {
                 /** ID of the action attempt. */
@@ -76916,6 +77154,11 @@ export type Routes = {
                     type: 'bridge_disconnected';
                     /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
                     message: string;
+                } | {
+                    /** Error type to indicate that encoding was interrupted, for example, if the card was removed from the encoder before writing was complete. */
+                    type: 'encoding_interrupted';
+                    /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
+                    message: string;
                 };
             } | {
                 /** ID of the action attempt. */
@@ -80937,6 +81180,11 @@ export type Routes = {
                     type: 'bridge_disconnected';
                     /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
                     message: string;
+                } | {
+                    /** Error type to indicate that encoding was interrupted, for example, if the card was removed from the encoder before writing was complete. */
+                    type: 'encoding_interrupted';
+                    /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
+                    message: string;
                 };
             } | {
                 /** ID of the action attempt. */
@@ -82472,6 +82720,11 @@ export type Routes = {
                     type: 'bridge_disconnected';
                     /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
                     message: string;
+                } | {
+                    /** Error type to indicate that encoding was interrupted, for example, if the card was removed from the encoder before writing was complete. */
+                    type: 'encoding_interrupted';
+                    /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
+                    message: string;
                 };
             } | {
                 /** ID of the action attempt. */
@@ -83835,6 +84088,11 @@ export type Routes = {
                     type: 'bridge_disconnected';
                     /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
                     message: string;
+                } | {
+                    /** Error type to indicate that encoding was interrupted, for example, if the card was removed from the encoder before writing was complete. */
+                    type: 'encoding_interrupted';
+                    /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
+                    message: string;
                 };
             } | {
                 /** ID of the action attempt. */
@@ -85310,6 +85568,11 @@ export type Routes = {
                     type: 'bridge_disconnected';
                     /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
                     message: string;
+                } | {
+                    /** Error type to indicate that encoding was interrupted, for example, if the card was removed from the encoder before writing was complete. */
+                    type: 'encoding_interrupted';
+                    /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
+                    message: string;
                 };
             } | {
                 /** ID of the action attempt. */
@@ -92783,6 +93046,11 @@ export type Routes = {
                         type: 'bridge_disconnected';
                         /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
                         message: string;
+                    } | {
+                        /** Error type to indicate that encoding was interrupted, for example, if the card was removed from the encoder before writing was complete. */
+                        type: 'encoding_interrupted';
+                        /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
+                        message: string;
                     };
                 } | {
                     /** ID of the action attempt. */
@@ -99644,6 +99912,11 @@ export type Routes = {
                     type: 'bridge_disconnected';
                     /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
                     message: string;
+                } | {
+                    /** Error type to indicate that encoding was interrupted, for example, if the card was removed from the encoder before writing was complete. */
+                    type: 'encoding_interrupted';
+                    /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
+                    message: string;
                 };
             } | {
                 /** ID of the action attempt. */

package/package.json

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

package/src/lib/seam/connect/models/action-attempts/encode-credential.ts

@@ -107,6 +107,23 @@ const bridge_disconnected_error = z
     'Error to indicate that the Seam Bridge is disconnected or cannot reach the access control system.',
   )
 
+const encoding_interrupted_error = z
+  .object({
+    type: z
+      .literal('encoding_interrupted')
+      .describe(
+        'Error type to indicate that encoding was interrupted, for example, if the card was removed from the encoder before writing was complete.',
+      ),
+    message: z
+      .string()
+      .describe(
+        'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
+      ),
+  })
+  .describe(
+    'Error to indicate that encoding was interrupted, for example, if the card was removed from the encoder before writing was complete.',
+  )
+
 const error = z.union([
   ...common_action_attempt_errors,
   no_credential_on_encoder_error,
@@ -115,6 +132,7 @@ const error = z.union([
   encoder_not_online_error,
   encoder_timeout_error,
   bridge_disconnected_error,
+  encoding_interrupted_error,
 ])
 
 const result = acs_credential