Skip to content

Commit e33d8a7

Browse files
github-actions[bot]speakeasybot
github-actions[bot]
and
speakeasybot
authored
chore: 🐝 Update SDK - Generate 0.19.0 (#136)
> [!IMPORTANT] > Linting report available at: <https://app.speakeasy.com/org/unstructured/unstructured5xr/linting-report/824b9f90ba7196da07c221cb7f0d71e6> > OpenAPI Change report available at: <https://app.speakeasy.com/org/unstructured/unstructured5xr/changes-report/b702fa86d0b84d9997084bd5d9b34d74> # SDK update Based on: - OpenAPI Doc - Speakeasy CLI 1.468.6 (2.493.13) https://github.com/speakeasy-api/speakeasy ## Versioning Version Bump Type: [minor] - 🤖 (automated) ## OpenAPI Change Summary ``` ├─┬Info │ └──[🔀] version (5:16) ├─┬Paths │ └─┬/general/v0/general │ └─┬POST │ └─┬Responses │ └─┬200 │ ├──[➕] content (76:27) │ └─┬application/json │ └─┬Schema │ └─┬Extensions │ └──[➕] x-speakeasy-name-override (73:48) └─┬Components ├──[➕] schemas (526:22) └─┬partition_parameters ├──[➕] properties (337:11) ├─┬strategy │ └──[➕] enum (326:15) └─┬unique_element_ids └──[🔀] title (352:22) ``` | Document Element | Total Changes | Breaking Changes | |------------------|---------------|------------------| | components | 4 | 0 | | info | 1 | 0 | | paths | 2 | 0 | ## TYPESCRIPT CHANGELOG ## sdkHooks: 0.2.0 - 2024-11-02 ### 🐝 New Features - allow hooks to trigger retries *(commit by [@disintegrator](https://github.com/disintegrator))* ## envVarSecurityUsage: 0.1.2 - 2024-11-04 ### 🐛 Bug Fixes - speakeasy examples override default strings *(commit by [@ryan-timothy-albert](https://github.com/ryan-timothy-albert))* ## examples: 2.81.5 - 2025-01-08 ### 🐛 Bug Fixes - prevent map examples from retaining obsolete key-value pairs *(commit by [@2ynn](https://github.com/2ynn))* ## acceptHeaders: 2.81.2 - 2024-04-30 ### 🐛 Bug Fixes - compute accept types from success responses *(commit by [@disintegrator](https://github.com/disintegrator))* ## globalSecurity: 2.82.12 - 2024-12-23 ### 🐛 Bug Fixes - remove default basic auth username / password *(commit by [@disintegrator](https://github.com/disintegrator))* ## core: 3.18.14 - 2025-01-13 ### 🐛 Bug Fixes - skip null and undefined parameter values during serialization *(commit by [@disintegrator](https://github.com/disintegrator))* ## core: 3.18.13 - 2025-01-13 ### 🐛 Bug Fixes - avoid setting `Content-Type: */*` request header for relevant operations *(commit by [@disintegrator](https://github.com/disintegrator))* ## core: 3.18.12 - 2024-12-19 ### 🔧 Chores - bump typescript transpilation target to ES2020 *(commit by [@mfbx9da4](https://github.com/mfbx9da4))* ## core: 3.18.11 - 2024-12-16 ### 🐛 Bug Fixes - flattening with hidden parameters *(commit by [@mfbx9da4](https://github.com/mfbx9da4))* ## core: 3.18.10 - 2024-12-13 ### 🐛 Bug Fixes - Support OAS references under multipart/form-data file properties *(commit by [@bflad](https://github.com/bflad))* ## core: 3.18.9 - 2024-12-06 ### 🐛 Bug Fixes - support property names solely comprised of illegal characters *(commit by [@mfbx9da4](https://github.com/mfbx9da4))* ## core: 3.18.8 - 2024-11-28 ### 🐛 Bug Fixes - add arguments to variable name exclusion list to avoid shadowing errors *(commit by [@TristanSpeakEasy](https://github.com/tristanspeakeasy))* ## core: 3.18.7 - 2024-11-22 ### 🐛 Bug Fixes - handle circular references through unions correctly *(commit by [@disintegrator](https://github.com/disintegrator))* ## core: 3.18.6 - 2024-11-19 ### 🐛 Bug Fixes - detect import cycles between models living in different modules *(commit by [@disintegrator](https://github.com/disintegrator))* ## core: 3.18.5 - 2024-11-15 ### 🐛 Bug Fixes - handling of raw buffers when deserialzing into zod types *(commit by [@TristanSpeakEasy](https://github.com/tristanspeakeasy))* ## core: 3.18.4 - 2024-11-12 ### 🐛 Bug Fixes - sort media type objects by specificity *(commit by [@disintegrator](https://github.com/disintegrator))* ## core: 3.18.3 - 2024-10-31 ### 🐛 Bug Fixes - Prevent panic with invalid implicit discriminator mappings with propertyName within allOf object *(commit by [@bflad](https://github.com/bflad))* ## unions: 2.85.8 - 2024-11-05 ### 🐛 Bug Fixes - improved handling of complex allOf schemas that merge multiple types *(commit by [@TristanSpeakEasy](https://github.com/tristanspeakeasy))* Co-authored-by: speakeasybot <[email protected]>
1 parent a8c0297 commit e33d8a7

36 files changed

+907
-263
lines changed

‎.gitignore‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
/react-query
2+
/.speakeasy/reports
13
/__tests__
24
/funcs
35
/core.*

‎.npmignore‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,7 @@
11
**/*
2+
!/FUNCTIONS.md
3+
!/RUNTIMES.md
4+
!/REACT_QUERY.md
25
!/**/*.ts
36
!/**/*.js
47
!/**/*.map

‎.speakeasy/gen.lock‎

Lines changed: 18 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,45 +1,46 @@
11
lockVersion: 2.0.0
22
id: f42cb8e6-e2ce-4565-b975-5a9f38b94d5a
33
management:
4-
docChecksum: 0ecb1bbbef6c9805d6a3edcc0afd098a
5-
docVersion: 1.0.51
6-
speakeasyVersion: 1.422.1
7-
generationVersion: 2.438.15
8-
releaseVersion: 0.18.2
9-
configChecksum: ca25abf7161ef39bf7793f0e79caf68e
4+
docChecksum: 4717c00d28425bfad21b5c8706ed4ca7
5+
docVersion: 1.0.58
6+
speakeasyVersion: 1.468.6
7+
generationVersion: 2.493.13
8+
releaseVersion: 0.19.0
9+
configChecksum: 756522998ca4a24ef07ae29599125e94
1010
repoURL: https://github.com/Unstructured-IO/unstructured-js-client.git
1111
repoSubDirectory: .
1212
installationURL: https://github.com/Unstructured-IO/unstructured-js-client
1313
published: true
1414
features:
1515
typescript:
16+
acceptHeaders: 2.81.2
1617
additionalDependencies: 0.1.0
1718
constsAndDefaults: 0.1.11
18-
core: 3.18.2
19+
core: 3.18.14
1920
defaultEnabledRetries: 0.1.0
2021
enumUnions: 0.1.0
21-
envVarSecurityUsage: 0.1.1
22-
examples: 2.81.4
23-
globalSecurity: 2.82.11
22+
envVarSecurityUsage: 0.1.2
23+
examples: 2.81.5
24+
globalSecurity: 2.82.12
2425
globalSecurityCallbacks: 0.1.0
2526
globalServerURLs: 2.82.4
2627
nameOverrides: 2.81.2
2728
nullables: 0.1.0
2829
openEnums: 0.1.1
2930
responseFormat: 0.2.3
3031
retries: 2.83.0
31-
sdkHooks: 0.1.0
32+
sdkHooks: 0.2.0
3233
serverIDs: 2.81.2
33-
unions: 2.85.7
34+
unions: 2.85.8
3435
uploadStreams: 0.1.0
3536
generatedFiles:
3637
- .eslintrc.cjs
3738
- .gitattributes
3839
- .npmignore
39-
- CONTRIBUTING.md
4040
- FUNCTIONS.md
4141
- RUNTIMES.md
4242
- USAGE.md
43+
- docs/lib/utils/retryconfig.md
4344
- docs/sdk/models/errors/detail.md
4445
- docs/sdk/models/errors/httpvalidationerror.md
4546
- docs/sdk/models/errors/servererror.md
@@ -53,6 +54,8 @@ generatedFiles:
5354
- docs/sdk/models/shared/security.md
5455
- docs/sdk/models/shared/strategy.md
5556
- docs/sdk/models/shared/validationerror.md
57+
- docs/sdks/general/README.md
58+
- docs/sdks/unstructuredclient/README.md
5659
- jsr.json
5760
- package.json
5861
- src/core.ts
@@ -108,7 +111,9 @@ examples:
108111
responses:
109112
"200":
110113
application/json: [{"type": "Title", "element_id": "6aa0ff22f91bbe7e26e8e25ca8052acd", "text": "LayoutParser: A Unified Toolkit for Deep Learning Based Document Image Analysis", "metadata": {"languages": ["eng"], "page_number": 1, "filename": "layout-parser-paper.pdf", "filetype": "application/pdf"}}]
114+
text/csv: "<value>"
111115
"422":
112116
application/json: {"detail": []}
113117
5XX:
114118
application/json: {"detail": "An error occurred"}
119+
generatedTests: {}

‎.speakeasy/workflow.lock‎

Lines changed: 11 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,21 @@
1-
speakeasyVersion: 1.422.1
1+
speakeasyVersion: 1.468.6
22
sources:
33
my-source:
44
sourceNamespace: my-source
5-
sourceRevisionDigest: sha256:7904e30126e3e30e77b56f6d901513e7009cbdc1d433dd7f6baa7da71a31b79a
6-
sourceBlobDigest: sha256:4747157b44baaa540a909f6947d16b08b096845a816819d9b0d35d074561fb68
5+
sourceRevisionDigest: sha256:3ce862c538447f14371df47b3eb07ae3ac20d1dd7f127ecaafbdbda175e5f967
6+
sourceBlobDigest: sha256:5b768ce3d603f07d017095a42738571836d3d0698c1713bf9b184a6235cffdd2
77
tags:
88
- latest
9-
- main
9+
- speakeasy-sdk-regen-1731198560
10+
- 1.0.58
1011
targets:
1112
unstructed-typescript:
1213
source: my-source
1314
sourceNamespace: my-source
14-
sourceRevisionDigest: sha256:7904e30126e3e30e77b56f6d901513e7009cbdc1d433dd7f6baa7da71a31b79a
15-
sourceBlobDigest: sha256:4747157b44baaa540a909f6947d16b08b096845a816819d9b0d35d074561fb68
15+
sourceRevisionDigest: sha256:3ce862c538447f14371df47b3eb07ae3ac20d1dd7f127ecaafbdbda175e5f967
16+
sourceBlobDigest: sha256:5b768ce3d603f07d017095a42738571836d3d0698c1713bf9b184a6235cffdd2
17+
codeSamplesNamespace: my-source-typescript-code-samples
18+
codeSamplesRevisionDigest: sha256:36362ca76ec0ffe7ab5d84c904a5e4ecb16158194fedd282fa1c2bb0399b91fa
1619
workflow:
1720
workflowVersion: 1.0.0
1821
speakeasyVersion: latest
@@ -33,3 +36,5 @@ workflow:
3336
token: $NPM_TOKEN
3437
codeSamples:
3538
output: codeSamples.yaml
39+
registry:
40+
location: registry.speakeasyapi.dev/unstructured/unstructured5xr/my-source-typescript-code-samples

‎.speakeasy/workflow.yaml‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,3 +17,5 @@ targets:
1717
token: $NPM_TOKEN
1818
codeSamples:
1919
output: codeSamples.yaml
20+
registry:
21+
location: registry.speakeasyapi.dev/unstructured/unstructured5xr/my-source-typescript-code-samples

‎README.md‎

Lines changed: 10 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -268,19 +268,17 @@ client.general.partition({
268268
269269
<!-- Start Table of Contents [toc] -->
270270
## Table of Contents
271+
<!-- $toc-max-depth=2 -->
272+
* [SDK Installation](#sdk-installation)
273+
* [SDK Example Usage](#sdk-example-usage)
274+
* [Change the base URL](#change-the-base-url)
275+
* [Custom HTTP Client](#custom-http-client)
276+
* [Retries](#retries)
277+
* [Requirements](#requirements)
278+
* [Standalone functions](#standalone-functions)
279+
* [File uploads](#file-uploads)
280+
* [Debugging](#debugging)
271281
272-
* [SDK Installation](#sdk-installation)
273-
* [Requirements](#requirements)
274-
* [SDK Example Usage](#sdk-example-usage)
275-
* [Available Resources and Operations](#available-resources-and-operations)
276-
* [Standalone functions](#standalone-functions)
277-
* [File uploads](#file-uploads)
278-
* [Retries](#retries)
279-
* [Error Handling](#error-handling)
280-
* [Server Selection](#server-selection)
281-
* [Custom HTTP Client](#custom-http-client)
282-
* [Authentication](#authentication)
283-
* [Debugging](#debugging)
284282
<!-- End Table of Contents [toc] -->
285283
286284
<!-- Start Requirements [requirements] -->

‎RELEASES.md‎

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -504,4 +504,14 @@ Based on:
504504
### Generated
505505
- [typescript v0.18.2] .
506506
### Releases
507-
- [NPM v0.18.2] https://www.npmjs.com/package/unstructured-client/v/0.18.2 - .
507+
- [NPM v0.18.2] https://www.npmjs.com/package/unstructured-client/v/0.18.2 - .
508+
509+
## 2025-01-15 00:27:25
510+
### Changes
511+
Based on:
512+
- OpenAPI Doc
513+
- Speakeasy CLI 1.468.6 (2.493.13) https://github.com/speakeasy-api/speakeasy
514+
### Generated
515+
- [typescript v0.19.0] .
516+
### Releases
517+
- [NPM v0.19.0] https://www.npmjs.com/package/unstructured-client/v/0.19.0 - .

‎RUNTIMES.md‎

Lines changed: 27 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Supported JavaScript runtimes
22

3-
This SDK is intended to be used in JavaScript runtimes that support the following features:
3+
This SDK is intended to be used in JavaScript runtimes that support ECMAScript 2020 or newer. The SDK uses the following features:
44

55
* [Web Fetch API][web-fetch]
66
* [Web Streams API][web-streams] and in particular `ReadableStream`
@@ -20,3 +20,29 @@ Runtime environments that are explicitly supported are:
2020
- Note that Deno does not currently have native support for streaming file uploads backed by the filesystem ([issue link][deno-file-streaming])
2121

2222
[deno-file-streaming]: https://github.com/denoland/deno/issues/11018
23+
24+
## Recommended TypeScript compiler options
25+
26+
The following `tsconfig.json` options are recommended for projects using this
27+
SDK in order to get static type support for features like async iterables,
28+
streams and `fetch`-related APIs ([`for await...of`][for-await-of],
29+
[`AbortSignal`][abort-signal], [`Request`][request], [`Response`][response] and
30+
so on):
31+
32+
[for-await-of]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Statements/for-await...of
33+
[abort-signal]: https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal
34+
[request]: https://developer.mozilla.org/en-US/docs/Web/API/Request
35+
[response]: https://developer.mozilla.org/en-US/docs/Web/API/Response
36+
37+
```jsonc
38+
{
39+
"compilerOptions": {
40+
"target": "es2020", // or higher
41+
"lib": ["es2020", "dom", "dom.iterable"],
42+
}
43+
}
44+
```
45+
46+
While `target` can be set to older ECMAScript versions, it may result in extra,
47+
unnecessary compatibility code being generated if you are not targeting old
48+
runtimes.

‎docs/lib/utils/retryconfig.md‎

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
# RetryConfig
2+
3+
Allows customizing the default retry configuration. It is only permitted in methods that accept retry policies.
4+
5+
## Fields
6+
7+
| Name | Type | Description | Example |
8+
| ------------------------- | ----------------------------------- | ------------------------------------------------------------------------------------------ | ----------- |
9+
| `strategy` | `"backoff" | "none"` | The retry strategy to use. | `"backoff"` |
10+
| `backoff` | [BackoffStrategy](#backoffstrategy) | When strategy is "backoff", this configurates for the backoff parameters. | |
11+
| `retryConnectionErrors` | `*boolean*` | When strategy is "backoff", this determines whether or not to retry on connection errors. | `true` |
12+
13+
## BackoffStrategy
14+
15+
The backoff strategy allows retrying a request with an exponential backoff between each retry.
16+
17+
### Fields
18+
19+
| Name | Type | Description | Example |
20+
| ------------------ | ------------ | ----------------------------------------- | -------- |
21+
| `initialInterval` | `*number*` | The initial interval in milliseconds. | `500` |
22+
| `maxInterval` | `*number*` | The maximum interval in milliseconds. | `60000` |
23+
| `exponent` | `*number*` | The exponent to use for the backoff. | `1.5` |
24+
| `maxElapsedTime` | `*number*` | The maximum elapsed time in milliseconds. | `300000` |

‎docs/sdk/models/operations/partitionresponse.md‎

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,10 @@ import { PartitionResponse } from "unstructured-client/sdk/models/operations";
77

88
let value: PartitionResponse = {
99
contentType: "<value>",
10+
statusCode: 306,
11+
rawResponse: new Response("{\"message\": \"hello world\"}", {
12+
headers: { "Content-Type": "application/json" },
13+
}),
1014
elements: [
1115
{
1216
"type": "Title",
@@ -23,10 +27,6 @@ let value: PartitionResponse = {
2327
},
2428
},
2529
],
26-
statusCode: 306,
27-
rawResponse: new Response("{\"message\": \"hello world\"}", {
28-
headers: { "Content-Type": "application/json" },
29-
}),
3030
};
3131
```
3232

@@ -35,6 +35,7 @@ let value: PartitionResponse = {
3535
| Field | Type | Required | Description |
3636
| --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- |
3737
| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation |
38-
| `elements` | Record<string, *any*>[] | :heavy_minus_sign: | Successful Response |
3938
| `statusCode` | *number* | :heavy_check_mark: | HTTP response status code for this operation |
40-
| `rawResponse` | [Response](https://developer.mozilla.org/en-US/docs/Web/API/Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
39+
| `rawResponse` | [Response](https://developer.mozilla.org/en-US/docs/Web/API/Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
40+
| `csvElements` | *string* | :heavy_minus_sign: | Successful Response |
41+
| `elements` | Record<string, *any*>[] | :heavy_minus_sign: | Successful Response |

0 commit comments

Comments
 (0)