diff --git a/.speakeasy/workflow.yaml b/.speakeasy/workflow.yaml index fe4afae..0c6bd6b 100644 --- a/.speakeasy/workflow.yaml +++ b/.speakeasy/workflow.yaml @@ -9,7 +9,7 @@ sources: registry: location: registry.speakeasyapi.dev/unstructured/unstructured5xr/my-source targets: - unstructed-typescript: + unstructured-typescript: target: typescript source: my-source publish: diff --git a/FUNCTIONS.md b/FUNCTIONS.md index 3e1f0a0..9c836f4 100644 --- a/FUNCTIONS.md +++ b/FUNCTIONS.md @@ -1,11 +1,11 @@ # Standalone Functions > [!NOTE] -> This section is useful if you are using a bundler and targetting browsers and +> This section is useful if you are using a bundler and targeting browsers and > runtimes where the size of an application affects performance and load times. Every method in this SDK is also available as a standalone function. This -alternative API is suitable when targetting the browser or serverless runtimes +alternative API is suitable when targeting the browser or serverless runtimes and using a bundler to build your application since all unused functionality will be tree-shaken away. This includes code for unused methods, Zod schemas, encoding helpers and response handlers. The result is dramatically smaller diff --git a/README.md b/README.md index 37db880..5af308c 100755 --- a/README.md +++ b/README.md @@ -19,10 +19,10 @@

-

Typescript SDK for the Unstructured API

+

TypeScript SDK for the Unstructured API

-This is a Typescript client for the [Unstructured API](https://docs.unstructured.io/api-reference/api-services/overview). +This is a TypeScript client for the [Unstructured API](https://docs.unstructured.io/api-reference/api-services/overview). Please refer to the [Unstructured docs](https://docs.unstructured.io/api-reference/api-services/sdk-jsts) for a full guide to using the client. @@ -384,6 +384,6 @@ looking for the latest version. ### Contributions While we value open-source contributions to this SDK, this library is generated programmatically. -Feel free to open a PR or a Github issue as a proof of concept and we'll do our best to include it in a future release! +Feel free to open a PR or a GitHub issue as a proof of concept and we'll do our best to include it in a future release! ### SDK Created by [Speakeasy](https://docs.speakeasyapi.dev/docs/using-speakeasy/client-sdks) diff --git a/overlay_client.yaml b/overlay_client.yaml index 983a07d..7639064 100644 --- a/overlay_client.yaml +++ b/overlay_client.yaml @@ -38,7 +38,7 @@ actions: "split_pdf_allow_failed": { "title": "Split Pdf Allow Failed", - "description": "When `split_pdf_page` is set to `True`, this parameter defines the behavior when some of the parallel requests fail. By default `split_pdf_allow_failed` is set to `False` and any failed request send to the API will make the whole process break and raise an Exception. If `split_pdf_allow_failed` is set to `True`, the errors encountered while sending parallel requests will not break the processing - the resuling list of Elements will miss the data from errored pages.", + "description": "When `split_pdf_page` is set to `True`, this parameter defines the behavior when some of the parallel requests fail. By default `split_pdf_allow_failed` is set to `False` and any failed request send to the API will make the whole process break and raise an Exception. If `split_pdf_allow_failed` is set to `True`, the errors encountered while sending parallel requests will not break the processing - the resulting list of Elements will miss the data from errored pages.", "type": "boolean", "default": false, } diff --git a/src/lib/http.ts b/src/lib/http.ts index 13cf1fd..0386b09 100644 --- a/src/lib/http.ts +++ b/src/lib/http.ts @@ -12,7 +12,7 @@ export type Awaitable = T | Promise; const DEFAULT_FETCHER: Fetcher = (input, init) => { // If input is a Request and init is undefined, Bun will discard the method, // headers, body and other options that were set on the request object. - // Node.js and browers would ignore an undefined init value. This check is + // Node.js and browsers would ignore an undefined init value. This check is // therefore needed for interop with Bun. if (init == null) { return fetch(input); @@ -254,7 +254,7 @@ export function matchResponse( } /** - * Uses various heurisitics to determine if an error is a connection error. + * Uses various heuristics to determine if an error is a connection error. */ export function isConnectionError(err: unknown): boolean { if (typeof err !== "object" || err == null) { @@ -281,7 +281,7 @@ export function isConnectionError(err: unknown): boolean { } /** - * Uses various heurisitics to determine if an error is a timeout error. + * Uses various heuristics to determine if an error is a timeout error. */ export function isTimeoutError(err: unknown): boolean { if (typeof err !== "object" || err == null) { @@ -302,7 +302,7 @@ export function isTimeoutError(err: unknown): boolean { } /** - * Uses various heurisitics to determine if an error is a abort error. + * Uses various heuristics to determine if an error is a abort error. */ export function isAbortError(err: unknown): boolean { if (typeof err !== "object" || err == null) { diff --git a/src/sdk/models/errors/sdkvalidationerror.ts b/src/sdk/models/errors/sdkvalidationerror.ts index 16929b9..8d7e922 100644 --- a/src/sdk/models/errors/sdkvalidationerror.ts +++ b/src/sdk/models/errors/sdkvalidationerror.ts @@ -79,7 +79,7 @@ export function formatZodError(err: z.ZodError, level = 0): string { case "invalid_union": { const len = issue.unionErrors.length; append( - `│ ✖︎ Attemped to deserialize into one of ${len} union members:`, + `│ ✖︎ Attempted to deserialize into one of ${len} union members:`, ); issue.unionErrors.forEach((err, i) => { append(`│ ✖︎ Member ${i + 1} of ${len}`); diff --git a/src/sdk/models/shared/partitionparameters.ts b/src/sdk/models/shared/partitionparameters.ts index 466fa4b..8dbf4f1 100644 --- a/src/sdk/models/shared/partitionparameters.ts +++ b/src/sdk/models/shared/partitionparameters.ts @@ -140,7 +140,7 @@ export type PartitionParameters = { */ skipInferTableTypes?: Array | undefined; /** - * When `split_pdf_page` is set to `True`, this parameter defines the behavior when some of the parallel requests fail. By default `split_pdf_allow_failed` is set to `False` and any failed request send to the API will make the whole process break and raise an Exception. If `split_pdf_allow_failed` is set to `True`, the errors encountered while sending parallel requests will not break the processing - the resuling list of Elements will miss the data from errored pages. + * When `split_pdf_page` is set to `True`, this parameter defines the behavior when some of the parallel requests fail. By default `split_pdf_allow_failed` is set to `False` and any failed request send to the API will make the whole process break and raise an Exception. If `split_pdf_allow_failed` is set to `True`, the errors encountered while sending parallel requests will not break the processing - the resulting list of Elements will miss the data from errored pages. */ splitPdfAllowFailed?: boolean | undefined; /** diff --git a/src/sdk/types/constdatetime.ts b/src/sdk/types/constdatetime.ts index c0a4409..eeff4dd 100644 --- a/src/sdk/types/constdatetime.ts +++ b/src/sdk/types/constdatetime.ts @@ -11,5 +11,5 @@ export function constDateTime( return ( typeof v === "string" && new Date(v).getTime() === new Date(val).getTime() ); - }, `Value must be equivelant to ${val}`); + }, `Value must be equivalent to ${val}`); }