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
325 changes: 325 additions & 0 deletions docs/api-reference/_blueprint.json
Original file line number Diff line number Diff line change
Expand Up @@ -57233,6 +57233,16 @@
"isDraft": false,
"draftMessage": ""
},
{
"name": "access_code.mutations_requested",
"description": "",
"isDeprecated": false,
"deprecationMessage": "",
"isUndocumented": false,
"undocumentedMessage": "",
"isDraft": false,
"draftMessage": ""
},
{
"name": "access_code.scheduled_on_device",
"description": "",
Expand Down Expand Up @@ -58310,6 +58320,16 @@
"isDraft": false,
"draftMessage": ""
},
{
"name": "access_code.mutations_requested",
"description": "",
"isDeprecated": false,
"deprecationMessage": "",
"isUndocumented": false,
"undocumentedMessage": "",
"isDraft": false,
"draftMessage": ""
},
{
"name": "access_code.scheduled_on_device",
"description": "",
Expand Down Expand Up @@ -72005,6 +72025,16 @@
"isDraft": false,
"draftMessage": ""
},
{
"name": "access_code.mutations_requested",
"description": "",
"isDeprecated": false,
"deprecationMessage": "",
"isUndocumented": false,
"undocumentedMessage": "",
"isDraft": false,
"draftMessage": ""
},
{
"name": "access_code.scheduled_on_device",
"description": "",
Expand Down Expand Up @@ -73082,6 +73112,16 @@
"isDraft": false,
"draftMessage": ""
},
{
"name": "access_code.mutations_requested",
"description": "",
"isDeprecated": false,
"deprecationMessage": "",
"isUndocumented": false,
"undocumentedMessage": "",
"isDraft": false,
"draftMessage": ""
},
{
"name": "access_code.scheduled_on_device",
"description": "",
Expand Down Expand Up @@ -122945,6 +122985,16 @@
"isDraft": false,
"draftMessage": ""
},
{
"name": "access_code.mutations_requested",
"description": "",
"isDeprecated": false,
"deprecationMessage": "",
"isUndocumented": false,
"undocumentedMessage": "",
"isDraft": false,
"draftMessage": ""
},
{
"name": "access_code.scheduled_on_device",
"description": "",
Expand Down Expand Up @@ -142179,6 +142229,281 @@
"resourceSamples": [],
"eventType": "access_code.time_frame_changed"
},
{
"resourceType": "event",
"properties": [
{
"name": "access_code_id",
"description": "ID of the affected access code.",
"isDeprecated": false,
"deprecationMessage": "",
"isUndocumented": false,
"undocumentedMessage": "",
"isDraft": false,
"draftMessage": "",
"propertyGroupKey": null,
"format": "id",
"jsonType": "string"
},
{
"name": "connected_account_custom_metadata",
"description": "Custom metadata of the connected account, present when connected_account_id is provided.",
"isDeprecated": false,
"deprecationMessage": "",
"isUndocumented": false,
"undocumentedMessage": "",
"isDraft": false,
"draftMessage": "",
"propertyGroupKey": null,
"format": "record",
"jsonType": "object"
},
{
"name": "connected_account_id",
"description": "ID of the connected account associated with the affected access code.",
"isDeprecated": false,
"deprecationMessage": "",
"isUndocumented": false,
"undocumentedMessage": "",
"isDraft": false,
"draftMessage": "",
"propertyGroupKey": null,
"format": "id",
"jsonType": "string"
},
{
"name": "created_at",
"description": "Date and time at which the event was created.",
"isDeprecated": false,
"deprecationMessage": "",
"isUndocumented": false,
"undocumentedMessage": "",
"isDraft": false,
"draftMessage": "",
"propertyGroupKey": null,
"format": "datetime",
"jsonType": "string"
},
{
"name": "device_custom_metadata",
"description": "Custom metadata of the device, present when device_id is provided.",
"isDeprecated": false,
"deprecationMessage": "",
"isUndocumented": false,
"undocumentedMessage": "",
"isDraft": false,
"draftMessage": "",
"propertyGroupKey": null,
"format": "record",
"jsonType": "object"
},
{
"name": "device_id",
"description": "ID of the device associated with the affected access code.",
"isDeprecated": false,
"deprecationMessage": "",
"isUndocumented": false,
"undocumentedMessage": "",
"isDraft": false,
"draftMessage": "",
"propertyGroupKey": null,
"format": "id",
"jsonType": "string"
},
{
"name": "event_id",
"description": "ID of the event.",
"isDeprecated": false,
"deprecationMessage": "",
"isUndocumented": false,
"undocumentedMessage": "",
"isDraft": false,
"draftMessage": "",
"propertyGroupKey": null,
"format": "id",
"jsonType": "string"
},
{
"name": "event_type",
"description": "",
"isDeprecated": false,
"deprecationMessage": "",
"isUndocumented": false,
"undocumentedMessage": "",
"isDraft": false,
"draftMessage": "",
"propertyGroupKey": null,
"format": "enum",
"jsonType": "string",
"values": [
{
"name": "access_code.mutations_requested",
"description": "",
"isDeprecated": false,
"deprecationMessage": "",
"isUndocumented": false,
"undocumentedMessage": "",
"isDraft": false,
"draftMessage": ""
}
]
},
{
"name": "occurred_at",
"description": "Date and time at which the event occurred.",
"isDeprecated": false,
"deprecationMessage": "",
"isUndocumented": false,
"undocumentedMessage": "",
"isDraft": false,
"draftMessage": "",
"propertyGroupKey": null,
"format": "datetime",
"jsonType": "string"
},
{
"name": "requested_mutations",
"description": "Array of mutations requested on the access code, each containing the mutation type and from/to values.",
"isDeprecated": false,
"deprecationMessage": "",
"isUndocumented": false,
"undocumentedMessage": "",
"isDraft": false,
"draftMessage": "",
"propertyGroupKey": null,
"format": "list",
"jsonType": "array",
"itemFormat": "object",
"itemProperties": [
{
"name": "from",
"description": "Previous property values before the requested change. Keys depend on the mutation type. Absent for non-property mutations like `deleting`.",
"isDeprecated": false,
"deprecationMessage": "",
"isUndocumented": false,
"undocumentedMessage": "",
"isDraft": false,
"draftMessage": "",
"propertyGroupKey": null,
"format": "record",
"jsonType": "object"
},
{
"name": "mutation_code",
"description": "Code identifying the type of mutation requested, such as `updating_name`, `updating_code`, `updating_time_frame`, or `deleting`.",
"isDeprecated": false,
"deprecationMessage": "",
"isUndocumented": false,
"undocumentedMessage": "",
"isDraft": false,
"draftMessage": "",
"propertyGroupKey": null,
"format": "enum",
"jsonType": "string",
"values": [
{
"name": "updating_name",
"description": "",
"isDeprecated": false,
"deprecationMessage": "",
"isUndocumented": false,
"undocumentedMessage": "",
"isDraft": false,
"draftMessage": ""
},
{
"name": "updating_code",
"description": "",
"isDeprecated": false,
"deprecationMessage": "",
"isUndocumented": false,
"undocumentedMessage": "",
"isDraft": false,
"draftMessage": ""
},
{
"name": "updating_time_frame",
"description": "",
"isDeprecated": false,
"deprecationMessage": "",
"isUndocumented": false,
"undocumentedMessage": "",
"isDraft": false,
"draftMessage": ""
},
{
"name": "deleting",
"description": "",
"isDeprecated": false,
"deprecationMessage": "",
"isUndocumented": false,
"undocumentedMessage": "",
"isDraft": false,
"draftMessage": ""
},
{
"name": "creating",
"description": "",
"isDeprecated": false,
"deprecationMessage": "",
"isUndocumented": false,
"undocumentedMessage": "",
"isDraft": false,
"draftMessage": ""
},
{
"name": "deferring_creation",
"description": "",
"isDeprecated": false,
"deprecationMessage": "",
"isUndocumented": false,
"undocumentedMessage": "",
"isDraft": false,
"draftMessage": ""
}
]
},
{
"name": "to",
"description": "New property values after the requested change. Keys depend on the mutation type. Absent for non-property mutations like `deleting`.",
"isDeprecated": false,
"deprecationMessage": "",
"isUndocumented": false,
"undocumentedMessage": "",
"isDraft": false,
"draftMessage": "",
"propertyGroupKey": null,
"format": "record",
"jsonType": "object"
}
]
},
{
"name": "workspace_id",
"description": "ID of the workspace associated with the event.",
"isDeprecated": false,
"deprecationMessage": "",
"isUndocumented": false,
"undocumentedMessage": "",
"isDraft": false,
"draftMessage": "",
"propertyGroupKey": null,
"format": "id",
"jsonType": "string"
}
],
"description": "Mutations were requested on an [access code](https://docs.seam.co/low-level-apis/smart-locks/access-codes). This event fires at request time, before the change is confirmed on the device.",
"isDeprecated": false,
"routePath": "/access_codes",
"deprecationMessage": "",
"isUndocumented": false,
"undocumentedMessage": "",
"isDraft": false,
"draftMessage": "",
"propertyGroups": [],
"resourceSamples": [],
"eventType": "access_code.mutations_requested"
},
{
"resourceType": "event",
"properties": [
Expand Down
1 change: 1 addition & 0 deletions docs/api-reference/_report.md
Original file line number Diff line number Diff line change
Expand Up @@ -685,6 +685,7 @@ These items are deprecated.
- `event: access_code.name_changed`
- `event: access_code.code_changed`
- `event: access_code.time_frame_changed`
- `event: access_code.mutations_requested`
- `event: access_code.scheduled_on_device`
- `event: access_code.set_on_device`
- `event: access_code.removed_from_device`
Expand Down
Loading
Loading