@seamapi/types 1.761.0 → 1.763.0

package/dist/connect.d.cts

@@ -110724,6 +110724,7 @@ declare const _default: {
                                                                                         type: string;
                                                                                     };
                                                                                     errors?: never;
+                                                                                    properties_before?: never;
                                                                                     properties_updated?: never;
                                                                                     warnings?: never;
                                                                                     event_id?: never;
@@ -110756,6 +110757,12 @@ declare const _default: {
                                                                                         };
                                                                                         type: string;
                                                                                     };
+                                                                                    properties_before: {
+                                                                                        additionalProperties: {
+                                                                                            $ref: string;
+                                                                                        };
+                                                                                        type: string;
+                                                                                    };
                                                                                     properties_updated: {
                                                                                         additionalProperties: {
                                                                                             $ref: string;
@@ -110797,6 +110804,7 @@ declare const _default: {
                                                                                     };
                                                                                     description?: never;
                                                                                     errors?: never;
+                                                                                    properties_before?: never;
                                                                                     properties_updated?: never;
                                                                                     warnings?: never;
                                                                                     response_body?: never;
@@ -110832,6 +110840,7 @@ declare const _default: {
                                                                                         type: string;
                                                                                     };
                                                                                     errors?: never;
+                                                                                    properties_before?: never;
                                                                                     properties_updated?: never;
                                                                                     warnings?: never;
                                                                                     event_id?: never;
@@ -110872,6 +110881,7 @@ declare const _default: {
                                                                                     };
                                                                                     description?: never;
                                                                                     errors?: never;
+                                                                                    properties_before?: never;
                                                                                     properties_updated?: never;
                                                                                     warnings?: never;
                                                                                     event_id?: never;
@@ -110920,6 +110930,7 @@ declare const _default: {
                                                                                     };
                                                                                     description?: never;
                                                                                     errors?: never;
+                                                                                    properties_before?: never;
                                                                                     properties_updated?: never;
                                                                                     warnings?: never;
                                                                                     event_id?: never;
@@ -111173,6 +111184,7 @@ declare const _default: {
                                                                                         type: string;
                                                                                     };
                                                                                     errors?: never;
+                                                                                    properties_before?: never;
                                                                                     properties_updated?: never;
                                                                                     warnings?: never;
                                                                                     event_id?: never;
@@ -111205,6 +111217,12 @@ declare const _default: {
                                                                                         };
                                                                                         type: string;
                                                                                     };
+                                                                                    properties_before: {
+                                                                                        additionalProperties: {
+                                                                                            $ref: string;
+                                                                                        };
+                                                                                        type: string;
+                                                                                    };
                                                                                     properties_updated: {
                                                                                         additionalProperties: {
                                                                                             $ref: string;
@@ -111246,6 +111264,7 @@ declare const _default: {
                                                                                     };
                                                                                     description?: never;
                                                                                     errors?: never;
+                                                                                    properties_before?: never;
                                                                                     properties_updated?: never;
                                                                                     warnings?: never;
                                                                                     response_body?: never;
@@ -111281,6 +111300,7 @@ declare const _default: {
                                                                                         type: string;
                                                                                     };
                                                                                     errors?: never;
+                                                                                    properties_before?: never;
                                                                                     properties_updated?: never;
                                                                                     warnings?: never;
                                                                                     event_id?: never;
@@ -111321,6 +111341,7 @@ declare const _default: {
                                                                                     };
                                                                                     description?: never;
                                                                                     errors?: never;
+                                                                                    properties_before?: never;
                                                                                     properties_updated?: never;
                                                                                     warnings?: never;
                                                                                     event_id?: never;
@@ -111369,6 +111390,7 @@ declare const _default: {
                                                                                     };
                                                                                     description?: never;
                                                                                     errors?: never;
+                                                                                    properties_before?: never;
                                                                                     properties_updated?: never;
                                                                                     warnings?: never;
                                                                                     event_id?: never;
@@ -118558,6 +118580,135 @@ declare const _default: {
                 'x-undocumented': string;
             };
         };
+        '/seam/customer/v1/reservations/list_access_grants': {
+            get: {
+                description: string;
+                operationId: string;
+                parameters: {
+                    in: string;
+                    name: string;
+                    required: boolean;
+                    schema: {
+                        description: string;
+                        type: string;
+                    };
+                }[];
+                responses: {
+                    200: {
+                        content: {
+                            'application/json': {
+                                schema: {
+                                    properties: {
+                                        access_grants: {
+                                            items: {
+                                                $ref: string;
+                                            };
+                                            type: string;
+                                        };
+                                        ok: {
+                                            type: string;
+                                        };
+                                    };
+                                    required: string[];
+                                    type: string;
+                                };
+                            };
+                        };
+                        description: string;
+                    };
+                    400: {
+                        description: string;
+                    };
+                    401: {
+                        description: string;
+                    };
+                };
+                security: ({
+                    client_session_with_customer: never[];
+                    console_session_with_workspace?: never;
+                } | {
+                    console_session_with_workspace: never[];
+                    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: {
+                                    customer_key: {
+                                        description: string;
+                                        type: string;
+                                    };
+                                    reservation_key: {
+                                        description: string;
+                                        type: string;
+                                    };
+                                };
+                                required: string[];
+                                type: string;
+                            };
+                        };
+                    };
+                };
+                responses: {
+                    200: {
+                        content: {
+                            'application/json': {
+                                schema: {
+                                    properties: {
+                                        access_grants: {
+                                            items: {
+                                                $ref: string;
+                                            };
+                                            type: string;
+                                        };
+                                        ok: {
+                                            type: string;
+                                        };
+                                    };
+                                    required: string[];
+                                    type: string;
+                                };
+                            };
+                        };
+                        description: string;
+                    };
+                    400: {
+                        description: string;
+                    };
+                    401: {
+                        description: string;
+                    };
+                };
+                security: ({
+                    client_session_with_customer: never[];
+                    console_session_with_workspace?: never;
+                } | {
+                    console_session_with_workspace: never[];
+                    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/settings/business_verticals/list': {
             get: {
                 description: string;
@@ -191131,6 +191282,9 @@ type Routes = {
                             properties_updated?: {
                                 [x: string]: any;
                             } | undefined;
+                            properties_before?: {
+                                [x: string]: any;
+                            } | undefined;
                             errors?: string[] | undefined;
                             warnings?: string[] | undefined;
                         } | {
@@ -196428,6 +196582,179 @@ type Routes = {
         };
         maxDuration: undefined;
     };
+    '/seam/customer/v1/reservations/list_access_grants': {
+        route: '/seam/customer/v1/reservations/list_access_grants';
+        method: 'GET' | 'POST';
+        queryParams: {};
+        jsonBody: {};
+        commonParams: {
+            /** The customer_key identifying the customer. Required when not using client_session_with_customer auth. */
+            customer_key?: string | undefined;
+            /** The reservation_key to filter access grants by. */
+            reservation_key: string;
+        };
+        formData: {};
+        jsonResponse: {
+            access_grants: {
+                /** ID of the Seam workspace associated with the Access Grant. */
+                workspace_id: string;
+                /** ID of the Access Grant. */
+                access_grant_id: string;
+                /** Unique key for the access grant within the workspace. */
+                access_grant_key?: string | undefined;
+                /** Reservation key for the access grant. */
+                reservation_key?: string | undefined;
+                /** ID of user identity to which the Access Grant gives access. */
+                user_identity_id: string;
+                /**
+                 * @deprecated Use `space_ids`.*/
+                location_ids: string[];
+                /** IDs of the spaces to which the Access Grant gives access. */
+                space_ids: string[];
+                /** Access methods that the user requested for the Access Grant. */
+                requested_access_methods: {
+                    /** Display name of the access method. */
+                    display_name: string;
+                    /** Access method mode. Supported values: `code`, `card`, `mobile_key`. */
+                    mode: 'code' | 'card' | 'mobile_key';
+                    /** Specific PIN code to use for this access method. Only applicable when mode is 'code'. */
+                    code?: string | undefined;
+                    /** Maximum number of times the instant key can be used. Only applicable when mode is 'mobile_key'. Defaults to 1 if not specified. */
+                    instant_key_max_use_count?: number | undefined;
+                    /** Date and time at which the requested access method was added to the Access Grant. */
+                    created_at: string;
+                    /** IDs of the access methods created for the requested access method. */
+                    created_access_method_ids: string[];
+                }[];
+                /** IDs of the access methods created for the Access Grant. */
+                access_method_ids: string[];
+                /** Client Session Token. Only returned if the Access Grant has a mobile_key access method. */
+                client_session_token?: string | undefined;
+                /** Name of the Access Grant. If not provided, the display name will be computed. */
+                name: string | null;
+                /** Display name of the Access Grant. */
+                display_name: string;
+                /** Instant Key URL. Only returned if the Access Grant has a single mobile_key access_method.  */
+                instant_key_url?: string | undefined;
+                /** Date and time at which the Access Grant was created. */
+                created_at: string;
+                /** Date and time at which the Access Grant starts. */
+                starts_at: string;
+                /** Date and time at which the Access Grant ends. */
+                ends_at: string | null;
+                /** Warnings associated with the [access grant](https://docs.seam.co/latest/capability-guides/access-grants). */
+                warnings: ({
+                    /** Date and time at which Seam created the warning. */
+                    created_at: string;
+                    /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
+                    message: string;
+                    /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
+                    warning_code: 'being_deleted';
+                } | {
+                    /** Date and time at which Seam created the warning. */
+                    created_at: string;
+                    /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
+                    message: string;
+                    /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
+                    warning_code: 'underprovisioned_access';
+                } | {
+                    /** Date and time at which Seam created the warning. */
+                    created_at: string;
+                    /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
+                    message: string;
+                    /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
+                    warning_code: 'overprovisioned_access';
+                } | {
+                    /** Date and time at which Seam created the warning. */
+                    created_at: string;
+                    /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
+                    message: string;
+                    /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
+                    warning_code: 'updating_access_times';
+                    /** IDs of the access methods being updated. */
+                    access_method_ids: string[];
+                } | {
+                    /** Date and time at which Seam created the warning. */
+                    created_at: string;
+                    /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
+                    message: string;
+                    /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
+                    warning_code: 'requested_code_unavailable';
+                    /** ID of the device where the requested code was unavailable. */
+                    device_id: string;
+                    /** The originally requested PIN code that was unavailable. */
+                    original_code: string;
+                    /** The new PIN code that was assigned instead. */
+                    new_code: string;
+                } | {
+                    /** Date and time at which Seam created the warning. */
+                    created_at: string;
+                    /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
+                    message: string;
+                    /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
+                    warning_code: 'device_does_not_support_access_codes';
+                    /** ID of the device that does not support access codes. */
+                    device_id: string;
+                })[];
+                /** Errors associated with the [access grant](https://docs.seam.co/latest/capability-guides/access-grants). */
+                errors: {
+                    /** Date and time at which Seam created the error. */
+                    created_at: string;
+                    /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
+                    message: string;
+                    /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
+                    error_code: 'cannot_create_requested_access_methods';
+                }[];
+                /** ID of the customization profile associated with the Access Grant. */
+                customization_profile_id?: string | undefined;
+                /** List of pending mutations for the access grant. This shows updates that are in progress. */
+                pending_mutations: ({
+                    /** Date and time at which the mutation was created. */
+                    created_at: string;
+                    /** Detailed description of the mutation. */
+                    message: string;
+                    /** Mutation code to indicate that Seam is in the process of updating the spaces (devices) associated with this access grant. */
+                    mutation_code: 'updating_spaces';
+                    /** Previous location configuration. */
+                    from: {
+                        /** Previous device IDs where access codes existed. */
+                        device_ids: string[];
+                    };
+                    /** New location configuration. */
+                    to: {
+                        /** New device IDs where access codes should be created. */
+                        device_ids: string[];
+                        /** Common code key to ensure PIN code reuse across devices. */
+                        common_code_key?: (string | null) | undefined;
+                    };
+                } | {
+                    /** Date and time at which the mutation was created. */
+                    created_at: string;
+                    /** Detailed description of the mutation. */
+                    message: string;
+                    /** Mutation code to indicate that Seam is in the process of updating the access times for this access grant. */
+                    mutation_code: 'updating_access_times';
+                    /** IDs of the access methods being updated. */
+                    access_method_ids: string[];
+                    /** Previous access time configuration. */
+                    from: {
+                        /** Previous start time for access. */
+                        starts_at: string | null;
+                        /** Previous end time for access. */
+                        ends_at: string | null;
+                    };
+                    /** New access time configuration. */
+                    to: {
+                        /** New start time for access. */
+                        starts_at: string | null;
+                        /** New end time for access. */
+                        ends_at: string | null;
+                    };
+                })[];
+            }[];
+        };
+        maxDuration: undefined;
+    };
     '/seam/customer/v1/settings/business_verticals/list': {
         route: '/seam/customer/v1/settings/business_verticals/list';
         method: 'GET' | 'POST';

package/dist/index.cjs

@@ -61627,6 +61627,12 @@ var openapi_default = {
                                               items: { type: "string" },
                                               type: "array"
                                             },
+                                            properties_before: {
+                                              additionalProperties: {
+                                                $ref: "#/components/schemas/access_code"
+                                              },
+                                              type: "object"
+                                            },
                                             properties_updated: {
                                               additionalProperties: {
                                                 $ref: "#/components/schemas/access_code"
@@ -62012,6 +62018,12 @@ var openapi_default = {
                                               items: { type: "string" },
                                               type: "array"
                                             },
+                                            properties_before: {
+                                              additionalProperties: {
+                                                $ref: "#/components/schemas/access_code"
+                                              },
+                                              type: "object"
+                                            },
                                             properties_updated: {
                                               additionalProperties: {
                                                 $ref: "#/components/schemas/access_code"
@@ -68855,6 +68867,124 @@ var openapi_default = {
         "x-undocumented": "Internal endpoint for customer portals."
       }
     },
+    "/seam/customer/v1/reservations/list_access_grants": {
+      get: {
+        description: "Lists access grants linked to a reservation by reservation_key.",
+        operationId: "seamCustomerV1ReservationsListAccessGrantsGet",
+        parameters: [
+          {
+            in: "query",
+            name: "customer_key",
+            required: false,
+            schema: {
+              description: "The customer_key identifying the customer. Required when not using client_session_with_customer auth.",
+              type: "string"
+            }
+          },
+          {
+            in: "query",
+            name: "reservation_key",
+            required: true,
+            schema: {
+              description: "The reservation_key to filter access grants by.",
+              type: "string"
+            }
+          }
+        ],
+        responses: {
+          200: {
+            content: {
+              "application/json": {
+                schema: {
+                  properties: {
+                    access_grants: {
+                      items: { $ref: "#/components/schemas/access_grant" },
+                      type: "array"
+                    },
+                    ok: { type: "boolean" }
+                  },
+                  required: ["access_grants", "ok"],
+                  type: "object"
+                }
+              }
+            },
+            description: "OK"
+          },
+          400: { description: "Bad Request" },
+          401: { description: "Unauthorized" }
+        },
+        security: [
+          { client_session_with_customer: [] },
+          { console_session_with_workspace: [] }
+        ],
+        summary: "/seam/customer/v1/reservations/list_access_grants",
+        tags: [],
+        "x-fern-sdk-group-name": ["seam", "customer", "v1", "reservations"],
+        "x-fern-sdk-method-name": "list_access_grants",
+        "x-fern-sdk-return-value": "access_grants",
+        "x-response-key": "access_grants",
+        "x-title": "List Access Grants for Reservation",
+        "x-undocumented": "Internal endpoint for customer portals."
+      },
+      post: {
+        description: "Lists access grants linked to a reservation by reservation_key.",
+        operationId: "seamCustomerV1ReservationsListAccessGrantsPost",
+        requestBody: {
+          content: {
+            "application/json": {
+              schema: {
+                properties: {
+                  customer_key: {
+                    description: "The customer_key identifying the customer. Required when not using client_session_with_customer auth.",
+                    type: "string"
+                  },
+                  reservation_key: {
+                    description: "The reservation_key to filter access grants by.",
+                    type: "string"
+                  }
+                },
+                required: ["reservation_key"],
+                type: "object"
+              }
+            }
+          }
+        },
+        responses: {
+          200: {
+            content: {
+              "application/json": {
+                schema: {
+                  properties: {
+                    access_grants: {
+                      items: { $ref: "#/components/schemas/access_grant" },
+                      type: "array"
+                    },
+                    ok: { type: "boolean" }
+                  },
+                  required: ["access_grants", "ok"],
+                  type: "object"
+                }
+              }
+            },
+            description: "OK"
+          },
+          400: { description: "Bad Request" },
+          401: { description: "Unauthorized" }
+        },
+        security: [
+          { client_session_with_customer: [] },
+          { console_session_with_workspace: [] }
+        ],
+        summary: "/seam/customer/v1/reservations/list_access_grants",
+        tags: [],
+        "x-fern-sdk-group-name": ["seam", "customer", "v1", "reservations"],
+        "x-fern-sdk-method-name": "list_access_grants",
+        "x-fern-sdk-return-value": "access_grants",
+        "x-response-key": "access_grants",
+        "x-title": "List Access Grants for Reservation",
+        "x-undocumented": "Internal endpoint for customer portals."
+      }
+    },
     "/seam/customer/v1/settings/business_verticals/list": {
       get: {
         description: "Returns all available business verticals.",