@seamapi/types 1.772.0 → 1.774.0

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

@@ -13476,14 +13476,19 @@ export type Routes = {
                     | undefined
                 })
               /** Location information for the device. */
-              location: {
-                /** Name of the device location.
-                 */
-                location_name?: string | undefined
-                /** Time zone of the device location.
-                 */
-                timezone?: string | undefined
-              } | null
+              location?:
+                | {
+                    /** Name of the device location.
+                     */
+                    location_name?: string | undefined
+                    /** Time zone of the device location.
+                     */
+                    time_zone?: string | undefined
+                    /** Time zone of the device location.
+                     * @deprecated Use `time_zone` instead.*/
+                    timezone?: string | undefined
+                  }
+                | undefined
               /** Unique identifier for the account associated with the device. */
               connected_account_id: string
               /** Unique identifier for the Seam workspace associated with the device. */
@@ -18567,14 +18572,19 @@ export type Routes = {
                     | undefined
                 })
               /** Location information for the device. */
-              location: {
-                /** Name of the device location.
-                 */
-                location_name?: string | undefined
-                /** Time zone of the device location.
-                 */
-                timezone?: string | undefined
-              } | null
+              location?:
+                | {
+                    /** Name of the device location.
+                     */
+                    location_name?: string | undefined
+                    /** Time zone of the device location.
+                     */
+                    time_zone?: string | undefined
+                    /** Time zone of the device location.
+                     * @deprecated Use `time_zone` instead.*/
+                    timezone?: string | undefined
+                  }
+                | undefined
               /** Unique identifier for the account associated with the device. */
               connected_account_id: string
               /** Unique identifier for the Seam workspace associated with the device. */
@@ -37766,14 +37776,19 @@ export type Routes = {
               | undefined
           })
         /** Location information for the device. */
-        location: {
-          /** Name of the device location.
-           */
-          location_name?: string | undefined
-          /** Time zone of the device location.
-           */
-          timezone?: string | undefined
-        } | null
+        location?:
+          | {
+              /** Name of the device location.
+               */
+              location_name?: string | undefined
+              /** Time zone of the device location.
+               */
+              time_zone?: string | undefined
+              /** Time zone of the device location.
+               * @deprecated Use `time_zone` instead.*/
+              timezone?: string | undefined
+            }
+          | undefined
         /** Unique identifier for the account associated with the device. */
         connected_account_id: string
         /** Unique identifier for the Seam workspace associated with the device. */
@@ -39640,14 +39655,19 @@ export type Routes = {
               | undefined
           })
         /** Location information for the device. */
-        location: {
-          /** Name of the device location.
-           */
-          location_name?: string | undefined
-          /** Time zone of the device location.
-           */
-          timezone?: string | undefined
-        } | null
+        location?:
+          | {
+              /** Name of the device location.
+               */
+              location_name?: string | undefined
+              /** Time zone of the device location.
+               */
+              time_zone?: string | undefined
+              /** Time zone of the device location.
+               * @deprecated Use `time_zone` instead.*/
+              timezone?: string | undefined
+            }
+          | undefined
         /** Unique identifier for the account associated with the device. */
         connected_account_id: string
         /** Unique identifier for the Seam workspace associated with the device. */
