Skip to content

Commit 3eb17e8

Browse files
Merge pull request #4 from Scan-Documents/release-please--branches--main--changes--next--components--scan-documents
release: 0.1.0-alpha.4
2 parents ae1690f + a4bef09 commit 3eb17e8

9 files changed

Lines changed: 42 additions & 9 deletions

File tree

.release-please-manifest.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
11
{
2-
".": "0.1.0-alpha.3"
2+
".": "0.1.0-alpha.4"
33
}

.stats.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
configured_endpoints: 17
2-
openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/scan-documents%2Fscan-documents-04f736d0a9ae5151fec360201288ee49dc02cc4f60adf1ff17c5e3a0bbb639b4.yml
3-
openapi_spec_hash: e9d1be2b0eae296e605a9a79af48ab63
2+
openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/scan-documents%2Fscan-documents-41af66c2f2ba90b745f6c36d89d31281f16d916521b98a8f510ec3a8f90a1efb.yml
3+
openapi_spec_hash: 0c629cd46c640a055b0cfa5d88aad337
44
config_hash: ee078a284af580362c78b746a0c811c2

CHANGELOG.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,18 @@
11
# Changelog
22

3+
## 0.1.0-alpha.4 (2025-05-21)
4+
5+
Full Changelog: [v0.1.0-alpha.3...v0.1.0-alpha.4](https://github.com/Scan-Documents/node-sdk/compare/v0.1.0-alpha.3...v0.1.0-alpha.4)
6+
7+
### Features
8+
9+
* **api:** update via SDK Studio ([825db67](https://github.com/Scan-Documents/node-sdk/commit/825db6702da4376ec6ae5977469a0e572b053957))
10+
11+
12+
### Documentation
13+
14+
* readme changes ([d33adb0](https://github.com/Scan-Documents/node-sdk/commit/d33adb0d480cea87d13f65a66ce987d32a040fad))
15+
316
## 0.1.0-alpha.3 (2025-05-21)
417

518
Full Changelog: [v0.1.0-alpha.2...v0.1.0-alpha.3](https://github.com/Scan-Documents/node-sdk/compare/v0.1.0-alpha.2...v0.1.0-alpha.3)

README.md

Lines changed: 21 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
This library provides convenient access to the Scan Documents REST API from server-side TypeScript or JavaScript.
66

7-
The REST API documentation can be found on [scan-documents.com](https://scan-documents.com/docs). The full API of this library can be found in [api.md](api.md).
7+
The REST API documentation can be found on [Scan Documents](https://scan-documents.com/docs). The full API of this library can be found in [api.md](api.md).
88

99
It is generated with [Stainless](https://www.stainless.com/).
1010

@@ -87,6 +87,26 @@ await client.files.upload({ file: await toFile(Buffer.from('my bytes'), 'file'),
8787
await client.files.upload({ file: await toFile(new Uint8Array([0, 1, 2]), 'file'), name: 'File Name' });
8888
```
8989

90+
91+
## Task operations
92+
93+
Operations can be found under the `imageOperations` and `pdfOperations` resources.
94+
95+
```ts
96+
import ScanDocuments from 'scan-documents';
97+
98+
const client = new ScanDocuments({
99+
apiKey: process.env['SCAN_DOCUMENTS_API_KEY'], // This is the default and can be omitted
100+
});
101+
102+
const applyEffectResponse = await client.imageOperations.applyEffect({
103+
effect: 'grayscale',
104+
input: 'file_avyrvozb9302uwhq',
105+
});
106+
107+
console.log(applyEffectResponse);
108+
```
109+
90110
## Handling errors
91111

92112
When the library is unable to connect to the API,

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "scan-documents",
3-
"version": "0.1.0-alpha.3",
3+
"version": "0.1.0-alpha.4",
44
"description": "The official TypeScript library for the Scan Documents API",
55
"author": "Scan Documents <support@scan-documents.com>",
66
"types": "dist/index.d.ts",

packages/mcp-server/package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "scan-documents-mcp",
3-
"version": "0.1.0-alpha.3",
3+
"version": "0.1.0-alpha.4",
44
"description": "The official MCP Server for the Scan Documents API",
55
"author": "Scan Documents <support@scan-documents.com>",
66
"types": "dist/index.d.ts",

packages/mcp-server/src/server.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ export { endpoints } from './tools';
1919
export const server = new McpServer(
2020
{
2121
name: 'scan_documents_api',
22-
version: '0.1.0-alpha.3',
22+
version: '0.1.0-alpha.4',
2323
},
2424
{
2525
capabilities: {

src/resources/files.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -65,7 +65,7 @@ export class Files extends APIResource {
6565
download(id: string, options?: RequestOptions): APIPromise<Response> {
6666
return this._client.get(path`/v1/files/${id}/download`, {
6767
...options,
68-
headers: buildHeaders([{ Accept: 'image/*' }, options?.headers]),
68+
headers: buildHeaders([{ Accept: 'image/png' }, options?.headers]),
6969
__binaryResponse: true,
7070
});
7171
}

src/version.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
export const VERSION = '0.1.0-alpha.3'; // x-release-please-version
1+
export const VERSION = '0.1.0-alpha.4'; // x-release-please-version

0 commit comments

Comments
 (0)