Skip to content

Commit 4977d9f

Browse files
seambotseambot
authored
feat: Update to @seamapi/[email protected] (#762)
* feat: Update to @seamapi/[email protected] * ci: Generate docs
1 parent a0d0a0b commit 4977d9f

File tree

10 files changed

+439
-5
lines changed

10 files changed

+439
-5
lines changed

‎docs/SUMMARY.md‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -365,6 +365,11 @@
365365
* [List Workspaces](api/workspaces/list.md)
366366
* [Reset a Sandbox Workspace](api/workspaces/reset_sandbox.md)
367367
* [Udpate a Workspace](api/workspaces/update.md)
368+
* [Customization Profiles](api/workspaces/customization_profiles/README.md)
369+
* [Get Customization Profile](api/workspaces/customization_profiles/get.md)
370+
* [Get Customization Profile](api/workspaces/customization_profiles/list.md)
371+
* [Update Customization Profile](api/workspaces/customization_profiles/create.md)
372+
* [Update Customization Profile](api/workspaces/customization_profiles/update.md)
368373
<!-- end api -->
369374

370375
## Developer Tools

‎docs/api/_blueprint.json‎

Lines changed: 265 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -64461,6 +64461,271 @@
6446164461
"isUndocumented": false,
6446264462
"isDeprecated": false,
6446364463
"isDraft": false
64464+
},
64465+
{
64466+
"path": "/workspaces/customization_profiles",
64467+
"name": "customization_profiles",
64468+
"namespacePath": null,
64469+
"endpoints": [
64470+
{
64471+
"title": "Update Customization Profile",
64472+
"name": "create",
64473+
"path": "/workspaces/customization_profiles/create",
64474+
"parentPath": "/workspaces/customization_profiles",
64475+
"description": "Updates the customization profile for the workspace.",
64476+
"isDeprecated": false,
64477+
"deprecationMessage": "",
64478+
"isUndocumented": false,
64479+
"undocumentedMessage": "",
64480+
"isDraft": false,
64481+
"draftMessage": "",
64482+
"response": {
64483+
"responseType": "resource",
64484+
"responseKey": "customization_profile",
64485+
"resourceType": "unknown",
64486+
"description": "OK",
64487+
"actionAttemptType": null
64488+
},
64489+
"request": {
64490+
"methods": [
64491+
"POST"
64492+
],
64493+
"semanticMethod": "POST",
64494+
"preferredMethod": "POST",
64495+
"parameters": [
64496+
{
64497+
"name": "primary_color",
64498+
"description": "",
64499+
"isRequired": true,
64500+
"isDeprecated": false,
64501+
"deprecationMessage": "",
64502+
"isUndocumented": false,
64503+
"undocumentedMessage": "",
64504+
"isDraft": false,
64505+
"draftMessage": "",
64506+
"hasDefault": false,
64507+
"format": "string",
64508+
"jsonType": "string"
64509+
},
64510+
{
64511+
"name": "secondary_color",
64512+
"description": "",
64513+
"isRequired": true,
64514+
"isDeprecated": false,
64515+
"deprecationMessage": "",
64516+
"isUndocumented": false,
64517+
"undocumentedMessage": "",
64518+
"isDraft": false,
64519+
"draftMessage": "",
64520+
"hasDefault": false,
64521+
"format": "string",
64522+
"jsonType": "string"
64523+
}
64524+
]
64525+
},
64526+
"hasPagination": false,
64527+
"authMethods": [
64528+
"client_session_token"
64529+
],
64530+
"workspaceScope": "required",
64531+
"codeSamples": []
64532+
},
64533+
{
64534+
"title": "Get Customization Profile",
64535+
"name": "get",
64536+
"path": "/workspaces/customization_profiles/get",
64537+
"parentPath": "/workspaces/customization_profiles",
64538+
"description": "Retrieves the customization profile for the workspace.",
64539+
"isDeprecated": false,
64540+
"deprecationMessage": "",
64541+
"isUndocumented": false,
64542+
"undocumentedMessage": "",
64543+
"isDraft": false,
64544+
"draftMessage": "",
64545+
"response": {
64546+
"responseType": "resource",
64547+
"responseKey": "customization_profile",
64548+
"resourceType": "unknown",
64549+
"description": "OK",
64550+
"actionAttemptType": null
64551+
},
64552+
"request": {
64553+
"methods": [
64554+
"GET",
64555+
"POST"
64556+
],
64557+
"semanticMethod": "GET",
64558+
"preferredMethod": "POST",
64559+
"parameters": [
64560+
{
64561+
"name": "customization_profile_id",
64562+
"description": "",
64563+
"isRequired": true,
64564+
"isDeprecated": false,
64565+
"deprecationMessage": "",
64566+
"isUndocumented": false,
64567+
"undocumentedMessage": "",
64568+
"isDraft": false,
64569+
"draftMessage": "",
64570+
"hasDefault": false,
64571+
"format": "id",
64572+
"jsonType": "string"
64573+
}
64574+
]
64575+
},
64576+
"hasPagination": false,
64577+
"authMethods": [
64578+
"client_session_token"
64579+
],
64580+
"workspaceScope": "required",
64581+
"codeSamples": []
64582+
},
64583+
{
64584+
"title": "Get Customization Profile",
64585+
"name": "list",
64586+
"path": "/workspaces/customization_profiles/list",
64587+
"parentPath": "/workspaces/customization_profiles",
64588+
"description": "Retrieves the customization profile for the workspace.",
64589+
"isDeprecated": false,
64590+
"deprecationMessage": "",
64591+
"isUndocumented": false,
64592+
"undocumentedMessage": "",
64593+
"isDraft": false,
64594+
"draftMessage": "",
64595+
"response": {
64596+
"responseType": "resource_list",
64597+
"responseKey": "customization_profiles",
64598+
"resourceType": "unknown",
64599+
"description": "OK",
64600+
"actionAttemptType": null
64601+
},
64602+
"request": {
64603+
"methods": [
64604+
"GET",
64605+
"POST"
64606+
],
64607+
"semanticMethod": "GET",
64608+
"preferredMethod": "GET",
64609+
"parameters": []
64610+
},
64611+
"hasPagination": false,
64612+
"authMethods": [
64613+
"client_session_token"
64614+
],
64615+
"workspaceScope": "required",
64616+
"codeSamples": []
64617+
},
64618+
{
64619+
"title": "Update Customization Profile",
64620+
"name": "update",
64621+
"path": "/workspaces/customization_profiles/update",
64622+
"parentPath": "/workspaces/customization_profiles",
64623+
"description": "Updates the customization profile for the workspace.",
64624+
"isDeprecated": false,
64625+
"deprecationMessage": "",
64626+
"isUndocumented": false,
64627+
"undocumentedMessage": "",
64628+
"isDraft": false,
64629+
"draftMessage": "",
64630+
"response": {
64631+
"responseType": "void",
64632+
"description": "OK"
64633+
},
64634+
"request": {
64635+
"methods": [
64636+
"PATCH",
64637+
"POST"
64638+
],
64639+
"semanticMethod": "PATCH",
64640+
"preferredMethod": "PATCH",
64641+
"parameters": [
64642+
{
64643+
"name": "customization_profile_id",
64644+
"description": "",
64645+
"isRequired": true,
64646+
"isDeprecated": false,
64647+
"deprecationMessage": "",
64648+
"isUndocumented": false,
64649+
"undocumentedMessage": "",
64650+
"isDraft": false,
64651+
"draftMessage": "",
64652+
"hasDefault": false,
64653+
"format": "id",
64654+
"jsonType": "string"
64655+
},
64656+
{
64657+
"name": "primary_color",
64658+
"description": "",
64659+
"isRequired": false,
64660+
"isDeprecated": false,
64661+
"deprecationMessage": "",
64662+
"isUndocumented": false,
64663+
"undocumentedMessage": "",
64664+
"isDraft": false,
64665+
"draftMessage": "",
64666+
"hasDefault": false,
64667+
"format": "string",
64668+
"jsonType": "string"
64669+
},
64670+
{
64671+
"name": "secondary_color",
64672+
"description": "",
64673+
"isRequired": false,
64674+
"isDeprecated": false,
64675+
"deprecationMessage": "",
64676+
"isUndocumented": false,
64677+
"undocumentedMessage": "",
64678+
"isDraft": false,
64679+
"draftMessage": "",
64680+
"hasDefault": false,
64681+
"format": "string",
64682+
"jsonType": "string"
64683+
}
64684+
]
64685+
},
64686+
"hasPagination": false,
64687+
"authMethods": [
64688+
"client_session_token"
64689+
],
64690+
"workspaceScope": "required",
64691+
"codeSamples": []
64692+
},
64693+
{
64694+
"title": "Upload Customization Profile Logo",
64695+
"name": "upload_images",
64696+
"path": "/workspaces/customization_profiles/upload_images",
64697+
"parentPath": "/workspaces/customization_profiles",
64698+
"description": "Uploads a logo for the customization profile.",
64699+
"isDeprecated": false,
64700+
"deprecationMessage": "",
64701+
"isUndocumented": true,
64702+
"undocumentedMessage": "Internal endpoint for customer portals.",
64703+
"isDraft": false,
64704+
"draftMessage": "",
64705+
"response": {
64706+
"responseType": "void",
64707+
"description": "OK"
64708+
},
64709+
"request": {
64710+
"methods": [
64711+
"POST"
64712+
],
64713+
"semanticMethod": "POST",
64714+
"preferredMethod": "POST",
64715+
"parameters": []
64716+
},
64717+
"hasPagination": false,
64718+
"authMethods": [
64719+
"client_session_token"
64720+
],
64721+
"workspaceScope": "required",
64722+
"codeSamples": []
64723+
}
64724+
],
64725+
"parentPath": "/workspaces",
64726+
"isUndocumented": false,
64727+
"isDeprecated": false,
64728+
"isDraft": false
6446464729
}
6446564730
],
6446664731
"namespaces": [

‎docs/api/_report.md‎

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -101,6 +101,7 @@ These items are intentionally undocumented.
101101
- `/user_identities/enrollment_automations/launch`: Will be removed.
102102
- `/user_identities/enrollment_automations/list`: Will be removed.
103103
- `/workspaces/find_resources`: Unreleased.
104+
- `/workspaces/customization_profiles/upload_images`: Internal endpoint for customer portals.
104105

105106
### Endpoint parameters
106107

@@ -374,6 +375,15 @@ Items that are intentionally undocumented are not included in this section.
374375
- `webview_primary_button_color`
375376
- `webview_primary_button_text_color`
376377
- `webview_success_message`
378+
- `/workspaces/customization_profiles/create`
379+
- `primary_color`
380+
- `secondary_color`
381+
- `/workspaces/customization_profiles/get`
382+
- `customization_profile_id`
383+
- `/workspaces/customization_profiles/update`
384+
- `customization_profile_id`
385+
- `primary_color`
386+
- `secondary_color`
377387

378388
## Draft
379389

@@ -518,6 +528,9 @@ These items are deprecated.
518528
- `/seam/partner/v1/building_blocks/spaces/auto_map`: `spaces`
519529
- `/spaces/get_related`: `batch`
520530
- `/workspaces/find_resources`: `batch`
531+
- `/workspaces/customization_profiles/create`: `customization_profile`
532+
- `/workspaces/customization_profiles/get`: `customization_profile`
533+
- `/workspaces/customization_profiles/list`: `customization_profiles`
521534

522535
### Endpoints without code samples
523536

@@ -531,6 +544,10 @@ These items are deprecated.
531544
- `/instant_keys/list`
532545
- `/locks/get`
533546
- `/spaces/get_related`
547+
- `/workspaces/customization_profiles/create`
548+
- `/workspaces/customization_profiles/get`
549+
- `/workspaces/customization_profiles/list`
550+
- `/workspaces/customization_profiles/update`
534551

535552
### Resources without resource samples
536553

‎docs/api/workspaces/customization_profiles/README.md‎

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
# Customization Profiles
2+
3+
## Endpoints
4+
5+
6+
[**`/workspaces/customization_profiles/create`**](./create.md)
7+
8+
Updates the customization profile for the workspace.
9+
10+
11+
[**`/workspaces/customization_profiles/get`**](./get.md)
12+
13+
Retrieves the customization profile for the workspace.
14+
15+
16+
[**`/workspaces/customization_profiles/list`**](./list.md)
17+
18+
Retrieves the customization profile for the workspace.
19+
20+
21+
[**`/workspaces/customization_profiles/update`**](./update.md)
22+
23+
Updates the customization profile for the workspace.
24+
25+

‎docs/api/workspaces/customization_profiles/create.md‎

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
# Update Customization Profile
2+
3+
- [Request Parameters](#request-parameters)
4+
- [Response](#response)
5+
6+
Updates the customization profile for the workspace.
7+
8+
9+
<details>
10+
11+
<summary>Authentication Methods</summary>
12+
13+
- Client session token
14+
15+
To learn more, see [Authentication](https://docs.seam.co/latest/api/authentication).
16+
</details>
17+
18+
## Request Parameters
19+
20+
**`primary_color`** *String* (Required)
21+
22+
---
23+
24+
**`secondary_color`** *String* (Required)
25+
26+
---
27+
28+
29+
## Response
30+
31+
[unknown](./)
32+

0 commit comments

Comments
 (0)