NEXUS-909 feat Enable custom server URLs in the workflow endpoints (#265)

## Summary
* `server_url` logic in workflow endpoints is now the same as partition
endpoint: user should be able to pass it from Client init to each
endpoint and if no input we will just fallback to default based on
endpoint operation
* NOTE changes to developers: generate GHA will need manual changes
* you need to change the automate speakeasy bot PR made generate GHA ->
so that it won't revert the changes on `base_url` in each endpoint (see
#266)
* we could add those file under `.genignore` so that speakeasy bot
ignore the ^^ changes -> but i don't like this way since we might still
need to modify workflow API endpoint and speakeasy bot will ignore them
if we do
* [another
trick](https://www.speakeasy.com/docs/customize/code/code-regions/overview)
i found that could solve the issue -> we could pay speakeasy more... but
still not very flexible
* or we could also patch `_get_url` in `basesdk.py` but thats in deeper
stack of code might be difficult to read the flow (and write tests)
* all reasons ^^^^ include i decide to go with manual changes in
generate GHA -> we need a developer to approve that auto PR anyway


## Test
you got three ways of using the url
```
## make sure the version of unstructured_client is the local one should be 0.34.0
import unstructured_client
from unstructured_client.models import operations, shared
from unstructured_client import UnstructuredClient
# 1. init custom url when you create the Client (suggested way for in-VPC)
uc_client = UnstructuredClient(server_url="http://localhost:8081/", api_key_auth="XXXX")

create_workflow_data = {
    "name": "custom sdk workflow",
    "workflow_type": shared.WorkflowType.BASIC,
}

client_res = uc_client.workflows.create_workflow(request={
    "create_workflow": create_workflow_data,
})
# 2. pass url when you call the specific endpoint (probably nobody will use this one...)
uc_client = UnstructuredClient(api_key_auth="XXX")

create_workflow_data = {
    "name": "custom sdk workflow",
    "workflow_type": shared.WorkflowType.BASIC,
}

client_res = uc_client.workflows.create_workflow(
    request={"create_workflow": create_workflow_data,},
    server_url="http://localhost:8081/",
)
# 3. no passing any url, fallback to default
uc_client = UnstructuredClient(api_key_auth="XXX)

create_workflow_data = {
    "name": "custom sdk workflow",
    "workflow_type": shared.WorkflowType.BASIC,
}

client_res = uc_client.workflows.create_workflow(
    request={"create_workflow": create_workflow_data,},
)
```
and responses would be (last one is default fallback)
```
INFO: HTTP Request: POST http://localhost:8081/api/v1/workflows/ "HTTP/1.1 200 OK"
INFO: HTTP Request: POST http://localhost:8081/api/v1/workflows/ "HTTP/1.1 200 OK"
INFO: HTTP Request: POST https://platform.unstructuredapp.io/api/v1/workflows/ "HTTP/1.1 200 OK"
```

---------

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
Co-authored-by: speakeasybot <[email protected]>

Author: 3 people

.genignore

@@ -1,13 +1,10 @@
-# https://www.speakeasyapi.dev/docs/customize-sdks/monkey-patching
+# https://www.speakeasy.com/docs/customize/code/monkey-patching
 
 # ignore human-written files and directories
-src/unstructured_client/_unstructured
 _jupyter
 _sample_docs
 _test_unstructured_client
 
 # ignore Makefile
 Makefile
 
-# Ignore the general.partition code until we can fix the base_url issue
-src/unstructured_client/general.py

.gitignore

@@ -1,3 +1,4 @@
+.speakeasy/temp/
 .speakeasy/reports
 .venv/
 README-PYPI.md
@@ -11,10 +12,8 @@ __pycache__/
 # human-added igore files
 .ipynb_checkpoints/
 .idea/
-
 .local
 *.ipynb
-
 openapi.json
 openapi_client.json
 openapi_serverless.json

.speakeasy/gen.lock

@@ -3,10 +3,10 @@ id: 8b5fa338-9106-4734-abf0-e30d67044a90
 management:
   docChecksum: 6433f28e5b70c3c0d7754fc7a88db327
   docVersion: 1.1.7
-  speakeasyVersion: 1.535.1
-  generationVersion: 2.585.2
-  releaseVersion: 0.33.1
-  configChecksum: 8b5e7fbd95d040ba09964f3c97c3156a
+  speakeasyVersion: 1.537.0
+  generationVersion: 2.588.0
+  releaseVersion: 0.34.0
+  configChecksum: 0ba814fcbe0d0489903de407d36313af
   repoURL: https://github.com/Unstructured-IO/unstructured-python-client.git
   repoSubDirectory: .
   installationURL: https://github.com/Unstructured-IO/unstructured-python-client.git
@@ -16,7 +16,7 @@ features:
     acceptHeaders: 3.0.0
     additionalDependencies: 1.0.0
     constsAndDefaults: 1.0.5
-    core: 5.14.0
+    core: 5.15.0
     defaultEnabledRetries: 0.2.0
     enumUnions: 0.1.0
     envVarSecurityUsage: 0.3.2
@@ -228,6 +228,7 @@ generatedFiles:
   - src/unstructured_client/_version.py
   - src/unstructured_client/basesdk.py
   - src/unstructured_client/destinations.py
+  - src/unstructured_client/general.py
   - src/unstructured_client/httpclient.py
   - src/unstructured_client/jobs.py
   - src/unstructured_client/models/__init__.py
@@ -369,6 +370,7 @@ generatedFiles:
   - src/unstructured_client/types/basemodel.py
   - src/unstructured_client/utils/__init__.py
   - src/unstructured_client/utils/annotations.py
+  - src/unstructured_client/utils/datetimes.py
   - src/unstructured_client/utils/enums.py
   - src/unstructured_client/utils/eventstreaming.py
   - src/unstructured_client/utils/forms.py
@@ -668,7 +670,7 @@ examples:
         "200":
           application/json: {"created_at": "2025-03-13T23:31:02.383Z", "id": "c3274f55-9861-4e4e-8526-4273aa4d2772", "status": "FAILURE"}
         "422":
-          application/json: {"detail": [{"loc": ["<value>"], "msg": "<value>", "type": "<value>"}, {"loc": [], "msg": "<value>", "type": "<value>"}, {"loc": [], "msg": "<value>", "type": "<value>"}]}
+          application/json: {"detail": "<value>"}
   create_connection_check_sources:
     speakeasy-default-create-connection-check-sources:
       parameters:
@@ -679,7 +681,7 @@ examples:
         "202":
           application/json: {"created_at": "2023-03-12T05:54:05.025Z", "id": "b5793adb-057f-470c-ae7e-309d786a99eb", "status": "SUCCESS"}
         "422":
-          application/json: {"detail": []}
+          application/json: {"detail": "<value>"}
   get_connection_check_sources:
     speakeasy-default-get-connection-check-sources:
       parameters:
@@ -690,6 +692,6 @@ examples:
         "200":
           application/json: {"created_at": "2023-09-12T00:38:55.692Z", "id": "f7d1d931-a753-4fe9-ae3f-671f188a9b55", "status": "SUCCESS"}
         "422":
-          application/json: {"detail": [{"loc": ["<value>"], "msg": "<value>", "type": "<value>"}, {"loc": [], "msg": "<value>", "type": "<value>"}]}
+          application/json: {"detail": "<value>"}
 examplesVersion: 1.0.1
 generatedTests: {}

.speakeasy/workflow.lock

@@ -1,21 +1,21 @@
-speakeasyVersion: 1.535.1
+speakeasyVersion: 1.537.0
 sources:
     my-source:
         sourceNamespace: my-source
-        sourceRevisionDigest: sha256:6771a944eaf5581cde4835c43e7997635f7d80ce441763c47cad9c305ba4a91e
+        sourceRevisionDigest: sha256:f5fa536ffbf6240b18b267193074d11564a899dd6fdee36261205b93c8f84880
         sourceBlobDigest: sha256:521a1c7be485e2be9f33ff7b82566823e96827cb69f7ca7775e0dd3dcc52d825
         tags:
             - latest
-            - speakeasy-sdk-regen-1745261613
+            - speakeasy-sdk-regen-1745334275
             - 1.1.7
 targets:
     unstructured-python:
         source: my-source
         sourceNamespace: my-source
-        sourceRevisionDigest: sha256:6771a944eaf5581cde4835c43e7997635f7d80ce441763c47cad9c305ba4a91e
+        sourceRevisionDigest: sha256:f5fa536ffbf6240b18b267193074d11564a899dd6fdee36261205b93c8f84880
         sourceBlobDigest: sha256:521a1c7be485e2be9f33ff7b82566823e96827cb69f7ca7775e0dd3dcc52d825
         codeSamplesNamespace: my-source-code-samples
-        codeSamplesRevisionDigest: sha256:06bd35ef844f603c2c2357092fc875febff06f5c9eb855e262ff013b8935d8d6
+        codeSamplesRevisionDigest: sha256:5940dadc286e702b4e23f58d1b7b536ffea4648a9f4f4a7ab650c6c107730a28
 workflow:
     workflowVersion: 1.0.0
     speakeasyVersion: latest

RELEASES.md

@@ -977,4 +977,14 @@ Based on:
 ### Generated
 - [python v0.33.1] .
 ### Releases
-- [PyPI v0.33.1] https://pypi.org/project/unstructured-client/0.33.1 - .
+- [PyPI v0.33.1] https://pypi.org/project/unstructured-client/0.33.1 - .
+
+## 2025-04-22 15:11:11
+### Changes
+Based on:
+- OpenAPI Doc  
+- Speakeasy CLI 1.537.0 (2.588.0) https://github.com/speakeasy-api/speakeasy
+### Generated
+- [python v0.34.0] .
+### Releases
+- [PyPI v0.34.0] https://pypi.org/project/unstructured-client/0.34.0 - .

_test_unstructured_client/unit/test_custom_hooks.py

@@ -169,7 +169,7 @@ def mock_post(request):
     with pytest.raises(Exception):
         session.general.partition(request=req, retries=retries)
 
-    pattern = re.compile(f"Failed to process a request due to connection error .*? "
+    pattern = re.compile("Failed to process a request due to connection error .*? "
                          "Attempting retry number 1 after sleep.")
     assert bool(pattern.search(caplog.text))
 
@@ -198,23 +198,20 @@ def test_unit_clean_server_url_fixes_malformed_paid_api_url(server_url: str):
 
 
 @pytest.mark.parametrize(
-    "server_url",
+    "server_url,expected_url",
     [
-        # -- well-formed url --
-        "http://localhost:8000",
-        # -- common malformed urls --
-        "localhost:8000",
-        "localhost:8000/general/v0/general",
-        "http://localhost:8000/general/v0/general",
+        ("http://localhost:8000", "http://localhost:8000"),
+        ("localhost:8000", "http://localhost:8000"),
+        ("localhost:8000/general/v0/general", "http://localhost:8000/general/v0/general"),
+        ("http://localhost:8000/general/v0/general", "http://localhost:8000/general/v0/general"),
     ],
 )
-def test_unit_clean_server_url_fixes_malformed_localhost_url(server_url: str):
+def test_unit_clean_server_url_fixes_non_unst_domain_url(server_url: str, expected_url: str):
     client = UnstructuredClient(
         server_url=server_url,
         api_key_auth=FAKE_KEY,
     )
-    assert client.general.sdk_configuration.server_url == "http://localhost:8000"
-
+    assert client.general.sdk_configuration.server_url == expected_url
 
 @pytest.mark.parametrize(
     "server_url",

_test_unstructured_client/unit/test_request_utils.py

@@ -7,7 +7,6 @@
     get_base_url,
     get_multipart_stream_fields,
 )
-from unstructured_client.models import shared
 
 
 # make the above test using @pytest.mark.parametrize