@seamapi/types 1.605.0 → 1.607.0

package/dist/connect.d.cts

@@ -4684,6 +4684,7 @@ declare const acs_entrance: z.ZodObject<{
     can_unlock_with_mobile_key: z.ZodOptional<z.ZodBoolean>;
     can_unlock_with_card: z.ZodOptional<z.ZodBoolean>;
     can_unlock_with_code: z.ZodOptional<z.ZodBoolean>;
+    can_belong_to_reservation: z.ZodOptional<z.ZodBoolean>;
 }, "strip", z.ZodTypeAny, {
     display_name: string;
     created_at: string;
@@ -4723,6 +4724,7 @@ declare const acs_entrance: z.ZodObject<{
     can_unlock_with_code?: boolean | undefined;
     can_unlock_with_mobile_key?: boolean | undefined;
     can_unlock_with_card?: boolean | undefined;
+    can_belong_to_reservation?: boolean | undefined;
     latch_metadata?: {
         door_name: string;
         is_connected: boolean;
@@ -4787,6 +4789,7 @@ declare const acs_entrance: z.ZodObject<{
     can_unlock_with_code?: boolean | undefined;
     can_unlock_with_mobile_key?: boolean | undefined;
     can_unlock_with_card?: boolean | undefined;
+    can_belong_to_reservation?: boolean | undefined;
     latch_metadata?: {
         door_name: string;
         is_connected: boolean;
@@ -14774,6 +14777,7 @@ declare const batch: z.ZodObject<{
         can_unlock_with_mobile_key: z.ZodOptional<z.ZodBoolean>;
         can_unlock_with_card: z.ZodOptional<z.ZodBoolean>;
         can_unlock_with_code: z.ZodOptional<z.ZodBoolean>;
+        can_belong_to_reservation: z.ZodOptional<z.ZodBoolean>;
     }, "strip", z.ZodTypeAny, {
         display_name: string;
         created_at: string;
@@ -14813,6 +14817,7 @@ declare const batch: z.ZodObject<{
         can_unlock_with_code?: boolean | undefined;
         can_unlock_with_mobile_key?: boolean | undefined;
         can_unlock_with_card?: boolean | undefined;
+        can_belong_to_reservation?: boolean | undefined;
         latch_metadata?: {
             door_name: string;
             is_connected: boolean;
@@ -14877,6 +14882,7 @@ declare const batch: z.ZodObject<{
         can_unlock_with_code?: boolean | undefined;
         can_unlock_with_mobile_key?: boolean | undefined;
         can_unlock_with_card?: boolean | undefined;
+        can_belong_to_reservation?: boolean | undefined;
         latch_metadata?: {
             door_name: string;
             is_connected: boolean;
@@ -31711,6 +31717,7 @@ declare const batch: z.ZodObject<{
         can_unlock_with_code?: boolean | undefined;
         can_unlock_with_mobile_key?: boolean | undefined;
         can_unlock_with_card?: boolean | undefined;
+        can_belong_to_reservation?: boolean | undefined;
         latch_metadata?: {
             door_name: string;
             is_connected: boolean;
@@ -35621,6 +35628,7 @@ declare const batch: z.ZodObject<{
         can_unlock_with_code?: boolean | undefined;
         can_unlock_with_mobile_key?: boolean | undefined;
         can_unlock_with_card?: boolean | undefined;
+        can_belong_to_reservation?: boolean | undefined;
         latch_metadata?: {
             door_name: string;
             is_connected: boolean;
@@ -39632,6 +39640,27 @@ type ConnectedAccount = z.infer<typeof connected_account>;
 declare const custom_metadata: z.ZodRecord<z.ZodString, z.ZodUnion<[z.ZodString, z.ZodBoolean]>>;
 type CustomMetadata = z.output<typeof custom_metadata>;
 
+declare const staff_member_resource: z.ZodObject<{
+    name: z.ZodString;
+    email_address: z.ZodOptional<z.ZodString>;
+    phone_number: z.ZodOptional<z.ZodString>;
+} & {
+    staff_member_key: z.ZodString;
+    site_keys: z.ZodArray<z.ZodString, "many">;
+}, "strip", z.ZodTypeAny, {
+    name: string;
+    staff_member_key: string;
+    site_keys: string[];
+    email_address?: string | undefined;
+    phone_number?: string | undefined;
+}, {
+    name: string;
+    staff_member_key: string;
+    site_keys: string[];
+    email_address?: string | undefined;
+    phone_number?: string | undefined;
+}>;
+
 declare const customization_profile: z.ZodObject<{
     workspace_id: z.ZodString;
     name: z.ZodNullable<z.ZodString>;
@@ -51479,6 +51508,7 @@ declare const schemas_magic_link: typeof magic_link;
 declare const schemas_noise_threshold: typeof noise_threshold;
 declare const schemas_pagination: typeof pagination;
 declare const schemas_seam_event: typeof seam_event;
+declare const schemas_staff_member_resource: typeof staff_member_resource;
 declare const schemas_thermostat_daily_program: typeof thermostat_daily_program;
 declare const schemas_thermostat_schedule: typeof thermostat_schedule;
 declare const schemas_thermostat_weekly_program: typeof thermostat_weekly_program;
@@ -51491,7 +51521,7 @@ declare const schemas_user_identity: typeof user_identity;
 declare const schemas_webhook: typeof webhook;
 declare const schemas_workspace: typeof workspace;
 declare namespace schemas {
-  export { schemas_access_code as access_code, schemas_acs_access_group as acs_access_group, schemas_acs_credential as acs_credential, schemas_acs_encoder as acs_encoder, schemas_acs_entrance as acs_entrance, schemas_acs_system as acs_system, schemas_acs_user as acs_user, schemas_action_attempt as action_attempt, schemas_batch as batch, schemas_bridge as bridge, schemas_bridge_client_session as bridge_client_session, schemas_building_block_type as building_block_type, schemas_client_session as client_session, schemas_common_failed_action_attempt as common_failed_action_attempt, schemas_common_pending_action_attempt as common_pending_action_attempt, schemas_common_succeeded_action_attempt as common_succeeded_action_attempt, schemas_connect_webview as connect_webview, schemas_connected_account as connected_account, schemas_custom_metadata as custom_metadata, schemas_customization_profile as customization_profile, schemas_device as device, schemas_device_provider as device_provider, schemas_instant_key as instant_key, schemas_magic_link as magic_link, schemas_noise_threshold as noise_threshold, schemas_pagination as pagination, schemas_seam_event as seam_event, schemas_thermostat_daily_program as thermostat_daily_program, schemas_thermostat_schedule as thermostat_schedule, schemas_thermostat_weekly_program as thermostat_weekly_program, schemas_unmanaged_access_code as unmanaged_access_code, schemas_unmanaged_acs_access_group as unmanaged_acs_access_group, schemas_unmanaged_acs_credential as unmanaged_acs_credential, schemas_unmanaged_acs_user as unmanaged_acs_user, schemas_unmanaged_device as unmanaged_device, schemas_user_identity as user_identity, schemas_webhook as webhook, schemas_workspace as workspace };
+  export { schemas_access_code as access_code, schemas_acs_access_group as acs_access_group, schemas_acs_credential as acs_credential, schemas_acs_encoder as acs_encoder, schemas_acs_entrance as acs_entrance, schemas_acs_system as acs_system, schemas_acs_user as acs_user, schemas_action_attempt as action_attempt, schemas_batch as batch, schemas_bridge as bridge, schemas_bridge_client_session as bridge_client_session, schemas_building_block_type as building_block_type, schemas_client_session as client_session, schemas_common_failed_action_attempt as common_failed_action_attempt, schemas_common_pending_action_attempt as common_pending_action_attempt, schemas_common_succeeded_action_attempt as common_succeeded_action_attempt, schemas_connect_webview as connect_webview, schemas_connected_account as connected_account, schemas_custom_metadata as custom_metadata, schemas_customization_profile as customization_profile, schemas_device as device, schemas_device_provider as device_provider, schemas_instant_key as instant_key, schemas_magic_link as magic_link, schemas_noise_threshold as noise_threshold, schemas_pagination as pagination, schemas_seam_event as seam_event, schemas_staff_member_resource as staff_member_resource, schemas_thermostat_daily_program as thermostat_daily_program, schemas_thermostat_schedule as thermostat_schedule, schemas_thermostat_weekly_program as thermostat_weekly_program, schemas_unmanaged_access_code as unmanaged_access_code, schemas_unmanaged_acs_access_group as unmanaged_acs_access_group, schemas_unmanaged_acs_credential as unmanaged_acs_credential, schemas_unmanaged_acs_user as unmanaged_acs_user, schemas_unmanaged_device as unmanaged_device, schemas_user_identity as user_identity, schemas_webhook as webhook, schemas_workspace as workspace };
 }
 
 declare const _default: {
@@ -52653,6 +52683,10 @@ declare const _default: {
                         required: string[];
                         type: string;
                     };
+                    can_belong_to_reservation: {
+                        description: string;
+                        type: string;
+                    };
                     can_unlock_with_card: {
                         description: string;
                         type: string;
@@ -63013,6 +63047,10 @@ declare const _default: {
                                                             required: string[];
                                                             type: string;
                                                         };
+                                                        can_belong_to_reservation: {
+                                                            description: string;
+                                                            type: string;
+                                                        };
                                                         can_unlock_with_card: {
                                                             description: string;
                                                             type: string;
@@ -63706,6 +63744,37 @@ declare const _default: {
                 'x-draft': string;
                 'x-route-path': string;
             };
+            staff_member: {
+                description: string;
+                properties: {
+                    email_address: {
+                        description: string;
+                        type: string;
+                    };
+                    name: {
+                        description: string;
+                        type: string;
+                    };
+                    phone_number: {
+                        description: string;
+                        type: string;
+                    };
+                    site_keys: {
+                        description: string;
+                        items: {
+                            type: string;
+                        };
+                        type: string;
+                    };
+                    staff_member_key: {
+                        description: string;
+                        type: string;
+                    };
+                };
+                required: string[];
+                type: string;
+                'x-route-path': string;
+            };
             thermostat_daily_program: {
                 description: string;
                 properties: {
@@ -84093,6 +84162,41 @@ declare const _default: {
                                                     };
                                                     type: string;
                                                 };
+                                                staff_members: {
+                                                    description: string;
+                                                    items: {
+                                                        description: string;
+                                                        properties: {
+                                                            email_address: {
+                                                                description: string;
+                                                                type: string;
+                                                            };
+                                                            name: {
+                                                                description: string;
+                                                                type: string;
+                                                            };
+                                                            phone_number: {
+                                                                description: string;
+                                                                type: string;
+                                                            };
+                                                            site_keys: {
+                                                                description: string;
+                                                                items: {
+                                                                    type: string;
+                                                                };
+                                                                type: string;
+                                                            };
+                                                            staff_member_key: {
+                                                                description: string;
+                                                                type: string;
+                                                            };
+                                                        };
+                                                        required: string[];
+                                                        type: string;
+                                                        'x-route-path': string;
+                                                    };
+                                                    type: string;
+                                                };
                                                 tenants: {
                                                     description: string;
                                                     items: {
@@ -85055,6 +85159,41 @@ declare const _default: {
                                         };
                                         type: string;
                                     };
+                                    staff_members: {
+                                        description: string;
+                                        items: {
+                                            description: string;
+                                            properties: {
+                                                email_address: {
+                                                    description: string;
+                                                    type: string;
+                                                };
+                                                name: {
+                                                    description: string;
+                                                    type: string;
+                                                };
+                                                phone_number: {
+                                                    description: string;
+                                                    type: string;
+                                                };
+                                                site_keys: {
+                                                    description: string;
+                                                    items: {
+                                                        type: string;
+                                                    };
+                                                    type: string;
+                                                };
+                                                staff_member_key: {
+                                                    description: string;
+                                                    type: string;
+                                                };
+                                            };
+                                            required: string[];
+                                            type: string;
+                                            'x-route-path': string;
+                                        };
+                                        type: string;
+                                    };
                                     tenants: {
                                         description: string;
                                         items: {
@@ -96020,6 +96159,190 @@ declare const _default: {
                 'x-title': string;
             };
         };
+        '/seam/customer/v1/staff_members/list': {
+            get: {
+                description: string;
+                operationId: string;
+                parameters: ({
+                    in: string;
+                    name: string;
+                    schema: {
+                        description: string;
+                        type: string;
+                        format?: never;
+                        default?: never;
+                        exclusiveMinimum?: never;
+                        minimum?: never;
+                        nullable?: never;
+                    };
+                } | {
+                    in: string;
+                    name: string;
+                    schema: {
+                        description: string;
+                        format: string;
+                        type: string;
+                        default?: never;
+                        exclusiveMinimum?: never;
+                        minimum?: never;
+                        nullable?: never;
+                    };
+                } | {
+                    in: string;
+                    name: string;
+                    schema: {
+                        default: number;
+                        description: string;
+                        exclusiveMinimum: boolean;
+                        minimum: number;
+                        type: string;
+                        format?: never;
+                        nullable?: never;
+                    };
+                } | {
+                    in: string;
+                    name: string;
+                    schema: {
+                        description: string;
+                        nullable: boolean;
+                        type: string;
+                        format?: never;
+                        default?: never;
+                        exclusiveMinimum?: never;
+                        minimum?: never;
+                    };
+                })[];
+                responses: {
+                    200: {
+                        content: {
+                            'application/json': {
+                                schema: {
+                                    properties: {
+                                        ok: {
+                                            type: string;
+                                        };
+                                        pagination: {
+                                            $ref: string;
+                                        };
+                                        staff_members: {
+                                            items: {
+                                                $ref: string;
+                                            };
+                                            type: string;
+                                        };
+                                    };
+                                    required: string[];
+                                    type: string;
+                                };
+                            };
+                        };
+                        description: string;
+                    };
+                    400: {
+                        description: string;
+                    };
+                    401: {
+                        description: string;
+                    };
+                };
+                security: {
+                    client_session_with_customer: never[];
+                }[];
+                summary: string;
+                tags: never[];
+                'x-fern-sdk-group-name': string[];
+                'x-fern-sdk-method-name': string;
+                'x-fern-sdk-return-value': string;
+                'x-response-key': string;
+                'x-title': string;
+                'x-undocumented': string;
+            };
+            post: {
+                description: string;
+                operationId: string;
+                requestBody: {
+                    content: {
+                        'application/json': {
+                            schema: {
+                                properties: {
+                                    created_before: {
+                                        description: string;
+                                        format: string;
+                                        type: string;
+                                    };
+                                    limit: {
+                                        default: number;
+                                        description: string;
+                                        exclusiveMinimum: boolean;
+                                        minimum: number;
+                                        type: string;
+                                    };
+                                    page_cursor: {
+                                        description: string;
+                                        nullable: boolean;
+                                        type: string;
+                                    };
+                                    space_id: {
+                                        description: string;
+                                        format: string;
+                                        type: string;
+                                    };
+                                    space_key: {
+                                        description: string;
+                                        type: string;
+                                    };
+                                };
+                                type: string;
+                            };
+                        };
+                    };
+                };
+                responses: {
+                    200: {
+                        content: {
+                            'application/json': {
+                                schema: {
+                                    properties: {
+                                        ok: {
+                                            type: string;
+                                        };
+                                        pagination: {
+                                            $ref: string;
+                                        };
+                                        staff_members: {
+                                            items: {
+                                                $ref: string;
+                                            };
+                                            type: string;
+                                        };
+                                    };
+                                    required: string[];
+                                    type: string;
+                                };
+                            };
+                        };
+                        description: string;
+                    };
+                    400: {
+                        description: string;
+                    };
+                    401: {
+                        description: string;
+                    };
+                };
+                security: {
+                    client_session_with_customer: never[];
+                }[];
+                summary: string;
+                tags: never[];
+                'x-fern-sdk-group-name': string[];
+                'x-fern-sdk-method-name': string;
+                'x-fern-sdk-return-value': string;
+                'x-response-key': string;
+                'x-title': string;
+                'x-undocumented': string;
+            };
+        };
         '/seam/customer/v1/webhooks/connectors/[workspace_id]/[connector_id]': {
             post: {
                 description: string;
@@ -119956,6 +120279,8 @@ type Routes = {
                     can_unlock_with_card?: boolean | undefined;
                     /** Indicates whether the ACS entrance can be unlocked with pin codes. */
                     can_unlock_with_code?: boolean | undefined;
+                    /** Indicates whether the ACS entrance can belong to a reservation via an access_grant.reservation_key. */
+                    can_belong_to_reservation?: boolean | undefined;
                 }[] | undefined;
                 user_identities?: {
                     /** ID of the user identity. */
@@ -123388,6 +123713,8 @@ type Routes = {
                     can_unlock_with_card?: boolean | undefined;
                     /** Indicates whether the ACS entrance can be unlocked with pin codes. */
                     can_unlock_with_code?: boolean | undefined;
+                    /** Indicates whether the ACS entrance can belong to a reservation via an access_grant.reservation_key. */
+                    can_belong_to_reservation?: boolean | undefined;
                 }[] | undefined;
                 acs_systems?: {
                     /** ID of the default credential manager `acs_system` for this [access control system](https://docs.seam.co/latest/capability-guides/access-systems). */
@@ -129445,6 +129772,8 @@ type Routes = {
                 can_unlock_with_card?: boolean | undefined;
                 /** Indicates whether the ACS entrance can be unlocked with pin codes. */
                 can_unlock_with_code?: boolean | undefined;
+                /** Indicates whether the ACS entrance can belong to a reservation via an access_grant.reservation_key. */
+                can_belong_to_reservation?: boolean | undefined;
             }[];
         };
     };
@@ -130811,6 +131140,8 @@ type Routes = {
                 can_unlock_with_card?: boolean | undefined;
                 /** Indicates whether the ACS entrance can be unlocked with pin codes. */
                 can_unlock_with_code?: boolean | undefined;
+                /** Indicates whether the ACS entrance can belong to a reservation via an access_grant.reservation_key. */
+                can_belong_to_reservation?: boolean | undefined;
             }[];
         };
     };
@@ -134277,6 +134608,8 @@ type Routes = {
                 can_unlock_with_card?: boolean | undefined;
                 /** Indicates whether the ACS entrance can be unlocked with pin codes. */
                 can_unlock_with_code?: boolean | undefined;
+                /** Indicates whether the ACS entrance can belong to a reservation via an access_grant.reservation_key. */
+                can_belong_to_reservation?: boolean | undefined;
             };
         };
     };
@@ -134444,6 +134777,8 @@ type Routes = {
                 can_unlock_with_card?: boolean | undefined;
                 /** Indicates whether the ACS entrance can be unlocked with pin codes. */
                 can_unlock_with_code?: boolean | undefined;
+                /** Indicates whether the ACS entrance can belong to a reservation via an access_grant.reservation_key. */
+                can_belong_to_reservation?: boolean | undefined;
             }[];
             /** Information about the current page of results. */
             pagination: {
@@ -135919,6 +136254,8 @@ type Routes = {
                 can_unlock_with_card?: boolean | undefined;
                 /** Indicates whether the ACS entrance can be unlocked with pin codes. */
                 can_unlock_with_code?: boolean | undefined;
+                /** Indicates whether the ACS entrance can belong to a reservation via an access_grant.reservation_key. */
+                can_belong_to_reservation?: boolean | undefined;
             }[];
         };
     };
@@ -140295,6 +140632,19 @@ type Routes = {
                     /** Your unique identifier for the user identity. */
                     user_identity_key: string;
                 }[] | undefined;
+                /** List of staff members. */
+                staff_members?: {
+                    /** Your display name for this user identity resource. */
+                    name: string;
+                    /** Email address associated with the user identity. */
+                    email_address?: string | undefined;
+                    /** Phone number associated with the user identity. */
+                    phone_number?: string | undefined;
+                    /** Your unique identifier for the staff. */
+                    staff_member_key: string;
+                    /** List of unique identifiers for the sites the staff member is associated with. */
+                    site_keys: string[];
+                }[] | undefined;
                 /** List of reservations. */
                 reservations?: {
                     /** Your name for this access grant resource. */
@@ -140620,6 +140970,19 @@ type Routes = {
                 /** Your unique identifier for the user identity. */
                 user_identity_key: string;
             }[] | undefined;
+            /** List of staff members. */
+            staff_members?: {
+                /** Your display name for this user identity resource. */
+                name: string;
+                /** Email address associated with the user identity. */
+                email_address?: string | undefined;
+                /** Phone number associated with the user identity. */
+                phone_number?: string | undefined;
+                /** Your unique identifier for the staff. */
+                staff_member_key: string;
+                /** List of unique identifiers for the sites the staff member is associated with. */
+                site_keys: string[];
+            }[] | undefined;
             /** List of reservations. */
             reservations?: {
                 /** Your name for this access grant resource. */
@@ -167645,6 +168008,48 @@ type Routes = {
             }[];
         };
     };
+    '/seam/customer/v1/staff_members/list': {
+        route: '/seam/customer/v1/staff_members/list';
+        method: 'GET' | 'POST';
+        queryParams: {};
+        jsonBody: {};
+        commonParams: {
+            /** Filter staff members by space key. */
+            space_key?: string | undefined;
+            /** Filter staff members by space ID (UUID). */
+            space_id?: string | undefined;
+            /** Maximum number of records to return per page. */
+            limit?: number;
+            /** Timestamp by which to limit returned staff members. Returns staff members created before this timestamp. */
+            created_before?: Date | undefined;
+            /** Identifies the specific page of results to return, obtained from the previous page's `next_page_cursor`. */
+            page_cursor?: ((string | undefined) | null) | undefined;
+        };
+        formData: {};
+        jsonResponse: {
+            staff_members: {
+                /** Your display name for this user identity resource. */
+                name: string;
+                /** Email address associated with the user identity. */
+                email_address?: string | undefined;
+                /** Phone number associated with the user identity. */
+                phone_number?: string | undefined;
+                /** Your unique identifier for the staff. */
+                staff_member_key: string;
+                /** List of unique identifiers for the sites the staff member is associated with. */
+                site_keys: string[];
+            }[];
+            /** Information about the current page of results. */
+            pagination: {
+                /** Opaque value that can be used to select the next page of results via the `page_cursor` parameter. */
+                next_page_cursor: string | null;
+                /** Indicates whether there is another page of results after this one. */
+                has_next_page: boolean;
+                /** URL to get the next page of results. */
+                next_page_url: string | null;
+            };
+        };
+    };
     '/seam/customer/v1/webhooks/connectors/[workspace_id]/[connector_id]': {
         route: '/seam/customer/v1/webhooks/connectors/[workspace_id]/[connector_id]';
         method: 'POST';
@@ -168181,6 +168586,8 @@ type Routes = {
                             can_unlock_with_card?: boolean | undefined;
                             /** Indicates whether the ACS entrance can be unlocked with pin codes. */
                             can_unlock_with_code?: boolean | undefined;
+                            /** Indicates whether the ACS entrance can belong to a reservation via an access_grant.reservation_key. */
+                            can_belong_to_reservation?: boolean | undefined;
                         }[];
                     }[];
                 }[];
@@ -169760,6 +170167,8 @@ type Routes = {
                     can_unlock_with_card?: boolean | undefined;
                     /** Indicates whether the ACS entrance can be unlocked with pin codes. */
                     can_unlock_with_code?: boolean | undefined;
+                    /** Indicates whether the ACS entrance can belong to a reservation via an access_grant.reservation_key. */
+                    can_belong_to_reservation?: boolean | undefined;
                 }[] | undefined;
                 connected_accounts?: {
                     /** ID of the connected account. */
@@ -190994,6 +191403,8 @@ type Routes = {
                     can_unlock_with_card?: boolean | undefined;
                     /** Indicates whether the ACS entrance can be unlocked with pin codes. */
                     can_unlock_with_code?: boolean | undefined;
+                    /** Indicates whether the ACS entrance can belong to a reservation via an access_grant.reservation_key. */
+                    can_belong_to_reservation?: boolean | undefined;
                 }[] | undefined;
                 acs_systems?: {
                     /** ID of the default credential manager `acs_system` for this [access control system](https://docs.seam.co/latest/capability-guides/access-systems). */