Skip to content
This repository was archived by the owner on Nov 15, 2024. It is now read-only.

Commit 9926766

Browse files
committed
fix: clean up types
1 parent ebd8789 commit 9926766

32 files changed

+694
-500
lines changed

docs/classes/default.md

Lines changed: 20 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -60,17 +60,17 @@ Routes.constructor
6060

6161
| Name | Type |
6262
| :------ | :------ |
63-
| `create` | (`params`: [`AccessCodeCreateRequest`](../modules.md#accesscodecreaterequest)) => `Promise`<[`AccessCode`](../interfaces/AccessCode.md)\> |
64-
| `delete` | (`params`: [`AccessCodeDeleteRequest`](../modules.md#accesscodedeleterequest)) => `Promise`<[`Workspace`](../interfaces/Workspace.md) \| [`Workspace`](../interfaces/Workspace.md)[] \| [`Device`](../interfaces/Device.md)<[`LockProperties`](../interfaces/LockProperties.md), `any`\> \| [`Device`](../interfaces/Device.md)<[`LockProperties`](../interfaces/LockProperties.md), `any`\>[] \| [`ActionAttempt`](../modules.md#actionattempt)<`any`\> \| [`AccessCode`](../interfaces/AccessCode.md) \| [`AccessCode`](../interfaces/AccessCode.md)[] \| [`Device`](../interfaces/Device.md)<`any`, `any`\> \| [`Device`](../interfaces/Device.md)<`any`, `any`\>[] \| [`ConnectWebview`](../interfaces/ConnectWebview.md) \| [`ConnectWebview`](../interfaces/ConnectWebview.md)[] \| [`ConnectedAccount`](../interfaces/ConnectedAccount.md) \| [`ConnectedAccount`](../interfaces/ConnectedAccount.md)[]\> |
65-
| `list` | (`params`: { `device_id`: `string` }) => `Promise`<[`AccessCode`](../interfaces/AccessCode.md)[]\> |
63+
| `create` | (`params`: [`AccessCodeCreateBaseRequest`](../interfaces/AccessCodeCreateBaseRequest.md)) => `Promise`<[`OngoingAccessCode`](../interfaces/OngoingAccessCode.md)\> \| (`params`: [`AccessCodeCreateScheduledRequest`](../interfaces/AccessCodeCreateScheduledRequest.md)) => `Promise`<[`TimeBoundAccessCode`](../interfaces/TimeBoundAccessCode.md)\> |
64+
| `delete` | (`params`: [`AccessCodeDeleteRequest`](../modules.md#accesscodedeleterequest)) => `Promise`<`unknown`\> |
65+
| `list` | (`params`: { `device_id`: `string` }) => `Promise`<[`AccessCode`](../modules.md#accesscode)[]\> |
6666

6767
#### Inherited from
6868

6969
Routes.accessCodes
7070

7171
#### Defined in
7272

73-
[src/routes.ts:168](https://github.com/seamapi/seamapi-javascript/blob/main/src/routes.ts#L168)
73+
[src/routes.ts:190](https://github.com/seamapi/seamapi-javascript/blob/main/src/routes.ts#L190)
7474

7575
___
7676

@@ -82,15 +82,15 @@ ___
8282

8383
| Name | Type |
8484
| :------ | :------ |
85-
| `get` | (`actionAttemptId`: `string`) => `Promise`<[`ActionAttempt`](../modules.md#actionattempt)<`any`\>\> |
85+
| `get` | <T\>(`actionAttemptId`: `string`) => `Promise`<[`ActionAttempt`](../modules.md#actionattempt)<`T`\>\> |
8686

8787
#### Inherited from
8888

8989
Routes.actionAttempts
9090

9191
#### Defined in
9292

93-
[src/routes.ts:227](https://github.com/seamapi/seamapi-javascript/blob/main/src/routes.ts#L227)
93+
[src/routes.ts:262](https://github.com/seamapi/seamapi-javascript/blob/main/src/routes.ts#L262)
9494

9595
___
9696

@@ -112,7 +112,7 @@ ___
112112

113113
| Name | Type |
114114
| :------ | :------ |
115-
| `create` | (`params`: [`ConnectWebviewCreateRequest`](../interfaces/ConnectWebviewCreateRequest.md)) => `Promise`<[`ConnectWebview`](../interfaces/ConnectWebview.md)\> |
115+
| `create` | (`params`: [`ConnectWebviewCreateRequest`](../interfaces/ConnectWebviewCreateRequest.md)) => `Promise`<`Omit`<[`ConnectWebview`](../interfaces/ConnectWebview.md), ``"connected_account_id"``\> & { `custom_redirect_url`: ``null`` \| `string` }\> |
116116
| `get` | (`connectWebviewId`: `string`) => `Promise`<[`ConnectWebview`](../interfaces/ConnectWebview.md)\> |
117117
| `list` | () => `Promise`<[`ConnectWebview`](../interfaces/ConnectWebview.md)[]\> |
118118

@@ -122,7 +122,7 @@ Routes.connectWebviews
122122

123123
#### Defined in
124124

125-
[src/routes.ts:148](https://github.com/seamapi/seamapi-javascript/blob/main/src/routes.ts#L148)
125+
[src/routes.ts:164](https://github.com/seamapi/seamapi-javascript/blob/main/src/routes.ts#L164)
126126

127127
___
128128

@@ -143,7 +143,7 @@ Routes.connectedAccounts
143143

144144
#### Defined in
145145

146-
[src/routes.ts:212](https://github.com/seamapi/seamapi-javascript/blob/main/src/routes.ts#L212)
146+
[src/routes.ts:241](https://github.com/seamapi/seamapi-javascript/blob/main/src/routes.ts#L241)
147147

148148
___
149149

@@ -155,16 +155,16 @@ ___
155155

156156
| Name | Type |
157157
| :------ | :------ |
158-
| `get` | (`deviceId`: `string`) => `Promise`<[`Device`](../interfaces/Device.md)<`any`, `any`\>\> |
159-
| `list` | (`connectedAccountId?`: `string`) => `Promise`<[`Device`](../interfaces/Device.md)<`any`, `any`\>[]\> |
158+
| `get` | (`deviceId`: `string`) => `Promise`<[`Device`](../interfaces/Device.md)<`unknown`, [`DeviceType`](../modules.md#devicetype)\>\> |
159+
| `list` | (`connectedAccountId?`: `string`) => `Promise`<[`Device`](../interfaces/Device.md)<`unknown`, [`DeviceType`](../modules.md#devicetype)\>[]\> |
160160

161161
#### Inherited from
162162

163163
Routes.devices
164164

165165
#### Defined in
166166

167-
[src/routes.ts:129](https://github.com/seamapi/seamapi-javascript/blob/main/src/routes.ts#L129)
167+
[src/routes.ts:145](https://github.com/seamapi/seamapi-javascript/blob/main/src/routes.ts#L145)
168168

169169
___
170170

@@ -176,18 +176,18 @@ ___
176176

177177
| Name | Type |
178178
| :------ | :------ |
179-
| `get` | (`deviceId`: `string`) => `Promise`<[`Device`](../interfaces/Device.md)<[`LockProperties`](../interfaces/LockProperties.md), `any`\>\> |
180-
| `list` | (`connectedAccountId?`: `string`) => `Promise`<[`Device`](../interfaces/Device.md)<[`LockProperties`](../interfaces/LockProperties.md), `any`\>[]\> |
181-
| `lockDoor` | (`deviceId`: `string`) => `Promise`<[`Workspace`](../interfaces/Workspace.md) \| [`Workspace`](../interfaces/Workspace.md)[] \| [`Device`](../interfaces/Device.md)<[`LockProperties`](../interfaces/LockProperties.md), `any`\> \| [`Device`](../interfaces/Device.md)<[`LockProperties`](../interfaces/LockProperties.md), `any`\>[] \| [`ActionAttempt`](../modules.md#actionattempt)<`any`\> \| [`AccessCode`](../interfaces/AccessCode.md) \| [`AccessCode`](../interfaces/AccessCode.md)[] \| [`Device`](../interfaces/Device.md)<`any`, `any`\> \| [`Device`](../interfaces/Device.md)<`any`, `any`\>[] \| [`ConnectWebview`](../interfaces/ConnectWebview.md) \| [`ConnectWebview`](../interfaces/ConnectWebview.md)[] \| [`ConnectedAccount`](../interfaces/ConnectedAccount.md) \| [`ConnectedAccount`](../interfaces/ConnectedAccount.md)[]\> |
182-
| `unlockDoor` | (`deviceId`: `string`) => `Promise`<[`Workspace`](../interfaces/Workspace.md) \| [`Workspace`](../interfaces/Workspace.md)[] \| [`Device`](../interfaces/Device.md)<[`LockProperties`](../interfaces/LockProperties.md), `any`\> \| [`Device`](../interfaces/Device.md)<[`LockProperties`](../interfaces/LockProperties.md), `any`\>[] \| [`ActionAttempt`](../modules.md#actionattempt)<`any`\> \| [`AccessCode`](../interfaces/AccessCode.md) \| [`AccessCode`](../interfaces/AccessCode.md)[] \| [`Device`](../interfaces/Device.md)<`any`, `any`\> \| [`Device`](../interfaces/Device.md)<`any`, `any`\>[] \| [`ConnectWebview`](../interfaces/ConnectWebview.md) \| [`ConnectWebview`](../interfaces/ConnectWebview.md)[] \| [`ConnectedAccount`](../interfaces/ConnectedAccount.md) \| [`ConnectedAccount`](../interfaces/ConnectedAccount.md)[]\> |
179+
| `get` | (`deviceId`: `string`) => `Promise`<[`LockDevice`](../modules.md#lockdevice)\> |
180+
| `list` | (`connectedAccountId?`: `string`) => `Promise`<[`LockDevice`](../modules.md#lockdevice)[]\> |
181+
| `lockDoor` | (`deviceId`: `string`) => `Promise`<`unknown`\> |
182+
| `unlockDoor` | (`deviceId`: `string`) => `Promise`<`unknown`\> |
183183

184184
#### Inherited from
185185

186186
Routes.locks
187187

188188
#### Defined in
189189

190-
[src/routes.ts:94](https://github.com/seamapi/seamapi-javascript/blob/main/src/routes.ts#L94)
190+
[src/routes.ts:110](https://github.com/seamapi/seamapi-javascript/blob/main/src/routes.ts#L110)
191191

192192
___
193193

@@ -199,17 +199,17 @@ ___
199199

200200
| Name | Type |
201201
| :------ | :------ |
202-
| `get` | () => `Promise`<[`Workspace`](../interfaces/Workspace.md)\> |
202+
| `get` | () => `Promise`<[`Workspace`](../interfaces/Workspace.md) & { `connect_partner_name`: `string` }\> |
203203
| `list` | () => `Promise`<[`Workspace`](../interfaces/Workspace.md)[]\> |
204-
| `resetSandbox` | () => `Promise`<{ `ok`: ``true`` }\> |
204+
| `resetSandbox` | () => `Promise`<[`SuccessfulAPIResponse`](../modules.md#successfulapiresponse)<[`WorkspaceResetSandboxResponse`](../interfaces/WorkspaceResetSandboxResponse.md)\>\> |
205205

206206
#### Inherited from
207207

208208
Routes.workspaces
209209

210210
#### Defined in
211211

212-
[src/routes.ts:78](https://github.com/seamapi/seamapi-javascript/blob/main/src/routes.ts#L78)
212+
[src/routes.ts:94](https://github.com/seamapi/seamapi-javascript/blob/main/src/routes.ts#L94)
213213

214214
## Methods
215215

docs/interfaces/AccessCode.md

Lines changed: 0 additions & 74 deletions
This file was deleted.

docs/interfaces/AccessCodeBase.md

Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
[seamapi](../README.md) / [Exports](../modules.md) / AccessCodeBase
2+
3+
# Interface: AccessCodeBase
4+
5+
## Hierarchy
6+
7+
- **`AccessCodeBase`**
8+
9+
[`OngoingAccessCode`](OngoingAccessCode.md)
10+
11+
[`TimeBoundAccessCode`](TimeBoundAccessCode.md)
12+
13+
## Table of contents
14+
15+
### Properties
16+
17+
- [access\_code\_id](AccessCodeBase.md#access_code_id)
18+
- [code](AccessCodeBase.md#code)
19+
- [name](AccessCodeBase.md#name)
20+
21+
## Properties
22+
23+
### access\_code\_id
24+
25+
**access\_code\_id**: `string`
26+
27+
#### Defined in
28+
29+
[src/types/models.ts:124](https://github.com/seamapi/seamapi-javascript/blob/main/src/types/models.ts#L124)
30+
31+
___
32+
33+
### code
34+
35+
**code**: `string`
36+
37+
#### Defined in
38+
39+
[src/types/models.ts:126](https://github.com/seamapi/seamapi-javascript/blob/main/src/types/models.ts#L126)
40+
41+
___
42+
43+
### name
44+
45+
`Optional` **name**: `string`
46+
47+
#### Defined in
48+
49+
[src/types/models.ts:125](https://github.com/seamapi/seamapi-javascript/blob/main/src/types/models.ts#L125)
Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
[seamapi](../README.md) / [Exports](../modules.md) / AccessCodeCreateBaseRequest
2+
3+
# Interface: AccessCodeCreateBaseRequest
4+
5+
## Hierarchy
6+
7+
- **`AccessCodeCreateBaseRequest`**
8+
9+
[`AccessCodeCreateScheduledRequest`](AccessCodeCreateScheduledRequest.md)
10+
11+
## Table of contents
12+
13+
### Properties
14+
15+
- [code](AccessCodeCreateBaseRequest.md#code)
16+
- [device\_id](AccessCodeCreateBaseRequest.md#device_id)
17+
- [name](AccessCodeCreateBaseRequest.md#name)
18+
19+
## Properties
20+
21+
### code
22+
23+
`Optional` **code**: `string`
24+
25+
#### Defined in
26+
27+
[src/types/route-requests.ts:10](https://github.com/seamapi/seamapi-javascript/blob/main/src/types/route-requests.ts#L10)
28+
29+
___
30+
31+
### device\_id
32+
33+
**device\_id**: `string`
34+
35+
#### Defined in
36+
37+
[src/types/route-requests.ts:8](https://github.com/seamapi/seamapi-javascript/blob/main/src/types/route-requests.ts#L8)
38+
39+
___
40+
41+
### name
42+
43+
`Optional` **name**: `string`
44+
45+
#### Defined in
46+
47+
[src/types/route-requests.ts:9](https://github.com/seamapi/seamapi-javascript/blob/main/src/types/route-requests.ts#L9)
Lines changed: 81 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,81 @@
1+
[seamapi](../README.md) / [Exports](../modules.md) / AccessCodeCreateScheduledRequest
2+
3+
# Interface: AccessCodeCreateScheduledRequest
4+
5+
## Hierarchy
6+
7+
- [`AccessCodeCreateBaseRequest`](AccessCodeCreateBaseRequest.md)
8+
9+
**`AccessCodeCreateScheduledRequest`**
10+
11+
## Table of contents
12+
13+
### Properties
14+
15+
- [code](AccessCodeCreateScheduledRequest.md#code)
16+
- [device\_id](AccessCodeCreateScheduledRequest.md#device_id)
17+
- [ends\_at](AccessCodeCreateScheduledRequest.md#ends_at)
18+
- [name](AccessCodeCreateScheduledRequest.md#name)
19+
- [starts\_at](AccessCodeCreateScheduledRequest.md#starts_at)
20+
21+
## Properties
22+
23+
### code
24+
25+
`Optional` **code**: `string`
26+
27+
#### Inherited from
28+
29+
[AccessCodeCreateBaseRequest](AccessCodeCreateBaseRequest.md).[code](AccessCodeCreateBaseRequest.md#code)
30+
31+
#### Defined in
32+
33+
[src/types/route-requests.ts:10](https://github.com/seamapi/seamapi-javascript/blob/main/src/types/route-requests.ts#L10)
34+
35+
___
36+
37+
### device\_id
38+
39+
**device\_id**: `string`
40+
41+
#### Inherited from
42+
43+
[AccessCodeCreateBaseRequest](AccessCodeCreateBaseRequest.md).[device_id](AccessCodeCreateBaseRequest.md#device_id)
44+
45+
#### Defined in
46+
47+
[src/types/route-requests.ts:8](https://github.com/seamapi/seamapi-javascript/blob/main/src/types/route-requests.ts#L8)
48+
49+
___
50+
51+
### ends\_at
52+
53+
**ends\_at**: `string` \| `Date`
54+
55+
#### Defined in
56+
57+
[src/types/route-requests.ts:18](https://github.com/seamapi/seamapi-javascript/blob/main/src/types/route-requests.ts#L18)
58+
59+
___
60+
61+
### name
62+
63+
`Optional` **name**: `string`
64+
65+
#### Inherited from
66+
67+
[AccessCodeCreateBaseRequest](AccessCodeCreateBaseRequest.md).[name](AccessCodeCreateBaseRequest.md#name)
68+
69+
#### Defined in
70+
71+
[src/types/route-requests.ts:9](https://github.com/seamapi/seamapi-javascript/blob/main/src/types/route-requests.ts#L9)
72+
73+
___
74+
75+
### starts\_at
76+
77+
**starts\_at**: `string` \| `Date`
78+
79+
#### Defined in
80+
81+
[src/types/route-requests.ts:17](https://github.com/seamapi/seamapi-javascript/blob/main/src/types/route-requests.ts#L17)

docs/interfaces/AccessCodesListResponse.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,8 +12,8 @@
1212

1313
### access\_codes
1414

15-
**access\_codes**: [`AccessCode`](AccessCode.md)[]
15+
**access\_codes**: [`AccessCode`](../modules.md#accesscode)[]
1616

1717
#### Defined in
1818

19-
[src/types/route-responses.ts:59](https://github.com/seamapi/seamapi-javascript/blob/main/src/types/route-responses.ts#L59)
19+
[src/types/route-responses.ts:57](https://github.com/seamapi/seamapi-javascript/blob/main/src/types/route-responses.ts#L57)

0 commit comments

Comments
 (0)