@@ -40771,14 +40791,19 @@ export type Routes = {
         /** Unique identifier for the account associated with the device. */
         connected_account_id: string
         /** Location information for the device. */
-        location: {
-          /** Name of the device location.
-           */
-          location_name?: string | undefined
-          /** Time zone of the device location.
-           */
-          timezone?: string | undefined
-        } | null
+        location?:
+          | {
+              /** Name of the device location.
+               */
+              location_name?: string | undefined
+              /** Time zone of the device location.
+               */
+              time_zone?: string | undefined
+              /** Time zone of the device location.
+               * @deprecated Use `time_zone` instead.*/
+              timezone?: string | undefined
+            }
+          | undefined
         /**
                 Collection of capabilities that the device supports when connected to Seam. Values are `access_code`, which indicates that the device can manage and utilize digital PIN codes for secure access; `lock`, which indicates that the device controls a door locking mechanism, enabling the remote opening and closing of doors and other entry points; `noise_detection`, which indicates that the device supports monitoring and responding to ambient noise levels; `thermostat`, which indicates that the device can regulate and adjust indoor temperatures; `battery`, which indicates that the device can manage battery life and health; and `phone`, which indicates that the device is a mobile device, such as a smartphone. **Important:** Superseded by [capability flags](https://docs.seam.co/latest/capability-guides/device-and-system-capabilities#capability-flags).
                  */
@@ -41529,14 +41554,19 @@ export type Routes = {
         /** Unique identifier for the account associated with the device. */
         connected_account_id: string
         /** Location information for the device. */
-        location: {
-          /** Name of the device location.
-           */
-          location_name?: string | undefined
-          /** Time zone of the device location.
-           */
-          timezone?: string | undefined
-        } | null
+        location?:
+          | {
+              /** Name of the device location.
+               */
+              location_name?: string | undefined
+              /** Time zone of the device location.
+               */
+              time_zone?: string | undefined
+              /** Time zone of the device location.
+               * @deprecated Use `time_zone` instead.*/
+              timezone?: string | undefined
+            }
+          | undefined
         /**
                 Collection of capabilities that the device supports when connected to Seam. Values are `access_code`, which indicates that the device can manage and utilize digital PIN codes for secure access; `lock`, which indicates that the device controls a door locking mechanism, enabling the remote opening and closing of doors and other entry points; `noise_detection`, which indicates that the device supports monitoring and responding to ambient noise levels; `thermostat`, which indicates that the device can regulate and adjust indoor temperatures; `battery`, which indicates that the device can manage battery life and health; and `phone`, which indicates that the device is a mobile device, such as a smartphone. **Important:** Superseded by [capability flags](https://docs.seam.co/latest/capability-guides/device-and-system-capabilities#capability-flags).
                  */
@@ -51492,14 +51522,19 @@ export type Routes = {
               | undefined
           })
         /** Location information for the device. */
-        location: {
-          /** Name of the device location.
-           */
-          location_name?: string | undefined
-          /** Time zone of the device location.
-           */
-          timezone?: string | undefined
-        } | null
+        location?:
+          | {
+              /** Name of the device location.
+               */
+              location_name?: string | undefined
+              /** Time zone of the device location.
+               */
+              time_zone?: string | undefined
+              /** Time zone of the device location.
+               * @deprecated Use `time_zone` instead.*/
+              timezone?: string | undefined
+            }
+          | undefined
         /** Unique identifier for the account associated with the device. */
         connected_account_id: string
         /** Unique identifier for the Seam workspace associated with the device. */
@@ -53135,14 +53170,19 @@ export type Routes = {
               | undefined
           })
         /** Location information for the device. */
-        location: {
-          /** Name of the device location.
-           */
-          location_name?: string | undefined
-          /** Time zone of the device location.
-           */
-          timezone?: string | undefined
-        } | null
+        location?:
+          | {
+              /** Name of the device location.
+               */
+              location_name?: string | undefined
+              /** Time zone of the device location.
+               */
+              time_zone?: string | undefined
+              /** Time zone of the device location.
+               * @deprecated Use `time_zone` instead.*/
+              timezone?: string | undefined
+            }
+          | undefined
         /** Unique identifier for the account associated with the device. */
         connected_account_id: string
         /** Unique identifier for the Seam workspace associated with the device. */
@@ -54968,14 +55008,19 @@ export type Routes = {
               | undefined
           })
         /** Location information for the device. */
-        location: {
-          /** Name of the device location.
-           */
-          location_name?: string | undefined
-          /** Time zone of the device location.
-           */
-          timezone?: string | undefined
-        } | null
+        location?:
+          | {
+              /** Name of the device location.
+               */
+              location_name?: string | undefined
+              /** Time zone of the device location.
+               */
+              time_zone?: string | undefined
+              /** Time zone of the device location.
+               * @deprecated Use `time_zone` instead.*/
+              timezone?: string | undefined
+            }
+          | undefined
         /** Unique identifier for the account associated with the device. */
         connected_account_id: string
         /** Unique identifier for the Seam workspace associated with the device. */
@@ -56610,14 +56655,19 @@ export type Routes = {
               | undefined
           })
         /** Location information for the device. */
