@seamapi/types 1.770.0 → 1.771.0

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

@@ -991,6 +991,12 @@ export type Routes = {
                   /** 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. */
@@ -3711,6 +3717,12 @@ export type Routes = {
                   /** 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. */
@@ -8335,6 +8347,12 @@ export type Routes = {
                   /** 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. */
@@ -11091,6 +11109,12 @@ export type Routes = {
                   /** 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. */
@@ -16511,6 +16535,12 @@ export type Routes = {
                   /** 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. */
@@ -24282,6 +24312,12 @@ export type Routes = {
                   /** 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. */
@@ -25934,6 +25970,12 @@ export type Routes = {
                   /** 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. */
@@ -26529,7 +26571,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`. */
@@ -28140,6 +28182,12 @@ export type Routes = {
                   /** 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. */
@@ -32086,6 +32134,12 @@ export type Routes = {
                   /** 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. */
@@ -33627,6 +33681,12 @@ export type Routes = {
                   /** 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. */
@@ -49601,6 +49661,12 @@ export type Routes = {
                   /** 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. */
@@ -57920,6 +57986,12 @@ export type Routes = {
                   /** 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. */
@@ -59462,6 +59534,12 @@ export type Routes = {
                   /** 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. */
@@ -61002,6 +61080,12 @@ export type Routes = {
                   /** 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. */
@@ -62544,6 +62628,12 @@ export type Routes = {
                   /** 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. */
@@ -67479,6 +67569,12 @@ export type Routes = {
                   /** 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. */
@@ -69040,6 +69136,12 @@ export type Routes = {
                   /** 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. */
@@ -70657,6 +70759,12 @@ export type Routes = {
                   /** 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. */
@@ -73234,6 +73342,12 @@ export type Routes = {
                   /** 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. */
@@ -78196,6 +78310,170 @@ 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'
@@ -83348,6 +83626,12 @@ export type Routes = {
                   /** 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. */
@@ -84894,6 +85178,12 @@ export type Routes = {
                   /** 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. */
@@ -86552,6 +86842,12 @@ export type Routes = {
                   /** 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. */
@@ -89772,6 +90068,12 @@ export type Routes = {
                   /** 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. */
@@ -91322,6 +91624,12 @@ export type Routes = {
                   /** 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. */
@@ -96274,6 +96582,12 @@ export type Routes = {
                   /** 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. */
@@ -98019,6 +98333,12 @@ export type Routes = {
                   /** 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. */
@@ -99597,6 +99917,12 @@ export type Routes = {
                   /** 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. */
@@ -101292,6 +101618,12 @@ export type Routes = {
                   /** 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. */
@@ -110296,6 +110628,12 @@ export type Routes = {
                         /** 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. */
@@ -118157,6 +118495,12 @@ export type Routes = {
                   /** 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. */