@seamapi/types 1.682.0 → 1.683.0

package/dist/connect.d.cts

@@ -57660,6 +57660,29 @@ declare const _default: {
                 type: string;
                 'x-route-path': string;
             };
+            customer: {
+                description: string;
+                properties: {
+                    created_at: {
+                        description: string;
+                        format: string;
+                        type: string;
+                    };
+                    customer_key: {
+                        description: string;
+                        type: string;
+                    };
+                    workspace_id: {
+                        description: string;
+                        format: string;
+                        type: string;
+                    };
+                };
+                required: string[];
+                type: string;
+                'x-route-path': string;
+                'x-undocumented': string;
+            };
             customization_profile: {
                 description: string;
                 properties: {
@@ -98518,6 +98541,170 @@ declare const _default: {
                 'x-undocumented': string;
             };
         };
+        '/seam/customer/v1/customers/list': {
+            get: {
+                description: string;
+                operationId: string;
+                parameters: ({
+                    in: string;
+                    name: string;
+                    schema: {
+                        default: number;
+                        description: string;
+                        exclusiveMinimum: boolean;
+                        minimum: number;
+                        type: string;
+                        nullable?: never;
+                    };
+                } | {
+                    in: string;
+                    name: string;
+                    schema: {
+                        description: string;
+                        nullable: boolean;
+                        type: string;
+                        default?: never;
+                        exclusiveMinimum?: never;
+                        minimum?: never;
+                    };
+                })[];
+                responses: {
+                    200: {
+                        content: {
+                            'application/json': {
+                                schema: {
+                                    properties: {
+                                        customers: {
+                                            items: {
+                                                $ref: string;
+                                            };
+                                            type: string;
+                                        };
+                                        ok: {
+                                            type: string;
+                                        };
+                                        pagination: {
+                                            $ref: string;
+                                        };
+                                    };
+                                    required: string[];
+                                    type: string;
+                                };
+                            };
+                        };
+                        description: string;
+                    };
+                    400: {
+                        description: string;
+                    };
+                    401: {
+                        description: string;
+                    };
+                };
+                security: ({
+                    api_key: never[];
+                    pat_with_workspace?: never;
+                    console_session_with_workspace?: never;
+                } | {
+                    pat_with_workspace: never[];
+                    api_key?: never;
+                    console_session_with_workspace?: never;
+                } | {
+                    console_session_with_workspace: never[];
+                    api_key?: never;
+                    pat_with_workspace?: 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: {
+                                    limit: {
+                                        default: number;
+                                        description: string;
+                                        exclusiveMinimum: boolean;
+                                        minimum: number;
+                                        type: string;
+                                    };
+                                    page_cursor: {
+                                        description: string;
+                                        nullable: boolean;
+                                        type: string;
+                                    };
+                                };
+                                type: string;
+                            };
+                        };
+                    };
+                };
+                responses: {
+                    200: {
+                        content: {
+                            'application/json': {
+                                schema: {
+                                    properties: {
+                                        customers: {
+                                            items: {
+                                                $ref: string;
+                                            };
+                                            type: string;
+                                        };
+                                        ok: {
+                                            type: string;
+                                        };
+                                        pagination: {
+                                            $ref: string;
+                                        };
+                                    };
+                                    required: string[];
+                                    type: string;
+                                };
+                            };
+                        };
+                        description: string;
+                    };
+                    400: {
+                        description: string;
+                    };
+                    401: {
+                        description: string;
+                    };
+                };
+                security: ({
+                    api_key: never[];
+                    pat_with_workspace?: never;
+                    console_session_with_workspace?: never;
+                } | {
+                    pat_with_workspace: never[];
+                    api_key?: never;
+                    console_session_with_workspace?: never;
+                } | {
+                    console_session_with_workspace: never[];
+                    api_key?: never;
+                    pat_with_workspace?: 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/events/list': {
             get: {
                 description: string;
@@ -166639,6 +166826,39 @@ type Routes = {
         };
         maxDuration: undefined;
     };
+    '/seam/customer/v1/customers/list': {
+        route: '/seam/customer/v1/customers/list';
+        method: 'GET' | 'POST';
+        queryParams: {};
+        jsonBody: {};
+        commonParams: {
+            /** Maximum number of records to return per page. */
+            limit?: number;
+            /** Identifies the specific page of results to return, obtained from the previous page's `next_page_cursor`. */
+            page_cursor?: ((string | undefined) | null) | undefined;
+        };
+        formData: {};
+        jsonResponse: {
+            customers: {
+                /** Unique key for the customer within the workspace. */
+                customer_key: string;
+                /** ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) associated with the customer. */
+                workspace_id: string;
+                /** Date and time at which the customer was created. */
+                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;
+            };
+        };
+        maxDuration: undefined;
+    };
     '/seam/customer/v1/events/list': {
         route: '/seam/customer/v1/events/list';
         method: 'GET' | 'POST';

package/dist/index.cjs

@@ -14361,6 +14361,29 @@ var openapi_default = {
         type: "object",
         "x-route-path": "/connected_accounts"
       },
+      customer: {
+        description: "Represents a customer within a workspace. Customers are used to organize resources and manage access for different clients, such as hotels, property managers, and more.",
+        properties: {
+          created_at: {
+            description: "Date and time at which the customer was created.",
+            format: "date-time",
+            type: "string"
+          },
+          customer_key: {
+            description: "Unique key for the customer within the workspace.",
+            type: "string"
+          },
+          workspace_id: {
+            description: "ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) associated with the customer.",
+            format: "uuid",
+            type: "string"
+          }
+        },
+        required: ["customer_key", "workspace_id", "created_at"],
+        type: "object",
+        "x-route-path": "/customers",
+        "x-undocumented": "Internal resource."
+      },
       customization_profile: {
         description: "A customization profile.",
         properties: {
@@ -56159,6 +56182,133 @@ var openapi_default = {
         "x-undocumented": "Internal endpoint for Console."
       }
     },
+    "/seam/customer/v1/customers/list": {
+      get: {
+        description: "Returns a list of all customers within the workspace.",
+        operationId: "seamCustomerV1CustomersListGet",
+        parameters: [
+          {
+            in: "query",
+            name: "limit",
+            schema: {
+              default: 500,
+              description: "Maximum number of records to return per page.",
+              exclusiveMinimum: true,
+              minimum: 0,
+              type: "integer"
+            }
+          },
+          {
+            in: "query",
+            name: "page_cursor",
+            schema: {
+              description: "Identifies the specific page of results to return, obtained from the previous page's `next_page_cursor`.",
+              nullable: true,
+              type: "string"
+            }
+          }
+        ],
+        responses: {
+          200: {
+            content: {
+              "application/json": {
+                schema: {
+                  properties: {
+                    customers: {
+                      items: { $ref: "#/components/schemas/customer" },
+                      type: "array"
+                    },
+                    ok: { type: "boolean" },
+                    pagination: { $ref: "#/components/schemas/pagination" }
+                  },
+                  required: ["customers", "pagination", "ok"],
+                  type: "object"
+                }
+              }
+            },
+            description: "OK"
+          },
+          400: { description: "Bad Request" },
+          401: { description: "Unauthorized" }
+        },
+        security: [
+          { api_key: [] },
+          { pat_with_workspace: [] },
+          { console_session_with_workspace: [] }
+        ],
+        summary: "/seam/customer/v1/customers/list",
+        tags: [],
+        "x-fern-sdk-group-name": ["seam", "customer", "v1", "customers"],
+        "x-fern-sdk-method-name": "list",
+        "x-fern-sdk-return-value": "customers",
+        "x-response-key": "customers",
+        "x-title": "List Customers",
+        "x-undocumented": "Internal endpoint for Console."
+      },
+      post: {
+        description: "Returns a list of all customers within the workspace.",
+        operationId: "seamCustomerV1CustomersListPost",
+        requestBody: {
+          content: {
+            "application/json": {
+              schema: {
+                properties: {
+                  limit: {
+                    default: 500,
+                    description: "Maximum number of records to return per page.",
+                    exclusiveMinimum: true,
+                    minimum: 0,
+                    type: "integer"
+                  },
+                  page_cursor: {
+                    description: "Identifies the specific page of results to return, obtained from the previous page's `next_page_cursor`.",
+                    nullable: true,
+                    type: "string"
+                  }
+                },
+                type: "object"
+              }
+            }
+          }
+        },
+        responses: {
+          200: {
+            content: {
+              "application/json": {
+                schema: {
+                  properties: {
+                    customers: {
+                      items: { $ref: "#/components/schemas/customer" },
+                      type: "array"
+                    },
+                    ok: { type: "boolean" },
+                    pagination: { $ref: "#/components/schemas/pagination" }
+                  },
+                  required: ["customers", "pagination", "ok"],
+                  type: "object"
+                }
+              }
+            },
+            description: "OK"
+          },
+          400: { description: "Bad Request" },
+          401: { description: "Unauthorized" }
+        },
+        security: [
+          { api_key: [] },
+          { pat_with_workspace: [] },
+          { console_session_with_workspace: [] }
+        ],
+        summary: "/seam/customer/v1/customers/list",
+        tags: [],
+        "x-fern-sdk-group-name": ["seam", "customer", "v1", "customers"],
+        "x-fern-sdk-method-name": "list",
+        "x-fern-sdk-return-value": "customers",
+        "x-response-key": "customers",
+        "x-title": "List Customers",
+        "x-undocumented": "Internal endpoint for Console."
+      }
+    },
     "/seam/customer/v1/events/list": {
       get: {
         description: "Returns a list of events for devices in a specific space. This endpoint is designed for customer portals and only supports filtering by space_id.",