From 7a6405f20610a901d541c184a616906faa481a47 Mon Sep 17 00:00:00 2001 From: andrii-balitskyi <10balian10@gmail.com> Date: Thu, 22 Dec 2022 16:39:12 +0100 Subject: [PATCH] Fixes #100 --- docs/classes/Seam.md | 18 ++++---- docs/interfaces/AccessCodeCreateResponse.md | 46 +++++++++++++++++++ docs/interfaces/AccessCodeGetResponse.md | 6 +++ .../interfaces/ActionAttemptCreateResponse.md | 2 +- docs/interfaces/ActionAttemptGetResponse.md | 8 +++- .../ConnectedAccountsGetResponse.md | 2 +- .../ConnectedAccountsListResponse.md | 2 +- docs/interfaces/EventsListResponse.md | 2 +- docs/interfaces/WebhookGetResponse.md | 2 +- docs/interfaces/WebhookListResponse.md | 2 +- docs/modules.md | 1 + src/seam-connect/routes.ts | 17 +++---- src/types/route-responses.ts | 3 ++ 13 files changed, 85 insertions(+), 26 deletions(-) create mode 100644 docs/interfaces/AccessCodeCreateResponse.md diff --git a/docs/classes/Seam.md b/docs/classes/Seam.md index a6633963..486ce3d0 100644 --- a/docs/classes/Seam.md +++ b/docs/classes/Seam.md @@ -73,7 +73,7 @@ Routes.accessCodes #### Defined in -[src/seam-connect/routes.ts:235](https://github.com/seamapi/javascript/blob/main/src/seam-connect/routes.ts#L235) +[src/seam-connect/routes.ts:236](https://github.com/seamapi/javascript/blob/main/src/seam-connect/routes.ts#L236) ___ @@ -93,7 +93,7 @@ Routes.actionAttempts #### Defined in -[src/seam-connect/routes.ts:307](https://github.com/seamapi/javascript/blob/main/src/seam-connect/routes.ts#L307) +[src/seam-connect/routes.ts:304](https://github.com/seamapi/javascript/blob/main/src/seam-connect/routes.ts#L304) ___ @@ -126,7 +126,7 @@ Routes.connectWebviews #### Defined in -[src/seam-connect/routes.ts:203](https://github.com/seamapi/javascript/blob/main/src/seam-connect/routes.ts#L203) +[src/seam-connect/routes.ts:204](https://github.com/seamapi/javascript/blob/main/src/seam-connect/routes.ts#L204) ___ @@ -148,7 +148,7 @@ Routes.connectedAccounts #### Defined in -[src/seam-connect/routes.ts:282](https://github.com/seamapi/javascript/blob/main/src/seam-connect/routes.ts#L282) +[src/seam-connect/routes.ts:279](https://github.com/seamapi/javascript/blob/main/src/seam-connect/routes.ts#L279) ___ @@ -171,7 +171,7 @@ Routes.devices #### Defined in -[src/seam-connect/routes.ts:166](https://github.com/seamapi/javascript/blob/main/src/seam-connect/routes.ts#L166) +[src/seam-connect/routes.ts:167](https://github.com/seamapi/javascript/blob/main/src/seam-connect/routes.ts#L167) ___ @@ -191,7 +191,7 @@ Routes.events #### Defined in -[src/seam-connect/routes.ts:191](https://github.com/seamapi/javascript/blob/main/src/seam-connect/routes.ts#L191) +[src/seam-connect/routes.ts:192](https://github.com/seamapi/javascript/blob/main/src/seam-connect/routes.ts#L192) ___ @@ -214,7 +214,7 @@ Routes.locks #### Defined in -[src/seam-connect/routes.ts:131](https://github.com/seamapi/javascript/blob/main/src/seam-connect/routes.ts#L131) +[src/seam-connect/routes.ts:132](https://github.com/seamapi/javascript/blob/main/src/seam-connect/routes.ts#L132) ___ @@ -237,7 +237,7 @@ Routes.webhooks #### Defined in -[src/seam-connect/routes.ts:317](https://github.com/seamapi/javascript/blob/main/src/seam-connect/routes.ts#L317) +[src/seam-connect/routes.ts:314](https://github.com/seamapi/javascript/blob/main/src/seam-connect/routes.ts#L314) ___ @@ -259,7 +259,7 @@ Routes.workspaces #### Defined in -[src/seam-connect/routes.ts:115](https://github.com/seamapi/javascript/blob/main/src/seam-connect/routes.ts#L115) +[src/seam-connect/routes.ts:116](https://github.com/seamapi/javascript/blob/main/src/seam-connect/routes.ts#L116) ## Methods diff --git a/docs/interfaces/AccessCodeCreateResponse.md b/docs/interfaces/AccessCodeCreateResponse.md new file mode 100644 index 00000000..76d3c70d --- /dev/null +++ b/docs/interfaces/AccessCodeCreateResponse.md @@ -0,0 +1,46 @@ +[seamapi](../README.md) / [Exports](../modules.md) / AccessCodeCreateResponse + +# Interface: AccessCodeCreateResponse + +## Hierarchy + +- [`AccessCodeGetResponse`](AccessCodeGetResponse.md) + +- [`ActionAttemptGetResponse`](ActionAttemptGetResponse.md) + + ↳ **`AccessCodeCreateResponse`** + +## Table of contents + +### Properties + +- [access\_code](AccessCodeCreateResponse.md#access_code) +- [action\_attempt](AccessCodeCreateResponse.md#action_attempt) + +## Properties + +### access\_code + +• **access\_code**: [`AccessCode`](../modules.md#accesscode) + +#### Inherited from + +[AccessCodeGetResponse](AccessCodeGetResponse.md).[access_code](AccessCodeGetResponse.md#access_code) + +#### Defined in + +[src/types/route-responses.ts:64](https://github.com/seamapi/javascript/blob/main/src/types/route-responses.ts#L64) + +___ + +### action\_attempt + +• **action\_attempt**: [`ActionAttempt`](../modules.md#actionattempt)<[`ActionType`](../modules.md#actiontype)\> + +#### Inherited from + +[ActionAttemptGetResponse](ActionAttemptGetResponse.md).[action_attempt](ActionAttemptGetResponse.md#action_attempt) + +#### Defined in + +[src/types/route-responses.ts:96](https://github.com/seamapi/javascript/blob/main/src/types/route-responses.ts#L96) diff --git a/docs/interfaces/AccessCodeGetResponse.md b/docs/interfaces/AccessCodeGetResponse.md index 3e91aea5..c8c4d37c 100644 --- a/docs/interfaces/AccessCodeGetResponse.md +++ b/docs/interfaces/AccessCodeGetResponse.md @@ -2,6 +2,12 @@ # Interface: AccessCodeGetResponse +## Hierarchy + +- **`AccessCodeGetResponse`** + + ↳ [`AccessCodeCreateResponse`](AccessCodeCreateResponse.md) + ## Table of contents ### Properties diff --git a/docs/interfaces/ActionAttemptCreateResponse.md b/docs/interfaces/ActionAttemptCreateResponse.md index 860d3893..6492a067 100644 --- a/docs/interfaces/ActionAttemptCreateResponse.md +++ b/docs/interfaces/ActionAttemptCreateResponse.md @@ -22,4 +22,4 @@ #### Defined in -[src/types/route-responses.ts:89](https://github.com/seamapi/javascript/blob/main/src/types/route-responses.ts#L89) +[src/types/route-responses.ts:92](https://github.com/seamapi/javascript/blob/main/src/types/route-responses.ts#L92) diff --git a/docs/interfaces/ActionAttemptGetResponse.md b/docs/interfaces/ActionAttemptGetResponse.md index 00028f40..aad5c7bc 100644 --- a/docs/interfaces/ActionAttemptGetResponse.md +++ b/docs/interfaces/ActionAttemptGetResponse.md @@ -8,6 +8,12 @@ | :------ | :------ | | `T` | extends [`ActionType`](../modules.md#actiontype) = [`ActionType`](../modules.md#actiontype) | +## Hierarchy + +- **`ActionAttemptGetResponse`** + + ↳ [`AccessCodeCreateResponse`](AccessCodeCreateResponse.md) + ## Table of contents ### Properties @@ -22,4 +28,4 @@ #### Defined in -[src/types/route-responses.ts:93](https://github.com/seamapi/javascript/blob/main/src/types/route-responses.ts#L93) +[src/types/route-responses.ts:96](https://github.com/seamapi/javascript/blob/main/src/types/route-responses.ts#L96) diff --git a/docs/interfaces/ConnectedAccountsGetResponse.md b/docs/interfaces/ConnectedAccountsGetResponse.md index fc5be7ec..081c6560 100644 --- a/docs/interfaces/ConnectedAccountsGetResponse.md +++ b/docs/interfaces/ConnectedAccountsGetResponse.md @@ -16,4 +16,4 @@ #### Defined in -[src/types/route-responses.ts:72](https://github.com/seamapi/javascript/blob/main/src/types/route-responses.ts#L72) +[src/types/route-responses.ts:75](https://github.com/seamapi/javascript/blob/main/src/types/route-responses.ts#L75) diff --git a/docs/interfaces/ConnectedAccountsListResponse.md b/docs/interfaces/ConnectedAccountsListResponse.md index b2b88a09..0e10a16f 100644 --- a/docs/interfaces/ConnectedAccountsListResponse.md +++ b/docs/interfaces/ConnectedAccountsListResponse.md @@ -16,4 +16,4 @@ #### Defined in -[src/types/route-responses.ts:69](https://github.com/seamapi/javascript/blob/main/src/types/route-responses.ts#L69) +[src/types/route-responses.ts:72](https://github.com/seamapi/javascript/blob/main/src/types/route-responses.ts#L72) diff --git a/docs/interfaces/EventsListResponse.md b/docs/interfaces/EventsListResponse.md index f8e8b9f6..d4e5a68b 100644 --- a/docs/interfaces/EventsListResponse.md +++ b/docs/interfaces/EventsListResponse.md @@ -16,4 +16,4 @@ #### Defined in -[src/types/route-responses.ts:98](https://github.com/seamapi/javascript/blob/main/src/types/route-responses.ts#L98) +[src/types/route-responses.ts:101](https://github.com/seamapi/javascript/blob/main/src/types/route-responses.ts#L101) diff --git a/docs/interfaces/WebhookGetResponse.md b/docs/interfaces/WebhookGetResponse.md index 775ff5ec..02356be8 100644 --- a/docs/interfaces/WebhookGetResponse.md +++ b/docs/interfaces/WebhookGetResponse.md @@ -16,4 +16,4 @@ #### Defined in -[src/types/route-responses.ts:81](https://github.com/seamapi/javascript/blob/main/src/types/route-responses.ts#L81) +[src/types/route-responses.ts:84](https://github.com/seamapi/javascript/blob/main/src/types/route-responses.ts#L84) diff --git a/docs/interfaces/WebhookListResponse.md b/docs/interfaces/WebhookListResponse.md index 0a491bbf..6706a51d 100644 --- a/docs/interfaces/WebhookListResponse.md +++ b/docs/interfaces/WebhookListResponse.md @@ -16,4 +16,4 @@ #### Defined in -[src/types/route-responses.ts:77](https://github.com/seamapi/javascript/blob/main/src/types/route-responses.ts#L77) +[src/types/route-responses.ts:80](https://github.com/seamapi/javascript/blob/main/src/types/route-responses.ts#L80) diff --git a/docs/modules.md b/docs/modules.md index 24cf89b9..c40c1d03 100644 --- a/docs/modules.md +++ b/docs/modules.md @@ -31,6 +31,7 @@ - [AccessCodeBase](interfaces/AccessCodeBase.md) - [AccessCodeCreateBaseRequest](interfaces/AccessCodeCreateBaseRequest.md) - [AccessCodeCreateOngoingRequest](interfaces/AccessCodeCreateOngoingRequest.md) +- [AccessCodeCreateResponse](interfaces/AccessCodeCreateResponse.md) - [AccessCodeCreateScheduledRequest](interfaces/AccessCodeCreateScheduledRequest.md) - [AccessCodeGetResponse](interfaces/AccessCodeGetResponse.md) - [AccessCodeUpdateBaseRequest](interfaces/AccessCodeUpdateBaseRequest.md) diff --git a/src/seam-connect/routes.ts b/src/seam-connect/routes.ts index af3f9b2e..48436887 100644 --- a/src/seam-connect/routes.ts +++ b/src/seam-connect/routes.ts @@ -49,6 +49,7 @@ import { WebhookListResponse, WebhookGetResponse, EventsListResponse, + AccessCodeCreateResponse, } from "../types/route-responses" export abstract class Routes { @@ -243,16 +244,12 @@ export abstract class Routes { url: "/access_codes/get", params, }), - create: (async (params: AccessCodeCreateRequest) => { - const action = - await this.createActionAttemptAndWait<"CREATE_ACCESS_CODE">({ - url: "/access_codes/create", - method: "POST", - data: params, - }) - - return action.access_code - }) as { + create: (async (params: AccessCodeCreateRequest) => + this.makeRequestAndFormat("access_code", { + url: "/access_codes/create", + method: "POST", + data: params, + })) as { (params: AccessCodeCreateOngoingRequest): Promise (params: AccessCodeCreateScheduledRequest): Promise }, diff --git a/src/types/route-responses.ts b/src/types/route-responses.ts index 23adfe7a..b93ef1ee 100644 --- a/src/types/route-responses.ts +++ b/src/types/route-responses.ts @@ -63,6 +63,9 @@ export interface AccessCodesListResponse { export interface AccessCodeGetResponse { access_code: AccessCode } +export interface AccessCodeCreateResponse + extends AccessCodeGetResponse, + ActionAttemptGetResponse {} // Connected Accounts export interface ConnectedAccountsListResponse {