Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
82 changes: 82 additions & 0 deletions docs/api/_blueprint.json
Original file line number Diff line number Diff line change
Expand Up @@ -60032,6 +60032,20 @@
"semanticMethod": "POST",
"preferredMethod": "POST",
"parameters": [
{
"name": "customization_profile_id",
"description": "",
"isRequired": false,
"isDeprecated": false,
"deprecationMessage": "",
"isUndocumented": false,
"undocumentedMessage": "",
"isDraft": false,
"draftMessage": "",
"hasDefault": false,
"format": "id",
"jsonType": "string"
},
{
"name": "max_use_count",
"description": "Maximum number of times the instant key can be used. Default: 1.",
Expand Down Expand Up @@ -88980,6 +88994,74 @@
"format": "datetime",
"jsonType": "string"
},
{
"name": "customization_profile",
"description": "Customization profile associated with the Instant Key.",
"isDeprecated": false,
"deprecationMessage": "",
"isUndocumented": false,
"undocumentedMessage": "",
"isDraft": false,
"draftMessage": "",
"propertyGroupKey": null,
"format": "object",
"jsonType": "object",
"propertyGroups": [],
"properties": [
{
"name": "logo_url",
"description": "URL of the logo associated with the customization profile.",
"isDeprecated": false,
"deprecationMessage": "",
"isUndocumented": false,
"undocumentedMessage": "",
"isDraft": false,
"draftMessage": "",
"propertyGroupKey": null,
"format": "string",
"jsonType": "string"
},
{
"name": "primary_color",
"description": "Primary color of the customization profile.",
"isDeprecated": false,
"deprecationMessage": "",
"isUndocumented": false,
"undocumentedMessage": "",
"isDraft": false,
"draftMessage": "",
"propertyGroupKey": null,
"format": "string",
"jsonType": "string"
},
{
"name": "secondary_color",
"description": "Secondary color of the customization profile.",
"isDeprecated": false,
"deprecationMessage": "",
"isUndocumented": false,
"undocumentedMessage": "",
"isDraft": false,
"draftMessage": "",
"propertyGroupKey": null,
"format": "string",
"jsonType": "string"
}
]
},
{
"name": "customization_profile_id",
"description": "ID of the customization profile associated with the Instant Key.",
"isDeprecated": false,
"deprecationMessage": "",
"isUndocumented": false,
"undocumentedMessage": "",
"isDraft": false,
"draftMessage": "",
"propertyGroupKey": null,
"format": "id",
"jsonType": "string"
},
{
"name": "expires_at",
"description": "Date and time at which the Instant Key expires.",
Expand Down
2 changes: 2 additions & 0 deletions docs/api/_report.md
Original file line number Diff line number Diff line change
Expand Up @@ -373,6 +373,8 @@ Items that are intentionally undocumented are not included in this section.
- `sync`
- `/thermostats/set_hvac_mode`
- `hvac_mode_setting`
- `/user_identities/generate_instant_key`
- `customization_profile_id`
- `/user_identities/get`
- `user_identity_key`
- `/workspaces/create`
Expand Down
34 changes: 34 additions & 0 deletions docs/api/instant_keys/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,40 @@ Date and time at which the Instant Key was created.



---

**`customization_profile`** *Object*

Customization profile associated with the Instant Key.



<details>
<summary>Child Properties</summary>

- <strong><code>logo_url</code></strong> <i>String</i>

URL of the logo associated with the customization profile.

- <strong><code>primary_color</code></strong> <i>String</i>

Primary color of the customization profile.

- <strong><code>secondary_color</code></strong> <i>String</i>

Secondary color of the customization profile.

</details>

---

**`customization_profile_id`** *UUID*

ID of the customization profile associated with the Instant Key.




---

**`expires_at`** *Datetime*
Expand Down
4 changes: 4 additions & 0 deletions docs/api/user_identities/generate_instant_key.md
Original file line number Diff line number Diff line change
Expand Up @@ -199,6 +199,10 @@ ID of the user identity for which you want to generate an instant key.

---

**`customization_profile_id`** *String*

---

**`max_use_count`** *Number*

Maximum number of times the instant key can be used. Default: 1.
Expand Down
8 changes: 4 additions & 4 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@
"@prettier/plugin-ruby": "^4.0.4",
"@seamapi/blueprint": "^0.51.3",
"@seamapi/smith": "^0.4.4",
"@seamapi/types": "1.490.0",
"@seamapi/types": "1.491.0",
"@types/command-exists": "^1.2.3",
"change-case": "^5.4.4",
"command-exists": "^1.2.9",
Expand Down
Loading