-        location: {
-          /** Name of the device location.
-           */
-          location_name?: string | undefined
-          /** Time zone of the device location.
-           */
-          timezone?: string | undefined
-        } | null
+        location?:
+          | {
+              /** Name of the device location.
+               */
+              location_name?: string | undefined
+              /** Time zone of the device location.
+               */
+              time_zone?: string | undefined
+              /** Time zone of the device location.
+               * @deprecated Use `time_zone` instead.*/
+              timezone?: string | undefined
+            }
+          | undefined
         /** Unique identifier for the account associated with the device. */
         connected_account_id: string
         /** Unique identifier for the Seam workspace associated with the device. */
@@ -64541,14 +64591,19 @@ export type Routes = {
               | undefined
           })
         /** Location information for the device. */
-        location: {
-          /** Name of the device location.
-           */
-          location_name?: string | undefined
-          /** Time zone of the device location.
-           */
-          timezone?: string | undefined
-        } | null
+        location?:
+          | {
+              /** Name of the device location.
+               */
+              location_name?: string | undefined
+              /** Time zone of the device location.
+               */
+              time_zone?: string | undefined
+              /** Time zone of the device location.
+               * @deprecated Use `time_zone` instead.*/
+              timezone?: string | undefined
+            }
+          | undefined
         /** Unique identifier for the account associated with the device. */
         connected_account_id: string
         /** Unique identifier for the Seam workspace associated with the device. */
@@ -66183,14 +66238,19 @@ export type Routes = {
               | undefined
           })
         /** Location information for the device. */
-        location: {
-          /** Name of the device location.
-           */
-          location_name?: string | undefined
-          /** Time zone of the device location.
-           */
-          timezone?: string | undefined
-        } | null
+        location?:
+          | {
+              /** Name of the device location.
+               */
+              location_name?: string | undefined
+              /** Time zone of the device location.
+               */
+              time_zone?: string | undefined
+              /** Time zone of the device location.
+               * @deprecated Use `time_zone` instead.*/
+              timezone?: string | undefined
+            }
+          | undefined
         /** Unique identifier for the account associated with the device. */
         connected_account_id: string
         /** Unique identifier for the Seam workspace associated with the device. */
@@ -74378,6 +74438,215 @@ export type Routes = {
     }
     maxDuration: undefined
   }
