@seamapi/types 1.682.0 → 1.683.0

package/lib/seam/connect/models/customer/customer.d.ts

@@ -0,0 +1,15 @@
+import { z } from 'zod';
+export declare const customer: z.ZodObject<{
+    customer_key: z.ZodString;
+    workspace_id: z.ZodString;
+    created_at: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    workspace_id: string;
+    created_at: string;
+    customer_key: string;
+}, {
+    workspace_id: string;
+    created_at: string;
+    customer_key: string;
+}>;
+export type Customer = z.infer<typeof customer>;

package/lib/seam/connect/models/customer/customer.js

@@ -0,0 +1,21 @@
+import { z } from 'zod';
+export const customer = z.object({
+    customer_key: z
+        .string()
+        .describe('Unique key for the customer within the workspace.'),
+    workspace_id: z
+        .string()
+        .uuid()
+        .describe('ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) associated with the customer.'),
+    created_at: z
+        .string()
+        .datetime()
+        .describe('Date and time at which the customer was created.'),
+}).describe(`
+  ---
+  route_path: /customers
+  undocumented: Internal resource.
+  ---
+  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.
+  `);
+//# sourceMappingURL=customer.js.map

package/lib/seam/connect/models/customer/customer.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"customer.js","sourceRoot":"","sources":["../../../../../src/lib/seam/connect/models/customer/customer.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAA;AAEvB,MAAM,CAAC,MAAM,QAAQ,GAAG,CAAC,CAAC,MAAM,CAAC;IAC/B,YAAY,EAAE,CAAC;SACZ,MAAM,EAAE;SACR,QAAQ,CAAC,mDAAmD,CAAC;IAChE,YAAY,EAAE,CAAC;SACZ,MAAM,EAAE;SACR,IAAI,EAAE;SACN,QAAQ,CACP,2GAA2G,CAC5G;IACH,UAAU,EAAE,CAAC;SACV,MAAM,EAAE;SACR,QAAQ,EAAE;SACV,QAAQ,CAAC,kDAAkD,CAAC;CAChE,CAAC,CAAC,QAAQ,CAAC;;;;;;GAMT,CAAC,CAAA"}

package/lib/seam/connect/models/customer/index.d.ts

@@ -1,4 +1,5 @@
 export * from './business-vertical.js';
+export * from './customer.js';
 export * from './customer-data.js';
 export * from './customer-delete-data.js';
 export * from './customer-portal.js';

package/lib/seam/connect/models/customer/index.js

@@ -1,4 +1,5 @@
 export * from './business-vertical.js';
+export * from './customer.js';
 export * from './customer-data.js';
 export * from './customer-delete-data.js';
 export * from './customer-portal.js';

package/lib/seam/connect/models/customer/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../../src/lib/seam/connect/models/customer/index.ts"],"names":[],"mappings":"AAAA,cAAc,wBAAwB,CAAA;AACtC,cAAc,oBAAoB,CAAA;AAClC,cAAc,2BAA2B,CAAA;AACzC,cAAc,sBAAsB,CAAA"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../../src/lib/seam/connect/models/customer/index.ts"],"names":[],"mappings":"AAAA,cAAc,wBAAwB,CAAA;AACtC,cAAc,eAAe,CAAA;AAC7B,cAAc,oBAAoB,CAAA;AAClC,cAAc,2BAA2B,CAAA;AACzC,cAAc,sBAAsB,CAAA"}

package/lib/seam/connect/openapi.d.ts

@@ -4601,6 +4601,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: {
@@ -45459,6 +45482,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;

package/lib/seam/connect/openapi.js

@@ -8461,6 +8461,29 @@ export 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: {
@@ -50259,6 +50282,133 @@ export 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.',