Skip to content

Commit 648012a

Browse files
committed
Update links to use api/access_codes
1 parent 83d2104 commit 648012a

7 files changed

Lines changed: 13 additions & 13 deletions

File tree

docs/capability-guides/smart-locks/access-codes/creating-access-codes/README.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -19,11 +19,11 @@ layout:
1919

2020
## Overview
2121

22-
This guide explains how to create online access codes on an online smart lock. With the [Access Codes](../../../../api-clients/access_codes/) API, generate PIN codes on a door lock and share it with visitors, allowing them keyless access.
22+
This guide explains how to create online access codes on an online smart lock. With the [Access Codes](../../../../api/access_codes/) API, generate PIN codes on a door lock and share it with visitors, allowing them keyless access.
2323

2424
Seam supports programming two types of online access codes for online door locks:
2525

26-
1. **Ongoing**: Ideal for residents or long-term users. Ongoing codes remain active on a device until removed. Create one by omitting both `starts_at` and `ends_at`. To remove the code, use the [Delete Access Code](../../../../api-clients/access_codes/delete.md) endpoint.
26+
1. **Ongoing**: Ideal for residents or long-term users. Ongoing codes remain active on a device until removed. Create one by omitting both `starts_at` and `ends_at`. To remove the code, use the [Delete Access Code](../../../../api/access_codes/delete.md) endpoint.
2727
2. **Time Bound**: Suitable for temporary access like guest visits or service appointments. These codes operate between a designated `starts_at` and `ends_at` time window, granting access only during that period.
2828

2929
{% hint style="info" %}
@@ -232,7 +232,7 @@ Ongoing online access codes are ideal for long-term users that wish to keep the
232232

233233
### 1. Create an Ongoing Online Access Code
234234