+  '/seam/customer/v1/connectors/ical/generate-config': {
+    route: '/seam/customer/v1/connectors/ical/generate-config'
+    method: 'POST'
+    queryParams: {}
+    jsonBody: {
+      /** iCal feed URL to analyze */
+      ical_url: string
+    }
+    commonParams: {}
+    formData: {}
+    jsonResponse: {
+      generated_config: {
+        ical_config: {
+          /** Optional filter to skip non-matching events */
+          filter?:
+            | {
+                /** iCal property name to match against */
+                source: string
+                /** Regex pattern — events not matching are skipped */
+                pattern: string
+              }
+            | undefined
+          fields: {
+            /** How to extract the reservation key (falls back to UID) */
+            reservation_key?:
+              | {
+                  /** iCal property name to read from: UID, SUMMARY, DESCRIPTION, DTSTART, DTEND, etc. */
+                  source: string
+                  /** Regex with capture group to extract value from the property */
+                  pattern?: string | undefined
+                  /** Special type handling — 'date' parses iCal date formats */
+                  type?: 'date' | undefined
+                }
+              | undefined
+            /** How to extract guest name */
+            guest_name?:
+              | {
+                  /** iCal property name to read from: UID, SUMMARY, DESCRIPTION, DTSTART, DTEND, etc. */
+                  source: string
+                  /** Regex with capture group to extract value from the property */
+                  pattern?: string | undefined
+                  /** Special type handling — 'date' parses iCal date formats */
+                  type?: 'date' | undefined
+                }
+              | undefined
+            /** How to extract guest email */
+            guest_email?:
+              | {
+                  /** iCal property name to read from: UID, SUMMARY, DESCRIPTION, DTSTART, DTEND, etc. */
+                  source: string
+                  /** Regex with capture group to extract value from the property */
+                  pattern?: string | undefined
+                  /** Special type handling — 'date' parses iCal date formats */
+                  type?: 'date' | undefined
+                }
+              | undefined
+            /** How to extract guest phone */
+            guest_phone?:
+              | {
+                  /** iCal property name to read from: UID, SUMMARY, DESCRIPTION, DTSTART, DTEND, etc. */
+                  source: string
+                  /** Regex with capture group to extract value from the property */
+                  pattern?: string | undefined
+                  /** Special type handling — 'date' parses iCal date formats */
+                  type?: 'date' | undefined
+                }
+              | undefined
+            /** How to extract check-in date */
+            starts_at: {
+              /** iCal property name to read from: UID, SUMMARY, DESCRIPTION, DTSTART, DTEND, etc. */
+              source: string
+              /** Regex with capture group to extract value from the property */
+              pattern?: string | undefined
+              /** Special type handling — 'date' parses iCal date formats */
+              type?: 'date' | undefined
+            }
+            /** How to extract check-out date */
+            ends_at: {
+              /** iCal property name to read from: UID, SUMMARY, DESCRIPTION, DTSTART, DTEND, etc. */
+              source: string
+              /** Regex with capture group to extract value from the property */
+              pattern?: string | undefined
+              /** Special type handling — 'date' parses iCal date formats */
+              type?: 'date' | undefined
+            }
+          }
+          /** IANA time zone (e.g. America/New_York) applied when dates have no time/timezone */
+          time_zone?: string | undefined
+          /** Default check-in time (HH:MM) used when iCal gives date-only values */
+          default_check_in_time?: string | undefined
+          /** Default check-out time (HH:MM) used when iCal gives date-only values */
+          default_check_out_time?: string | undefined
+        }
+      }
+    }
+    maxDuration: undefined
+  }
+  '/seam/customer/v1/connectors/ical/validate-config': {
+    route: '/seam/customer/v1/connectors/ical/validate-config'
+    method: 'POST'
+    queryParams: {}
+    jsonBody: {
+      /** iCal feed URL to validate against */
+      ical_url: string
+      /** Config to validate */
+      ical_config: {
+        /** Optional filter to skip non-matching events */
+        filter?:
+          | {
+              /** iCal property name to match against */
+              source: string
+              /** Regex pattern — events not matching are skipped */
+              pattern: string
+            }
+          | undefined
+        fields: {
+          /** How to extract the reservation key (falls back to UID) */
+          reservation_key?:
+            | {
+                /** iCal property name to read from: UID, SUMMARY, DESCRIPTION, DTSTART, DTEND, etc. */
+                source: string
+                /** Regex with capture group to extract value from the property */
+                pattern?: string | undefined
+                /** Special type handling — 'date' parses iCal date formats */
+                type?: 'date' | undefined
+              }
+            | undefined
+          /** How to extract guest name */
+          guest_name?:
+            | {
+                /** iCal property name to read from: UID, SUMMARY, DESCRIPTION, DTSTART, DTEND, etc. */
+                source: string
+                /** Regex with capture group to extract value from the property */
+                pattern?: string | undefined
+                /** Special type handling — 'date' parses iCal date formats */
+                type?: 'date' | undefined
+              }
+            | undefined
+          /** How to extract guest email */
+          guest_email?:
+            | {
+                /** iCal property name to read from: UID, SUMMARY, DESCRIPTION, DTSTART, DTEND, etc. */
+                source: string
+                /** Regex with capture group to extract value from the property */
+                pattern?: string | undefined
+                /** Special type handling — 'date' parses iCal date formats */
+                type?: 'date' | undefined
+              }
+            | undefined
+          /** How to extract guest phone */
+          guest_phone?:
+            | {
+                /** iCal property name to read from: UID, SUMMARY, DESCRIPTION, DTSTART, DTEND, etc. */
+                source: string
+                /** Regex with capture group to extract value from the property */
+                pattern?: string | undefined
+                /** Special type handling — 'date' parses iCal date formats */
+                type?: 'date' | undefined
+              }
+            | undefined
+          /** How to extract check-in date */
+          starts_at: {
+            /** iCal property name to read from: UID, SUMMARY, DESCRIPTION, DTSTART, DTEND, etc. */
+            source: string
+            /** Regex with capture group to extract value from the property */
+            pattern?: string | undefined
+            /** Special type handling — 'date' parses iCal date formats */
+            type?: 'date' | undefined
+          }
+          /** How to extract check-out date */
+          ends_at: {
+            /** iCal property name to read from: UID, SUMMARY, DESCRIPTION, DTSTART, DTEND, etc. */
+            source: string
+            /** Regex with capture group to extract value from the property */
+            pattern?: string | undefined
+            /** Special type handling — 'date' parses iCal date formats */
+            type?: 'date' | undefined
+          }
+        }
+        /** IANA time zone (e.g. America/New_York) applied when dates have no time/timezone */
+        time_zone?: string | undefined
+        /** Default check-in time (HH:MM) used when iCal gives date-only values */
+        default_check_in_time?: string | undefined
+        /** Default check-out time (HH:MM) used when iCal gives date-only values */
+        default_check_out_time?: string | undefined
+      }
+    }
+    commonParams: {}
+    formData: {}
+    jsonResponse: {
+      validation_result: {
+        is_valid: boolean
+        total_events: number
+        matched_events: number
+        filtered_events: number
+        reservations: {
+          uid: string
+          reservation_key: string | null
+          guest_name: string | null
+          guest_email: string | null
+          guest_phone: string | null
+          starts_at: string | null
+          ends_at: string | null
+        }[]
+        errors: string[]
+      }
+    }
+    maxDuration: undefined
+  }
   '/seam/customer/v1/connectors/list': {
     route: '/seam/customer/v1/connectors/list'
     method: 'GET' | 'POST'
@@ -81511,14 +81780,19 @@ export type Routes = {
                     | undefined
                 })
               /** Location information for the device. */
