Skip to content
This repository was archived by the owner on Nov 15, 2024. It is now read-only.
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
15 changes: 8 additions & 7 deletions docs/classes/Seam.md
Original file line number Diff line number Diff line change
Expand Up @@ -62,14 +62,15 @@ Routes.constructor
| `create` | (`params`: [`AccessCodeCreateOngoingRequest`](../interfaces/AccessCodeCreateOngoingRequest.md)) => `Promise`<[`OngoingAccessCode`](../interfaces/OngoingAccessCode.md)\>(`params`: [`AccessCodeCreateScheduledRequest`](../interfaces/AccessCodeCreateScheduledRequest.md)) => `Promise`<[`TimeBoundAccessCode`](../interfaces/TimeBoundAccessCode.md)\> |
| `delete` | (`params`: [`AccessCodeDeleteRequest`](../modules.md#accesscodedeleterequest)) => `Promise`<`unknown`\> |
| `list` | (`params`: { `device_id`: `string` }) => `Promise`<[`AccessCode`](../modules.md#accesscode)[]\> |
| `update` | (`params`: [`AccessCodeUpdateRequest`](../modules.md#accesscodeupdaterequest)) => `Promise`<[`OngoingAccessCode`](../interfaces/OngoingAccessCode.md) \| [`TimeBoundAccessCode`](../interfaces/TimeBoundAccessCode.md)\> |

#### Inherited from

Routes.accessCodes

#### Defined in

[src/routes.ts:193](https://github.com/seamapi/javascript/blob/main/src/routes.ts#L193)
[src/routes.ts:196](https://github.com/seamapi/javascript/blob/main/src/routes.ts#L196)

___

Expand All @@ -89,7 +90,7 @@ Routes.actionAttempts

#### Defined in

[src/routes.ts:264](https://github.com/seamapi/javascript/blob/main/src/routes.ts#L264)
[src/routes.ts:260](https://github.com/seamapi/javascript/blob/main/src/routes.ts#L260)

___

Expand Down Expand Up @@ -121,7 +122,7 @@ Routes.connectWebviews

#### Defined in

[src/routes.ts:167](https://github.com/seamapi/javascript/blob/main/src/routes.ts#L167)
[src/routes.ts:170](https://github.com/seamapi/javascript/blob/main/src/routes.ts#L170)

___

Expand All @@ -142,7 +143,7 @@ Routes.connectedAccounts

#### Defined in

[src/routes.ts:243](https://github.com/seamapi/javascript/blob/main/src/routes.ts#L243)
[src/routes.ts:239](https://github.com/seamapi/javascript/blob/main/src/routes.ts#L239)

___

Expand All @@ -164,7 +165,7 @@ Routes.devices

#### Defined in

[src/routes.ts:148](https://github.com/seamapi/javascript/blob/main/src/routes.ts#L148)
[src/routes.ts:151](https://github.com/seamapi/javascript/blob/main/src/routes.ts#L151)

___

Expand All @@ -187,7 +188,7 @@ Routes.locks

#### Defined in

[src/routes.ts:113](https://github.com/seamapi/javascript/blob/main/src/routes.ts#L113)
[src/routes.ts:116](https://github.com/seamapi/javascript/blob/main/src/routes.ts#L116)

___

Expand All @@ -209,7 +210,7 @@ Routes.workspaces

#### Defined in

[src/routes.ts:97](https://github.com/seamapi/javascript/blob/main/src/routes.ts#L97)
[src/routes.ts:100](https://github.com/seamapi/javascript/blob/main/src/routes.ts#L100)

## Methods

Expand Down
6 changes: 3 additions & 3 deletions docs/interfaces/AccessCodeBase.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@

#### Defined in

[src/types/models.ts:133](https://github.com/seamapi/javascript/blob/main/src/types/models.ts#L133)
[src/types/models.ts:135](https://github.com/seamapi/javascript/blob/main/src/types/models.ts#L135)

___

Expand All @@ -36,7 +36,7 @@ ___

#### Defined in

[src/types/models.ts:135](https://github.com/seamapi/javascript/blob/main/src/types/models.ts#L135)
[src/types/models.ts:137](https://github.com/seamapi/javascript/blob/main/src/types/models.ts#L137)

___

Expand All @@ -46,4 +46,4 @@ ___

#### Defined in

[src/types/models.ts:134](https://github.com/seamapi/javascript/blob/main/src/types/models.ts#L134)
[src/types/models.ts:136](https://github.com/seamapi/javascript/blob/main/src/types/models.ts#L136)
6 changes: 3 additions & 3 deletions docs/interfaces/AccessCodeCreateBaseRequest.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@

#### Defined in

[src/types/route-requests.ts:16](https://github.com/seamapi/javascript/blob/main/src/types/route-requests.ts#L16)
[src/types/route-requests.ts:17](https://github.com/seamapi/javascript/blob/main/src/types/route-requests.ts#L17)

___

Expand All @@ -36,7 +36,7 @@ ___

#### Defined in

[src/types/route-requests.ts:14](https://github.com/seamapi/javascript/blob/main/src/types/route-requests.ts#L14)
[src/types/route-requests.ts:15](https://github.com/seamapi/javascript/blob/main/src/types/route-requests.ts#L15)

___

Expand All @@ -46,4 +46,4 @@ ___

#### Defined in

[src/types/route-requests.ts:15](https://github.com/seamapi/javascript/blob/main/src/types/route-requests.ts#L15)
[src/types/route-requests.ts:16](https://github.com/seamapi/javascript/blob/main/src/types/route-requests.ts#L16)
6 changes: 3 additions & 3 deletions docs/interfaces/AccessCodeCreateOngoingRequest.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@

#### Defined in

[src/types/route-requests.ts:16](https://github.com/seamapi/javascript/blob/main/src/types/route-requests.ts#L16)
[src/types/route-requests.ts:17](https://github.com/seamapi/javascript/blob/main/src/types/route-requests.ts#L17)

___

Expand All @@ -42,7 +42,7 @@ ___

#### Defined in

[src/types/route-requests.ts:14](https://github.com/seamapi/javascript/blob/main/src/types/route-requests.ts#L14)
[src/types/route-requests.ts:15](https://github.com/seamapi/javascript/blob/main/src/types/route-requests.ts#L15)

___

Expand All @@ -56,4 +56,4 @@ ___

#### Defined in

[src/types/route-requests.ts:15](https://github.com/seamapi/javascript/blob/main/src/types/route-requests.ts#L15)
[src/types/route-requests.ts:16](https://github.com/seamapi/javascript/blob/main/src/types/route-requests.ts#L16)
10 changes: 5 additions & 5 deletions docs/interfaces/AccessCodeCreateScheduledRequest.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@

#### Defined in

[src/types/route-requests.ts:16](https://github.com/seamapi/javascript/blob/main/src/types/route-requests.ts#L16)
[src/types/route-requests.ts:17](https://github.com/seamapi/javascript/blob/main/src/types/route-requests.ts#L17)

___

Expand All @@ -44,7 +44,7 @@ ___

#### Defined in

[src/types/route-requests.ts:14](https://github.com/seamapi/javascript/blob/main/src/types/route-requests.ts#L14)
[src/types/route-requests.ts:15](https://github.com/seamapi/javascript/blob/main/src/types/route-requests.ts#L15)

___

Expand All @@ -54,7 +54,7 @@ ___

#### Defined in

[src/types/route-requests.ts:25](https://github.com/seamapi/javascript/blob/main/src/types/route-requests.ts#L25)
[src/types/route-requests.ts:26](https://github.com/seamapi/javascript/blob/main/src/types/route-requests.ts#L26)

___

Expand All @@ -68,7 +68,7 @@ ___

#### Defined in

[src/types/route-requests.ts:15](https://github.com/seamapi/javascript/blob/main/src/types/route-requests.ts#L15)
[src/types/route-requests.ts:16](https://github.com/seamapi/javascript/blob/main/src/types/route-requests.ts#L16)

___

Expand All @@ -78,4 +78,4 @@ ___

#### Defined in

[src/types/route-requests.ts:24](https://github.com/seamapi/javascript/blob/main/src/types/route-requests.ts#L24)
[src/types/route-requests.ts:25](https://github.com/seamapi/javascript/blob/main/src/types/route-requests.ts#L25)
30 changes: 30 additions & 0 deletions docs/interfaces/AccessCodeUpdateBaseRequest.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
[seamapi](../README.md) / [Exports](../modules.md) / AccessCodeUpdateBaseRequest

# Interface: AccessCodeUpdateBaseRequest

## Table of contents

### Properties

- [access\_code\_id](AccessCodeUpdateBaseRequest.md#access_code_id)
- [device\_id](AccessCodeUpdateBaseRequest.md#device_id)

## Properties

### access\_code\_id

• **access\_code\_id**: `string`

#### Defined in

[src/types/route-requests.ts:35](https://github.com/seamapi/javascript/blob/main/src/types/route-requests.ts#L35)

___

### device\_id

• `Optional` **device\_id**: `string`

#### Defined in

[src/types/route-requests.ts:34](https://github.com/seamapi/javascript/blob/main/src/types/route-requests.ts#L34)
23 changes: 22 additions & 1 deletion docs/interfaces/ActionAttemptResultTypeMap.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@
- [DELETE\_ACCESS\_CODE](ActionAttemptResultTypeMap.md#delete_access_code)
- [LOCK\_DOOR](ActionAttemptResultTypeMap.md#lock_door)
- [UNLOCK\_DOOR](ActionAttemptResultTypeMap.md#unlock_door)
- [UPDATE\_ACCESS\_CODE](ActionAttemptResultTypeMap.md#update_access_code)

## Properties

Expand All @@ -35,7 +36,7 @@ Record.CREATE\_ACCESS\_CODE

#### Defined in

[src/types/models.ts:100](https://github.com/seamapi/javascript/blob/main/src/types/models.ts#L100)
[src/types/models.ts:101](https://github.com/seamapi/javascript/blob/main/src/types/models.ts#L101)

___

Expand Down Expand Up @@ -66,3 +67,23 @@ ___
#### Inherited from

Record.UNLOCK\_DOOR

___

### UPDATE\_ACCESS\_CODE

• **UPDATE\_ACCESS\_CODE**: `Object`

#### Type declaration

| Name | Type |
| :------ | :------ |
| `access_code` | [`AccessCode`](../modules.md#accesscode) |

#### Overrides

Record.UPDATE\_ACCESS\_CODE

#### Defined in

[src/types/models.ts:102](https://github.com/seamapi/javascript/blob/main/src/types/models.ts#L102)
10 changes: 5 additions & 5 deletions docs/interfaces/ActionAttemptWithError.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ ActionAttemptBase.action\_attempt\_id

#### Defined in

[src/types/models.ts:74](https://github.com/seamapi/javascript/blob/main/src/types/models.ts#L74)
[src/types/models.ts:75](https://github.com/seamapi/javascript/blob/main/src/types/models.ts#L75)

___

Expand All @@ -50,7 +50,7 @@ ActionAttemptBase.action\_type

#### Defined in

[src/types/models.ts:75](https://github.com/seamapi/javascript/blob/main/src/types/models.ts#L75)
[src/types/models.ts:76](https://github.com/seamapi/javascript/blob/main/src/types/models.ts#L76)

___

Expand All @@ -71,7 +71,7 @@ ActionAttemptBase.error

#### Defined in

[src/types/models.ts:92](https://github.com/seamapi/javascript/blob/main/src/types/models.ts#L92)
[src/types/models.ts:93](https://github.com/seamapi/javascript/blob/main/src/types/models.ts#L93)

___

Expand All @@ -85,7 +85,7 @@ ActionAttemptBase.result

#### Defined in

[src/types/models.ts:91](https://github.com/seamapi/javascript/blob/main/src/types/models.ts#L91)
[src/types/models.ts:92](https://github.com/seamapi/javascript/blob/main/src/types/models.ts#L92)

___

Expand All @@ -99,4 +99,4 @@ ActionAttemptBase.status

#### Defined in

[src/types/models.ts:90](https://github.com/seamapi/javascript/blob/main/src/types/models.ts#L90)
[src/types/models.ts:91](https://github.com/seamapi/javascript/blob/main/src/types/models.ts#L91)
Loading