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

Commit 5f21147

Browse files
authored
feat: Merge pull request #72 from seamapi/implement-access-codes-get
fix #61: Implement `access_codes.get`
2 parents 42c1201 + e455127 commit 5f21147

22 files changed

+214
-51
lines changed

docs/classes/Seam.md

Lines changed: 10 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -63,6 +63,7 @@ Routes.constructor
6363
| :------ | :------ |
6464
| `create` | (`params`: [`AccessCodeCreateOngoingRequest`](../interfaces/AccessCodeCreateOngoingRequest.md)) => `Promise`<[`OngoingAccessCode`](../interfaces/OngoingAccessCode.md)\>(`params`: [`AccessCodeCreateScheduledRequest`](../interfaces/AccessCodeCreateScheduledRequest.md)) => `Promise`<[`TimeBoundAccessCode`](../interfaces/TimeBoundAccessCode.md)\> |
6565
| `delete` | (`params`: [`AccessCodeDeleteRequest`](../modules.md#accesscodedeleterequest)) => `Promise`<`unknown`\> |
66+
| `get` | (`params`: [`AccessCodeGetRequest`](../modules.md#accesscodegetrequest)) => `Promise`<[`AccessCode`](../modules.md#accesscode)\> |
6667
| `list` | (`params`: { `device_id`: `string` }) => `Promise`<[`AccessCode`](../modules.md#accesscode)[]\> |
6768
| `update` | (`params`: [`AccessCodeUpdateRequest`](../modules.md#accesscodeupdaterequest)) => `Promise`<[`OngoingAccessCode`](../interfaces/OngoingAccessCode.md) \| [`TimeBoundAccessCode`](../interfaces/TimeBoundAccessCode.md)\> |
6869

@@ -72,7 +73,7 @@ Routes.accessCodes
7273

7374
#### Defined in
7475

75-
[src/routes.ts:219](https://github.com/seamapi/javascript/blob/main/src/routes.ts#L219)
76+
[src/routes.ts:221](https://github.com/seamapi/javascript/blob/main/src/routes.ts#L221)
7677

7778
___
7879

@@ -92,7 +93,7 @@ Routes.actionAttempts
9293

9394
#### Defined in
9495

95-
[src/routes.ts:283](https://github.com/seamapi/javascript/blob/main/src/routes.ts#L283)
96+
[src/routes.ts:289](https://github.com/seamapi/javascript/blob/main/src/routes.ts#L289)
9697

9798
___
9899

@@ -124,7 +125,7 @@ Routes.connectWebviews
124125

125126
#### Defined in
126127

127-
[src/routes.ts:193](https://github.com/seamapi/javascript/blob/main/src/routes.ts#L193)
128+
[src/routes.ts:195](https://github.com/seamapi/javascript/blob/main/src/routes.ts#L195)
128129

129130
___
130131

@@ -145,7 +146,7 @@ Routes.connectedAccounts
145146

146147
#### Defined in
147148

148-
[src/routes.ts:262](https://github.com/seamapi/javascript/blob/main/src/routes.ts#L262)
149+
[src/routes.ts:268](https://github.com/seamapi/javascript/blob/main/src/routes.ts#L268)
149150

150151
___
151152

@@ -168,7 +169,7 @@ Routes.devices
168169

169170
#### Defined in
170171

171-
[src/routes.ts:156](https://github.com/seamapi/javascript/blob/main/src/routes.ts#L156)
172+
[src/routes.ts:158](https://github.com/seamapi/javascript/blob/main/src/routes.ts#L158)
172173

173174
___
174175

@@ -188,7 +189,7 @@ Routes.events
188189

189190
#### Defined in
190191

191-
[src/routes.ts:181](https://github.com/seamapi/javascript/blob/main/src/routes.ts#L181)
192+
[src/routes.ts:183](https://github.com/seamapi/javascript/blob/main/src/routes.ts#L183)
192193

193194
___
194195

@@ -211,7 +212,7 @@ Routes.locks
211212

212213
#### Defined in
213214

214-
[src/routes.ts:121](https://github.com/seamapi/javascript/blob/main/src/routes.ts#L121)
215+
[src/routes.ts:123](https://github.com/seamapi/javascript/blob/main/src/routes.ts#L123)
215216

216217
___
217218

@@ -234,7 +235,7 @@ Routes.webhooks
234235

235236
#### Defined in
236237

237-
[src/routes.ts:293](https://github.com/seamapi/javascript/blob/main/src/routes.ts#L293)
238+
[src/routes.ts:299](https://github.com/seamapi/javascript/blob/main/src/routes.ts#L299)
238239

239240
___
240241

@@ -256,7 +257,7 @@ Routes.workspaces
256257

257258
#### Defined in
258259

259-
[src/routes.ts:105](https://github.com/seamapi/javascript/blob/main/src/routes.ts#L105)
260+
[src/routes.ts:107](https://github.com/seamapi/javascript/blob/main/src/routes.ts#L107)
260261

261262
## Methods
262263

docs/interfaces/AccessCodeBase.md

Lines changed: 13 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,7 @@
1616

1717
- [access\_code\_id](AccessCodeBase.md#access_code_id)
1818
- [code](AccessCodeBase.md#code)
19+
- [device\_id](AccessCodeBase.md#device_id)
1920
- [name](AccessCodeBase.md#name)
2021

2122
## Properties
@@ -36,7 +37,17 @@ ___
3637

3738
#### Defined in
3839

39-
[src/types/models.ts:140](https://github.com/seamapi/javascript/blob/main/src/types/models.ts#L140)
40+
[src/types/models.ts:141](https://github.com/seamapi/javascript/blob/main/src/types/models.ts#L141)
41+
42+
___
43+
44+
### device\_id
45+
46+
`Optional` **device\_id**: `string`
47+
48+
#### Defined in
49+
50+
[src/types/models.ts:139](https://github.com/seamapi/javascript/blob/main/src/types/models.ts#L139)
4051

4152
___
4253

@@ -46,4 +57,4 @@ ___
4657

4758
#### Defined in
4859

49-
[src/types/models.ts:139](https://github.com/seamapi/javascript/blob/main/src/types/models.ts#L139)
60+
[src/types/models.ts:140](https://github.com/seamapi/javascript/blob/main/src/types/models.ts#L140)
Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
[seamapi](../README.md) / [Exports](../modules.md) / AccessCodeGetResponse
2+
3+
# Interface: AccessCodeGetResponse
4+
5+
## Table of contents
6+
7+
### Properties
8+
9+
- [access\_code](AccessCodeGetResponse.md#access_code)
10+
11+
## Properties
12+
13+
### access\_code
14+
15+
**access\_code**: [`AccessCode`](../modules.md#accesscode)
16+
17+
#### Defined in
18+
19+
[src/types/route-responses.ts:63](https://github.com/seamapi/javascript/blob/main/src/types/route-responses.ts#L63)

docs/interfaces/ActionAttemptCreateResponse.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,4 +22,4 @@
2222

2323
#### Defined in
2424

25-
[src/types/route-responses.ts:85](https://github.com/seamapi/javascript/blob/main/src/types/route-responses.ts#L85)
25+
[src/types/route-responses.ts:88](https://github.com/seamapi/javascript/blob/main/src/types/route-responses.ts#L88)

docs/interfaces/ActionAttemptGetResponse.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,4 +22,4 @@
2222

2323
#### Defined in
2424

25-
[src/types/route-responses.ts:89](https://github.com/seamapi/javascript/blob/main/src/types/route-responses.ts#L89)
25+
[src/types/route-responses.ts:92](https://github.com/seamapi/javascript/blob/main/src/types/route-responses.ts#L92)

docs/interfaces/ConnectedAccount.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@
1919

2020
#### Defined in
2121

22-
[src/types/models.ts:163](https://github.com/seamapi/javascript/blob/main/src/types/models.ts#L163)
22+
[src/types/models.ts:164](https://github.com/seamapi/javascript/blob/main/src/types/models.ts#L164)
2323

2424
___
2525

@@ -29,7 +29,7 @@ ___
2929

3030
#### Defined in
3131

32-
[src/types/models.ts:160](https://github.com/seamapi/javascript/blob/main/src/types/models.ts#L160)
32+
[src/types/models.ts:161](https://github.com/seamapi/javascript/blob/main/src/types/models.ts#L161)
3333

3434
___
3535

@@ -39,7 +39,7 @@ ___
3939

4040
#### Defined in
4141

42-
[src/types/models.ts:161](https://github.com/seamapi/javascript/blob/main/src/types/models.ts#L161)
42+
[src/types/models.ts:162](https://github.com/seamapi/javascript/blob/main/src/types/models.ts#L162)
4343

4444
___
4545

@@ -49,4 +49,4 @@ ___
4949

5050
#### Defined in
5151

52-
[src/types/models.ts:162](https://github.com/seamapi/javascript/blob/main/src/types/models.ts#L162)
52+
[src/types/models.ts:163](https://github.com/seamapi/javascript/blob/main/src/types/models.ts#L163)

docs/interfaces/ConnectedAccountsGetResponse.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,4 +16,4 @@
1616

1717
#### Defined in
1818

19-
[src/types/route-responses.ts:68](https://github.com/seamapi/javascript/blob/main/src/types/route-responses.ts#L68)
19+
[src/types/route-responses.ts:71](https://github.com/seamapi/javascript/blob/main/src/types/route-responses.ts#L71)

docs/interfaces/ConnectedAccountsListResponse.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,4 +16,4 @@
1616

1717
#### Defined in
1818

19-
[src/types/route-responses.ts:65](https://github.com/seamapi/javascript/blob/main/src/types/route-responses.ts#L65)
19+
[src/types/route-responses.ts:68](https://github.com/seamapi/javascript/blob/main/src/types/route-responses.ts#L68)

docs/interfaces/EventsListRequest.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@
2020

2121
#### Defined in
2222

23-
[src/types/route-requests.ts:87](https://github.com/seamapi/javascript/blob/main/src/types/route-requests.ts#L87)
23+
[src/types/route-requests.ts:93](https://github.com/seamapi/javascript/blob/main/src/types/route-requests.ts#L93)
2424

2525
___
2626

@@ -30,7 +30,7 @@ ___
3030

3131
#### Defined in
3232

33-
[src/types/route-requests.ts:86](https://github.com/seamapi/javascript/blob/main/src/types/route-requests.ts#L86)
33+
[src/types/route-requests.ts:92](https://github.com/seamapi/javascript/blob/main/src/types/route-requests.ts#L92)
3434

3535
___
3636

@@ -40,7 +40,7 @@ ___
4040

4141
#### Defined in
4242

43-
[src/types/route-requests.ts:89](https://github.com/seamapi/javascript/blob/main/src/types/route-requests.ts#L89)
43+
[src/types/route-requests.ts:95](https://github.com/seamapi/javascript/blob/main/src/types/route-requests.ts#L95)
4444

4545
___
4646

@@ -50,7 +50,7 @@ ___
5050

5151
#### Defined in
5252

53-
[src/types/route-requests.ts:88](https://github.com/seamapi/javascript/blob/main/src/types/route-requests.ts#L88)
53+
[src/types/route-requests.ts:94](https://github.com/seamapi/javascript/blob/main/src/types/route-requests.ts#L94)
5454

5555
___
5656

@@ -60,4 +60,4 @@ ___
6060

6161
#### Defined in
6262

63-
[src/types/route-requests.ts:85](https://github.com/seamapi/javascript/blob/main/src/types/route-requests.ts#L85)
63+
[src/types/route-requests.ts:91](https://github.com/seamapi/javascript/blob/main/src/types/route-requests.ts#L91)

docs/interfaces/EventsListResponse.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,4 +16,4 @@
1616

1717
#### Defined in
1818

19-
[src/types/route-responses.ts:94](https://github.com/seamapi/javascript/blob/main/src/types/route-responses.ts#L94)
19+
[src/types/route-responses.ts:97](https://github.com/seamapi/javascript/blob/main/src/types/route-responses.ts#L97)

docs/interfaces/OngoingAccessCode.md

Lines changed: 20 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,7 @@
1515
- [access\_code\_id](OngoingAccessCode.md#access_code_id)
1616
- [code](OngoingAccessCode.md#code)
1717
- [created\_at](OngoingAccessCode.md#created_at)
18+
- [device\_id](OngoingAccessCode.md#device_id)
1819
- [name](OngoingAccessCode.md#name)
1920
- [status](OngoingAccessCode.md#status)
2021
- [type](OngoingAccessCode.md#type)
@@ -45,7 +46,7 @@ ___
4546

4647
#### Defined in
4748

48-
[src/types/models.ts:140](https://github.com/seamapi/javascript/blob/main/src/types/models.ts#L140)
49+
[src/types/models.ts:141](https://github.com/seamapi/javascript/blob/main/src/types/models.ts#L141)
4950

5051
___
5152

@@ -55,7 +56,21 @@ ___
5556

5657
#### Defined in
5758

58-
[src/types/models.ts:145](https://github.com/seamapi/javascript/blob/main/src/types/models.ts#L145)
59+
[src/types/models.ts:146](https://github.com/seamapi/javascript/blob/main/src/types/models.ts#L146)
60+
61+
___
62+
63+
### device\_id
64+
65+
`Optional` **device\_id**: `string`
66+
67+
#### Inherited from
68+
69+
[AccessCodeBase](AccessCodeBase.md).[device_id](AccessCodeBase.md#device_id)
70+
71+
#### Defined in
72+
73+
[src/types/models.ts:139](https://github.com/seamapi/javascript/blob/main/src/types/models.ts#L139)
5974

6075
___
6176

@@ -69,7 +84,7 @@ ___
6984

7085
#### Defined in
7186

72-
[src/types/models.ts:139](https://github.com/seamapi/javascript/blob/main/src/types/models.ts#L139)
87+
[src/types/models.ts:140](https://github.com/seamapi/javascript/blob/main/src/types/models.ts#L140)
7388

7489
___
7590

@@ -79,7 +94,7 @@ ___
7994

8095
#### Defined in
8196

82-
[src/types/models.ts:146](https://github.com/seamapi/javascript/blob/main/src/types/models.ts#L146)
97+
[src/types/models.ts:147](https://github.com/seamapi/javascript/blob/main/src/types/models.ts#L147)
8398

8499
___
85100

@@ -89,4 +104,4 @@ ___
89104

90105
#### Defined in
91106

92-
[src/types/models.ts:144](https://github.com/seamapi/javascript/blob/main/src/types/models.ts#L144)
107+
[src/types/models.ts:145](https://github.com/seamapi/javascript/blob/main/src/types/models.ts#L145)

docs/interfaces/TimeBoundAccessCode.md

Lines changed: 22 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,7 @@
1515
- [access\_code\_id](TimeBoundAccessCode.md#access_code_id)
1616
- [code](TimeBoundAccessCode.md#code)
1717
- [created\_at](TimeBoundAccessCode.md#created_at)
18+
- [device\_id](TimeBoundAccessCode.md#device_id)
1819
- [ends\_at](TimeBoundAccessCode.md#ends_at)
1920
- [name](TimeBoundAccessCode.md#name)
2021
- [starts\_at](TimeBoundAccessCode.md#starts_at)
@@ -47,7 +48,7 @@ ___
4748

4849
#### Defined in
4950

50-
[src/types/models.ts:140](https://github.com/seamapi/javascript/blob/main/src/types/models.ts#L140)
51+
[src/types/models.ts:141](https://github.com/seamapi/javascript/blob/main/src/types/models.ts#L141)
5152

5253
___
5354

@@ -57,7 +58,21 @@ ___
5758

5859
#### Defined in
5960

60-
[src/types/models.ts:151](https://github.com/seamapi/javascript/blob/main/src/types/models.ts#L151)
61+
[src/types/models.ts:152](https://github.com/seamapi/javascript/blob/main/src/types/models.ts#L152)
62+
63+
___
64+
65+
### device\_id
66+
67+
`Optional` **device\_id**: `string`
68+
69+
#### Inherited from
70+
71+
[AccessCodeBase](AccessCodeBase.md).[device_id](AccessCodeBase.md#device_id)
72+
73+
#### Defined in
74+
75+
[src/types/models.ts:139](https://github.com/seamapi/javascript/blob/main/src/types/models.ts#L139)
6176

6277
___
6378

@@ -67,7 +82,7 @@ ___
6782

6883
#### Defined in
6984

70-
[src/types/models.ts:154](https://github.com/seamapi/javascript/blob/main/src/types/models.ts#L154)
85+
[src/types/models.ts:155](https://github.com/seamapi/javascript/blob/main/src/types/models.ts#L155)
7186

7287
___
7388

@@ -81,7 +96,7 @@ ___
8196

8297
#### Defined in
8398

84-
[src/types/models.ts:139](https://github.com/seamapi/javascript/blob/main/src/types/models.ts#L139)
99+
[src/types/models.ts:140](https://github.com/seamapi/javascript/blob/main/src/types/models.ts#L140)
85100

86101
___
87102

@@ -91,7 +106,7 @@ ___
91106

92107
#### Defined in
93108

94-
[src/types/models.ts:153](https://github.com/seamapi/javascript/blob/main/src/types/models.ts#L153)
109+
[src/types/models.ts:154](https://github.com/seamapi/javascript/blob/main/src/types/models.ts#L154)
95110

96111
___
97112

@@ -101,7 +116,7 @@ ___
101116

102117
#### Defined in
103118

104-
[src/types/models.ts:152](https://github.com/seamapi/javascript/blob/main/src/types/models.ts#L152)
119+
[src/types/models.ts:153](https://github.com/seamapi/javascript/blob/main/src/types/models.ts#L153)
105120

106121
___
107122

@@ -111,4 +126,4 @@ ___
111126

112127
#### Defined in
113128

114-
[src/types/models.ts:150](https://github.com/seamapi/javascript/blob/main/src/types/models.ts#L150)
129+
[src/types/models.ts:151](https://github.com/seamapi/javascript/blob/main/src/types/models.ts#L151)

0 commit comments

Comments
 (0)