@seamapi/types 1.630.0 → 1.632.0

package/dist/connect.d.cts

@@ -72794,14 +72794,22 @@ declare const _default: {
                     pat_with_workspace: never[];
                     console_session_with_workspace?: never;
                     api_key?: never;
+                    client_session_with_customer?: never;
                 } | {
                     console_session_with_workspace: never[];
                     pat_with_workspace?: never;
                     api_key?: never;
+                    client_session_with_customer?: never;
                 } | {
                     api_key: never[];
                     pat_with_workspace?: never;
                     console_session_with_workspace?: never;
+                    client_session_with_customer?: never;
+                } | {
+                    client_session_with_customer: never[];
+                    pat_with_workspace?: never;
+                    console_session_with_workspace?: never;
+                    api_key?: never;
                 })[];
                 summary: string;
                 tags: never[];
@@ -73051,14 +73059,22 @@ declare const _default: {
                     pat_with_workspace: never[];
                     console_session_with_workspace?: never;
                     api_key?: never;
+                    client_session_with_customer?: never;
                 } | {
                     console_session_with_workspace: never[];
                     pat_with_workspace?: never;
                     api_key?: never;
+                    client_session_with_customer?: never;
                 } | {
                     api_key: never[];
                     pat_with_workspace?: never;
                     console_session_with_workspace?: never;
+                    client_session_with_customer?: never;
+                } | {
+                    client_session_with_customer: never[];
+                    pat_with_workspace?: never;
+                    console_session_with_workspace?: never;
+                    api_key?: never;
                 })[];
                 summary: string;
                 tags: never[];
@@ -93844,6 +93860,109 @@ declare const _default: {
                 'x-undocumented': string;
             };
         };
+        '/seam/customer/v1/access_grants/list': {
+            get: {
+                description: string;
+                operationId: string;
+                parameters: never[];
+                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[];
+                }[];
+                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: {};
+                                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[];
+                }[];
+                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/automation_runs/list': {
             get: {
                 description: string;
@@ -106170,14 +106289,22 @@ declare const _default: {
                     api_key: never[];
                     pat_with_workspace?: never;
                     console_session_with_workspace?: never;
+                    client_session_with_customer?: never;
                 } | {
                     pat_with_workspace: never[];
                     api_key?: never;
                     console_session_with_workspace?: never;
+                    client_session_with_customer?: never;
                 } | {
                     console_session_with_workspace: never[];
                     api_key?: never;
                     pat_with_workspace?: never;
+                    client_session_with_customer?: never;
+                } | {
+                    client_session_with_customer: never[];
+                    api_key?: never;
+                    pat_with_workspace?: never;
+                    console_session_with_workspace?: never;
                 })[];
                 summary: string;
                 tags: string[];
@@ -106250,14 +106377,22 @@ declare const _default: {
                     api_key: never[];
                     pat_with_workspace?: never;
                     console_session_with_workspace?: never;
+                    client_session_with_customer?: never;
                 } | {
                     pat_with_workspace: never[];
                     api_key?: never;
                     console_session_with_workspace?: never;
+                    client_session_with_customer?: never;
                 } | {
                     console_session_with_workspace: never[];
                     api_key?: never;
                     pat_with_workspace?: never;
+                    client_session_with_customer?: never;
+                } | {
+                    client_session_with_customer: never[];
+                    api_key?: never;
+                    pat_with_workspace?: never;
+                    console_session_with_workspace?: never;
                 })[];
                 summary: string;
                 tags: string[];
@@ -167918,6 +168053,73 @@ type Routes = {
             };
         };
     };
+    '/seam/customer/v1/access_grants/list': {
+        route: '/seam/customer/v1/access_grants/list';
+        method: 'GET' | 'POST';
+        queryParams: {};
+        jsonBody: {};
+        commonParams: {};
+        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;
+                    /** 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';
+                }[];
+                /** ID of the customization profile associated with the Access Grant. */
+                customization_profile_id?: string | undefined;
+            }[];
+        };
+    };
     '/seam/customer/v1/automation_runs/list': {
         route: '/seam/customer/v1/automation_runs/list';
         method: 'GET' | 'POST';

package/dist/index.cjs

@@ -34110,7 +34110,8 @@ var openapi_default = {
         security: [
           { pat_with_workspace: [] },
           { console_session_with_workspace: [] },
-          { api_key: [] }
+          { api_key: [] },
+          { client_session_with_customer: [] }
         ],
         summary: "/access_methods/get_related",
         tags: [],
@@ -34345,7 +34346,8 @@ var openapi_default = {
         security: [
           { pat_with_workspace: [] },
           { console_session_with_workspace: [] },
-          { api_key: [] }
+          { api_key: [] },
+          { client_session_with_customer: [] }
         ],
         summary: "/access_methods/get_related",
         tags: [],
@@ -52868,6 +52870,84 @@ var openapi_default = {
         "x-undocumented": "Internal endpoint for Console"
       }
     },
+    "/seam/customer/v1/access_grants/list": {
+      get: {
+        description: "Gets an Access Grant.",
+        operationId: "seamCustomerV1AccessGrantsListGet",
+        parameters: [],
+        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: [] }],
+        summary: "/seam/customer/v1/access_grants/list",
+        tags: [],
+        "x-fern-sdk-group-name": ["seam", "customer", "v1", "access_grants"],
+        "x-fern-sdk-method-name": "list",
+        "x-fern-sdk-return-value": "access_grants",
+        "x-response-key": "access_grants",
+        "x-title": "List Access Grants (Other Access)",
+        "x-undocumented": "Internal endpoint for customer portals."
+      },
+      post: {
+        description: "Gets an Access Grant.",
+        operationId: "seamCustomerV1AccessGrantsListPost",
+        requestBody: {
+          content: {
+            "application/json": { schema: { properties: {}, 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: [] }],
+        summary: "/seam/customer/v1/access_grants/list",
+        tags: [],
+        "x-fern-sdk-group-name": ["seam", "customer", "v1", "access_grants"],
+        "x-fern-sdk-method-name": "list",
+        "x-fern-sdk-return-value": "access_grants",
+        "x-response-key": "access_grants",
+        "x-title": "List Access Grants (Other Access)",
+        "x-undocumented": "Internal endpoint for customer portals."
+      }
+    },
     "/seam/customer/v1/automation_runs/list": {
       get: {
         description: "Returns a list of all automation runs for a workspace or customer.",
@@ -63241,7 +63321,8 @@ var openapi_default = {
         security: [
           { api_key: [] },
           { pat_with_workspace: [] },
-          { console_session_with_workspace: [] }
+          { console_session_with_workspace: [] },
+          { client_session_with_customer: [] }
         ],
         summary: "/user_identities/get",
         tags: ["/user_identities"],
@@ -63304,7 +63385,8 @@ var openapi_default = {
         security: [
           { api_key: [] },
           { pat_with_workspace: [] },
-          { console_session_with_workspace: [] }
+          { console_session_with_workspace: [] },
+          { client_session_with_customer: [] }
         ],
         summary: "/user_identities/get",
         tags: ["/user_identities"],