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
3,038 changes: 2,221 additions & 817 deletions docs/api-reference/_blueprint.json

Large diffs are not rendered by default.

68 changes: 68 additions & 0 deletions docs/api-reference/access_codes/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2405,6 +2405,10 @@ An [access code](https://docs.seam.co/low-level-apis/smart-locks/access-codes) w

ID of the device associated with the affected access code.

<strong><code>event_description</code></strong> <i>String</i>

Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event.

<strong><code>event_id</code></strong> <i>UUID</i>

ID of the event.
Expand Down Expand Up @@ -2479,6 +2483,10 @@ An [access code](https://docs.seam.co/low-level-apis/smart-locks/access-codes) w

ID of the device associated with the affected access code.

<strong><code>event_description</code></strong> <i>String</i>

Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event.

<strong><code>event_id</code></strong> <i>UUID</i>

ID of the event.
Expand Down Expand Up @@ -2534,6 +2542,10 @@ The name of an [access code](https://docs.seam.co/low-level-apis/smart-locks/acc

ID of the device associated with the affected access code.

<strong><code>event_description</code></strong> <i>String</i>

Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event.

<strong><code>event_id</code></strong> <i>UUID</i>

ID of the event.
Expand Down Expand Up @@ -2597,6 +2609,10 @@ The pin code of an [access code](https://docs.seam.co/low-level-apis/smart-locks

ID of the device associated with the affected access code.

<strong><code>event_description</code></strong> <i>String</i>

Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event.

<strong><code>event_id</code></strong> <i>UUID</i>

ID of the event.
Expand Down Expand Up @@ -2660,6 +2676,10 @@ The time frame of an [access code](https://docs.seam.co/low-level-apis/smart-loc

ID of the device associated with the affected access code.

<strong><code>event_description</code></strong> <i>String</i>

Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event.

<strong><code>event_id</code></strong> <i>UUID</i>

ID of the event.
Expand Down Expand Up @@ -2719,6 +2739,10 @@ Mutations were requested on an [access code](https://docs.seam.co/low-level-apis

ID of the device associated with the affected access code.

<strong><code>event_description</code></strong> <i>String</i>

Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event.

<strong><code>event_id</code></strong> <i>UUID</i>

ID of the event.
Expand Down Expand Up @@ -2803,6 +2827,10 @@ An [access code](https://docs.seam.co/low-level-apis/smart-locks/access-codes) w

ID of the device associated with the affected access code.

<strong><code>event_description</code></strong> <i>String</i>

Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event.

<strong><code>event_id</code></strong> <i>UUID</i>

ID of the event.
Expand Down Expand Up @@ -2858,6 +2886,10 @@ An [access code](https://docs.seam.co/low-level-apis/smart-locks/access-codes) w

ID of the device associated with the affected access code.

<strong><code>event_description</code></strong> <i>String</i>

Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event.

<strong><code>event_id</code></strong> <i>UUID</i>

ID of the event.
Expand Down Expand Up @@ -2909,6 +2941,10 @@ An [access code](https://docs.seam.co/low-level-apis/smart-locks/access-codes) w

ID of the device associated with the affected access code.

<strong><code>event_description</code></strong> <i>String</i>

Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event.

<strong><code>event_id</code></strong> <i>UUID</i>

ID of the event.
Expand Down Expand Up @@ -3074,6 +3110,10 @@ There was an unusually long delay in setting an [access code](https://docs.seam.
Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.


<strong><code>event_description</code></strong> <i>String</i>

Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event.

<strong><code>event_id</code></strong> <i>UUID</i>

ID of the event.
Expand Down Expand Up @@ -3239,6 +3279,10 @@ An [access code](https://docs.seam.co/low-level-apis/smart-locks/access-codes) f
Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.


<strong><code>event_description</code></strong> <i>String</i>

Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event.

<strong><code>event_id</code></strong> <i>UUID</i>

ID of the event.
Expand Down Expand Up @@ -3294,6 +3338,10 @@ An [access code](https://docs.seam.co/low-level-apis/smart-locks/access-codes) w

ID of the device associated with the affected access code.

<strong><code>event_description</code></strong> <i>String</i>

Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event.

<strong><code>event_id</code></strong> <i>UUID</i>

ID of the event.
Expand Down Expand Up @@ -3459,6 +3507,10 @@ There was an unusually long delay in removing an [access code](https://docs.seam
Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.


<strong><code>event_description</code></strong> <i>String</i>

Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event.

<strong><code>event_id</code></strong> <i>UUID</i>

ID of the event.
Expand Down Expand Up @@ -3624,6 +3676,10 @@ An [access code](https://docs.seam.co/low-level-apis/smart-locks/access-codes) f
Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.


<strong><code>event_description</code></strong> <i>String</i>

Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event.

<strong><code>event_id</code></strong> <i>UUID</i>

ID of the event.
Expand Down Expand Up @@ -3675,6 +3731,10 @@ An [access code](https://docs.seam.co/low-level-apis/smart-locks/access-codes) w

ID of the device associated with the affected access code.

<strong><code>event_description</code></strong> <i>String</i>

Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event.

<strong><code>event_id</code></strong> <i>UUID</i>

ID of the event.
Expand Down Expand Up @@ -3726,6 +3786,10 @@ An [access code](https://docs.seam.co/low-level-apis/smart-locks/access-codes) w

ID of the device associated with the affected access code.

<strong><code>event_description</code></strong> <i>String</i>

Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event.

<strong><code>event_id</code></strong> <i>UUID</i>

ID of the event.
Expand Down Expand Up @@ -3781,6 +3845,10 @@ A [backup access code](https://docs.seam.co/low-level-apis/smart-locks/access-co

ID of the device associated with the affected access code.

<strong><code>event_description</code></strong> <i>String</i>

Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event.

<strong><code>event_id</code></strong> <i>UUID</i>

ID of the event.
Expand Down
16 changes: 16 additions & 0 deletions docs/api-reference/access_codes/unmanaged/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -1930,6 +1930,10 @@ An [unmanaged access code](https://docs.seam.co/low-level-apis/smart-locks/acces

ID of the device associated with the affected access code.

<strong><code>event_description</code></strong> <i>String</i>

Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event.

<strong><code>event_id</code></strong> <i>UUID</i>

ID of the event.
Expand Down Expand Up @@ -2095,6 +2099,10 @@ An [unmanaged access code](https://docs.seam.co/low-level-apis/smart-locks/acces
Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.


<strong><code>event_description</code></strong> <i>String</i>

Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event.

<strong><code>event_id</code></strong> <i>UUID</i>

ID of the event.
Expand Down Expand Up @@ -2146,6 +2154,10 @@ An [unmanaged access code](https://docs.seam.co/low-level-apis/smart-locks/acces

ID of the device associated with the affected access code.

<strong><code>event_description</code></strong> <i>String</i>

Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event.

<strong><code>event_id</code></strong> <i>UUID</i>

ID of the event.
Expand Down Expand Up @@ -2197,6 +2209,10 @@ An [unmanaged access code](https://docs.seam.co/low-level-apis/smart-locks/acces

ID of the device associated with the affected access code.

<strong><code>event_description</code></strong> <i>String</i>

Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event.

<strong><code>event_id</code></strong> <i>UUID</i>

ID of the event.
Expand Down
28 changes: 28 additions & 0 deletions docs/api-reference/access_grants/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -852,6 +852,10 @@ An Access Grant was created.

Date and time at which the event was created.

<strong><code>event_description</code></strong> <i>String</i>

Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event.

<strong><code>event_id</code></strong> <i>UUID</i>

ID of the event.
Expand Down Expand Up @@ -887,6 +891,10 @@ An Access Grant was deleted.

Date and time at which the event was created.

<strong><code>event_description</code></strong> <i>String</i>

Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event.

<strong><code>event_id</code></strong> <i>UUID</i>

ID of the event.
Expand Down Expand Up @@ -922,6 +930,10 @@ All access requested for an Access Grant was successfully granted.

Date and time at which the event was created.

<strong><code>event_description</code></strong> <i>String</i>

Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event.

<strong><code>event_id</code></strong> <i>UUID</i>

ID of the event.
Expand Down Expand Up @@ -961,6 +973,10 @@ Access requested as part of an Access Grant to a particular door was successfull

Date and time at which the event was created.

<strong><code>event_description</code></strong> <i>String</i>

Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event.

<strong><code>event_id</code></strong> <i>UUID</i>

ID of the event.
Expand Down Expand Up @@ -1000,6 +1016,10 @@ Access to a particular door that was requested as part of an Access Grant was lo

Date and time at which the event was created.

<strong><code>event_description</code></strong> <i>String</i>

Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event.

<strong><code>event_id</code></strong> <i>UUID</i>

ID of the event.
Expand Down Expand Up @@ -1043,6 +1063,10 @@ An Access Grant's start or end time was changed.

The new end time for the access grant.

<strong><code>event_description</code></strong> <i>String</i>

Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event.

<strong><code>event_id</code></strong> <i>UUID</i>

ID of the event.
Expand Down Expand Up @@ -1086,6 +1110,10 @@ One or more requested access methods could not be created for an Access Grant.

Description of why the access methods could not be created.

<strong><code>event_description</code></strong> <i>String</i>

Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event.

<strong><code>event_id</code></strong> <i>UUID</i>

ID of the event.
Expand Down
24 changes: 24 additions & 0 deletions docs/api-reference/access_methods/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -576,6 +576,10 @@ An access method was issued.

Date and time at which the event was created.

<strong><code>event_description</code></strong> <i>String</i>

Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event.

<strong><code>event_id</code></strong> <i>UUID</i>

ID of the event.
Expand Down Expand Up @@ -623,6 +627,10 @@ An access method was revoked.

Date and time at which the event was created.

<strong><code>event_description</code></strong> <i>String</i>

Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event.

<strong><code>event_id</code></strong> <i>UUID</i>

ID of the event.
Expand Down Expand Up @@ -666,6 +674,10 @@ An access method representing a physical card requires encoding.

Date and time at which the event was created.

<strong><code>event_description</code></strong> <i>String</i>

Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event.

<strong><code>event_id</code></strong> <i>UUID</i>

ID of the event.
Expand Down Expand Up @@ -709,6 +721,10 @@ An access method was deleted.

Date and time at which the event was created.

<strong><code>event_description</code></strong> <i>String</i>

Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event.

<strong><code>event_id</code></strong> <i>UUID</i>

ID of the event.
Expand Down Expand Up @@ -756,6 +772,10 @@ An access method was reissued.

Date and time at which the event was created.

<strong><code>event_description</code></strong> <i>String</i>

Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event.

<strong><code>event_id</code></strong> <i>UUID</i>

ID of the event.
Expand Down Expand Up @@ -803,6 +823,10 @@ An access method was created.

Date and time at which the event was created.

<strong><code>event_description</code></strong> <i>String</i>

Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event.

<strong><code>event_id</code></strong> <i>UUID</i>

ID of the event.
Expand Down
4 changes: 4 additions & 0 deletions docs/api-reference/acs/access_groups/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -722,6 +722,10 @@ An ACS access group was deleted.

Date and time at which the event was created.

<strong><code>event_description</code></strong> <i>String</i>

Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event.

<strong><code>event_id</code></strong> <i>UUID</i>

ID of the event.
Expand Down
Loading
Loading