diff --git a/docs/api/_blueprint.json b/docs/api/_blueprint.json index c0c16235c..e037c37bc 100644 --- a/docs/api/_blueprint.json +++ b/docs/api/_blueprint.json @@ -57409,6 +57409,84 @@ "isDeprecated": false, "isDraft": false }, + { + "path": "/seam/customer/v1/customers", + "name": "customers", + "namespacePath": "/seam/customer/v1", + "endpoints": [ + { + "title": "List Customers", + "name": "list", + "path": "/seam/customer/v1/customers/list", + "parentPath": "/seam/customer/v1/customers", + "description": "Returns a list of all customers within the workspace.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": true, + "undocumentedMessage": "Internal endpoint for Console.", + "isDraft": false, + "draftMessage": "", + "response": { + "responseType": "resource_list", + "responseKey": "customers", + "resourceType": "customer", + "description": "OK", + "actionAttemptType": null, + "batchResourceTypes": null + }, + "request": { + "methods": [ + "GET", + "POST" + ], + "semanticMethod": "GET", + "preferredMethod": "POST", + "parameters": [ + { + "name": "limit", + "description": "Maximum number of records to return per page.", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": true, + "default": 500, + "format": "number", + "jsonType": "number" + }, + { + "name": "page_cursor", + "description": "Identifies the specific page of results to return, obtained from the previous page's `next_page_cursor`.", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "string", + "jsonType": "string" + } + ] + }, + "hasPagination": true, + "authMethods": [ + "api_key", + "personal_access_token" + ], + "workspaceScope": "required", + "codeSamples": [] + } + ], + "parentPath": "/seam/customer/v1", + "isUndocumented": true, + "isDeprecated": false, + "isDraft": false + }, { "path": "/seam/customer/v1/events", "name": "events", @@ -89799,6 +89877,60 @@ } ] }, + { + "resourceType": "customer", + "properties": [ + { + "name": "created_at", + "description": "Date and time at which the customer was created.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "customer_key", + "description": "Unique key for the customer within the workspace.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "workspace_id", + "description": "ID of the [workspace](../core-concepts/workspaces/README.md) associated with the customer.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + } + ], + "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.", + "isDeprecated": false, + "routePath": "/customers", + "deprecationMessage": "", + "isUndocumented": true, + "undocumentedMessage": "Internal resource.", + "isDraft": false, + "draftMessage": "", + "propertyGroups": [], + "resourceSamples": [] + }, { "resourceType": "customization_profile", "properties": [ diff --git a/docs/api/_report.md b/docs/api/_report.md index 0f18f8b57..add20e06e 100644 --- a/docs/api/_report.md +++ b/docs/api/_report.md @@ -20,6 +20,7 @@ These items are intentionally undocumented. - `/seam/customer/v1/automation_runs`: No undocumented message provided - `/seam/customer/v1/automations`: No undocumented message provided - `/seam/customer/v1/connectors`: No undocumented message provided +- `/seam/customer/v1/customers`: No undocumented message provided - `/seam/customer/v1/events`: No undocumented message provided - `/seam/customer/v1/portals`: No undocumented message provided - `/seam/customer/v1/reservations`: No undocumented message provided @@ -42,6 +43,7 @@ These items are intentionally undocumented. - `acs_credential_provisioning_automation`: Deprecated. Will be removed. - `bridge_client_session`: Seam Bridge client only. - `bridge_connected_systems`: Seam Bridge client only. +- `customer`: Internal resource. - `customization_profile`: Unreleased. - `enrollment_automation`: Will be removed. - `magic_link`: Unreleased. @@ -107,6 +109,7 @@ These items are intentionally undocumented. - `/seam/customer/v1/connectors/list`: Internal endpoint for Console. - `/seam/customer/v1/connectors/sync`: Only used internally. - `/seam/customer/v1/connectors/update`: Internal endpoint for Console. +- `/seam/customer/v1/customers/list`: Internal endpoint for Console. - `/seam/customer/v1/events/list`: Internal endpoint for customer portals. - `/seam/customer/v1/portals/get`: Internal endpoint for customer portals. - `/seam/customer/v1/reservations/get`: Internal endpoint for customer portals. diff --git a/package-lock.json b/package-lock.json index b3912d715..4c43f966b 100644 --- a/package-lock.json +++ b/package-lock.json @@ -14,7 +14,7 @@ "@prettier/plugin-ruby": "^4.0.4", "@seamapi/blueprint": "^0.53.0", "@seamapi/smith": "^0.5.2", - "@seamapi/types": "1.682.0", + "@seamapi/types": "1.683.0", "@types/command-exists": "^1.2.3", "change-case": "^5.4.4", "command-exists": "^1.2.9", @@ -983,9 +983,9 @@ } }, "node_modules/@seamapi/types": { - "version": "1.682.0", - "resolved": "https://registry.npmjs.org/@seamapi/types/-/types-1.682.0.tgz", - "integrity": "sha512-rlESxdegjGMDOVqupvKAaZPR8slkTOPl3udVRCcUZ+Y9GIiUVF0dri95tAIR0nEbPqVig4Q3KNQaMoRMr5Y0nA==", + "version": "1.683.0", + "resolved": "https://registry.npmjs.org/@seamapi/types/-/types-1.683.0.tgz", + "integrity": "sha512-k01xjafqJX54HMLRfjeeyrP9dhKHVGS/824aptdElYo0JaWJQiEwvvLYunm4CYAFIa4mt4MhtoatE6VmQPyqUg==", "dev": true, "license": "MIT", "engines": { diff --git a/package.json b/package.json index e6dba7e94..db4afb86f 100644 --- a/package.json +++ b/package.json @@ -32,7 +32,7 @@ "@prettier/plugin-ruby": "^4.0.4", "@seamapi/blueprint": "^0.53.0", "@seamapi/smith": "^0.5.2", - "@seamapi/types": "1.682.0", + "@seamapi/types": "1.683.0", "@types/command-exists": "^1.2.3", "change-case": "^5.4.4", "command-exists": "^1.2.9",