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

Commit 492f262

Browse files
chore(release): 4.18.2 [skip ci]
## [4.18.2](seamapi/javascript@v4.18.1...v4.18.2) (2022-12-07) ### Bug Fixes * Bump release for types file ([c4e94bc](seamapi/javascript@c4e94bc)) * remove /api from types ([b10868c](seamapi/javascript@b10868c)) * use bot token for release workflow ([37cdc89](seamapi/javascript@37cdc89))
1 parent 37cdc89 commit 492f262

File tree

4 files changed

+280
-170
lines changed

4 files changed

+280
-170
lines changed

docs/classes/SeamOS.md

Lines changed: 28 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -59,10 +59,10 @@
5959
| Name | Type |
6060
| :------ | :------ |
6161
| `create` | (`data`: `undefined` \| { `code?`: `string` ; `device_id`: `string` ; `ends_at?`: `string` \| `Date` ; `name?`: `string` ; `starts_at?`: `string` \| `Date` }) => `Promise`<{ `access_code_id`: `string` ; `code`: `string` ; `created_at`: `string` \| `Date` ; `type`: ``"ongoing"`` } \| { `access_code_id`: `string` ; `code`: `string` ; `created_at`: `string` \| `Date` ; `ends_at`: `string` \| `Date` ; `starts_at`: `string` \| `Date` ; `type`: ``"time_bound"`` }\> |
62-
| `delete` | (`data`: `undefined` \| { `access_code_id`: `string` }) => `Promise`<{ `ok`: `boolean` }\> |
62+
| `delete` | (`data`: `undefined` \| { `access_code_id`: `string` }) => `Promise`<{}\> |
6363
| `get` | (`data`: `undefined` \| { `access_code_id`: `string` }) => `Promise`<{ `access_code_id`: `string` ; `code`: `string` ; `created_at`: `string` \| `Date` ; `type`: ``"ongoing"`` } \| { `access_code_id`: `string` ; `code`: `string` ; `created_at`: `string` \| `Date` ; `ends_at`: `string` \| `Date` ; `starts_at`: `string` \| `Date` ; `type`: ``"time_bound"`` }\> |
6464
| `list` | (`data`: `undefined` \| { `building_id?`: `string` ; `device_group_id?`: `string` ; `device_id?`: `string` ; `user_id?`: `string` }) => `Promise`<({ `access_code_id`: `string` ; `code`: `string` ; `created_at`: `string` \| `Date` ; `type`: ``"ongoing"`` } \| { `access_code_id`: `string` ; `code`: `string` ; `created_at`: `string` \| `Date` ; `ends_at`: `string` \| `Date` ; `starts_at`: `string` \| `Date` ; `type`: ``"time_bound"`` })[]\> |
65-
| `update` | (`data`: `undefined` \| { `access_code_id`: `string` ; `code?`: `string` ; `device_id?`: `string` ; `ends_at?`: `string` \| `Date` ; `name?`: `string` ; `starts_at?`: `string` \| `Date` }) => `Promise`<{ `ok`: `boolean` }\> |
65+
| `update` | (`data`: `undefined` \| { `access_code_id`: `string` ; `code?`: `string` ; `device_id?`: `string` ; `ends_at?`: `string` \| `Date` ; `name?`: `string` ; `starts_at?`: `string` \| `Date` }) => `Promise`<{}\> |
6666

6767
#### Defined in
6868