235-
Set an ongoing online access code by providing the `device_id` of the smart lock on which you want to [create an access code](../../../../api-clients/access_codes/create.md). Assign an optional `name` to the access code for easier identification within the [Seam Console](https://console.seam.co) and smart lock app.
235+
Set an ongoing online access code by providing the `device_id` of the smart lock on which you want to [create an access code](../../../../api/access_codes/create.md). Assign an optional `name` to the access code for easier identification within the [Seam Console](https://console.seam.co) and smart lock app.
236236

237237
To customize the PIN code, specify a desired PIN for the `code` property. If you do not specify a `code`, you can set the `preferred_code_length`, and Seam generates a code of this length if the affected device supports the specified preferred code length. See [Access Code Requirements for Door Locks](../../../../products/smart-locks/access-codes/access-code-requirements-for-door-locks.md) to understand any requirements specific to the door lock.
238238

@@ -550,7 +550,7 @@ There are two methods to verify that an ongoing access code has been set on the
550550

551551
### **Polling Method**
552552

553-
Use the `access_code` reference returned by the create function to call the [Get Access Code](../../../../api-clients/access_codes/get/) function. A basic implementation would involve polling this endpoint until the `status` of the access code updates to `set`.
553+
Use the `access_code` reference returned by the create function to call the [Get Access Code](../../../../api/access_codes/get/) function. A basic implementation would involve polling this endpoint until the `status` of the access code updates to `set`.
554554

555555
If the `status` remains `setting` for a very long time, or if the `access_code` object contains any `warnings` or `errors` properties, consult [the guide on "Troubleshooting Access Code Issues"](../../../../products/smart-locks/access-codes/troubleshooting-access-code-issues.md) for further guidance.
556556

@@ -577,7 +577,7 @@ Time-bound online access codes are suitable for temporary access, like guest vis
577577

578578
### 1. Create a Time-Bound Online Access Code
579579

580-
To set a time-bound online access code, provide the `device_id` of the smart lock on which you want to program a code, along with `starts_at` and `ends_at` [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) timestamps to define the active time window for the code. For more details, see the [Create Access Code](../../../../api-clients/access_codes/create.md) endpoint.
580+
To set a time-bound online access code, provide the `device_id` of the smart lock on which you want to program a code, along with `starts_at` and `ends_at` [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) timestamps to define the active time window for the code. For more details, see the [Create Access Code](../../../../api/access_codes/create.md) endpoint.
581581

582582
As with ongoing codes, you can assign an optional `name` to the access code. A clear name helps users to identify the access code quickly within their smart lock app.
583583

@@ -936,7 +936,7 @@ There are two methods to verify that an time-bound access code has been set on t
936936

937937
### **Polling Method**
938938

939-
Use the `access_code` reference returned by the create function to call the [Get Access Code](../../../../api-clients/access_codes/get/) function. In a basic implementation, you would poll this endpoint at the `starts_at` time to check if the access code's status is updated to `set`.
939+
Use the `access_code` reference returned by the create function to call the [Get Access Code](../../../../api/access_codes/get/) function. In a basic implementation, you would poll this endpoint at the `starts_at` time to check if the access code's status is updated to `set`.
940940

941941
If the `status` remains `setting`, or if the `access_code` object displays any `warnings` or `errors`, refer to [the "Troubleshooting Access Code Issues" guide](../../../../products/smart-locks/access-codes/troubleshooting-access-code-issues.md) for assistance.
942942

docs/device-and-system-integration-guides/smartthings-hubs-+-smart-locks.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ Note the following SmartThings-specific features:
4949

5050
### Reporting Access Code Length Constraints
5151

52-
For SmartThings-connected devices, you can report the set of supported access code lengths or the minimum and maximum supported code lengths. For details, see [Report Device Access Code Constraints](../api-clients/access_codes/report-device-access-code-constraints.md).
52+
For SmartThings-connected devices, you can report the set of supported access code lengths or the minimum and maximum supported code lengths. For details, see [Report Device Access Code Constraints](../api/access_codes/report-device-access-code-constraints.md).
5353

5454
***
5555

docs/device-guides/implementing-robust-access-code-management-for-guests.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ Seam's backup access code pool, we automatically make sure all backup access cod
4646
are healthy, ready for immediate usage, replaced after every use, and automatically
4747
removed when a reservation ends.
4848

49-
Seam's official backup access code pool can be enabled by adding `use_backup_access_code_pool: true` to any [`/access_codes/create` API request](https://docs.seam.co/latest/api-clients/access_codes/create). You can then retrieve access codes using [`/access_codes/pull_backup_access_code`](https://docs.seam.co/latest/api-clients/access_codes/pull_backup_access_code).
49+
Seam's official backup access code pool can be enabled by adding `use_backup_access_code_pool: true` to any [`/access_codes/create` API request](https://docs.seam.co/latest/api/access_codes/create). You can then retrieve access codes using [`/access_codes/pull_backup_access_code`](https://docs.seam.co/latest/api/access_codes/pull_backup_access_code).
5050

5151
{% tabs %}
5252

docs/products/smart-locks/access-codes/backup-access-codes.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -516,7 +516,7 @@ You can retrieve a backup access code to use instead.
516516

517517
### 3. Confirm the availability of a backup access code
518518

519-
To confirm that a backup access code is available for retrieval, check the `is_backup_access_code_available` property on the access code by inspecting the response from [Get Access Code](../../../api-clients/access_codes/get/) or [List Access Codes](../../../api/access_codes/list.md). If the backup code pool has been exhausted, this property returns `false`.
519+
To confirm that a backup access code is available for retrieval, check the `is_backup_access_code_available` property on the access code by inspecting the response from [Get Access Code](../../../api/access_codes/get/) or [List Access Codes](../../../api/access_codes/list.md). If the backup code pool has been exhausted, this property returns `false`.
520520

521521
{% hint style="info" %}
522522
Note that we only support pulling backup codes for `time_bound` codes at this time.

docs/products/smart-locks/access-codes/modifying-access-codes.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -200,7 +200,7 @@ There are two methods to verify that a permanent access code has been set on the
200200

201201
**Polling Method**
202202

203-
Utilize the `access_code_id` returned in the response from the create endpoint to invoke the [Get Access Code](../../../api-clients/access_codes/get/) endpoint. A basic implementation would involve polling this endpoint until the `status` of the access code updates to `set`.
203+
Utilize the `access_code_id` returned in the response from the create endpoint to invoke the [Get Access Code](../../../api/access_codes/get/) endpoint. A basic implementation would involve polling this endpoint until the `status` of the access code updates to `set`.
204204

205205
If the `status` remains `setting` for a very long time, or if the `access_code` object contains any `warnings` or `errors` properties, consult [our guide on "Troubleshooting Access Code Issues"](troubleshooting-access-code-issues.md) for further guidance.
206206

@@ -216,7 +216,7 @@ There are two methods to verify that a time-bound access code has been set on th
216216

217217
**Polling Method**
218218

219-
Use the `access_code_id` provided in the response from the create endpoint to call the [Get Access Code](../../../api-clients/access_codes/get/) endpoint. In a basic implementation, you would poll this endpoint at the `starts_at` time to check if the access code's status is updated to `set`.
219+
Use the `access_code_id` provided in the response from the create endpoint to call the [Get Access Code](../../../api/access_codes/get/) endpoint. In a basic implementation, you would poll this endpoint at the `starts_at` time to check if the access code's status is updated to `set`.
220220

221221
If the `status` remains `setting`, or if the `access_code` object displays any warnings or errors, refer to [our "Troubleshooting Access Code Issues" guide](troubleshooting-access-code-issues.md) for assistance.
222222

docs/products/smart-locks/access-codes/retrieving-access-codes.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -709,7 +709,7 @@ System.out.println(accessCodes);
709709

710710
## Retrieving Individual Access Codes
711711

712-
To retrieve a specific access code, include the desired `access_code_id` in the [Get Access Code](../../../api-clients/access_codes/get/) request.
712+
To retrieve a specific access code, include the desired `access_code_id` in the [Get Access Code](../../../api/access_codes/get/) request.
713713

714714
{% tabs %}
715715
{% tab title="Python" %}

docs/products/smart-locks/access-codes/troubleshooting-access-code-issues.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ If the device or connected account associated with an access code has an error,
2929

3030
## Determining the Issue
3131

32-
The first step in troubleshooting an access code issue is to figure out what the issue is from Seam's point of view. Make a [Get Access Code](../../../api-clients/access_codes/get/) or [List Access Codes](../../../api/access_codes/list.md) request and look at the `errors` and `warnings` payloads on the access code object. Look at the error and warning codes. Then, see the matching remedy in [Suggested Access Code Remedies](troubleshooting-access-code-issues.md#suggested-access-code-remedies) for next steps.
32+
The first step in troubleshooting an access code issue is to figure out what the issue is from Seam's point of view. Make a [Get Access Code](../../../api/access_codes/get/) or [List Access Codes](../../../api/access_codes/list.md) request and look at the `errors` and `warnings` payloads on the access code object. Look at the error and warning codes. Then, see the matching remedy in [Suggested Access Code Remedies](troubleshooting-access-code-issues.md#suggested-access-code-remedies) for next steps.
3333

3434
{% tabs %}
3535
{% tab title="Python" %}

0 commit comments

Comments
 (0)