Skip to content

feat(deps): bump the seam group across 1 directory with 2 updates #270

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open
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
27 changes: 27 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -58,6 +58,8 @@ Instead, it re-exports from a core set of Seam modules:
- [Configuring the Axios Client](#configuring-the-axios-client)
- [Using the Axios Client](#using-the-axios-client)
- [Overriding the Client](#overriding-the-client)
- [Alternative endpoint path interface](#alternative-endpoint-path-interface)
- [Enable undocumented API](#enable-undocumented-api)
- [Inspecting the Request](#inspecting-the-request)
- [Receiving Webhooks](#receiving-webhooks)
- [Development and Testing](#development-and-testing)
Expand Down Expand Up @@ -523,6 +525,31 @@ const devices = await seam.client.get<DevicesListResponse>('/devices/list')
An Axios compatible client may be provided to create a `Seam` instance.
This API is used internally and is not directly supported.

#### Alternative endpoint path interface

The `SeamEndpoints` class offers an alternative path-based interface to every API endpoint.
Each endpoint is exposed as simple property that returns the corresponding method from `Seam`.

```ts
import { SeamEndpoints } from 'seam'

const seam = new SeamEndpoints()
const devices = await seam['/devices/list']()
```

#### Enable undocumented API

Pass the `isUndocumentedApiEnabled` option to allow using the undocumented API.
This API is used internally and is not directly supported.
Do not use the undocumented API in production environments.
Seam is not responsible for any issues you may encounter with the undocumented API.

```ts
import { Seam } from 'seam'

const seam = new Seam({ isUndocumentedApiEnabled: true })
```

#### Inspecting the Request

All client methods return an instance of `SeamHttpRequest`.
Expand Down
18 changes: 9 additions & 9 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 2 additions & 2 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -65,8 +65,8 @@
"npm": ">= 9.0.0"
},
"dependencies": {
"@seamapi/http": "1.35.1",
"@seamapi/types": "1.420.2",
"@seamapi/http": "1.37.0",
"@seamapi/types": "1.423.4",
"@seamapi/webhook": "1.1.1",
"zod": "^3.21.4"
},
Expand Down
Loading