@seamapi/types 1.428.0 → 1.429.0

package/dist/connect.d.cts

@@ -56427,6 +56427,766 @@ declare const _default: {
                 'x-undocumented': string;
             };
         };
+        '/seam/customer/v1/automation_runs/list': {
+            get: {
+                description: string;
+                operationId: string;
+                parameters: ({
+                    in: string;
+                    name: string;
+                    schema: {
+                        description: string;
+                        format: string;
+                        type: string;
+                        enum?: never;
+                        default?: never;
+                        exclusiveMinimum?: never;
+                        minimum?: never;
+                        nullable?: never;
+                    };
+                } | {
+                    in: string;
+                    name: string;
+                    schema: {
+                        description: string;
+                        enum: string[];
+                        type: string;
+                        format?: never;
+                        default?: never;
+                        exclusiveMinimum?: never;
+                        minimum?: never;
+                        nullable?: never;
+                    };
+                } | {
+                    in: string;
+                    name: string;
+                    schema: {
+                        description: string;
+                        type: string;
+                        format?: never;
+                        enum?: never;
+                        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;
+                        enum?: never;
+                        nullable?: never;
+                    };
+                } | {
+                    in: string;
+                    name: string;
+                    schema: {
+                        description: string;
+                        nullable: boolean;
+                        type: string;
+                        format?: never;
+                        enum?: never;
+                        default?: never;
+                        exclusiveMinimum?: never;
+                        minimum?: never;
+                    };
+                })[];
+                responses: {
+                    200: {
+                        content: {
+                            'application/json': {
+                                schema: {
+                                    properties: {
+                                        automation_runs: {
+                                            items: {
+                                                properties: {
+                                                    automation_id: {
+                                                        format: string;
+                                                        type: string;
+                                                    };
+                                                    automation_result: {
+                                                        properties: {
+                                                            actions: {
+                                                                items: {
+                                                                    properties: {
+                                                                        access_grant_id: {
+                                                                            format: string;
+                                                                            type: string;
+                                                                        };
+                                                                        action_type: {
+                                                                            enum: string[];
+                                                                            type: string;
+                                                                        };
+                                                                        resource_type: {
+                                                                            type: string;
+                                                                        };
+                                                                    };
+                                                                    required: string[];
+                                                                    type: string;
+                                                                };
+                                                                type: string;
+                                                            };
+                                                            error: {
+                                                                type: string;
+                                                            };
+                                                            rule: {
+                                                                enum: string[];
+                                                                type: string;
+                                                            };
+                                                            success: {
+                                                                type: string;
+                                                            };
+                                                        };
+                                                        required: string[];
+                                                        type: string;
+                                                    };
+                                                    automation_run_id: {
+                                                        format: string;
+                                                        type: string;
+                                                    };
+                                                    created_at: {
+                                                        type: string;
+                                                    };
+                                                    partner_resource_id: {
+                                                        format: string;
+                                                        type: string;
+                                                    };
+                                                    workspace_id: {
+                                                        format: string;
+                                                        type: string;
+                                                    };
+                                                };
+                                                required: string[];
+                                                type: string;
+                                            };
+                                            type: string;
+                                        };
+                                        ok: {
+                                            type: string;
+                                        };
+                                        pagination: {
+                                            $ref: string;
+                                        };
+                                    };
+                                    required: string[];
+                                    type: string;
+                                };
+                            };
+                        };
+                        description: string;
+                    };
+                    400: {
+                        description: string;
+                    };
+                    401: {
+                        description: string;
+                    };
+                };
+                security: ({
+                    console_session_with_workspace: never[];
+                    api_key?: never;
+                    client_session_with_customer?: never;
+                } | {
+                    api_key: never[];
+                    console_session_with_workspace?: never;
+                    client_session_with_customer?: never;
+                } | {
+                    client_session_with_customer: never[];
+                    console_session_with_workspace?: never;
+                    api_key?: 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: {
+                                    automation_id: {
+                                        description: string;
+                                        format: string;
+                                        type: string;
+                                    };
+                                    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;
+                                    };
+                                    partner_resource_id: {
+                                        description: string;
+                                        format: string;
+                                        type: string;
+                                    };
+                                    rule: {
+                                        description: string;
+                                        enum: string[];
+                                        type: string;
+                                    };
+                                    success: {
+                                        description: string;
+                                        type: string;
+                                    };
+                                };
+                                type: string;
+                            };
+                        };
+                    };
+                };
+                responses: {
+                    200: {
+                        content: {
+                            'application/json': {
+                                schema: {
+                                    properties: {
+                                        automation_runs: {
+                                            items: {
+                                                properties: {
+                                                    automation_id: {
+                                                        format: string;
+                                                        type: string;
+                                                    };
+                                                    automation_result: {
+                                                        properties: {
+                                                            actions: {
+                                                                items: {
+                                                                    properties: {
+                                                                        access_grant_id: {
+                                                                            format: string;
+                                                                            type: string;
+                                                                        };
+                                                                        action_type: {
+                                                                            enum: string[];
+                                                                            type: string;
+                                                                        };
+                                                                        resource_type: {
+                                                                            type: string;
+                                                                        };
+                                                                    };
+                                                                    required: string[];
+                                                                    type: string;
+                                                                };
+                                                                type: string;
+                                                            };
+                                                            error: {
+                                                                type: string;
+                                                            };
+                                                            rule: {
+                                                                enum: string[];
+                                                                type: string;
+                                                            };
+                                                            success: {
+                                                                type: string;
+                                                            };
+                                                        };
+                                                        required: string[];
+                                                        type: string;
+                                                    };
+                                                    automation_run_id: {
+                                                        format: string;
+                                                        type: string;
+                                                    };
+                                                    created_at: {
+                                                        type: string;
+                                                    };
+                                                    partner_resource_id: {
+                                                        format: string;
+                                                        type: string;
+                                                    };
+                                                    workspace_id: {
+                                                        format: string;
+                                                        type: string;
+                                                    };
+                                                };
+                                                required: string[];
+                                                type: string;
+                                            };
+                                            type: string;
+                                        };
+                                        ok: {
+                                            type: string;
+                                        };
+                                        pagination: {
+                                            $ref: string;
+                                        };
+                                    };
+                                    required: string[];
+                                    type: string;
+                                };
+                            };
+                        };
+                        description: string;
+                    };
+                    400: {
+                        description: string;
+                    };
+                    401: {
+                        description: string;
+                    };
+                };
+                security: ({
+                    console_session_with_workspace: never[];
+                    api_key?: never;
+                    client_session_with_customer?: never;
+                } | {
+                    api_key: never[];
+                    console_session_with_workspace?: never;
+                    client_session_with_customer?: never;
+                } | {
+                    client_session_with_customer: never[];
+                    console_session_with_workspace?: never;
+                    api_key?: 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/automations/delete': {
+            delete: {
+                description: string;
+                operationId: string;
+                requestBody: {
+                    content: {
+                        'application/json': {
+                            schema: {
+                                properties: {};
+                                type: string;
+                            };
+                        };
+                    };
+                };
+                responses: {
+                    200: {
+                        content: {
+                            'application/json': {
+                                schema: {
+                                    properties: {
+                                        ok: {
+                                            type: string;
+                                        };
+                                    };
+                                    required: string[];
+                                    type: string;
+                                };
+                            };
+                        };
+                        description: string;
+                    };
+                    400: {
+                        description: string;
+                    };
+                    401: {
+                        description: string;
+                    };
+                };
+                security: ({
+                    console_session_with_workspace: never[];
+                    api_key?: never;
+                    client_session_with_customer?: never;
+                } | {
+                    api_key: never[];
+                    console_session_with_workspace?: never;
+                    client_session_with_customer?: never;
+                } | {
+                    client_session_with_customer: never[];
+                    console_session_with_workspace?: never;
+                    api_key?: never;
+                })[];
+                summary: string;
+                tags: never[];
+                'x-fern-sdk-group-name': string[];
+                'x-fern-sdk-method-name': string;
+                'x-response-key': null;
+                'x-title': string;
+                'x-undocumented': string;
+            };
+        };
+        '/seam/customer/v1/automations/get': {
+            get: {
+                description: string;
+                operationId: string;
+                responses: {
+                    200: {
+                        content: {
+                            'application/json': {
+                                schema: {
+                                    properties: {
+                                        access_rules: {
+                                            properties: {
+                                                reservation_created: {
+                                                    properties: {
+                                                        config: {
+                                                            properties: {
+                                                                access_methods: {
+                                                                    items: {
+                                                                        enum: string[];
+                                                                        type: string;
+                                                                    };
+                                                                    minItems: number;
+                                                                    type: string;
+                                                                };
+                                                                method_issuance_strategy: {
+                                                                    enum: string[];
+                                                                    type: string;
+                                                                };
+                                                            };
+                                                            required: string[];
+                                                            type: string;
+                                                        };
+                                                        rule: {
+                                                            enum: string[];
+                                                            type: string;
+                                                        };
+                                                    };
+                                                    required: string[];
+                                                    type: string;
+                                                };
+                                                reservation_deleted: {
+                                                    properties: {
+                                                        config: {
+                                                            $ref: string;
+                                                        };
+                                                        rule: {
+                                                            enum: string[];
+                                                            type: string;
+                                                        };
+                                                    };
+                                                    required: string[];
+                                                    type: string;
+                                                };
+                                                reservation_time_updated: {
+                                                    properties: {
+                                                        config: {
+                                                            $ref: string;
+                                                        };
+                                                        rule: {
+                                                            enum: string[];
+                                                            type: string;
+                                                        };
+                                                    };
+                                                    required: string[];
+                                                    type: string;
+                                                };
+                                            };
+                                            type: string;
+                                        };
+                                        ok: {
+                                            type: string;
+                                        };
+                                    };
+                                    required: string[];
+                                    type: string;
+                                };
+                            };
+                        };
+                        description: string;
+                    };
+                    400: {
+                        description: string;
+                    };
+                    401: {
+                        description: string;
+                    };
+                };
+                security: ({
+                    console_session_with_workspace: never[];
+                    api_key?: never;
+                    client_session_with_customer?: never;
+                } | {
+                    api_key: never[];
+                    console_session_with_workspace?: never;
+                    client_session_with_customer?: never;
+                } | {
+                    client_session_with_customer: never[];
+                    console_session_with_workspace?: never;
+                    api_key?: never;
+                })[];
+                summary: string;
+                tags: never[];
+                'x-fern-sdk-group-name': string[];
+                'x-fern-sdk-method-name': string;
+                'x-response-key': null;
+                'x-title': string;
+                'x-undocumented': string;
+            };
+        };
+        '/seam/customer/v1/automations/update': {
+            patch: {
+                description: string;
+                operationId: string;
+                requestBody: {
+                    content: {
+                        'application/json': {
+                            schema: {
+                                properties: {
+                                    access_rules: {
+                                        description: string;
+                                        properties: {
+                                            reservation_created: {
+                                                properties: {
+                                                    config: {
+                                                        properties: {
+                                                            access_methods: {
+                                                                items: {
+                                                                    enum: string[];
+                                                                    type: string;
+                                                                };
+                                                                minItems: number;
+                                                                type: string;
+                                                            };
+                                                            method_issuance_strategy: {
+                                                                enum: string[];
+                                                                type: string;
+                                                            };
+                                                        };
+                                                        required: string[];
+                                                        type: string;
+                                                    };
+                                                    rule: {
+                                                        enum: string[];
+                                                        type: string;
+                                                    };
+                                                };
+                                                required: string[];
+                                                type: string;
+                                            };
+                                            reservation_deleted: {
+                                                properties: {
+                                                    config: {
+                                                        properties: {};
+                                                        type: string;
+                                                    };
+                                                    rule: {
+                                                        enum: string[];
+                                                        type: string;
+                                                    };
+                                                };
+                                                required: string[];
+                                                type: string;
+                                            };
+                                            reservation_time_updated: {
+                                                properties: {
+                                                    config: {
+                                                        properties: {};
+                                                        type: string;
+                                                    };
+                                                    rule: {
+                                                        enum: string[];
+                                                        type: string;
+                                                    };
+                                                };
+                                                required: string[];
+                                                type: string;
+                                            };
+                                        };
+                                        type: string;
+                                    };
+                                };
+                                type: string;
+                            };
+                        };
+                    };
+                };
+                responses: {
+                    200: {
+                        content: {
+                            'application/json': {
+                                schema: {
+                                    properties: {
+                                        ok: {
+                                            type: string;
+                                        };
+                                    };
+                                    required: string[];
+                                    type: string;
+                                };
+                            };
+                        };
+                        description: string;
+                    };
+                    400: {
+                        description: string;
+                    };
+                    401: {
+                        description: string;
+                    };
+                };
+                security: ({
+                    console_session_with_workspace: never[];
+                    api_key?: never;
+                    client_session_with_customer?: never;
+                } | {
+                    api_key: never[];
+                    console_session_with_workspace?: never;
+                    client_session_with_customer?: never;
+                } | {
+                    client_session_with_customer: never[];
+                    console_session_with_workspace?: never;
+                    api_key?: never;
+                })[];
+                summary: string;
+                tags: never[];
+                'x-fern-sdk-group-name': string[];
+                'x-fern-sdk-method-name': string;
+                'x-response-key': null;
+                'x-title': string;
+                'x-undocumented': string;
+            };
+            post: {
+                description: string;
+                operationId: string;
+                requestBody: {
+                    content: {
+                        'application/json': {
+                            schema: {
+                                properties: {
+                                    access_rules: {
+                                        description: string;
+                                        properties: {
+                                            reservation_created: {
+                                                properties: {
+                                                    config: {
+                                                        properties: {
+                                                            access_methods: {
+                                                                items: {
+                                                                    enum: string[];
+                                                                    type: string;
+                                                                };
+                                                                minItems: number;
+                                                                type: string;
+                                                            };
+                                                            method_issuance_strategy: {
+                                                                enum: string[];
+                                                                type: string;
+                                                            };
+                                                        };
+                                                        required: string[];
+                                                        type: string;
+                                                    };
+                                                    rule: {
+                                                        enum: string[];
+                                                        type: string;
+                                                    };
+                                                };
+                                                required: string[];
+                                                type: string;
+                                            };
+                                            reservation_deleted: {
+                                                properties: {
+                                                    config: {
+                                                        properties: {};
+                                                        type: string;
+                                                    };
+                                                    rule: {
+                                                        enum: string[];
+                                                        type: string;
+                                                    };
+                                                };
+                                                required: string[];
+                                                type: string;
+                                            };
+                                            reservation_time_updated: {
+                                                properties: {
+                                                    config: {
+                                                        properties: {};
+                                                        type: string;
+                                                    };
+                                                    rule: {
+                                                        enum: string[];
+                                                        type: string;
+                                                    };
+                                                };
+                                                required: string[];
+                                                type: string;
+                                            };
+                                        };
+                                        type: string;
+                                    };
+                                };
+                                type: string;
+                            };
+                        };
+                    };
+                };
+                responses: {
+                    200: {
+                        content: {
+                            'application/json': {
+                                schema: {
+                                    properties: {
+                                        ok: {
+                                            type: string;
+                                        };
+                                    };
+                                    required: string[];
+                                    type: string;
+                                };
+                            };
+                        };
+                        description: string;
+                    };
+                    400: {
+                        description: string;
+                    };
+                    401: {
+                        description: string;
+                    };
+                };
+                security: ({
+                    console_session_with_workspace: never[];
+                    api_key?: never;
+                    client_session_with_customer?: never;
+                } | {
+                    api_key: never[];
+                    console_session_with_workspace?: never;
+                    client_session_with_customer?: never;
+                } | {
+                    client_session_with_customer: never[];
+                    console_session_with_workspace?: never;
+                    api_key?: never;
+                })[];
+                summary: string;
+                tags: never[];
+                'x-fern-sdk-group-name': string[];
+                'x-fern-sdk-method-name': string;
+                'x-response-key': null;
+                'x-title': string;
+                'x-undocumented': string;
+            };
+        };
         '/seam/customer/v1/portals/get': {
             get: {
                 description: string;
@@ -113258,6 +114018,121 @@ interface Routes {
             }>;
         };
     };
+    '/seam/customer/v1/automation_runs/list': {
+        route: '/seam/customer/v1/automation_runs/list';
+        method: 'GET' | 'POST';
+        queryParams: {};
+        jsonBody: {};
+        commonParams: {
+            /** ID of the automation for which you want to retrieve all automation runs. */
+            automation_id?: string | undefined;
+            /** ID of the partner resource for which you want to retrieve all automation runs. */
+            partner_resource_id?: string | undefined;
+            /** Filter automation runs by the specific rule that was executed. */
+            rule?: ('reservation_created' | 'reservation_time_updated' | 'reservation_deleted') | undefined;
+            /** Filter automation runs by success status. */
+            success?: boolean | undefined;
+            /** Maximum number of records to return per page. */
+            limit?: number;
+            /** Timestamp by which to limit returned automation runs. Returns runs 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;
+        };
+        formData: {};
+        jsonResponse: {
+            automation_runs: Array<{
+                automation_run_id: string;
+                workspace_id: string;
+                automation_id: string;
+                partner_resource_id: string;
+                automation_result?: {
+                    success: boolean;
+                    rule: 'reservation_created' | 'reservation_time_updated' | 'reservation_deleted';
+                    actions: Array<{
+                        action_type: 'create' | 'update' | 'delete';
+                        resource_type: string;
+                        access_grant_id: string;
+                    }>;
+                    error?: string | undefined;
+                } | undefined;
+                created_at: 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/automations/delete': {
+        route: '/seam/customer/v1/automations/delete';
+        method: 'DELETE';
+        queryParams: {};
+        jsonBody: {};
+        commonParams: {};
+        formData: {};
+        jsonResponse: {};
+    };
+    '/seam/customer/v1/automations/get': {
+        route: '/seam/customer/v1/automations/get';
+        method: 'GET';
+        queryParams: {};
+        jsonBody: {};
+        commonParams: {};
+        formData: {};
+        jsonResponse: {
+            access_rules?: {
+                reservation_created?: {
+                    rule: 'reservation_created';
+                    config: {
+                        access_methods: Array<'card' | 'mobile_key' | 'code'>;
+                        method_issuance_strategy: 'first_available' | 'first_two_available' | 'all_available';
+                    };
+                } | undefined;
+                reservation_time_updated?: {
+                    rule: 'reservation_time_updated';
+                    config: {};
+                } | undefined;
+                reservation_deleted?: {
+                    rule: 'reservation_deleted';
+                    config: {};
+                } | undefined;
+            } | undefined;
+        };
+    };
+    '/seam/customer/v1/automations/update': {
+        route: '/seam/customer/v1/automations/update';
+        method: 'POST' | 'PATCH';
+        queryParams: {};
+        jsonBody: {
+            /** Access automation rules configuration. */
+            access_rules?: {
+                reservation_created?: {
+                    rule: 'reservation_created';
+                    config: {
+                        access_methods: Array<'card' | 'mobile_key' | 'code'>;
+                        method_issuance_strategy: 'first_available' | 'first_two_available' | 'all_available';
+                    };
+                } | undefined;
+                reservation_time_updated?: {
+                    rule: 'reservation_time_updated';
+                    config: {};
+                } | undefined;
+                reservation_deleted?: {
+                    rule: 'reservation_deleted';
+                    config: {};
+                } | undefined;
+            } | undefined;
+        };
+        commonParams: {};
+        formData: {};
+        jsonResponse: {};
+    };
     '/seam/customer/v1/portals/get': {
         route: '/seam/customer/v1/portals/get';
         method: 'GET' | 'POST';