-              location: {
-                /** Name of the device location.
-                 */
-                location_name?: string | undefined
-                /** Time zone of the device location.
-                 */
-                timezone?: string | undefined
-              } | null
+              location?:
+                | {
+                    /** Name of the device location.
+                     */
+                    location_name?: string | undefined
+                    /** Time zone of the device location.
+                     */
+                    time_zone?: string | undefined
+                    /** Time zone of the device location.
+                     * @deprecated Use `time_zone` instead.*/
+                    timezone?: string | undefined
+                  }
+                | undefined
               /** Unique identifier for the account associated with the device. */
               connected_account_id: string
               /** Unique identifier for the Seam workspace associated with the device. */
@@ -88688,14 +88962,19 @@ export type Routes = {
               | undefined
           })
         /** Location information for the device. */
-        location: {
-          /** Name of the device location.
-           */
-          location_name?: string | undefined
-          /** Time zone of the device location.
-           */
-          timezone?: string | undefined
-        } | null
+        location?:
+          | {
+              /** Name of the device location.
+               */
+              location_name?: string | undefined
+              /** Time zone of the device location.
+               */
+              time_zone?: string | undefined
+              /** Time zone of the device location.
+               * @deprecated Use `time_zone` instead.*/
+              timezone?: string | undefined
+            }
+          | undefined
         /** Unique identifier for the account associated with the device. */
         connected_account_id: string
         /** Unique identifier for the Seam workspace associated with the device. */
@@ -93564,14 +93843,19 @@ export type Routes = {
               | undefined
           })
         /** Location information for the device. */
-        location: {
-          /** Name of the device location.
-           */
-          location_name?: string | undefined
-          /** Time zone of the device location.
-           */
-          timezone?: string | undefined
-        } | null
+        location?:
+          | {
+              /** Name of the device location.
+               */
+              location_name?: string | undefined
+              /** Time zone of the device location.
+               */
+              time_zone?: string | undefined
+              /** Time zone of the device location.
+               * @deprecated Use `time_zone` instead.*/
+              timezone?: string | undefined
+            }
+          | undefined
         /** Unique identifier for the account associated with the device. */
         connected_account_id: string
         /** Unique identifier for the Seam workspace associated with the device. */
@@ -95206,14 +95490,19 @@ export type Routes = {
               | undefined
           })
         /** Location information for the device. */