@@ -79,10 +79,10 @@ ___
7979
| Name | Type |
8080
| :------ | :------ |
8181
| `create` | (`data`: `undefined` \| [`RouteRequestBody`](../modules/SeamOSRouteTypes.md#routerequestbody)<``"/access_passes/create"``\>) => `Promise`<{ `access_methods`: ({ `access_method`: ``"remote_unlock"`` ; `device_id`: `string` } \| { `access_method`: ``"access_code"`` ; `code`: `string` ; `device_id`: `string` })[] ; `access_pass_id`: `string` }\> |
82-
| `delete` | (`data`: `undefined` \| { `access_pass_id`: `string` }) => `Promise`<{ `ok`: `boolean` }\> |
82+
| `delete` | (`data`: `undefined` \| { `access_pass_id`: `string` }) => `Promise`<{}\> |
8383
| `get` | (`data`: `undefined` \| { `access_pass_id`: `string` }) => `Promise`<{ `access_methods`: ({ `access_method`: ``"remote_unlock"`` ; `device_id`: `string` } \| { `access_method`: ``"access_code"`` ; `code`: `string` ; `device_id`: `string` })[] ; `access_pass_id`: `string` }\> |
8484
| `list` | (`data`: `undefined` \| { `building_id?`: `string` ; `user_id?`: `string` }) => `Promise`<{ `access_methods`: ({ `access_method`: ``"remote_unlock"`` ; `device_id`: `string` } \| { `access_method`: ``"access_code"`` ; `code`: `string` ; `device_id`: `string` })[] ; `access_pass_id`: `string` }[]\> |
85-
| `update` | (`data`: `undefined` \| { `device_group_id?`: `string` ; `device_id?`: `string`[] ; `device_ids?`: `string`[] ; `ends_at?`: `string` \| `Date` ; `name`: `string` ; `starts_at?`: `string` \| `Date` }) => `Promise`<{ `ok`: `boolean` }\> |
85+
| `update` | (`data`: `undefined` \| { `device_group_id?`: `string` ; `device_id?`: `string`[] ; `device_ids?`: `string`[] ; `ends_at?`: `string` \| `Date` ; `name`: `string` ; `starts_at?`: `string` \| `Date` }) => `Promise`<{}\> |
8686

8787
#### Defined in
8888

@@ -108,13 +108,13 @@ ___
108108

109109
| Name | Type |
110110
| :------ | :------ |
111-
| `add_device` | (`data`: `undefined` \| { `building_id`: `string` ; `device_id`: `string` }) => `Promise`<{ `ok`: `boolean` }\> |
112-
| `add_user` | (`data`: `undefined` \| [`RouteRequestBody`](../modules/SeamOSRouteTypes.md#routerequestbody)<``"/buildings/add_user"``\>) => `Promise`<{ `ok`: `boolean` }\> |
113-
| `create` | (`data`: `undefined` \| { `location?`: `any` ; `name`: `string` ; `owner_id`: `string` }) => `Promise`<{ `building_id`: `string` ; `created_at`: `string` \| `Date` ; `location?`: `any` ; `name`: `string` ; `organization_id`: `string` }\> |
114-
| `delete` | (`data`: `undefined` \| { `building_id`: `string` }) => `Promise`<{ `ok`: `boolean` }\> |
111+
| `add_device` | (`data`: `undefined` \| { `building_id`: `string` ; `device_id`: `string` }) => `Promise`<{}\> |
112+
| `add_user` | (`data`: `undefined` \| [`RouteRequestBody`](../modules/SeamOSRouteTypes.md#routerequestbody)<``"/buildings/add_user"``\>) => `Promise`<{}\> |
113+
| `create` | (`data`: `undefined` \| { `location?`: { [x: string]: `any`; } ; `name`: `string` ; `owner_id`: `string` }) => `Promise`<{ `building_id`: `string` ; `created_at`: `string` \| `Date` ; `location?`: `any` ; `name`: `string` ; `organization_id`: `string` }\> |
114+
| `delete` | (`data`: `undefined` \| { `building_id`: `string` }) => `Promise`<{}\> |
115115
| `get` | (`data`: `undefined` \| { `building_id`: `string` }) => `Promise`<{ `building_id`: `string` ; `created_at`: `string` \| `Date` ; `location?`: `any` ; `name`: `string` ; `organization_id`: `string` }\> |
116116
| `list` | (`data`: `undefined` \| {}) => `Promise`<{ `building_id`: `string` ; `created_at`: `string` \| `Date` ; `location?`: `any` ; `name`: `string` ; `organization_id`: `string` }[]\> |
117-
| `update` | (`data`: `undefined` \| { `building_id`: `string` ; `name?`: `string` ; `owner_id?`: `string` }) => `Promise`<{ `ok`: `boolean` }\> |
117+
| `update` | (`data`: `undefined` \| { `building_id`: `string` ; `name?`: `string` ; `owner_id?`: `string` }) => `Promise`<{}\> |
118118

119119
#### Defined in
120120

@@ -130,12 +130,12 @@ ___
130130

131131
| Name | Type |
132132
| :------ | :------ |
133-
| `add_device` | (`data`: `undefined` \| { `device_group_id`: `string` ; `device_id`: `string` }) => `Promise`<{ `ok`: `boolean` }\> |
133+
| `add_device` | (`data`: `undefined` \| { `device_group_id`: `string` ; `device_id`: `string` }) => `Promise`<{}\> |
134134
| `create` | (`data`: `undefined` \| { `name`: `string` }) => `Promise`<{ `created_at`: `string` \| `Date` ; `device_group_id`: `string` ; `name`: `string` ; `organization_id`: `string` }\> |
135-
| `delete` | (`data`: `undefined` \| { `device_group_id`: `string` }) => `Promise`<{ `ok`: `boolean` }\> |
135+
| `delete` | (`data`: `undefined` \| { `device_group_id`: `string` }) => `Promise`<{}\> |
136136
| `get` | (`data`: `undefined` \| { `device_group_id`: `string` }) => `Promise`<{ `created_at`: `string` \| `Date` ; `device_group_id`: `string` ; `name`: `string` ; `organization_id`: `string` }\> |
137137
| `list` | (`data`: `undefined` \| {}) => `Promise`<{ `created_at`: `string` \| `Date` ; `device_group_id`: `string` ; `name`: `string` ; `organization_id`: `string` }[]\> |
138-
| `update` | (`data`: `undefined` \| { `device_group_id`: `string` ; `name?`: `string` }) => `Promise`<{ `ok`: `boolean` }\> |
138+
| `update` | (`data`: `undefined` \| { `device_group_id`: `string` ; `name?`: `string` }) => `Promise`<{}\> |
139139

140140
#### Defined in
141141

@@ -151,10 +151,10 @@ ___
151151

152152
| Name | Type |
153153
| :------ | :------ |
154-
| `delete` | (`data`: `undefined` \| { `device_id`: `string` }) => `Promise`<{ `ok`: `boolean` }\> |
155-
| `get` | (`data`: `undefined` \| [`RouteRequestBody`](../modules/SeamOSRouteTypes.md#routerequestbody)<``"/devices/get"``\>) => `Promise`<{ `connected_account_id`: `string` ; `created_at`: `string` \| `Date` ; `device_id`: `string` ; `device_type`: `string` ; `name`: `string` }\> |
156-
| `list` | (`data`: `undefined` \| { `building_id?`: `string` ; `has_no_building?`: `boolean` ; `user_group_id?`: `string` ; `user_id?`: `string` }) => `Promise`<{ `connected_account_id`: `string` ; `created_at`: `string` \| `Date` ; `device_id`: `string` ; `device_type`: `string` ; `name`: `string` }[]\> |
157-
| `update` | (`data`: `undefined` \| { `device_id`: `string` ; `location?`: {} ; `name?`: `string` }) => `Promise`<{ `ok`: `boolean` }\> |
154+
| `delete` | (`data`: `undefined` \| { `device_id`: `string` }) => `Promise`<{}\> |
155+
| `get` | (`data`: `undefined` \| { `building_id?`: `string` ; `device_id?`: `string` ; `device_name?`: `string` }) => `Promise`<{ `building_id`: ``null`` \| `string` ; `created_at`: `string` \| `Date` ; `device_id`: `string` ; `device_type`: `string` ; `errors`: `unknown`[] ; `linked_account_id`: `string` ; `name`: `string` ; `properties`: { [x: string]: `unknown`; } }\> |
156+
| `list` | (`data`: `undefined` \| { `building_id?`: `string` ; `has_no_building?`: `boolean` ; `user_group_id?`: `string` ; `user_id?`: `string` }) => `Promise`<{ `building_id`: ``null`` \| `string` ; `created_at`: `string` \| `Date` ; `device_id`: `string` ; `device_type`: `string` ; `errors`: `unknown`[] ; `linked_account_id`: `string` ; `name`: `string` ; `properties`: { [x: string]: `unknown`; } }[]\> |
157+
| `update` | (`data`: `undefined` \| { `device_id`: `string` ; `location?`: {} ; `name?`: `string` }) => `Promise`<{}\> |
158158

159159
#### Defined in
160160

@@ -170,9 +170,9 @@ ___
170170

171171
| Name | Type |
172172
| :------ | :------ |
173-
| `create` | (`data`: `undefined` \| { `accepted_providers?`: `string`[] ; `custom_redirect_url?`: `string` ; `device_selection_mode?`: ``"none"`` \| ``"single"`` \| ``"multiple"`` }) => `Promise`<{ `connected_account_id`: ``null`` \| `string` ; `connected_webview_id`: `string` ; `created_at`: `string` \| `Date` ; `organization_id`: `string` }\> |
174-
| `delete` | (`data`: `undefined` \| { `login_portal_id`: `string` }) => `Promise`<{ `ok`: `boolean` }\> |
175-
| `get` | (`data`: `undefined` \| { `login_portal_id`: `string` }) => `Promise`<{ `connected_account_id`: ``null`` \| `string` ; `connected_webview_id`: `string` ; `created_at`: `string` \| `Date` ; `organization_id`: `string` }\> |
173+
| `create` | (`data`: `undefined` \| { `accepted_providers?`: `string`[] ; `custom_redirect_url?`: `string` ; `device_selection_mode?`: ``"none"`` \| ``"single"`` \| ``"multiple"`` }) => `Promise`<{ `created_at`: `string` \| `Date` ; `login_portal_id`: `string` ; `organization_id`: `string` ; `view_url`: `string` }\> |
174+
| `delete` | (`data`: `undefined` \| { `login_portal_id`: `string` }) => `Promise`<{}\> |
175+
| `get` | (`data`: `undefined` \| { `login_portal_id`: `string` }) => `Promise`<{ `created_at`: `string` \| `Date` ; `login_portal_id`: `string` ; `organization_id`: `string` ; `view_url`: `string` }\> |
176176

177177
#### Defined in
178178

@@ -189,10 +189,10 @@ ___
189189
| Name | Type |
190190
| :------ | :------ |
191191
| `create` | (`data`: `undefined` \| { `name`: `string` }) => `Promise`<{ `created_at`: `string` \| `Date` ; `name`: `string` ; `organization_id`: `string` }\> |
192-
| `get` | () => (`data`: `undefined` \| {}) => `Promise`<{ `created_at`: `string` \| `Date` ; `name`: `string` ; `organization_id`: `string` }\> |
193-
| `invite_user` | (`data`: `undefined` \| { `email`: `string` }) => `Promise`<{ `ok`: `boolean` }\> |
194-
| `remove_user` | (`data`: `undefined` \| { `user_id`: `string` }) => `Promise`<{ `ok`: `boolean` }\> |
195-
| `update` | (`data`: `undefined` \| { `name?`: `string` }) => `Promise`<{ `ok`: `boolean` }\> |
192+
| `get` | () => (`data`: `undefined` \| { `organization_id`: `string` }) => `Promise`<{ `created_at`: `string` \| `Date` ; `name`: `string` ; `organization_id`: `string` }\> |
193+
| `invite_user` | (`data`: `undefined` \| { `email`: `string` }) => `Promise`<{}\> |
194+
| `remove_user` | (`data`: `undefined` \| { `user_id`: `string` }) => `Promise`<{}\> |
195+
| `update` | (`data`: `undefined` \| { `name?`: `string` }) => `Promise`<{}\> |
196196

197197
#### Defined in
198198

@@ -209,10 +209,10 @@ ___
209209
| Name | Type |
210210
| :------ | :------ |
211211
| `create` | (`data`: `undefined` \| { `name`: `string` }) => `Promise`<{ `created_at`: `string` \| `Date` ; `name`: `string` ; `organization_id`: `string` ; `user_group_id`: `string` }\> |
212-
| `delete` | (`data`: `undefined` \| { `user_group_id`: `string` }) => `Promise`<{ `ok`: `boolean` }\> |
212+
| `delete` | (`data`: `undefined` \| { `user_group_id`: `string` }) => `Promise`<{}\> |
213213
| `get` | (`data`: `undefined` \| { `user_group_id`: `string` }) => `Promise`<{ `created_at`: `string` \| `Date` ; `name`: `string` ; `organization_id`: `string` ; `user_group_id`: `string` }\> |
214214
| `list` | (`data`: `undefined` \| {}) => `Promise`<{ `created_at`: `string` \| `Date` ; `name`: `string` ; `organization_id`: `string` ; `user_group_id`: `string` }[]\> |
215-
| `update` | (`data`: `undefined` \| { `name?`: `string` ; `user_group_id`: `string` }) => `Promise`<{ `ok`: `boolean` }\> |
215+
| `update` | (`data`: `undefined` \| { `name?`: `string` ; `user_group_id`: `string` }) => `Promise`<{}\> |
216216

217217
#### Defined in
218218

@@ -228,10 +228,10 @@ ___
228228

229229
| Name | Type |
230230
| :------ | :------ |
231-
| `delete` | (`data`: `undefined` \| { `user_id`: `string` }) => `Promise`<{ `ok`: `boolean` }\> |
231+
| `delete` | (`data`: `undefined` \| { `user_id`: `string` }) => `Promise`<{}\> |
232232
| `get` | (`data`: `undefined` \| { `user_id`: `string` }) => `Promise`<{ `created_at`: `string` \| `Date` ; `organization_id`: `string` ; `user_id`: `string` }\> |
233233
| `list` | (`data`: `undefined` \| { `building_id?`: `string` ; `user_group_id?`: `string` }) => `Promise`<{ `created_at`: `string` \| `Date` ; `organization_id`: `string` ; `user_id`: `string` }[]\> |
234-
| `update` | (`data`: `undefined` \| { `first_name?`: `string` ; `last_name?`: `string` ; `title?`: `string` ; `user_id?`: `string` }) => `Promise`<{ `ok`: `boolean` }\> |
234+
| `update` | (`data`: `undefined` \| { `first_name?`: `string` ; `last_name?`: `string` ; `title?`: `string` ; `user_id?`: `string` }) => `Promise`<{}\> |
235235

236236
#### Defined in
237237

@@ -457,7 +457,7 @@ ___
457457
| Name | Type |
458458
| :------ | :------ |
459459
| `URL` | extends keyof [`Routes`](../interfaces/SeamOSRouteTypes.Routes.md) |
460-
| `Method` | extends ``"GET"`` \| ``"POST"`` \| ``"DELETE"`` \| ``"PATCH"`` |
460+
| `Method` | extends ``"GET"`` \| ``"DELETE"`` \| ``"POST"`` \| ``"PATCH"`` |
461461

462462
#### Parameters
463463

0 commit comments

Comments
 (0)