feat: add support for Platform API (#219)

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

Author: pawel-kmiecik

Diff for: .gitignore

@@ -11,8 +11,16 @@ __pycache__/
 # human-added igore files
 .ipynb_checkpoints/
 .idea/
+
+.local
+*.ipynb
+
 openapi.json
 openapi_client.json
+openapi_serverless.json
+openapi_platform_api.json
+openapi_merged.yaml
+openapi_platform_serverless_client.yaml
 # Environments
 .env
 .envrc

Diff for: .speakeasy/workflow.yaml

@@ -4,6 +4,7 @@ sources:
     my-source:
         inputs:
             - location: https://api.unstructured.io/general/openapi.json
+            - location: https://platform.unstructuredapp.io/openapi.json
         overlays:
             - location: ./overlay_client.yaml
         registry:

Diff for: CHANGELOG.md

@@ -1,3 +1,28 @@
+## 0.30.0
+
+### Enhancements
+
+### Features
+* Add Unstructured Platform APIs to manage source and destination connectors, workflows, and workflow runs
+__WARNING__: This is a breaking change for the use of non-default `server_url` settings in the client usage.
+To set the custom URL for the client, use the the `server_url` parameter in a given operation:
+```python
+elements = client.general.partition(
+    request=operations.PartitionRequest(
+        partition_parameters=shared.PartitionParameters(
+            files=shared.Files(
+                content=doc_file,
+                file_name="your_document.pdf",
+            ),
+            strategy=shared.Strategy.FAST,
+        )
+    ),
+    server_url="your_server_url",
+)
+```
+
+### Fixes
+
 ## 0.26.1
 
 ### Enhancements

Diff for: Makefile

@@ -62,20 +62,28 @@ lint:
 # Speakeasy #
 #############
 
-## client-generate:			Pull the openapi spec from the free hosted API and generate the SDK
-.PHONY: client-generate
-client-generate:
-	wget -nv -q -O openapi.json https://api.unstructured.io/general/openapi.json
+## download-openapi-specs:			         Download the openapi specs from the Serverless and Platform APIs
+.PHONY: download-openapi-specs
+download-openapi-specs:
+	wget -nv -q -O openapi_serverless.json https://api.unstructured.io/general/openapi.json
+	wget -nv -q -O openapi_platform_api.json https://platform.unstructuredapp.io/openapi.json
+
+## client-merge-serverless-platform:		Merge the Serverless and Platform APIs specs into a single schema
+.PHONY: client-merge-serverless-platform
+client-merge-serverless-platform:
+	speakeasy merge -s ./openapi_serverless.json -s ./openapi_platform_api.json -o ./openapi_merged.yaml
+
+## client-generate-unified-sdk-local:		Generate the SDK using merged schemas
+.PHONY: client-generate-unified-sdk-local
+client-generate-unified-sdk-local:
 	speakeasy overlay validate -o ./overlay_client.yaml
-	speakeasy overlay apply -s ./openapi.json -o ./overlay_client.yaml > ./openapi_client.json
-	speakeasy generate sdk -s ./openapi_client.json -o ./ -l python
+	speakeasy overlay apply -s ./openapi_merged.yaml -o ./overlay_client.yaml > ./openapi_platform_serverless_client.yaml
+	speakeasy generate sdk -s ./openapi_platform_serverless_client.yaml -o ./ -l python
+
+## client-generate-sdk:			             Do all the steps to generate the SDK
+.PHONY: client-generate-sdk
+client-generate-sdk: download-openapi-specs client-merge-serverless-platform client-generate-unified-sdk-local
 
-## client-generate-local:			Generate the SDK using a local copy of openapi.json
-.PHONY: client-generate-local
-client-generate-local:
-	speakeasy overlay validate -o ./overlay_client.yaml
-	speakeasy overlay apply -s ./openapi.json -o ./overlay_client.yaml > ./openapi_client.json
-	speakeasy generate sdk -s ./openapi_client.json -o ./ -l python
 
 .PHONY: publish
 publish:
@@ -88,4 +96,4 @@ publish:
 ## run-jupyter:				starts jupyter notebook
 .PHONY: run-jupyter
 run-jupyter:
-	PYTHONPATH=$(realpath .) JUPYTER_PATH=$(realpath .) jupyter-notebook --NotebookApp.token='' --NotebookApp.password=''
+	PYTHONPATH=$(realpath .) JUPYTER_PATH=$(realpath .) jupyter-notebook --NotebookApp.token='' --NotebookApp.password=''

Diff for: _test_contract/platform_api/conftest.py

@@ -0,0 +1,29 @@
+import os
+
+import pytest
+
+from unstructured_client import UnstructuredClient, RetryConfig
+from unstructured_client.utils import BackoffStrategy
+
+FAKE_API_KEY = "91pmLBeETAbXCpNylRsLq11FdiZPTk"
+
+
+@pytest.fixture(scope="module")
+def platform_api_url():
+    return "https://platform.unstructuredapp.io"
+
+
+@pytest.fixture(scope="module")
+def client(platform_api_url) -> UnstructuredClient:
+    _client = UnstructuredClient(
+        api_key_auth=FAKE_API_KEY,
+        server_url="platform-api",
+        retry_config=RetryConfig(
+            strategy="backoff",
+            retry_connection_errors=False,
+            backoff=BackoffStrategy(
+                max_elapsed_time=0, max_interval=0, exponent=0, initial_interval=0
+            ),
+        ),
+    )
+    yield _client