Skip to content

Commit

Permalink
Merge branch 'main' into acs-user-samples
Browse files Browse the repository at this point in the history
  • Loading branch information
mikewuu committed Oct 15, 2024
2 parents 6d15beb + 3db652a commit 94fda55
Show file tree
Hide file tree
Showing 62 changed files with 5,130 additions and 615 deletions.
2 changes: 1 addition & 1 deletion .devcontainer/Dockerfile
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ FROM mcr.microsoft.com/vscode/devcontainers/javascript-node:${VARIANT}

RUN apt-get update

RUN apt-get install -y php ruby ruby-dev
RUN apt-get install -y php ruby ruby-dev golang-go
RUN gem install standard -v 1.31.0

RUN wget https://github.com/mvdan/sh/releases/download/v3.9.0/shfmt_v3.9.0_linux_amd64 -O shfmt \
Expand Down
2 changes: 1 addition & 1 deletion .devcontainer/seam-sdk-playground/devcontainer.json
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,6 @@
]
}
},
"postCreateCommand": "npm install -g seam-cli && seam config set fake-server && cd /workspaces/api-docs/seam-sdk-playground/javascript && npm i seam@latest && cd /workspaces/api-docs/seam-sdk-playground/csharp && ./init.sh && cd /workspaces/api-docs/seam-sdk-playground/go && ./init.sh && cd /workspaces/api-docs/seam-sdk-playground/php && composer update",
"postCreateCommand": "npm install -g seam-cli && seam config set fake-server && cd /workspaces/docs/seam-sdk-playground/javascript && npm i seam@latest && cd /workspaces/docs/seam-sdk-playground/csharp && ./init.sh && cd /workspaces/docs/seam-sdk-playground/go && ./init.sh && cd /workspaces/docs/seam-sdk-playground/php && composer update",
"remoteUser": "node"
}
2 changes: 1 addition & 1 deletion .github/CODEOWNERS
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
* @seamapi/sdk
/docs/ @seamapi/docs
/src/data/code-sample-definitions @seamapi/docs
* @seamapi/sdk
4 changes: 4 additions & 0 deletions .github/workflows/generate.yml
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,10 @@ jobs:
uses: ruby/setup-ruby@v1
with:
ruby-version: '3.3'
- name: Setup Go
uses: actions/setup-go@v5
with:
go-version: '^1.23.2'
- name: Install standardrb
run: gem install standard -v 1.31.0
- name: Normalize package-lock.json
Expand Down
1 change: 1 addition & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -126,6 +126,7 @@ GitHub actions will automatically ensure the formatting is applied for all pull

