chore: 🐝 Update SDK - Generate 0.26.0-beta.1 (#174)

> [!IMPORTANT]
> Linting report available at:
<https://app.speakeasy.com/org/unstructured/unstructured5xr/linting-report/bf0427c20713a11fe7668763b568f89f>
> OpenAPI Change report available at:
<https://app.speakeasy.com/org/unstructured/unstructured5xr/changes-report/31a7e970642e0a5917f23d6db791d459>
# SDK update
Based on:
- OpenAPI Doc  
- Speakeasy CLI 1.396.6 (2.415.6)
https://github.com/speakeasy-api/speakeasy
## OpenAPI Change Summary


```
├─┬Info
│ └──[🔀] version (4:14)
├─┬Components
│ └─┬partition_parameters
│   ├──[➕] properties (275:17)
│   └─┬strategy
│     ├──[🔀] description (193:34)
│     └──[🔀] default (194:30)❌ 
└─┬Extensions
  └──[🔀] x-speakeasy-retries (330:22)
```

| Document Element | Total Changes | Breaking Changes |
|------------------|---------------|------------------|
| info             | 1             | 0                |
| components       | 3             | 1                |



## PYTHON CHANGELOG
## retries: 3.0.2 - 2024-09-06
### 🐛 Bug Fixes
- typing and usage snippets for next pagination func *(commit by
[@TristanSpeakEasy](https://github.com/tristanspeakeasy))*



## retries: 3.0.1 - 2024-09-06
### 🐛 Bug Fixes
- retries not using asycnio.sleep in async calls *(commit by
[@TristanSpeakEasy](https://github.com/tristanspeakeasy))*



## constsAndDefaults: 1.0.2 - 2024-08-06
### 🐛 Bug Fixes
- fixed rendering of const fields with examples in usage snippets
*(commit by [@TristanSpeakEasy](https://github.com/tristanspeakeasy))*



## constsAndDefaults: 1.0.1 - 2024-07-30
### 🐛 Bug Fixes
- fixed handling of consts in non-json usages *(commit by
[@TristanSpeakEasy](https://github.com/tristanspeakeasy))*



## core: 5.5.3 - 2024-09-12
### 🐛 Bug Fixes
- crash when there was no available security *(commit by
[@ThomasRooney](https://github.com/ThomasRooney))*



## core: 5.5.2 - 2024-09-11
### 🔧 Chores
- improvements to usage snippet generation *(commit by
[@TristanSpeakEasy](https://github.com/tristanspeakeasy))*



## core: 5.5.1 - 2024-09-10
### 🔧 Chores
- sort sub-sdks in readme *(commit by
[@ThomasRooney](https://github.com/ThomasRooney))*



## core: 5.5.0 - 2024-09-08
### 🐝 New Features
- format code with dprint *(commit by
[@disintegrator](https://github.com/disintegrator))*



## core: 5.4.5 - 2024-09-07
### 🐛 Bug Fixes
- ensure async client is used for async request building *(commit by
[@TristanSpeakEasy](https://github.com/tristanspeakeasy))*



## core: 5.4.4 - 2024-09-06
### 🔧 Chores
- upgrade to Pydantic 2.9 *(commit by
[@TristanSpeakEasy](https://github.com/tristanspeakeasy))*



## core: 5.4.3 - 2024-09-05
### 🐛 Bug Fixes
- ensure generated examples are stable generation to generation *(commit
by [@TristanSpeakEasy](https://github.com/tristanspeakeasy))*



## core: 5.4.2 - 2024-08-28
### 🐛 Bug Fixes
- remove pyright entry from pyproject.toml *(commit by
[@disintegrator](https://github.com/disintegrator))*



## core: 5.3.9 - 2024-08-18
### 🐛 Bug Fixes
- fixed handling of unset values when using serializers *(commit by
[@TristanSpeakEasy](https://github.com/tristanspeakeasy))*



## core: 5.4.1 - 2024-08-17
### 🔧 Chores
- remove unused method param *(commit by
[@adaam2](https://github.com/adaam2))*



## core: 5.3.8 - 2024-08-12
### 🐛 Bug Fixes
- downgrade python-dateutil to 2.8.2 *(commit by
[@disintegrator](https://github.com/disintegrator))*



## core: 5.4.0 - 2024-08-09
### 🐝 New Features
- default debug logging *(commit by
[@ryan-timothy-albert](https://github.com/ryan-timothy-albert))*



## core: 5.3.7 - 2024-08-08
### 🔧 Chores
- add README information regarding IDE support *(commit by
[@TristanSpeakEasy](https://github.com/tristanspeakeasy))*



## core: 5.3.6 - 2024-08-08
### 🐛 Bug Fixes
- ensure README uploaded to pypi used absolute links *(commit by
[@TristanSpeakEasy](https://github.com/tristanspeakeasy))*



## core: 5.3.5 - 2024-08-07
### 🐛 Bug Fixes
- ordering of models in file to ensure dependencies come first *(commit
by [@TristanSpeakEasy](https://github.com/tristanspeakeasy))*



## core: 5.3.4 - 2024-08-06
### 🐛 Bug Fixes
- various fixes to linting and type errors *(commit by
[@TristanSpeakEasy](https://github.com/tristanspeakeasy))*



## core: 5.3.3 - 2024-08-02
### 🐛 Bug Fixes
- fixed various issues with pyright warning/errors *(commit by
[@TristanSpeakEasy](https://github.com/tristanspeakeasy))*



## core: 5.3.2 - 2024-08-01
### 🐛 Bug Fixes
- language specific env var wrapping *(commit by
[@ThomasRooney](https://github.com/ThomasRooney))*



## core: 5.3.1 - 2024-08-01
### 🔧 Chores
- set pyproject.toml version field at compile time *(commit by
[@disintegrator](https://github.com/disintegrator))*



## core: 5.2.6 - 2024-08-01
### 🐛 Bug Fixes
- add --skip-existing to poetry publish script *(commit by
[@disintegrator](https://github.com/disintegrator))*



## core: 5.3.0 - 2024-07-31
### 🐝 New Features
- python debug logger interface *(commit by
[@ryan-timothy-albert](https://github.com/ryan-timothy-albert))*



## core: 5.2.5 - 2024-07-31
### 🐛 Bug Fixes
- fixed conversion of collection fields from TypedDict to Pydantic model
*(commit by [@TristanSpeakEasy](https://github.com/tristanspeakeasy))*



## envVarSecurityUsage: 0.3.1 - 2024-08-03
### 🐛 Bug Fixes
- optionality of security in regards to env var usage *(commit by
[@TristanSpeakEasy](https://github.com/tristanspeakeasy))*



## envVarSecurityUsage: 0.3.0 - 2024-08-01
### 🐝 New Features
- update security env vars for complex usage *(commit by
[@ryan-timothy-albert](https://github.com/ryan-timothy-albert))*



## envVarSecurityUsage: 0.2.1 - 2024-07-27
### 🐛 Bug Fixes
- show username environment variable in usage snippets *(commit by
[@disintegrator](https://github.com/disintegrator))*



## globalSecurity: 3.0.2 - 2024-08-07
### 🐛 Bug Fixes
- fixed documentation of global security schemes *(commit by
[@TristanSpeakEasy](https://github.com/tristanspeakeasy))*



## globalSecurity: 3.0.1 - 2024-08-05
### 🐛 Bug Fixes
- fixed rendering of usage snippets when required security is used with
env vars *(commit by
[@TristanSpeakEasy](https://github.com/tristanspeakeasy))*



## unions: 3.0.2 - 2024-08-09
### 🐛 Bug Fixes
- improved type matching for examples *(commit by
[@TristanSpeakEasy](https://github.com/tristanspeakeasy))*

---------

Co-authored-by: speakeasybot <[email protected]>
Co-authored-by: Austin Walker <[email protected]>

Author: 3 people

Diff for: .github/workflows/ci.yaml

@@ -12,6 +12,10 @@ permissions:
   id-token: write
   contents: read
 
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
 jobs:
   test_unit:
     strategy:
@@ -25,20 +29,20 @@ jobs:
       with:
         python-version: ${{ matrix.python-version }}
     - name: Install dependencies
-      run: make install-test
+      run: make install
     - name: Run unit tests
       run: |
-        pip install  .
-        make test-unit
+        poetry run make test-unit
 
   lint:
     runs-on: ubuntu-latest
     steps:
     - uses: actions/checkout@v4
     - name: Install dependencies
-      run: pip install . && make install-dev
+      run: make install
     - name: Lint
-      run: make lint
+      run: |
+        poetry run make lint
 
   test_integration:
     strategy:
@@ -52,11 +56,10 @@ jobs:
       with:
         python-version: ${{ matrix.python-version }}
     - name: Install dependencies
-      run: make install-test
+      run: make install
     - name: Run all tests
       run: |
-        pip install  .
-        make test
+        poetry run make test
       env:
         UNSTRUCTURED_API_KEY: ${{ secrets.UNSTRUCTURED_API_KEY }}
 

Diff for: .gitignore

@@ -1,3 +1,5 @@
+.venv/
+README-PYPI.md
 pyrightconfig.json
 venv/
 src/*.egg-info/

Diff for: .speakeasy/gen.lock

@@ -1,25 +1,26 @@
 lockVersion: 2.0.0
 id: 8b5fa338-9106-4734-abf0-e30d67044a90
 management:
-  docChecksum: a6ff17ff485bb4b5884d75af244e18a1
-  docVersion: 1.0.44
-  speakeasyVersion: 1.346.0
-  generationVersion: 2.379.3
-  releaseVersion: 0.26.0-beta
-  configChecksum: 96c9dbe127b795111b840819ebcc996d
+  docChecksum: ad32e3faae264ab1eb7cf461e373dcfa
+  docVersion: 1.0.48
+  speakeasyVersion: 1.396.6
+  generationVersion: 2.415.6
+  releaseVersion: 0.26.0-beta.1
+  configChecksum: 1af6154f17e397a8f89b4f6fd727be8d
   repoURL: https://github.com/Unstructured-IO/unstructured-python-client.git
   repoSubDirectory: .
   installationURL: https://github.com/Unstructured-IO/unstructured-python-client.git
   published: true
 features:
   python:
     additionalDependencies: 1.0.0
-    constsAndDefaults: 1.0.0
-    core: 5.2.4
+    constsAndDefaults: 1.0.2
+    core: 5.5.3
     defaultEnabledRetries: 0.2.0
-    envVarSecurityUsage: 0.2.0
+    enumUnions: 0.1.0
+    envVarSecurityUsage: 0.3.1
     examples: 3.0.0
-    globalSecurity: 3.0.0
+    globalSecurity: 3.0.2
     globalSecurityCallbacks: 1.0.0
     globalSecurityFlattening: 1.0.0
     globalServerURLs: 3.0.0
@@ -28,24 +29,56 @@ features:
     nullables: 1.0.0
     openEnums: 1.0.0
     responseFormat: 1.0.0
-    retries: 3.0.0
+    retries: 3.0.2
     sdkHooks: 1.0.0
     serverIDs: 3.0.0
-    unions: 3.0.1
+    unions: 3.0.2
     uploadStreams: 1.0.0
 generatedFiles:
-  - src/unstructured_client/sdkconfiguration.py
-  - src/unstructured_client/general.py
-  - src/unstructured_client/sdk.py
+  - .gitattributes
   - .vscode/settings.json
+  - CONTRIBUTING.md
+  - USAGE.md
+  - docs/models/errors/detail.md
+  - docs/models/errors/httpvalidationerror.md
+  - docs/models/errors/servererror.md
+  - docs/models/operations/partitionrequest.md
+  - docs/models/operations/partitionresponse.md
+  - docs/models/shared/chunkingstrategy.md
+  - docs/models/shared/files.md
+  - docs/models/shared/loc.md
+  - docs/models/shared/outputformat.md
+  - docs/models/shared/partitionparameters.md
+  - docs/models/shared/security.md
+  - docs/models/shared/strategy.md
+  - docs/models/shared/validationerror.md
+  - poetry.toml
   - py.typed
   - pylintrc
   - pyproject.toml
+  - scripts/compile.sh
+  - scripts/prepare-readme.py
   - scripts/publish.sh
   - src/unstructured_client/__init__.py
+  - src/unstructured_client/_hooks/__init__.py
+  - src/unstructured_client/_hooks/sdkhooks.py
+  - src/unstructured_client/_hooks/types.py
   - src/unstructured_client/basesdk.py
+  - src/unstructured_client/general.py
   - src/unstructured_client/httpclient.py
+  - src/unstructured_client/models/errors/__init__.py
+  - src/unstructured_client/models/errors/httpvalidationerror.py
+  - src/unstructured_client/models/errors/sdkerror.py
+  - src/unstructured_client/models/errors/servererror.py
+  - src/unstructured_client/models/operations/__init__.py
+  - src/unstructured_client/models/operations/partition.py
+  - src/unstructured_client/models/shared/__init__.py
+  - src/unstructured_client/models/shared/partition_parameters.py
+  - src/unstructured_client/models/shared/security.py
+  - src/unstructured_client/models/shared/validationerror.py
   - src/unstructured_client/py.typed
+  - src/unstructured_client/sdk.py
+  - src/unstructured_client/sdkconfiguration.py
   - src/unstructured_client/types/__init__.py
   - src/unstructured_client/types/basemodel.py
   - src/unstructured_client/utils/__init__.py
@@ -54,6 +87,7 @@ generatedFiles:
   - src/unstructured_client/utils/eventstreaming.py
   - src/unstructured_client/utils/forms.py
   - src/unstructured_client/utils/headers.py
+  - src/unstructured_client/utils/logger.py
   - src/unstructured_client/utils/metadata.py
   - src/unstructured_client/utils/queryparams.py
   - src/unstructured_client/utils/requestbodies.py
@@ -62,32 +96,15 @@ generatedFiles:
   - src/unstructured_client/utils/serializers.py
   - src/unstructured_client/utils/url.py
   - src/unstructured_client/utils/values.py
-  - src/unstructured_client/models/errors/sdkerror.py
-  - src/unstructured_client/models/operations/partition.py
-  - src/unstructured_client/models/operations/__init__.py
-  - src/unstructured_client/models/errors/httpvalidationerror.py
-  - src/unstructured_client/models/errors/servererror.py
-  - src/unstructured_client/models/errors/__init__.py
-  - src/unstructured_client/models/shared/validationerror.py
-  - src/unstructured_client/models/shared/partition_parameters.py
-  - src/unstructured_client/models/shared/security.py
-  - src/unstructured_client/models/shared/__init__.py
-  - docs/models/operations/partitionrequest.md
-  - docs/models/operations/partitionresponse.md
-  - docs/models/errors/detail.md
-  - docs/models/errors/httpvalidationerror.md
-  - docs/models/errors/servererror.md
-  - docs/models/shared/loc.md
-  - docs/models/shared/validationerror.md
-  - docs/models/shared/chunkingstrategy.md
-  - docs/models/shared/files.md
-  - docs/models/shared/outputformat.md
-  - docs/models/shared/strategy.md
-  - docs/models/shared/partitionparameters.md
-  - docs/models/shared/security.md
-  - USAGE.md
-  - .gitattributes
-  - src/unstructured_client/_hooks/sdkhooks.py
-  - src/unstructured_client/_hooks/types.py
-  - src/unstructured_client/_hooks/__init__.py
-  - CONTRIBUTING.md
+examples:
+  partition:
+    speakeasy-default-partition:
+      requestBody:
+        multipart/form-data: {"chunking_strategy": "by_title", "files": {"": "{\"summary\":\"File to be partitioned\",\"externalValue\":\"https://github.com/Unstructured-IO/unstructured/blob/98d3541909f64290b5efb65a226fc3ee8a7cc5ee/example-docs/layout-parser-paper.pdf\"}"}, "split_pdf_page_range": [1, 10], "strategy": "hi_res"}
+      responses:
+        "200":
+          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"}}]
+        "422":
+          application/json: {"detail": "<value>"}
+        5XX:
+          application/json: {"detail": "An error occurred"}

Diff for: .vscode/settings.json

@@ -0,0 +1,6 @@
+{
+  "python.testing.pytestArgs": ["tests", "-vv"],
+  "python.testing.unittestEnabled": false,
+  "python.testing.pytestEnabled": true,
+  "pylint.args": ["--rcfile=pylintrc"]
+}

Diff for: Makefile

@@ -7,17 +7,12 @@ DOCKER_IMAGE ?= downloads.unstructured.io/unstructured-io/unstructured-api:lates
 # Install #
 ###########
 
-.PHONY: install-test
-install-test:
-	pip install pytest pytest-asyncio pytest-mock requests_mock pypdf deepdiff requests-toolbelt uvloop
-
-.PHONY: install-dev
-install-dev:
-	pip install jupyter uvloop pylint mypy
-
 ## install:					installs all test, dev, and experimental requirements
 .PHONY: install
-install: install-test install-dev
+install:
+	pip install poetry
+	python scripts/prepare-readme.py
+	poetry install
 
 #################
 # Test and Lint #

Diff for: README.md

@@ -29,15 +29,45 @@ This is a Python client for the [Unstructured API](https://docs.unstructured.io/
 
 Please refer to the [Unstructured docs](https://docs.unstructured.io/api-reference/api-services/sdk-python) for a full guide to using the client.
 
+<!-- Start Summary [summary] -->
+## Summary
+
+
+<!-- End Summary [summary] -->
+
+<!-- Start Table of Contents [toc] -->
+## Table of Contents
+
+* [SDK Installation](#sdk-installation)
+* [IDE Support](#ide-support)
+* [SDK Example Usage](#sdk-example-usage)
+* [Available Resources and Operations](#available-resources-and-operations)
+* [File uploads](#file-uploads)
+* [Retries](#retries)
+* [Error Handling](#error-handling)
+* [Server Selection](#server-selection)
+* [Custom HTTP Client](#custom-http-client)
+* [Authentication](#authentication)
+* [Debugging](#debugging)
+<!-- End Table of Contents [toc] -->
+
 <!-- Start SDK Installation [installation] -->
 ## SDK Installation
 
-PIP
+The SDK can be installed with either *pip* or *poetry* package managers.
+
+### PIP
+
+*PIP* is the default package installer for Python, enabling easy installation and management of packages from PyPI via the command line.
+
 ```bash
 pip install unstructured-client
 ```
 
-Poetry
+### Poetry
+
+*Poetry* is a modern tool that simplifies dependency management and package publishing by using a single `pyproject.toml` file to handle project metadata and dependencies.
+
 ```bash
 poetry add unstructured-client
 ```
@@ -143,16 +173,13 @@ from unstructured_client import UnstructuredClient
 from unstructured_client.models import shared
 from unstructured_client.utils import BackoffStrategy, RetryConfig
 
-s = UnstructuredClient(
-    api_key_auth="YOUR_API_KEY",
-)
-
+s = UnstructuredClient()
 
 res = s.general.partition(request={
     "partition_parameters": {
         "files": {
-            "content": open("<file_path>", "rb"),
-            "file_name": "your_file_here",
+            "content": open("example.file", "rb"),
+            "file_name": "example.file",
         },
         "chunking_strategy": shared.ChunkingStrategy.BY_TITLE,
         "split_pdf_page_range": [
@@ -178,15 +205,13 @@ from unstructured_client.utils import BackoffStrategy, RetryConfig
 
 s = UnstructuredClient(
     retry_config=RetryConfig("backoff", BackoffStrategy(1, 50, 1.1, 100), False),
-    api_key_auth="YOUR_API_KEY",
 )
 
-
 res = s.general.partition(request={
     "partition_parameters": {
         "files": {
-            "content": open("<file_path>", "rb"),
-            "file_name": "your_file_here",
+            "content": open("example.file", "rb"),
+            "file_name": "example.file",
         },
         "chunking_strategy": shared.ChunkingStrategy.BY_TITLE,
         "split_pdf_page_range": [
@@ -292,6 +317,16 @@ s = UnstructuredClient(async_client=CustomClient(httpx.AsyncClient()))
 <!-- No Server Selection -->
 <!-- No Authentication -->
 
+<!-- Start IDE Support [idesupport] -->
+## IDE Support
+
+### PyCharm
+
+Generally, the SDK will work well with most IDEs out of the box. However, when using PyCharm, you can enjoy much better integration with Pydantic by installing an additional plugin.
+
+- [PyCharm Pydantic Plugin](https://docs.pydantic.dev/latest/integrations/pycharm/)
+<!-- End IDE Support [idesupport] -->
+
 <!-- Start File uploads [file-upload] -->
 ## File uploads
 
@@ -306,16 +341,13 @@ Certain SDK methods accept file objects as part of a request body or multi-part
 from unstructured_client import UnstructuredClient
 from unstructured_client.models import shared
 
-s = UnstructuredClient(
-    api_key_auth="YOUR_API_KEY",
-)
-
+s = UnstructuredClient()
 
 res = s.general.partition(request={
     "partition_parameters": {
         "files": {
-            "content": open("<file_path>", "rb"),
-            "file_name": "your_file_here",
+            "content": open("example.file", "rb"),
+            "file_name": "example.file",
         },
         "chunking_strategy": shared.ChunkingStrategy.BY_TITLE,
         "split_pdf_page_range": [
@@ -333,6 +365,21 @@ if res.elements is not None:
 ```
 <!-- End File uploads [file-upload] -->
 
+<!-- Start Debugging [debug] -->
+## Debugging
+
+You can setup your SDK to emit debug logs for SDK requests and responses.
+
+You can pass your own logger class directly into your SDK.
+```python
+from unstructured_client import UnstructuredClient
+import logging
+
+logging.basicConfig(level=logging.DEBUG)
+s = UnstructuredClient(debug_logger=logging.getLogger("unstructured_client"))
+```
+<!-- End Debugging [debug] -->
+
 <!-- Placeholder for Future Speakeasy SDK Sections -->
 
 ### Maturity