-        location: {
-          /** Name of the device location.
-           */
-          location_name?: string | undefined
-          /** Time zone of the device location.
-           */
-          timezone?: string | undefined
-        } | null
+        location?:
+          | {
+              /** Name of the device location.
+               */
+              location_name?: string | undefined
+              /** Time zone of the device location.
+               */
+              time_zone?: string | undefined
+              /** Time zone of the device location.
+               * @deprecated Use `time_zone` instead.*/
+              timezone?: string | undefined
+            }
+          | undefined
         /** Unique identifier for the account associated with the device. */
         connected_account_id: string
         /** Unique identifier for the Seam workspace associated with the device. */
@@ -104014,14 +104303,19 @@ export type Routes = {
               | undefined
           })
         /** Location information for the device. */
-        location: {
-          /** Name of the device location.
-           */
-          location_name?: string | undefined
-          /** Time zone of the device location.
-           */
-          timezone?: string | undefined
-        } | null
+        location?:
+          | {
+              /** Name of the device location.
+               */
+              location_name?: string | undefined
+              /** Time zone of the device location.
+               */
+              time_zone?: string | undefined
+              /** Time zone of the device location.
+               * @deprecated Use `time_zone` instead.*/
+              timezone?: string | undefined
+            }
+          | undefined
         /** Unique identifier for the account associated with the device. */
         connected_account_id: string
         /** Unique identifier for the Seam workspace associated with the device. */
@@ -105658,14 +105952,19 @@ export type Routes = {
               | undefined
           })
         /** Location information for the device. */
-        location: {
-          /** Name of the device location.
-           */
-          location_name?: string | undefined
-          /** Time zone of the device location.
-           */
-          timezone?: string | undefined
-        } | null
+        location?:
+          | {
+              /** Name of the device location.
+               */
+              location_name?: string | undefined
+              /** Time zone of the device location.
+               */
+              time_zone?: string | undefined
+              /** Time zone of the device location.
+               * @deprecated Use `time_zone` instead.*/
+              timezone?: string | undefined
+            }
+          | undefined
         /** Unique identifier for the account associated with the device. */
         connected_account_id: string
         /** Unique identifier for the Seam workspace associated with the device. */
@@ -108415,14 +108714,19 @@ export type Routes = {
                     | undefined
                 })
               /** Location information for the device. */
-              location: {
-                /** Name of the device location.
-                 */
-                location_name?: string | undefined
-                /** Time zone of the device location.
-                 */
-                timezone?: string | undefined
-              } | null
+              location?:
+                | {
+                    /** Name of the device location.
+                     */
+                    location_name?: string | undefined
+                    /** Time zone of the device location.
+                     */
+                    time_zone?: string | undefined
+                    /** Time zone of the device location.
+                     * @deprecated Use `time_zone` instead.*/
+                    timezone?: string | undefined
+                  }
+                | undefined
               /** Unique identifier for the account associated with the device. */
               connected_account_id: string
               /** Unique identifier for the Seam workspace associated with the device. */
@@ -111761,14 +112065,19 @@ export type Routes = {
               /** Unique identifier for the account associated with the device. */
               connected_account_id: string
               /** Location information for the device. */
-              location: {
-                /** Name of the device location.
-                 */
-                location_name?: string | undefined
-                /** Time zone of the device location.
-                 */
-                timezone?: string | undefined
-              } | null
+              location?:
+                | {
+                    /** Name of the device location.
+                     */
+                    location_name?: string | undefined
+                    /** Time zone of the device location.
+                     */
+                    time_zone?: string | undefined
+                    /** Time zone of the device location.
+                     * @deprecated Use `time_zone` instead.*/
+                    timezone?: string | undefined
+                  }
+                | undefined
               /**
                     Collection of capabilities that the device supports when connected to Seam. Values are `access_code`, which indicates that the device can manage and utilize digital PIN codes for secure access; `lock`, which indicates that the device controls a door locking mechanism, enabling the remote opening and closing of doors and other entry points; `noise_detection`, which indicates that the device supports monitoring and responding to ambient noise levels; `thermostat`, which indicates that the device can regulate and adjust indoor temperatures; `battery`, which indicates that the device can manage battery life and health; and `phone`, which indicates that the device is a mobile device, such as a smartphone. **Important:** Superseded by [capability flags](https://docs.seam.co/latest/capability-guides/device-and-system-capabilities#capability-flags).
                      */