@seamapi/types 1.682.0 → 1.684.0

package/lib/seam/connect/openapi.js

@@ -1937,24 +1937,50 @@ export default {
                         description: 'Warnings associated with the `acs_access_group`.',
                         items: {
                             description: 'Warning associated with the `acs_access_group`.',
-                            properties: {
-                                created_at: {
-                                    description: 'Date and time at which Seam created the warning.',
-                                    format: 'date-time',
-                                    type: 'string',
-                                },
-                                message: {
-                                    description: 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
-                                    type: 'string',
+                            oneOf: [
+                                {
+                                    description: 'An unknown issue occurred while syncing the state of this access group with the provider. This issue may affect the proper functioning of this access group.',
+                                    properties: {
+                                        created_at: {
+                                            description: 'Date and time at which Seam created the warning.',
+                                            format: 'date-time',
+                                            type: 'string',
+                                        },
+                                        message: {
+                                            description: 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
+                                            type: 'string',
+                                        },
+                                        warning_code: {
+                                            description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
+                                            enum: ['unknown_issue_with_acs_access_group'],
+                                            type: 'string',
+                                        },
+                                    },
+                                    required: ['created_at', 'message', 'warning_code'],
+                                    type: 'object',
                                 },
-                                warning_code: {
-                                    description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
-                                    enum: ['unknown_issue_with_acs_access_group'],
-                                    type: 'string',
+                                {
+                                    description: 'Indicates that the access group is being deleted from the access system. This is a temporary state, and the access group will be deleted shortly.',
+                                    properties: {
+                                        created_at: {
+                                            description: 'Date and time at which Seam created the warning.',
+                                            format: 'date-time',
+                                            type: 'string',
+                                        },
+                                        message: {
+                                            description: 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
+                                            type: 'string',
+                                        },
+                                        warning_code: {
+                                            description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
+                                            enum: ['being_deleted'],
+                                            type: 'string',
+                                        },
+                                    },
+                                    required: ['created_at', 'message', 'warning_code'],
+                                    type: 'object',
                                 },
-                            },
-                            required: ['created_at', 'message', 'warning_code'],
-                            type: 'object',
+                            ],
                         },
                         type: 'array',
                     },
@@ -8461,6 +8487,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: {
@@ -20986,24 +21035,50 @@ export default {
                         description: 'Warnings associated with the `acs_access_group`.',
                         items: {
                             description: 'Warning associated with the `acs_access_group`.',
-                            properties: {
-                                created_at: {
-                                    description: 'Date and time at which Seam created the warning.',
-                                    format: 'date-time',
-                                    type: 'string',
-                                },
-                                message: {
-                                    description: 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
-                                    type: 'string',
+                            oneOf: [
+                                {
+                                    description: 'An unknown issue occurred while syncing the state of this access group with the provider. This issue may affect the proper functioning of this access group.',
+                                    properties: {
+                                        created_at: {
+                                            description: 'Date and time at which Seam created the warning.',
+                                            format: 'date-time',
+                                            type: 'string',
+                                        },
+                                        message: {
+                                            description: 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
+                                            type: 'string',
+                                        },
+                                        warning_code: {
+                                            description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
+                                            enum: ['unknown_issue_with_acs_access_group'],
+                                            type: 'string',
+                                        },
+                                    },
+                                    required: ['created_at', 'message', 'warning_code'],
+                                    type: 'object',
                                 },
-                                warning_code: {
-                                    description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
-                                    enum: ['unknown_issue_with_acs_access_group'],
-                                    type: 'string',
+                                {
+                                    description: 'Indicates that the access group is being deleted from the access system. This is a temporary state, and the access group will be deleted shortly.',
+                                    properties: {
+                                        created_at: {
+                                            description: 'Date and time at which Seam created the warning.',
+                                            format: 'date-time',
+                                            type: 'string',
+                                        },
+                                        message: {
+                                            description: 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
+                                            type: 'string',
+                                        },
+                                        warning_code: {
+                                            description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
+                                            enum: ['being_deleted'],
+                                            type: 'string',
+                                        },
+                                    },
+                                    required: ['created_at', 'message', 'warning_code'],
+                                    type: 'object',
                                 },
-                            },
-                            required: ['created_at', 'message', 'warning_code'],
-                            type: 'object',
+                            ],
                         },
                         type: 'array',
                     },
@@ -29551,6 +29626,101 @@ export default {
                 'x-title': 'Add an ACS User to an Access Group',
             },
         },
+        '/acs/access_groups/delete': {
+            delete: {
+                description: 'Deletes a specified [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups).',
+                operationId: 'acsAccessGroupsDeleteDelete',
+                parameters: [
+                    {
+                        in: 'query',
+                        name: 'acs_access_group_id',
+                        required: true,
+                        schema: {
+                            description: 'ID of the access group that you want to delete.',
+                            format: 'uuid',
+                            type: 'string',
+                        },
+                    },
+                ],
+                responses: {
+                    200: {
+                        content: {
+                            'application/json': {
+                                schema: {
+                                    properties: { ok: { type: 'boolean' } },
+                                    required: ['ok'],
+                                    type: 'object',
+                                },
+                            },
+                        },
+                        description: 'OK',
+                    },
+                    400: { description: 'Bad Request' },
+                    401: { description: 'Unauthorized' },
+                },
+                security: [
+                    { client_session: [] },
+                    { pat_with_workspace: [] },
+                    { console_session_with_workspace: [] },
+                    { api_key: [] },
+                ],
+                summary: '/acs/access_groups/delete',
+                tags: ['/acs'],
+                'x-fern-sdk-group-name': ['acs', 'access_groups'],
+                'x-fern-sdk-method-name': 'delete',
+                'x-response-key': null,
+                'x-title': 'Delete an Access Group',
+            },
+            post: {
+                description: 'Deletes a specified [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups).',
+                operationId: 'acsAccessGroupsDeletePost',
+                requestBody: {
+                    content: {
+                        'application/json': {
+                            schema: {
+                                properties: {
+                                    acs_access_group_id: {
+                                        description: 'ID of the access group that you want to delete.',
+                                        format: 'uuid',
+                                        type: 'string',
+                                    },
+                                },
+                                required: ['acs_access_group_id'],
+                                type: 'object',
+                            },
+                        },
+                    },
+                },
+                responses: {
+                    200: {
+                        content: {
+                            'application/json': {
+                                schema: {
+                                    properties: { ok: { type: 'boolean' } },
+                                    required: ['ok'],
+                                    type: 'object',
+                                },
+                            },
+                        },
+                        description: 'OK',
+                    },
+                    400: { description: 'Bad Request' },
+                    401: { description: 'Unauthorized' },
+                },
+                security: [
+                    { client_session: [] },
+                    { pat_with_workspace: [] },
+                    { console_session_with_workspace: [] },
+                    { api_key: [] },
+                ],
+                summary: '/acs/access_groups/delete',
+                tags: ['/acs'],
+                'x-fern-sdk-group-name': ['acs', 'access_groups'],
+                'x-fern-sdk-method-name': 'delete',
+                'x-response-key': null,
+                'x-title': 'Delete an Access Group',
+            },
+        },
         '/acs/access_groups/get': {
             get: {
                 description: 'Returns a specified [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups).',
@@ -50259,6 +50429,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.',