Skip to content

Commit f7f656d

Browse files
authored
feat: Update to @seamapi/[email protected] (#782)
* feat: Update to @seamapi/[email protected] * ci: Generate docs
1 parent a6cbd4a commit f7f656d

File tree

6 files changed

+127
-5
lines changed

6 files changed

+127
-5
lines changed

docs/api/_blueprint.json

Lines changed: 82 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -60032,6 +60032,20 @@
6003260032
"semanticMethod": "POST",
6003360033
"preferredMethod": "POST",
6003460034
"parameters": [
60035+
{
60036+
"name": "customization_profile_id",
60037+
"description": "",
60038+
"isRequired": false,
60039+
"isDeprecated": false,
60040+
"deprecationMessage": "",
60041+
"isUndocumented": false,
60042+
"undocumentedMessage": "",
60043+
"isDraft": false,
60044+
"draftMessage": "",
60045+
"hasDefault": false,
60046+
"format": "id",
60047+
"jsonType": "string"
60048+
},
6003560049
{
6003660050
"name": "max_use_count",
6003760051
"description": "Maximum number of times the instant key can be used. Default: 1.",
@@ -88980,6 +88994,74 @@
8898088994
"format": "datetime",
8898188995
"jsonType": "string"
8898288996
},
88997+
{
88998+
"name": "customization_profile",
88999+
"description": "Customization profile associated with the Instant Key.",
89000+
"isDeprecated": false,
89001+
"deprecationMessage": "",
89002+
"isUndocumented": false,
89003+
"undocumentedMessage": "",
89004+
"isDraft": false,
89005+
"draftMessage": "",
89006+
"propertyGroupKey": null,
89007+
"format": "object",
89008+
"jsonType": "object",
89009+
"propertyGroups": [],
89010+
"properties": [
89011+
{
89012+
"name": "logo_url",
89013+
"description": "URL of the logo associated with the customization profile.",
89014+
"isDeprecated": false,
89015+
"deprecationMessage": "",
89016+
"isUndocumented": false,
89017+
"undocumentedMessage": "",
89018+
"isDraft": false,
89019+
"draftMessage": "",
89020+
"propertyGroupKey": null,
89021+
"format": "string",
89022+
"jsonType": "string"
89023+
},
89024+
{
89025+
"name": "primary_color",
89026+
"description": "Primary color of the customization profile.",
89027+
"isDeprecated": false,
89028+
"deprecationMessage": "",
89029+
"isUndocumented": false,
89030+
"undocumentedMessage": "",
89031+
"isDraft": false,
89032+
"draftMessage": "",
89033+
"propertyGroupKey": null,
89034+
"format": "string",
89035+
"jsonType": "string"
89036+
},
89037+
{
89038+
"name": "secondary_color",
89039+
"description": "Secondary color of the customization profile.",
89040+
"isDeprecated": false,
89041+
"deprecationMessage": "",
89042+
"isUndocumented": false,
89043+
"undocumentedMessage": "",
89044+
"isDraft": false,
89045+
"draftMessage": "",
89046+
"propertyGroupKey": null,
89047+
"format": "string",
89048+
"jsonType": "string"
89049+
}
89050+
]
89051+
},
89052+
{
89053+
"name": "customization_profile_id",
89054+
"description": "ID of the customization profile associated with the Instant Key.",
89055+
"isDeprecated": false,
89056+
"deprecationMessage": "",
89057+
"isUndocumented": false,
89058+
"undocumentedMessage": "",
89059+
"isDraft": false,
89060+
"draftMessage": "",
89061+
"propertyGroupKey": null,
89062+
"format": "id",
89063+
"jsonType": "string"
89064+
},
8898389065
{
8898489066
"name": "expires_at",
8898589067
"description": "Date and time at which the Instant Key expires.",

docs/api/_report.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -373,6 +373,8 @@ Items that are intentionally undocumented are not included in this section.
373373
- `sync`
374374
- `/thermostats/set_hvac_mode`
375375
- `hvac_mode_setting`
376+
- `/user_identities/generate_instant_key`
377+
- `customization_profile_id`
376378
- `/user_identities/get`
377379
- `user_identity_key`
378380
- `/workspaces/create`

docs/api/instant_keys/README.md

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -48,6 +48,40 @@ Date and time at which the Instant Key was created.
4848

4949

5050

51+
---
52+
53+
**`customization_profile`** *Object*
54+
55+
Customization profile associated with the Instant Key.
56+
57+
58+
59+
<details>
60+
<summary>Child Properties</summary>
61+
62+
- <strong><code>logo_url</code></strong> <i>String</i>
63+
64+
URL of the logo associated with the customization profile.
65+
66+
- <strong><code>primary_color</code></strong> <i>String</i>
67+
68+
Primary color of the customization profile.
69+
70+
- <strong><code>secondary_color</code></strong> <i>String</i>
71+
72+
Secondary color of the customization profile.
73+
74+
</details>
75+
76+
---
77+
78+
**`customization_profile_id`** *UUID*
79+
80+
ID of the customization profile associated with the Instant Key.
81+
82+
83+
84+
5185
---
5286

5387
**`expires_at`** *Datetime*

docs/api/user_identities/generate_instant_key.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -199,6 +199,10 @@ ID of the user identity for which you want to generate an instant key.
199199

200200
---
201201

202+
**`customization_profile_id`** *String*
203+
204+
---
205+
202206
**`max_use_count`** *Number*
203207

204208
Maximum number of times the instant key can be used. Default: 1.

package-lock.json

Lines changed: 4 additions & 4 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@
3232
"@prettier/plugin-ruby": "^4.0.4",
3333
"@seamapi/blueprint": "^0.51.3",
3434
"@seamapi/smith": "^0.4.4",
35-
"@seamapi/types": "1.490.0",
35+
"@seamapi/types": "1.491.0",
3636
"@types/command-exists": "^1.2.3",
3737
"change-case": "^5.4.4",
3838
"command-exists": "^1.2.9",

0 commit comments

Comments
 (0)