- [shfmt](https://github.com/mvdan/sh)
- [ruff](https://github.com/astral-sh/ruff)
- [gofmt](https://go.dev/blog/gofmt)
- [standardrb](https://github.com/standardrb/standard)

## GitHub Actions
Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/.gitbook/assets/akiles-logo.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/.gitbook/assets/ongoing-access-code-dark.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/.gitbook/assets/ongoing-access-code-light.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/.gitbook/assets/seam-cli-cover.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/.gitbook/assets/seam-cli-demo.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
14 changes: 10 additions & 4 deletions docs/SUMMARY.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,7 @@
* [Managed and Unmanaged Devices](core-concepts/devices/managed-and-unmanaged-devices.md)
* [Adding Custom Metadata to a Device](core-concepts/devices/adding-custom-metadata-to-a-device.md)
* [Filtering Devices by Custom Metadata](core-concepts/devices/filtering-devices-by-custom-metadata.md)
* [Testing Your App Against Device Disconnection and Removal](core-concepts/devices/testing-your-app-against-device-disconnection-and-removal.md)
* [Connected Accounts](core-concepts/connected-accounts/README.md)
* [Adding Custom Metadata to a Connected Account](core-concepts/connected-accounts/adding-custom-metadata-to-a-connected-account.md)
* [Filtering Connected Accounts by Custom Metadata](core-concepts/connected-accounts/filtering-connected-accounts-by-custom-metadata.md)
Expand All @@ -31,8 +32,8 @@

* [📋 Device and System Capabilities](capability-guides/device-and-system-capabilities.md)
* [🔒 Smart Locks](products/smart-locks/README.md)
* [Locking and Unlocking](products/smart-locks/lock-and-unlock.md)
* [Managing Access Codes](products/smart-locks/access-codes/README.md)
* [Locking and Unlocking Smart Locks](products/smart-locks/lock-and-unlock.md)
* [Creating and Managing Smart Lock Access Codes](products/smart-locks/access-codes/README.md)
* [Creating Access Codes](products/smart-locks/access-codes/creating-access-codes.md)
* [Retrieving Access Codes](products/smart-locks/access-codes/retrieving-access-codes.md)
* [Modifying Access Codes](products/smart-locks/access-codes/modifying-access-codes.md)
Expand Down Expand Up @@ -157,8 +158,8 @@
* [List Locks](api-clients/locks/list.md)
* [Access Control Systems](api-clients/acs/README.md)
* [Systems](api/acs/systems/README.md)
* [List Systems](api/acs/systems/list.md)
* [Get a System](api/acs/systems/get.md)
* [List ACS Systems](api/acs/systems/list.md)
* [Get an ACS System](api/acs/systems/get.md)
* [List Compatible Credential Manager ACS Systems](api/acs/systems/list\_compatible\_credential\_manager\_acs\_systems.md)
* [Users](api/acs/users/README.md)
* [Create a User](api/acs/users/create.md)
Expand Down Expand Up @@ -231,9 +232,11 @@
## 🛠️ Developer Tools

* [Webhooks](core-concepts/webhooks.md)
* [Seam CLI](developer-tools/seam-cli.md)
* [Sandbox Devices and Systems](device-guides/sandbox-and-sample-data/README.md)
* [Sandbox 2N Intercoms](device-guides/sandbox-and-sample-data/2n-intercoms-sample-data.md)
* [Sandbox 4SUITES Locks](device-guides/sandbox-and-sample-data/4suites-locks-sample-data.md)
* [Sandbox Akiles Locks](developer-tools/sandbox-and-sample-data/sandbox-akiles-locks.md)
* [Sandbox ASSA ABLOY Credential Services](device-guides/sandbox-and-sample-data/assa-abloy-credential-service-sample-data.md)
* [Sandbox ASSA ABLOY Visionline Access Control System](device-guides/sandbox-and-sample-data/assa-abloy-visionline-access-management-system-sample-data.md)
* [Sandbox August Locks](device-guides/sandbox-and-sample-data/august-locks-sample-data.md)
Expand All @@ -248,6 +251,7 @@
* [Sandbox Honeywell Resideo Thermostats](developer-tools/sandbox-and-sample-data/sandbox-honeywell-thermostats.md)
* [Sandbox igloohome Locks](device-guides/sandbox-and-sample-data/igloohome-sample-data.md)
* [Sandbox Kwikset Locks](device-guides/sandbox-and-sample-data/kwikset-locks-sample-data.md)
* [Sandbox Latch Access Control System](developer-tools/sandbox-and-sample-data/sandbox-latch-access-control-system.md)
* [Sandbox Linear Callboxes](device-guides/sandbox-and-sample-data/linear-sample-data.md)
* [Sandbox Lockly Locks](device-guides/sandbox-and-sample-data/lockly-lock-sample-data.md)
* [Sandbox Minut Sensors](device-guides/sandbox-and-sample-data/minut-noise-sensor-sample-data.md)
Expand All @@ -274,6 +278,8 @@
* [Get started with 2N Intercoms](device-guides/get-started-with-2n-intercoms.md)
* [4SUITES Locks](device-and-system-integration-guides/4suites-locks/README.md)
* [Get started with 4SUITES locks](device-and-system-integration-guides/4suites-locks/get-started-with-4suites-locks.md)
* [Akiles Locks](device-and-system-integration-guides/akiles-locks/README.md)
* [Get started with Akiles locks](device-and-system-integration-guides/akiles-locks/get-started-with-akiles-locks.md)
* [ASSA ABLOY Credential Services](device-guides/assa-abloy-credential-services-credential-manager-in-development.md)
* [ASSA ABLOY Visionline Access Control System](device-guides/assa-abloy-visionline-access-control-system-in-development/README.md)
* [Visionline ACS Setup Instructions](device-and-system-integration-guides/assa-abloy-visionline-access-control-system-in-development/visionline-acs-setup-instructions/README.md)
Expand Down
14 changes: 7 additions & 7 deletions docs/api-clients/access_codes/create.md
Original file line number Diff line number Diff line change
Expand Up @@ -840,7 +840,7 @@ seam.accessCodes().create(AccessCodesCreateRequest.builder()
{% endtab %}
{% endtabs %}

### Creating an Hourly-Bound Offline Access Code
### Creating an Time-Bound Offline Access Code

{% tabs %}
{% tab title="Python" %}
Expand All @@ -851,7 +851,7 @@ device_id = "9689dc30-77d8-4728-9968-b3abd0835f47"

created_access_code = seam.access_codes.create(
device = device_id,
name = "my hourly-bound offline code",
name = "my time-bound offline code",
starts_at = "2023-11-10T00:00:00-00:00",
ends_at = "2023-11-15T18:00:00-00:00",
is_offline_access_code = True
Expand All @@ -872,7 +872,7 @@ AccessCode(access_code_id='f078dce8-3c5e-4bc4-bd08-3ad013ee8be6',
warnings=[],
starts_at='2023-11-10T00:00:00.000Z',
ends_at='2023-11-15T18:00:00.000Z',
name='my hourly-bound offline code5',
name='my time-bound offline code',
status='unset',
common_code_key=None,
is_managed=True,
Expand All @@ -899,7 +899,7 @@ curl -X 'POST' \
-H 'Content-Type: application/json' \
-d '{
"device_id": "9689dc30-77d8-4728-9968-b3abd0835f47",
"name": "my hourly-bound offline code",
"name": "my time-bound offline code",
"starts_at": "2023-11-10T00:00:00-00:00",
"ends_at": "2023-11-15T18:00:00-00:00",
"is_offline_access_code": true
Expand All @@ -920,7 +920,7 @@ curl -X 'POST' \
"access_code": {
"access_code_id": "a4960c38-fe15-4766-8647-c93e8f05f84a",
"device_id": "9689dc30-77d8-4728-9968-b3abd0835f47",
"name": "my hourly-bound offline code",
"name": "my time-bound offline code",
"appearance": null,
"code": null,
"is_waiting_for_code_assignment": true,
Expand Down Expand Up @@ -952,7 +952,7 @@ const deviceId = "ea12f6c6-e63e-447d-856b-ec9e92981000"

const createdAccessCode = await seam.accessCodes.create({
device_id: deviceId,
name: "my hourly-bound offline code",
name: "my time-bound offline code",
starts_at: "2023-12-22T06:00:00-00:00",
ends_at: "2023-12-22T18:00:00-00:00",
max_time_rounding: "1h",
Expand All @@ -968,7 +968,7 @@ console.log(createdAccessCode)
{
access_code_id: 'b4977781-7108-478a-a5ec-764b51ba2647',
device_id: 'ea12f6c6-e63e-447d-856b-ec9e92981000',
name: 'my hourly-bound offline code',
name: 'my time-bound offline code',
appearance: null,
code: null,
is_waiting_for_code_assignment: true,
Expand Down
5 changes: 3 additions & 2 deletions docs/api-clients/connect_webviews/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,17 +46,18 @@ When you [create a Connect Webview](create.md), specify the desired provider cat
| `noise_sensors` | Only returns provider integrations marked as noise sensors. |

{% hint style="info" %}
To list all providers within a category, use the [List Device Providers](../devices/list_device_providers.md) method with the desired `provider_category` filter.
To list all providers within a category, use the [List Device Providers](../devices/list\_device\_providers.md) method with the desired `provider_category` filter.
{% endhint %}

### Device Provider Keys

To list all provider keys, use the [List Device Providers](../devices/list_device_providers.md) method with no filters.
To list all provider keys, use the [List Device Providers](../devices/list\_device\_providers.md) method with no filters.

| Provider Name | Device Provider Key |
| ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------- |
| [2N](../../device-guides/2n-intercom-systems.md) | `my_2n` |
| [4SUITES](../../device-and-system-integration-guides/4suites-locks/) | `four_suites` |
| [Akiles](../../device-and-system-integration-guides/akiles-locks/) | `akiles` |
| [Akuvox](https://akuvox.com/) | `akuvox` |
| [ASSA ABLOY Credential Service](../../device-guides/assa-abloy-credential-services-credential-manager-in-development.md) | `assa_abloy_credential_service` |
| [ASSA ABLOY Visionline Access Control System](../../device-guides/assa-abloy-visionline-access-control-system-in-development/) | `visionline` |
Expand Down
Loading

0 comments on commit 94fda55

Please sign in to comment.