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
6 changes: 5 additions & 1 deletion codegen/layouts/api-endpoint.hbs
Original file line number Diff line number Diff line change
Expand Up @@ -73,7 +73,11 @@ None

## Response

{{#if response.resourceType}}{{#if (eq response.responseType "resource_list")}}Array of [{{response.escapedResourceType}}s]({{#if response.responsePath}}{{response.responsePath}}{{else}}./{{/if}}){{else}}[{{response.escapedResourceType}}]({{#if response.responsePath}}{{response.responsePath}}{{else}}./{{/if}}){{/if}}{{else}}void{{/if}}
{% hint style="success" %}
Returns:
**{{#if response.resourceType}}{{#if (eq response.responseType "resource_list")}}Array of [{{response.escapedResourceType}}s]({{#if response.responsePath}}{{response.responsePath}}{{else}}./{{/if}}){{else}}[{{response.escapedResourceType}}]({{#if response.responsePath}}{{response.responsePath}}{{else}}./{{/if}}){{/if}}{{else}}void{{/if}}**

{% endhint %}

{{#if resourceSamples.length}}

Expand Down
6 changes: 5 additions & 1 deletion docs/api/access_codes/create.md
Original file line number Diff line number Diff line change
Expand Up @@ -384,7 +384,11 @@ Indicates whether to use a [backup access code pool](https://docs.seam.co/latest

## Response

[access\_code](.)
{% hint style="success" %}
Returns:
**[access\_code](.)**

{% endhint %}


{% tabs %}
Expand Down
6 changes: 5 additions & 1 deletion docs/api/access_codes/create_multiple.md
Original file line number Diff line number Diff line change
Expand Up @@ -443,7 +443,11 @@ Indicates whether to use a [backup access code pool](https://docs.seam.co/latest

## Response

Array of [access\_codes](.)
{% hint style="success" %}
Returns:
**Array of [access\_codes](.)**

{% endhint %}


{% tabs %}
Expand Down
6 changes: 5 additions & 1 deletion docs/api/access_codes/delete.md
Original file line number Diff line number Diff line change
Expand Up @@ -160,5 +160,9 @@ ID of the device for which you want to delete the access code.

## Response

void
{% hint style="success" %}
Returns:
**void**

{% endhint %}

6 changes: 5 additions & 1 deletion docs/api/access_codes/generate_code.md
Original file line number Diff line number Diff line change
Expand Up @@ -150,7 +150,11 @@ ID of the device for which you want to generate a code.

## Response

[access\_code](.)
{% hint style="success" %}
Returns:
**[access\_code](.)**

{% endhint %}


{% tabs %}
Expand Down
6 changes: 5 additions & 1 deletion docs/api/access_codes/get.md
Original file line number Diff line number Diff line change
Expand Up @@ -297,7 +297,11 @@ ID of the device containing the access code that you want to get. You must speci

## Response

[access\_code](.)
{% hint style="success" %}
Returns:
**[access\_code](.)**

{% endhint %}


{% tabs %}
Expand Down
6 changes: 5 additions & 1 deletion docs/api/access_codes/list.md
Original file line number Diff line number Diff line change
Expand Up @@ -332,7 +332,11 @@ Your user ID for the user by which to filter access codes.

## Response

Array of [access\_codes](.)
{% hint style="success" %}
Returns:
**Array of [access\_codes](.)**

{% endhint %}


{% tabs %}
Expand Down
6 changes: 5 additions & 1 deletion docs/api/access_codes/pull_backup_access_code.md
Original file line number Diff line number Diff line change
Expand Up @@ -295,7 +295,11 @@ ID of the access code for which you want to pull a backup access code.

## Response

[access\_code](.)
{% hint style="success" %}
Returns:
**[access\_code](.)**

{% endhint %}


{% tabs %}
Expand Down
6 changes: 5 additions & 1 deletion docs/api/access_codes/report_device_constraints.md
Original file line number Diff line number Diff line change
Expand Up @@ -189,7 +189,11 @@ Array of supported code lengths as integers between 4 and 20, inclusive. You can

## Response

void
{% hint style="success" %}
Returns:
**void**

{% endhint %}


---
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -255,7 +255,11 @@ Name of the simulated unmanaged access code.

## Response

[unmanaged\_access\_code](./../unmanaged)
{% hint style="success" %}
Returns:
**[unmanaged\_access\_code](./../unmanaged)**

{% endhint %}


{% tabs %}
Expand Down
6 changes: 5 additions & 1 deletion docs/api/access_codes/unmanaged/convert_to_managed.md
Original file line number Diff line number Diff line change
Expand Up @@ -181,5 +181,9 @@ Indicates whether [external modification](https://docs.seam.co/latest/capability

## Response

void
{% hint style="success" %}
Returns:
**void**

{% endhint %}

6 changes: 5 additions & 1 deletion docs/api/access_codes/unmanaged/delete.md
Original file line number Diff line number Diff line change
Expand Up @@ -147,5 +147,9 @@ ID of the unmanaged access code that you want to delete.

## Response

void
{% hint style="success" %}
Returns:
**void**

{% endhint %}

6 changes: 5 additions & 1 deletion docs/api/access_codes/unmanaged/get.md
Original file line number Diff line number Diff line change
Expand Up @@ -245,7 +245,11 @@ ID of the device containing the unmanaged access code that you want to get. You

## Response

[unmanaged\_access\_code](.)
{% hint style="success" %}
Returns:
**[unmanaged\_access\_code](.)**

{% endhint %}


{% tabs %}
Expand Down
6 changes: 5 additions & 1 deletion docs/api/access_codes/unmanaged/list.md
Original file line number Diff line number Diff line change
Expand Up @@ -261,7 +261,11 @@ Your user ID for the user by which to filter unmanaged access codes.

## Response

Array of [unmanaged\_access\_codes](.)
{% hint style="success" %}
Returns:
**Array of [unmanaged\_access\_codes](.)**

{% endhint %}


{% tabs %}
Expand Down
6 changes: 5 additions & 1 deletion docs/api/access_codes/unmanaged/update.md
Original file line number Diff line number Diff line change
Expand Up @@ -186,5 +186,9 @@ Indicates whether [external modification](https://docs.seam.co/latest/capability

## Response

void
{% hint style="success" %}
Returns:
**void**

{% endhint %}

6 changes: 5 additions & 1 deletion docs/api/access_codes/update.md
Original file line number Diff line number Diff line change
Expand Up @@ -279,5 +279,9 @@ Indicates whether to use a [backup access code pool](https://docs.seam.co/latest

## Response

void
{% hint style="success" %}
Returns:
**void**

{% endhint %}

6 changes: 5 additions & 1 deletion docs/api/access_codes/update_multiple.md
Original file line number Diff line number Diff line change
Expand Up @@ -193,5 +193,9 @@ Date and time at which the validity of the new access code starts, in [ISO 8601]

## Response

void
{% hint style="success" %}
Returns:
**void**

{% endhint %}

6 changes: 5 additions & 1 deletion docs/api/access_grants/create.md
Original file line number Diff line number Diff line change
Expand Up @@ -631,7 +631,11 @@ ID of user identity for whom access is being granted.

## Response

[access\_grant](.)
{% hint style="success" %}
Returns:
**[access\_grant](.)**

{% endhint %}


{% tabs %}
Expand Down
6 changes: 5 additions & 1 deletion docs/api/access_grants/delete.md
Original file line number Diff line number Diff line change
Expand Up @@ -148,5 +148,9 @@ ID of Access Grant to delete.

## Response

void
{% hint style="success" %}
Returns:
**void**

{% endhint %}

6 changes: 5 additions & 1 deletion docs/api/access_grants/get.md
Original file line number Diff line number Diff line change
Expand Up @@ -387,7 +387,11 @@ Unique key of Access Grant to get.

## Response

[access\_grant](.)
{% hint style="success" %}
Returns:
**[access\_grant](.)**

{% endhint %}


{% tabs %}
Expand Down
6 changes: 5 additions & 1 deletion docs/api/access_grants/get_related.md
Original file line number Diff line number Diff line change
Expand Up @@ -65,5 +65,9 @@ Possible enum values:

## Response

[unknown](./)
{% hint style="success" %}
Returns:
**[unknown](./)**

{% endhint %}

6 changes: 5 additions & 1 deletion docs/api/access_grants/list.md
Original file line number Diff line number Diff line change
Expand Up @@ -480,7 +480,11 @@ ID of user identity by which you want to filter the list of Access Grants.

## Response

Array of [access\_grants](.)
{% hint style="success" %}
Returns:
**Array of [access\_grants](.)**

{% endhint %}


{% tabs %}
Expand Down
6 changes: 5 additions & 1 deletion docs/api/access_grants/request_access_methods.md
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,11 @@ Enum values:

## Response

[access\_grant](.)
{% hint style="success" %}
Returns:
**[access\_grant](.)**

{% endhint %}


{% tabs %}
Expand Down
6 changes: 5 additions & 1 deletion docs/api/access_grants/unmanaged/get.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,5 +29,9 @@ ID of unmanaged Access Grant to get.

## Response

[unknown](./)
{% hint style="success" %}
Returns:
**[unknown](./)**

{% endhint %}

6 changes: 5 additions & 1 deletion docs/api/access_grants/unmanaged/list.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,5 +47,9 @@ ID of user identity by which you want to filter the list of unmanaged Access Gra

## Response

Array of [unknowns](./)
{% hint style="success" %}
Returns:
**Array of [unknowns](./)**

{% endhint %}

6 changes: 5 additions & 1 deletion docs/api/access_grants/unmanaged/update.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,5 +45,9 @@ Unique key for the access grant. If not provided, the existing key will be prese

## Response

void
{% hint style="success" %}
Returns:
**void**

{% endhint %}

6 changes: 5 additions & 1 deletion docs/api/access_grants/update.md
Original file line number Diff line number Diff line change
Expand Up @@ -180,5 +180,9 @@ Date and time at which the validity of the grant starts, in [ISO 8601](https://w

## Response

void
{% hint style="success" %}
Returns:
**void**

{% endhint %}

6 changes: 5 additions & 1 deletion docs/api/access_methods/delete.md
Original file line number Diff line number Diff line change
Expand Up @@ -147,5 +147,9 @@ ID of access method to get.

## Response

void
{% hint style="success" %}
Returns:
**void**

{% endhint %}

6 changes: 5 additions & 1 deletion docs/api/access_methods/encode.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,11 @@ ID of the `acs_encoder` to use to encode the `access_method`.

## Response

[action\_attempt](./)
{% hint style="success" %}
Returns:
**[action\_attempt](./)**

{% endhint %}


{% tabs %}
Expand Down
6 changes: 5 additions & 1 deletion docs/api/access_methods/get.md
Original file line number Diff line number Diff line change
Expand Up @@ -197,7 +197,11 @@ ID of access method to get.

## Response

[access\_method](.)
{% hint style="success" %}
Returns:
**[access\_method](.)**

{% endhint %}


{% tabs %}
Expand Down
6 changes: 5 additions & 1 deletion docs/api/access_methods/get_related.md
Original file line number Diff line number Diff line change
Expand Up @@ -68,5 +68,9 @@ Possible enum values:

## Response

[unknown](./)
{% hint style="success" %}
Returns:
**[unknown](./)**

{% endhint %}

6 changes: 5 additions & 1 deletion docs/api/access_methods/list.md
Original file line number Diff line number Diff line change
Expand Up @@ -324,7 +324,11 @@ ID of the space for which you want to retrieve all access methods.

## Response

Array of [access\_methods](.)
{% hint style="success" %}
Returns:
**Array of [access\_methods](.)**

{% endhint %}


{% tabs %}
Expand Down
6 changes: 5 additions & 1 deletion docs/api/access_methods/unmanaged/get.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,5 +28,9 @@ ID of unmanaged access method to get.

## Response

[unknown](./)
{% hint style="success" %}
Returns:
**[unknown](./)**

{% endhint %}

Loading
Loading