Skip to content

Commit f1a25cd

Browse files
committed
Release 0.10.6
1 parent 9c29413 commit f1a25cd

File tree

607 files changed

+17009
-919
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

607 files changed

+17009
-919
lines changed

README.md

Lines changed: 8 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -13,19 +13,18 @@ npm i -s scoutos
1313

1414
## Reference
1515

16-
A full reference for this library is available [here](./reference.md).
16+
A full reference for this library is available [here](https://github.com/scoutos/scoutos-typescript-sdk/blob/HEAD/./reference.md).
1717

1818
## Usage
1919

2020
Instantiate and use the client with the following:
2121

2222
```typescript
2323
import { ScoutClient } from "scoutos";
24+
import * as fs from "fs";
2425

2526
const client = new ScoutClient({ apiKey: "YOUR_API_KEY" });
26-
await client.workflows.createRevision({
27-
body: {},
28-
});
27+
await client.parseFileV2FilesParsePost(fs.createReadStream("/path/to/your/file"), {});
2928
```
3029

3130
## Request And Response Types
@@ -50,7 +49,7 @@ will be thrown.
5049
import { ScoutError } from "scoutos";
5150

5251
try {
53-
await client.workflows.createRevision(...);
52+
await client.parseFileV2FilesParsePost(...);
5453
} catch (err) {
5554
if (err instanceof ScoutError) {
5655
console.log(err.statusCode);
@@ -67,7 +66,7 @@ try {
6766
If you would like to send additional headers as part of the request, use the `headers` request option.
6867

6968
```typescript
70-
const response = await client.workflows.createRevision(..., {
69+
const response = await client.parseFileV2FilesParsePost(..., {
7170
headers: {
7271
'X-Custom-Header': 'custom value'
7372
}
@@ -89,7 +88,7 @@ A request is deemed retryable when any of the following HTTP status codes is ret
8988
Use the `maxRetries` request option to configure this behavior.
9089

9190
```typescript
92-
const response = await client.workflows.createRevision(..., {
91+
const response = await client.parseFileV2FilesParsePost(..., {
9392
maxRetries: 0 // override maxRetries at the request level
9493
});
9594
```
@@ -99,7 +98,7 @@ const response = await client.workflows.createRevision(..., {
9998
The SDK defaults to a 60 second timeout. Use the `timeoutInSeconds` option to configure this behavior.
10099

101100
```typescript
102-
const response = await client.workflows.createRevision(..., {
101+
const response = await client.parseFileV2FilesParsePost(..., {
103102
timeoutInSeconds: 30 // override timeout to 30s
104103
});
105104
```
@@ -110,7 +109,7 @@ The SDK allows users to abort requests at any point by passing in an abort signa
110109

111110
```typescript
112111
const controller = new AbortController();
113-
const response = await client.workflows.createRevision(..., {
112+
const response = await client.parseFileV2FilesParsePost(..., {
114113
abortSignal: controller.signal
115114
});
116115
controller.abort(); // aborts the request

package.json

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "scoutos",
3-
"version": "0.10.5",
3+
"version": "0.10.6",
44
"private": false,
55
"repository": "https://github.com/scoutos/scoutos-typescript-sdk",
66
"main": "./index.js",
@@ -18,7 +18,8 @@
1818
"node-fetch": "^2.7.0",
1919
"qs": "^6.13.1",
2020
"readable-stream": "^4.5.2",
21-
"js-base64": "3.7.7"
21+
"js-base64": "3.7.7",
22+
"form-data-encoder": "^4.0.2"
2223
},
2324
"devDependencies": {
2425
"@types/url-join": "4.0.1",

0 commit comments

Comments
 (0)