Skip to content

Commit 7d3e148

Browse files
speakeasybotspeakeasybot
committed
ci: regenerated with OpenAPI Doc 0.0.1, Speakeay CLI 1.91.1
1 parent 925bd40 commit 7d3e148

File tree

12 files changed

+112
-22
lines changed

12 files changed

+112
-22
lines changed

‎README.md‎

Lines changed: 71 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -22,13 +22,13 @@ This is a Typescript client for the [Unstructured API](https://unstructured-io.g
2222
### NPM
2323

2424
```bash
25-
npm add https://github.com/Unstructured-IO/unstructured-js-client
25+
npm add unstructured-client
2626
```
2727

2828
### Yarn
2929

3030
```bash
31-
yarn add https://github.com/Unstructured-IO/unstructured-js-client
31+
yarn add unstructured-client
3232
```
3333
<!-- End SDK Installation -->
3434

@@ -76,6 +76,75 @@ sdk.general.partition({
7676

7777
<!-- End Dev Containers -->
7878

79+
80+
81+
## SDK Example Usage
82+
<!-- Start SDK Example Usage -->
83+
84+
85+
```typescript
86+
import { UnstructuredClient } from "unstructured-client";
87+
import { PartitionResponse } from "unstructured-client/dist/sdk/models/operations";
88+
89+
const sdk = new UnstructuredClient({
90+
security: {
91+
apiKeyAuth: "YOUR_API_KEY",
92+
},
93+
});
94+
95+
sdk.general.partition({
96+
coordinates: false,
97+
encoding: "utf-8",
98+
files: {
99+
content: "distinctio".encode(),
100+
files: "quibusdam",
101+
},
102+
gzUncompressedContentType: "application/pdf",
103+
hiResModelName: "yolox",
104+
includePageBreaks: false,
105+
ocrLanguages: [
106+
"eng",
107+
],
108+
outputFormat: "application/json",
109+
pdfInferTableStructure: false,
110+
skipInferTableTypes: [
111+
"pdf",
112+
],
113+
strategy: "hi_res",
114+
xmlKeepTags: false,
115+
}).then((res: PartitionResponse) => {
116+
if (res.statusCode == 200) {
117+
// handle response
118+
}
119+
});
120+
```
121+
<!-- End SDK Example Usage -->
122+
123+
124+
125+
<!-- Start SDK Available Operations -->
126+
## Available Resources and Operations
127+
128+
129+
### [general](docs/sdks/general/README.md)
130+
131+
* [partition](docs/sdks/general/README.md#partition) - Pipeline 1
132+
<!-- End SDK Available Operations -->
133+
134+
135+
136+
<!-- Start Pagination -->
137+
# Pagination
138+
139+
Some of the endpoints in this SDK support pagination. To use pagination, you make your SDK calls as usual, but the
140+
returned response object will have a `next` method that can be called to pull down the next group of results. If the
141+
return value of `next` is `null`, then there are no more pages to be fetched.
142+
143+
Here's an example of one such pagination call:
144+
145+
146+
<!-- End Pagination -->
147+
79148
<!-- Placeholder for Future Speakeasy SDK Sections -->
80149

81150
### Maturity

‎RELEASES.md‎

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,4 +22,14 @@ Based on:
2222
- OpenAPI Doc 0.0.1
2323
- Speakeasy CLI 1.90.0 (2.125.1) https://github.com/speakeasy-api/speakeasy
2424
### Generated
25-
- [typescript v0.1.2] .
25+
- [typescript v0.1.2] .
26+
27+
## 2023-09-26 21:38:49
28+
### Changes
29+
Based on:
30+
- OpenAPI Doc 0.0.1
31+
- Speakeasy CLI 1.91.1 (2.130.1) https://github.com/speakeasy-api/speakeasy
32+
### Generated
33+
- [typescript v0.2.0] .
34+
### Releases
35+
- [NPM v0.2.0] https://www.npmjs.com/package/unstructured-client/v/0.2.0 - .

‎USAGE.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,10 @@
22

33

44
```typescript
5-
import { Unstructured } from "unstructured-client";
5+
import { UnstructuredClient } from "unstructured-client";
66
import { PartitionResponse } from "unstructured-client/dist/sdk/models/operations";
77

8-
const sdk = new Unstructured({
8+
const sdk = new UnstructuredClient({
99
security: {
1010
apiKeyAuth: "YOUR_API_KEY",
1111
},

‎docs/models/operations/partitionresponse.md‎

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

66
| Field | Type | Required | Description |
77
| ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- |
8-
| `contentType` | *string* | :heavy_check_mark: | N/A |
8+
| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation |
99
| `elements` | *any*[] | :heavy_minus_sign: | Successful Response |
10-
| `statusCode` | *number* | :heavy_check_mark: | N/A |
11-
| `rawResponse` | [AxiosResponse](https://axios-http.com/docs/res_schema) | :heavy_minus_sign: | N/A |
10+
| `statusCode` | *number* | :heavy_check_mark: | HTTP response status code for this operation |
11+
| `rawResponse` | [AxiosResponse](https://axios-http.com/docs/res_schema) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing |

‎docs/sdks/general/README.md‎

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
# General
2+
(*general*)
23

34
### Available Operations
45

@@ -11,10 +12,10 @@ Pipeline 1
1112
### Example Usage
1213

1314
```typescript
14-
import { Unstructured } from "unstructured-client";
15+
import { UnstructuredClient } from "unstructured-client";
1516
import { PartitionResponse } from "unstructured-client/dist/sdk/models/operations";
1617

17-
const sdk = new Unstructured({
18+
const sdk = new UnstructuredClient({
1819
security: {
1920
apiKeyAuth: "YOUR_API_KEY",
2021
},

‎docs/sdks/unstructured/README.md‎ renamed to ‎docs/sdks/unstructuredclient/README.md‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
1-
# Unstructured SDK
1+
# UnstructuredClient SDK
2+
23

34
## Overview
45

‎files.gen‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ docs/models/errors/validationerror.md
3434
docs/models/shared/partitionparametersfiles.md
3535
docs/models/shared/partitionparameters.md
3636
docs/models/shared/security.md
37-
docs/sdks/unstructured/README.md
37+
docs/sdks/unstructuredclient/README.md
3838
docs/models/utils/retryconfig.md
3939
docs/sdks/general/README.md
4040
.gitattributes

‎gen.yaml‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,8 @@ configVersion: 1.0.0
22
management:
33
docChecksum: f332d5b484fbeb4689b0c548694f5a69
44
docVersion: 0.0.1
5-
speakeasyVersion: 1.90.0
6-
generationVersion: 2.125.1
5+
speakeasyVersion: 1.91.1
6+
generationVersion: 2.130.1
77
generation:
88
comments:
99
disableComments: false
@@ -14,7 +14,7 @@ generation:
1414
tagNamespacingDisabled: false
1515
features:
1616
typescript:
17-
core: 2.87.5
17+
core: 2.88.1
1818
examples: 2.81.2
1919
globalSecurity: 2.81.1
2020
globalServerURLs: 2.82.0
@@ -23,7 +23,7 @@ features:
2323
retries: 2.82.0
2424
serverIDs: 2.81.1
2525
typescript:
26-
version: 0.1.2
26+
version: 0.2.0
2727
author: Unstructured
2828
clientServerStatusCodesAsErrors: true
2929
maxMethodParams: 0

‎package-lock.json‎

Lines changed: 2 additions & 2 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎package.json‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "unstructured-client",
3-
"version": "0.1.2",
3+
"version": "0.2.0",
44
"author": "Unstructured",
55
"scripts": {
66
"prepare": "tsc --build"

0 commit comments

Comments
 (0)