Skip to content

Commit adad492

Browse files
committed
ci: Generate docs
1 parent eb853fd commit adad492

File tree

2 files changed

+135
-0
lines changed

2 files changed

+135
-0
lines changed

docs/api/_blueprint.json

Lines changed: 132 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -57409,6 +57409,84 @@
5740957409
"isDeprecated": false,
5741057410
"isDraft": false
5741157411
},
57412+
{
57413+
"path": "/seam/customer/v1/customers",
57414+
"name": "customers",
57415+
"namespacePath": "/seam/customer/v1",
57416+
"endpoints": [
57417+
{
57418+
"title": "List Customers",
57419+
"name": "list",
57420+
"path": "/seam/customer/v1/customers/list",
57421+
"parentPath": "/seam/customer/v1/customers",
57422+
"description": "Returns a list of all customers within the workspace.",
57423+
"isDeprecated": false,
57424+
"deprecationMessage": "",
57425+
"isUndocumented": true,
57426+
"undocumentedMessage": "Internal endpoint for Console.",
57427+
"isDraft": false,
57428+
"draftMessage": "",
57429+
"response": {
57430+
"responseType": "resource_list",
57431+
"responseKey": "customers",
57432+
"resourceType": "customer",
57433+
"description": "OK",
57434+
"actionAttemptType": null,
57435+
"batchResourceTypes": null
57436+
},
57437+
"request": {
57438+
"methods": [
57439+
"GET",
57440+
"POST"
57441+
],
57442+
"semanticMethod": "GET",
57443+
"preferredMethod": "POST",
57444+
"parameters": [
57445+
{
57446+
"name": "limit",
57447+
"description": "Maximum number of records to return per page.",
57448+
"isRequired": false,
57449+
"isDeprecated": false,
57450+
"deprecationMessage": "",
57451+
"isUndocumented": false,
57452+
"undocumentedMessage": "",
57453+
"isDraft": false,
57454+
"draftMessage": "",
57455+
"hasDefault": true,
57456+
"default": 500,
57457+
"format": "number",
57458+
"jsonType": "number"
57459+
},
57460+
{
57461+
"name": "page_cursor",
57462+
"description": "Identifies the specific page of results to return, obtained from the previous page's `next_page_cursor`.",
57463+
"isRequired": false,
57464+
"isDeprecated": false,
57465+
"deprecationMessage": "",
57466+
"isUndocumented": false,
57467+
"undocumentedMessage": "",
57468+
"isDraft": false,
57469+
"draftMessage": "",
57470+
"hasDefault": false,
57471+
"format": "string",
57472+
"jsonType": "string"
57473+
}
57474+
]
57475+
},
57476+
"hasPagination": true,
57477+
"authMethods": [
57478+
"api_key",
57479+
"personal_access_token"
57480+
],
57481+
"workspaceScope": "required",
57482+
"codeSamples": []
57483+
}
57484+
],
57485+
"parentPath": "/seam/customer/v1",
57486+
"isUndocumented": true,
57487+
"isDeprecated": false,
57488+
"isDraft": false
57489+
},
5741257490
{
5741357491
"path": "/seam/customer/v1/events",
5741457492
"name": "events",
@@ -89799,6 +89877,60 @@
8979989877
}
8980089878
]
8980189879
},
89880+
{
89881+
"resourceType": "customer",
89882+
"properties": [
89883+
{
89884+
"name": "created_at",
89885+
"description": "Date and time at which the customer was created.",
89886+
"isDeprecated": false,
89887+
"deprecationMessage": "",
89888+
"isUndocumented": false,
89889+
"undocumentedMessage": "",
89890+
"isDraft": false,
89891+
"draftMessage": "",
89892+
"propertyGroupKey": null,
89893+
"format": "datetime",
89894+
"jsonType": "string"
89895+
},
89896+
{
89897+
"name": "customer_key",
89898+
"description": "Unique key for the customer within the workspace.",
89899+
"isDeprecated": false,
89900+
"deprecationMessage": "",
89901+
"isUndocumented": false,
89902+
"undocumentedMessage": "",
89903+
"isDraft": false,
89904+
"draftMessage": "",
89905+
"propertyGroupKey": null,
89906+
"format": "string",
89907+
"jsonType": "string"
89908+
},
89909+
{
89910+
"name": "workspace_id",
89911+
"description": "ID of the [workspace](../core-concepts/workspaces/README.md) associated with the customer.",
89912+
"isDeprecated": false,
89913+
"deprecationMessage": "",
89914+
"isUndocumented": false,
89915+
"undocumentedMessage": "",
89916+
"isDraft": false,
89917+
"draftMessage": "",
89918+
"propertyGroupKey": null,
89919+
"format": "id",
89920+
"jsonType": "string"
89921+
}
89922+
],
89923+
"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.",
89924+
"isDeprecated": false,
89925+
"routePath": "/customers",
89926+
"deprecationMessage": "",
89927+
"isUndocumented": true,
89928+
"undocumentedMessage": "Internal resource.",
89929+
"isDraft": false,
89930+
"draftMessage": "",
89931+
"propertyGroups": [],
89932+
"resourceSamples": []
89933+
},
8980289934
{
8980389935
"resourceType": "customization_profile",
8980489936
"properties": [

docs/api/_report.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,7 @@ These items are intentionally undocumented.
2020
- `/seam/customer/v1/automation_runs`: No undocumented message provided
2121
- `/seam/customer/v1/automations`: No undocumented message provided
2222
- `/seam/customer/v1/connectors`: No undocumented message provided
23+
- `/seam/customer/v1/customers`: No undocumented message provided
2324
- `/seam/customer/v1/events`: No undocumented message provided
2425
- `/seam/customer/v1/portals`: No undocumented message provided
2526
- `/seam/customer/v1/reservations`: No undocumented message provided
@@ -42,6 +43,7 @@ These items are intentionally undocumented.
4243
- `acs_credential_provisioning_automation`: Deprecated. Will be removed.
4344
- `bridge_client_session`: Seam Bridge client only.
4445
- `bridge_connected_systems`: Seam Bridge client only.
46+
- `customer`: Internal resource.
4547
- `customization_profile`: Unreleased.
4648
- `enrollment_automation`: Will be removed.
4749
- `magic_link`: Unreleased.
@@ -107,6 +109,7 @@ These items are intentionally undocumented.
107109
- `/seam/customer/v1/connectors/list`: Internal endpoint for Console.
108110
- `/seam/customer/v1/connectors/sync`: Only used internally.
109111
- `/seam/customer/v1/connectors/update`: Internal endpoint for Console.
112+
- `/seam/customer/v1/customers/list`: Internal endpoint for Console.
110113
- `/seam/customer/v1/events/list`: Internal endpoint for customer portals.
111114
- `/seam/customer/v1/portals/get`: Internal endpoint for customer portals.
112115
- `/seam/customer/v1/reservations/get`: Internal endpoint for customer portals.

0 commit comments

Comments
 (0)