From 3725db4b3dad04e5932d85da934dd3704841a4b0 Mon Sep 17 00:00:00 2001 From: armandobelardo Date: Fri, 2 Aug 2024 06:50:29 -0400 Subject: [PATCH] fix: python readme references request options correctly --- generators/python/sdk/CHANGELOG.md | 6 +- generators/python/sdk/VERSION | 2 +- .../generator_cli/readme_snippet_builder.py | 8 +- seed/python-sdk/alias/README.md | 131 - seed/python-sdk/api-wide-base-path/README.md | 137 - seed/python-sdk/audiences/README.md | 135 - .../auth-environment-variables/README.md | 131 - .../README.md | 135 - seed/python-sdk/basic-auth/README.md | 135 - .../README.md | 129 - seed/python-sdk/bytes/README.md | 127 - seed/python-sdk/code-samples/README.md | 131 - seed/python-sdk/custom-auth/README.md | 133 - .../enum/no-custom-config/README.md | 133 - seed/python-sdk/enum/strenum/README.md | 133 - seed/python-sdk/error-property/README.md | 127 - .../examples/client-filename/README.md | 135 - .../examples/no-custom-config/README.md | 135 - seed/python-sdk/examples/readme/README.md | 182 - .../deps_with_min_python_version/README.md | 133 - .../exhaustive/extra_dependencies/README.md | 133 - .../extra_dev_dependencies/README.md | 133 - .../exhaustive/five-second-timeout/README.md | 133 - .../follow_redirects_by_default/README.md | 133 - .../exhaustive/improved_imports/README.md | 133 - .../exhaustive/infinite-timeout/README.md | 133 - .../inline_request_params/README.md | 133 - .../exhaustive/no-custom-config/README.md | 133 - .../pydantic-extra-fields/README.md | 133 - .../exhaustive/pydantic-v1/README.md | 133 - .../skip-pydantic-validation/README.md | 133 - .../exhaustive/union-utils/README.md | 133 - seed/python-sdk/extends/README.md | 135 - seed/python-sdk/extra-properties/README.md | 131 - seed/python-sdk/file-download/README.md | 127 - seed/python-sdk/file-upload/README.md | 127 - seed/python-sdk/folders/README.md | 127 - seed/python-sdk/idempotency-headers/README.md | 135 - seed/python-sdk/imdb/README.md | 135 - .../literal/no-custom-config/README.md | 131 - .../literal/use_typeddict_requests/README.md | 131 - seed/python-sdk/mixed-case/README.md | 131 - seed/python-sdk/multi-line-docs/README.md | 133 - .../README.md | 135 - .../multi-url-environment/README.md | 131 - seed/python-sdk/no-environment/README.md | 129 - .../README.md | 137 - .../README.md | 139 - .../README.md | 139 - .../oauth-client-credentials/README.md | 139 - seed/python-sdk/optional/README.md | 131 - seed/python-sdk/package-yml/README.md | 135 - seed/python-sdk/pagination/.mock/ir.json | 6992 ----------------- seed/python-sdk/pagination/README.md | 173 - seed/python-sdk/plain-text/README.md | 127 - seed/python-sdk/query-parameters/README.md | 220 - seed/python-sdk/reserved-keywords/README.md | 131 - seed/python-sdk/server-sent-events/README.md | 152 - .../single-url-environment-default/README.md | 127 - .../README.md | 131 - seed/python-sdk/streaming-parameter/README.md | 133 - .../streaming/no-custom-config/README.md | 152 - .../skip-pydantic-validation/README.md | 152 - .../undiscriminated-unions/README.md | 131 - .../unions/no-custom-config/README.md | 131 - seed/python-sdk/unions/union-utils/README.md | 131 - seed/python-sdk/unknown/README.md | 131 - .../validation/no-custom-config/README.md | 137 - .../validation/with-defaults/README.md | 137 - seed/python-sdk/variables/README.md | 131 - seed/python-sdk/version-no-default/README.md | 131 - seed/python-sdk/version/README.md | 131 - 72 files changed, 10 insertions(+), 16243 deletions(-) delete mode 100644 seed/python-sdk/pagination/.mock/ir.json diff --git a/generators/python/sdk/CHANGELOG.md b/generators/python/sdk/CHANGELOG.md index f7e54949e2e..d4ca55f02b9 100644 --- a/generators/python/sdk/CHANGELOG.md +++ b/generators/python/sdk/CHANGELOG.md @@ -5,7 +5,11 @@ All notable changes to this project will be documented in this file. The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). -## [3.3.0-rc1] - 2024-07-31 +## [3.3.1] - 2024-08-02 + +- Fix: Generated READMEs now reference RequestOptions as TypedDicts correctly. + +## [3.3.0-rc1] - 2024-08-01 - Fix: TypedDict snippets now include literals where available. diff --git a/generators/python/sdk/VERSION b/generators/python/sdk/VERSION index 490631ab03b..bea438e9ade 100644 --- a/generators/python/sdk/VERSION +++ b/generators/python/sdk/VERSION @@ -1 +1 @@ -3.3.0-rc1 +3.3.1 diff --git a/generators/python/src/fern_python/generator_cli/readme_snippet_builder.py b/generators/python/src/fern_python/generator_cli/readme_snippet_builder.py index 4a3f95b1def..d3686c2539c 100644 --- a/generators/python/src/fern_python/generator_cli/readme_snippet_builder.py +++ b/generators/python/src/fern_python/generator_cli/readme_snippet_builder.py @@ -117,7 +117,7 @@ def _build_timeout_snippets(self) -> List[str]: client_instantiation = AST.ClassInstantiation( class_=self._root_client.sync_client.class_reference, - args=[AST.Expression("..."), AST.Expression("{ timeout=20.0 }")], + args=[AST.Expression("..."), AST.Expression(f'{ "timeout": 20.0 }')], ) def _client_writer(writer: AST.NodeWriter) -> None: @@ -134,7 +134,7 @@ def _client_writer(writer: AST.NodeWriter) -> None: # Override timeout for a specific method client.{endpoint.endpoint_package_path}{endpoint.method_name}({"...," if has_parameters else ""}{{ - timeout_in_seconds=1 + "timeout_in_seconds": 1 }}) """ ) @@ -188,7 +188,7 @@ def _build_retries_snippets(self) -> List[str]: has_parameters = self._endpoint_metadata.has_parameters(endpoint_id) retry_snippets.append( f"""client.{endpoint.endpoint_package_path}{endpoint.method_name}({"...," if has_parameters else ""}{{ - max_retries=1 + "max_retries": 1 }}) """ ) @@ -201,7 +201,7 @@ def _build_custom_client_snippets(self) -> str: args=[AST.Expression("...")], kwargs=[ ( - "http_client", + "httpx_client", AST.Expression( AST.ClassInstantiation( class_=HttpX.CLIENT, diff --git a/seed/python-sdk/alias/README.md b/seed/python-sdk/alias/README.md index 8f35ac82458..e69de29bb2d 100644 --- a/seed/python-sdk/alias/README.md +++ b/seed/python-sdk/alias/README.md @@ -1,131 +0,0 @@ -# Seed Python Library - -[![fern shield](https://img.shields.io/badge/%F0%9F%8C%BF-SDK%20generated%20by%20Fern-brightgreen)](https://github.com/fern-api/fern) -[![pypi](https://img.shields.io/pypi/v/fern_alias)](https://pypi.python.org/pypi/fern_alias) - -The Seed Python library provides convenient access to the Seed API from Python. - -## Installation - -```sh -pip install fern_alias -``` - -## Usage - -Instantiate and use the client with the following: - -```python -from seed import SeedAlias - -client = SeedAlias( - base_url="https://yourhost.com/path/to/api", -) -client.get( - type_id="type-kaljhv87", -) -``` - -## Async Client - -The SDK also exports an `async` client so that you can make non-blocking calls to our API. - -```python -import asyncio - -from seed import AsyncSeedAlias - -client = AsyncSeedAlias( - base_url="https://yourhost.com/path/to/api", -) - - -async def main() -> None: - await client.get( - type_id="type-kaljhv87", - ) - - -asyncio.run(main()) -``` - -## Exception Handling - -When the API returns a non-success status code (4xx or 5xx response), a subclass of the following error -will be thrown. - -```python -from seed.core.api_error import ApiError - -try: - client.get() -except ApiError as e: - print(e.status_code) - print(e.body) -``` - -## Advanced - -### Retries - -The SDK is instrumented with automatic retries with exponential backoff. A request will be retried as long -as the request is deemed retriable and the number of retry attempts has not grown larger than the configured -retry limit (default: 2). - -A request is deemed retriable when any of the following HTTP status codes is returned: - -- [408](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/408) (Timeout) -- [429](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/429) (Too Many Requests) -- [5XX](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/500) (Internal Server Errors) - -Use the `max_retries` request option to configure this behavior. - -```python -client.get({ - max_retries=1 -}) -``` - -### Timeouts - -The SDK defaults to a 60 second timeout. You can configure this with a timeout option at the client or request level. - -```python - -from seed import SeedAlias - -client = SeedAlias(..., { timeout=20.0 }, ) - - -# Override timeout for a specific method -client.get({ - timeout_in_seconds=1 -}) -``` - -### Custom Client - -You can override the `httpx` client to customize it for your use-case. Some common use-cases include support for proxies -and transports. -```python -import httpx -from seed import SeedAlias - -client = SeedAlias( - ..., - http_client=httpx.Client( - proxies="http://my.test.proxy.example.com", - transport=httpx.HTTPTransport(local_address="0.0.0.0"), - ), -) -``` - -## Contributing - -While we value open-source contributions to this SDK, this library is generated programmatically. -Additions made directly to this library would have to be moved over to our generation code, -otherwise they would be overwritten upon the next generated release. Feel free to open a PR as -a proof of concept, but know that we will not be able to merge it as-is. We suggest opening -an issue first to discuss with us! - -On the other hand, contributions to the README are always very welcome! diff --git a/seed/python-sdk/api-wide-base-path/README.md b/seed/python-sdk/api-wide-base-path/README.md index afba9e932ad..e69de29bb2d 100644 --- a/seed/python-sdk/api-wide-base-path/README.md +++ b/seed/python-sdk/api-wide-base-path/README.md @@ -1,137 +0,0 @@ -# Seed Python Library - -[![fern shield](https://img.shields.io/badge/%F0%9F%8C%BF-SDK%20generated%20by%20Fern-brightgreen)](https://github.com/fern-api/fern) -[![pypi](https://img.shields.io/pypi/v/fern_api-wide-base-path)](https://pypi.python.org/pypi/fern_api-wide-base-path) - -The Seed Python library provides convenient access to the Seed API from Python. - -## Installation - -```sh -pip install fern_api-wide-base-path -``` - -## Usage - -Instantiate and use the client with the following: - -```python -from seed import SeedApiWideBasePath - -client = SeedApiWideBasePath( - base_url="https://yourhost.com/path/to/api", -) -client.service.post( - path_param="string", - service_param="string", - resource_param="string", - endpoint_param=1, -) -``` - -## Async Client - -The SDK also exports an `async` client so that you can make non-blocking calls to our API. - -```python -import asyncio - -from seed import AsyncSeedApiWideBasePath - -client = AsyncSeedApiWideBasePath( - base_url="https://yourhost.com/path/to/api", -) - - -async def main() -> None: - await client.service.post( - path_param="string", - service_param="string", - resource_param="string", - endpoint_param=1, - ) - - -asyncio.run(main()) -``` - -## Exception Handling - -When the API returns a non-success status code (4xx or 5xx response), a subclass of the following error -will be thrown. - -```python -from seed.core.api_error import ApiError - -try: - client.service.post() -except ApiError as e: - print(e.status_code) - print(e.body) -``` - -## Advanced - -### Retries - -The SDK is instrumented with automatic retries with exponential backoff. A request will be retried as long -as the request is deemed retriable and the number of retry attempts has not grown larger than the configured -retry limit (default: 2). - -A request is deemed retriable when any of the following HTTP status codes is returned: - -- [408](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/408) (Timeout) -- [429](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/429) (Too Many Requests) -- [5XX](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/500) (Internal Server Errors) - -Use the `max_retries` request option to configure this behavior. - -```python -client.service.post({ - max_retries=1 -}) -``` - -### Timeouts - -The SDK defaults to a 60 second timeout. You can configure this with a timeout option at the client or request level. - -```python - -from seed import SeedApiWideBasePath - -client = SeedApiWideBasePath(..., { timeout=20.0 }, ) - - -# Override timeout for a specific method -client.service.post({ - timeout_in_seconds=1 -}) -``` - -### Custom Client - -You can override the `httpx` client to customize it for your use-case. Some common use-cases include support for proxies -and transports. -```python -import httpx -from seed import SeedApiWideBasePath - -client = SeedApiWideBasePath( - ..., - http_client=httpx.Client( - proxies="http://my.test.proxy.example.com", - transport=httpx.HTTPTransport(local_address="0.0.0.0"), - ), -) -``` - -## Contributing - -While we value open-source contributions to this SDK, this library is generated programmatically. -Additions made directly to this library would have to be moved over to our generation code, -otherwise they would be overwritten upon the next generated release. Feel free to open a PR as -a proof of concept, but know that we will not be able to merge it as-is. We suggest opening -an issue first to discuss with us! - -On the other hand, contributions to the README are always very welcome! diff --git a/seed/python-sdk/audiences/README.md b/seed/python-sdk/audiences/README.md index eb762f50962..e69de29bb2d 100644 --- a/seed/python-sdk/audiences/README.md +++ b/seed/python-sdk/audiences/README.md @@ -1,135 +0,0 @@ -# Seed Python Library - -[![fern shield](https://img.shields.io/badge/%F0%9F%8C%BF-SDK%20generated%20by%20Fern-brightgreen)](https://github.com/fern-api/fern) -[![pypi](https://img.shields.io/pypi/v/fern_audiences)](https://pypi.python.org/pypi/fern_audiences) - -The Seed Python library provides convenient access to the Seed API from Python. - -## Installation - -```sh -pip install fern_audiences -``` - -## Usage - -Instantiate and use the client with the following: - -```python -from seed import SeedAudiences - -client = SeedAudiences( - base_url="https://yourhost.com/path/to/api", -) -client.foo.find( - optional_string="string", - public_property="string", - private_property=1, -) -``` - -## Async Client - -The SDK also exports an `async` client so that you can make non-blocking calls to our API. - -```python -import asyncio - -from seed import AsyncSeedAudiences - -client = AsyncSeedAudiences( - base_url="https://yourhost.com/path/to/api", -) - - -async def main() -> None: - await client.foo.find( - optional_string="string", - public_property="string", - private_property=1, - ) - - -asyncio.run(main()) -``` - -## Exception Handling - -When the API returns a non-success status code (4xx or 5xx response), a subclass of the following error -will be thrown. - -```python -from seed.core.api_error import ApiError - -try: - client.foo.find(...) -except ApiError as e: - print(e.status_code) - print(e.body) -``` - -## Advanced - -### Retries - -The SDK is instrumented with automatic retries with exponential backoff. A request will be retried as long -as the request is deemed retriable and the number of retry attempts has not grown larger than the configured -retry limit (default: 2). - -A request is deemed retriable when any of the following HTTP status codes is returned: - -- [408](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/408) (Timeout) -- [429](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/429) (Too Many Requests) -- [5XX](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/500) (Internal Server Errors) - -Use the `max_retries` request option to configure this behavior. - -```python -client.foo.find(...,{ - max_retries=1 -}) -``` - -### Timeouts - -The SDK defaults to a 60 second timeout. You can configure this with a timeout option at the client or request level. - -```python - -from seed import SeedAudiences - -client = SeedAudiences(..., { timeout=20.0 }, ) - - -# Override timeout for a specific method -client.foo.find(...,{ - timeout_in_seconds=1 -}) -``` - -### Custom Client - -You can override the `httpx` client to customize it for your use-case. Some common use-cases include support for proxies -and transports. -```python -import httpx -from seed import SeedAudiences - -client = SeedAudiences( - ..., - http_client=httpx.Client( - proxies="http://my.test.proxy.example.com", - transport=httpx.HTTPTransport(local_address="0.0.0.0"), - ), -) -``` - -## Contributing - -While we value open-source contributions to this SDK, this library is generated programmatically. -Additions made directly to this library would have to be moved over to our generation code, -otherwise they would be overwritten upon the next generated release. Feel free to open a PR as -a proof of concept, but know that we will not be able to merge it as-is. We suggest opening -an issue first to discuss with us! - -On the other hand, contributions to the README are always very welcome! diff --git a/seed/python-sdk/auth-environment-variables/README.md b/seed/python-sdk/auth-environment-variables/README.md index 66d8082622d..e69de29bb2d 100644 --- a/seed/python-sdk/auth-environment-variables/README.md +++ b/seed/python-sdk/auth-environment-variables/README.md @@ -1,131 +0,0 @@ -# Seed Python Library - -[![fern shield](https://img.shields.io/badge/%F0%9F%8C%BF-SDK%20generated%20by%20Fern-brightgreen)](https://github.com/fern-api/fern) -[![pypi](https://img.shields.io/pypi/v/fern_auth-environment-variables)](https://pypi.python.org/pypi/fern_auth-environment-variables) - -The Seed Python library provides convenient access to the Seed API from Python. - -## Installation - -```sh -pip install fern_auth-environment-variables -``` - -## Usage - -Instantiate and use the client with the following: - -```python -from seed import SeedAuthEnvironmentVariables - -client = SeedAuthEnvironmentVariables( - x_another_header="YOUR_X_ANOTHER_HEADER", - api_key="YOUR_API_KEY", - base_url="https://yourhost.com/path/to/api", -) -client.service.get_with_api_key() -``` - -## Async Client - -The SDK also exports an `async` client so that you can make non-blocking calls to our API. - -```python -import asyncio - -from seed import AsyncSeedAuthEnvironmentVariables - -client = AsyncSeedAuthEnvironmentVariables( - x_another_header="YOUR_X_ANOTHER_HEADER", - api_key="YOUR_API_KEY", - base_url="https://yourhost.com/path/to/api", -) - - -async def main() -> None: - await client.service.get_with_api_key() - - -asyncio.run(main()) -``` - -## Exception Handling - -When the API returns a non-success status code (4xx or 5xx response), a subclass of the following error -will be thrown. - -```python -from seed.core.api_error import ApiError - -try: - client.service.get_with_api_key(...) -except ApiError as e: - print(e.status_code) - print(e.body) -``` - -## Advanced - -### Retries - -The SDK is instrumented with automatic retries with exponential backoff. A request will be retried as long -as the request is deemed retriable and the number of retry attempts has not grown larger than the configured -retry limit (default: 2). - -A request is deemed retriable when any of the following HTTP status codes is returned: - -- [408](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/408) (Timeout) -- [429](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/429) (Too Many Requests) -- [5XX](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/500) (Internal Server Errors) - -Use the `max_retries` request option to configure this behavior. - -```python -client.service.get_with_api_key(...,{ - max_retries=1 -}) -``` - -### Timeouts - -The SDK defaults to a 60 second timeout. You can configure this with a timeout option at the client or request level. - -```python - -from seed import SeedAuthEnvironmentVariables - -client = SeedAuthEnvironmentVariables(..., { timeout=20.0 }, ) - - -# Override timeout for a specific method -client.service.get_with_api_key(...,{ - timeout_in_seconds=1 -}) -``` - -### Custom Client - -You can override the `httpx` client to customize it for your use-case. Some common use-cases include support for proxies -and transports. -```python -import httpx -from seed import SeedAuthEnvironmentVariables - -client = SeedAuthEnvironmentVariables( - ..., - http_client=httpx.Client( - proxies="http://my.test.proxy.example.com", - transport=httpx.HTTPTransport(local_address="0.0.0.0"), - ), -) -``` - -## Contributing - -While we value open-source contributions to this SDK, this library is generated programmatically. -Additions made directly to this library would have to be moved over to our generation code, -otherwise they would be overwritten upon the next generated release. Feel free to open a PR as -a proof of concept, but know that we will not be able to merge it as-is. We suggest opening -an issue first to discuss with us! - -On the other hand, contributions to the README are always very welcome! diff --git a/seed/python-sdk/basic-auth-environment-variables/README.md b/seed/python-sdk/basic-auth-environment-variables/README.md index 35cf292d85c..e69de29bb2d 100644 --- a/seed/python-sdk/basic-auth-environment-variables/README.md +++ b/seed/python-sdk/basic-auth-environment-variables/README.md @@ -1,135 +0,0 @@ -# Seed Python Library - -[![fern shield](https://img.shields.io/badge/%F0%9F%8C%BF-SDK%20generated%20by%20Fern-brightgreen)](https://github.com/fern-api/fern) -[![pypi](https://img.shields.io/pypi/v/fern_basic-auth-environment-variables)](https://pypi.python.org/pypi/fern_basic-auth-environment-variables) - -The Seed Python library provides convenient access to the Seed API from Python. - -## Installation - -```sh -pip install fern_basic-auth-environment-variables -``` - -## Usage - -Instantiate and use the client with the following: - -```python -from seed import SeedBasicAuthEnvironmentVariables - -client = SeedBasicAuthEnvironmentVariables( - username="YOUR_USERNAME", - password="YOUR_PASSWORD", - base_url="https://yourhost.com/path/to/api", -) -client.basic_auth.post_with_basic_auth( - request={"key": "value"}, -) -``` - -## Async Client - -The SDK also exports an `async` client so that you can make non-blocking calls to our API. - -```python -import asyncio - -from seed import AsyncSeedBasicAuthEnvironmentVariables - -client = AsyncSeedBasicAuthEnvironmentVariables( - username="YOUR_USERNAME", - password="YOUR_PASSWORD", - base_url="https://yourhost.com/path/to/api", -) - - -async def main() -> None: - await client.basic_auth.post_with_basic_auth( - request={"key": "value"}, - ) - - -asyncio.run(main()) -``` - -## Exception Handling - -When the API returns a non-success status code (4xx or 5xx response), a subclass of the following error -will be thrown. - -```python -from seed.core.api_error import ApiError - -try: - client.basic_auth.post_with_basic_auth(...) -except ApiError as e: - print(e.status_code) - print(e.body) -``` - -## Advanced - -### Retries - -The SDK is instrumented with automatic retries with exponential backoff. A request will be retried as long -as the request is deemed retriable and the number of retry attempts has not grown larger than the configured -retry limit (default: 2). - -A request is deemed retriable when any of the following HTTP status codes is returned: - -- [408](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/408) (Timeout) -- [429](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/429) (Too Many Requests) -- [5XX](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/500) (Internal Server Errors) - -Use the `max_retries` request option to configure this behavior. - -```python -client.basic_auth.post_with_basic_auth(...,{ - max_retries=1 -}) -``` - -### Timeouts - -The SDK defaults to a 60 second timeout. You can configure this with a timeout option at the client or request level. - -```python - -from seed import SeedBasicAuthEnvironmentVariables - -client = SeedBasicAuthEnvironmentVariables(..., { timeout=20.0 }, ) - - -# Override timeout for a specific method -client.basic_auth.post_with_basic_auth(...,{ - timeout_in_seconds=1 -}) -``` - -### Custom Client - -You can override the `httpx` client to customize it for your use-case. Some common use-cases include support for proxies -and transports. -```python -import httpx -from seed import SeedBasicAuthEnvironmentVariables - -client = SeedBasicAuthEnvironmentVariables( - ..., - http_client=httpx.Client( - proxies="http://my.test.proxy.example.com", - transport=httpx.HTTPTransport(local_address="0.0.0.0"), - ), -) -``` - -## Contributing - -While we value open-source contributions to this SDK, this library is generated programmatically. -Additions made directly to this library would have to be moved over to our generation code, -otherwise they would be overwritten upon the next generated release. Feel free to open a PR as -a proof of concept, but know that we will not be able to merge it as-is. We suggest opening -an issue first to discuss with us! - -On the other hand, contributions to the README are always very welcome! diff --git a/seed/python-sdk/basic-auth/README.md b/seed/python-sdk/basic-auth/README.md index 4b6a11fc56f..e69de29bb2d 100644 --- a/seed/python-sdk/basic-auth/README.md +++ b/seed/python-sdk/basic-auth/README.md @@ -1,135 +0,0 @@ -# Seed Python Library - -[![fern shield](https://img.shields.io/badge/%F0%9F%8C%BF-SDK%20generated%20by%20Fern-brightgreen)](https://github.com/fern-api/fern) -[![pypi](https://img.shields.io/pypi/v/fern_basic-auth)](https://pypi.python.org/pypi/fern_basic-auth) - -The Seed Python library provides convenient access to the Seed API from Python. - -## Installation - -```sh -pip install fern_basic-auth -``` - -## Usage - -Instantiate and use the client with the following: - -```python -from seed import SeedBasicAuth - -client = SeedBasicAuth( - username="YOUR_USERNAME", - password="YOUR_PASSWORD", - base_url="https://yourhost.com/path/to/api", -) -client.basic_auth.post_with_basic_auth( - request={"key": "value"}, -) -``` - -## Async Client - -The SDK also exports an `async` client so that you can make non-blocking calls to our API. - -```python -import asyncio - -from seed import AsyncSeedBasicAuth - -client = AsyncSeedBasicAuth( - username="YOUR_USERNAME", - password="YOUR_PASSWORD", - base_url="https://yourhost.com/path/to/api", -) - - -async def main() -> None: - await client.basic_auth.post_with_basic_auth( - request={"key": "value"}, - ) - - -asyncio.run(main()) -``` - -## Exception Handling - -When the API returns a non-success status code (4xx or 5xx response), a subclass of the following error -will be thrown. - -```python -from seed.core.api_error import ApiError - -try: - client.basic_auth.post_with_basic_auth(...) -except ApiError as e: - print(e.status_code) - print(e.body) -``` - -## Advanced - -### Retries - -The SDK is instrumented with automatic retries with exponential backoff. A request will be retried as long -as the request is deemed retriable and the number of retry attempts has not grown larger than the configured -retry limit (default: 2). - -A request is deemed retriable when any of the following HTTP status codes is returned: - -- [408](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/408) (Timeout) -- [429](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/429) (Too Many Requests) -- [5XX](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/500) (Internal Server Errors) - -Use the `max_retries` request option to configure this behavior. - -```python -client.basic_auth.post_with_basic_auth(...,{ - max_retries=1 -}) -``` - -### Timeouts - -The SDK defaults to a 60 second timeout. You can configure this with a timeout option at the client or request level. - -```python - -from seed import SeedBasicAuth - -client = SeedBasicAuth(..., { timeout=20.0 }, ) - - -# Override timeout for a specific method -client.basic_auth.post_with_basic_auth(...,{ - timeout_in_seconds=1 -}) -``` - -### Custom Client - -You can override the `httpx` client to customize it for your use-case. Some common use-cases include support for proxies -and transports. -```python -import httpx -from seed import SeedBasicAuth - -client = SeedBasicAuth( - ..., - http_client=httpx.Client( - proxies="http://my.test.proxy.example.com", - transport=httpx.HTTPTransport(local_address="0.0.0.0"), - ), -) -``` - -## Contributing - -While we value open-source contributions to this SDK, this library is generated programmatically. -Additions made directly to this library would have to be moved over to our generation code, -otherwise they would be overwritten upon the next generated release. Feel free to open a PR as -a proof of concept, but know that we will not be able to merge it as-is. We suggest opening -an issue first to discuss with us! - -On the other hand, contributions to the README are always very welcome! diff --git a/seed/python-sdk/bearer-token-environment-variable/README.md b/seed/python-sdk/bearer-token-environment-variable/README.md index 7cff631017e..e69de29bb2d 100644 --- a/seed/python-sdk/bearer-token-environment-variable/README.md +++ b/seed/python-sdk/bearer-token-environment-variable/README.md @@ -1,129 +0,0 @@ -# Seed Python Library - -[![fern shield](https://img.shields.io/badge/%F0%9F%8C%BF-SDK%20generated%20by%20Fern-brightgreen)](https://github.com/fern-api/fern) -[![pypi](https://img.shields.io/pypi/v/fern_bearer-token-environment-variable)](https://pypi.python.org/pypi/fern_bearer-token-environment-variable) - -The Seed Python library provides convenient access to the Seed API from Python. - -## Installation - -```sh -pip install fern_bearer-token-environment-variable -``` - -## Usage - -Instantiate and use the client with the following: - -```python -from seed import SeedBearerTokenEnvironmentVariable - -client = SeedBearerTokenEnvironmentVariable( - api_key="YOUR_API_KEY", - base_url="https://yourhost.com/path/to/api", -) -client.service.get_with_bearer_token() -``` - -## Async Client - -The SDK also exports an `async` client so that you can make non-blocking calls to our API. - -```python -import asyncio - -from seed import AsyncSeedBearerTokenEnvironmentVariable - -client = AsyncSeedBearerTokenEnvironmentVariable( - api_key="YOUR_API_KEY", - base_url="https://yourhost.com/path/to/api", -) - - -async def main() -> None: - await client.service.get_with_bearer_token() - - -asyncio.run(main()) -``` - -## Exception Handling - -When the API returns a non-success status code (4xx or 5xx response), a subclass of the following error -will be thrown. - -```python -from seed.core.api_error import ApiError - -try: - client.service.get_with_bearer_token() -except ApiError as e: - print(e.status_code) - print(e.body) -``` - -## Advanced - -### Retries - -The SDK is instrumented with automatic retries with exponential backoff. A request will be retried as long -as the request is deemed retriable and the number of retry attempts has not grown larger than the configured -retry limit (default: 2). - -A request is deemed retriable when any of the following HTTP status codes is returned: - -- [408](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/408) (Timeout) -- [429](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/429) (Too Many Requests) -- [5XX](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/500) (Internal Server Errors) - -Use the `max_retries` request option to configure this behavior. - -```python -client.service.get_with_bearer_token({ - max_retries=1 -}) -``` - -### Timeouts - -The SDK defaults to a 60 second timeout. You can configure this with a timeout option at the client or request level. - -```python - -from seed import SeedBearerTokenEnvironmentVariable - -client = SeedBearerTokenEnvironmentVariable(..., { timeout=20.0 }, ) - - -# Override timeout for a specific method -client.service.get_with_bearer_token({ - timeout_in_seconds=1 -}) -``` - -### Custom Client - -You can override the `httpx` client to customize it for your use-case. Some common use-cases include support for proxies -and transports. -```python -import httpx -from seed import SeedBearerTokenEnvironmentVariable - -client = SeedBearerTokenEnvironmentVariable( - ..., - http_client=httpx.Client( - proxies="http://my.test.proxy.example.com", - transport=httpx.HTTPTransport(local_address="0.0.0.0"), - ), -) -``` - -## Contributing - -While we value open-source contributions to this SDK, this library is generated programmatically. -Additions made directly to this library would have to be moved over to our generation code, -otherwise they would be overwritten upon the next generated release. Feel free to open a PR as -a proof of concept, but know that we will not be able to merge it as-is. We suggest opening -an issue first to discuss with us! - -On the other hand, contributions to the README are always very welcome! diff --git a/seed/python-sdk/bytes/README.md b/seed/python-sdk/bytes/README.md index 7501e2b3131..e69de29bb2d 100644 --- a/seed/python-sdk/bytes/README.md +++ b/seed/python-sdk/bytes/README.md @@ -1,127 +0,0 @@ -# Seed Python Library - -[![fern shield](https://img.shields.io/badge/%F0%9F%8C%BF-SDK%20generated%20by%20Fern-brightgreen)](https://github.com/fern-api/fern) -[![pypi](https://img.shields.io/pypi/v/fern_bytes)](https://pypi.python.org/pypi/fern_bytes) - -The Seed Python library provides convenient access to the Seed API from Python. - -## Installation - -```sh -pip install fern_bytes -``` - -## Usage - -Instantiate and use the client with the following: - -```python -from seed import SeedBytes - -client = SeedBytes( - base_url="https://yourhost.com/path/to/api", -) -client.service.upload() -``` - -## Async Client - -The SDK also exports an `async` client so that you can make non-blocking calls to our API. - -```python -import asyncio - -from seed import AsyncSeedBytes - -client = AsyncSeedBytes( - base_url="https://yourhost.com/path/to/api", -) - - -async def main() -> None: - await client.service.upload() - - -asyncio.run(main()) -``` - -## Exception Handling - -When the API returns a non-success status code (4xx or 5xx response), a subclass of the following error -will be thrown. - -```python -from seed.core.api_error import ApiError - -try: - client.service.upload() -except ApiError as e: - print(e.status_code) - print(e.body) -``` - -## Advanced - -### Retries - -The SDK is instrumented with automatic retries with exponential backoff. A request will be retried as long -as the request is deemed retriable and the number of retry attempts has not grown larger than the configured -retry limit (default: 2). - -A request is deemed retriable when any of the following HTTP status codes is returned: - -- [408](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/408) (Timeout) -- [429](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/429) (Too Many Requests) -- [5XX](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/500) (Internal Server Errors) - -Use the `max_retries` request option to configure this behavior. - -```python -client.service.upload({ - max_retries=1 -}) -``` - -### Timeouts - -The SDK defaults to a 60 second timeout. You can configure this with a timeout option at the client or request level. - -```python - -from seed import SeedBytes - -client = SeedBytes(..., { timeout=20.0 }, ) - - -# Override timeout for a specific method -client.service.upload({ - timeout_in_seconds=1 -}) -``` - -### Custom Client - -You can override the `httpx` client to customize it for your use-case. Some common use-cases include support for proxies -and transports. -```python -import httpx -from seed import SeedBytes - -client = SeedBytes( - ..., - http_client=httpx.Client( - proxies="http://my.test.proxy.example.com", - transport=httpx.HTTPTransport(local_address="0.0.0.0"), - ), -) -``` - -## Contributing - -While we value open-source contributions to this SDK, this library is generated programmatically. -Additions made directly to this library would have to be moved over to our generation code, -otherwise they would be overwritten upon the next generated release. Feel free to open a PR as -a proof of concept, but know that we will not be able to merge it as-is. We suggest opening -an issue first to discuss with us! - -On the other hand, contributions to the README are always very welcome! diff --git a/seed/python-sdk/code-samples/README.md b/seed/python-sdk/code-samples/README.md index ef416d8feef..e69de29bb2d 100644 --- a/seed/python-sdk/code-samples/README.md +++ b/seed/python-sdk/code-samples/README.md @@ -1,131 +0,0 @@ -# Seed Python Library - -[![fern shield](https://img.shields.io/badge/%F0%9F%8C%BF-SDK%20generated%20by%20Fern-brightgreen)](https://github.com/fern-api/fern) -[![pypi](https://img.shields.io/pypi/v/fern_code-samples)](https://pypi.python.org/pypi/fern_code-samples) - -The Seed Python library provides convenient access to the Seed API from Python. - -## Installation - -```sh -pip install fern_code-samples -``` - -## Usage - -Instantiate and use the client with the following: - -```python -from seed import SeedCodeSamples - -client = SeedCodeSamples( - base_url="https://yourhost.com/path/to/api", -) -client.service.hello( - num_events=5, -) -``` - -## Async Client - -The SDK also exports an `async` client so that you can make non-blocking calls to our API. - -```python -import asyncio - -from seed import AsyncSeedCodeSamples - -client = AsyncSeedCodeSamples( - base_url="https://yourhost.com/path/to/api", -) - - -async def main() -> None: - await client.service.hello( - num_events=5, - ) - - -asyncio.run(main()) -``` - -## Exception Handling - -When the API returns a non-success status code (4xx or 5xx response), a subclass of the following error -will be thrown. - -```python -from seed.core.api_error import ApiError - -try: - client.service.hello() -except ApiError as e: - print(e.status_code) - print(e.body) -``` - -## Advanced - -### Retries - -The SDK is instrumented with automatic retries with exponential backoff. A request will be retried as long -as the request is deemed retriable and the number of retry attempts has not grown larger than the configured -retry limit (default: 2). - -A request is deemed retriable when any of the following HTTP status codes is returned: - -- [408](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/408) (Timeout) -- [429](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/429) (Too Many Requests) -- [5XX](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/500) (Internal Server Errors) - -Use the `max_retries` request option to configure this behavior. - -```python -client.service.hello({ - max_retries=1 -}) -``` - -### Timeouts - -The SDK defaults to a 60 second timeout. You can configure this with a timeout option at the client or request level. - -```python - -from seed import SeedCodeSamples - -client = SeedCodeSamples(..., { timeout=20.0 }, ) - - -# Override timeout for a specific method -client.service.hello({ - timeout_in_seconds=1 -}) -``` - -### Custom Client - -You can override the `httpx` client to customize it for your use-case. Some common use-cases include support for proxies -and transports. -```python -import httpx -from seed import SeedCodeSamples - -client = SeedCodeSamples( - ..., - http_client=httpx.Client( - proxies="http://my.test.proxy.example.com", - transport=httpx.HTTPTransport(local_address="0.0.0.0"), - ), -) -``` - -## Contributing - -While we value open-source contributions to this SDK, this library is generated programmatically. -Additions made directly to this library would have to be moved over to our generation code, -otherwise they would be overwritten upon the next generated release. Feel free to open a PR as -a proof of concept, but know that we will not be able to merge it as-is. We suggest opening -an issue first to discuss with us! - -On the other hand, contributions to the README are always very welcome! diff --git a/seed/python-sdk/custom-auth/README.md b/seed/python-sdk/custom-auth/README.md index 46a7c49ccb7..e69de29bb2d 100644 --- a/seed/python-sdk/custom-auth/README.md +++ b/seed/python-sdk/custom-auth/README.md @@ -1,133 +0,0 @@ -# Seed Python Library - -[![fern shield](https://img.shields.io/badge/%F0%9F%8C%BF-SDK%20generated%20by%20Fern-brightgreen)](https://github.com/fern-api/fern) -[![pypi](https://img.shields.io/pypi/v/fern_custom-auth)](https://pypi.python.org/pypi/fern_custom-auth) - -The Seed Python library provides convenient access to the Seed API from Python. - -## Installation - -```sh -pip install fern_custom-auth -``` - -## Usage - -Instantiate and use the client with the following: - -```python -from seed import SeedCustomAuth - -client = SeedCustomAuth( - custom_auth_scheme="YOUR_CUSTOM_AUTH_SCHEME", - base_url="https://yourhost.com/path/to/api", -) -client.custom_auth.post_with_custom_auth( - request={"key": "value"}, -) -``` - -## Async Client - -The SDK also exports an `async` client so that you can make non-blocking calls to our API. - -```python -import asyncio - -from seed import AsyncSeedCustomAuth - -client = AsyncSeedCustomAuth( - custom_auth_scheme="YOUR_CUSTOM_AUTH_SCHEME", - base_url="https://yourhost.com/path/to/api", -) - - -async def main() -> None: - await client.custom_auth.post_with_custom_auth( - request={"key": "value"}, - ) - - -asyncio.run(main()) -``` - -## Exception Handling - -When the API returns a non-success status code (4xx or 5xx response), a subclass of the following error -will be thrown. - -```python -from seed.core.api_error import ApiError - -try: - client.custom_auth.post_with_custom_auth(...) -except ApiError as e: - print(e.status_code) - print(e.body) -``` - -## Advanced - -### Retries - -The SDK is instrumented with automatic retries with exponential backoff. A request will be retried as long -as the request is deemed retriable and the number of retry attempts has not grown larger than the configured -retry limit (default: 2). - -A request is deemed retriable when any of the following HTTP status codes is returned: - -- [408](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/408) (Timeout) -- [429](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/429) (Too Many Requests) -- [5XX](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/500) (Internal Server Errors) - -Use the `max_retries` request option to configure this behavior. - -```python -client.custom_auth.post_with_custom_auth(...,{ - max_retries=1 -}) -``` - -### Timeouts - -The SDK defaults to a 60 second timeout. You can configure this with a timeout option at the client or request level. - -```python - -from seed import SeedCustomAuth - -client = SeedCustomAuth(..., { timeout=20.0 }, ) - - -# Override timeout for a specific method -client.custom_auth.post_with_custom_auth(...,{ - timeout_in_seconds=1 -}) -``` - -### Custom Client - -You can override the `httpx` client to customize it for your use-case. Some common use-cases include support for proxies -and transports. -```python -import httpx -from seed import SeedCustomAuth - -client = SeedCustomAuth( - ..., - http_client=httpx.Client( - proxies="http://my.test.proxy.example.com", - transport=httpx.HTTPTransport(local_address="0.0.0.0"), - ), -) -``` - -## Contributing - -While we value open-source contributions to this SDK, this library is generated programmatically. -Additions made directly to this library would have to be moved over to our generation code, -otherwise they would be overwritten upon the next generated release. Feel free to open a PR as -a proof of concept, but know that we will not be able to merge it as-is. We suggest opening -an issue first to discuss with us! - -On the other hand, contributions to the README are always very welcome! diff --git a/seed/python-sdk/enum/no-custom-config/README.md b/seed/python-sdk/enum/no-custom-config/README.md index 4aff2815a0c..e69de29bb2d 100644 --- a/seed/python-sdk/enum/no-custom-config/README.md +++ b/seed/python-sdk/enum/no-custom-config/README.md @@ -1,133 +0,0 @@ -# Seed Python Library - -[![fern shield](https://img.shields.io/badge/%F0%9F%8C%BF-SDK%20generated%20by%20Fern-brightgreen)](https://github.com/fern-api/fern) -[![pypi](https://img.shields.io/pypi/v/fern_enum)](https://pypi.python.org/pypi/fern_enum) - -The Seed Python library provides convenient access to the Seed API from Python. - -## Installation - -```sh -pip install fern_enum -``` - -## Usage - -Instantiate and use the client with the following: - -```python -from seed import SeedEnum - -client = SeedEnum( - base_url="https://yourhost.com/path/to/api", -) -client.inlined_request.send( - operand=">", - operand_or_color="red", -) -``` - -## Async Client - -The SDK also exports an `async` client so that you can make non-blocking calls to our API. - -```python -import asyncio - -from seed import AsyncSeedEnum - -client = AsyncSeedEnum( - base_url="https://yourhost.com/path/to/api", -) - - -async def main() -> None: - await client.inlined_request.send( - operand=">", - operand_or_color="red", - ) - - -asyncio.run(main()) -``` - -## Exception Handling - -When the API returns a non-success status code (4xx or 5xx response), a subclass of the following error -will be thrown. - -```python -from seed.core.api_error import ApiError - -try: - client.inlined_request.send(...) -except ApiError as e: - print(e.status_code) - print(e.body) -``` - -## Advanced - -### Retries - -The SDK is instrumented with automatic retries with exponential backoff. A request will be retried as long -as the request is deemed retriable and the number of retry attempts has not grown larger than the configured -retry limit (default: 2). - -A request is deemed retriable when any of the following HTTP status codes is returned: - -- [408](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/408) (Timeout) -- [429](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/429) (Too Many Requests) -- [5XX](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/500) (Internal Server Errors) - -Use the `max_retries` request option to configure this behavior. - -```python -client.inlined_request.send(...,{ - max_retries=1 -}) -``` - -### Timeouts - -The SDK defaults to a 60 second timeout. You can configure this with a timeout option at the client or request level. - -```python - -from seed import SeedEnum - -client = SeedEnum(..., { timeout=20.0 }, ) - - -# Override timeout for a specific method -client.inlined_request.send(...,{ - timeout_in_seconds=1 -}) -``` - -### Custom Client - -You can override the `httpx` client to customize it for your use-case. Some common use-cases include support for proxies -and transports. -```python -import httpx -from seed import SeedEnum - -client = SeedEnum( - ..., - http_client=httpx.Client( - proxies="http://my.test.proxy.example.com", - transport=httpx.HTTPTransport(local_address="0.0.0.0"), - ), -) -``` - -## Contributing - -While we value open-source contributions to this SDK, this library is generated programmatically. -Additions made directly to this library would have to be moved over to our generation code, -otherwise they would be overwritten upon the next generated release. Feel free to open a PR as -a proof of concept, but know that we will not be able to merge it as-is. We suggest opening -an issue first to discuss with us! - -On the other hand, contributions to the README are always very welcome! diff --git a/seed/python-sdk/enum/strenum/README.md b/seed/python-sdk/enum/strenum/README.md index 4aff2815a0c..e69de29bb2d 100644 --- a/seed/python-sdk/enum/strenum/README.md +++ b/seed/python-sdk/enum/strenum/README.md @@ -1,133 +0,0 @@ -# Seed Python Library - -[![fern shield](https://img.shields.io/badge/%F0%9F%8C%BF-SDK%20generated%20by%20Fern-brightgreen)](https://github.com/fern-api/fern) -[![pypi](https://img.shields.io/pypi/v/fern_enum)](https://pypi.python.org/pypi/fern_enum) - -The Seed Python library provides convenient access to the Seed API from Python. - -## Installation - -```sh -pip install fern_enum -``` - -## Usage - -Instantiate and use the client with the following: - -```python -from seed import SeedEnum - -client = SeedEnum( - base_url="https://yourhost.com/path/to/api", -) -client.inlined_request.send( - operand=">", - operand_or_color="red", -) -``` - -## Async Client - -The SDK also exports an `async` client so that you can make non-blocking calls to our API. - -```python -import asyncio - -from seed import AsyncSeedEnum - -client = AsyncSeedEnum( - base_url="https://yourhost.com/path/to/api", -) - - -async def main() -> None: - await client.inlined_request.send( - operand=">", - operand_or_color="red", - ) - - -asyncio.run(main()) -``` - -## Exception Handling - -When the API returns a non-success status code (4xx or 5xx response), a subclass of the following error -will be thrown. - -```python -from seed.core.api_error import ApiError - -try: - client.inlined_request.send(...) -except ApiError as e: - print(e.status_code) - print(e.body) -``` - -## Advanced - -### Retries - -The SDK is instrumented with automatic retries with exponential backoff. A request will be retried as long -as the request is deemed retriable and the number of retry attempts has not grown larger than the configured -retry limit (default: 2). - -A request is deemed retriable when any of the following HTTP status codes is returned: - -- [408](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/408) (Timeout) -- [429](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/429) (Too Many Requests) -- [5XX](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/500) (Internal Server Errors) - -Use the `max_retries` request option to configure this behavior. - -```python -client.inlined_request.send(...,{ - max_retries=1 -}) -``` - -### Timeouts - -The SDK defaults to a 60 second timeout. You can configure this with a timeout option at the client or request level. - -```python - -from seed import SeedEnum - -client = SeedEnum(..., { timeout=20.0 }, ) - - -# Override timeout for a specific method -client.inlined_request.send(...,{ - timeout_in_seconds=1 -}) -``` - -### Custom Client - -You can override the `httpx` client to customize it for your use-case. Some common use-cases include support for proxies -and transports. -```python -import httpx -from seed import SeedEnum - -client = SeedEnum( - ..., - http_client=httpx.Client( - proxies="http://my.test.proxy.example.com", - transport=httpx.HTTPTransport(local_address="0.0.0.0"), - ), -) -``` - -## Contributing - -While we value open-source contributions to this SDK, this library is generated programmatically. -Additions made directly to this library would have to be moved over to our generation code, -otherwise they would be overwritten upon the next generated release. Feel free to open a PR as -a proof of concept, but know that we will not be able to merge it as-is. We suggest opening -an issue first to discuss with us! - -On the other hand, contributions to the README are always very welcome! diff --git a/seed/python-sdk/error-property/README.md b/seed/python-sdk/error-property/README.md index b9411d2d612..e69de29bb2d 100644 --- a/seed/python-sdk/error-property/README.md +++ b/seed/python-sdk/error-property/README.md @@ -1,127 +0,0 @@ -# Seed Python Library - -[![fern shield](https://img.shields.io/badge/%F0%9F%8C%BF-SDK%20generated%20by%20Fern-brightgreen)](https://github.com/fern-api/fern) -[![pypi](https://img.shields.io/pypi/v/fern_error-property)](https://pypi.python.org/pypi/fern_error-property) - -The Seed Python library provides convenient access to the Seed API from Python. - -## Installation - -```sh -pip install fern_error-property -``` - -## Usage - -Instantiate and use the client with the following: - -```python -from seed import SeedErrorProperty - -client = SeedErrorProperty( - base_url="https://yourhost.com/path/to/api", -) -client.property_based_error.throw_error() -``` - -## Async Client - -The SDK also exports an `async` client so that you can make non-blocking calls to our API. - -```python -import asyncio - -from seed import AsyncSeedErrorProperty - -client = AsyncSeedErrorProperty( - base_url="https://yourhost.com/path/to/api", -) - - -async def main() -> None: - await client.property_based_error.throw_error() - - -asyncio.run(main()) -``` - -## Exception Handling - -When the API returns a non-success status code (4xx or 5xx response), a subclass of the following error -will be thrown. - -```python -from seed.core.api_error import ApiError - -try: - client.property_based_error.throw_error() -except ApiError as e: - print(e.status_code) - print(e.body) -``` - -## Advanced - -### Retries - -The SDK is instrumented with automatic retries with exponential backoff. A request will be retried as long -as the request is deemed retriable and the number of retry attempts has not grown larger than the configured -retry limit (default: 2). - -A request is deemed retriable when any of the following HTTP status codes is returned: - -- [408](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/408) (Timeout) -- [429](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/429) (Too Many Requests) -- [5XX](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/500) (Internal Server Errors) - -Use the `max_retries` request option to configure this behavior. - -```python -client.property_based_error.throw_error({ - max_retries=1 -}) -``` - -### Timeouts - -The SDK defaults to a 60 second timeout. You can configure this with a timeout option at the client or request level. - -```python - -from seed import SeedErrorProperty - -client = SeedErrorProperty(..., { timeout=20.0 }, ) - - -# Override timeout for a specific method -client.property_based_error.throw_error({ - timeout_in_seconds=1 -}) -``` - -### Custom Client - -You can override the `httpx` client to customize it for your use-case. Some common use-cases include support for proxies -and transports. -```python -import httpx -from seed import SeedErrorProperty - -client = SeedErrorProperty( - ..., - http_client=httpx.Client( - proxies="http://my.test.proxy.example.com", - transport=httpx.HTTPTransport(local_address="0.0.0.0"), - ), -) -``` - -## Contributing - -While we value open-source contributions to this SDK, this library is generated programmatically. -Additions made directly to this library would have to be moved over to our generation code, -otherwise they would be overwritten upon the next generated release. Feel free to open a PR as -a proof of concept, but know that we will not be able to merge it as-is. We suggest opening -an issue first to discuss with us! - -On the other hand, contributions to the README are always very welcome! diff --git a/seed/python-sdk/examples/client-filename/README.md b/seed/python-sdk/examples/client-filename/README.md index 839e193938b..e69de29bb2d 100644 --- a/seed/python-sdk/examples/client-filename/README.md +++ b/seed/python-sdk/examples/client-filename/README.md @@ -1,135 +0,0 @@ -# Seed Python Library - -[![fern shield](https://img.shields.io/badge/%F0%9F%8C%BF-SDK%20generated%20by%20Fern-brightgreen)](https://github.com/fern-api/fern) -[![pypi](https://img.shields.io/pypi/v/fern_examples)](https://pypi.python.org/pypi/fern_examples) - -The Seed Python library provides convenient access to the Seed API from Python. - -## Installation - -```sh -pip install fern_examples -``` - -## Usage - -Instantiate and use the client with the following: - -```python -from seed import SeedExhaustive -from seed.environment import SeedExhaustiveEnvironment - -client = SeedExhaustive( - token="YOUR_TOKEN", - environment=SeedExhaustiveEnvironment.PRODUCTION, -) -client.echo( - request="Hello world!\\n\\nwith\\n\\tnewlines", -) -``` - -## Async Client - -The SDK also exports an `async` client so that you can make non-blocking calls to our API. - -```python -import asyncio - -from seed import AsyncSeedExhaustive -from seed.environment import SeedExhaustiveEnvironment - -client = AsyncSeedExhaustive( - token="YOUR_TOKEN", - environment=SeedExhaustiveEnvironment.PRODUCTION, -) - - -async def main() -> None: - await client.echo( - request="Hello world!\\n\\nwith\\n\\tnewlines", - ) - - -asyncio.run(main()) -``` - -## Exception Handling - -When the API returns a non-success status code (4xx or 5xx response), a subclass of the following error -will be thrown. - -```python -from seed.core.api_error import ApiError - -try: - client.echo(...) -except ApiError as e: - print(e.status_code) - print(e.body) -``` - -## Advanced - -### Retries - -The SDK is instrumented with automatic retries with exponential backoff. A request will be retried as long -as the request is deemed retriable and the number of retry attempts has not grown larger than the configured -retry limit (default: 2). - -A request is deemed retriable when any of the following HTTP status codes is returned: - -- [408](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/408) (Timeout) -- [429](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/429) (Too Many Requests) -- [5XX](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/500) (Internal Server Errors) - -Use the `max_retries` request option to configure this behavior. - -```python -client.echo(...,{ - max_retries=1 -}) -``` - -### Timeouts - -The SDK defaults to a 60 second timeout. You can configure this with a timeout option at the client or request level. - -```python - -from seed import SeedExhaustive - -client = SeedExhaustive(..., { timeout=20.0 }, ) - - -# Override timeout for a specific method -client.echo(...,{ - timeout_in_seconds=1 -}) -``` - -### Custom Client - -You can override the `httpx` client to customize it for your use-case. Some common use-cases include support for proxies -and transports. -```python -import httpx -from seed import SeedExhaustive - -client = SeedExhaustive( - ..., - http_client=httpx.Client( - proxies="http://my.test.proxy.example.com", - transport=httpx.HTTPTransport(local_address="0.0.0.0"), - ), -) -``` - -## Contributing - -While we value open-source contributions to this SDK, this library is generated programmatically. -Additions made directly to this library would have to be moved over to our generation code, -otherwise they would be overwritten upon the next generated release. Feel free to open a PR as -a proof of concept, but know that we will not be able to merge it as-is. We suggest opening -an issue first to discuss with us! - -On the other hand, contributions to the README are always very welcome! diff --git a/seed/python-sdk/examples/no-custom-config/README.md b/seed/python-sdk/examples/no-custom-config/README.md index 6fe018df740..e69de29bb2d 100644 --- a/seed/python-sdk/examples/no-custom-config/README.md +++ b/seed/python-sdk/examples/no-custom-config/README.md @@ -1,135 +0,0 @@ -# Seed Python Library - -[![fern shield](https://img.shields.io/badge/%F0%9F%8C%BF-SDK%20generated%20by%20Fern-brightgreen)](https://github.com/fern-api/fern) -[![pypi](https://img.shields.io/pypi/v/fern_examples)](https://pypi.python.org/pypi/fern_examples) - -The Seed Python library provides convenient access to the Seed API from Python. - -## Installation - -```sh -pip install fern_examples -``` - -## Usage - -Instantiate and use the client with the following: - -```python -from seed import SeedExamples -from seed.environment import SeedExamplesEnvironment - -client = SeedExamples( - token="YOUR_TOKEN", - environment=SeedExamplesEnvironment.PRODUCTION, -) -client.echo( - request="Hello world!\\n\\nwith\\n\\tnewlines", -) -``` - -## Async Client - -The SDK also exports an `async` client so that you can make non-blocking calls to our API. - -```python -import asyncio - -from seed import AsyncSeedExamples -from seed.environment import SeedExamplesEnvironment - -client = AsyncSeedExamples( - token="YOUR_TOKEN", - environment=SeedExamplesEnvironment.PRODUCTION, -) - - -async def main() -> None: - await client.echo( - request="Hello world!\\n\\nwith\\n\\tnewlines", - ) - - -asyncio.run(main()) -``` - -## Exception Handling - -When the API returns a non-success status code (4xx or 5xx response), a subclass of the following error -will be thrown. - -```python -from seed.core.api_error import ApiError - -try: - client.echo(...) -except ApiError as e: - print(e.status_code) - print(e.body) -``` - -## Advanced - -### Retries - -The SDK is instrumented with automatic retries with exponential backoff. A request will be retried as long -as the request is deemed retriable and the number of retry attempts has not grown larger than the configured -retry limit (default: 2). - -A request is deemed retriable when any of the following HTTP status codes is returned: - -- [408](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/408) (Timeout) -- [429](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/429) (Too Many Requests) -- [5XX](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/500) (Internal Server Errors) - -Use the `max_retries` request option to configure this behavior. - -```python -client.echo(...,{ - max_retries=1 -}) -``` - -### Timeouts - -The SDK defaults to a 60 second timeout. You can configure this with a timeout option at the client or request level. - -```python - -from seed import SeedExamples - -client = SeedExamples(..., { timeout=20.0 }, ) - - -# Override timeout for a specific method -client.echo(...,{ - timeout_in_seconds=1 -}) -``` - -### Custom Client - -You can override the `httpx` client to customize it for your use-case. Some common use-cases include support for proxies -and transports. -```python -import httpx -from seed import SeedExamples - -client = SeedExamples( - ..., - http_client=httpx.Client( - proxies="http://my.test.proxy.example.com", - transport=httpx.HTTPTransport(local_address="0.0.0.0"), - ), -) -``` - -## Contributing - -While we value open-source contributions to this SDK, this library is generated programmatically. -Additions made directly to this library would have to be moved over to our generation code, -otherwise they would be overwritten upon the next generated release. Feel free to open a PR as -a proof of concept, but know that we will not be able to merge it as-is. We suggest opening -an issue first to discuss with us! - -On the other hand, contributions to the README are always very welcome! diff --git a/seed/python-sdk/examples/readme/README.md b/seed/python-sdk/examples/readme/README.md index 7b28d669927..e69de29bb2d 100644 --- a/seed/python-sdk/examples/readme/README.md +++ b/seed/python-sdk/examples/readme/README.md @@ -1,182 +0,0 @@ -# Seed Python Library - -![](https://www.fernapi.com) - -[![fern shield](https://img.shields.io/badge/%F0%9F%8C%BF-SDK%20generated%20by%20Fern-brightgreen)](https://github.com/fern-api/fern) -[![pypi](https://img.shields.io/pypi/v/fern_examples)](https://pypi.python.org/pypi/fern_examples) - -The Seed Python library provides convenient access to the Seed API from Python. - -## Documentation - -API reference documentation is available [here](https://www.docs.fernapi.com). - -## Installation - -```sh -pip install fern_examples -``` - -## Usage - -Instantiate and use the client with the following: - -```python -from seed import SeedExamples -from seed.environment import SeedExamplesEnvironment - -client = SeedExamples( - token="YOUR_TOKEN", - environment=SeedExamplesEnvironment.PRODUCTION, -) -client.service.create_movie( - id="movie-c06a4ad7", - prequel="movie-cv9b914f", - title="The Boy and the Heron", - from_="Hayao Miyazaki", - rating=8.0, - tag="tag-wf9as23d", - metadata={ - "actors": ["Christian Bale", "Florence Pugh", "Willem Dafoe"], - "releaseDate": "2023-12-08", - "ratings": {"rottenTomatoes": 97, "imdb": 7.6}, - }, -) -``` - -## Async Client - -The SDK also exports an `async` client so that you can make non-blocking calls to our API. - -```python -import asyncio - -from seed import AsyncSeedExamples -from seed.environment import SeedExamplesEnvironment - -client = AsyncSeedExamples( - token="YOUR_TOKEN", - environment=SeedExamplesEnvironment.PRODUCTION, -) - - -async def main() -> None: - await client.service.get_movie( - movie_id="movie-c06a4ad7", - ) - - -asyncio.run(main()) -``` - -```python -import asyncio - -from seed import AsyncSeedExamples -from seed.environment import SeedExamplesEnvironment - -client = AsyncSeedExamples( - token="YOUR_TOKEN", - environment=SeedExamplesEnvironment.PRODUCTION, -) - - -async def main() -> None: - await client.service.create_movie( - id="movie-c06a4ad7", - prequel="movie-cv9b914f", - title="The Boy and the Heron", - from_="Hayao Miyazaki", - rating=8.0, - tag="tag-wf9as23d", - metadata={ - "actors": ["Christian Bale", "Florence Pugh", "Willem Dafoe"], - "releaseDate": "2023-12-08", - "ratings": {"rottenTomatoes": 97, "imdb": 7.6}, - }, - ) - - -asyncio.run(main()) -``` - -## Exception Handling - -When the API returns a non-success status code (4xx or 5xx response), a subclass of the following error -will be thrown. - -```python -from seed.core.api_error import ApiError - -try: - client.service.create_movie(...) -except ApiError as e: - print(e.status_code) - print(e.body) -``` - -## Advanced - -### Retries - -The SDK is instrumented with automatic retries with exponential backoff. A request will be retried as long -as the request is deemed retriable and the number of retry attempts has not grown larger than the configured -retry limit (default: 2). - -A request is deemed retriable when any of the following HTTP status codes is returned: - -- [408](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/408) (Timeout) -- [429](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/429) (Too Many Requests) -- [5XX](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/500) (Internal Server Errors) - -Use the `max_retries` request option to configure this behavior. - -```python -client.service.create_movie(...,{ - max_retries=1 -}) -``` - -### Timeouts - -The SDK defaults to a 60 second timeout. You can configure this with a timeout option at the client or request level. - -```python - -from seed import SeedExamples - -client = SeedExamples(..., { timeout=20.0 }, ) - - -# Override timeout for a specific method -client.service.create_movie(...,{ - timeout_in_seconds=1 -}) -``` - -### Custom Client - -You can override the `httpx` client to customize it for your use-case. Some common use-cases include support for proxies -and transports. -```python -import httpx -from seed import SeedExamples - -client = SeedExamples( - ..., - http_client=httpx.Client( - proxies="http://my.test.proxy.example.com", - transport=httpx.HTTPTransport(local_address="0.0.0.0"), - ), -) -``` - -## Contributing - -While we value open-source contributions to this SDK, this library is generated programmatically. -Additions made directly to this library would have to be moved over to our generation code, -otherwise they would be overwritten upon the next generated release. Feel free to open a PR as -a proof of concept, but know that we will not be able to merge it as-is. We suggest opening -an issue first to discuss with us! - -On the other hand, contributions to the README are always very welcome! diff --git a/seed/python-sdk/exhaustive/deps_with_min_python_version/README.md b/seed/python-sdk/exhaustive/deps_with_min_python_version/README.md index f9843c1ef4a..e69de29bb2d 100644 --- a/seed/python-sdk/exhaustive/deps_with_min_python_version/README.md +++ b/seed/python-sdk/exhaustive/deps_with_min_python_version/README.md @@ -1,133 +0,0 @@ -# Seed Python Library - -[![fern shield](https://img.shields.io/badge/%F0%9F%8C%BF-SDK%20generated%20by%20Fern-brightgreen)](https://github.com/fern-api/fern) -[![pypi](https://img.shields.io/pypi/v/fern_exhaustive)](https://pypi.python.org/pypi/fern_exhaustive) - -The Seed Python library provides convenient access to the Seed API from Python. - -## Installation - -```sh -pip install fern_exhaustive -``` - -## Usage - -Instantiate and use the client with the following: - -```python -from seed import SeedExhaustive - -client = SeedExhaustive( - token="YOUR_TOKEN", - base_url="https://yourhost.com/path/to/api", -) -client.endpoints.container.get_and_return_list_of_primitives( - request=["string"], -) -``` - -## Async Client - -The SDK also exports an `async` client so that you can make non-blocking calls to our API. - -```python -import asyncio - -from seed import AsyncSeedExhaustive - -client = AsyncSeedExhaustive( - token="YOUR_TOKEN", - base_url="https://yourhost.com/path/to/api", -) - - -async def main() -> None: - await client.endpoints.container.get_and_return_list_of_primitives( - request=["string"], - ) - - -asyncio.run(main()) -``` - -## Exception Handling - -When the API returns a non-success status code (4xx or 5xx response), a subclass of the following error -will be thrown. - -```python -from seed.core.api_error import ApiError - -try: - client.endpoints.container.get_and_return_list_of_primitives(...) -except ApiError as e: - print(e.status_code) - print(e.body) -``` - -## Advanced - -### Retries - -The SDK is instrumented with automatic retries with exponential backoff. A request will be retried as long -as the request is deemed retriable and the number of retry attempts has not grown larger than the configured -retry limit (default: 2). - -A request is deemed retriable when any of the following HTTP status codes is returned: - -- [408](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/408) (Timeout) -- [429](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/429) (Too Many Requests) -- [5XX](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/500) (Internal Server Errors) - -Use the `max_retries` request option to configure this behavior. - -```python -client.endpoints.container.get_and_return_list_of_primitives(...,{ - max_retries=1 -}) -``` - -### Timeouts - -The SDK defaults to a 60 second timeout. You can configure this with a timeout option at the client or request level. - -```python - -from seed import SeedExhaustive - -client = SeedExhaustive(..., { timeout=20.0 }, ) - - -# Override timeout for a specific method -client.endpoints.container.get_and_return_list_of_primitives(...,{ - timeout_in_seconds=1 -}) -``` - -### Custom Client - -You can override the `httpx` client to customize it for your use-case. Some common use-cases include support for proxies -and transports. -```python -import httpx -from seed import SeedExhaustive - -client = SeedExhaustive( - ..., - http_client=httpx.Client( - proxies="http://my.test.proxy.example.com", - transport=httpx.HTTPTransport(local_address="0.0.0.0"), - ), -) -``` - -## Contributing - -While we value open-source contributions to this SDK, this library is generated programmatically. -Additions made directly to this library would have to be moved over to our generation code, -otherwise they would be overwritten upon the next generated release. Feel free to open a PR as -a proof of concept, but know that we will not be able to merge it as-is. We suggest opening -an issue first to discuss with us! - -On the other hand, contributions to the README are always very welcome! diff --git a/seed/python-sdk/exhaustive/extra_dependencies/README.md b/seed/python-sdk/exhaustive/extra_dependencies/README.md index f9843c1ef4a..e69de29bb2d 100644 --- a/seed/python-sdk/exhaustive/extra_dependencies/README.md +++ b/seed/python-sdk/exhaustive/extra_dependencies/README.md @@ -1,133 +0,0 @@ -# Seed Python Library - -[![fern shield](https://img.shields.io/badge/%F0%9F%8C%BF-SDK%20generated%20by%20Fern-brightgreen)](https://github.com/fern-api/fern) -[![pypi](https://img.shields.io/pypi/v/fern_exhaustive)](https://pypi.python.org/pypi/fern_exhaustive) - -The Seed Python library provides convenient access to the Seed API from Python. - -## Installation - -```sh -pip install fern_exhaustive -``` - -## Usage - -Instantiate and use the client with the following: - -```python -from seed import SeedExhaustive - -client = SeedExhaustive( - token="YOUR_TOKEN", - base_url="https://yourhost.com/path/to/api", -) -client.endpoints.container.get_and_return_list_of_primitives( - request=["string"], -) -``` - -## Async Client - -The SDK also exports an `async` client so that you can make non-blocking calls to our API. - -```python -import asyncio - -from seed import AsyncSeedExhaustive - -client = AsyncSeedExhaustive( - token="YOUR_TOKEN", - base_url="https://yourhost.com/path/to/api", -) - - -async def main() -> None: - await client.endpoints.container.get_and_return_list_of_primitives( - request=["string"], - ) - - -asyncio.run(main()) -``` - -## Exception Handling - -When the API returns a non-success status code (4xx or 5xx response), a subclass of the following error -will be thrown. - -```python -from seed.core.api_error import ApiError - -try: - client.endpoints.container.get_and_return_list_of_primitives(...) -except ApiError as e: - print(e.status_code) - print(e.body) -``` - -## Advanced - -### Retries - -The SDK is instrumented with automatic retries with exponential backoff. A request will be retried as long -as the request is deemed retriable and the number of retry attempts has not grown larger than the configured -retry limit (default: 2). - -A request is deemed retriable when any of the following HTTP status codes is returned: - -- [408](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/408) (Timeout) -- [429](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/429) (Too Many Requests) -- [5XX](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/500) (Internal Server Errors) - -Use the `max_retries` request option to configure this behavior. - -```python -client.endpoints.container.get_and_return_list_of_primitives(...,{ - max_retries=1 -}) -``` - -### Timeouts - -The SDK defaults to a 60 second timeout. You can configure this with a timeout option at the client or request level. - -```python - -from seed import SeedExhaustive - -client = SeedExhaustive(..., { timeout=20.0 }, ) - - -# Override timeout for a specific method -client.endpoints.container.get_and_return_list_of_primitives(...,{ - timeout_in_seconds=1 -}) -``` - -### Custom Client - -You can override the `httpx` client to customize it for your use-case. Some common use-cases include support for proxies -and transports. -```python -import httpx -from seed import SeedExhaustive - -client = SeedExhaustive( - ..., - http_client=httpx.Client( - proxies="http://my.test.proxy.example.com", - transport=httpx.HTTPTransport(local_address="0.0.0.0"), - ), -) -``` - -## Contributing - -While we value open-source contributions to this SDK, this library is generated programmatically. -Additions made directly to this library would have to be moved over to our generation code, -otherwise they would be overwritten upon the next generated release. Feel free to open a PR as -a proof of concept, but know that we will not be able to merge it as-is. We suggest opening -an issue first to discuss with us! - -On the other hand, contributions to the README are always very welcome! diff --git a/seed/python-sdk/exhaustive/extra_dev_dependencies/README.md b/seed/python-sdk/exhaustive/extra_dev_dependencies/README.md index f9843c1ef4a..e69de29bb2d 100644 --- a/seed/python-sdk/exhaustive/extra_dev_dependencies/README.md +++ b/seed/python-sdk/exhaustive/extra_dev_dependencies/README.md @@ -1,133 +0,0 @@ -# Seed Python Library - -[![fern shield](https://img.shields.io/badge/%F0%9F%8C%BF-SDK%20generated%20by%20Fern-brightgreen)](https://github.com/fern-api/fern) -[![pypi](https://img.shields.io/pypi/v/fern_exhaustive)](https://pypi.python.org/pypi/fern_exhaustive) - -The Seed Python library provides convenient access to the Seed API from Python. - -## Installation - -```sh -pip install fern_exhaustive -``` - -## Usage - -Instantiate and use the client with the following: - -```python -from seed import SeedExhaustive - -client = SeedExhaustive( - token="YOUR_TOKEN", - base_url="https://yourhost.com/path/to/api", -) -client.endpoints.container.get_and_return_list_of_primitives( - request=["string"], -) -``` - -## Async Client - -The SDK also exports an `async` client so that you can make non-blocking calls to our API. - -```python -import asyncio - -from seed import AsyncSeedExhaustive - -client = AsyncSeedExhaustive( - token="YOUR_TOKEN", - base_url="https://yourhost.com/path/to/api", -) - - -async def main() -> None: - await client.endpoints.container.get_and_return_list_of_primitives( - request=["string"], - ) - - -asyncio.run(main()) -``` - -## Exception Handling - -When the API returns a non-success status code (4xx or 5xx response), a subclass of the following error -will be thrown. - -```python -from seed.core.api_error import ApiError - -try: - client.endpoints.container.get_and_return_list_of_primitives(...) -except ApiError as e: - print(e.status_code) - print(e.body) -``` - -## Advanced - -### Retries - -The SDK is instrumented with automatic retries with exponential backoff. A request will be retried as long -as the request is deemed retriable and the number of retry attempts has not grown larger than the configured -retry limit (default: 2). - -A request is deemed retriable when any of the following HTTP status codes is returned: - -- [408](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/408) (Timeout) -- [429](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/429) (Too Many Requests) -- [5XX](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/500) (Internal Server Errors) - -Use the `max_retries` request option to configure this behavior. - -```python -client.endpoints.container.get_and_return_list_of_primitives(...,{ - max_retries=1 -}) -``` - -### Timeouts - -The SDK defaults to a 60 second timeout. You can configure this with a timeout option at the client or request level. - -```python - -from seed import SeedExhaustive - -client = SeedExhaustive(..., { timeout=20.0 }, ) - - -# Override timeout for a specific method -client.endpoints.container.get_and_return_list_of_primitives(...,{ - timeout_in_seconds=1 -}) -``` - -### Custom Client - -You can override the `httpx` client to customize it for your use-case. Some common use-cases include support for proxies -and transports. -```python -import httpx -from seed import SeedExhaustive - -client = SeedExhaustive( - ..., - http_client=httpx.Client( - proxies="http://my.test.proxy.example.com", - transport=httpx.HTTPTransport(local_address="0.0.0.0"), - ), -) -``` - -## Contributing - -While we value open-source contributions to this SDK, this library is generated programmatically. -Additions made directly to this library would have to be moved over to our generation code, -otherwise they would be overwritten upon the next generated release. Feel free to open a PR as -a proof of concept, but know that we will not be able to merge it as-is. We suggest opening -an issue first to discuss with us! - -On the other hand, contributions to the README are always very welcome! diff --git a/seed/python-sdk/exhaustive/five-second-timeout/README.md b/seed/python-sdk/exhaustive/five-second-timeout/README.md index f9843c1ef4a..e69de29bb2d 100644 --- a/seed/python-sdk/exhaustive/five-second-timeout/README.md +++ b/seed/python-sdk/exhaustive/five-second-timeout/README.md @@ -1,133 +0,0 @@ -# Seed Python Library - -[![fern shield](https://img.shields.io/badge/%F0%9F%8C%BF-SDK%20generated%20by%20Fern-brightgreen)](https://github.com/fern-api/fern) -[![pypi](https://img.shields.io/pypi/v/fern_exhaustive)](https://pypi.python.org/pypi/fern_exhaustive) - -The Seed Python library provides convenient access to the Seed API from Python. - -## Installation - -```sh -pip install fern_exhaustive -``` - -## Usage - -Instantiate and use the client with the following: - -```python -from seed import SeedExhaustive - -client = SeedExhaustive( - token="YOUR_TOKEN", - base_url="https://yourhost.com/path/to/api", -) -client.endpoints.container.get_and_return_list_of_primitives( - request=["string"], -) -``` - -## Async Client - -The SDK also exports an `async` client so that you can make non-blocking calls to our API. - -```python -import asyncio - -from seed import AsyncSeedExhaustive - -client = AsyncSeedExhaustive( - token="YOUR_TOKEN", - base_url="https://yourhost.com/path/to/api", -) - - -async def main() -> None: - await client.endpoints.container.get_and_return_list_of_primitives( - request=["string"], - ) - - -asyncio.run(main()) -``` - -## Exception Handling - -When the API returns a non-success status code (4xx or 5xx response), a subclass of the following error -will be thrown. - -```python -from seed.core.api_error import ApiError - -try: - client.endpoints.container.get_and_return_list_of_primitives(...) -except ApiError as e: - print(e.status_code) - print(e.body) -``` - -## Advanced - -### Retries - -The SDK is instrumented with automatic retries with exponential backoff. A request will be retried as long -as the request is deemed retriable and the number of retry attempts has not grown larger than the configured -retry limit (default: 2). - -A request is deemed retriable when any of the following HTTP status codes is returned: - -- [408](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/408) (Timeout) -- [429](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/429) (Too Many Requests) -- [5XX](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/500) (Internal Server Errors) - -Use the `max_retries` request option to configure this behavior. - -```python -client.endpoints.container.get_and_return_list_of_primitives(...,{ - max_retries=1 -}) -``` - -### Timeouts - -The SDK defaults to a 60 second timeout. You can configure this with a timeout option at the client or request level. - -```python - -from seed import SeedExhaustive - -client = SeedExhaustive(..., { timeout=20.0 }, ) - - -# Override timeout for a specific method -client.endpoints.container.get_and_return_list_of_primitives(...,{ - timeout_in_seconds=1 -}) -``` - -### Custom Client - -You can override the `httpx` client to customize it for your use-case. Some common use-cases include support for proxies -and transports. -```python -import httpx -from seed import SeedExhaustive - -client = SeedExhaustive( - ..., - http_client=httpx.Client( - proxies="http://my.test.proxy.example.com", - transport=httpx.HTTPTransport(local_address="0.0.0.0"), - ), -) -``` - -## Contributing - -While we value open-source contributions to this SDK, this library is generated programmatically. -Additions made directly to this library would have to be moved over to our generation code, -otherwise they would be overwritten upon the next generated release. Feel free to open a PR as -a proof of concept, but know that we will not be able to merge it as-is. We suggest opening -an issue first to discuss with us! - -On the other hand, contributions to the README are always very welcome! diff --git a/seed/python-sdk/exhaustive/follow_redirects_by_default/README.md b/seed/python-sdk/exhaustive/follow_redirects_by_default/README.md index f9843c1ef4a..e69de29bb2d 100644 --- a/seed/python-sdk/exhaustive/follow_redirects_by_default/README.md +++ b/seed/python-sdk/exhaustive/follow_redirects_by_default/README.md @@ -1,133 +0,0 @@ -# Seed Python Library - -[![fern shield](https://img.shields.io/badge/%F0%9F%8C%BF-SDK%20generated%20by%20Fern-brightgreen)](https://github.com/fern-api/fern) -[![pypi](https://img.shields.io/pypi/v/fern_exhaustive)](https://pypi.python.org/pypi/fern_exhaustive) - -The Seed Python library provides convenient access to the Seed API from Python. - -## Installation - -```sh -pip install fern_exhaustive -``` - -## Usage - -Instantiate and use the client with the following: - -```python -from seed import SeedExhaustive - -client = SeedExhaustive( - token="YOUR_TOKEN", - base_url="https://yourhost.com/path/to/api", -) -client.endpoints.container.get_and_return_list_of_primitives( - request=["string"], -) -``` - -## Async Client - -The SDK also exports an `async` client so that you can make non-blocking calls to our API. - -```python -import asyncio - -from seed import AsyncSeedExhaustive - -client = AsyncSeedExhaustive( - token="YOUR_TOKEN", - base_url="https://yourhost.com/path/to/api", -) - - -async def main() -> None: - await client.endpoints.container.get_and_return_list_of_primitives( - request=["string"], - ) - - -asyncio.run(main()) -``` - -## Exception Handling - -When the API returns a non-success status code (4xx or 5xx response), a subclass of the following error -will be thrown. - -```python -from seed.core.api_error import ApiError - -try: - client.endpoints.container.get_and_return_list_of_primitives(...) -except ApiError as e: - print(e.status_code) - print(e.body) -``` - -## Advanced - -### Retries - -The SDK is instrumented with automatic retries with exponential backoff. A request will be retried as long -as the request is deemed retriable and the number of retry attempts has not grown larger than the configured -retry limit (default: 2). - -A request is deemed retriable when any of the following HTTP status codes is returned: - -- [408](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/408) (Timeout) -- [429](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/429) (Too Many Requests) -- [5XX](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/500) (Internal Server Errors) - -Use the `max_retries` request option to configure this behavior. - -```python -client.endpoints.container.get_and_return_list_of_primitives(...,{ - max_retries=1 -}) -``` - -### Timeouts - -The SDK defaults to a 60 second timeout. You can configure this with a timeout option at the client or request level. - -```python - -from seed import SeedExhaustive - -client = SeedExhaustive(..., { timeout=20.0 }, ) - - -# Override timeout for a specific method -client.endpoints.container.get_and_return_list_of_primitives(...,{ - timeout_in_seconds=1 -}) -``` - -### Custom Client - -You can override the `httpx` client to customize it for your use-case. Some common use-cases include support for proxies -and transports. -```python -import httpx -from seed import SeedExhaustive - -client = SeedExhaustive( - ..., - http_client=httpx.Client( - proxies="http://my.test.proxy.example.com", - transport=httpx.HTTPTransport(local_address="0.0.0.0"), - ), -) -``` - -## Contributing - -While we value open-source contributions to this SDK, this library is generated programmatically. -Additions made directly to this library would have to be moved over to our generation code, -otherwise they would be overwritten upon the next generated release. Feel free to open a PR as -a proof of concept, but know that we will not be able to merge it as-is. We suggest opening -an issue first to discuss with us! - -On the other hand, contributions to the README are always very welcome! diff --git a/seed/python-sdk/exhaustive/improved_imports/README.md b/seed/python-sdk/exhaustive/improved_imports/README.md index f9843c1ef4a..e69de29bb2d 100644 --- a/seed/python-sdk/exhaustive/improved_imports/README.md +++ b/seed/python-sdk/exhaustive/improved_imports/README.md @@ -1,133 +0,0 @@ -# Seed Python Library - -[![fern shield](https://img.shields.io/badge/%F0%9F%8C%BF-SDK%20generated%20by%20Fern-brightgreen)](https://github.com/fern-api/fern) -[![pypi](https://img.shields.io/pypi/v/fern_exhaustive)](https://pypi.python.org/pypi/fern_exhaustive) - -The Seed Python library provides convenient access to the Seed API from Python. - -## Installation - -```sh -pip install fern_exhaustive -``` - -## Usage - -Instantiate and use the client with the following: - -```python -from seed import SeedExhaustive - -client = SeedExhaustive( - token="YOUR_TOKEN", - base_url="https://yourhost.com/path/to/api", -) -client.endpoints.container.get_and_return_list_of_primitives( - request=["string"], -) -``` - -## Async Client - -The SDK also exports an `async` client so that you can make non-blocking calls to our API. - -```python -import asyncio - -from seed import AsyncSeedExhaustive - -client = AsyncSeedExhaustive( - token="YOUR_TOKEN", - base_url="https://yourhost.com/path/to/api", -) - - -async def main() -> None: - await client.endpoints.container.get_and_return_list_of_primitives( - request=["string"], - ) - - -asyncio.run(main()) -``` - -## Exception Handling - -When the API returns a non-success status code (4xx or 5xx response), a subclass of the following error -will be thrown. - -```python -from seed.core.api_error import ApiError - -try: - client.endpoints.container.get_and_return_list_of_primitives(...) -except ApiError as e: - print(e.status_code) - print(e.body) -``` - -## Advanced - -### Retries - -The SDK is instrumented with automatic retries with exponential backoff. A request will be retried as long -as the request is deemed retriable and the number of retry attempts has not grown larger than the configured -retry limit (default: 2). - -A request is deemed retriable when any of the following HTTP status codes is returned: - -- [408](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/408) (Timeout) -- [429](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/429) (Too Many Requests) -- [5XX](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/500) (Internal Server Errors) - -Use the `max_retries` request option to configure this behavior. - -```python -client.endpoints.container.get_and_return_list_of_primitives(...,{ - max_retries=1 -}) -``` - -### Timeouts - -The SDK defaults to a 60 second timeout. You can configure this with a timeout option at the client or request level. - -```python - -from seed import SeedExhaustive - -client = SeedExhaustive(..., { timeout=20.0 }, ) - - -# Override timeout for a specific method -client.endpoints.container.get_and_return_list_of_primitives(...,{ - timeout_in_seconds=1 -}) -``` - -### Custom Client - -You can override the `httpx` client to customize it for your use-case. Some common use-cases include support for proxies -and transports. -```python -import httpx -from seed import SeedExhaustive - -client = SeedExhaustive( - ..., - http_client=httpx.Client( - proxies="http://my.test.proxy.example.com", - transport=httpx.HTTPTransport(local_address="0.0.0.0"), - ), -) -``` - -## Contributing - -While we value open-source contributions to this SDK, this library is generated programmatically. -Additions made directly to this library would have to be moved over to our generation code, -otherwise they would be overwritten upon the next generated release. Feel free to open a PR as -a proof of concept, but know that we will not be able to merge it as-is. We suggest opening -an issue first to discuss with us! - -On the other hand, contributions to the README are always very welcome! diff --git a/seed/python-sdk/exhaustive/infinite-timeout/README.md b/seed/python-sdk/exhaustive/infinite-timeout/README.md index f9843c1ef4a..e69de29bb2d 100644 --- a/seed/python-sdk/exhaustive/infinite-timeout/README.md +++ b/seed/python-sdk/exhaustive/infinite-timeout/README.md @@ -1,133 +0,0 @@ -# Seed Python Library - -[![fern shield](https://img.shields.io/badge/%F0%9F%8C%BF-SDK%20generated%20by%20Fern-brightgreen)](https://github.com/fern-api/fern) -[![pypi](https://img.shields.io/pypi/v/fern_exhaustive)](https://pypi.python.org/pypi/fern_exhaustive) - -The Seed Python library provides convenient access to the Seed API from Python. - -## Installation - -```sh -pip install fern_exhaustive -``` - -## Usage - -Instantiate and use the client with the following: - -```python -from seed import SeedExhaustive - -client = SeedExhaustive( - token="YOUR_TOKEN", - base_url="https://yourhost.com/path/to/api", -) -client.endpoints.container.get_and_return_list_of_primitives( - request=["string"], -) -``` - -## Async Client - -The SDK also exports an `async` client so that you can make non-blocking calls to our API. - -```python -import asyncio - -from seed import AsyncSeedExhaustive - -client = AsyncSeedExhaustive( - token="YOUR_TOKEN", - base_url="https://yourhost.com/path/to/api", -) - - -async def main() -> None: - await client.endpoints.container.get_and_return_list_of_primitives( - request=["string"], - ) - - -asyncio.run(main()) -``` - -## Exception Handling - -When the API returns a non-success status code (4xx or 5xx response), a subclass of the following error -will be thrown. - -```python -from seed.core.api_error import ApiError - -try: - client.endpoints.container.get_and_return_list_of_primitives(...) -except ApiError as e: - print(e.status_code) - print(e.body) -``` - -## Advanced - -### Retries - -The SDK is instrumented with automatic retries with exponential backoff. A request will be retried as long -as the request is deemed retriable and the number of retry attempts has not grown larger than the configured -retry limit (default: 2). - -A request is deemed retriable when any of the following HTTP status codes is returned: - -- [408](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/408) (Timeout) -- [429](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/429) (Too Many Requests) -- [5XX](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/500) (Internal Server Errors) - -Use the `max_retries` request option to configure this behavior. - -```python -client.endpoints.container.get_and_return_list_of_primitives(...,{ - max_retries=1 -}) -``` - -### Timeouts - -The SDK defaults to a 60 second timeout. You can configure this with a timeout option at the client or request level. - -```python - -from seed import SeedExhaustive - -client = SeedExhaustive(..., { timeout=20.0 }, ) - - -# Override timeout for a specific method -client.endpoints.container.get_and_return_list_of_primitives(...,{ - timeout_in_seconds=1 -}) -``` - -### Custom Client - -You can override the `httpx` client to customize it for your use-case. Some common use-cases include support for proxies -and transports. -```python -import httpx -from seed import SeedExhaustive - -client = SeedExhaustive( - ..., - http_client=httpx.Client( - proxies="http://my.test.proxy.example.com", - transport=httpx.HTTPTransport(local_address="0.0.0.0"), - ), -) -``` - -## Contributing - -While we value open-source contributions to this SDK, this library is generated programmatically. -Additions made directly to this library would have to be moved over to our generation code, -otherwise they would be overwritten upon the next generated release. Feel free to open a PR as -a proof of concept, but know that we will not be able to merge it as-is. We suggest opening -an issue first to discuss with us! - -On the other hand, contributions to the README are always very welcome! diff --git a/seed/python-sdk/exhaustive/inline_request_params/README.md b/seed/python-sdk/exhaustive/inline_request_params/README.md index f9843c1ef4a..e69de29bb2d 100644 --- a/seed/python-sdk/exhaustive/inline_request_params/README.md +++ b/seed/python-sdk/exhaustive/inline_request_params/README.md @@ -1,133 +0,0 @@ -# Seed Python Library - -[![fern shield](https://img.shields.io/badge/%F0%9F%8C%BF-SDK%20generated%20by%20Fern-brightgreen)](https://github.com/fern-api/fern) -[![pypi](https://img.shields.io/pypi/v/fern_exhaustive)](https://pypi.python.org/pypi/fern_exhaustive) - -The Seed Python library provides convenient access to the Seed API from Python. - -## Installation - -```sh -pip install fern_exhaustive -``` - -## Usage - -Instantiate and use the client with the following: - -```python -from seed import SeedExhaustive - -client = SeedExhaustive( - token="YOUR_TOKEN", - base_url="https://yourhost.com/path/to/api", -) -client.endpoints.container.get_and_return_list_of_primitives( - request=["string"], -) -``` - -## Async Client - -The SDK also exports an `async` client so that you can make non-blocking calls to our API. - -```python -import asyncio - -from seed import AsyncSeedExhaustive - -client = AsyncSeedExhaustive( - token="YOUR_TOKEN", - base_url="https://yourhost.com/path/to/api", -) - - -async def main() -> None: - await client.endpoints.container.get_and_return_list_of_primitives( - request=["string"], - ) - - -asyncio.run(main()) -``` - -## Exception Handling - -When the API returns a non-success status code (4xx or 5xx response), a subclass of the following error -will be thrown. - -```python -from seed.core.api_error import ApiError - -try: - client.endpoints.container.get_and_return_list_of_primitives(...) -except ApiError as e: - print(e.status_code) - print(e.body) -``` - -## Advanced - -### Retries - -The SDK is instrumented with automatic retries with exponential backoff. A request will be retried as long -as the request is deemed retriable and the number of retry attempts has not grown larger than the configured -retry limit (default: 2). - -A request is deemed retriable when any of the following HTTP status codes is returned: - -- [408](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/408) (Timeout) -- [429](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/429) (Too Many Requests) -- [5XX](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/500) (Internal Server Errors) - -Use the `max_retries` request option to configure this behavior. - -```python -client.endpoints.container.get_and_return_list_of_primitives(...,{ - max_retries=1 -}) -``` - -### Timeouts - -The SDK defaults to a 60 second timeout. You can configure this with a timeout option at the client or request level. - -```python - -from seed import SeedExhaustive - -client = SeedExhaustive(..., { timeout=20.0 }, ) - - -# Override timeout for a specific method -client.endpoints.container.get_and_return_list_of_primitives(...,{ - timeout_in_seconds=1 -}) -``` - -### Custom Client - -You can override the `httpx` client to customize it for your use-case. Some common use-cases include support for proxies -and transports. -```python -import httpx -from seed import SeedExhaustive - -client = SeedExhaustive( - ..., - http_client=httpx.Client( - proxies="http://my.test.proxy.example.com", - transport=httpx.HTTPTransport(local_address="0.0.0.0"), - ), -) -``` - -## Contributing - -While we value open-source contributions to this SDK, this library is generated programmatically. -Additions made directly to this library would have to be moved over to our generation code, -otherwise they would be overwritten upon the next generated release. Feel free to open a PR as -a proof of concept, but know that we will not be able to merge it as-is. We suggest opening -an issue first to discuss with us! - -On the other hand, contributions to the README are always very welcome! diff --git a/seed/python-sdk/exhaustive/no-custom-config/README.md b/seed/python-sdk/exhaustive/no-custom-config/README.md index f9843c1ef4a..e69de29bb2d 100644 --- a/seed/python-sdk/exhaustive/no-custom-config/README.md +++ b/seed/python-sdk/exhaustive/no-custom-config/README.md @@ -1,133 +0,0 @@ -# Seed Python Library - -[![fern shield](https://img.shields.io/badge/%F0%9F%8C%BF-SDK%20generated%20by%20Fern-brightgreen)](https://github.com/fern-api/fern) -[![pypi](https://img.shields.io/pypi/v/fern_exhaustive)](https://pypi.python.org/pypi/fern_exhaustive) - -The Seed Python library provides convenient access to the Seed API from Python. - -## Installation - -```sh -pip install fern_exhaustive -``` - -## Usage - -Instantiate and use the client with the following: - -```python -from seed import SeedExhaustive - -client = SeedExhaustive( - token="YOUR_TOKEN", - base_url="https://yourhost.com/path/to/api", -) -client.endpoints.container.get_and_return_list_of_primitives( - request=["string"], -) -``` - -## Async Client - -The SDK also exports an `async` client so that you can make non-blocking calls to our API. - -```python -import asyncio - -from seed import AsyncSeedExhaustive - -client = AsyncSeedExhaustive( - token="YOUR_TOKEN", - base_url="https://yourhost.com/path/to/api", -) - - -async def main() -> None: - await client.endpoints.container.get_and_return_list_of_primitives( - request=["string"], - ) - - -asyncio.run(main()) -``` - -## Exception Handling - -When the API returns a non-success status code (4xx or 5xx response), a subclass of the following error -will be thrown. - -```python -from seed.core.api_error import ApiError - -try: - client.endpoints.container.get_and_return_list_of_primitives(...) -except ApiError as e: - print(e.status_code) - print(e.body) -``` - -## Advanced - -### Retries - -The SDK is instrumented with automatic retries with exponential backoff. A request will be retried as long -as the request is deemed retriable and the number of retry attempts has not grown larger than the configured -retry limit (default: 2). - -A request is deemed retriable when any of the following HTTP status codes is returned: - -- [408](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/408) (Timeout) -- [429](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/429) (Too Many Requests) -- [5XX](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/500) (Internal Server Errors) - -Use the `max_retries` request option to configure this behavior. - -```python -client.endpoints.container.get_and_return_list_of_primitives(...,{ - max_retries=1 -}) -``` - -### Timeouts - -The SDK defaults to a 60 second timeout. You can configure this with a timeout option at the client or request level. - -```python - -from seed import SeedExhaustive - -client = SeedExhaustive(..., { timeout=20.0 }, ) - - -# Override timeout for a specific method -client.endpoints.container.get_and_return_list_of_primitives(...,{ - timeout_in_seconds=1 -}) -``` - -### Custom Client - -You can override the `httpx` client to customize it for your use-case. Some common use-cases include support for proxies -and transports. -```python -import httpx -from seed import SeedExhaustive - -client = SeedExhaustive( - ..., - http_client=httpx.Client( - proxies="http://my.test.proxy.example.com", - transport=httpx.HTTPTransport(local_address="0.0.0.0"), - ), -) -``` - -## Contributing - -While we value open-source contributions to this SDK, this library is generated programmatically. -Additions made directly to this library would have to be moved over to our generation code, -otherwise they would be overwritten upon the next generated release. Feel free to open a PR as -a proof of concept, but know that we will not be able to merge it as-is. We suggest opening -an issue first to discuss with us! - -On the other hand, contributions to the README are always very welcome! diff --git a/seed/python-sdk/exhaustive/pydantic-extra-fields/README.md b/seed/python-sdk/exhaustive/pydantic-extra-fields/README.md index f9843c1ef4a..e69de29bb2d 100644 --- a/seed/python-sdk/exhaustive/pydantic-extra-fields/README.md +++ b/seed/python-sdk/exhaustive/pydantic-extra-fields/README.md @@ -1,133 +0,0 @@ -# Seed Python Library - -[![fern shield](https://img.shields.io/badge/%F0%9F%8C%BF-SDK%20generated%20by%20Fern-brightgreen)](https://github.com/fern-api/fern) -[![pypi](https://img.shields.io/pypi/v/fern_exhaustive)](https://pypi.python.org/pypi/fern_exhaustive) - -The Seed Python library provides convenient access to the Seed API from Python. - -## Installation - -```sh -pip install fern_exhaustive -``` - -## Usage - -Instantiate and use the client with the following: - -```python -from seed import SeedExhaustive - -client = SeedExhaustive( - token="YOUR_TOKEN", - base_url="https://yourhost.com/path/to/api", -) -client.endpoints.container.get_and_return_list_of_primitives( - request=["string"], -) -``` - -## Async Client - -The SDK also exports an `async` client so that you can make non-blocking calls to our API. - -```python -import asyncio - -from seed import AsyncSeedExhaustive - -client = AsyncSeedExhaustive( - token="YOUR_TOKEN", - base_url="https://yourhost.com/path/to/api", -) - - -async def main() -> None: - await client.endpoints.container.get_and_return_list_of_primitives( - request=["string"], - ) - - -asyncio.run(main()) -``` - -## Exception Handling - -When the API returns a non-success status code (4xx or 5xx response), a subclass of the following error -will be thrown. - -```python -from seed.core.api_error import ApiError - -try: - client.endpoints.container.get_and_return_list_of_primitives(...) -except ApiError as e: - print(e.status_code) - print(e.body) -``` - -## Advanced - -### Retries - -The SDK is instrumented with automatic retries with exponential backoff. A request will be retried as long -as the request is deemed retriable and the number of retry attempts has not grown larger than the configured -retry limit (default: 2). - -A request is deemed retriable when any of the following HTTP status codes is returned: - -- [408](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/408) (Timeout) -- [429](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/429) (Too Many Requests) -- [5XX](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/500) (Internal Server Errors) - -Use the `max_retries` request option to configure this behavior. - -```python -client.endpoints.container.get_and_return_list_of_primitives(...,{ - max_retries=1 -}) -``` - -### Timeouts - -The SDK defaults to a 60 second timeout. You can configure this with a timeout option at the client or request level. - -```python - -from seed import SeedExhaustive - -client = SeedExhaustive(..., { timeout=20.0 }, ) - - -# Override timeout for a specific method -client.endpoints.container.get_and_return_list_of_primitives(...,{ - timeout_in_seconds=1 -}) -``` - -### Custom Client - -You can override the `httpx` client to customize it for your use-case. Some common use-cases include support for proxies -and transports. -```python -import httpx -from seed import SeedExhaustive - -client = SeedExhaustive( - ..., - http_client=httpx.Client( - proxies="http://my.test.proxy.example.com", - transport=httpx.HTTPTransport(local_address="0.0.0.0"), - ), -) -``` - -## Contributing - -While we value open-source contributions to this SDK, this library is generated programmatically. -Additions made directly to this library would have to be moved over to our generation code, -otherwise they would be overwritten upon the next generated release. Feel free to open a PR as -a proof of concept, but know that we will not be able to merge it as-is. We suggest opening -an issue first to discuss with us! - -On the other hand, contributions to the README are always very welcome! diff --git a/seed/python-sdk/exhaustive/pydantic-v1/README.md b/seed/python-sdk/exhaustive/pydantic-v1/README.md index f9843c1ef4a..e69de29bb2d 100644 --- a/seed/python-sdk/exhaustive/pydantic-v1/README.md +++ b/seed/python-sdk/exhaustive/pydantic-v1/README.md @@ -1,133 +0,0 @@ -# Seed Python Library - -[![fern shield](https://img.shields.io/badge/%F0%9F%8C%BF-SDK%20generated%20by%20Fern-brightgreen)](https://github.com/fern-api/fern) -[![pypi](https://img.shields.io/pypi/v/fern_exhaustive)](https://pypi.python.org/pypi/fern_exhaustive) - -The Seed Python library provides convenient access to the Seed API from Python. - -## Installation - -```sh -pip install fern_exhaustive -``` - -## Usage - -Instantiate and use the client with the following: - -```python -from seed import SeedExhaustive - -client = SeedExhaustive( - token="YOUR_TOKEN", - base_url="https://yourhost.com/path/to/api", -) -client.endpoints.container.get_and_return_list_of_primitives( - request=["string"], -) -``` - -## Async Client - -The SDK also exports an `async` client so that you can make non-blocking calls to our API. - -```python -import asyncio - -from seed import AsyncSeedExhaustive - -client = AsyncSeedExhaustive( - token="YOUR_TOKEN", - base_url="https://yourhost.com/path/to/api", -) - - -async def main() -> None: - await client.endpoints.container.get_and_return_list_of_primitives( - request=["string"], - ) - - -asyncio.run(main()) -``` - -## Exception Handling - -When the API returns a non-success status code (4xx or 5xx response), a subclass of the following error -will be thrown. - -```python -from seed.core.api_error import ApiError - -try: - client.endpoints.container.get_and_return_list_of_primitives(...) -except ApiError as e: - print(e.status_code) - print(e.body) -``` - -## Advanced - -### Retries - -The SDK is instrumented with automatic retries with exponential backoff. A request will be retried as long -as the request is deemed retriable and the number of retry attempts has not grown larger than the configured -retry limit (default: 2). - -A request is deemed retriable when any of the following HTTP status codes is returned: - -- [408](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/408) (Timeout) -- [429](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/429) (Too Many Requests) -- [5XX](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/500) (Internal Server Errors) - -Use the `max_retries` request option to configure this behavior. - -```python -client.endpoints.container.get_and_return_list_of_primitives(...,{ - max_retries=1 -}) -``` - -### Timeouts - -The SDK defaults to a 60 second timeout. You can configure this with a timeout option at the client or request level. - -```python - -from seed import SeedExhaustive - -client = SeedExhaustive(..., { timeout=20.0 }, ) - - -# Override timeout for a specific method -client.endpoints.container.get_and_return_list_of_primitives(...,{ - timeout_in_seconds=1 -}) -``` - -### Custom Client - -You can override the `httpx` client to customize it for your use-case. Some common use-cases include support for proxies -and transports. -```python -import httpx -from seed import SeedExhaustive - -client = SeedExhaustive( - ..., - http_client=httpx.Client( - proxies="http://my.test.proxy.example.com", - transport=httpx.HTTPTransport(local_address="0.0.0.0"), - ), -) -``` - -## Contributing - -While we value open-source contributions to this SDK, this library is generated programmatically. -Additions made directly to this library would have to be moved over to our generation code, -otherwise they would be overwritten upon the next generated release. Feel free to open a PR as -a proof of concept, but know that we will not be able to merge it as-is. We suggest opening -an issue first to discuss with us! - -On the other hand, contributions to the README are always very welcome! diff --git a/seed/python-sdk/exhaustive/skip-pydantic-validation/README.md b/seed/python-sdk/exhaustive/skip-pydantic-validation/README.md index f9843c1ef4a..e69de29bb2d 100644 --- a/seed/python-sdk/exhaustive/skip-pydantic-validation/README.md +++ b/seed/python-sdk/exhaustive/skip-pydantic-validation/README.md @@ -1,133 +0,0 @@ -# Seed Python Library - -[![fern shield](https://img.shields.io/badge/%F0%9F%8C%BF-SDK%20generated%20by%20Fern-brightgreen)](https://github.com/fern-api/fern) -[![pypi](https://img.shields.io/pypi/v/fern_exhaustive)](https://pypi.python.org/pypi/fern_exhaustive) - -The Seed Python library provides convenient access to the Seed API from Python. - -## Installation - -```sh -pip install fern_exhaustive -``` - -## Usage - -Instantiate and use the client with the following: - -```python -from seed import SeedExhaustive - -client = SeedExhaustive( - token="YOUR_TOKEN", - base_url="https://yourhost.com/path/to/api", -) -client.endpoints.container.get_and_return_list_of_primitives( - request=["string"], -) -``` - -## Async Client - -The SDK also exports an `async` client so that you can make non-blocking calls to our API. - -```python -import asyncio - -from seed import AsyncSeedExhaustive - -client = AsyncSeedExhaustive( - token="YOUR_TOKEN", - base_url="https://yourhost.com/path/to/api", -) - - -async def main() -> None: - await client.endpoints.container.get_and_return_list_of_primitives( - request=["string"], - ) - - -asyncio.run(main()) -``` - -## Exception Handling - -When the API returns a non-success status code (4xx or 5xx response), a subclass of the following error -will be thrown. - -```python -from seed.core.api_error import ApiError - -try: - client.endpoints.container.get_and_return_list_of_primitives(...) -except ApiError as e: - print(e.status_code) - print(e.body) -``` - -## Advanced - -### Retries - -The SDK is instrumented with automatic retries with exponential backoff. A request will be retried as long -as the request is deemed retriable and the number of retry attempts has not grown larger than the configured -retry limit (default: 2). - -A request is deemed retriable when any of the following HTTP status codes is returned: - -- [408](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/408) (Timeout) -- [429](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/429) (Too Many Requests) -- [5XX](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/500) (Internal Server Errors) - -Use the `max_retries` request option to configure this behavior. - -```python -client.endpoints.container.get_and_return_list_of_primitives(...,{ - max_retries=1 -}) -``` - -### Timeouts - -The SDK defaults to a 60 second timeout. You can configure this with a timeout option at the client or request level. - -```python - -from seed import SeedExhaustive - -client = SeedExhaustive(..., { timeout=20.0 }, ) - - -# Override timeout for a specific method -client.endpoints.container.get_and_return_list_of_primitives(...,{ - timeout_in_seconds=1 -}) -``` - -### Custom Client - -You can override the `httpx` client to customize it for your use-case. Some common use-cases include support for proxies -and transports. -```python -import httpx -from seed import SeedExhaustive - -client = SeedExhaustive( - ..., - http_client=httpx.Client( - proxies="http://my.test.proxy.example.com", - transport=httpx.HTTPTransport(local_address="0.0.0.0"), - ), -) -``` - -## Contributing - -While we value open-source contributions to this SDK, this library is generated programmatically. -Additions made directly to this library would have to be moved over to our generation code, -otherwise they would be overwritten upon the next generated release. Feel free to open a PR as -a proof of concept, but know that we will not be able to merge it as-is. We suggest opening -an issue first to discuss with us! - -On the other hand, contributions to the README are always very welcome! diff --git a/seed/python-sdk/exhaustive/union-utils/README.md b/seed/python-sdk/exhaustive/union-utils/README.md index f9843c1ef4a..e69de29bb2d 100644 --- a/seed/python-sdk/exhaustive/union-utils/README.md +++ b/seed/python-sdk/exhaustive/union-utils/README.md @@ -1,133 +0,0 @@ -# Seed Python Library - -[![fern shield](https://img.shields.io/badge/%F0%9F%8C%BF-SDK%20generated%20by%20Fern-brightgreen)](https://github.com/fern-api/fern) -[![pypi](https://img.shields.io/pypi/v/fern_exhaustive)](https://pypi.python.org/pypi/fern_exhaustive) - -The Seed Python library provides convenient access to the Seed API from Python. - -## Installation - -```sh -pip install fern_exhaustive -``` - -## Usage - -Instantiate and use the client with the following: - -```python -from seed import SeedExhaustive - -client = SeedExhaustive( - token="YOUR_TOKEN", - base_url="https://yourhost.com/path/to/api", -) -client.endpoints.container.get_and_return_list_of_primitives( - request=["string"], -) -``` - -## Async Client - -The SDK also exports an `async` client so that you can make non-blocking calls to our API. - -```python -import asyncio - -from seed import AsyncSeedExhaustive - -client = AsyncSeedExhaustive( - token="YOUR_TOKEN", - base_url="https://yourhost.com/path/to/api", -) - - -async def main() -> None: - await client.endpoints.container.get_and_return_list_of_primitives( - request=["string"], - ) - - -asyncio.run(main()) -``` - -## Exception Handling - -When the API returns a non-success status code (4xx or 5xx response), a subclass of the following error -will be thrown. - -```python -from seed.core.api_error import ApiError - -try: - client.endpoints.container.get_and_return_list_of_primitives(...) -except ApiError as e: - print(e.status_code) - print(e.body) -``` - -## Advanced - -### Retries - -The SDK is instrumented with automatic retries with exponential backoff. A request will be retried as long -as the request is deemed retriable and the number of retry attempts has not grown larger than the configured -retry limit (default: 2). - -A request is deemed retriable when any of the following HTTP status codes is returned: - -- [408](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/408) (Timeout) -- [429](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/429) (Too Many Requests) -- [5XX](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/500) (Internal Server Errors) - -Use the `max_retries` request option to configure this behavior. - -```python -client.endpoints.container.get_and_return_list_of_primitives(...,{ - max_retries=1 -}) -``` - -### Timeouts - -The SDK defaults to a 60 second timeout. You can configure this with a timeout option at the client or request level. - -```python - -from seed import SeedExhaustive - -client = SeedExhaustive(..., { timeout=20.0 }, ) - - -# Override timeout for a specific method -client.endpoints.container.get_and_return_list_of_primitives(...,{ - timeout_in_seconds=1 -}) -``` - -### Custom Client - -You can override the `httpx` client to customize it for your use-case. Some common use-cases include support for proxies -and transports. -```python -import httpx -from seed import SeedExhaustive - -client = SeedExhaustive( - ..., - http_client=httpx.Client( - proxies="http://my.test.proxy.example.com", - transport=httpx.HTTPTransport(local_address="0.0.0.0"), - ), -) -``` - -## Contributing - -While we value open-source contributions to this SDK, this library is generated programmatically. -Additions made directly to this library would have to be moved over to our generation code, -otherwise they would be overwritten upon the next generated release. Feel free to open a PR as -a proof of concept, but know that we will not be able to merge it as-is. We suggest opening -an issue first to discuss with us! - -On the other hand, contributions to the README are always very welcome! diff --git a/seed/python-sdk/extends/README.md b/seed/python-sdk/extends/README.md index ad3d1c6ac0e..e69de29bb2d 100644 --- a/seed/python-sdk/extends/README.md +++ b/seed/python-sdk/extends/README.md @@ -1,135 +0,0 @@ -# Seed Python Library - -[![fern shield](https://img.shields.io/badge/%F0%9F%8C%BF-SDK%20generated%20by%20Fern-brightgreen)](https://github.com/fern-api/fern) -[![pypi](https://img.shields.io/pypi/v/fern_extends)](https://pypi.python.org/pypi/fern_extends) - -The Seed Python library provides convenient access to the Seed API from Python. - -## Installation - -```sh -pip install fern_extends -``` - -## Usage - -Instantiate and use the client with the following: - -```python -from seed import SeedExtends - -client = SeedExtends( - base_url="https://yourhost.com/path/to/api", -) -client.extended_inline_request_body( - unique="string", - name="string", - docs="string", -) -``` - -## Async Client - -The SDK also exports an `async` client so that you can make non-blocking calls to our API. - -```python -import asyncio - -from seed import AsyncSeedExtends - -client = AsyncSeedExtends( - base_url="https://yourhost.com/path/to/api", -) - - -async def main() -> None: - await client.extended_inline_request_body( - unique="string", - name="string", - docs="string", - ) - - -asyncio.run(main()) -``` - -## Exception Handling - -When the API returns a non-success status code (4xx or 5xx response), a subclass of the following error -will be thrown. - -```python -from seed.core.api_error import ApiError - -try: - client.extended_inline_request_body() -except ApiError as e: - print(e.status_code) - print(e.body) -``` - -## Advanced - -### Retries - -The SDK is instrumented with automatic retries with exponential backoff. A request will be retried as long -as the request is deemed retriable and the number of retry attempts has not grown larger than the configured -retry limit (default: 2). - -A request is deemed retriable when any of the following HTTP status codes is returned: - -- [408](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/408) (Timeout) -- [429](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/429) (Too Many Requests) -- [5XX](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/500) (Internal Server Errors) - -Use the `max_retries` request option to configure this behavior. - -```python -client.extended_inline_request_body({ - max_retries=1 -}) -``` - -### Timeouts - -The SDK defaults to a 60 second timeout. You can configure this with a timeout option at the client or request level. - -```python - -from seed import SeedExtends - -client = SeedExtends(..., { timeout=20.0 }, ) - - -# Override timeout for a specific method -client.extended_inline_request_body({ - timeout_in_seconds=1 -}) -``` - -### Custom Client - -You can override the `httpx` client to customize it for your use-case. Some common use-cases include support for proxies -and transports. -```python -import httpx -from seed import SeedExtends - -client = SeedExtends( - ..., - http_client=httpx.Client( - proxies="http://my.test.proxy.example.com", - transport=httpx.HTTPTransport(local_address="0.0.0.0"), - ), -) -``` - -## Contributing - -While we value open-source contributions to this SDK, this library is generated programmatically. -Additions made directly to this library would have to be moved over to our generation code, -otherwise they would be overwritten upon the next generated release. Feel free to open a PR as -a proof of concept, but know that we will not be able to merge it as-is. We suggest opening -an issue first to discuss with us! - -On the other hand, contributions to the README are always very welcome! diff --git a/seed/python-sdk/extra-properties/README.md b/seed/python-sdk/extra-properties/README.md index 56985afc5b2..e69de29bb2d 100644 --- a/seed/python-sdk/extra-properties/README.md +++ b/seed/python-sdk/extra-properties/README.md @@ -1,131 +0,0 @@ -# Seed Python Library - -[![fern shield](https://img.shields.io/badge/%F0%9F%8C%BF-SDK%20generated%20by%20Fern-brightgreen)](https://github.com/fern-api/fern) -[![pypi](https://img.shields.io/pypi/v/fern_extra-properties)](https://pypi.python.org/pypi/fern_extra-properties) - -The Seed Python library provides convenient access to the Seed API from Python. - -## Installation - -```sh -pip install fern_extra-properties -``` - -## Usage - -Instantiate and use the client with the following: - -```python -from seed import SeedExtraProperties - -client = SeedExtraProperties( - base_url="https://yourhost.com/path/to/api", -) -client.user.create_user( - name="string", -) -``` - -## Async Client - -The SDK also exports an `async` client so that you can make non-blocking calls to our API. - -```python -import asyncio - -from seed import AsyncSeedExtraProperties - -client = AsyncSeedExtraProperties( - base_url="https://yourhost.com/path/to/api", -) - - -async def main() -> None: - await client.user.create_user( - name="string", - ) - - -asyncio.run(main()) -``` - -## Exception Handling - -When the API returns a non-success status code (4xx or 5xx response), a subclass of the following error -will be thrown. - -```python -from seed.core.api_error import ApiError - -try: - client.user.create_user() -except ApiError as e: - print(e.status_code) - print(e.body) -``` - -## Advanced - -### Retries - -The SDK is instrumented with automatic retries with exponential backoff. A request will be retried as long -as the request is deemed retriable and the number of retry attempts has not grown larger than the configured -retry limit (default: 2). - -A request is deemed retriable when any of the following HTTP status codes is returned: - -- [408](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/408) (Timeout) -- [429](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/429) (Too Many Requests) -- [5XX](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/500) (Internal Server Errors) - -Use the `max_retries` request option to configure this behavior. - -```python -client.user.create_user({ - max_retries=1 -}) -``` - -### Timeouts - -The SDK defaults to a 60 second timeout. You can configure this with a timeout option at the client or request level. - -```python - -from seed import SeedExtraProperties - -client = SeedExtraProperties(..., { timeout=20.0 }, ) - - -# Override timeout for a specific method -client.user.create_user({ - timeout_in_seconds=1 -}) -``` - -### Custom Client - -You can override the `httpx` client to customize it for your use-case. Some common use-cases include support for proxies -and transports. -```python -import httpx -from seed import SeedExtraProperties - -client = SeedExtraProperties( - ..., - http_client=httpx.Client( - proxies="http://my.test.proxy.example.com", - transport=httpx.HTTPTransport(local_address="0.0.0.0"), - ), -) -``` - -## Contributing - -While we value open-source contributions to this SDK, this library is generated programmatically. -Additions made directly to this library would have to be moved over to our generation code, -otherwise they would be overwritten upon the next generated release. Feel free to open a PR as -a proof of concept, but know that we will not be able to merge it as-is. We suggest opening -an issue first to discuss with us! - -On the other hand, contributions to the README are always very welcome! diff --git a/seed/python-sdk/file-download/README.md b/seed/python-sdk/file-download/README.md index 5f6bc44f6a1..e69de29bb2d 100644 --- a/seed/python-sdk/file-download/README.md +++ b/seed/python-sdk/file-download/README.md @@ -1,127 +0,0 @@ -# Seed Python Library - -[![fern shield](https://img.shields.io/badge/%F0%9F%8C%BF-SDK%20generated%20by%20Fern-brightgreen)](https://github.com/fern-api/fern) -[![pypi](https://img.shields.io/pypi/v/fern_file-download)](https://pypi.python.org/pypi/fern_file-download) - -The Seed Python library provides convenient access to the Seed API from Python. - -## Installation - -```sh -pip install fern_file-download -``` - -## Usage - -Instantiate and use the client with the following: - -```python -from seed import SeedFileDownload - -client = SeedFileDownload( - base_url="https://yourhost.com/path/to/api", -) -client.service.download_file() -``` - -## Async Client - -The SDK also exports an `async` client so that you can make non-blocking calls to our API. - -```python -import asyncio - -from seed import AsyncSeedFileDownload - -client = AsyncSeedFileDownload( - base_url="https://yourhost.com/path/to/api", -) - - -async def main() -> None: - await client.service.download_file() - - -asyncio.run(main()) -``` - -## Exception Handling - -When the API returns a non-success status code (4xx or 5xx response), a subclass of the following error -will be thrown. - -```python -from seed.core.api_error import ApiError - -try: - client.service.download_file() -except ApiError as e: - print(e.status_code) - print(e.body) -``` - -## Advanced - -### Retries - -The SDK is instrumented with automatic retries with exponential backoff. A request will be retried as long -as the request is deemed retriable and the number of retry attempts has not grown larger than the configured -retry limit (default: 2). - -A request is deemed retriable when any of the following HTTP status codes is returned: - -- [408](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/408) (Timeout) -- [429](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/429) (Too Many Requests) -- [5XX](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/500) (Internal Server Errors) - -Use the `max_retries` request option to configure this behavior. - -```python -client.service.download_file({ - max_retries=1 -}) -``` - -### Timeouts - -The SDK defaults to a 60 second timeout. You can configure this with a timeout option at the client or request level. - -```python - -from seed import SeedFileDownload - -client = SeedFileDownload(..., { timeout=20.0 }, ) - - -# Override timeout for a specific method -client.service.download_file({ - timeout_in_seconds=1 -}) -``` - -### Custom Client - -You can override the `httpx` client to customize it for your use-case. Some common use-cases include support for proxies -and transports. -```python -import httpx -from seed import SeedFileDownload - -client = SeedFileDownload( - ..., - http_client=httpx.Client( - proxies="http://my.test.proxy.example.com", - transport=httpx.HTTPTransport(local_address="0.0.0.0"), - ), -) -``` - -## Contributing - -While we value open-source contributions to this SDK, this library is generated programmatically. -Additions made directly to this library would have to be moved over to our generation code, -otherwise they would be overwritten upon the next generated release. Feel free to open a PR as -a proof of concept, but know that we will not be able to merge it as-is. We suggest opening -an issue first to discuss with us! - -On the other hand, contributions to the README are always very welcome! diff --git a/seed/python-sdk/file-upload/README.md b/seed/python-sdk/file-upload/README.md index 86ed80a112e..e69de29bb2d 100644 --- a/seed/python-sdk/file-upload/README.md +++ b/seed/python-sdk/file-upload/README.md @@ -1,127 +0,0 @@ -# Seed Python Library - -[![fern shield](https://img.shields.io/badge/%F0%9F%8C%BF-SDK%20generated%20by%20Fern-brightgreen)](https://github.com/fern-api/fern) -[![pypi](https://img.shields.io/pypi/v/fern_file-upload)](https://pypi.python.org/pypi/fern_file-upload) - -The Seed Python library provides convenient access to the Seed API from Python. - -## Installation - -```sh -pip install fern_file-upload -``` - -## Usage - -Instantiate and use the client with the following: - -```python -from seed import SeedFileUpload - -client = SeedFileUpload( - base_url="https://yourhost.com/path/to/api", -) -client.service.post() -``` - -## Async Client - -The SDK also exports an `async` client so that you can make non-blocking calls to our API. - -```python -import asyncio - -from seed import AsyncSeedFileUpload - -client = AsyncSeedFileUpload( - base_url="https://yourhost.com/path/to/api", -) - - -async def main() -> None: - await client.service.post() - - -asyncio.run(main()) -``` - -## Exception Handling - -When the API returns a non-success status code (4xx or 5xx response), a subclass of the following error -will be thrown. - -```python -from seed.core.api_error import ApiError - -try: - client.service.post(...) -except ApiError as e: - print(e.status_code) - print(e.body) -``` - -## Advanced - -### Retries - -The SDK is instrumented with automatic retries with exponential backoff. A request will be retried as long -as the request is deemed retriable and the number of retry attempts has not grown larger than the configured -retry limit (default: 2). - -A request is deemed retriable when any of the following HTTP status codes is returned: - -- [408](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/408) (Timeout) -- [429](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/429) (Too Many Requests) -- [5XX](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/500) (Internal Server Errors) - -Use the `max_retries` request option to configure this behavior. - -```python -client.service.post(...,{ - max_retries=1 -}) -``` - -### Timeouts - -The SDK defaults to a 60 second timeout. You can configure this with a timeout option at the client or request level. - -```python - -from seed import SeedFileUpload - -client = SeedFileUpload(..., { timeout=20.0 }, ) - - -# Override timeout for a specific method -client.service.post(...,{ - timeout_in_seconds=1 -}) -``` - -### Custom Client - -You can override the `httpx` client to customize it for your use-case. Some common use-cases include support for proxies -and transports. -```python -import httpx -from seed import SeedFileUpload - -client = SeedFileUpload( - ..., - http_client=httpx.Client( - proxies="http://my.test.proxy.example.com", - transport=httpx.HTTPTransport(local_address="0.0.0.0"), - ), -) -``` - -## Contributing - -While we value open-source contributions to this SDK, this library is generated programmatically. -Additions made directly to this library would have to be moved over to our generation code, -otherwise they would be overwritten upon the next generated release. Feel free to open a PR as -a proof of concept, but know that we will not be able to merge it as-is. We suggest opening -an issue first to discuss with us! - -On the other hand, contributions to the README are always very welcome! diff --git a/seed/python-sdk/folders/README.md b/seed/python-sdk/folders/README.md index f8336a0bd2c..e69de29bb2d 100644 --- a/seed/python-sdk/folders/README.md +++ b/seed/python-sdk/folders/README.md @@ -1,127 +0,0 @@ -# Seed Python Library - -[![fern shield](https://img.shields.io/badge/%F0%9F%8C%BF-SDK%20generated%20by%20Fern-brightgreen)](https://github.com/fern-api/fern) -[![pypi](https://img.shields.io/pypi/v/fern_folders)](https://pypi.python.org/pypi/fern_folders) - -The Seed Python library provides convenient access to the Seed API from Python. - -## Installation - -```sh -pip install fern_folders -``` - -## Usage - -Instantiate and use the client with the following: - -```python -from seed import SeedApi - -client = SeedApi( - base_url="https://yourhost.com/path/to/api", -) -client.foo() -``` - -## Async Client - -The SDK also exports an `async` client so that you can make non-blocking calls to our API. - -```python -import asyncio - -from seed import AsyncSeedApi - -client = AsyncSeedApi( - base_url="https://yourhost.com/path/to/api", -) - - -async def main() -> None: - await client.foo() - - -asyncio.run(main()) -``` - -## Exception Handling - -When the API returns a non-success status code (4xx or 5xx response), a subclass of the following error -will be thrown. - -```python -from seed.core.api_error import ApiError - -try: - client.foo(...) -except ApiError as e: - print(e.status_code) - print(e.body) -``` - -## Advanced - -### Retries - -The SDK is instrumented with automatic retries with exponential backoff. A request will be retried as long -as the request is deemed retriable and the number of retry attempts has not grown larger than the configured -retry limit (default: 2). - -A request is deemed retriable when any of the following HTTP status codes is returned: - -- [408](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/408) (Timeout) -- [429](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/429) (Too Many Requests) -- [5XX](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/500) (Internal Server Errors) - -Use the `max_retries` request option to configure this behavior. - -```python -client.foo(...,{ - max_retries=1 -}) -``` - -### Timeouts - -The SDK defaults to a 60 second timeout. You can configure this with a timeout option at the client or request level. - -```python - -from seed import SeedApi - -client = SeedApi(..., { timeout=20.0 }, ) - - -# Override timeout for a specific method -client.foo(...,{ - timeout_in_seconds=1 -}) -``` - -### Custom Client - -You can override the `httpx` client to customize it for your use-case. Some common use-cases include support for proxies -and transports. -```python -import httpx -from seed import SeedApi - -client = SeedApi( - ..., - http_client=httpx.Client( - proxies="http://my.test.proxy.example.com", - transport=httpx.HTTPTransport(local_address="0.0.0.0"), - ), -) -``` - -## Contributing - -While we value open-source contributions to this SDK, this library is generated programmatically. -Additions made directly to this library would have to be moved over to our generation code, -otherwise they would be overwritten upon the next generated release. Feel free to open a PR as -a proof of concept, but know that we will not be able to merge it as-is. We suggest opening -an issue first to discuss with us! - -On the other hand, contributions to the README are always very welcome! diff --git a/seed/python-sdk/idempotency-headers/README.md b/seed/python-sdk/idempotency-headers/README.md index 7f1bae9ec11..e69de29bb2d 100644 --- a/seed/python-sdk/idempotency-headers/README.md +++ b/seed/python-sdk/idempotency-headers/README.md @@ -1,135 +0,0 @@ -# Seed Python Library - -[![fern shield](https://img.shields.io/badge/%F0%9F%8C%BF-SDK%20generated%20by%20Fern-brightgreen)](https://github.com/fern-api/fern) -[![pypi](https://img.shields.io/pypi/v/fern_idempotency-headers)](https://pypi.python.org/pypi/fern_idempotency-headers) - -The Seed Python library provides convenient access to the Seed API from Python. - -## Installation - -```sh -pip install fern_idempotency-headers -``` - -## Usage - -Instantiate and use the client with the following: - -```python -from seed import SeedIdempotencyHeaders - -client = SeedIdempotencyHeaders( - token="YOUR_TOKEN", - base_url="https://yourhost.com/path/to/api", -) -client.payment.create( - amount=1, - currency="USD", -) -``` - -## Async Client - -The SDK also exports an `async` client so that you can make non-blocking calls to our API. - -```python -import asyncio - -from seed import AsyncSeedIdempotencyHeaders - -client = AsyncSeedIdempotencyHeaders( - token="YOUR_TOKEN", - base_url="https://yourhost.com/path/to/api", -) - - -async def main() -> None: - await client.payment.create( - amount=1, - currency="USD", - ) - - -asyncio.run(main()) -``` - -## Exception Handling - -When the API returns a non-success status code (4xx or 5xx response), a subclass of the following error -will be thrown. - -```python -from seed.core.api_error import ApiError - -try: - client.payment.create(...) -except ApiError as e: - print(e.status_code) - print(e.body) -``` - -## Advanced - -### Retries - -The SDK is instrumented with automatic retries with exponential backoff. A request will be retried as long -as the request is deemed retriable and the number of retry attempts has not grown larger than the configured -retry limit (default: 2). - -A request is deemed retriable when any of the following HTTP status codes is returned: - -- [408](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/408) (Timeout) -- [429](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/429) (Too Many Requests) -- [5XX](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/500) (Internal Server Errors) - -Use the `max_retries` request option to configure this behavior. - -```python -client.payment.create(...,{ - max_retries=1 -}) -``` - -### Timeouts - -The SDK defaults to a 60 second timeout. You can configure this with a timeout option at the client or request level. - -```python - -from seed import SeedIdempotencyHeaders - -client = SeedIdempotencyHeaders(..., { timeout=20.0 }, ) - - -# Override timeout for a specific method -client.payment.create(...,{ - timeout_in_seconds=1 -}) -``` - -### Custom Client - -You can override the `httpx` client to customize it for your use-case. Some common use-cases include support for proxies -and transports. -```python -import httpx -from seed import SeedIdempotencyHeaders - -client = SeedIdempotencyHeaders( - ..., - http_client=httpx.Client( - proxies="http://my.test.proxy.example.com", - transport=httpx.HTTPTransport(local_address="0.0.0.0"), - ), -) -``` - -## Contributing - -While we value open-source contributions to this SDK, this library is generated programmatically. -Additions made directly to this library would have to be moved over to our generation code, -otherwise they would be overwritten upon the next generated release. Feel free to open a PR as -a proof of concept, but know that we will not be able to merge it as-is. We suggest opening -an issue first to discuss with us! - -On the other hand, contributions to the README are always very welcome! diff --git a/seed/python-sdk/imdb/README.md b/seed/python-sdk/imdb/README.md index ddeb853dd7b..e69de29bb2d 100644 --- a/seed/python-sdk/imdb/README.md +++ b/seed/python-sdk/imdb/README.md @@ -1,135 +0,0 @@ -# Seed Python Library - -[![fern shield](https://img.shields.io/badge/%F0%9F%8C%BF-SDK%20generated%20by%20Fern-brightgreen)](https://github.com/fern-api/fern) -[![pypi](https://img.shields.io/pypi/v/fern_imdb)](https://pypi.python.org/pypi/fern_imdb) - -The Seed Python library provides convenient access to the Seed API from Python. - -## Installation - -```sh -pip install fern_imdb -``` - -## Usage - -Instantiate and use the client with the following: - -```python -from seed import SeedApi - -client = SeedApi( - token="YOUR_TOKEN", - base_url="https://yourhost.com/path/to/api", -) -client.imdb.create_movie( - title="string", - rating=1.1, -) -``` - -## Async Client - -The SDK also exports an `async` client so that you can make non-blocking calls to our API. - -```python -import asyncio - -from seed import AsyncSeedApi - -client = AsyncSeedApi( - token="YOUR_TOKEN", - base_url="https://yourhost.com/path/to/api", -) - - -async def main() -> None: - await client.imdb.create_movie( - title="string", - rating=1.1, - ) - - -asyncio.run(main()) -``` - -## Exception Handling - -When the API returns a non-success status code (4xx or 5xx response), a subclass of the following error -will be thrown. - -```python -from seed.core.api_error import ApiError - -try: - client.imdb.create_movie(...) -except ApiError as e: - print(e.status_code) - print(e.body) -``` - -## Advanced - -### Retries - -The SDK is instrumented with automatic retries with exponential backoff. A request will be retried as long -as the request is deemed retriable and the number of retry attempts has not grown larger than the configured -retry limit (default: 2). - -A request is deemed retriable when any of the following HTTP status codes is returned: - -- [408](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/408) (Timeout) -- [429](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/429) (Too Many Requests) -- [5XX](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/500) (Internal Server Errors) - -Use the `max_retries` request option to configure this behavior. - -```python -client.imdb.create_movie(...,{ - max_retries=1 -}) -``` - -### Timeouts - -The SDK defaults to a 60 second timeout. You can configure this with a timeout option at the client or request level. - -```python - -from seed import SeedApi - -client = SeedApi(..., { timeout=20.0 }, ) - - -# Override timeout for a specific method -client.imdb.create_movie(...,{ - timeout_in_seconds=1 -}) -``` - -### Custom Client - -You can override the `httpx` client to customize it for your use-case. Some common use-cases include support for proxies -and transports. -```python -import httpx -from seed import SeedApi - -client = SeedApi( - ..., - http_client=httpx.Client( - proxies="http://my.test.proxy.example.com", - transport=httpx.HTTPTransport(local_address="0.0.0.0"), - ), -) -``` - -## Contributing - -While we value open-source contributions to this SDK, this library is generated programmatically. -Additions made directly to this library would have to be moved over to our generation code, -otherwise they would be overwritten upon the next generated release. Feel free to open a PR as -a proof of concept, but know that we will not be able to merge it as-is. We suggest opening -an issue first to discuss with us! - -On the other hand, contributions to the README are always very welcome! diff --git a/seed/python-sdk/literal/no-custom-config/README.md b/seed/python-sdk/literal/no-custom-config/README.md index b41be124158..e69de29bb2d 100644 --- a/seed/python-sdk/literal/no-custom-config/README.md +++ b/seed/python-sdk/literal/no-custom-config/README.md @@ -1,131 +0,0 @@ -# Seed Python Library - -[![fern shield](https://img.shields.io/badge/%F0%9F%8C%BF-SDK%20generated%20by%20Fern-brightgreen)](https://github.com/fern-api/fern) -[![pypi](https://img.shields.io/pypi/v/fern_literal)](https://pypi.python.org/pypi/fern_literal) - -The Seed Python library provides convenient access to the Seed API from Python. - -## Installation - -```sh -pip install fern_literal -``` - -## Usage - -Instantiate and use the client with the following: - -```python -from seed import SeedLiteral - -client = SeedLiteral( - base_url="https://yourhost.com/path/to/api", -) -client.headers.send( - query="What is the weather today", -) -``` - -## Async Client - -The SDK also exports an `async` client so that you can make non-blocking calls to our API. - -```python -import asyncio - -from seed import AsyncSeedLiteral - -client = AsyncSeedLiteral( - base_url="https://yourhost.com/path/to/api", -) - - -async def main() -> None: - await client.headers.send( - query="What is the weather today", - ) - - -asyncio.run(main()) -``` - -## Exception Handling - -When the API returns a non-success status code (4xx or 5xx response), a subclass of the following error -will be thrown. - -```python -from seed.core.api_error import ApiError - -try: - client.headers.send(...) -except ApiError as e: - print(e.status_code) - print(e.body) -``` - -## Advanced - -### Retries - -The SDK is instrumented with automatic retries with exponential backoff. A request will be retried as long -as the request is deemed retriable and the number of retry attempts has not grown larger than the configured -retry limit (default: 2). - -A request is deemed retriable when any of the following HTTP status codes is returned: - -- [408](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/408) (Timeout) -- [429](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/429) (Too Many Requests) -- [5XX](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/500) (Internal Server Errors) - -Use the `max_retries` request option to configure this behavior. - -```python -client.headers.send(...,{ - max_retries=1 -}) -``` - -### Timeouts - -The SDK defaults to a 60 second timeout. You can configure this with a timeout option at the client or request level. - -```python - -from seed import SeedLiteral - -client = SeedLiteral(..., { timeout=20.0 }, ) - - -# Override timeout for a specific method -client.headers.send(...,{ - timeout_in_seconds=1 -}) -``` - -### Custom Client - -You can override the `httpx` client to customize it for your use-case. Some common use-cases include support for proxies -and transports. -```python -import httpx -from seed import SeedLiteral - -client = SeedLiteral( - ..., - http_client=httpx.Client( - proxies="http://my.test.proxy.example.com", - transport=httpx.HTTPTransport(local_address="0.0.0.0"), - ), -) -``` - -## Contributing - -While we value open-source contributions to this SDK, this library is generated programmatically. -Additions made directly to this library would have to be moved over to our generation code, -otherwise they would be overwritten upon the next generated release. Feel free to open a PR as -a proof of concept, but know that we will not be able to merge it as-is. We suggest opening -an issue first to discuss with us! - -On the other hand, contributions to the README are always very welcome! diff --git a/seed/python-sdk/literal/use_typeddict_requests/README.md b/seed/python-sdk/literal/use_typeddict_requests/README.md index b41be124158..e69de29bb2d 100644 --- a/seed/python-sdk/literal/use_typeddict_requests/README.md +++ b/seed/python-sdk/literal/use_typeddict_requests/README.md @@ -1,131 +0,0 @@ -# Seed Python Library - -[![fern shield](https://img.shields.io/badge/%F0%9F%8C%BF-SDK%20generated%20by%20Fern-brightgreen)](https://github.com/fern-api/fern) -[![pypi](https://img.shields.io/pypi/v/fern_literal)](https://pypi.python.org/pypi/fern_literal) - -The Seed Python library provides convenient access to the Seed API from Python. - -## Installation - -```sh -pip install fern_literal -``` - -## Usage - -Instantiate and use the client with the following: - -```python -from seed import SeedLiteral - -client = SeedLiteral( - base_url="https://yourhost.com/path/to/api", -) -client.headers.send( - query="What is the weather today", -) -``` - -## Async Client - -The SDK also exports an `async` client so that you can make non-blocking calls to our API. - -```python -import asyncio - -from seed import AsyncSeedLiteral - -client = AsyncSeedLiteral( - base_url="https://yourhost.com/path/to/api", -) - - -async def main() -> None: - await client.headers.send( - query="What is the weather today", - ) - - -asyncio.run(main()) -``` - -## Exception Handling - -When the API returns a non-success status code (4xx or 5xx response), a subclass of the following error -will be thrown. - -```python -from seed.core.api_error import ApiError - -try: - client.headers.send(...) -except ApiError as e: - print(e.status_code) - print(e.body) -``` - -## Advanced - -### Retries - -The SDK is instrumented with automatic retries with exponential backoff. A request will be retried as long -as the request is deemed retriable and the number of retry attempts has not grown larger than the configured -retry limit (default: 2). - -A request is deemed retriable when any of the following HTTP status codes is returned: - -- [408](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/408) (Timeout) -- [429](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/429) (Too Many Requests) -- [5XX](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/500) (Internal Server Errors) - -Use the `max_retries` request option to configure this behavior. - -```python -client.headers.send(...,{ - max_retries=1 -}) -``` - -### Timeouts - -The SDK defaults to a 60 second timeout. You can configure this with a timeout option at the client or request level. - -```python - -from seed import SeedLiteral - -client = SeedLiteral(..., { timeout=20.0 }, ) - - -# Override timeout for a specific method -client.headers.send(...,{ - timeout_in_seconds=1 -}) -``` - -### Custom Client - -You can override the `httpx` client to customize it for your use-case. Some common use-cases include support for proxies -and transports. -```python -import httpx -from seed import SeedLiteral - -client = SeedLiteral( - ..., - http_client=httpx.Client( - proxies="http://my.test.proxy.example.com", - transport=httpx.HTTPTransport(local_address="0.0.0.0"), - ), -) -``` - -## Contributing - -While we value open-source contributions to this SDK, this library is generated programmatically. -Additions made directly to this library would have to be moved over to our generation code, -otherwise they would be overwritten upon the next generated release. Feel free to open a PR as -a proof of concept, but know that we will not be able to merge it as-is. We suggest opening -an issue first to discuss with us! - -On the other hand, contributions to the README are always very welcome! diff --git a/seed/python-sdk/mixed-case/README.md b/seed/python-sdk/mixed-case/README.md index bd28836b3da..e69de29bb2d 100644 --- a/seed/python-sdk/mixed-case/README.md +++ b/seed/python-sdk/mixed-case/README.md @@ -1,131 +0,0 @@ -# Seed Python Library - -[![fern shield](https://img.shields.io/badge/%F0%9F%8C%BF-SDK%20generated%20by%20Fern-brightgreen)](https://github.com/fern-api/fern) -[![pypi](https://img.shields.io/pypi/v/fern_mixed-case)](https://pypi.python.org/pypi/fern_mixed-case) - -The Seed Python library provides convenient access to the Seed API from Python. - -## Installation - -```sh -pip install fern_mixed-case -``` - -## Usage - -Instantiate and use the client with the following: - -```python -from seed import SeedMixedCase - -client = SeedMixedCase( - base_url="https://yourhost.com/path/to/api", -) -client.service.get_resource( - resource_id="rsc-xyz", -) -``` - -## Async Client - -The SDK also exports an `async` client so that you can make non-blocking calls to our API. - -```python -import asyncio - -from seed import AsyncSeedMixedCase - -client = AsyncSeedMixedCase( - base_url="https://yourhost.com/path/to/api", -) - - -async def main() -> None: - await client.service.get_resource( - resource_id="rsc-xyz", - ) - - -asyncio.run(main()) -``` - -## Exception Handling - -When the API returns a non-success status code (4xx or 5xx response), a subclass of the following error -will be thrown. - -```python -from seed.core.api_error import ApiError - -try: - client.service.get_resource(...) -except ApiError as e: - print(e.status_code) - print(e.body) -``` - -## Advanced - -### Retries - -The SDK is instrumented with automatic retries with exponential backoff. A request will be retried as long -as the request is deemed retriable and the number of retry attempts has not grown larger than the configured -retry limit (default: 2). - -A request is deemed retriable when any of the following HTTP status codes is returned: - -- [408](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/408) (Timeout) -- [429](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/429) (Too Many Requests) -- [5XX](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/500) (Internal Server Errors) - -Use the `max_retries` request option to configure this behavior. - -```python -client.service.get_resource(...,{ - max_retries=1 -}) -``` - -### Timeouts - -The SDK defaults to a 60 second timeout. You can configure this with a timeout option at the client or request level. - -```python - -from seed import SeedMixedCase - -client = SeedMixedCase(..., { timeout=20.0 }, ) - - -# Override timeout for a specific method -client.service.get_resource(...,{ - timeout_in_seconds=1 -}) -``` - -### Custom Client - -You can override the `httpx` client to customize it for your use-case. Some common use-cases include support for proxies -and transports. -```python -import httpx -from seed import SeedMixedCase - -client = SeedMixedCase( - ..., - http_client=httpx.Client( - proxies="http://my.test.proxy.example.com", - transport=httpx.HTTPTransport(local_address="0.0.0.0"), - ), -) -``` - -## Contributing - -While we value open-source contributions to this SDK, this library is generated programmatically. -Additions made directly to this library would have to be moved over to our generation code, -otherwise they would be overwritten upon the next generated release. Feel free to open a PR as -a proof of concept, but know that we will not be able to merge it as-is. We suggest opening -an issue first to discuss with us! - -On the other hand, contributions to the README are always very welcome! diff --git a/seed/python-sdk/multi-line-docs/README.md b/seed/python-sdk/multi-line-docs/README.md index 4e677f766d2..e69de29bb2d 100644 --- a/seed/python-sdk/multi-line-docs/README.md +++ b/seed/python-sdk/multi-line-docs/README.md @@ -1,133 +0,0 @@ -# Seed Python Library - -[![fern shield](https://img.shields.io/badge/%F0%9F%8C%BF-SDK%20generated%20by%20Fern-brightgreen)](https://github.com/fern-api/fern) -[![pypi](https://img.shields.io/pypi/v/fern_multi-line-docs)](https://pypi.python.org/pypi/fern_multi-line-docs) - -The Seed Python library provides convenient access to the Seed API from Python. - -## Installation - -```sh -pip install fern_multi-line-docs -``` - -## Usage - -Instantiate and use the client with the following: - -```python -from seed import SeedMultiLineDocs - -client = SeedMultiLineDocs( - base_url="https://yourhost.com/path/to/api", -) -client.user.create_user( - name="string", - age=1, -) -``` - -## Async Client - -The SDK also exports an `async` client so that you can make non-blocking calls to our API. - -```python -import asyncio - -from seed import AsyncSeedMultiLineDocs - -client = AsyncSeedMultiLineDocs( - base_url="https://yourhost.com/path/to/api", -) - - -async def main() -> None: - await client.user.create_user( - name="string", - age=1, - ) - - -asyncio.run(main()) -``` - -## Exception Handling - -When the API returns a non-success status code (4xx or 5xx response), a subclass of the following error -will be thrown. - -```python -from seed.core.api_error import ApiError - -try: - client.user.create_user(...) -except ApiError as e: - print(e.status_code) - print(e.body) -``` - -## Advanced - -### Retries - -The SDK is instrumented with automatic retries with exponential backoff. A request will be retried as long -as the request is deemed retriable and the number of retry attempts has not grown larger than the configured -retry limit (default: 2). - -A request is deemed retriable when any of the following HTTP status codes is returned: - -- [408](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/408) (Timeout) -- [429](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/429) (Too Many Requests) -- [5XX](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/500) (Internal Server Errors) - -Use the `max_retries` request option to configure this behavior. - -```python -client.user.create_user(...,{ - max_retries=1 -}) -``` - -### Timeouts - -The SDK defaults to a 60 second timeout. You can configure this with a timeout option at the client or request level. - -```python - -from seed import SeedMultiLineDocs - -client = SeedMultiLineDocs(..., { timeout=20.0 }, ) - - -# Override timeout for a specific method -client.user.create_user(...,{ - timeout_in_seconds=1 -}) -``` - -### Custom Client - -You can override the `httpx` client to customize it for your use-case. Some common use-cases include support for proxies -and transports. -```python -import httpx -from seed import SeedMultiLineDocs - -client = SeedMultiLineDocs( - ..., - http_client=httpx.Client( - proxies="http://my.test.proxy.example.com", - transport=httpx.HTTPTransport(local_address="0.0.0.0"), - ), -) -``` - -## Contributing - -While we value open-source contributions to this SDK, this library is generated programmatically. -Additions made directly to this library would have to be moved over to our generation code, -otherwise they would be overwritten upon the next generated release. Feel free to open a PR as -a proof of concept, but know that we will not be able to merge it as-is. We suggest opening -an issue first to discuss with us! - -On the other hand, contributions to the README are always very welcome! diff --git a/seed/python-sdk/multi-url-environment-no-default/README.md b/seed/python-sdk/multi-url-environment-no-default/README.md index e8c306e48bc..e69de29bb2d 100644 --- a/seed/python-sdk/multi-url-environment-no-default/README.md +++ b/seed/python-sdk/multi-url-environment-no-default/README.md @@ -1,135 +0,0 @@ -# Seed Python Library - -[![fern shield](https://img.shields.io/badge/%F0%9F%8C%BF-SDK%20generated%20by%20Fern-brightgreen)](https://github.com/fern-api/fern) -[![pypi](https://img.shields.io/pypi/v/fern_multi-url-environment-no-default)](https://pypi.python.org/pypi/fern_multi-url-environment-no-default) - -The Seed Python library provides convenient access to the Seed API from Python. - -## Installation - -```sh -pip install fern_multi-url-environment-no-default -``` - -## Usage - -Instantiate and use the client with the following: - -```python -from seed import SeedMultiUrlEnvironmentNoDefault -from seed.environment import SeedMultiUrlEnvironmentNoDefaultEnvironment - -client = SeedMultiUrlEnvironmentNoDefault( - token="YOUR_TOKEN", - environment=SeedMultiUrlEnvironmentNoDefaultEnvironment.PRODUCTION, -) -client.ec_2.boot_instance( - size="string", -) -``` - -## Async Client - -The SDK also exports an `async` client so that you can make non-blocking calls to our API. - -```python -import asyncio - -from seed import AsyncSeedMultiUrlEnvironmentNoDefault -from seed.environment import SeedMultiUrlEnvironmentNoDefaultEnvironment - -client = AsyncSeedMultiUrlEnvironmentNoDefault( - token="YOUR_TOKEN", - environment=SeedMultiUrlEnvironmentNoDefaultEnvironment.PRODUCTION, -) - - -async def main() -> None: - await client.ec_2.boot_instance( - size="string", - ) - - -asyncio.run(main()) -``` - -## Exception Handling - -When the API returns a non-success status code (4xx or 5xx response), a subclass of the following error -will be thrown. - -```python -from seed.core.api_error import ApiError - -try: - client.ec_2.boot_instance(...) -except ApiError as e: - print(e.status_code) - print(e.body) -``` - -## Advanced - -### Retries - -The SDK is instrumented with automatic retries with exponential backoff. A request will be retried as long -as the request is deemed retriable and the number of retry attempts has not grown larger than the configured -retry limit (default: 2). - -A request is deemed retriable when any of the following HTTP status codes is returned: - -- [408](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/408) (Timeout) -- [429](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/429) (Too Many Requests) -- [5XX](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/500) (Internal Server Errors) - -Use the `max_retries` request option to configure this behavior. - -```python -client.ec_2.boot_instance(...,{ - max_retries=1 -}) -``` - -### Timeouts - -The SDK defaults to a 60 second timeout. You can configure this with a timeout option at the client or request level. - -```python - -from seed import SeedMultiUrlEnvironmentNoDefault - -client = SeedMultiUrlEnvironmentNoDefault(..., { timeout=20.0 }, ) - - -# Override timeout for a specific method -client.ec_2.boot_instance(...,{ - timeout_in_seconds=1 -}) -``` - -### Custom Client - -You can override the `httpx` client to customize it for your use-case. Some common use-cases include support for proxies -and transports. -```python -import httpx -from seed import SeedMultiUrlEnvironmentNoDefault - -client = SeedMultiUrlEnvironmentNoDefault( - ..., - http_client=httpx.Client( - proxies="http://my.test.proxy.example.com", - transport=httpx.HTTPTransport(local_address="0.0.0.0"), - ), -) -``` - -## Contributing - -While we value open-source contributions to this SDK, this library is generated programmatically. -Additions made directly to this library would have to be moved over to our generation code, -otherwise they would be overwritten upon the next generated release. Feel free to open a PR as -a proof of concept, but know that we will not be able to merge it as-is. We suggest opening -an issue first to discuss with us! - -On the other hand, contributions to the README are always very welcome! diff --git a/seed/python-sdk/multi-url-environment/README.md b/seed/python-sdk/multi-url-environment/README.md index 560fe2e0a56..e69de29bb2d 100644 --- a/seed/python-sdk/multi-url-environment/README.md +++ b/seed/python-sdk/multi-url-environment/README.md @@ -1,131 +0,0 @@ -# Seed Python Library - -[![fern shield](https://img.shields.io/badge/%F0%9F%8C%BF-SDK%20generated%20by%20Fern-brightgreen)](https://github.com/fern-api/fern) -[![pypi](https://img.shields.io/pypi/v/fern_multi-url-environment)](https://pypi.python.org/pypi/fern_multi-url-environment) - -The Seed Python library provides convenient access to the Seed API from Python. - -## Installation - -```sh -pip install fern_multi-url-environment -``` - -## Usage - -Instantiate and use the client with the following: - -```python -from seed import SeedMultiUrlEnvironment - -client = SeedMultiUrlEnvironment( - token="YOUR_TOKEN", -) -client.ec_2.boot_instance( - size="string", -) -``` - -## Async Client - -The SDK also exports an `async` client so that you can make non-blocking calls to our API. - -```python -import asyncio - -from seed import AsyncSeedMultiUrlEnvironment - -client = AsyncSeedMultiUrlEnvironment( - token="YOUR_TOKEN", -) - - -async def main() -> None: - await client.ec_2.boot_instance( - size="string", - ) - - -asyncio.run(main()) -``` - -## Exception Handling - -When the API returns a non-success status code (4xx or 5xx response), a subclass of the following error -will be thrown. - -```python -from seed.core.api_error import ApiError - -try: - client.ec_2.boot_instance(...) -except ApiError as e: - print(e.status_code) - print(e.body) -``` - -## Advanced - -### Retries - -The SDK is instrumented with automatic retries with exponential backoff. A request will be retried as long -as the request is deemed retriable and the number of retry attempts has not grown larger than the configured -retry limit (default: 2). - -A request is deemed retriable when any of the following HTTP status codes is returned: - -- [408](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/408) (Timeout) -- [429](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/429) (Too Many Requests) -- [5XX](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/500) (Internal Server Errors) - -Use the `max_retries` request option to configure this behavior. - -```python -client.ec_2.boot_instance(...,{ - max_retries=1 -}) -``` - -### Timeouts - -The SDK defaults to a 60 second timeout. You can configure this with a timeout option at the client or request level. - -```python - -from seed import SeedMultiUrlEnvironment - -client = SeedMultiUrlEnvironment(..., { timeout=20.0 }, ) - - -# Override timeout for a specific method -client.ec_2.boot_instance(...,{ - timeout_in_seconds=1 -}) -``` - -### Custom Client - -You can override the `httpx` client to customize it for your use-case. Some common use-cases include support for proxies -and transports. -```python -import httpx -from seed import SeedMultiUrlEnvironment - -client = SeedMultiUrlEnvironment( - ..., - http_client=httpx.Client( - proxies="http://my.test.proxy.example.com", - transport=httpx.HTTPTransport(local_address="0.0.0.0"), - ), -) -``` - -## Contributing - -While we value open-source contributions to this SDK, this library is generated programmatically. -Additions made directly to this library would have to be moved over to our generation code, -otherwise they would be overwritten upon the next generated release. Feel free to open a PR as -a proof of concept, but know that we will not be able to merge it as-is. We suggest opening -an issue first to discuss with us! - -On the other hand, contributions to the README are always very welcome! diff --git a/seed/python-sdk/no-environment/README.md b/seed/python-sdk/no-environment/README.md index 5f13dd44650..e69de29bb2d 100644 --- a/seed/python-sdk/no-environment/README.md +++ b/seed/python-sdk/no-environment/README.md @@ -1,129 +0,0 @@ -# Seed Python Library - -[![fern shield](https://img.shields.io/badge/%F0%9F%8C%BF-SDK%20generated%20by%20Fern-brightgreen)](https://github.com/fern-api/fern) -[![pypi](https://img.shields.io/pypi/v/fern_no-environment)](https://pypi.python.org/pypi/fern_no-environment) - -The Seed Python library provides convenient access to the Seed API from Python. - -## Installation - -```sh -pip install fern_no-environment -``` - -## Usage - -Instantiate and use the client with the following: - -```python -from seed import SeedNoEnvironment - -client = SeedNoEnvironment( - token="YOUR_TOKEN", - base_url="https://yourhost.com/path/to/api", -) -client.dummy.get_dummy() -``` - -## Async Client - -The SDK also exports an `async` client so that you can make non-blocking calls to our API. - -```python -import asyncio - -from seed import AsyncSeedNoEnvironment - -client = AsyncSeedNoEnvironment( - token="YOUR_TOKEN", - base_url="https://yourhost.com/path/to/api", -) - - -async def main() -> None: - await client.dummy.get_dummy() - - -asyncio.run(main()) -``` - -## Exception Handling - -When the API returns a non-success status code (4xx or 5xx response), a subclass of the following error -will be thrown. - -```python -from seed.core.api_error import ApiError - -try: - client.dummy.get_dummy() -except ApiError as e: - print(e.status_code) - print(e.body) -``` - -## Advanced - -### Retries - -The SDK is instrumented with automatic retries with exponential backoff. A request will be retried as long -as the request is deemed retriable and the number of retry attempts has not grown larger than the configured -retry limit (default: 2). - -A request is deemed retriable when any of the following HTTP status codes is returned: - -- [408](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/408) (Timeout) -- [429](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/429) (Too Many Requests) -- [5XX](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/500) (Internal Server Errors) - -Use the `max_retries` request option to configure this behavior. - -```python -client.dummy.get_dummy({ - max_retries=1 -}) -``` - -### Timeouts - -The SDK defaults to a 60 second timeout. You can configure this with a timeout option at the client or request level. - -```python - -from seed import SeedNoEnvironment - -client = SeedNoEnvironment(..., { timeout=20.0 }, ) - - -# Override timeout for a specific method -client.dummy.get_dummy({ - timeout_in_seconds=1 -}) -``` - -### Custom Client - -You can override the `httpx` client to customize it for your use-case. Some common use-cases include support for proxies -and transports. -```python -import httpx -from seed import SeedNoEnvironment - -client = SeedNoEnvironment( - ..., - http_client=httpx.Client( - proxies="http://my.test.proxy.example.com", - transport=httpx.HTTPTransport(local_address="0.0.0.0"), - ), -) -``` - -## Contributing - -While we value open-source contributions to this SDK, this library is generated programmatically. -Additions made directly to this library would have to be moved over to our generation code, -otherwise they would be overwritten upon the next generated release. Feel free to open a PR as -a proof of concept, but know that we will not be able to merge it as-is. We suggest opening -an issue first to discuss with us! - -On the other hand, contributions to the README are always very welcome! diff --git a/seed/python-sdk/oauth-client-credentials-default/README.md b/seed/python-sdk/oauth-client-credentials-default/README.md index d9545bc7524..e69de29bb2d 100644 --- a/seed/python-sdk/oauth-client-credentials-default/README.md +++ b/seed/python-sdk/oauth-client-credentials-default/README.md @@ -1,137 +0,0 @@ -# Seed Python Library - -[![fern shield](https://img.shields.io/badge/%F0%9F%8C%BF-SDK%20generated%20by%20Fern-brightgreen)](https://github.com/fern-api/fern) -[![pypi](https://img.shields.io/pypi/v/fern_oauth-client-credentials-default)](https://pypi.python.org/pypi/fern_oauth-client-credentials-default) - -The Seed Python library provides convenient access to the Seed API from Python. - -## Installation - -```sh -pip install fern_oauth-client-credentials-default -``` - -## Usage - -Instantiate and use the client with the following: - -```python -from seed import SeedOauthClientCredentialsDefault - -client = SeedOauthClientCredentialsDefault( - base_url="https://yourhost.com/path/to/api", - client_id="YOUR_CLIENT_ID", - client_secret="YOUR_CLIENT_SECRET", -) -client.auth.get_token( - client_id="string", - client_secret="string", -) -``` - -## Async Client - -The SDK also exports an `async` client so that you can make non-blocking calls to our API. - -```python -import asyncio - -from seed import AsyncSeedOauthClientCredentialsDefault - -client = AsyncSeedOauthClientCredentialsDefault( - base_url="https://yourhost.com/path/to/api", - client_id="YOUR_CLIENT_ID", - client_secret="YOUR_CLIENT_SECRET", -) - - -async def main() -> None: - await client.auth.get_token( - client_id="string", - client_secret="string", - ) - - -asyncio.run(main()) -``` - -## Exception Handling - -When the API returns a non-success status code (4xx or 5xx response), a subclass of the following error -will be thrown. - -```python -from seed.core.api_error import ApiError - -try: - client.auth.get_token() -except ApiError as e: - print(e.status_code) - print(e.body) -``` - -## Advanced - -### Retries - -The SDK is instrumented with automatic retries with exponential backoff. A request will be retried as long -as the request is deemed retriable and the number of retry attempts has not grown larger than the configured -retry limit (default: 2). - -A request is deemed retriable when any of the following HTTP status codes is returned: - -- [408](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/408) (Timeout) -- [429](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/429) (Too Many Requests) -- [5XX](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/500) (Internal Server Errors) - -Use the `max_retries` request option to configure this behavior. - -```python -client.auth.get_token({ - max_retries=1 -}) -``` - -### Timeouts - -The SDK defaults to a 60 second timeout. You can configure this with a timeout option at the client or request level. - -```python - -from seed import SeedOauthClientCredentialsDefault - -client = SeedOauthClientCredentialsDefault(..., { timeout=20.0 }, ) - - -# Override timeout for a specific method -client.auth.get_token({ - timeout_in_seconds=1 -}) -``` - -### Custom Client - -You can override the `httpx` client to customize it for your use-case. Some common use-cases include support for proxies -and transports. -```python -import httpx -from seed import SeedOauthClientCredentialsDefault - -client = SeedOauthClientCredentialsDefault( - ..., - http_client=httpx.Client( - proxies="http://my.test.proxy.example.com", - transport=httpx.HTTPTransport(local_address="0.0.0.0"), - ), -) -``` - -## Contributing - -While we value open-source contributions to this SDK, this library is generated programmatically. -Additions made directly to this library would have to be moved over to our generation code, -otherwise they would be overwritten upon the next generated release. Feel free to open a PR as -a proof of concept, but know that we will not be able to merge it as-is. We suggest opening -an issue first to discuss with us! - -On the other hand, contributions to the README are always very welcome! diff --git a/seed/python-sdk/oauth-client-credentials-environment-variables/README.md b/seed/python-sdk/oauth-client-credentials-environment-variables/README.md index 288ea72a910..e69de29bb2d 100644 --- a/seed/python-sdk/oauth-client-credentials-environment-variables/README.md +++ b/seed/python-sdk/oauth-client-credentials-environment-variables/README.md @@ -1,139 +0,0 @@ -# Seed Python Library - -[![fern shield](https://img.shields.io/badge/%F0%9F%8C%BF-SDK%20generated%20by%20Fern-brightgreen)](https://github.com/fern-api/fern) -[![pypi](https://img.shields.io/pypi/v/fern_oauth-client-credentials-environment-variables)](https://pypi.python.org/pypi/fern_oauth-client-credentials-environment-variables) - -The Seed Python library provides convenient access to the Seed API from Python. - -## Installation - -```sh -pip install fern_oauth-client-credentials-environment-variables -``` - -## Usage - -Instantiate and use the client with the following: - -```python -from seed import SeedOauthClientCredentialsEnvironmentVariables - -client = SeedOauthClientCredentialsEnvironmentVariables( - base_url="https://yourhost.com/path/to/api", - client_id="YOUR_CLIENT_ID", - client_secret="YOUR_CLIENT_SECRET", -) -client.auth.get_token_with_client_credentials( - client_id="string", - client_secret="string", - scope="string", -) -``` - -## Async Client - -The SDK also exports an `async` client so that you can make non-blocking calls to our API. - -```python -import asyncio - -from seed import AsyncSeedOauthClientCredentialsEnvironmentVariables - -client = AsyncSeedOauthClientCredentialsEnvironmentVariables( - base_url="https://yourhost.com/path/to/api", - client_id="YOUR_CLIENT_ID", - client_secret="YOUR_CLIENT_SECRET", -) - - -async def main() -> None: - await client.auth.get_token_with_client_credentials( - client_id="string", - client_secret="string", - scope="string", - ) - - -asyncio.run(main()) -``` - -## Exception Handling - -When the API returns a non-success status code (4xx or 5xx response), a subclass of the following error -will be thrown. - -```python -from seed.core.api_error import ApiError - -try: - client.auth.get_token_with_client_credentials(...) -except ApiError as e: - print(e.status_code) - print(e.body) -``` - -## Advanced - -### Retries - -The SDK is instrumented with automatic retries with exponential backoff. A request will be retried as long -as the request is deemed retriable and the number of retry attempts has not grown larger than the configured -retry limit (default: 2). - -A request is deemed retriable when any of the following HTTP status codes is returned: - -- [408](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/408) (Timeout) -- [429](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/429) (Too Many Requests) -- [5XX](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/500) (Internal Server Errors) - -Use the `max_retries` request option to configure this behavior. - -```python -client.auth.get_token_with_client_credentials(...,{ - max_retries=1 -}) -``` - -### Timeouts - -The SDK defaults to a 60 second timeout. You can configure this with a timeout option at the client or request level. - -```python - -from seed import SeedOauthClientCredentialsEnvironmentVariables - -client = SeedOauthClientCredentialsEnvironmentVariables(..., { timeout=20.0 }, ) - - -# Override timeout for a specific method -client.auth.get_token_with_client_credentials(...,{ - timeout_in_seconds=1 -}) -``` - -### Custom Client - -You can override the `httpx` client to customize it for your use-case. Some common use-cases include support for proxies -and transports. -```python -import httpx -from seed import SeedOauthClientCredentialsEnvironmentVariables - -client = SeedOauthClientCredentialsEnvironmentVariables( - ..., - http_client=httpx.Client( - proxies="http://my.test.proxy.example.com", - transport=httpx.HTTPTransport(local_address="0.0.0.0"), - ), -) -``` - -## Contributing - -While we value open-source contributions to this SDK, this library is generated programmatically. -Additions made directly to this library would have to be moved over to our generation code, -otherwise they would be overwritten upon the next generated release. Feel free to open a PR as -a proof of concept, but know that we will not be able to merge it as-is. We suggest opening -an issue first to discuss with us! - -On the other hand, contributions to the README are always very welcome! diff --git a/seed/python-sdk/oauth-client-credentials-nested-root/README.md b/seed/python-sdk/oauth-client-credentials-nested-root/README.md index 42f544f9175..e69de29bb2d 100644 --- a/seed/python-sdk/oauth-client-credentials-nested-root/README.md +++ b/seed/python-sdk/oauth-client-credentials-nested-root/README.md @@ -1,139 +0,0 @@ -# Seed Python Library - -[![fern shield](https://img.shields.io/badge/%F0%9F%8C%BF-SDK%20generated%20by%20Fern-brightgreen)](https://github.com/fern-api/fern) -[![pypi](https://img.shields.io/pypi/v/fern_oauth-client-credentials-nested-root)](https://pypi.python.org/pypi/fern_oauth-client-credentials-nested-root) - -The Seed Python library provides convenient access to the Seed API from Python. - -## Installation - -```sh -pip install fern_oauth-client-credentials-nested-root -``` - -## Usage - -Instantiate and use the client with the following: - -```python -from seed import SeedOauthClientCredentials - -client = SeedOauthClientCredentials( - base_url="https://yourhost.com/path/to/api", - client_id="YOUR_CLIENT_ID", - client_secret="YOUR_CLIENT_SECRET", -) -client.auth.get_token( - client_id="string", - client_secret="string", - scope="string", -) -``` - -## Async Client - -The SDK also exports an `async` client so that you can make non-blocking calls to our API. - -```python -import asyncio - -from seed import AsyncSeedOauthClientCredentials - -client = AsyncSeedOauthClientCredentials( - base_url="https://yourhost.com/path/to/api", - client_id="YOUR_CLIENT_ID", - client_secret="YOUR_CLIENT_SECRET", -) - - -async def main() -> None: - await client.auth.get_token( - client_id="string", - client_secret="string", - scope="string", - ) - - -asyncio.run(main()) -``` - -## Exception Handling - -When the API returns a non-success status code (4xx or 5xx response), a subclass of the following error -will be thrown. - -```python -from seed.core.api_error import ApiError - -try: - client.auth.get_token() -except ApiError as e: - print(e.status_code) - print(e.body) -``` - -## Advanced - -### Retries - -The SDK is instrumented with automatic retries with exponential backoff. A request will be retried as long -as the request is deemed retriable and the number of retry attempts has not grown larger than the configured -retry limit (default: 2). - -A request is deemed retriable when any of the following HTTP status codes is returned: - -- [408](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/408) (Timeout) -- [429](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/429) (Too Many Requests) -- [5XX](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/500) (Internal Server Errors) - -Use the `max_retries` request option to configure this behavior. - -```python -client.auth.get_token({ - max_retries=1 -}) -``` - -### Timeouts - -The SDK defaults to a 60 second timeout. You can configure this with a timeout option at the client or request level. - -```python - -from seed import SeedOauthClientCredentials - -client = SeedOauthClientCredentials(..., { timeout=20.0 }, ) - - -# Override timeout for a specific method -client.auth.get_token({ - timeout_in_seconds=1 -}) -``` - -### Custom Client - -You can override the `httpx` client to customize it for your use-case. Some common use-cases include support for proxies -and transports. -```python -import httpx -from seed import SeedOauthClientCredentials - -client = SeedOauthClientCredentials( - ..., - http_client=httpx.Client( - proxies="http://my.test.proxy.example.com", - transport=httpx.HTTPTransport(local_address="0.0.0.0"), - ), -) -``` - -## Contributing - -While we value open-source contributions to this SDK, this library is generated programmatically. -Additions made directly to this library would have to be moved over to our generation code, -otherwise they would be overwritten upon the next generated release. Feel free to open a PR as -a proof of concept, but know that we will not be able to merge it as-is. We suggest opening -an issue first to discuss with us! - -On the other hand, contributions to the README are always very welcome! diff --git a/seed/python-sdk/oauth-client-credentials/README.md b/seed/python-sdk/oauth-client-credentials/README.md index 0d54b3d5efd..e69de29bb2d 100644 --- a/seed/python-sdk/oauth-client-credentials/README.md +++ b/seed/python-sdk/oauth-client-credentials/README.md @@ -1,139 +0,0 @@ -# Seed Python Library - -[![fern shield](https://img.shields.io/badge/%F0%9F%8C%BF-SDK%20generated%20by%20Fern-brightgreen)](https://github.com/fern-api/fern) -[![pypi](https://img.shields.io/pypi/v/fern_oauth-client-credentials)](https://pypi.python.org/pypi/fern_oauth-client-credentials) - -The Seed Python library provides convenient access to the Seed API from Python. - -## Installation - -```sh -pip install fern_oauth-client-credentials -``` - -## Usage - -Instantiate and use the client with the following: - -```python -from seed import SeedOauthClientCredentials - -client = SeedOauthClientCredentials( - base_url="https://yourhost.com/path/to/api", - client_id="YOUR_CLIENT_ID", - client_secret="YOUR_CLIENT_SECRET", -) -client.auth.get_token_with_client_credentials( - client_id="string", - client_secret="string", - scope="string", -) -``` - -## Async Client - -The SDK also exports an `async` client so that you can make non-blocking calls to our API. - -```python -import asyncio - -from seed import AsyncSeedOauthClientCredentials - -client = AsyncSeedOauthClientCredentials( - base_url="https://yourhost.com/path/to/api", - client_id="YOUR_CLIENT_ID", - client_secret="YOUR_CLIENT_SECRET", -) - - -async def main() -> None: - await client.auth.get_token_with_client_credentials( - client_id="string", - client_secret="string", - scope="string", - ) - - -asyncio.run(main()) -``` - -## Exception Handling - -When the API returns a non-success status code (4xx or 5xx response), a subclass of the following error -will be thrown. - -```python -from seed.core.api_error import ApiError - -try: - client.auth.get_token_with_client_credentials(...) -except ApiError as e: - print(e.status_code) - print(e.body) -``` - -## Advanced - -### Retries - -The SDK is instrumented with automatic retries with exponential backoff. A request will be retried as long -as the request is deemed retriable and the number of retry attempts has not grown larger than the configured -retry limit (default: 2). - -A request is deemed retriable when any of the following HTTP status codes is returned: - -- [408](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/408) (Timeout) -- [429](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/429) (Too Many Requests) -- [5XX](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/500) (Internal Server Errors) - -Use the `max_retries` request option to configure this behavior. - -```python -client.auth.get_token_with_client_credentials(...,{ - max_retries=1 -}) -``` - -### Timeouts - -The SDK defaults to a 60 second timeout. You can configure this with a timeout option at the client or request level. - -```python - -from seed import SeedOauthClientCredentials - -client = SeedOauthClientCredentials(..., { timeout=20.0 }, ) - - -# Override timeout for a specific method -client.auth.get_token_with_client_credentials(...,{ - timeout_in_seconds=1 -}) -``` - -### Custom Client - -You can override the `httpx` client to customize it for your use-case. Some common use-cases include support for proxies -and transports. -```python -import httpx -from seed import SeedOauthClientCredentials - -client = SeedOauthClientCredentials( - ..., - http_client=httpx.Client( - proxies="http://my.test.proxy.example.com", - transport=httpx.HTTPTransport(local_address="0.0.0.0"), - ), -) -``` - -## Contributing - -While we value open-source contributions to this SDK, this library is generated programmatically. -Additions made directly to this library would have to be moved over to our generation code, -otherwise they would be overwritten upon the next generated release. Feel free to open a PR as -a proof of concept, but know that we will not be able to merge it as-is. We suggest opening -an issue first to discuss with us! - -On the other hand, contributions to the README are always very welcome! diff --git a/seed/python-sdk/optional/README.md b/seed/python-sdk/optional/README.md index c32f35c939a..e69de29bb2d 100644 --- a/seed/python-sdk/optional/README.md +++ b/seed/python-sdk/optional/README.md @@ -1,131 +0,0 @@ -# Seed Python Library - -[![fern shield](https://img.shields.io/badge/%F0%9F%8C%BF-SDK%20generated%20by%20Fern-brightgreen)](https://github.com/fern-api/fern) -[![pypi](https://img.shields.io/pypi/v/fern_optional)](https://pypi.python.org/pypi/fern_optional) - -The Seed Python library provides convenient access to the Seed API from Python. - -## Installation - -```sh -pip install fern_optional -``` - -## Usage - -Instantiate and use the client with the following: - -```python -from seed import SeedObjectsWithImports - -client = SeedObjectsWithImports( - base_url="https://yourhost.com/path/to/api", -) -client.optional.send_optional_body( - request={"string": {"key": "value"}}, -) -``` - -## Async Client - -The SDK also exports an `async` client so that you can make non-blocking calls to our API. - -```python -import asyncio - -from seed import AsyncSeedObjectsWithImports - -client = AsyncSeedObjectsWithImports( - base_url="https://yourhost.com/path/to/api", -) - - -async def main() -> None: - await client.optional.send_optional_body( - request={"string": {"key": "value"}}, - ) - - -asyncio.run(main()) -``` - -## Exception Handling - -When the API returns a non-success status code (4xx or 5xx response), a subclass of the following error -will be thrown. - -```python -from seed.core.api_error import ApiError - -try: - client.optional.send_optional_body() -except ApiError as e: - print(e.status_code) - print(e.body) -``` - -## Advanced - -### Retries - -The SDK is instrumented with automatic retries with exponential backoff. A request will be retried as long -as the request is deemed retriable and the number of retry attempts has not grown larger than the configured -retry limit (default: 2). - -A request is deemed retriable when any of the following HTTP status codes is returned: - -- [408](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/408) (Timeout) -- [429](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/429) (Too Many Requests) -- [5XX](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/500) (Internal Server Errors) - -Use the `max_retries` request option to configure this behavior. - -```python -client.optional.send_optional_body({ - max_retries=1 -}) -``` - -### Timeouts - -The SDK defaults to a 60 second timeout. You can configure this with a timeout option at the client or request level. - -```python - -from seed import SeedObjectsWithImports - -client = SeedObjectsWithImports(..., { timeout=20.0 }, ) - - -# Override timeout for a specific method -client.optional.send_optional_body({ - timeout_in_seconds=1 -}) -``` - -### Custom Client - -You can override the `httpx` client to customize it for your use-case. Some common use-cases include support for proxies -and transports. -```python -import httpx -from seed import SeedObjectsWithImports - -client = SeedObjectsWithImports( - ..., - http_client=httpx.Client( - proxies="http://my.test.proxy.example.com", - transport=httpx.HTTPTransport(local_address="0.0.0.0"), - ), -) -``` - -## Contributing - -While we value open-source contributions to this SDK, this library is generated programmatically. -Additions made directly to this library would have to be moved over to our generation code, -otherwise they would be overwritten upon the next generated release. Feel free to open a PR as -a proof of concept, but know that we will not be able to merge it as-is. We suggest opening -an issue first to discuss with us! - -On the other hand, contributions to the README are always very welcome! diff --git a/seed/python-sdk/package-yml/README.md b/seed/python-sdk/package-yml/README.md index 6a8719d5cb3..e69de29bb2d 100644 --- a/seed/python-sdk/package-yml/README.md +++ b/seed/python-sdk/package-yml/README.md @@ -1,135 +0,0 @@ -# Seed Python Library - -[![fern shield](https://img.shields.io/badge/%F0%9F%8C%BF-SDK%20generated%20by%20Fern-brightgreen)](https://github.com/fern-api/fern) -[![pypi](https://img.shields.io/pypi/v/fern_package-yml)](https://pypi.python.org/pypi/fern_package-yml) - -The Seed Python library provides convenient access to the Seed API from Python. - -## Installation - -```sh -pip install fern_package-yml -``` - -## Usage - -Instantiate and use the client with the following: - -```python -from seed import SeedPackageYml - -client = SeedPackageYml( - base_url="https://yourhost.com/path/to/api", -) -client.echo( - id="id-ksfd9c1", - name="Hello world!", - size=20, -) -``` - -## Async Client - -The SDK also exports an `async` client so that you can make non-blocking calls to our API. - -```python -import asyncio - -from seed import AsyncSeedPackageYml - -client = AsyncSeedPackageYml( - base_url="https://yourhost.com/path/to/api", -) - - -async def main() -> None: - await client.echo( - id="id-ksfd9c1", - name="Hello world!", - size=20, - ) - - -asyncio.run(main()) -``` - -## Exception Handling - -When the API returns a non-success status code (4xx or 5xx response), a subclass of the following error -will be thrown. - -```python -from seed.core.api_error import ApiError - -try: - client.echo(...) -except ApiError as e: - print(e.status_code) - print(e.body) -``` - -## Advanced - -### Retries - -The SDK is instrumented with automatic retries with exponential backoff. A request will be retried as long -as the request is deemed retriable and the number of retry attempts has not grown larger than the configured -retry limit (default: 2). - -A request is deemed retriable when any of the following HTTP status codes is returned: - -- [408](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/408) (Timeout) -- [429](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/429) (Too Many Requests) -- [5XX](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/500) (Internal Server Errors) - -Use the `max_retries` request option to configure this behavior. - -```python -client.echo(...,{ - max_retries=1 -}) -``` - -### Timeouts - -The SDK defaults to a 60 second timeout. You can configure this with a timeout option at the client or request level. - -```python - -from seed import SeedPackageYml - -client = SeedPackageYml(..., { timeout=20.0 }, ) - - -# Override timeout for a specific method -client.echo(...,{ - timeout_in_seconds=1 -}) -``` - -### Custom Client - -You can override the `httpx` client to customize it for your use-case. Some common use-cases include support for proxies -and transports. -```python -import httpx -from seed import SeedPackageYml - -client = SeedPackageYml( - ..., - http_client=httpx.Client( - proxies="http://my.test.proxy.example.com", - transport=httpx.HTTPTransport(local_address="0.0.0.0"), - ), -) -``` - -## Contributing - -While we value open-source contributions to this SDK, this library is generated programmatically. -Additions made directly to this library would have to be moved over to our generation code, -otherwise they would be overwritten upon the next generated release. Feel free to open a PR as -a proof of concept, but know that we will not be able to merge it as-is. We suggest opening -an issue first to discuss with us! - -On the other hand, contributions to the README are always very welcome! diff --git a/seed/python-sdk/pagination/.mock/ir.json b/seed/python-sdk/pagination/.mock/ir.json deleted file mode 100644 index ef50cbc3fc6..00000000000 --- a/seed/python-sdk/pagination/.mock/ir.json +++ /dev/null @@ -1,6992 +0,0 @@ -{ - "apiName": { - "originalName": "pagination", - "camelCase": { - "unsafeName": "pagination", - "safeName": "pagination" - }, - "snakeCase": { - "unsafeName": "pagination", - "safeName": "pagination" - }, - "screamingSnakeCase": { - "unsafeName": "PAGINATION", - "safeName": "PAGINATION" - }, - "pascalCase": { - "unsafeName": "Pagination", - "safeName": "Pagination" - } - }, - "apiDisplayName": null, - "apiDocs": null, - "auth": { - "requirement": "ALL", - "schemes": [ - { - "_type": "bearer", - "token": { - "originalName": "token", - "camelCase": { - "unsafeName": "token", - "safeName": "token" - }, - "snakeCase": { - "unsafeName": "token", - "safeName": "token" - }, - "screamingSnakeCase": { - "unsafeName": "TOKEN", - "safeName": "TOKEN" - }, - "pascalCase": { - "unsafeName": "Token", - "safeName": "Token" - } - }, - "tokenEnvVar": null, - "docs": null - } - ], - "docs": null - }, - "headers": [], - "idempotencyHeaders": [], - "types": { - "type_:UsernameCursor": { - "name": { - "name": { - "originalName": "UsernameCursor", - "camelCase": { - "unsafeName": "usernameCursor", - "safeName": "usernameCursor" - }, - "snakeCase": { - "unsafeName": "username_cursor", - "safeName": "username_cursor" - }, - "screamingSnakeCase": { - "unsafeName": "USERNAME_CURSOR", - "safeName": "USERNAME_CURSOR" - }, - "pascalCase": { - "unsafeName": "UsernameCursor", - "safeName": "UsernameCursor" - } - }, - "fernFilepath": { - "allParts": [], - "packagePath": [], - "file": null - }, - "typeId": "type_:UsernameCursor" - }, - "shape": { - "_type": "object", - "extends": [], - "properties": [ - { - "name": { - "name": { - "originalName": "cursor", - "camelCase": { - "unsafeName": "cursor", - "safeName": "cursor" - }, - "snakeCase": { - "unsafeName": "cursor", - "safeName": "cursor" - }, - "screamingSnakeCase": { - "unsafeName": "CURSOR", - "safeName": "CURSOR" - }, - "pascalCase": { - "unsafeName": "Cursor", - "safeName": "Cursor" - } - }, - "wireValue": "cursor" - }, - "valueType": { - "_type": "named", - "name": { - "originalName": "UsernamePage", - "camelCase": { - "unsafeName": "usernamePage", - "safeName": "usernamePage" - }, - "snakeCase": { - "unsafeName": "username_page", - "safeName": "username_page" - }, - "screamingSnakeCase": { - "unsafeName": "USERNAME_PAGE", - "safeName": "USERNAME_PAGE" - }, - "pascalCase": { - "unsafeName": "UsernamePage", - "safeName": "UsernamePage" - } - }, - "fernFilepath": { - "allParts": [], - "packagePath": [], - "file": null - }, - "typeId": "type_:UsernamePage" - }, - "availability": null, - "docs": null - } - ], - "extra-properties": false - }, - "referencedTypes": [ - "type_:UsernamePage" - ], - "examples": [], - "availability": null, - "docs": null - }, - "type_:UsernamePage": { - "name": { - "name": { - "originalName": "UsernamePage", - "camelCase": { - "unsafeName": "usernamePage", - "safeName": "usernamePage" - }, - "snakeCase": { - "unsafeName": "username_page", - "safeName": "username_page" - }, - "screamingSnakeCase": { - "unsafeName": "USERNAME_PAGE", - "safeName": "USERNAME_PAGE" - }, - "pascalCase": { - "unsafeName": "UsernamePage", - "safeName": "UsernamePage" - } - }, - "fernFilepath": { - "allParts": [], - "packagePath": [], - "file": null - }, - "typeId": "type_:UsernamePage" - }, - "shape": { - "_type": "object", - "extends": [], - "properties": [ - { - "name": { - "name": { - "originalName": "after", - "camelCase": { - "unsafeName": "after", - "safeName": "after" - }, - "snakeCase": { - "unsafeName": "after", - "safeName": "after" - }, - "screamingSnakeCase": { - "unsafeName": "AFTER", - "safeName": "AFTER" - }, - "pascalCase": { - "unsafeName": "After", - "safeName": "After" - } - }, - "wireValue": "after" - }, - "valueType": { - "_type": "container", - "container": { - "_type": "optional", - "optional": { - "_type": "primitive", - "primitive": "STRING" - } - } - }, - "availability": null, - "docs": null - }, - { - "name": { - "name": { - "originalName": "data", - "camelCase": { - "unsafeName": "data", - "safeName": "data" - }, - "snakeCase": { - "unsafeName": "data", - "safeName": "data" - }, - "screamingSnakeCase": { - "unsafeName": "DATA", - "safeName": "DATA" - }, - "pascalCase": { - "unsafeName": "Data", - "safeName": "Data" - } - }, - "wireValue": "data" - }, - "valueType": { - "_type": "container", - "container": { - "_type": "list", - "list": { - "_type": "primitive", - "primitive": "STRING" - } - } - }, - "availability": null, - "docs": null - } - ], - "extra-properties": false - }, - "referencedTypes": [], - "examples": [], - "availability": null, - "docs": null - }, - "type_users:Order": { - "name": { - "name": { - "originalName": "Order", - "camelCase": { - "unsafeName": "order", - "safeName": "order" - }, - "snakeCase": { - "unsafeName": "order", - "safeName": "order" - }, - "screamingSnakeCase": { - "unsafeName": "ORDER", - "safeName": "ORDER" - }, - "pascalCase": { - "unsafeName": "Order", - "safeName": "Order" - } - }, - "fernFilepath": { - "allParts": [ - { - "originalName": "users", - "camelCase": { - "unsafeName": "users", - "safeName": "users" - }, - "snakeCase": { - "unsafeName": "users", - "safeName": "users" - }, - "screamingSnakeCase": { - "unsafeName": "USERS", - "safeName": "USERS" - }, - "pascalCase": { - "unsafeName": "Users", - "safeName": "Users" - } - } - ], - "packagePath": [], - "file": { - "originalName": "users", - "camelCase": { - "unsafeName": "users", - "safeName": "users" - }, - "snakeCase": { - "unsafeName": "users", - "safeName": "users" - }, - "screamingSnakeCase": { - "unsafeName": "USERS", - "safeName": "USERS" - }, - "pascalCase": { - "unsafeName": "Users", - "safeName": "Users" - } - } - }, - "typeId": "type_users:Order" - }, - "shape": { - "_type": "enum", - "values": [ - { - "name": { - "name": { - "originalName": "asc", - "camelCase": { - "unsafeName": "asc", - "safeName": "asc" - }, - "snakeCase": { - "unsafeName": "asc", - "safeName": "asc" - }, - "screamingSnakeCase": { - "unsafeName": "ASC", - "safeName": "ASC" - }, - "pascalCase": { - "unsafeName": "Asc", - "safeName": "Asc" - } - }, - "wireValue": "asc" - }, - "availability": null, - "docs": null - }, - { - "name": { - "name": { - "originalName": "desc", - "camelCase": { - "unsafeName": "desc", - "safeName": "desc" - }, - "snakeCase": { - "unsafeName": "desc", - "safeName": "desc" - }, - "screamingSnakeCase": { - "unsafeName": "DESC", - "safeName": "DESC" - }, - "pascalCase": { - "unsafeName": "Desc", - "safeName": "Desc" - } - }, - "wireValue": "desc" - }, - "availability": null, - "docs": null - } - ] - }, - "referencedTypes": [], - "examples": [], - "availability": null, - "docs": null - }, - "type_users:UserListContainer": { - "name": { - "name": { - "originalName": "UserListContainer", - "camelCase": { - "unsafeName": "userListContainer", - "safeName": "userListContainer" - }, - "snakeCase": { - "unsafeName": "user_list_container", - "safeName": "user_list_container" - }, - "screamingSnakeCase": { - "unsafeName": "USER_LIST_CONTAINER", - "safeName": "USER_LIST_CONTAINER" - }, - "pascalCase": { - "unsafeName": "UserListContainer", - "safeName": "UserListContainer" - } - }, - "fernFilepath": { - "allParts": [ - { - "originalName": "users", - "camelCase": { - "unsafeName": "users", - "safeName": "users" - }, - "snakeCase": { - "unsafeName": "users", - "safeName": "users" - }, - "screamingSnakeCase": { - "unsafeName": "USERS", - "safeName": "USERS" - }, - "pascalCase": { - "unsafeName": "Users", - "safeName": "Users" - } - } - ], - "packagePath": [], - "file": { - "originalName": "users", - "camelCase": { - "unsafeName": "users", - "safeName": "users" - }, - "snakeCase": { - "unsafeName": "users", - "safeName": "users" - }, - "screamingSnakeCase": { - "unsafeName": "USERS", - "safeName": "USERS" - }, - "pascalCase": { - "unsafeName": "Users", - "safeName": "Users" - } - } - }, - "typeId": "type_users:UserListContainer" - }, - "shape": { - "_type": "object", - "extends": [], - "properties": [ - { - "name": { - "name": { - "originalName": "users", - "camelCase": { - "unsafeName": "users", - "safeName": "users" - }, - "snakeCase": { - "unsafeName": "users", - "safeName": "users" - }, - "screamingSnakeCase": { - "unsafeName": "USERS", - "safeName": "USERS" - }, - "pascalCase": { - "unsafeName": "Users", - "safeName": "Users" - } - }, - "wireValue": "users" - }, - "valueType": { - "_type": "container", - "container": { - "_type": "list", - "list": { - "_type": "named", - "name": { - "originalName": "User", - "camelCase": { - "unsafeName": "user", - "safeName": "user" - }, - "snakeCase": { - "unsafeName": "user", - "safeName": "user" - }, - "screamingSnakeCase": { - "unsafeName": "USER", - "safeName": "USER" - }, - "pascalCase": { - "unsafeName": "User", - "safeName": "User" - } - }, - "fernFilepath": { - "allParts": [ - { - "originalName": "users", - "camelCase": { - "unsafeName": "users", - "safeName": "users" - }, - "snakeCase": { - "unsafeName": "users", - "safeName": "users" - }, - "screamingSnakeCase": { - "unsafeName": "USERS", - "safeName": "USERS" - }, - "pascalCase": { - "unsafeName": "Users", - "safeName": "Users" - } - } - ], - "packagePath": [], - "file": { - "originalName": "users", - "camelCase": { - "unsafeName": "users", - "safeName": "users" - }, - "snakeCase": { - "unsafeName": "users", - "safeName": "users" - }, - "screamingSnakeCase": { - "unsafeName": "USERS", - "safeName": "USERS" - }, - "pascalCase": { - "unsafeName": "Users", - "safeName": "Users" - } - } - }, - "typeId": "type_users:User" - } - } - }, - "availability": null, - "docs": null - } - ], - "extra-properties": false - }, - "referencedTypes": [ - "type_users:User" - ], - "examples": [], - "availability": null, - "docs": null - }, - "type_users:UserPage": { - "name": { - "name": { - "originalName": "UserPage", - "camelCase": { - "unsafeName": "userPage", - "safeName": "userPage" - }, - "snakeCase": { - "unsafeName": "user_page", - "safeName": "user_page" - }, - "screamingSnakeCase": { - "unsafeName": "USER_PAGE", - "safeName": "USER_PAGE" - }, - "pascalCase": { - "unsafeName": "UserPage", - "safeName": "UserPage" - } - }, - "fernFilepath": { - "allParts": [ - { - "originalName": "users", - "camelCase": { - "unsafeName": "users", - "safeName": "users" - }, - "snakeCase": { - "unsafeName": "users", - "safeName": "users" - }, - "screamingSnakeCase": { - "unsafeName": "USERS", - "safeName": "USERS" - }, - "pascalCase": { - "unsafeName": "Users", - "safeName": "Users" - } - } - ], - "packagePath": [], - "file": { - "originalName": "users", - "camelCase": { - "unsafeName": "users", - "safeName": "users" - }, - "snakeCase": { - "unsafeName": "users", - "safeName": "users" - }, - "screamingSnakeCase": { - "unsafeName": "USERS", - "safeName": "USERS" - }, - "pascalCase": { - "unsafeName": "Users", - "safeName": "Users" - } - } - }, - "typeId": "type_users:UserPage" - }, - "shape": { - "_type": "object", - "extends": [], - "properties": [ - { - "name": { - "name": { - "originalName": "data", - "camelCase": { - "unsafeName": "data", - "safeName": "data" - }, - "snakeCase": { - "unsafeName": "data", - "safeName": "data" - }, - "screamingSnakeCase": { - "unsafeName": "DATA", - "safeName": "DATA" - }, - "pascalCase": { - "unsafeName": "Data", - "safeName": "Data" - } - }, - "wireValue": "data" - }, - "valueType": { - "_type": "named", - "name": { - "originalName": "UserListContainer", - "camelCase": { - "unsafeName": "userListContainer", - "safeName": "userListContainer" - }, - "snakeCase": { - "unsafeName": "user_list_container", - "safeName": "user_list_container" - }, - "screamingSnakeCase": { - "unsafeName": "USER_LIST_CONTAINER", - "safeName": "USER_LIST_CONTAINER" - }, - "pascalCase": { - "unsafeName": "UserListContainer", - "safeName": "UserListContainer" - } - }, - "fernFilepath": { - "allParts": [ - { - "originalName": "users", - "camelCase": { - "unsafeName": "users", - "safeName": "users" - }, - "snakeCase": { - "unsafeName": "users", - "safeName": "users" - }, - "screamingSnakeCase": { - "unsafeName": "USERS", - "safeName": "USERS" - }, - "pascalCase": { - "unsafeName": "Users", - "safeName": "Users" - } - } - ], - "packagePath": [], - "file": { - "originalName": "users", - "camelCase": { - "unsafeName": "users", - "safeName": "users" - }, - "snakeCase": { - "unsafeName": "users", - "safeName": "users" - }, - "screamingSnakeCase": { - "unsafeName": "USERS", - "safeName": "USERS" - }, - "pascalCase": { - "unsafeName": "Users", - "safeName": "Users" - } - } - }, - "typeId": "type_users:UserListContainer" - }, - "availability": null, - "docs": null - }, - { - "name": { - "name": { - "originalName": "next", - "camelCase": { - "unsafeName": "next", - "safeName": "next" - }, - "snakeCase": { - "unsafeName": "next", - "safeName": "next" - }, - "screamingSnakeCase": { - "unsafeName": "NEXT", - "safeName": "NEXT" - }, - "pascalCase": { - "unsafeName": "Next", - "safeName": "Next" - } - }, - "wireValue": "next" - }, - "valueType": { - "_type": "container", - "container": { - "_type": "optional", - "optional": { - "_type": "primitive", - "primitive": "UUID" - } - } - }, - "availability": null, - "docs": null - } - ], - "extra-properties": false - }, - "referencedTypes": [ - "type_users:UserListContainer", - "type_users:User" - ], - "examples": [], - "availability": null, - "docs": null - }, - "type_users:UsernameContainer": { - "name": { - "name": { - "originalName": "UsernameContainer", - "camelCase": { - "unsafeName": "usernameContainer", - "safeName": "usernameContainer" - }, - "snakeCase": { - "unsafeName": "username_container", - "safeName": "username_container" - }, - "screamingSnakeCase": { - "unsafeName": "USERNAME_CONTAINER", - "safeName": "USERNAME_CONTAINER" - }, - "pascalCase": { - "unsafeName": "UsernameContainer", - "safeName": "UsernameContainer" - } - }, - "fernFilepath": { - "allParts": [ - { - "originalName": "users", - "camelCase": { - "unsafeName": "users", - "safeName": "users" - }, - "snakeCase": { - "unsafeName": "users", - "safeName": "users" - }, - "screamingSnakeCase": { - "unsafeName": "USERS", - "safeName": "USERS" - }, - "pascalCase": { - "unsafeName": "Users", - "safeName": "Users" - } - } - ], - "packagePath": [], - "file": { - "originalName": "users", - "camelCase": { - "unsafeName": "users", - "safeName": "users" - }, - "snakeCase": { - "unsafeName": "users", - "safeName": "users" - }, - "screamingSnakeCase": { - "unsafeName": "USERS", - "safeName": "USERS" - }, - "pascalCase": { - "unsafeName": "Users", - "safeName": "Users" - } - } - }, - "typeId": "type_users:UsernameContainer" - }, - "shape": { - "_type": "object", - "extends": [], - "properties": [ - { - "name": { - "name": { - "originalName": "results", - "camelCase": { - "unsafeName": "results", - "safeName": "results" - }, - "snakeCase": { - "unsafeName": "results", - "safeName": "results" - }, - "screamingSnakeCase": { - "unsafeName": "RESULTS", - "safeName": "RESULTS" - }, - "pascalCase": { - "unsafeName": "Results", - "safeName": "Results" - } - }, - "wireValue": "results" - }, - "valueType": { - "_type": "container", - "container": { - "_type": "list", - "list": { - "_type": "primitive", - "primitive": "STRING" - } - } - }, - "availability": null, - "docs": null - } - ], - "extra-properties": false - }, - "referencedTypes": [], - "examples": [], - "availability": null, - "docs": null - }, - "type_users:ListUsersExtendedResponse": { - "name": { - "name": { - "originalName": "ListUsersExtendedResponse", - "camelCase": { - "unsafeName": "listUsersExtendedResponse", - "safeName": "listUsersExtendedResponse" - }, - "snakeCase": { - "unsafeName": "list_users_extended_response", - "safeName": "list_users_extended_response" - }, - "screamingSnakeCase": { - "unsafeName": "LIST_USERS_EXTENDED_RESPONSE", - "safeName": "LIST_USERS_EXTENDED_RESPONSE" - }, - "pascalCase": { - "unsafeName": "ListUsersExtendedResponse", - "safeName": "ListUsersExtendedResponse" - } - }, - "fernFilepath": { - "allParts": [ - { - "originalName": "users", - "camelCase": { - "unsafeName": "users", - "safeName": "users" - }, - "snakeCase": { - "unsafeName": "users", - "safeName": "users" - }, - "screamingSnakeCase": { - "unsafeName": "USERS", - "safeName": "USERS" - }, - "pascalCase": { - "unsafeName": "Users", - "safeName": "Users" - } - } - ], - "packagePath": [], - "file": { - "originalName": "users", - "camelCase": { - "unsafeName": "users", - "safeName": "users" - }, - "snakeCase": { - "unsafeName": "users", - "safeName": "users" - }, - "screamingSnakeCase": { - "unsafeName": "USERS", - "safeName": "USERS" - }, - "pascalCase": { - "unsafeName": "Users", - "safeName": "Users" - } - } - }, - "typeId": "type_users:ListUsersExtendedResponse" - }, - "shape": { - "_type": "object", - "extends": [ - { - "name": { - "originalName": "UserPage", - "camelCase": { - "unsafeName": "userPage", - "safeName": "userPage" - }, - "snakeCase": { - "unsafeName": "user_page", - "safeName": "user_page" - }, - "screamingSnakeCase": { - "unsafeName": "USER_PAGE", - "safeName": "USER_PAGE" - }, - "pascalCase": { - "unsafeName": "UserPage", - "safeName": "UserPage" - } - }, - "fernFilepath": { - "allParts": [ - { - "originalName": "users", - "camelCase": { - "unsafeName": "users", - "safeName": "users" - }, - "snakeCase": { - "unsafeName": "users", - "safeName": "users" - }, - "screamingSnakeCase": { - "unsafeName": "USERS", - "safeName": "USERS" - }, - "pascalCase": { - "unsafeName": "Users", - "safeName": "Users" - } - } - ], - "packagePath": [], - "file": { - "originalName": "users", - "camelCase": { - "unsafeName": "users", - "safeName": "users" - }, - "snakeCase": { - "unsafeName": "users", - "safeName": "users" - }, - "screamingSnakeCase": { - "unsafeName": "USERS", - "safeName": "USERS" - }, - "pascalCase": { - "unsafeName": "Users", - "safeName": "Users" - } - } - }, - "typeId": "type_users:UserPage" - } - ], - "properties": [ - { - "name": { - "name": { - "originalName": "total_count", - "camelCase": { - "unsafeName": "totalCount", - "safeName": "totalCount" - }, - "snakeCase": { - "unsafeName": "total_count", - "safeName": "total_count" - }, - "screamingSnakeCase": { - "unsafeName": "TOTAL_COUNT", - "safeName": "TOTAL_COUNT" - }, - "pascalCase": { - "unsafeName": "TotalCount", - "safeName": "TotalCount" - } - }, - "wireValue": "total_count" - }, - "valueType": { - "_type": "primitive", - "primitive": "INTEGER" - }, - "availability": null, - "docs": "The totall number of /users" - } - ], - "extra-properties": false - }, - "referencedTypes": [ - "type_users:UserPage", - "type_users:UserListContainer", - "type_users:User" - ], - "examples": [], - "availability": null, - "docs": null - }, - "type_users:ListUsersPaginationResponse": { - "name": { - "name": { - "originalName": "ListUsersPaginationResponse", - "camelCase": { - "unsafeName": "listUsersPaginationResponse", - "safeName": "listUsersPaginationResponse" - }, - "snakeCase": { - "unsafeName": "list_users_pagination_response", - "safeName": "list_users_pagination_response" - }, - "screamingSnakeCase": { - "unsafeName": "LIST_USERS_PAGINATION_RESPONSE", - "safeName": "LIST_USERS_PAGINATION_RESPONSE" - }, - "pascalCase": { - "unsafeName": "ListUsersPaginationResponse", - "safeName": "ListUsersPaginationResponse" - } - }, - "fernFilepath": { - "allParts": [ - { - "originalName": "users", - "camelCase": { - "unsafeName": "users", - "safeName": "users" - }, - "snakeCase": { - "unsafeName": "users", - "safeName": "users" - }, - "screamingSnakeCase": { - "unsafeName": "USERS", - "safeName": "USERS" - }, - "pascalCase": { - "unsafeName": "Users", - "safeName": "Users" - } - } - ], - "packagePath": [], - "file": { - "originalName": "users", - "camelCase": { - "unsafeName": "users", - "safeName": "users" - }, - "snakeCase": { - "unsafeName": "users", - "safeName": "users" - }, - "screamingSnakeCase": { - "unsafeName": "USERS", - "safeName": "USERS" - }, - "pascalCase": { - "unsafeName": "Users", - "safeName": "Users" - } - } - }, - "typeId": "type_users:ListUsersPaginationResponse" - }, - "shape": { - "_type": "object", - "extends": [], - "properties": [ - { - "name": { - "name": { - "originalName": "page", - "camelCase": { - "unsafeName": "page", - "safeName": "page" - }, - "snakeCase": { - "unsafeName": "page", - "safeName": "page" - }, - "screamingSnakeCase": { - "unsafeName": "PAGE", - "safeName": "PAGE" - }, - "pascalCase": { - "unsafeName": "Page", - "safeName": "Page" - } - }, - "wireValue": "page" - }, - "valueType": { - "_type": "container", - "container": { - "_type": "optional", - "optional": { - "_type": "named", - "name": { - "originalName": "Page", - "camelCase": { - "unsafeName": "page", - "safeName": "page" - }, - "snakeCase": { - "unsafeName": "page", - "safeName": "page" - }, - "screamingSnakeCase": { - "unsafeName": "PAGE", - "safeName": "PAGE" - }, - "pascalCase": { - "unsafeName": "Page", - "safeName": "Page" - } - }, - "fernFilepath": { - "allParts": [ - { - "originalName": "users", - "camelCase": { - "unsafeName": "users", - "safeName": "users" - }, - "snakeCase": { - "unsafeName": "users", - "safeName": "users" - }, - "screamingSnakeCase": { - "unsafeName": "USERS", - "safeName": "USERS" - }, - "pascalCase": { - "unsafeName": "Users", - "safeName": "Users" - } - } - ], - "packagePath": [], - "file": { - "originalName": "users", - "camelCase": { - "unsafeName": "users", - "safeName": "users" - }, - "snakeCase": { - "unsafeName": "users", - "safeName": "users" - }, - "screamingSnakeCase": { - "unsafeName": "USERS", - "safeName": "USERS" - }, - "pascalCase": { - "unsafeName": "Users", - "safeName": "Users" - } - } - }, - "typeId": "type_users:Page" - } - } - }, - "availability": null, - "docs": null - }, - { - "name": { - "name": { - "originalName": "total_count", - "camelCase": { - "unsafeName": "totalCount", - "safeName": "totalCount" - }, - "snakeCase": { - "unsafeName": "total_count", - "safeName": "total_count" - }, - "screamingSnakeCase": { - "unsafeName": "TOTAL_COUNT", - "safeName": "TOTAL_COUNT" - }, - "pascalCase": { - "unsafeName": "TotalCount", - "safeName": "TotalCount" - } - }, - "wireValue": "total_count" - }, - "valueType": { - "_type": "primitive", - "primitive": "INTEGER" - }, - "availability": null, - "docs": "The totall number of /users" - }, - { - "name": { - "name": { - "originalName": "data", - "camelCase": { - "unsafeName": "data", - "safeName": "data" - }, - "snakeCase": { - "unsafeName": "data", - "safeName": "data" - }, - "screamingSnakeCase": { - "unsafeName": "DATA", - "safeName": "DATA" - }, - "pascalCase": { - "unsafeName": "Data", - "safeName": "Data" - } - }, - "wireValue": "data" - }, - "valueType": { - "_type": "container", - "container": { - "_type": "list", - "list": { - "_type": "named", - "name": { - "originalName": "User", - "camelCase": { - "unsafeName": "user", - "safeName": "user" - }, - "snakeCase": { - "unsafeName": "user", - "safeName": "user" - }, - "screamingSnakeCase": { - "unsafeName": "USER", - "safeName": "USER" - }, - "pascalCase": { - "unsafeName": "User", - "safeName": "User" - } - }, - "fernFilepath": { - "allParts": [ - { - "originalName": "users", - "camelCase": { - "unsafeName": "users", - "safeName": "users" - }, - "snakeCase": { - "unsafeName": "users", - "safeName": "users" - }, - "screamingSnakeCase": { - "unsafeName": "USERS", - "safeName": "USERS" - }, - "pascalCase": { - "unsafeName": "Users", - "safeName": "Users" - } - } - ], - "packagePath": [], - "file": { - "originalName": "users", - "camelCase": { - "unsafeName": "users", - "safeName": "users" - }, - "snakeCase": { - "unsafeName": "users", - "safeName": "users" - }, - "screamingSnakeCase": { - "unsafeName": "USERS", - "safeName": "USERS" - }, - "pascalCase": { - "unsafeName": "Users", - "safeName": "Users" - } - } - }, - "typeId": "type_users:User" - } - } - }, - "availability": null, - "docs": null - } - ], - "extra-properties": false - }, - "referencedTypes": [ - "type_users:Page", - "type_users:NextPage", - "type_users:User" - ], - "examples": [], - "availability": null, - "docs": null - }, - "type_users:Page": { - "name": { - "name": { - "originalName": "Page", - "camelCase": { - "unsafeName": "page", - "safeName": "page" - }, - "snakeCase": { - "unsafeName": "page", - "safeName": "page" - }, - "screamingSnakeCase": { - "unsafeName": "PAGE", - "safeName": "PAGE" - }, - "pascalCase": { - "unsafeName": "Page", - "safeName": "Page" - } - }, - "fernFilepath": { - "allParts": [ - { - "originalName": "users", - "camelCase": { - "unsafeName": "users", - "safeName": "users" - }, - "snakeCase": { - "unsafeName": "users", - "safeName": "users" - }, - "screamingSnakeCase": { - "unsafeName": "USERS", - "safeName": "USERS" - }, - "pascalCase": { - "unsafeName": "Users", - "safeName": "Users" - } - } - ], - "packagePath": [], - "file": { - "originalName": "users", - "camelCase": { - "unsafeName": "users", - "safeName": "users" - }, - "snakeCase": { - "unsafeName": "users", - "safeName": "users" - }, - "screamingSnakeCase": { - "unsafeName": "USERS", - "safeName": "USERS" - }, - "pascalCase": { - "unsafeName": "Users", - "safeName": "Users" - } - } - }, - "typeId": "type_users:Page" - }, - "shape": { - "_type": "object", - "extends": [], - "properties": [ - { - "name": { - "name": { - "originalName": "page", - "camelCase": { - "unsafeName": "page", - "safeName": "page" - }, - "snakeCase": { - "unsafeName": "page", - "safeName": "page" - }, - "screamingSnakeCase": { - "unsafeName": "PAGE", - "safeName": "PAGE" - }, - "pascalCase": { - "unsafeName": "Page", - "safeName": "Page" - } - }, - "wireValue": "page" - }, - "valueType": { - "_type": "primitive", - "primitive": "INTEGER" - }, - "availability": null, - "docs": "The current page" - }, - { - "name": { - "name": { - "originalName": "next", - "camelCase": { - "unsafeName": "next", - "safeName": "next" - }, - "snakeCase": { - "unsafeName": "next", - "safeName": "next" - }, - "screamingSnakeCase": { - "unsafeName": "NEXT", - "safeName": "NEXT" - }, - "pascalCase": { - "unsafeName": "Next", - "safeName": "Next" - } - }, - "wireValue": "next" - }, - "valueType": { - "_type": "container", - "container": { - "_type": "optional", - "optional": { - "_type": "named", - "name": { - "originalName": "NextPage", - "camelCase": { - "unsafeName": "nextPage", - "safeName": "nextPage" - }, - "snakeCase": { - "unsafeName": "next_page", - "safeName": "next_page" - }, - "screamingSnakeCase": { - "unsafeName": "NEXT_PAGE", - "safeName": "NEXT_PAGE" - }, - "pascalCase": { - "unsafeName": "NextPage", - "safeName": "NextPage" - } - }, - "fernFilepath": { - "allParts": [ - { - "originalName": "users", - "camelCase": { - "unsafeName": "users", - "safeName": "users" - }, - "snakeCase": { - "unsafeName": "users", - "safeName": "users" - }, - "screamingSnakeCase": { - "unsafeName": "USERS", - "safeName": "USERS" - }, - "pascalCase": { - "unsafeName": "Users", - "safeName": "Users" - } - } - ], - "packagePath": [], - "file": { - "originalName": "users", - "camelCase": { - "unsafeName": "users", - "safeName": "users" - }, - "snakeCase": { - "unsafeName": "users", - "safeName": "users" - }, - "screamingSnakeCase": { - "unsafeName": "USERS", - "safeName": "USERS" - }, - "pascalCase": { - "unsafeName": "Users", - "safeName": "Users" - } - } - }, - "typeId": "type_users:NextPage" - } - } - }, - "availability": null, - "docs": null - }, - { - "name": { - "name": { - "originalName": "per_page", - "camelCase": { - "unsafeName": "perPage", - "safeName": "perPage" - }, - "snakeCase": { - "unsafeName": "per_page", - "safeName": "per_page" - }, - "screamingSnakeCase": { - "unsafeName": "PER_PAGE", - "safeName": "PER_PAGE" - }, - "pascalCase": { - "unsafeName": "PerPage", - "safeName": "PerPage" - } - }, - "wireValue": "per_page" - }, - "valueType": { - "_type": "primitive", - "primitive": "INTEGER" - }, - "availability": null, - "docs": null - }, - { - "name": { - "name": { - "originalName": "total_page", - "camelCase": { - "unsafeName": "totalPage", - "safeName": "totalPage" - }, - "snakeCase": { - "unsafeName": "total_page", - "safeName": "total_page" - }, - "screamingSnakeCase": { - "unsafeName": "TOTAL_PAGE", - "safeName": "TOTAL_PAGE" - }, - "pascalCase": { - "unsafeName": "TotalPage", - "safeName": "TotalPage" - } - }, - "wireValue": "total_page" - }, - "valueType": { - "_type": "primitive", - "primitive": "INTEGER" - }, - "availability": null, - "docs": null - } - ], - "extra-properties": false - }, - "referencedTypes": [ - "type_users:NextPage" - ], - "examples": [], - "availability": null, - "docs": null - }, - "type_users:NextPage": { - "name": { - "name": { - "originalName": "NextPage", - "camelCase": { - "unsafeName": "nextPage", - "safeName": "nextPage" - }, - "snakeCase": { - "unsafeName": "next_page", - "safeName": "next_page" - }, - "screamingSnakeCase": { - "unsafeName": "NEXT_PAGE", - "safeName": "NEXT_PAGE" - }, - "pascalCase": { - "unsafeName": "NextPage", - "safeName": "NextPage" - } - }, - "fernFilepath": { - "allParts": [ - { - "originalName": "users", - "camelCase": { - "unsafeName": "users", - "safeName": "users" - }, - "snakeCase": { - "unsafeName": "users", - "safeName": "users" - }, - "screamingSnakeCase": { - "unsafeName": "USERS", - "safeName": "USERS" - }, - "pascalCase": { - "unsafeName": "Users", - "safeName": "Users" - } - } - ], - "packagePath": [], - "file": { - "originalName": "users", - "camelCase": { - "unsafeName": "users", - "safeName": "users" - }, - "snakeCase": { - "unsafeName": "users", - "safeName": "users" - }, - "screamingSnakeCase": { - "unsafeName": "USERS", - "safeName": "USERS" - }, - "pascalCase": { - "unsafeName": "Users", - "safeName": "Users" - } - } - }, - "typeId": "type_users:NextPage" - }, - "shape": { - "_type": "object", - "extends": [], - "properties": [ - { - "name": { - "name": { - "originalName": "page", - "camelCase": { - "unsafeName": "page", - "safeName": "page" - }, - "snakeCase": { - "unsafeName": "page", - "safeName": "page" - }, - "screamingSnakeCase": { - "unsafeName": "PAGE", - "safeName": "PAGE" - }, - "pascalCase": { - "unsafeName": "Page", - "safeName": "Page" - } - }, - "wireValue": "page" - }, - "valueType": { - "_type": "primitive", - "primitive": "INTEGER" - }, - "availability": null, - "docs": null - }, - { - "name": { - "name": { - "originalName": "starting_after", - "camelCase": { - "unsafeName": "startingAfter", - "safeName": "startingAfter" - }, - "snakeCase": { - "unsafeName": "starting_after", - "safeName": "starting_after" - }, - "screamingSnakeCase": { - "unsafeName": "STARTING_AFTER", - "safeName": "STARTING_AFTER" - }, - "pascalCase": { - "unsafeName": "StartingAfter", - "safeName": "StartingAfter" - } - }, - "wireValue": "starting_after" - }, - "valueType": { - "_type": "primitive", - "primitive": "STRING" - }, - "availability": null, - "docs": null - } - ], - "extra-properties": false - }, - "referencedTypes": [], - "examples": [], - "availability": null, - "docs": null - }, - "type_users:User": { - "name": { - "name": { - "originalName": "User", - "camelCase": { - "unsafeName": "user", - "safeName": "user" - }, - "snakeCase": { - "unsafeName": "user", - "safeName": "user" - }, - "screamingSnakeCase": { - "unsafeName": "USER", - "safeName": "USER" - }, - "pascalCase": { - "unsafeName": "User", - "safeName": "User" - } - }, - "fernFilepath": { - "allParts": [ - { - "originalName": "users", - "camelCase": { - "unsafeName": "users", - "safeName": "users" - }, - "snakeCase": { - "unsafeName": "users", - "safeName": "users" - }, - "screamingSnakeCase": { - "unsafeName": "USERS", - "safeName": "USERS" - }, - "pascalCase": { - "unsafeName": "Users", - "safeName": "Users" - } - } - ], - "packagePath": [], - "file": { - "originalName": "users", - "camelCase": { - "unsafeName": "users", - "safeName": "users" - }, - "snakeCase": { - "unsafeName": "users", - "safeName": "users" - }, - "screamingSnakeCase": { - "unsafeName": "USERS", - "safeName": "USERS" - }, - "pascalCase": { - "unsafeName": "Users", - "safeName": "Users" - } - } - }, - "typeId": "type_users:User" - }, - "shape": { - "_type": "object", - "extends": [], - "properties": [ - { - "name": { - "name": { - "originalName": "name", - "camelCase": { - "unsafeName": "name", - "safeName": "name" - }, - "snakeCase": { - "unsafeName": "name", - "safeName": "name" - }, - "screamingSnakeCase": { - "unsafeName": "NAME", - "safeName": "NAME" - }, - "pascalCase": { - "unsafeName": "Name", - "safeName": "Name" - } - }, - "wireValue": "name" - }, - "valueType": { - "_type": "primitive", - "primitive": "STRING" - }, - "availability": null, - "docs": null - }, - { - "name": { - "name": { - "originalName": "id", - "camelCase": { - "unsafeName": "id", - "safeName": "id" - }, - "snakeCase": { - "unsafeName": "id", - "safeName": "id" - }, - "screamingSnakeCase": { - "unsafeName": "ID", - "safeName": "ID" - }, - "pascalCase": { - "unsafeName": "Id", - "safeName": "Id" - } - }, - "wireValue": "id" - }, - "valueType": { - "_type": "primitive", - "primitive": "INTEGER" - }, - "availability": null, - "docs": null - } - ], - "extra-properties": false - }, - "referencedTypes": [], - "examples": [], - "availability": null, - "docs": null - } - }, - "errors": {}, - "services": { - "service_users": { - "availability": null, - "name": { - "fernFilepath": { - "allParts": [ - { - "originalName": "users", - "camelCase": { - "unsafeName": "users", - "safeName": "users" - }, - "snakeCase": { - "unsafeName": "users", - "safeName": "users" - }, - "screamingSnakeCase": { - "unsafeName": "USERS", - "safeName": "USERS" - }, - "pascalCase": { - "unsafeName": "Users", - "safeName": "Users" - } - } - ], - "packagePath": [], - "file": { - "originalName": "users", - "camelCase": { - "unsafeName": "users", - "safeName": "users" - }, - "snakeCase": { - "unsafeName": "users", - "safeName": "users" - }, - "screamingSnakeCase": { - "unsafeName": "USERS", - "safeName": "USERS" - }, - "pascalCase": { - "unsafeName": "Users", - "safeName": "Users" - } - } - } - }, - "displayName": null, - "basePath": { - "head": "/users", - "parts": [] - }, - "headers": [], - "pathParameters": [], - "endpoints": [ - { - "id": "endpoint_users.listWithCursorPagination", - "name": { - "originalName": "listWithCursorPagination", - "camelCase": { - "unsafeName": "listWithCursorPagination", - "safeName": "listWithCursorPagination" - }, - "snakeCase": { - "unsafeName": "list_with_cursor_pagination", - "safeName": "list_with_cursor_pagination" - }, - "screamingSnakeCase": { - "unsafeName": "LIST_WITH_CURSOR_PAGINATION", - "safeName": "LIST_WITH_CURSOR_PAGINATION" - }, - "pascalCase": { - "unsafeName": "ListWithCursorPagination", - "safeName": "ListWithCursorPagination" - } - }, - "displayName": null, - "auth": false, - "idempotent": false, - "baseUrl": null, - "method": "GET", - "path": { - "head": "", - "parts": [] - }, - "fullPath": { - "head": "/users", - "parts": [] - }, - "pathParameters": [], - "allPathParameters": [], - "queryParameters": [ - { - "name": { - "name": { - "originalName": "page", - "camelCase": { - "unsafeName": "page", - "safeName": "page" - }, - "snakeCase": { - "unsafeName": "page", - "safeName": "page" - }, - "screamingSnakeCase": { - "unsafeName": "PAGE", - "safeName": "PAGE" - }, - "pascalCase": { - "unsafeName": "Page", - "safeName": "Page" - } - }, - "wireValue": "page" - }, - "valueType": { - "_type": "container", - "container": { - "_type": "optional", - "optional": { - "_type": "primitive", - "primitive": "INTEGER" - } - } - }, - "allowMultiple": false, - "availability": null, - "docs": "Defaults to first page" - }, - { - "name": { - "name": { - "originalName": "per_page", - "camelCase": { - "unsafeName": "perPage", - "safeName": "perPage" - }, - "snakeCase": { - "unsafeName": "per_page", - "safeName": "per_page" - }, - "screamingSnakeCase": { - "unsafeName": "PER_PAGE", - "safeName": "PER_PAGE" - }, - "pascalCase": { - "unsafeName": "PerPage", - "safeName": "PerPage" - } - }, - "wireValue": "per_page" - }, - "valueType": { - "_type": "container", - "container": { - "_type": "optional", - "optional": { - "_type": "primitive", - "primitive": "INTEGER" - } - } - }, - "allowMultiple": false, - "availability": null, - "docs": "Defaults to per page" - }, - { - "name": { - "name": { - "originalName": "order", - "camelCase": { - "unsafeName": "order", - "safeName": "order" - }, - "snakeCase": { - "unsafeName": "order", - "safeName": "order" - }, - "screamingSnakeCase": { - "unsafeName": "ORDER", - "safeName": "ORDER" - }, - "pascalCase": { - "unsafeName": "Order", - "safeName": "Order" - } - }, - "wireValue": "order" - }, - "valueType": { - "_type": "container", - "container": { - "_type": "optional", - "optional": { - "_type": "named", - "name": { - "originalName": "Order", - "camelCase": { - "unsafeName": "order", - "safeName": "order" - }, - "snakeCase": { - "unsafeName": "order", - "safeName": "order" - }, - "screamingSnakeCase": { - "unsafeName": "ORDER", - "safeName": "ORDER" - }, - "pascalCase": { - "unsafeName": "Order", - "safeName": "Order" - } - }, - "fernFilepath": { - "allParts": [ - { - "originalName": "users", - "camelCase": { - "unsafeName": "users", - "safeName": "users" - }, - "snakeCase": { - "unsafeName": "users", - "safeName": "users" - }, - "screamingSnakeCase": { - "unsafeName": "USERS", - "safeName": "USERS" - }, - "pascalCase": { - "unsafeName": "Users", - "safeName": "Users" - } - } - ], - "packagePath": [], - "file": { - "originalName": "users", - "camelCase": { - "unsafeName": "users", - "safeName": "users" - }, - "snakeCase": { - "unsafeName": "users", - "safeName": "users" - }, - "screamingSnakeCase": { - "unsafeName": "USERS", - "safeName": "USERS" - }, - "pascalCase": { - "unsafeName": "Users", - "safeName": "Users" - } - } - }, - "typeId": "type_users:Order" - } - } - }, - "allowMultiple": false, - "availability": null, - "docs": null - }, - { - "name": { - "name": { - "originalName": "starting_after", - "camelCase": { - "unsafeName": "startingAfter", - "safeName": "startingAfter" - }, - "snakeCase": { - "unsafeName": "starting_after", - "safeName": "starting_after" - }, - "screamingSnakeCase": { - "unsafeName": "STARTING_AFTER", - "safeName": "STARTING_AFTER" - }, - "pascalCase": { - "unsafeName": "StartingAfter", - "safeName": "StartingAfter" - } - }, - "wireValue": "starting_after" - }, - "valueType": { - "_type": "container", - "container": { - "_type": "optional", - "optional": { - "_type": "primitive", - "primitive": "STRING" - } - } - }, - "allowMultiple": false, - "availability": null, - "docs": "The cursor used for pagination in order to fetch\nthe next page of results." - } - ], - "headers": [], - "requestBody": null, - "sdkRequest": { - "shape": { - "type": "wrapper", - "wrapperName": { - "originalName": "ListUsersCursorPaginationRequest", - "camelCase": { - "unsafeName": "listUsersCursorPaginationRequest", - "safeName": "listUsersCursorPaginationRequest" - }, - "snakeCase": { - "unsafeName": "list_users_cursor_pagination_request", - "safeName": "list_users_cursor_pagination_request" - }, - "screamingSnakeCase": { - "unsafeName": "LIST_USERS_CURSOR_PAGINATION_REQUEST", - "safeName": "LIST_USERS_CURSOR_PAGINATION_REQUEST" - }, - "pascalCase": { - "unsafeName": "ListUsersCursorPaginationRequest", - "safeName": "ListUsersCursorPaginationRequest" - } - }, - "bodyKey": { - "originalName": "body", - "camelCase": { - "unsafeName": "body", - "safeName": "body" - }, - "snakeCase": { - "unsafeName": "body", - "safeName": "body" - }, - "screamingSnakeCase": { - "unsafeName": "BODY", - "safeName": "BODY" - }, - "pascalCase": { - "unsafeName": "Body", - "safeName": "Body" - } - } - }, - "requestParameterName": { - "originalName": "request", - "camelCase": { - "unsafeName": "request", - "safeName": "request" - }, - "snakeCase": { - "unsafeName": "request", - "safeName": "request" - }, - "screamingSnakeCase": { - "unsafeName": "REQUEST", - "safeName": "REQUEST" - }, - "pascalCase": { - "unsafeName": "Request", - "safeName": "Request" - } - } - }, - "response": { - "body": { - "type": "json", - "value": { - "type": "response", - "responseBodyType": { - "_type": "named", - "name": { - "originalName": "ListUsersPaginationResponse", - "camelCase": { - "unsafeName": "listUsersPaginationResponse", - "safeName": "listUsersPaginationResponse" - }, - "snakeCase": { - "unsafeName": "list_users_pagination_response", - "safeName": "list_users_pagination_response" - }, - "screamingSnakeCase": { - "unsafeName": "LIST_USERS_PAGINATION_RESPONSE", - "safeName": "LIST_USERS_PAGINATION_RESPONSE" - }, - "pascalCase": { - "unsafeName": "ListUsersPaginationResponse", - "safeName": "ListUsersPaginationResponse" - } - }, - "fernFilepath": { - "allParts": [ - { - "originalName": "users", - "camelCase": { - "unsafeName": "users", - "safeName": "users" - }, - "snakeCase": { - "unsafeName": "users", - "safeName": "users" - }, - "screamingSnakeCase": { - "unsafeName": "USERS", - "safeName": "USERS" - }, - "pascalCase": { - "unsafeName": "Users", - "safeName": "Users" - } - } - ], - "packagePath": [], - "file": { - "originalName": "users", - "camelCase": { - "unsafeName": "users", - "safeName": "users" - }, - "snakeCase": { - "unsafeName": "users", - "safeName": "users" - }, - "screamingSnakeCase": { - "unsafeName": "USERS", - "safeName": "USERS" - }, - "pascalCase": { - "unsafeName": "Users", - "safeName": "Users" - } - } - }, - "typeId": "type_users:ListUsersPaginationResponse" - }, - "docs": null - } - }, - "status-code": null - }, - "errors": [], - "examples": [ - { - "exampleType": "generated", - "url": "", - "rootPathParameters": [], - "servicePathParameters": [], - "endpointPathParameters": [], - "serviceHeaders": [], - "endpointHeaders": [], - "queryParameters": [ - { - "name": { - "name": { - "originalName": "page", - "camelCase": { - "unsafeName": "page", - "safeName": "page" - }, - "snakeCase": { - "unsafeName": "page", - "safeName": "page" - }, - "screamingSnakeCase": { - "unsafeName": "PAGE", - "safeName": "PAGE" - }, - "pascalCase": { - "unsafeName": "Page", - "safeName": "Page" - } - }, - "wireValue": "page" - }, - "value": { - "shape": { - "type": "primitive", - "primitive": { - "type": "integer", - "integer": 1 - } - }, - "jsonExample": 1 - } - }, - { - "name": { - "name": { - "originalName": "per_page", - "camelCase": { - "unsafeName": "perPage", - "safeName": "perPage" - }, - "snakeCase": { - "unsafeName": "per_page", - "safeName": "per_page" - }, - "screamingSnakeCase": { - "unsafeName": "PER_PAGE", - "safeName": "PER_PAGE" - }, - "pascalCase": { - "unsafeName": "PerPage", - "safeName": "PerPage" - } - }, - "wireValue": "per_page" - }, - "value": { - "shape": { - "type": "primitive", - "primitive": { - "type": "integer", - "integer": 1 - } - }, - "jsonExample": 1 - } - }, - { - "name": { - "name": { - "originalName": "order", - "camelCase": { - "unsafeName": "order", - "safeName": "order" - }, - "snakeCase": { - "unsafeName": "order", - "safeName": "order" - }, - "screamingSnakeCase": { - "unsafeName": "ORDER", - "safeName": "ORDER" - }, - "pascalCase": { - "unsafeName": "Order", - "safeName": "Order" - } - }, - "wireValue": "order" - }, - "value": { - "shape": { - "type": "named", - "typeName": { - "name": { - "originalName": "Order", - "camelCase": { - "unsafeName": "order", - "safeName": "order" - }, - "snakeCase": { - "unsafeName": "order", - "safeName": "order" - }, - "screamingSnakeCase": { - "unsafeName": "ORDER", - "safeName": "ORDER" - }, - "pascalCase": { - "unsafeName": "Order", - "safeName": "Order" - } - }, - "fernFilepath": { - "allParts": [ - { - "originalName": "users", - "camelCase": { - "unsafeName": "users", - "safeName": "users" - }, - "snakeCase": { - "unsafeName": "users", - "safeName": "users" - }, - "screamingSnakeCase": { - "unsafeName": "USERS", - "safeName": "USERS" - }, - "pascalCase": { - "unsafeName": "Users", - "safeName": "Users" - } - } - ], - "packagePath": [], - "file": { - "originalName": "users", - "camelCase": { - "unsafeName": "users", - "safeName": "users" - }, - "snakeCase": { - "unsafeName": "users", - "safeName": "users" - }, - "screamingSnakeCase": { - "unsafeName": "USERS", - "safeName": "USERS" - }, - "pascalCase": { - "unsafeName": "Users", - "safeName": "Users" - } - } - }, - "typeId": "type_users:Order" - }, - "shape": { - "type": "enum", - "value": { - "name": { - "originalName": "asc", - "camelCase": { - "unsafeName": "asc", - "safeName": "asc" - }, - "snakeCase": { - "unsafeName": "asc", - "safeName": "asc" - }, - "screamingSnakeCase": { - "unsafeName": "ASC", - "safeName": "ASC" - }, - "pascalCase": { - "unsafeName": "Asc", - "safeName": "Asc" - } - }, - "wireValue": "asc" - } - } - }, - "jsonExample": "asc" - } - }, - { - "name": { - "name": { - "originalName": "starting_after", - "camelCase": { - "unsafeName": "startingAfter", - "safeName": "startingAfter" - }, - "snakeCase": { - "unsafeName": "starting_after", - "safeName": "starting_after" - }, - "screamingSnakeCase": { - "unsafeName": "STARTING_AFTER", - "safeName": "STARTING_AFTER" - }, - "pascalCase": { - "unsafeName": "StartingAfter", - "safeName": "StartingAfter" - } - }, - "wireValue": "starting_after" - }, - "value": { - "shape": { - "type": "primitive", - "primitive": { - "type": "string", - "string": { - "original": "string" - } - } - }, - "jsonExample": "string" - } - } - ], - "request": null, - "name": null, - "codeSamples": null, - "response": { - "type": "ok", - "body": { - "shape": { - "type": "named", - "typeName": { - "name": { - "originalName": "ListUsersPaginationResponse", - "camelCase": { - "unsafeName": "listUsersPaginationResponse", - "safeName": "listUsersPaginationResponse" - }, - "snakeCase": { - "unsafeName": "list_users_pagination_response", - "safeName": "list_users_pagination_response" - }, - "screamingSnakeCase": { - "unsafeName": "LIST_USERS_PAGINATION_RESPONSE", - "safeName": "LIST_USERS_PAGINATION_RESPONSE" - }, - "pascalCase": { - "unsafeName": "ListUsersPaginationResponse", - "safeName": "ListUsersPaginationResponse" - } - }, - "fernFilepath": { - "allParts": [ - { - "originalName": "users", - "camelCase": { - "unsafeName": "users", - "safeName": "users" - }, - "snakeCase": { - "unsafeName": "users", - "safeName": "users" - }, - "screamingSnakeCase": { - "unsafeName": "USERS", - "safeName": "USERS" - }, - "pascalCase": { - "unsafeName": "Users", - "safeName": "Users" - } - } - ], - "packagePath": [], - "file": { - "originalName": "users", - "camelCase": { - "unsafeName": "users", - "safeName": "users" - }, - "snakeCase": { - "unsafeName": "users", - "safeName": "users" - }, - "screamingSnakeCase": { - "unsafeName": "USERS", - "safeName": "USERS" - }, - "pascalCase": { - "unsafeName": "Users", - "safeName": "Users" - } - } - }, - "typeId": "type_users:ListUsersPaginationResponse" - }, - "shape": { - "type": "object", - "properties": [ - { - "name": { - "name": { - "originalName": "page", - "camelCase": { - "unsafeName": "page", - "safeName": "page" - }, - "snakeCase": { - "unsafeName": "page", - "safeName": "page" - }, - "screamingSnakeCase": { - "unsafeName": "PAGE", - "safeName": "PAGE" - }, - "pascalCase": { - "unsafeName": "Page", - "safeName": "Page" - } - }, - "wireValue": "page" - }, - "value": { - "shape": { - "type": "named", - "typeName": { - "name": { - "originalName": "Page", - "camelCase": { - "unsafeName": "page", - "safeName": "page" - }, - "snakeCase": { - "unsafeName": "page", - "safeName": "page" - }, - "screamingSnakeCase": { - "unsafeName": "PAGE", - "safeName": "PAGE" - }, - "pascalCase": { - "unsafeName": "Page", - "safeName": "Page" - } - }, - "fernFilepath": { - "allParts": [ - { - "originalName": "users", - "camelCase": { - "unsafeName": "users", - "safeName": "users" - }, - "snakeCase": { - "unsafeName": "users", - "safeName": "users" - }, - "screamingSnakeCase": { - "unsafeName": "USERS", - "safeName": "USERS" - }, - "pascalCase": { - "unsafeName": "Users", - "safeName": "Users" - } - } - ], - "packagePath": [], - "file": { - "originalName": "users", - "camelCase": { - "unsafeName": "users", - "safeName": "users" - }, - "snakeCase": { - "unsafeName": "users", - "safeName": "users" - }, - "screamingSnakeCase": { - "unsafeName": "USERS", - "safeName": "USERS" - }, - "pascalCase": { - "unsafeName": "Users", - "safeName": "Users" - } - } - }, - "typeId": "type_users:Page" - }, - "shape": { - "type": "object", - "properties": [] - } - }, - "jsonExample": {} - }, - "originalTypeDeclaration": { - "name": { - "originalName": "ListUsersPaginationResponse", - "camelCase": { - "unsafeName": "listUsersPaginationResponse", - "safeName": "listUsersPaginationResponse" - }, - "snakeCase": { - "unsafeName": "list_users_pagination_response", - "safeName": "list_users_pagination_response" - }, - "screamingSnakeCase": { - "unsafeName": "LIST_USERS_PAGINATION_RESPONSE", - "safeName": "LIST_USERS_PAGINATION_RESPONSE" - }, - "pascalCase": { - "unsafeName": "ListUsersPaginationResponse", - "safeName": "ListUsersPaginationResponse" - } - }, - "fernFilepath": { - "allParts": [ - { - "originalName": "users", - "camelCase": { - "unsafeName": "users", - "safeName": "users" - }, - "snakeCase": { - "unsafeName": "users", - "safeName": "users" - }, - "screamingSnakeCase": { - "unsafeName": "USERS", - "safeName": "USERS" - }, - "pascalCase": { - "unsafeName": "Users", - "safeName": "Users" - } - } - ], - "packagePath": [], - "file": { - "originalName": "users", - "camelCase": { - "unsafeName": "users", - "safeName": "users" - }, - "snakeCase": { - "unsafeName": "users", - "safeName": "users" - }, - "screamingSnakeCase": { - "unsafeName": "USERS", - "safeName": "USERS" - }, - "pascalCase": { - "unsafeName": "Users", - "safeName": "Users" - } - } - }, - "typeId": "type_users:ListUsersPaginationResponse" - } - }, - { - "name": { - "name": { - "originalName": "total_count", - "camelCase": { - "unsafeName": "totalCount", - "safeName": "totalCount" - }, - "snakeCase": { - "unsafeName": "total_count", - "safeName": "total_count" - }, - "screamingSnakeCase": { - "unsafeName": "TOTAL_COUNT", - "safeName": "TOTAL_COUNT" - }, - "pascalCase": { - "unsafeName": "TotalCount", - "safeName": "TotalCount" - } - }, - "wireValue": "total_count" - }, - "value": { - "shape": { - "type": "primitive", - "primitive": { - "type": "integer", - "integer": 1 - } - }, - "jsonExample": 1 - }, - "originalTypeDeclaration": { - "name": { - "originalName": "ListUsersPaginationResponse", - "camelCase": { - "unsafeName": "listUsersPaginationResponse", - "safeName": "listUsersPaginationResponse" - }, - "snakeCase": { - "unsafeName": "list_users_pagination_response", - "safeName": "list_users_pagination_response" - }, - "screamingSnakeCase": { - "unsafeName": "LIST_USERS_PAGINATION_RESPONSE", - "safeName": "LIST_USERS_PAGINATION_RESPONSE" - }, - "pascalCase": { - "unsafeName": "ListUsersPaginationResponse", - "safeName": "ListUsersPaginationResponse" - } - }, - "fernFilepath": { - "allParts": [ - { - "originalName": "users", - "camelCase": { - "unsafeName": "users", - "safeName": "users" - }, - "snakeCase": { - "unsafeName": "users", - "safeName": "users" - }, - "screamingSnakeCase": { - "unsafeName": "USERS", - "safeName": "USERS" - }, - "pascalCase": { - "unsafeName": "Users", - "safeName": "Users" - } - } - ], - "packagePath": [], - "file": { - "originalName": "users", - "camelCase": { - "unsafeName": "users", - "safeName": "users" - }, - "snakeCase": { - "unsafeName": "users", - "safeName": "users" - }, - "screamingSnakeCase": { - "unsafeName": "USERS", - "safeName": "USERS" - }, - "pascalCase": { - "unsafeName": "Users", - "safeName": "Users" - } - } - }, - "typeId": "type_users:ListUsersPaginationResponse" - } - }, - { - "name": { - "name": { - "originalName": "data", - "camelCase": { - "unsafeName": "data", - "safeName": "data" - }, - "snakeCase": { - "unsafeName": "data", - "safeName": "data" - }, - "screamingSnakeCase": { - "unsafeName": "DATA", - "safeName": "DATA" - }, - "pascalCase": { - "unsafeName": "Data", - "safeName": "Data" - } - }, - "wireValue": "data" - }, - "value": { - "shape": { - "type": "container", - "container": { - "type": "list", - "list": [ - { - "shape": { - "type": "named", - "typeName": { - "name": { - "originalName": "User", - "camelCase": { - "unsafeName": "user", - "safeName": "user" - }, - "snakeCase": { - "unsafeName": "user", - "safeName": "user" - }, - "screamingSnakeCase": { - "unsafeName": "USER", - "safeName": "USER" - }, - "pascalCase": { - "unsafeName": "User", - "safeName": "User" - } - }, - "fernFilepath": { - "allParts": [ - { - "originalName": "users", - "camelCase": { - "unsafeName": "users", - "safeName": "users" - }, - "snakeCase": { - "unsafeName": "users", - "safeName": "users" - }, - "screamingSnakeCase": { - "unsafeName": "USERS", - "safeName": "USERS" - }, - "pascalCase": { - "unsafeName": "Users", - "safeName": "Users" - } - } - ], - "packagePath": [], - "file": { - "originalName": "users", - "camelCase": { - "unsafeName": "users", - "safeName": "users" - }, - "snakeCase": { - "unsafeName": "users", - "safeName": "users" - }, - "screamingSnakeCase": { - "unsafeName": "USERS", - "safeName": "USERS" - }, - "pascalCase": { - "unsafeName": "Users", - "safeName": "Users" - } - } - }, - "typeId": "type_users:User" - }, - "shape": { - "type": "object", - "properties": [] - } - }, - "jsonExample": {} - } - ] - } - }, - "jsonExample": [ - {} - ] - }, - "originalTypeDeclaration": { - "name": { - "originalName": "ListUsersPaginationResponse", - "camelCase": { - "unsafeName": "listUsersPaginationResponse", - "safeName": "listUsersPaginationResponse" - }, - "snakeCase": { - "unsafeName": "list_users_pagination_response", - "safeName": "list_users_pagination_response" - }, - "screamingSnakeCase": { - "unsafeName": "LIST_USERS_PAGINATION_RESPONSE", - "safeName": "LIST_USERS_PAGINATION_RESPONSE" - }, - "pascalCase": { - "unsafeName": "ListUsersPaginationResponse", - "safeName": "ListUsersPaginationResponse" - } - }, - "fernFilepath": { - "allParts": [ - { - "originalName": "users", - "camelCase": { - "unsafeName": "users", - "safeName": "users" - }, - "snakeCase": { - "unsafeName": "users", - "safeName": "users" - }, - "screamingSnakeCase": { - "unsafeName": "USERS", - "safeName": "USERS" - }, - "pascalCase": { - "unsafeName": "Users", - "safeName": "Users" - } - } - ], - "packagePath": [], - "file": { - "originalName": "users", - "camelCase": { - "unsafeName": "users", - "safeName": "users" - }, - "snakeCase": { - "unsafeName": "users", - "safeName": "users" - }, - "screamingSnakeCase": { - "unsafeName": "USERS", - "safeName": "USERS" - }, - "pascalCase": { - "unsafeName": "Users", - "safeName": "Users" - } - } - }, - "typeId": "type_users:ListUsersPaginationResponse" - } - } - ] - } - }, - "jsonExample": { - "page": {}, - "total_count": 1, - "data": [ - {} - ] - } - } - }, - "docs": null - } - ], - "pagination": { - "type": "cursor", - "page": { - "name": { - "name": { - "originalName": "starting_after", - "camelCase": { - "unsafeName": "startingAfter", - "safeName": "startingAfter" - }, - "snakeCase": { - "unsafeName": "starting_after", - "safeName": "starting_after" - }, - "screamingSnakeCase": { - "unsafeName": "STARTING_AFTER", - "safeName": "STARTING_AFTER" - }, - "pascalCase": { - "unsafeName": "StartingAfter", - "safeName": "StartingAfter" - } - }, - "wireValue": "starting_after" - }, - "valueType": { - "_type": "container", - "container": { - "_type": "optional", - "optional": { - "_type": "primitive", - "primitive": "STRING" - } - } - }, - "allowMultiple": false, - "availability": null, - "docs": "The cursor used for pagination in order to fetch\nthe next page of results." - }, - "next": { - "propertyPath": [ - { - "originalName": "page", - "camelCase": { - "unsafeName": "page", - "safeName": "page" - }, - "snakeCase": { - "unsafeName": "page", - "safeName": "page" - }, - "screamingSnakeCase": { - "unsafeName": "PAGE", - "safeName": "PAGE" - }, - "pascalCase": { - "unsafeName": "Page", - "safeName": "Page" - } - }, - { - "originalName": "next", - "camelCase": { - "unsafeName": "next", - "safeName": "next" - }, - "snakeCase": { - "unsafeName": "next", - "safeName": "next" - }, - "screamingSnakeCase": { - "unsafeName": "NEXT", - "safeName": "NEXT" - }, - "pascalCase": { - "unsafeName": "Next", - "safeName": "Next" - } - } - ], - "property": { - "name": { - "name": { - "originalName": "starting_after", - "camelCase": { - "unsafeName": "startingAfter", - "safeName": "startingAfter" - }, - "snakeCase": { - "unsafeName": "starting_after", - "safeName": "starting_after" - }, - "screamingSnakeCase": { - "unsafeName": "STARTING_AFTER", - "safeName": "STARTING_AFTER" - }, - "pascalCase": { - "unsafeName": "StartingAfter", - "safeName": "StartingAfter" - } - }, - "wireValue": "starting_after" - }, - "valueType": { - "_type": "primitive", - "primitive": "STRING" - }, - "availability": null, - "docs": null - } - }, - "results": { - "propertyPath": [], - "property": { - "name": { - "name": { - "originalName": "data", - "camelCase": { - "unsafeName": "data", - "safeName": "data" - }, - "snakeCase": { - "unsafeName": "data", - "safeName": "data" - }, - "screamingSnakeCase": { - "unsafeName": "DATA", - "safeName": "DATA" - }, - "pascalCase": { - "unsafeName": "Data", - "safeName": "Data" - } - }, - "wireValue": "data" - }, - "valueType": { - "_type": "container", - "container": { - "_type": "list", - "list": { - "_type": "named", - "name": { - "originalName": "User", - "camelCase": { - "unsafeName": "user", - "safeName": "user" - }, - "snakeCase": { - "unsafeName": "user", - "safeName": "user" - }, - "screamingSnakeCase": { - "unsafeName": "USER", - "safeName": "USER" - }, - "pascalCase": { - "unsafeName": "User", - "safeName": "User" - } - }, - "fernFilepath": { - "allParts": [ - { - "originalName": "users", - "camelCase": { - "unsafeName": "users", - "safeName": "users" - }, - "snakeCase": { - "unsafeName": "users", - "safeName": "users" - }, - "screamingSnakeCase": { - "unsafeName": "USERS", - "safeName": "USERS" - }, - "pascalCase": { - "unsafeName": "Users", - "safeName": "Users" - } - } - ], - "packagePath": [], - "file": { - "originalName": "users", - "camelCase": { - "unsafeName": "users", - "safeName": "users" - }, - "snakeCase": { - "unsafeName": "users", - "safeName": "users" - }, - "screamingSnakeCase": { - "unsafeName": "USERS", - "safeName": "USERS" - }, - "pascalCase": { - "unsafeName": "Users", - "safeName": "Users" - } - } - }, - "typeId": "type_users:User" - } - } - }, - "availability": null, - "docs": null - } - } - }, - "availability": null, - "docs": null - }, - { - "id": "endpoint_users.listWithOffsetPagination", - "name": { - "originalName": "listWithOffsetPagination", - "camelCase": { - "unsafeName": "listWithOffsetPagination", - "safeName": "listWithOffsetPagination" - }, - "snakeCase": { - "unsafeName": "list_with_offset_pagination", - "safeName": "list_with_offset_pagination" - }, - "screamingSnakeCase": { - "unsafeName": "LIST_WITH_OFFSET_PAGINATION", - "safeName": "LIST_WITH_OFFSET_PAGINATION" - }, - "pascalCase": { - "unsafeName": "ListWithOffsetPagination", - "safeName": "ListWithOffsetPagination" - } - }, - "displayName": null, - "auth": false, - "idempotent": false, - "baseUrl": null, - "method": "GET", - "path": { - "head": "", - "parts": [] - }, - "fullPath": { - "head": "/users", - "parts": [] - }, - "pathParameters": [], - "allPathParameters": [], - "queryParameters": [ - { - "name": { - "name": { - "originalName": "page", - "camelCase": { - "unsafeName": "page", - "safeName": "page" - }, - "snakeCase": { - "unsafeName": "page", - "safeName": "page" - }, - "screamingSnakeCase": { - "unsafeName": "PAGE", - "safeName": "PAGE" - }, - "pascalCase": { - "unsafeName": "Page", - "safeName": "Page" - } - }, - "wireValue": "page" - }, - "valueType": { - "_type": "container", - "container": { - "_type": "optional", - "optional": { - "_type": "primitive", - "primitive": "INTEGER" - } - } - }, - "allowMultiple": false, - "availability": null, - "docs": "Defaults to first page" - }, - { - "name": { - "name": { - "originalName": "per_page", - "camelCase": { - "unsafeName": "perPage", - "safeName": "perPage" - }, - "snakeCase": { - "unsafeName": "per_page", - "safeName": "per_page" - }, - "screamingSnakeCase": { - "unsafeName": "PER_PAGE", - "safeName": "PER_PAGE" - }, - "pascalCase": { - "unsafeName": "PerPage", - "safeName": "PerPage" - } - }, - "wireValue": "per_page" - }, - "valueType": { - "_type": "container", - "container": { - "_type": "optional", - "optional": { - "_type": "primitive", - "primitive": "INTEGER" - } - } - }, - "allowMultiple": false, - "availability": null, - "docs": "Defaults to per page" - }, - { - "name": { - "name": { - "originalName": "order", - "camelCase": { - "unsafeName": "order", - "safeName": "order" - }, - "snakeCase": { - "unsafeName": "order", - "safeName": "order" - }, - "screamingSnakeCase": { - "unsafeName": "ORDER", - "safeName": "ORDER" - }, - "pascalCase": { - "unsafeName": "Order", - "safeName": "Order" - } - }, - "wireValue": "order" - }, - "valueType": { - "_type": "container", - "container": { - "_type": "optional", - "optional": { - "_type": "named", - "name": { - "originalName": "Order", - "camelCase": { - "unsafeName": "order", - "safeName": "order" - }, - "snakeCase": { - "unsafeName": "order", - "safeName": "order" - }, - "screamingSnakeCase": { - "unsafeName": "ORDER", - "safeName": "ORDER" - }, - "pascalCase": { - "unsafeName": "Order", - "safeName": "Order" - } - }, - "fernFilepath": { - "allParts": [ - { - "originalName": "users", - "camelCase": { - "unsafeName": "users", - "safeName": "users" - }, - "snakeCase": { - "unsafeName": "users", - "safeName": "users" - }, - "screamingSnakeCase": { - "unsafeName": "USERS", - "safeName": "USERS" - }, - "pascalCase": { - "unsafeName": "Users", - "safeName": "Users" - } - } - ], - "packagePath": [], - "file": { - "originalName": "users", - "camelCase": { - "unsafeName": "users", - "safeName": "users" - }, - "snakeCase": { - "unsafeName": "users", - "safeName": "users" - }, - "screamingSnakeCase": { - "unsafeName": "USERS", - "safeName": "USERS" - }, - "pascalCase": { - "unsafeName": "Users", - "safeName": "Users" - } - } - }, - "typeId": "type_users:Order" - } - } - }, - "allowMultiple": false, - "availability": null, - "docs": null - }, - { - "name": { - "name": { - "originalName": "starting_after", - "camelCase": { - "unsafeName": "startingAfter", - "safeName": "startingAfter" - }, - "snakeCase": { - "unsafeName": "starting_after", - "safeName": "starting_after" - }, - "screamingSnakeCase": { - "unsafeName": "STARTING_AFTER", - "safeName": "STARTING_AFTER" - }, - "pascalCase": { - "unsafeName": "StartingAfter", - "safeName": "StartingAfter" - } - }, - "wireValue": "starting_after" - }, - "valueType": { - "_type": "container", - "container": { - "_type": "optional", - "optional": { - "_type": "primitive", - "primitive": "STRING" - } - } - }, - "allowMultiple": false, - "availability": null, - "docs": "The cursor used for pagination in order to fetch\nthe next page of results." - } - ], - "headers": [], - "requestBody": null, - "sdkRequest": { - "shape": { - "type": "wrapper", - "wrapperName": { - "originalName": "ListUsersOffsetPaginationRequest", - "camelCase": { - "unsafeName": "listUsersOffsetPaginationRequest", - "safeName": "listUsersOffsetPaginationRequest" - }, - "snakeCase": { - "unsafeName": "list_users_offset_pagination_request", - "safeName": "list_users_offset_pagination_request" - }, - "screamingSnakeCase": { - "unsafeName": "LIST_USERS_OFFSET_PAGINATION_REQUEST", - "safeName": "LIST_USERS_OFFSET_PAGINATION_REQUEST" - }, - "pascalCase": { - "unsafeName": "ListUsersOffsetPaginationRequest", - "safeName": "ListUsersOffsetPaginationRequest" - } - }, - "bodyKey": { - "originalName": "body", - "camelCase": { - "unsafeName": "body", - "safeName": "body" - }, - "snakeCase": { - "unsafeName": "body", - "safeName": "body" - }, - "screamingSnakeCase": { - "unsafeName": "BODY", - "safeName": "BODY" - }, - "pascalCase": { - "unsafeName": "Body", - "safeName": "Body" - } - } - }, - "requestParameterName": { - "originalName": "request", - "camelCase": { - "unsafeName": "request", - "safeName": "request" - }, - "snakeCase": { - "unsafeName": "request", - "safeName": "request" - }, - "screamingSnakeCase": { - "unsafeName": "REQUEST", - "safeName": "REQUEST" - }, - "pascalCase": { - "unsafeName": "Request", - "safeName": "Request" - } - } - }, - "response": { - "body": { - "type": "json", - "value": { - "type": "response", - "responseBodyType": { - "_type": "named", - "name": { - "originalName": "ListUsersPaginationResponse", - "camelCase": { - "unsafeName": "listUsersPaginationResponse", - "safeName": "listUsersPaginationResponse" - }, - "snakeCase": { - "unsafeName": "list_users_pagination_response", - "safeName": "list_users_pagination_response" - }, - "screamingSnakeCase": { - "unsafeName": "LIST_USERS_PAGINATION_RESPONSE", - "safeName": "LIST_USERS_PAGINATION_RESPONSE" - }, - "pascalCase": { - "unsafeName": "ListUsersPaginationResponse", - "safeName": "ListUsersPaginationResponse" - } - }, - "fernFilepath": { - "allParts": [ - { - "originalName": "users", - "camelCase": { - "unsafeName": "users", - "safeName": "users" - }, - "snakeCase": { - "unsafeName": "users", - "safeName": "users" - }, - "screamingSnakeCase": { - "unsafeName": "USERS", - "safeName": "USERS" - }, - "pascalCase": { - "unsafeName": "Users", - "safeName": "Users" - } - } - ], - "packagePath": [], - "file": { - "originalName": "users", - "camelCase": { - "unsafeName": "users", - "safeName": "users" - }, - "snakeCase": { - "unsafeName": "users", - "safeName": "users" - }, - "screamingSnakeCase": { - "unsafeName": "USERS", - "safeName": "USERS" - }, - "pascalCase": { - "unsafeName": "Users", - "safeName": "Users" - } - } - }, - "typeId": "type_users:ListUsersPaginationResponse" - }, - "docs": null - } - }, - "status-code": null - }, - "errors": [], - "examples": [ - { - "exampleType": "generated", - "url": "", - "rootPathParameters": [], - "servicePathParameters": [], - "endpointPathParameters": [], - "serviceHeaders": [], - "endpointHeaders": [], - "queryParameters": [ - { - "name": { - "name": { - "originalName": "page", - "camelCase": { - "unsafeName": "page", - "safeName": "page" - }, - "snakeCase": { - "unsafeName": "page", - "safeName": "page" - }, - "screamingSnakeCase": { - "unsafeName": "PAGE", - "safeName": "PAGE" - }, - "pascalCase": { - "unsafeName": "Page", - "safeName": "Page" - } - }, - "wireValue": "page" - }, - "value": { - "shape": { - "type": "primitive", - "primitive": { - "type": "integer", - "integer": 1 - } - }, - "jsonExample": 1 - } - }, - { - "name": { - "name": { - "originalName": "per_page", - "camelCase": { - "unsafeName": "perPage", - "safeName": "perPage" - }, - "snakeCase": { - "unsafeName": "per_page", - "safeName": "per_page" - }, - "screamingSnakeCase": { - "unsafeName": "PER_PAGE", - "safeName": "PER_PAGE" - }, - "pascalCase": { - "unsafeName": "PerPage", - "safeName": "PerPage" - } - }, - "wireValue": "per_page" - }, - "value": { - "shape": { - "type": "primitive", - "primitive": { - "type": "integer", - "integer": 1 - } - }, - "jsonExample": 1 - } - }, - { - "name": { - "name": { - "originalName": "order", - "camelCase": { - "unsafeName": "order", - "safeName": "order" - }, - "snakeCase": { - "unsafeName": "order", - "safeName": "order" - }, - "screamingSnakeCase": { - "unsafeName": "ORDER", - "safeName": "ORDER" - }, - "pascalCase": { - "unsafeName": "Order", - "safeName": "Order" - } - }, - "wireValue": "order" - }, - "value": { - "shape": { - "type": "named", - "typeName": { - "name": { - "originalName": "Order", - "camelCase": { - "unsafeName": "order", - "safeName": "order" - }, - "snakeCase": { - "unsafeName": "order", - "safeName": "order" - }, - "screamingSnakeCase": { - "unsafeName": "ORDER", - "safeName": "ORDER" - }, - "pascalCase": { - "unsafeName": "Order", - "safeName": "Order" - } - }, - "fernFilepath": { - "allParts": [ - { - "originalName": "users", - "camelCase": { - "unsafeName": "users", - "safeName": "users" - }, - "snakeCase": { - "unsafeName": "users", - "safeName": "users" - }, - "screamingSnakeCase": { - "unsafeName": "USERS", - "safeName": "USERS" - }, - "pascalCase": { - "unsafeName": "Users", - "safeName": "Users" - } - } - ], - "packagePath": [], - "file": { - "originalName": "users", - "camelCase": { - "unsafeName": "users", - "safeName": "users" - }, - "snakeCase": { - "unsafeName": "users", - "safeName": "users" - }, - "screamingSnakeCase": { - "unsafeName": "USERS", - "safeName": "USERS" - }, - "pascalCase": { - "unsafeName": "Users", - "safeName": "Users" - } - } - }, - "typeId": "type_users:Order" - }, - "shape": { - "type": "enum", - "value": { - "name": { - "originalName": "asc", - "camelCase": { - "unsafeName": "asc", - "safeName": "asc" - }, - "snakeCase": { - "unsafeName": "asc", - "safeName": "asc" - }, - "screamingSnakeCase": { - "unsafeName": "ASC", - "safeName": "ASC" - }, - "pascalCase": { - "unsafeName": "Asc", - "safeName": "Asc" - } - }, - "wireValue": "asc" - } - } - }, - "jsonExample": "asc" - } - }, - { - "name": { - "name": { - "originalName": "starting_after", - "camelCase": { - "unsafeName": "startingAfter", - "safeName": "startingAfter" - }, - "snakeCase": { - "unsafeName": "starting_after", - "safeName": "starting_after" - }, - "screamingSnakeCase": { - "unsafeName": "STARTING_AFTER", - "safeName": "STARTING_AFTER" - }, - "pascalCase": { - "unsafeName": "StartingAfter", - "safeName": "StartingAfter" - } - }, - "wireValue": "starting_after" - }, - "value": { - "shape": { - "type": "primitive", - "primitive": { - "type": "string", - "string": { - "original": "string" - } - } - }, - "jsonExample": "string" - } - } - ], - "request": null, - "name": null, - "codeSamples": null, - "response": { - "type": "ok", - "body": { - "shape": { - "type": "named", - "typeName": { - "name": { - "originalName": "ListUsersPaginationResponse", - "camelCase": { - "unsafeName": "listUsersPaginationResponse", - "safeName": "listUsersPaginationResponse" - }, - "snakeCase": { - "unsafeName": "list_users_pagination_response", - "safeName": "list_users_pagination_response" - }, - "screamingSnakeCase": { - "unsafeName": "LIST_USERS_PAGINATION_RESPONSE", - "safeName": "LIST_USERS_PAGINATION_RESPONSE" - }, - "pascalCase": { - "unsafeName": "ListUsersPaginationResponse", - "safeName": "ListUsersPaginationResponse" - } - }, - "fernFilepath": { - "allParts": [ - { - "originalName": "users", - "camelCase": { - "unsafeName": "users", - "safeName": "users" - }, - "snakeCase": { - "unsafeName": "users", - "safeName": "users" - }, - "screamingSnakeCase": { - "unsafeName": "USERS", - "safeName": "USERS" - }, - "pascalCase": { - "unsafeName": "Users", - "safeName": "Users" - } - } - ], - "packagePath": [], - "file": { - "originalName": "users", - "camelCase": { - "unsafeName": "users", - "safeName": "users" - }, - "snakeCase": { - "unsafeName": "users", - "safeName": "users" - }, - "screamingSnakeCase": { - "unsafeName": "USERS", - "safeName": "USERS" - }, - "pascalCase": { - "unsafeName": "Users", - "safeName": "Users" - } - } - }, - "typeId": "type_users:ListUsersPaginationResponse" - }, - "shape": { - "type": "object", - "properties": [ - { - "name": { - "name": { - "originalName": "page", - "camelCase": { - "unsafeName": "page", - "safeName": "page" - }, - "snakeCase": { - "unsafeName": "page", - "safeName": "page" - }, - "screamingSnakeCase": { - "unsafeName": "PAGE", - "safeName": "PAGE" - }, - "pascalCase": { - "unsafeName": "Page", - "safeName": "Page" - } - }, - "wireValue": "page" - }, - "value": { - "shape": { - "type": "named", - "typeName": { - "name": { - "originalName": "Page", - "camelCase": { - "unsafeName": "page", - "safeName": "page" - }, - "snakeCase": { - "unsafeName": "page", - "safeName": "page" - }, - "screamingSnakeCase": { - "unsafeName": "PAGE", - "safeName": "PAGE" - }, - "pascalCase": { - "unsafeName": "Page", - "safeName": "Page" - } - }, - "fernFilepath": { - "allParts": [ - { - "originalName": "users", - "camelCase": { - "unsafeName": "users", - "safeName": "users" - }, - "snakeCase": { - "unsafeName": "users", - "safeName": "users" - }, - "screamingSnakeCase": { - "unsafeName": "USERS", - "safeName": "USERS" - }, - "pascalCase": { - "unsafeName": "Users", - "safeName": "Users" - } - } - ], - "packagePath": [], - "file": { - "originalName": "users", - "camelCase": { - "unsafeName": "users", - "safeName": "users" - }, - "snakeCase": { - "unsafeName": "users", - "safeName": "users" - }, - "screamingSnakeCase": { - "unsafeName": "USERS", - "safeName": "USERS" - }, - "pascalCase": { - "unsafeName": "Users", - "safeName": "Users" - } - } - }, - "typeId": "type_users:Page" - }, - "shape": { - "type": "object", - "properties": [] - } - }, - "jsonExample": {} - }, - "originalTypeDeclaration": { - "name": { - "originalName": "ListUsersPaginationResponse", - "camelCase": { - "unsafeName": "listUsersPaginationResponse", - "safeName": "listUsersPaginationResponse" - }, - "snakeCase": { - "unsafeName": "list_users_pagination_response", - "safeName": "list_users_pagination_response" - }, - "screamingSnakeCase": { - "unsafeName": "LIST_USERS_PAGINATION_RESPONSE", - "safeName": "LIST_USERS_PAGINATION_RESPONSE" - }, - "pascalCase": { - "unsafeName": "ListUsersPaginationResponse", - "safeName": "ListUsersPaginationResponse" - } - }, - "fernFilepath": { - "allParts": [ - { - "originalName": "users", - "camelCase": { - "unsafeName": "users", - "safeName": "users" - }, - "snakeCase": { - "unsafeName": "users", - "safeName": "users" - }, - "screamingSnakeCase": { - "unsafeName": "USERS", - "safeName": "USERS" - }, - "pascalCase": { - "unsafeName": "Users", - "safeName": "Users" - } - } - ], - "packagePath": [], - "file": { - "originalName": "users", - "camelCase": { - "unsafeName": "users", - "safeName": "users" - }, - "snakeCase": { - "unsafeName": "users", - "safeName": "users" - }, - "screamingSnakeCase": { - "unsafeName": "USERS", - "safeName": "USERS" - }, - "pascalCase": { - "unsafeName": "Users", - "safeName": "Users" - } - } - }, - "typeId": "type_users:ListUsersPaginationResponse" - } - }, - { - "name": { - "name": { - "originalName": "total_count", - "camelCase": { - "unsafeName": "totalCount", - "safeName": "totalCount" - }, - "snakeCase": { - "unsafeName": "total_count", - "safeName": "total_count" - }, - "screamingSnakeCase": { - "unsafeName": "TOTAL_COUNT", - "safeName": "TOTAL_COUNT" - }, - "pascalCase": { - "unsafeName": "TotalCount", - "safeName": "TotalCount" - } - }, - "wireValue": "total_count" - }, - "value": { - "shape": { - "type": "primitive", - "primitive": { - "type": "integer", - "integer": 1 - } - }, - "jsonExample": 1 - }, - "originalTypeDeclaration": { - "name": { - "originalName": "ListUsersPaginationResponse", - "camelCase": { - "unsafeName": "listUsersPaginationResponse", - "safeName": "listUsersPaginationResponse" - }, - "snakeCase": { - "unsafeName": "list_users_pagination_response", - "safeName": "list_users_pagination_response" - }, - "screamingSnakeCase": { - "unsafeName": "LIST_USERS_PAGINATION_RESPONSE", - "safeName": "LIST_USERS_PAGINATION_RESPONSE" - }, - "pascalCase": { - "unsafeName": "ListUsersPaginationResponse", - "safeName": "ListUsersPaginationResponse" - } - }, - "fernFilepath": { - "allParts": [ - { - "originalName": "users", - "camelCase": { - "unsafeName": "users", - "safeName": "users" - }, - "snakeCase": { - "unsafeName": "users", - "safeName": "users" - }, - "screamingSnakeCase": { - "unsafeName": "USERS", - "safeName": "USERS" - }, - "pascalCase": { - "unsafeName": "Users", - "safeName": "Users" - } - } - ], - "packagePath": [], - "file": { - "originalName": "users", - "camelCase": { - "unsafeName": "users", - "safeName": "users" - }, - "snakeCase": { - "unsafeName": "users", - "safeName": "users" - }, - "screamingSnakeCase": { - "unsafeName": "USERS", - "safeName": "USERS" - }, - "pascalCase": { - "unsafeName": "Users", - "safeName": "Users" - } - } - }, - "typeId": "type_users:ListUsersPaginationResponse" - } - }, - { - "name": { - "name": { - "originalName": "data", - "camelCase": { - "unsafeName": "data", - "safeName": "data" - }, - "snakeCase": { - "unsafeName": "data", - "safeName": "data" - }, - "screamingSnakeCase": { - "unsafeName": "DATA", - "safeName": "DATA" - }, - "pascalCase": { - "unsafeName": "Data", - "safeName": "Data" - } - }, - "wireValue": "data" - }, - "value": { - "shape": { - "type": "container", - "container": { - "type": "list", - "list": [ - { - "shape": { - "type": "named", - "typeName": { - "name": { - "originalName": "User", - "camelCase": { - "unsafeName": "user", - "safeName": "user" - }, - "snakeCase": { - "unsafeName": "user", - "safeName": "user" - }, - "screamingSnakeCase": { - "unsafeName": "USER", - "safeName": "USER" - }, - "pascalCase": { - "unsafeName": "User", - "safeName": "User" - } - }, - "fernFilepath": { - "allParts": [ - { - "originalName": "users", - "camelCase": { - "unsafeName": "users", - "safeName": "users" - }, - "snakeCase": { - "unsafeName": "users", - "safeName": "users" - }, - "screamingSnakeCase": { - "unsafeName": "USERS", - "safeName": "USERS" - }, - "pascalCase": { - "unsafeName": "Users", - "safeName": "Users" - } - } - ], - "packagePath": [], - "file": { - "originalName": "users", - "camelCase": { - "unsafeName": "users", - "safeName": "users" - }, - "snakeCase": { - "unsafeName": "users", - "safeName": "users" - }, - "screamingSnakeCase": { - "unsafeName": "USERS", - "safeName": "USERS" - }, - "pascalCase": { - "unsafeName": "Users", - "safeName": "Users" - } - } - }, - "typeId": "type_users:User" - }, - "shape": { - "type": "object", - "properties": [] - } - }, - "jsonExample": {} - } - ] - } - }, - "jsonExample": [ - {} - ] - }, - "originalTypeDeclaration": { - "name": { - "originalName": "ListUsersPaginationResponse", - "camelCase": { - "unsafeName": "listUsersPaginationResponse", - "safeName": "listUsersPaginationResponse" - }, - "snakeCase": { - "unsafeName": "list_users_pagination_response", - "safeName": "list_users_pagination_response" - }, - "screamingSnakeCase": { - "unsafeName": "LIST_USERS_PAGINATION_RESPONSE", - "safeName": "LIST_USERS_PAGINATION_RESPONSE" - }, - "pascalCase": { - "unsafeName": "ListUsersPaginationResponse", - "safeName": "ListUsersPaginationResponse" - } - }, - "fernFilepath": { - "allParts": [ - { - "originalName": "users", - "camelCase": { - "unsafeName": "users", - "safeName": "users" - }, - "snakeCase": { - "unsafeName": "users", - "safeName": "users" - }, - "screamingSnakeCase": { - "unsafeName": "USERS", - "safeName": "USERS" - }, - "pascalCase": { - "unsafeName": "Users", - "safeName": "Users" - } - } - ], - "packagePath": [], - "file": { - "originalName": "users", - "camelCase": { - "unsafeName": "users", - "safeName": "users" - }, - "snakeCase": { - "unsafeName": "users", - "safeName": "users" - }, - "screamingSnakeCase": { - "unsafeName": "USERS", - "safeName": "USERS" - }, - "pascalCase": { - "unsafeName": "Users", - "safeName": "Users" - } - } - }, - "typeId": "type_users:ListUsersPaginationResponse" - } - } - ] - } - }, - "jsonExample": { - "page": {}, - "total_count": 1, - "data": [ - {} - ] - } - } - }, - "docs": null - } - ], - "pagination": { - "type": "offset", - "page": { - "name": { - "name": { - "originalName": "page", - "camelCase": { - "unsafeName": "page", - "safeName": "page" - }, - "snakeCase": { - "unsafeName": "page", - "safeName": "page" - }, - "screamingSnakeCase": { - "unsafeName": "PAGE", - "safeName": "PAGE" - }, - "pascalCase": { - "unsafeName": "Page", - "safeName": "Page" - } - }, - "wireValue": "page" - }, - "valueType": { - "_type": "container", - "container": { - "_type": "optional", - "optional": { - "_type": "primitive", - "primitive": "INTEGER" - } - } - }, - "allowMultiple": false, - "availability": null, - "docs": "Defaults to first page" - }, - "results": { - "propertyPath": [], - "property": { - "name": { - "name": { - "originalName": "data", - "camelCase": { - "unsafeName": "data", - "safeName": "data" - }, - "snakeCase": { - "unsafeName": "data", - "safeName": "data" - }, - "screamingSnakeCase": { - "unsafeName": "DATA", - "safeName": "DATA" - }, - "pascalCase": { - "unsafeName": "Data", - "safeName": "Data" - } - }, - "wireValue": "data" - }, - "valueType": { - "_type": "container", - "container": { - "_type": "list", - "list": { - "_type": "named", - "name": { - "originalName": "User", - "camelCase": { - "unsafeName": "user", - "safeName": "user" - }, - "snakeCase": { - "unsafeName": "user", - "safeName": "user" - }, - "screamingSnakeCase": { - "unsafeName": "USER", - "safeName": "USER" - }, - "pascalCase": { - "unsafeName": "User", - "safeName": "User" - } - }, - "fernFilepath": { - "allParts": [ - { - "originalName": "users", - "camelCase": { - "unsafeName": "users", - "safeName": "users" - }, - "snakeCase": { - "unsafeName": "users", - "safeName": "users" - }, - "screamingSnakeCase": { - "unsafeName": "USERS", - "safeName": "USERS" - }, - "pascalCase": { - "unsafeName": "Users", - "safeName": "Users" - } - } - ], - "packagePath": [], - "file": { - "originalName": "users", - "camelCase": { - "unsafeName": "users", - "safeName": "users" - }, - "snakeCase": { - "unsafeName": "users", - "safeName": "users" - }, - "screamingSnakeCase": { - "unsafeName": "USERS", - "safeName": "USERS" - }, - "pascalCase": { - "unsafeName": "Users", - "safeName": "Users" - } - } - }, - "typeId": "type_users:User" - } - } - }, - "availability": null, - "docs": null - } - } - }, - "availability": null, - "docs": null - }, - { - "id": "endpoint_users.listWithExtendedResults", - "name": { - "originalName": "listWithExtendedResults", - "camelCase": { - "unsafeName": "listWithExtendedResults", - "safeName": "listWithExtendedResults" - }, - "snakeCase": { - "unsafeName": "list_with_extended_results", - "safeName": "list_with_extended_results" - }, - "screamingSnakeCase": { - "unsafeName": "LIST_WITH_EXTENDED_RESULTS", - "safeName": "LIST_WITH_EXTENDED_RESULTS" - }, - "pascalCase": { - "unsafeName": "ListWithExtendedResults", - "safeName": "ListWithExtendedResults" - } - }, - "displayName": null, - "auth": false, - "idempotent": false, - "baseUrl": null, - "method": "GET", - "path": { - "head": "", - "parts": [] - }, - "fullPath": { - "head": "/users", - "parts": [] - }, - "pathParameters": [], - "allPathParameters": [], - "queryParameters": [ - { - "name": { - "name": { - "originalName": "cursor", - "camelCase": { - "unsafeName": "cursor", - "safeName": "cursor" - }, - "snakeCase": { - "unsafeName": "cursor", - "safeName": "cursor" - }, - "screamingSnakeCase": { - "unsafeName": "CURSOR", - "safeName": "CURSOR" - }, - "pascalCase": { - "unsafeName": "Cursor", - "safeName": "Cursor" - } - }, - "wireValue": "cursor" - }, - "valueType": { - "_type": "container", - "container": { - "_type": "optional", - "optional": { - "_type": "primitive", - "primitive": "UUID" - } - } - }, - "allowMultiple": false, - "availability": null, - "docs": null - } - ], - "headers": [], - "requestBody": null, - "sdkRequest": { - "shape": { - "type": "wrapper", - "wrapperName": { - "originalName": "ListUsersExtendedRequest", - "camelCase": { - "unsafeName": "listUsersExtendedRequest", - "safeName": "listUsersExtendedRequest" - }, - "snakeCase": { - "unsafeName": "list_users_extended_request", - "safeName": "list_users_extended_request" - }, - "screamingSnakeCase": { - "unsafeName": "LIST_USERS_EXTENDED_REQUEST", - "safeName": "LIST_USERS_EXTENDED_REQUEST" - }, - "pascalCase": { - "unsafeName": "ListUsersExtendedRequest", - "safeName": "ListUsersExtendedRequest" - } - }, - "bodyKey": { - "originalName": "body", - "camelCase": { - "unsafeName": "body", - "safeName": "body" - }, - "snakeCase": { - "unsafeName": "body", - "safeName": "body" - }, - "screamingSnakeCase": { - "unsafeName": "BODY", - "safeName": "BODY" - }, - "pascalCase": { - "unsafeName": "Body", - "safeName": "Body" - } - } - }, - "requestParameterName": { - "originalName": "request", - "camelCase": { - "unsafeName": "request", - "safeName": "request" - }, - "snakeCase": { - "unsafeName": "request", - "safeName": "request" - }, - "screamingSnakeCase": { - "unsafeName": "REQUEST", - "safeName": "REQUEST" - }, - "pascalCase": { - "unsafeName": "Request", - "safeName": "Request" - } - } - }, - "response": { - "body": { - "type": "json", - "value": { - "type": "response", - "responseBodyType": { - "_type": "named", - "name": { - "originalName": "ListUsersExtendedResponse", - "camelCase": { - "unsafeName": "listUsersExtendedResponse", - "safeName": "listUsersExtendedResponse" - }, - "snakeCase": { - "unsafeName": "list_users_extended_response", - "safeName": "list_users_extended_response" - }, - "screamingSnakeCase": { - "unsafeName": "LIST_USERS_EXTENDED_RESPONSE", - "safeName": "LIST_USERS_EXTENDED_RESPONSE" - }, - "pascalCase": { - "unsafeName": "ListUsersExtendedResponse", - "safeName": "ListUsersExtendedResponse" - } - }, - "fernFilepath": { - "allParts": [ - { - "originalName": "users", - "camelCase": { - "unsafeName": "users", - "safeName": "users" - }, - "snakeCase": { - "unsafeName": "users", - "safeName": "users" - }, - "screamingSnakeCase": { - "unsafeName": "USERS", - "safeName": "USERS" - }, - "pascalCase": { - "unsafeName": "Users", - "safeName": "Users" - } - } - ], - "packagePath": [], - "file": { - "originalName": "users", - "camelCase": { - "unsafeName": "users", - "safeName": "users" - }, - "snakeCase": { - "unsafeName": "users", - "safeName": "users" - }, - "screamingSnakeCase": { - "unsafeName": "USERS", - "safeName": "USERS" - }, - "pascalCase": { - "unsafeName": "Users", - "safeName": "Users" - } - } - }, - "typeId": "type_users:ListUsersExtendedResponse" - }, - "docs": null - } - }, - "status-code": null - }, - "errors": [], - "examples": [ - { - "exampleType": "generated", - "url": "", - "rootPathParameters": [], - "servicePathParameters": [], - "endpointPathParameters": [], - "serviceHeaders": [], - "endpointHeaders": [], - "queryParameters": [ - { - "name": { - "name": { - "originalName": "cursor", - "camelCase": { - "unsafeName": "cursor", - "safeName": "cursor" - }, - "snakeCase": { - "unsafeName": "cursor", - "safeName": "cursor" - }, - "screamingSnakeCase": { - "unsafeName": "CURSOR", - "safeName": "CURSOR" - }, - "pascalCase": { - "unsafeName": "Cursor", - "safeName": "Cursor" - } - }, - "wireValue": "cursor" - }, - "value": { - "shape": { - "type": "primitive", - "primitive": { - "type": "uuid", - "uuid": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32" - } - }, - "jsonExample": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32" - } - } - ], - "request": null, - "name": null, - "codeSamples": null, - "response": { - "type": "ok", - "body": { - "shape": { - "type": "named", - "typeName": { - "name": { - "originalName": "ListUsersExtendedResponse", - "camelCase": { - "unsafeName": "listUsersExtendedResponse", - "safeName": "listUsersExtendedResponse" - }, - "snakeCase": { - "unsafeName": "list_users_extended_response", - "safeName": "list_users_extended_response" - }, - "screamingSnakeCase": { - "unsafeName": "LIST_USERS_EXTENDED_RESPONSE", - "safeName": "LIST_USERS_EXTENDED_RESPONSE" - }, - "pascalCase": { - "unsafeName": "ListUsersExtendedResponse", - "safeName": "ListUsersExtendedResponse" - } - }, - "fernFilepath": { - "allParts": [ - { - "originalName": "users", - "camelCase": { - "unsafeName": "users", - "safeName": "users" - }, - "snakeCase": { - "unsafeName": "users", - "safeName": "users" - }, - "screamingSnakeCase": { - "unsafeName": "USERS", - "safeName": "USERS" - }, - "pascalCase": { - "unsafeName": "Users", - "safeName": "Users" - } - } - ], - "packagePath": [], - "file": { - "originalName": "users", - "camelCase": { - "unsafeName": "users", - "safeName": "users" - }, - "snakeCase": { - "unsafeName": "users", - "safeName": "users" - }, - "screamingSnakeCase": { - "unsafeName": "USERS", - "safeName": "USERS" - }, - "pascalCase": { - "unsafeName": "Users", - "safeName": "Users" - } - } - }, - "typeId": "type_users:ListUsersExtendedResponse" - }, - "shape": { - "type": "object", - "properties": [ - { - "name": { - "name": { - "originalName": "total_count", - "camelCase": { - "unsafeName": "totalCount", - "safeName": "totalCount" - }, - "snakeCase": { - "unsafeName": "total_count", - "safeName": "total_count" - }, - "screamingSnakeCase": { - "unsafeName": "TOTAL_COUNT", - "safeName": "TOTAL_COUNT" - }, - "pascalCase": { - "unsafeName": "TotalCount", - "safeName": "TotalCount" - } - }, - "wireValue": "total_count" - }, - "value": { - "shape": { - "type": "primitive", - "primitive": { - "type": "integer", - "integer": 1 - } - }, - "jsonExample": 1 - }, - "originalTypeDeclaration": { - "name": { - "originalName": "ListUsersExtendedResponse", - "camelCase": { - "unsafeName": "listUsersExtendedResponse", - "safeName": "listUsersExtendedResponse" - }, - "snakeCase": { - "unsafeName": "list_users_extended_response", - "safeName": "list_users_extended_response" - }, - "screamingSnakeCase": { - "unsafeName": "LIST_USERS_EXTENDED_RESPONSE", - "safeName": "LIST_USERS_EXTENDED_RESPONSE" - }, - "pascalCase": { - "unsafeName": "ListUsersExtendedResponse", - "safeName": "ListUsersExtendedResponse" - } - }, - "fernFilepath": { - "allParts": [ - { - "originalName": "users", - "camelCase": { - "unsafeName": "users", - "safeName": "users" - }, - "snakeCase": { - "unsafeName": "users", - "safeName": "users" - }, - "screamingSnakeCase": { - "unsafeName": "USERS", - "safeName": "USERS" - }, - "pascalCase": { - "unsafeName": "Users", - "safeName": "Users" - } - } - ], - "packagePath": [], - "file": { - "originalName": "users", - "camelCase": { - "unsafeName": "users", - "safeName": "users" - }, - "snakeCase": { - "unsafeName": "users", - "safeName": "users" - }, - "screamingSnakeCase": { - "unsafeName": "USERS", - "safeName": "USERS" - }, - "pascalCase": { - "unsafeName": "Users", - "safeName": "Users" - } - } - }, - "typeId": "type_users:ListUsersExtendedResponse" - } - }, - { - "name": { - "name": { - "originalName": "data", - "camelCase": { - "unsafeName": "data", - "safeName": "data" - }, - "snakeCase": { - "unsafeName": "data", - "safeName": "data" - }, - "screamingSnakeCase": { - "unsafeName": "DATA", - "safeName": "DATA" - }, - "pascalCase": { - "unsafeName": "Data", - "safeName": "Data" - } - }, - "wireValue": "data" - }, - "value": { - "shape": { - "type": "named", - "typeName": { - "name": { - "originalName": "UserListContainer", - "camelCase": { - "unsafeName": "userListContainer", - "safeName": "userListContainer" - }, - "snakeCase": { - "unsafeName": "user_list_container", - "safeName": "user_list_container" - }, - "screamingSnakeCase": { - "unsafeName": "USER_LIST_CONTAINER", - "safeName": "USER_LIST_CONTAINER" - }, - "pascalCase": { - "unsafeName": "UserListContainer", - "safeName": "UserListContainer" - } - }, - "fernFilepath": { - "allParts": [ - { - "originalName": "users", - "camelCase": { - "unsafeName": "users", - "safeName": "users" - }, - "snakeCase": { - "unsafeName": "users", - "safeName": "users" - }, - "screamingSnakeCase": { - "unsafeName": "USERS", - "safeName": "USERS" - }, - "pascalCase": { - "unsafeName": "Users", - "safeName": "Users" - } - } - ], - "packagePath": [], - "file": { - "originalName": "users", - "camelCase": { - "unsafeName": "users", - "safeName": "users" - }, - "snakeCase": { - "unsafeName": "users", - "safeName": "users" - }, - "screamingSnakeCase": { - "unsafeName": "USERS", - "safeName": "USERS" - }, - "pascalCase": { - "unsafeName": "Users", - "safeName": "Users" - } - } - }, - "typeId": "type_users:UserListContainer" - }, - "shape": { - "type": "object", - "properties": [ - { - "name": { - "name": { - "originalName": "users", - "camelCase": { - "unsafeName": "users", - "safeName": "users" - }, - "snakeCase": { - "unsafeName": "users", - "safeName": "users" - }, - "screamingSnakeCase": { - "unsafeName": "USERS", - "safeName": "USERS" - }, - "pascalCase": { - "unsafeName": "Users", - "safeName": "Users" - } - }, - "wireValue": "users" - }, - "value": { - "shape": { - "type": "container", - "container": { - "type": "list", - "list": [ - { - "shape": { - "type": "named", - "typeName": { - "name": { - "originalName": "User", - "camelCase": { - "unsafeName": "user", - "safeName": "user" - }, - "snakeCase": { - "unsafeName": "user", - "safeName": "user" - }, - "screamingSnakeCase": { - "unsafeName": "USER", - "safeName": "USER" - }, - "pascalCase": { - "unsafeName": "User", - "safeName": "User" - } - }, - "fernFilepath": { - "allParts": [ - { - "originalName": "users", - "camelCase": { - "unsafeName": "users", - "safeName": "users" - }, - "snakeCase": { - "unsafeName": "users", - "safeName": "users" - }, - "screamingSnakeCase": { - "unsafeName": "USERS", - "safeName": "USERS" - }, - "pascalCase": { - "unsafeName": "Users", - "safeName": "Users" - } - } - ], - "packagePath": [], - "file": { - "originalName": "users", - "camelCase": { - "unsafeName": "users", - "safeName": "users" - }, - "snakeCase": { - "unsafeName": "users", - "safeName": "users" - }, - "screamingSnakeCase": { - "unsafeName": "USERS", - "safeName": "USERS" - }, - "pascalCase": { - "unsafeName": "Users", - "safeName": "Users" - } - } - }, - "typeId": "type_users:User" - }, - "shape": { - "type": "object", - "properties": [] - } - }, - "jsonExample": {} - } - ] - } - }, - "jsonExample": [ - {} - ] - }, - "originalTypeDeclaration": { - "name": { - "originalName": "UserListContainer", - "camelCase": { - "unsafeName": "userListContainer", - "safeName": "userListContainer" - }, - "snakeCase": { - "unsafeName": "user_list_container", - "safeName": "user_list_container" - }, - "screamingSnakeCase": { - "unsafeName": "USER_LIST_CONTAINER", - "safeName": "USER_LIST_CONTAINER" - }, - "pascalCase": { - "unsafeName": "UserListContainer", - "safeName": "UserListContainer" - } - }, - "fernFilepath": { - "allParts": [ - { - "originalName": "users", - "camelCase": { - "unsafeName": "users", - "safeName": "users" - }, - "snakeCase": { - "unsafeName": "users", - "safeName": "users" - }, - "screamingSnakeCase": { - "unsafeName": "USERS", - "safeName": "USERS" - }, - "pascalCase": { - "unsafeName": "Users", - "safeName": "Users" - } - } - ], - "packagePath": [], - "file": { - "originalName": "users", - "camelCase": { - "unsafeName": "users", - "safeName": "users" - }, - "snakeCase": { - "unsafeName": "users", - "safeName": "users" - }, - "screamingSnakeCase": { - "unsafeName": "USERS", - "safeName": "USERS" - }, - "pascalCase": { - "unsafeName": "Users", - "safeName": "Users" - } - } - }, - "typeId": "type_users:UserListContainer" - } - } - ] - } - }, - "jsonExample": { - "users": [ - {} - ] - } - }, - "originalTypeDeclaration": { - "name": { - "originalName": "UserPage", - "camelCase": { - "unsafeName": "userPage", - "safeName": "userPage" - }, - "snakeCase": { - "unsafeName": "user_page", - "safeName": "user_page" - }, - "screamingSnakeCase": { - "unsafeName": "USER_PAGE", - "safeName": "USER_PAGE" - }, - "pascalCase": { - "unsafeName": "UserPage", - "safeName": "UserPage" - } - }, - "fernFilepath": { - "allParts": [ - { - "originalName": "users", - "camelCase": { - "unsafeName": "users", - "safeName": "users" - }, - "snakeCase": { - "unsafeName": "users", - "safeName": "users" - }, - "screamingSnakeCase": { - "unsafeName": "USERS", - "safeName": "USERS" - }, - "pascalCase": { - "unsafeName": "Users", - "safeName": "Users" - } - } - ], - "packagePath": [], - "file": { - "originalName": "users", - "camelCase": { - "unsafeName": "users", - "safeName": "users" - }, - "snakeCase": { - "unsafeName": "users", - "safeName": "users" - }, - "screamingSnakeCase": { - "unsafeName": "USERS", - "safeName": "USERS" - }, - "pascalCase": { - "unsafeName": "Users", - "safeName": "Users" - } - } - }, - "typeId": "type_users:UserPage" - } - }, - { - "name": { - "name": { - "originalName": "next", - "camelCase": { - "unsafeName": "next", - "safeName": "next" - }, - "snakeCase": { - "unsafeName": "next", - "safeName": "next" - }, - "screamingSnakeCase": { - "unsafeName": "NEXT", - "safeName": "NEXT" - }, - "pascalCase": { - "unsafeName": "Next", - "safeName": "Next" - } - }, - "wireValue": "next" - }, - "value": { - "shape": { - "type": "primitive", - "primitive": { - "type": "uuid", - "uuid": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32" - } - }, - "jsonExample": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32" - }, - "originalTypeDeclaration": { - "name": { - "originalName": "UserPage", - "camelCase": { - "unsafeName": "userPage", - "safeName": "userPage" - }, - "snakeCase": { - "unsafeName": "user_page", - "safeName": "user_page" - }, - "screamingSnakeCase": { - "unsafeName": "USER_PAGE", - "safeName": "USER_PAGE" - }, - "pascalCase": { - "unsafeName": "UserPage", - "safeName": "UserPage" - } - }, - "fernFilepath": { - "allParts": [ - { - "originalName": "users", - "camelCase": { - "unsafeName": "users", - "safeName": "users" - }, - "snakeCase": { - "unsafeName": "users", - "safeName": "users" - }, - "screamingSnakeCase": { - "unsafeName": "USERS", - "safeName": "USERS" - }, - "pascalCase": { - "unsafeName": "Users", - "safeName": "Users" - } - } - ], - "packagePath": [], - "file": { - "originalName": "users", - "camelCase": { - "unsafeName": "users", - "safeName": "users" - }, - "snakeCase": { - "unsafeName": "users", - "safeName": "users" - }, - "screamingSnakeCase": { - "unsafeName": "USERS", - "safeName": "USERS" - }, - "pascalCase": { - "unsafeName": "Users", - "safeName": "Users" - } - } - }, - "typeId": "type_users:UserPage" - } - } - ] - } - }, - "jsonExample": { - "total_count": 1, - "data": { - "users": [ - {} - ] - }, - "next": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32" - } - } - }, - "docs": null - } - ], - "pagination": { - "type": "cursor", - "page": { - "name": { - "name": { - "originalName": "cursor", - "camelCase": { - "unsafeName": "cursor", - "safeName": "cursor" - }, - "snakeCase": { - "unsafeName": "cursor", - "safeName": "cursor" - }, - "screamingSnakeCase": { - "unsafeName": "CURSOR", - "safeName": "CURSOR" - }, - "pascalCase": { - "unsafeName": "Cursor", - "safeName": "Cursor" - } - }, - "wireValue": "cursor" - }, - "valueType": { - "_type": "container", - "container": { - "_type": "optional", - "optional": { - "_type": "primitive", - "primitive": "UUID" - } - } - }, - "allowMultiple": false, - "availability": null, - "docs": null - }, - "next": { - "propertyPath": [], - "property": { - "name": { - "name": { - "originalName": "next", - "camelCase": { - "unsafeName": "next", - "safeName": "next" - }, - "snakeCase": { - "unsafeName": "next", - "safeName": "next" - }, - "screamingSnakeCase": { - "unsafeName": "NEXT", - "safeName": "NEXT" - }, - "pascalCase": { - "unsafeName": "Next", - "safeName": "Next" - } - }, - "wireValue": "next" - }, - "valueType": { - "_type": "container", - "container": { - "_type": "optional", - "optional": { - "_type": "primitive", - "primitive": "UUID" - } - } - }, - "availability": null, - "docs": null - } - }, - "results": { - "propertyPath": [ - { - "originalName": "data", - "camelCase": { - "unsafeName": "data", - "safeName": "data" - }, - "snakeCase": { - "unsafeName": "data", - "safeName": "data" - }, - "screamingSnakeCase": { - "unsafeName": "DATA", - "safeName": "DATA" - }, - "pascalCase": { - "unsafeName": "Data", - "safeName": "Data" - } - } - ], - "property": { - "name": { - "name": { - "originalName": "users", - "camelCase": { - "unsafeName": "users", - "safeName": "users" - }, - "snakeCase": { - "unsafeName": "users", - "safeName": "users" - }, - "screamingSnakeCase": { - "unsafeName": "USERS", - "safeName": "USERS" - }, - "pascalCase": { - "unsafeName": "Users", - "safeName": "Users" - } - }, - "wireValue": "users" - }, - "valueType": { - "_type": "container", - "container": { - "_type": "list", - "list": { - "_type": "named", - "name": { - "originalName": "User", - "camelCase": { - "unsafeName": "user", - "safeName": "user" - }, - "snakeCase": { - "unsafeName": "user", - "safeName": "user" - }, - "screamingSnakeCase": { - "unsafeName": "USER", - "safeName": "USER" - }, - "pascalCase": { - "unsafeName": "User", - "safeName": "User" - } - }, - "fernFilepath": { - "allParts": [ - { - "originalName": "users", - "camelCase": { - "unsafeName": "users", - "safeName": "users" - }, - "snakeCase": { - "unsafeName": "users", - "safeName": "users" - }, - "screamingSnakeCase": { - "unsafeName": "USERS", - "safeName": "USERS" - }, - "pascalCase": { - "unsafeName": "Users", - "safeName": "Users" - } - } - ], - "packagePath": [], - "file": { - "originalName": "users", - "camelCase": { - "unsafeName": "users", - "safeName": "users" - }, - "snakeCase": { - "unsafeName": "users", - "safeName": "users" - }, - "screamingSnakeCase": { - "unsafeName": "USERS", - "safeName": "USERS" - }, - "pascalCase": { - "unsafeName": "Users", - "safeName": "Users" - } - } - }, - "typeId": "type_users:User" - } - } - }, - "availability": null, - "docs": null - } - } - }, - "availability": null, - "docs": null - }, - { - "id": "endpoint_users.listUsernames", - "name": { - "originalName": "listUsernames", - "camelCase": { - "unsafeName": "listUsernames", - "safeName": "listUsernames" - }, - "snakeCase": { - "unsafeName": "list_usernames", - "safeName": "list_usernames" - }, - "screamingSnakeCase": { - "unsafeName": "LIST_USERNAMES", - "safeName": "LIST_USERNAMES" - }, - "pascalCase": { - "unsafeName": "ListUsernames", - "safeName": "ListUsernames" - } - }, - "displayName": null, - "auth": false, - "idempotent": false, - "baseUrl": null, - "method": "GET", - "path": { - "head": "", - "parts": [] - }, - "fullPath": { - "head": "/users", - "parts": [] - }, - "pathParameters": [], - "allPathParameters": [], - "queryParameters": [ - { - "name": { - "name": { - "originalName": "starting_after", - "camelCase": { - "unsafeName": "startingAfter", - "safeName": "startingAfter" - }, - "snakeCase": { - "unsafeName": "starting_after", - "safeName": "starting_after" - }, - "screamingSnakeCase": { - "unsafeName": "STARTING_AFTER", - "safeName": "STARTING_AFTER" - }, - "pascalCase": { - "unsafeName": "StartingAfter", - "safeName": "StartingAfter" - } - }, - "wireValue": "starting_after" - }, - "valueType": { - "_type": "container", - "container": { - "_type": "optional", - "optional": { - "_type": "primitive", - "primitive": "STRING" - } - } - }, - "allowMultiple": false, - "availability": null, - "docs": "The cursor used for pagination in order to fetch\nthe next page of results." - } - ], - "headers": [], - "requestBody": null, - "sdkRequest": { - "shape": { - "type": "wrapper", - "wrapperName": { - "originalName": "ListUsernamesRequest", - "camelCase": { - "unsafeName": "listUsernamesRequest", - "safeName": "listUsernamesRequest" - }, - "snakeCase": { - "unsafeName": "list_usernames_request", - "safeName": "list_usernames_request" - }, - "screamingSnakeCase": { - "unsafeName": "LIST_USERNAMES_REQUEST", - "safeName": "LIST_USERNAMES_REQUEST" - }, - "pascalCase": { - "unsafeName": "ListUsernamesRequest", - "safeName": "ListUsernamesRequest" - } - }, - "bodyKey": { - "originalName": "body", - "camelCase": { - "unsafeName": "body", - "safeName": "body" - }, - "snakeCase": { - "unsafeName": "body", - "safeName": "body" - }, - "screamingSnakeCase": { - "unsafeName": "BODY", - "safeName": "BODY" - }, - "pascalCase": { - "unsafeName": "Body", - "safeName": "Body" - } - } - }, - "requestParameterName": { - "originalName": "request", - "camelCase": { - "unsafeName": "request", - "safeName": "request" - }, - "snakeCase": { - "unsafeName": "request", - "safeName": "request" - }, - "screamingSnakeCase": { - "unsafeName": "REQUEST", - "safeName": "REQUEST" - }, - "pascalCase": { - "unsafeName": "Request", - "safeName": "Request" - } - } - }, - "response": { - "body": { - "type": "json", - "value": { - "type": "response", - "responseBodyType": { - "_type": "named", - "name": { - "originalName": "UsernameCursor", - "camelCase": { - "unsafeName": "usernameCursor", - "safeName": "usernameCursor" - }, - "snakeCase": { - "unsafeName": "username_cursor", - "safeName": "username_cursor" - }, - "screamingSnakeCase": { - "unsafeName": "USERNAME_CURSOR", - "safeName": "USERNAME_CURSOR" - }, - "pascalCase": { - "unsafeName": "UsernameCursor", - "safeName": "UsernameCursor" - } - }, - "fernFilepath": { - "allParts": [], - "packagePath": [], - "file": null - }, - "typeId": "type_:UsernameCursor" - }, - "docs": null - } - }, - "status-code": null - }, - "errors": [], - "examples": [ - { - "exampleType": "generated", - "url": "", - "rootPathParameters": [], - "servicePathParameters": [], - "endpointPathParameters": [], - "serviceHeaders": [], - "endpointHeaders": [], - "queryParameters": [ - { - "name": { - "name": { - "originalName": "starting_after", - "camelCase": { - "unsafeName": "startingAfter", - "safeName": "startingAfter" - }, - "snakeCase": { - "unsafeName": "starting_after", - "safeName": "starting_after" - }, - "screamingSnakeCase": { - "unsafeName": "STARTING_AFTER", - "safeName": "STARTING_AFTER" - }, - "pascalCase": { - "unsafeName": "StartingAfter", - "safeName": "StartingAfter" - } - }, - "wireValue": "starting_after" - }, - "value": { - "shape": { - "type": "primitive", - "primitive": { - "type": "string", - "string": { - "original": "string" - } - } - }, - "jsonExample": "string" - } - } - ], - "request": null, - "name": null, - "codeSamples": null, - "response": { - "type": "ok", - "body": { - "shape": { - "type": "named", - "typeName": { - "name": { - "originalName": "UsernameCursor", - "camelCase": { - "unsafeName": "usernameCursor", - "safeName": "usernameCursor" - }, - "snakeCase": { - "unsafeName": "username_cursor", - "safeName": "username_cursor" - }, - "screamingSnakeCase": { - "unsafeName": "USERNAME_CURSOR", - "safeName": "USERNAME_CURSOR" - }, - "pascalCase": { - "unsafeName": "UsernameCursor", - "safeName": "UsernameCursor" - } - }, - "fernFilepath": { - "allParts": [], - "packagePath": [], - "file": null - }, - "typeId": "type_:UsernameCursor" - }, - "shape": { - "type": "object", - "properties": [ - { - "name": { - "name": { - "originalName": "cursor", - "camelCase": { - "unsafeName": "cursor", - "safeName": "cursor" - }, - "snakeCase": { - "unsafeName": "cursor", - "safeName": "cursor" - }, - "screamingSnakeCase": { - "unsafeName": "CURSOR", - "safeName": "CURSOR" - }, - "pascalCase": { - "unsafeName": "Cursor", - "safeName": "Cursor" - } - }, - "wireValue": "cursor" - }, - "value": { - "shape": { - "type": "named", - "typeName": { - "name": { - "originalName": "UsernamePage", - "camelCase": { - "unsafeName": "usernamePage", - "safeName": "usernamePage" - }, - "snakeCase": { - "unsafeName": "username_page", - "safeName": "username_page" - }, - "screamingSnakeCase": { - "unsafeName": "USERNAME_PAGE", - "safeName": "USERNAME_PAGE" - }, - "pascalCase": { - "unsafeName": "UsernamePage", - "safeName": "UsernamePage" - } - }, - "fernFilepath": { - "allParts": [], - "packagePath": [], - "file": null - }, - "typeId": "type_:UsernamePage" - }, - "shape": { - "type": "object", - "properties": [] - } - }, - "jsonExample": {} - }, - "originalTypeDeclaration": { - "name": { - "originalName": "UsernameCursor", - "camelCase": { - "unsafeName": "usernameCursor", - "safeName": "usernameCursor" - }, - "snakeCase": { - "unsafeName": "username_cursor", - "safeName": "username_cursor" - }, - "screamingSnakeCase": { - "unsafeName": "USERNAME_CURSOR", - "safeName": "USERNAME_CURSOR" - }, - "pascalCase": { - "unsafeName": "UsernameCursor", - "safeName": "UsernameCursor" - } - }, - "fernFilepath": { - "allParts": [], - "packagePath": [], - "file": null - }, - "typeId": "type_:UsernameCursor" - } - } - ] - } - }, - "jsonExample": { - "cursor": {} - } - } - }, - "docs": null - } - ], - "pagination": { - "type": "cursor", - "page": { - "name": { - "name": { - "originalName": "starting_after", - "camelCase": { - "unsafeName": "startingAfter", - "safeName": "startingAfter" - }, - "snakeCase": { - "unsafeName": "starting_after", - "safeName": "starting_after" - }, - "screamingSnakeCase": { - "unsafeName": "STARTING_AFTER", - "safeName": "STARTING_AFTER" - }, - "pascalCase": { - "unsafeName": "StartingAfter", - "safeName": "StartingAfter" - } - }, - "wireValue": "starting_after" - }, - "valueType": { - "_type": "container", - "container": { - "_type": "optional", - "optional": { - "_type": "primitive", - "primitive": "STRING" - } - } - }, - "allowMultiple": false, - "availability": null, - "docs": "The cursor used for pagination in order to fetch\nthe next page of results." - }, - "next": { - "propertyPath": [ - { - "originalName": "cursor", - "camelCase": { - "unsafeName": "cursor", - "safeName": "cursor" - }, - "snakeCase": { - "unsafeName": "cursor", - "safeName": "cursor" - }, - "screamingSnakeCase": { - "unsafeName": "CURSOR", - "safeName": "CURSOR" - }, - "pascalCase": { - "unsafeName": "Cursor", - "safeName": "Cursor" - } - } - ], - "property": { - "name": { - "name": { - "originalName": "after", - "camelCase": { - "unsafeName": "after", - "safeName": "after" - }, - "snakeCase": { - "unsafeName": "after", - "safeName": "after" - }, - "screamingSnakeCase": { - "unsafeName": "AFTER", - "safeName": "AFTER" - }, - "pascalCase": { - "unsafeName": "After", - "safeName": "After" - } - }, - "wireValue": "after" - }, - "valueType": { - "_type": "container", - "container": { - "_type": "optional", - "optional": { - "_type": "primitive", - "primitive": "STRING" - } - } - }, - "availability": null, - "docs": null - } - }, - "results": { - "propertyPath": [ - { - "originalName": "cursor", - "camelCase": { - "unsafeName": "cursor", - "safeName": "cursor" - }, - "snakeCase": { - "unsafeName": "cursor", - "safeName": "cursor" - }, - "screamingSnakeCase": { - "unsafeName": "CURSOR", - "safeName": "CURSOR" - }, - "pascalCase": { - "unsafeName": "Cursor", - "safeName": "Cursor" - } - } - ], - "property": { - "name": { - "name": { - "originalName": "data", - "camelCase": { - "unsafeName": "data", - "safeName": "data" - }, - "snakeCase": { - "unsafeName": "data", - "safeName": "data" - }, - "screamingSnakeCase": { - "unsafeName": "DATA", - "safeName": "DATA" - }, - "pascalCase": { - "unsafeName": "Data", - "safeName": "Data" - } - }, - "wireValue": "data" - }, - "valueType": { - "_type": "container", - "container": { - "_type": "list", - "list": { - "_type": "primitive", - "primitive": "STRING" - } - } - }, - "availability": null, - "docs": null - } - } - }, - "availability": null, - "docs": null - }, - { - "id": "endpoint_users.listWithGlobalConfig", - "name": { - "originalName": "listWithGlobalConfig", - "camelCase": { - "unsafeName": "listWithGlobalConfig", - "safeName": "listWithGlobalConfig" - }, - "snakeCase": { - "unsafeName": "list_with_global_config", - "safeName": "list_with_global_config" - }, - "screamingSnakeCase": { - "unsafeName": "LIST_WITH_GLOBAL_CONFIG", - "safeName": "LIST_WITH_GLOBAL_CONFIG" - }, - "pascalCase": { - "unsafeName": "ListWithGlobalConfig", - "safeName": "ListWithGlobalConfig" - } - }, - "displayName": null, - "auth": false, - "idempotent": false, - "baseUrl": null, - "method": "GET", - "path": { - "head": "", - "parts": [] - }, - "fullPath": { - "head": "/users", - "parts": [] - }, - "pathParameters": [], - "allPathParameters": [], - "queryParameters": [ - { - "name": { - "name": { - "originalName": "offset", - "camelCase": { - "unsafeName": "offset", - "safeName": "offset" - }, - "snakeCase": { - "unsafeName": "offset", - "safeName": "offset" - }, - "screamingSnakeCase": { - "unsafeName": "OFFSET", - "safeName": "OFFSET" - }, - "pascalCase": { - "unsafeName": "Offset", - "safeName": "Offset" - } - }, - "wireValue": "offset" - }, - "valueType": { - "_type": "container", - "container": { - "_type": "optional", - "optional": { - "_type": "primitive", - "primitive": "INTEGER" - } - } - }, - "allowMultiple": false, - "availability": null, - "docs": null - } - ], - "headers": [], - "requestBody": null, - "sdkRequest": { - "shape": { - "type": "wrapper", - "wrapperName": { - "originalName": "ListWithGlobalConfigRequest", - "camelCase": { - "unsafeName": "listWithGlobalConfigRequest", - "safeName": "listWithGlobalConfigRequest" - }, - "snakeCase": { - "unsafeName": "list_with_global_config_request", - "safeName": "list_with_global_config_request" - }, - "screamingSnakeCase": { - "unsafeName": "LIST_WITH_GLOBAL_CONFIG_REQUEST", - "safeName": "LIST_WITH_GLOBAL_CONFIG_REQUEST" - }, - "pascalCase": { - "unsafeName": "ListWithGlobalConfigRequest", - "safeName": "ListWithGlobalConfigRequest" - } - }, - "bodyKey": { - "originalName": "body", - "camelCase": { - "unsafeName": "body", - "safeName": "body" - }, - "snakeCase": { - "unsafeName": "body", - "safeName": "body" - }, - "screamingSnakeCase": { - "unsafeName": "BODY", - "safeName": "BODY" - }, - "pascalCase": { - "unsafeName": "Body", - "safeName": "Body" - } - } - }, - "requestParameterName": { - "originalName": "request", - "camelCase": { - "unsafeName": "request", - "safeName": "request" - }, - "snakeCase": { - "unsafeName": "request", - "safeName": "request" - }, - "screamingSnakeCase": { - "unsafeName": "REQUEST", - "safeName": "REQUEST" - }, - "pascalCase": { - "unsafeName": "Request", - "safeName": "Request" - } - } - }, - "response": { - "body": { - "type": "json", - "value": { - "type": "response", - "responseBodyType": { - "_type": "named", - "name": { - "originalName": "UsernameContainer", - "camelCase": { - "unsafeName": "usernameContainer", - "safeName": "usernameContainer" - }, - "snakeCase": { - "unsafeName": "username_container", - "safeName": "username_container" - }, - "screamingSnakeCase": { - "unsafeName": "USERNAME_CONTAINER", - "safeName": "USERNAME_CONTAINER" - }, - "pascalCase": { - "unsafeName": "UsernameContainer", - "safeName": "UsernameContainer" - } - }, - "fernFilepath": { - "allParts": [ - { - "originalName": "users", - "camelCase": { - "unsafeName": "users", - "safeName": "users" - }, - "snakeCase": { - "unsafeName": "users", - "safeName": "users" - }, - "screamingSnakeCase": { - "unsafeName": "USERS", - "safeName": "USERS" - }, - "pascalCase": { - "unsafeName": "Users", - "safeName": "Users" - } - } - ], - "packagePath": [], - "file": { - "originalName": "users", - "camelCase": { - "unsafeName": "users", - "safeName": "users" - }, - "snakeCase": { - "unsafeName": "users", - "safeName": "users" - }, - "screamingSnakeCase": { - "unsafeName": "USERS", - "safeName": "USERS" - }, - "pascalCase": { - "unsafeName": "Users", - "safeName": "Users" - } - } - }, - "typeId": "type_users:UsernameContainer" - }, - "docs": null - } - }, - "status-code": null - }, - "errors": [], - "examples": [ - { - "exampleType": "generated", - "url": "", - "rootPathParameters": [], - "servicePathParameters": [], - "endpointPathParameters": [], - "serviceHeaders": [], - "endpointHeaders": [], - "queryParameters": [ - { - "name": { - "name": { - "originalName": "offset", - "camelCase": { - "unsafeName": "offset", - "safeName": "offset" - }, - "snakeCase": { - "unsafeName": "offset", - "safeName": "offset" - }, - "screamingSnakeCase": { - "unsafeName": "OFFSET", - "safeName": "OFFSET" - }, - "pascalCase": { - "unsafeName": "Offset", - "safeName": "Offset" - } - }, - "wireValue": "offset" - }, - "value": { - "shape": { - "type": "primitive", - "primitive": { - "type": "integer", - "integer": 1 - } - }, - "jsonExample": 1 - } - } - ], - "request": null, - "name": null, - "codeSamples": null, - "response": { - "type": "ok", - "body": { - "shape": { - "type": "named", - "typeName": { - "name": { - "originalName": "UsernameContainer", - "camelCase": { - "unsafeName": "usernameContainer", - "safeName": "usernameContainer" - }, - "snakeCase": { - "unsafeName": "username_container", - "safeName": "username_container" - }, - "screamingSnakeCase": { - "unsafeName": "USERNAME_CONTAINER", - "safeName": "USERNAME_CONTAINER" - }, - "pascalCase": { - "unsafeName": "UsernameContainer", - "safeName": "UsernameContainer" - } - }, - "fernFilepath": { - "allParts": [ - { - "originalName": "users", - "camelCase": { - "unsafeName": "users", - "safeName": "users" - }, - "snakeCase": { - "unsafeName": "users", - "safeName": "users" - }, - "screamingSnakeCase": { - "unsafeName": "USERS", - "safeName": "USERS" - }, - "pascalCase": { - "unsafeName": "Users", - "safeName": "Users" - } - } - ], - "packagePath": [], - "file": { - "originalName": "users", - "camelCase": { - "unsafeName": "users", - "safeName": "users" - }, - "snakeCase": { - "unsafeName": "users", - "safeName": "users" - }, - "screamingSnakeCase": { - "unsafeName": "USERS", - "safeName": "USERS" - }, - "pascalCase": { - "unsafeName": "Users", - "safeName": "Users" - } - } - }, - "typeId": "type_users:UsernameContainer" - }, - "shape": { - "type": "object", - "properties": [ - { - "name": { - "name": { - "originalName": "results", - "camelCase": { - "unsafeName": "results", - "safeName": "results" - }, - "snakeCase": { - "unsafeName": "results", - "safeName": "results" - }, - "screamingSnakeCase": { - "unsafeName": "RESULTS", - "safeName": "RESULTS" - }, - "pascalCase": { - "unsafeName": "Results", - "safeName": "Results" - } - }, - "wireValue": "results" - }, - "value": { - "shape": { - "type": "container", - "container": { - "type": "list", - "list": [ - { - "shape": { - "type": "primitive", - "primitive": { - "type": "string", - "string": { - "original": "string" - } - } - }, - "jsonExample": "string" - } - ] - } - }, - "jsonExample": [ - "string" - ] - }, - "originalTypeDeclaration": { - "name": { - "originalName": "UsernameContainer", - "camelCase": { - "unsafeName": "usernameContainer", - "safeName": "usernameContainer" - }, - "snakeCase": { - "unsafeName": "username_container", - "safeName": "username_container" - }, - "screamingSnakeCase": { - "unsafeName": "USERNAME_CONTAINER", - "safeName": "USERNAME_CONTAINER" - }, - "pascalCase": { - "unsafeName": "UsernameContainer", - "safeName": "UsernameContainer" - } - }, - "fernFilepath": { - "allParts": [ - { - "originalName": "users", - "camelCase": { - "unsafeName": "users", - "safeName": "users" - }, - "snakeCase": { - "unsafeName": "users", - "safeName": "users" - }, - "screamingSnakeCase": { - "unsafeName": "USERS", - "safeName": "USERS" - }, - "pascalCase": { - "unsafeName": "Users", - "safeName": "Users" - } - } - ], - "packagePath": [], - "file": { - "originalName": "users", - "camelCase": { - "unsafeName": "users", - "safeName": "users" - }, - "snakeCase": { - "unsafeName": "users", - "safeName": "users" - }, - "screamingSnakeCase": { - "unsafeName": "USERS", - "safeName": "USERS" - }, - "pascalCase": { - "unsafeName": "Users", - "safeName": "Users" - } - } - }, - "typeId": "type_users:UsernameContainer" - } - } - ] - } - }, - "jsonExample": { - "results": [ - "string" - ] - } - } - }, - "docs": null - } - ], - "pagination": { - "type": "offset", - "page": { - "name": { - "name": { - "originalName": "offset", - "camelCase": { - "unsafeName": "offset", - "safeName": "offset" - }, - "snakeCase": { - "unsafeName": "offset", - "safeName": "offset" - }, - "screamingSnakeCase": { - "unsafeName": "OFFSET", - "safeName": "OFFSET" - }, - "pascalCase": { - "unsafeName": "Offset", - "safeName": "Offset" - } - }, - "wireValue": "offset" - }, - "valueType": { - "_type": "container", - "container": { - "_type": "optional", - "optional": { - "_type": "primitive", - "primitive": "INTEGER" - } - } - }, - "allowMultiple": false, - "availability": null, - "docs": null - }, - "results": { - "propertyPath": [], - "property": { - "name": { - "name": { - "originalName": "results", - "camelCase": { - "unsafeName": "results", - "safeName": "results" - }, - "snakeCase": { - "unsafeName": "results", - "safeName": "results" - }, - "screamingSnakeCase": { - "unsafeName": "RESULTS", - "safeName": "RESULTS" - }, - "pascalCase": { - "unsafeName": "Results", - "safeName": "Results" - } - }, - "wireValue": "results" - }, - "valueType": { - "_type": "container", - "container": { - "_type": "list", - "list": { - "_type": "primitive", - "primitive": "STRING" - } - } - }, - "availability": null, - "docs": null - } - } - }, - "availability": null, - "docs": null - } - ] - } - }, - "constants": { - "errorInstanceIdKey": { - "name": { - "originalName": "errorInstanceId", - "camelCase": { - "unsafeName": "errorInstanceId", - "safeName": "errorInstanceId" - }, - "snakeCase": { - "unsafeName": "error_instance_id", - "safeName": "error_instance_id" - }, - "screamingSnakeCase": { - "unsafeName": "ERROR_INSTANCE_ID", - "safeName": "ERROR_INSTANCE_ID" - }, - "pascalCase": { - "unsafeName": "ErrorInstanceId", - "safeName": "ErrorInstanceId" - } - }, - "wireValue": "errorInstanceId" - } - }, - "environments": null, - "errorDiscriminationStrategy": { - "type": "statusCode" - }, - "basePath": null, - "pathParameters": [], - "variables": [], - "serviceTypeReferenceInfo": { - "typesReferencedOnlyByService": { - "service_users": [ - "type_:UsernameCursor", - "type_users:Order", - "type_users:UsernameContainer", - "type_users:ListUsersExtendedResponse", - "type_users:ListUsersPaginationResponse" - ] - }, - "sharedTypes": [ - "type_:UsernamePage", - "type_users:UserListContainer", - "type_users:UserPage", - "type_users:Page", - "type_users:NextPage", - "type_users:User" - ] - }, - "webhookGroups": {}, - "websocketChannels": {}, - "subpackages": { - "subpackage_users": { - "name": { - "originalName": "users", - "camelCase": { - "unsafeName": "users", - "safeName": "users" - }, - "snakeCase": { - "unsafeName": "users", - "safeName": "users" - }, - "screamingSnakeCase": { - "unsafeName": "USERS", - "safeName": "USERS" - }, - "pascalCase": { - "unsafeName": "Users", - "safeName": "Users" - } - }, - "fernFilepath": { - "allParts": [ - { - "originalName": "users", - "camelCase": { - "unsafeName": "users", - "safeName": "users" - }, - "snakeCase": { - "unsafeName": "users", - "safeName": "users" - }, - "screamingSnakeCase": { - "unsafeName": "USERS", - "safeName": "USERS" - }, - "pascalCase": { - "unsafeName": "Users", - "safeName": "Users" - } - } - ], - "packagePath": [], - "file": { - "originalName": "users", - "camelCase": { - "unsafeName": "users", - "safeName": "users" - }, - "snakeCase": { - "unsafeName": "users", - "safeName": "users" - }, - "screamingSnakeCase": { - "unsafeName": "USERS", - "safeName": "USERS" - }, - "pascalCase": { - "unsafeName": "Users", - "safeName": "Users" - } - } - }, - "service": "service_users", - "types": [ - "type_users:Order", - "type_users:UserListContainer", - "type_users:UserPage", - "type_users:UsernameContainer", - "type_users:ListUsersExtendedResponse", - "type_users:ListUsersPaginationResponse", - "type_users:Page", - "type_users:NextPage", - "type_users:User" - ], - "errors": [], - "subpackages": [], - "navigationConfig": null, - "webhooks": null, - "websocket": null, - "hasEndpointsInTree": true, - "docs": null - } - }, - "rootPackage": { - "fernFilepath": { - "allParts": [], - "packagePath": [], - "file": null - }, - "websocket": null, - "service": null, - "types": [ - "type_:UsernameCursor", - "type_:UsernamePage" - ], - "errors": [], - "subpackages": [ - "subpackage_users" - ], - "webhooks": null, - "navigationConfig": null, - "hasEndpointsInTree": true, - "docs": null - }, - "sdkConfig": { - "isAuthMandatory": false, - "hasStreamingEndpoints": false, - "hasFileDownloadEndpoints": false, - "platformHeaders": { - "language": "X-Fern-Language", - "sdkName": "X-Fern-SDK-Name", - "sdkVersion": "X-Fern-SDK-Version" - } - } -} \ No newline at end of file diff --git a/seed/python-sdk/pagination/README.md b/seed/python-sdk/pagination/README.md index 9885120534b..e69de29bb2d 100644 --- a/seed/python-sdk/pagination/README.md +++ b/seed/python-sdk/pagination/README.md @@ -1,173 +0,0 @@ -# Seed Python Library - -[![fern shield](https://img.shields.io/badge/%F0%9F%8C%BF-SDK%20generated%20by%20Fern-brightgreen)](https://github.com/fern-api/fern) -[![pypi](https://img.shields.io/pypi/v/fern_pagination)](https://pypi.python.org/pypi/fern_pagination) - -The Seed Python library provides convenient access to the Seed API from Python. - -## Installation - -```sh -pip install fern_pagination -``` - -## Usage - -Instantiate and use the client with the following: - -```python -from seed import SeedPagination -from seed.users import WithCursor - -client = SeedPagination( - token="YOUR_TOKEN", - base_url="https://yourhost.com/path/to/api", -) -response = client.users.list_with_body_cursor_pagination( - pagination=WithCursor( - cursor="string", - ), -) -for item in response: - yield item -# alternatively, you can paginate page-by-page -for page in response.iter_pages(): - yield page -``` - -## Async Client - -The SDK also exports an `async` client so that you can make non-blocking calls to our API. - -```python -import asyncio - -from seed import AsyncSeedPagination -from seed.users import WithCursor - -client = AsyncSeedPagination( - token="YOUR_TOKEN", - base_url="https://yourhost.com/path/to/api", -) - - -async def main() -> None: - response = await client.users.list_with_body_cursor_pagination( - pagination=WithCursor( - cursor="string", - ), - ) - async for item in response: - yield item - # alternatively, you can paginate page-by-page - async for page in response.iter_pages(): - yield page - - -asyncio.run(main()) -``` - -## Exception Handling - -When the API returns a non-success status code (4xx or 5xx response), a subclass of the following error -will be thrown. - -```python -from seed.core.api_error import ApiError - -try: - client.users.list_with_body_cursor_pagination(...) -except ApiError as e: - print(e.status_code) - print(e.body) -``` - -## Pagination - -Paginated requests will return a `SyncPager` or `AsyncPager`, which can be used as generators for the underlying object. - -```python -from seed import SeedPagination - -client = SeedPagination( - token="YOUR_TOKEN", - base_url="https://yourhost.com/path/to/api", -) -response = client.users.list_with_cursor_pagination( - page=1, - per_page=1, - order="asc", - starting_after="string", -) -for item in response: - yield item -# alternatively, you can paginate page-by-page -for page in response.iter_pages(): - yield page -``` - -## Advanced - -### Retries - -The SDK is instrumented with automatic retries with exponential backoff. A request will be retried as long -as the request is deemed retriable and the number of retry attempts has not grown larger than the configured -retry limit (default: 2). - -A request is deemed retriable when any of the following HTTP status codes is returned: - -- [408](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/408) (Timeout) -- [429](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/429) (Too Many Requests) -- [5XX](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/500) (Internal Server Errors) - -Use the `max_retries` request option to configure this behavior. - -```python -client.users.list_with_body_cursor_pagination(...,{ - max_retries=1 -}) -``` - -### Timeouts - -The SDK defaults to a 60 second timeout. You can configure this with a timeout option at the client or request level. - -```python - -from seed import SeedPagination - -client = SeedPagination(..., { timeout=20.0 }, ) - - -# Override timeout for a specific method -client.users.list_with_body_cursor_pagination(...,{ - timeout_in_seconds=1 -}) -``` - -### Custom Client - -You can override the `httpx` client to customize it for your use-case. Some common use-cases include support for proxies -and transports. -```python -import httpx -from seed import SeedPagination - -client = SeedPagination( - ..., - http_client=httpx.Client( - proxies="http://my.test.proxy.example.com", - transport=httpx.HTTPTransport(local_address="0.0.0.0"), - ), -) -``` - -## Contributing - -While we value open-source contributions to this SDK, this library is generated programmatically. -Additions made directly to this library would have to be moved over to our generation code, -otherwise they would be overwritten upon the next generated release. Feel free to open a PR as -a proof of concept, but know that we will not be able to merge it as-is. We suggest opening -an issue first to discuss with us! - -On the other hand, contributions to the README are always very welcome! diff --git a/seed/python-sdk/plain-text/README.md b/seed/python-sdk/plain-text/README.md index 9ffdf541ead..e69de29bb2d 100644 --- a/seed/python-sdk/plain-text/README.md +++ b/seed/python-sdk/plain-text/README.md @@ -1,127 +0,0 @@ -# Seed Python Library - -[![fern shield](https://img.shields.io/badge/%F0%9F%8C%BF-SDK%20generated%20by%20Fern-brightgreen)](https://github.com/fern-api/fern) -[![pypi](https://img.shields.io/pypi/v/fern_plain-text)](https://pypi.python.org/pypi/fern_plain-text) - -The Seed Python library provides convenient access to the Seed API from Python. - -## Installation - -```sh -pip install fern_plain-text -``` - -## Usage - -Instantiate and use the client with the following: - -```python -from seed import SeedPlainText - -client = SeedPlainText( - base_url="https://yourhost.com/path/to/api", -) -client.service.get_text() -``` - -## Async Client - -The SDK also exports an `async` client so that you can make non-blocking calls to our API. - -```python -import asyncio - -from seed import AsyncSeedPlainText - -client = AsyncSeedPlainText( - base_url="https://yourhost.com/path/to/api", -) - - -async def main() -> None: - await client.service.get_text() - - -asyncio.run(main()) -``` - -## Exception Handling - -When the API returns a non-success status code (4xx or 5xx response), a subclass of the following error -will be thrown. - -```python -from seed.core.api_error import ApiError - -try: - client.service.get_text() -except ApiError as e: - print(e.status_code) - print(e.body) -``` - -## Advanced - -### Retries - -The SDK is instrumented with automatic retries with exponential backoff. A request will be retried as long -as the request is deemed retriable and the number of retry attempts has not grown larger than the configured -retry limit (default: 2). - -A request is deemed retriable when any of the following HTTP status codes is returned: - -- [408](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/408) (Timeout) -- [429](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/429) (Too Many Requests) -- [5XX](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/500) (Internal Server Errors) - -Use the `max_retries` request option to configure this behavior. - -```python -client.service.get_text({ - max_retries=1 -}) -``` - -### Timeouts - -The SDK defaults to a 60 second timeout. You can configure this with a timeout option at the client or request level. - -```python - -from seed import SeedPlainText - -client = SeedPlainText(..., { timeout=20.0 }, ) - - -# Override timeout for a specific method -client.service.get_text({ - timeout_in_seconds=1 -}) -``` - -### Custom Client - -You can override the `httpx` client to customize it for your use-case. Some common use-cases include support for proxies -and transports. -```python -import httpx -from seed import SeedPlainText - -client = SeedPlainText( - ..., - http_client=httpx.Client( - proxies="http://my.test.proxy.example.com", - transport=httpx.HTTPTransport(local_address="0.0.0.0"), - ), -) -``` - -## Contributing - -While we value open-source contributions to this SDK, this library is generated programmatically. -Additions made directly to this library would have to be moved over to our generation code, -otherwise they would be overwritten upon the next generated release. Feel free to open a PR as -a proof of concept, but know that we will not be able to merge it as-is. We suggest opening -an issue first to discuss with us! - -On the other hand, contributions to the README are always very welcome! diff --git a/seed/python-sdk/query-parameters/README.md b/seed/python-sdk/query-parameters/README.md index 20a384fa91d..e69de29bb2d 100644 --- a/seed/python-sdk/query-parameters/README.md +++ b/seed/python-sdk/query-parameters/README.md @@ -1,220 +0,0 @@ -# Seed Python Library - -[![fern shield](https://img.shields.io/badge/%F0%9F%8C%BF-SDK%20generated%20by%20Fern-brightgreen)](https://github.com/fern-api/fern) -[![pypi](https://img.shields.io/pypi/v/fern_query-parameters)](https://pypi.python.org/pypi/fern_query-parameters) - -The Seed Python library provides convenient access to the Seed API from Python. - -## Installation - -```sh -pip install fern_query-parameters -``` - -## Usage - -Instantiate and use the client with the following: - -```python -import datetime -import uuid - -from seed import SeedQueryParameters -from seed.user import NestedUser, User - -client = SeedQueryParameters( - base_url="https://yourhost.com/path/to/api", -) -client.user.get_username( - limit=1, - id=uuid.UUID( - "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", - ), - date=datetime.date.fromisoformat( - "2023-01-15", - ), - deadline=datetime.datetime.fromisoformat( - "2024-01-15 09:30:00+00:00", - ), - bytes="SGVsbG8gd29ybGQh", - user=User( - name="string", - tags=["string"], - ), - user_list=[ - User( - name="string", - tags=["string"], - ) - ], - optional_deadline=datetime.datetime.fromisoformat( - "2024-01-15 09:30:00+00:00", - ), - key_value={"string": "string"}, - optional_string="string", - nested_user=NestedUser( - name="string", - user=User( - name="string", - tags=["string"], - ), - ), - optional_user=User( - name="string", - tags=["string"], - ), - exclude_user=User( - name="string", - tags=["string"], - ), - filter="string", -) -``` - -## Async Client - -The SDK also exports an `async` client so that you can make non-blocking calls to our API. - -```python -import asyncio -import datetime -import uuid - -from seed import AsyncSeedQueryParameters -from seed.user import NestedUser, User - -client = AsyncSeedQueryParameters( - base_url="https://yourhost.com/path/to/api", -) - - -async def main() -> None: - await client.user.get_username( - limit=1, - id=uuid.UUID( - "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", - ), - date=datetime.date.fromisoformat( - "2023-01-15", - ), - deadline=datetime.datetime.fromisoformat( - "2024-01-15 09:30:00+00:00", - ), - bytes="SGVsbG8gd29ybGQh", - user=User( - name="string", - tags=["string"], - ), - user_list=[ - User( - name="string", - tags=["string"], - ) - ], - optional_deadline=datetime.datetime.fromisoformat( - "2024-01-15 09:30:00+00:00", - ), - key_value={"string": "string"}, - optional_string="string", - nested_user=NestedUser( - name="string", - user=User( - name="string", - tags=["string"], - ), - ), - optional_user=User( - name="string", - tags=["string"], - ), - exclude_user=User( - name="string", - tags=["string"], - ), - filter="string", - ) - - -asyncio.run(main()) -``` - -## Exception Handling - -When the API returns a non-success status code (4xx or 5xx response), a subclass of the following error -will be thrown. - -```python -from seed.core.api_error import ApiError - -try: - client.user.get_username() -except ApiError as e: - print(e.status_code) - print(e.body) -``` - -## Advanced - -### Retries - -The SDK is instrumented with automatic retries with exponential backoff. A request will be retried as long -as the request is deemed retriable and the number of retry attempts has not grown larger than the configured -retry limit (default: 2). - -A request is deemed retriable when any of the following HTTP status codes is returned: - -- [408](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/408) (Timeout) -- [429](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/429) (Too Many Requests) -- [5XX](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/500) (Internal Server Errors) - -Use the `max_retries` request option to configure this behavior. - -```python -client.user.get_username({ - max_retries=1 -}) -``` - -### Timeouts - -The SDK defaults to a 60 second timeout. You can configure this with a timeout option at the client or request level. - -```python - -from seed import SeedQueryParameters - -client = SeedQueryParameters(..., { timeout=20.0 }, ) - - -# Override timeout for a specific method -client.user.get_username({ - timeout_in_seconds=1 -}) -``` - -### Custom Client - -You can override the `httpx` client to customize it for your use-case. Some common use-cases include support for proxies -and transports. -```python -import httpx -from seed import SeedQueryParameters - -client = SeedQueryParameters( - ..., - http_client=httpx.Client( - proxies="http://my.test.proxy.example.com", - transport=httpx.HTTPTransport(local_address="0.0.0.0"), - ), -) -``` - -## Contributing - -While we value open-source contributions to this SDK, this library is generated programmatically. -Additions made directly to this library would have to be moved over to our generation code, -otherwise they would be overwritten upon the next generated release. Feel free to open a PR as -a proof of concept, but know that we will not be able to merge it as-is. We suggest opening -an issue first to discuss with us! - -On the other hand, contributions to the README are always very welcome! diff --git a/seed/python-sdk/reserved-keywords/README.md b/seed/python-sdk/reserved-keywords/README.md index 601fd5e2ba5..e69de29bb2d 100644 --- a/seed/python-sdk/reserved-keywords/README.md +++ b/seed/python-sdk/reserved-keywords/README.md @@ -1,131 +0,0 @@ -# Seed Python Library - -[![fern shield](https://img.shields.io/badge/%F0%9F%8C%BF-SDK%20generated%20by%20Fern-brightgreen)](https://github.com/fern-api/fern) -[![pypi](https://img.shields.io/pypi/v/fern_reserved-keywords)](https://pypi.python.org/pypi/fern_reserved-keywords) - -The Seed Python library provides convenient access to the Seed API from Python. - -## Installation - -```sh -pip install fern_reserved-keywords -``` - -## Usage - -Instantiate and use the client with the following: - -```python -from seed import SeedNurseryApi - -client = SeedNurseryApi( - base_url="https://yourhost.com/path/to/api", -) -client.package.test( - for_="string", -) -``` - -## Async Client - -The SDK also exports an `async` client so that you can make non-blocking calls to our API. - -```python -import asyncio - -from seed import AsyncSeedNurseryApi - -client = AsyncSeedNurseryApi( - base_url="https://yourhost.com/path/to/api", -) - - -async def main() -> None: - await client.package.test( - for_="string", - ) - - -asyncio.run(main()) -``` - -## Exception Handling - -When the API returns a non-success status code (4xx or 5xx response), a subclass of the following error -will be thrown. - -```python -from seed.core.api_error import ApiError - -try: - client.package.test() -except ApiError as e: - print(e.status_code) - print(e.body) -``` - -## Advanced - -### Retries - -The SDK is instrumented with automatic retries with exponential backoff. A request will be retried as long -as the request is deemed retriable and the number of retry attempts has not grown larger than the configured -retry limit (default: 2). - -A request is deemed retriable when any of the following HTTP status codes is returned: - -- [408](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/408) (Timeout) -- [429](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/429) (Too Many Requests) -- [5XX](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/500) (Internal Server Errors) - -Use the `max_retries` request option to configure this behavior. - -```python -client.package.test({ - max_retries=1 -}) -``` - -### Timeouts - -The SDK defaults to a 60 second timeout. You can configure this with a timeout option at the client or request level. - -```python - -from seed import SeedNurseryApi - -client = SeedNurseryApi(..., { timeout=20.0 }, ) - - -# Override timeout for a specific method -client.package.test({ - timeout_in_seconds=1 -}) -``` - -### Custom Client - -You can override the `httpx` client to customize it for your use-case. Some common use-cases include support for proxies -and transports. -```python -import httpx -from seed import SeedNurseryApi - -client = SeedNurseryApi( - ..., - http_client=httpx.Client( - proxies="http://my.test.proxy.example.com", - transport=httpx.HTTPTransport(local_address="0.0.0.0"), - ), -) -``` - -## Contributing - -While we value open-source contributions to this SDK, this library is generated programmatically. -Additions made directly to this library would have to be moved over to our generation code, -otherwise they would be overwritten upon the next generated release. Feel free to open a PR as -a proof of concept, but know that we will not be able to merge it as-is. We suggest opening -an issue first to discuss with us! - -On the other hand, contributions to the README are always very welcome! diff --git a/seed/python-sdk/server-sent-events/README.md b/seed/python-sdk/server-sent-events/README.md index 62c05a0bee8..e69de29bb2d 100644 --- a/seed/python-sdk/server-sent-events/README.md +++ b/seed/python-sdk/server-sent-events/README.md @@ -1,152 +0,0 @@ -# Seed Python Library - -[![fern shield](https://img.shields.io/badge/%F0%9F%8C%BF-SDK%20generated%20by%20Fern-brightgreen)](https://github.com/fern-api/fern) -[![pypi](https://img.shields.io/pypi/v/fern_server-sent-events)](https://pypi.python.org/pypi/fern_server-sent-events) - -The Seed Python library provides convenient access to the Seed API from Python. - -## Installation - -```sh -pip install fern_server-sent-events -``` - -## Usage - -Instantiate and use the client with the following: - -```python -from seed import SeedServerSentEvents - -client = SeedServerSentEvents( - base_url="https://yourhost.com/path/to/api", -) -response = client.completions.stream( - query="string", -) -for chunk in response: - yield chunk -``` - -## Async Client - -The SDK also exports an `async` client so that you can make non-blocking calls to our API. - -```python -import asyncio - -from seed import AsyncSeedServerSentEvents - -client = AsyncSeedServerSentEvents( - base_url="https://yourhost.com/path/to/api", -) - - -async def main() -> None: - response = await client.completions.stream( - query="string", - ) - async for chunk in response: - yield chunk - - -asyncio.run(main()) -``` - -## Exception Handling - -When the API returns a non-success status code (4xx or 5xx response), a subclass of the following error -will be thrown. - -```python -from seed.core.api_error import ApiError - -try: - client.completions.stream() -except ApiError as e: - print(e.status_code) - print(e.body) -``` - -## Streaming - -The SDK supports streaming responses, as well, the response will be a generator that you can loop over. - -```python -from seed import SeedServerSentEvents - -client = SeedServerSentEvents( - base_url="https://yourhost.com/path/to/api", -) -response = client.completions.stream( - query="string", -) -for chunk in response: - yield chunk -``` - -## Advanced - -### Retries - -The SDK is instrumented with automatic retries with exponential backoff. A request will be retried as long -as the request is deemed retriable and the number of retry attempts has not grown larger than the configured -retry limit (default: 2). - -A request is deemed retriable when any of the following HTTP status codes is returned: - -- [408](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/408) (Timeout) -- [429](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/429) (Too Many Requests) -- [5XX](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/500) (Internal Server Errors) - -Use the `max_retries` request option to configure this behavior. - -```python -client.completions.stream({ - max_retries=1 -}) -``` - -### Timeouts - -The SDK defaults to a 60 second timeout. You can configure this with a timeout option at the client or request level. - -```python - -from seed import SeedServerSentEvents - -client = SeedServerSentEvents(..., { timeout=20.0 }, ) - - -# Override timeout for a specific method -client.completions.stream({ - timeout_in_seconds=1 -}) -``` - -### Custom Client - -You can override the `httpx` client to customize it for your use-case. Some common use-cases include support for proxies -and transports. -```python -import httpx -from seed import SeedServerSentEvents - -client = SeedServerSentEvents( - ..., - http_client=httpx.Client( - proxies="http://my.test.proxy.example.com", - transport=httpx.HTTPTransport(local_address="0.0.0.0"), - ), -) -``` - -## Contributing - -While we value open-source contributions to this SDK, this library is generated programmatically. -Additions made directly to this library would have to be moved over to our generation code, -otherwise they would be overwritten upon the next generated release. Feel free to open a PR as -a proof of concept, but know that we will not be able to merge it as-is. We suggest opening -an issue first to discuss with us! - -On the other hand, contributions to the README are always very welcome! diff --git a/seed/python-sdk/single-url-environment-default/README.md b/seed/python-sdk/single-url-environment-default/README.md index fc40e6b4f8e..e69de29bb2d 100644 --- a/seed/python-sdk/single-url-environment-default/README.md +++ b/seed/python-sdk/single-url-environment-default/README.md @@ -1,127 +0,0 @@ -# Seed Python Library - -[![fern shield](https://img.shields.io/badge/%F0%9F%8C%BF-SDK%20generated%20by%20Fern-brightgreen)](https://github.com/fern-api/fern) -[![pypi](https://img.shields.io/pypi/v/fern_single-url-environment-default)](https://pypi.python.org/pypi/fern_single-url-environment-default) - -The Seed Python library provides convenient access to the Seed API from Python. - -## Installation - -```sh -pip install fern_single-url-environment-default -``` - -## Usage - -Instantiate and use the client with the following: - -```python -from seed import SeedSingleUrlEnvironmentDefault - -client = SeedSingleUrlEnvironmentDefault( - token="YOUR_TOKEN", -) -client.dummy.get_dummy() -``` - -## Async Client - -The SDK also exports an `async` client so that you can make non-blocking calls to our API. - -```python -import asyncio - -from seed import AsyncSeedSingleUrlEnvironmentDefault - -client = AsyncSeedSingleUrlEnvironmentDefault( - token="YOUR_TOKEN", -) - - -async def main() -> None: - await client.dummy.get_dummy() - - -asyncio.run(main()) -``` - -## Exception Handling - -When the API returns a non-success status code (4xx or 5xx response), a subclass of the following error -will be thrown. - -```python -from seed.core.api_error import ApiError - -try: - client.dummy.get_dummy() -except ApiError as e: - print(e.status_code) - print(e.body) -``` - -## Advanced - -### Retries - -The SDK is instrumented with automatic retries with exponential backoff. A request will be retried as long -as the request is deemed retriable and the number of retry attempts has not grown larger than the configured -retry limit (default: 2). - -A request is deemed retriable when any of the following HTTP status codes is returned: - -- [408](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/408) (Timeout) -- [429](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/429) (Too Many Requests) -- [5XX](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/500) (Internal Server Errors) - -Use the `max_retries` request option to configure this behavior. - -```python -client.dummy.get_dummy({ - max_retries=1 -}) -``` - -### Timeouts - -The SDK defaults to a 60 second timeout. You can configure this with a timeout option at the client or request level. - -```python - -from seed import SeedSingleUrlEnvironmentDefault - -client = SeedSingleUrlEnvironmentDefault(..., { timeout=20.0 }, ) - - -# Override timeout for a specific method -client.dummy.get_dummy({ - timeout_in_seconds=1 -}) -``` - -### Custom Client - -You can override the `httpx` client to customize it for your use-case. Some common use-cases include support for proxies -and transports. -```python -import httpx -from seed import SeedSingleUrlEnvironmentDefault - -client = SeedSingleUrlEnvironmentDefault( - ..., - http_client=httpx.Client( - proxies="http://my.test.proxy.example.com", - transport=httpx.HTTPTransport(local_address="0.0.0.0"), - ), -) -``` - -## Contributing - -While we value open-source contributions to this SDK, this library is generated programmatically. -Additions made directly to this library would have to be moved over to our generation code, -otherwise they would be overwritten upon the next generated release. Feel free to open a PR as -a proof of concept, but know that we will not be able to merge it as-is. We suggest opening -an issue first to discuss with us! - -On the other hand, contributions to the README are always very welcome! diff --git a/seed/python-sdk/single-url-environment-no-default/README.md b/seed/python-sdk/single-url-environment-no-default/README.md index 16e4e1681a6..e69de29bb2d 100644 --- a/seed/python-sdk/single-url-environment-no-default/README.md +++ b/seed/python-sdk/single-url-environment-no-default/README.md @@ -1,131 +0,0 @@ -# Seed Python Library - -[![fern shield](https://img.shields.io/badge/%F0%9F%8C%BF-SDK%20generated%20by%20Fern-brightgreen)](https://github.com/fern-api/fern) -[![pypi](https://img.shields.io/pypi/v/fern_single-url-environment-no-default)](https://pypi.python.org/pypi/fern_single-url-environment-no-default) - -The Seed Python library provides convenient access to the Seed API from Python. - -## Installation - -```sh -pip install fern_single-url-environment-no-default -``` - -## Usage - -Instantiate and use the client with the following: - -```python -from seed import SeedSingleUrlEnvironmentNoDefault -from seed.environment import SeedSingleUrlEnvironmentNoDefaultEnvironment - -client = SeedSingleUrlEnvironmentNoDefault( - token="YOUR_TOKEN", - environment=SeedSingleUrlEnvironmentNoDefaultEnvironment.PRODUCTION, -) -client.dummy.get_dummy() -``` - -## Async Client - -The SDK also exports an `async` client so that you can make non-blocking calls to our API. - -```python -import asyncio - -from seed import AsyncSeedSingleUrlEnvironmentNoDefault -from seed.environment import SeedSingleUrlEnvironmentNoDefaultEnvironment - -client = AsyncSeedSingleUrlEnvironmentNoDefault( - token="YOUR_TOKEN", - environment=SeedSingleUrlEnvironmentNoDefaultEnvironment.PRODUCTION, -) - - -async def main() -> None: - await client.dummy.get_dummy() - - -asyncio.run(main()) -``` - -## Exception Handling - -When the API returns a non-success status code (4xx or 5xx response), a subclass of the following error -will be thrown. - -```python -from seed.core.api_error import ApiError - -try: - client.dummy.get_dummy() -except ApiError as e: - print(e.status_code) - print(e.body) -``` - -## Advanced - -### Retries - -The SDK is instrumented with automatic retries with exponential backoff. A request will be retried as long -as the request is deemed retriable and the number of retry attempts has not grown larger than the configured -retry limit (default: 2). - -A request is deemed retriable when any of the following HTTP status codes is returned: - -- [408](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/408) (Timeout) -- [429](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/429) (Too Many Requests) -- [5XX](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/500) (Internal Server Errors) - -Use the `max_retries` request option to configure this behavior. - -```python -client.dummy.get_dummy({ - max_retries=1 -}) -``` - -### Timeouts - -The SDK defaults to a 60 second timeout. You can configure this with a timeout option at the client or request level. - -```python - -from seed import SeedSingleUrlEnvironmentNoDefault - -client = SeedSingleUrlEnvironmentNoDefault(..., { timeout=20.0 }, ) - - -# Override timeout for a specific method -client.dummy.get_dummy({ - timeout_in_seconds=1 -}) -``` - -### Custom Client - -You can override the `httpx` client to customize it for your use-case. Some common use-cases include support for proxies -and transports. -```python -import httpx -from seed import SeedSingleUrlEnvironmentNoDefault - -client = SeedSingleUrlEnvironmentNoDefault( - ..., - http_client=httpx.Client( - proxies="http://my.test.proxy.example.com", - transport=httpx.HTTPTransport(local_address="0.0.0.0"), - ), -) -``` - -## Contributing - -While we value open-source contributions to this SDK, this library is generated programmatically. -Additions made directly to this library would have to be moved over to our generation code, -otherwise they would be overwritten upon the next generated release. Feel free to open a PR as -a proof of concept, but know that we will not be able to merge it as-is. We suggest opening -an issue first to discuss with us! - -On the other hand, contributions to the README are always very welcome! diff --git a/seed/python-sdk/streaming-parameter/README.md b/seed/python-sdk/streaming-parameter/README.md index 45ff0c90068..e69de29bb2d 100644 --- a/seed/python-sdk/streaming-parameter/README.md +++ b/seed/python-sdk/streaming-parameter/README.md @@ -1,133 +0,0 @@ -# Seed Python Library - -[![fern shield](https://img.shields.io/badge/%F0%9F%8C%BF-SDK%20generated%20by%20Fern-brightgreen)](https://github.com/fern-api/fern) -[![pypi](https://img.shields.io/pypi/v/fern_streaming-parameter)](https://pypi.python.org/pypi/fern_streaming-parameter) - -The Seed Python library provides convenient access to the Seed API from Python. - -## Installation - -```sh -pip install fern_streaming-parameter -``` - -## Usage - -Instantiate and use the client with the following: - -```python -from seed import SeedStreaming - -client = SeedStreaming( - base_url="https://yourhost.com/path/to/api", -) -client.dummy.generate( - stream=False, - num_events=5, -) -``` - -## Async Client - -The SDK also exports an `async` client so that you can make non-blocking calls to our API. - -```python -import asyncio - -from seed import AsyncSeedStreaming - -client = AsyncSeedStreaming( - base_url="https://yourhost.com/path/to/api", -) - - -async def main() -> None: - await client.dummy.generate( - stream=False, - num_events=5, - ) - - -asyncio.run(main()) -``` - -## Exception Handling - -When the API returns a non-success status code (4xx or 5xx response), a subclass of the following error -will be thrown. - -```python -from seed.core.api_error import ApiError - -try: - client.dummy.generate() -except ApiError as e: - print(e.status_code) - print(e.body) -``` - -## Advanced - -### Retries - -The SDK is instrumented with automatic retries with exponential backoff. A request will be retried as long -as the request is deemed retriable and the number of retry attempts has not grown larger than the configured -retry limit (default: 2). - -A request is deemed retriable when any of the following HTTP status codes is returned: - -- [408](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/408) (Timeout) -- [429](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/429) (Too Many Requests) -- [5XX](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/500) (Internal Server Errors) - -Use the `max_retries` request option to configure this behavior. - -```python -client.dummy.generate({ - max_retries=1 -}) -``` - -### Timeouts - -The SDK defaults to a 60 second timeout. You can configure this with a timeout option at the client or request level. - -```python - -from seed import SeedStreaming - -client = SeedStreaming(..., { timeout=20.0 }, ) - - -# Override timeout for a specific method -client.dummy.generate({ - timeout_in_seconds=1 -}) -``` - -### Custom Client - -You can override the `httpx` client to customize it for your use-case. Some common use-cases include support for proxies -and transports. -```python -import httpx -from seed import SeedStreaming - -client = SeedStreaming( - ..., - http_client=httpx.Client( - proxies="http://my.test.proxy.example.com", - transport=httpx.HTTPTransport(local_address="0.0.0.0"), - ), -) -``` - -## Contributing - -While we value open-source contributions to this SDK, this library is generated programmatically. -Additions made directly to this library would have to be moved over to our generation code, -otherwise they would be overwritten upon the next generated release. Feel free to open a PR as -a proof of concept, but know that we will not be able to merge it as-is. We suggest opening -an issue first to discuss with us! - -On the other hand, contributions to the README are always very welcome! diff --git a/seed/python-sdk/streaming/no-custom-config/README.md b/seed/python-sdk/streaming/no-custom-config/README.md index 45a5ac6f671..e69de29bb2d 100644 --- a/seed/python-sdk/streaming/no-custom-config/README.md +++ b/seed/python-sdk/streaming/no-custom-config/README.md @@ -1,152 +0,0 @@ -# Seed Python Library - -[![fern shield](https://img.shields.io/badge/%F0%9F%8C%BF-SDK%20generated%20by%20Fern-brightgreen)](https://github.com/fern-api/fern) -[![pypi](https://img.shields.io/pypi/v/fern_streaming)](https://pypi.python.org/pypi/fern_streaming) - -The Seed Python library provides convenient access to the Seed API from Python. - -## Installation - -```sh -pip install fern_streaming -``` - -## Usage - -Instantiate and use the client with the following: - -```python -from seed import SeedStreaming - -client = SeedStreaming( - base_url="https://yourhost.com/path/to/api", -) -response = client.dummy.generate_stream( - num_events=1, -) -for chunk in response: - yield chunk -``` - -## Async Client - -The SDK also exports an `async` client so that you can make non-blocking calls to our API. - -```python -import asyncio - -from seed import AsyncSeedStreaming - -client = AsyncSeedStreaming( - base_url="https://yourhost.com/path/to/api", -) - - -async def main() -> None: - response = await client.dummy.generate_stream( - num_events=1, - ) - async for chunk in response: - yield chunk - - -asyncio.run(main()) -``` - -## Exception Handling - -When the API returns a non-success status code (4xx or 5xx response), a subclass of the following error -will be thrown. - -```python -from seed.core.api_error import ApiError - -try: - client.dummy.generate_stream(...) -except ApiError as e: - print(e.status_code) - print(e.body) -``` - -## Streaming - -The SDK supports streaming responses, as well, the response will be a generator that you can loop over. - -```python -from seed import SeedStreaming - -client = SeedStreaming( - base_url="https://yourhost.com/path/to/api", -) -response = client.dummy.generate_stream( - num_events=1, -) -for chunk in response: - yield chunk -``` - -## Advanced - -### Retries - -The SDK is instrumented with automatic retries with exponential backoff. A request will be retried as long -as the request is deemed retriable and the number of retry attempts has not grown larger than the configured -retry limit (default: 2). - -A request is deemed retriable when any of the following HTTP status codes is returned: - -- [408](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/408) (Timeout) -- [429](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/429) (Too Many Requests) -- [5XX](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/500) (Internal Server Errors) - -Use the `max_retries` request option to configure this behavior. - -```python -client.dummy.generate_stream(...,{ - max_retries=1 -}) -``` - -### Timeouts - -The SDK defaults to a 60 second timeout. You can configure this with a timeout option at the client or request level. - -```python - -from seed import SeedStreaming - -client = SeedStreaming(..., { timeout=20.0 }, ) - - -# Override timeout for a specific method -client.dummy.generate_stream(...,{ - timeout_in_seconds=1 -}) -``` - -### Custom Client - -You can override the `httpx` client to customize it for your use-case. Some common use-cases include support for proxies -and transports. -```python -import httpx -from seed import SeedStreaming - -client = SeedStreaming( - ..., - http_client=httpx.Client( - proxies="http://my.test.proxy.example.com", - transport=httpx.HTTPTransport(local_address="0.0.0.0"), - ), -) -``` - -## Contributing - -While we value open-source contributions to this SDK, this library is generated programmatically. -Additions made directly to this library would have to be moved over to our generation code, -otherwise they would be overwritten upon the next generated release. Feel free to open a PR as -a proof of concept, but know that we will not be able to merge it as-is. We suggest opening -an issue first to discuss with us! - -On the other hand, contributions to the README are always very welcome! diff --git a/seed/python-sdk/streaming/skip-pydantic-validation/README.md b/seed/python-sdk/streaming/skip-pydantic-validation/README.md index 45a5ac6f671..e69de29bb2d 100644 --- a/seed/python-sdk/streaming/skip-pydantic-validation/README.md +++ b/seed/python-sdk/streaming/skip-pydantic-validation/README.md @@ -1,152 +0,0 @@ -# Seed Python Library - -[![fern shield](https://img.shields.io/badge/%F0%9F%8C%BF-SDK%20generated%20by%20Fern-brightgreen)](https://github.com/fern-api/fern) -[![pypi](https://img.shields.io/pypi/v/fern_streaming)](https://pypi.python.org/pypi/fern_streaming) - -The Seed Python library provides convenient access to the Seed API from Python. - -## Installation - -```sh -pip install fern_streaming -``` - -## Usage - -Instantiate and use the client with the following: - -```python -from seed import SeedStreaming - -client = SeedStreaming( - base_url="https://yourhost.com/path/to/api", -) -response = client.dummy.generate_stream( - num_events=1, -) -for chunk in response: - yield chunk -``` - -## Async Client - -The SDK also exports an `async` client so that you can make non-blocking calls to our API. - -```python -import asyncio - -from seed import AsyncSeedStreaming - -client = AsyncSeedStreaming( - base_url="https://yourhost.com/path/to/api", -) - - -async def main() -> None: - response = await client.dummy.generate_stream( - num_events=1, - ) - async for chunk in response: - yield chunk - - -asyncio.run(main()) -``` - -## Exception Handling - -When the API returns a non-success status code (4xx or 5xx response), a subclass of the following error -will be thrown. - -```python -from seed.core.api_error import ApiError - -try: - client.dummy.generate_stream(...) -except ApiError as e: - print(e.status_code) - print(e.body) -``` - -## Streaming - -The SDK supports streaming responses, as well, the response will be a generator that you can loop over. - -```python -from seed import SeedStreaming - -client = SeedStreaming( - base_url="https://yourhost.com/path/to/api", -) -response = client.dummy.generate_stream( - num_events=1, -) -for chunk in response: - yield chunk -``` - -## Advanced - -### Retries - -The SDK is instrumented with automatic retries with exponential backoff. A request will be retried as long -as the request is deemed retriable and the number of retry attempts has not grown larger than the configured -retry limit (default: 2). - -A request is deemed retriable when any of the following HTTP status codes is returned: - -- [408](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/408) (Timeout) -- [429](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/429) (Too Many Requests) -- [5XX](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/500) (Internal Server Errors) - -Use the `max_retries` request option to configure this behavior. - -```python -client.dummy.generate_stream(...,{ - max_retries=1 -}) -``` - -### Timeouts - -The SDK defaults to a 60 second timeout. You can configure this with a timeout option at the client or request level. - -```python - -from seed import SeedStreaming - -client = SeedStreaming(..., { timeout=20.0 }, ) - - -# Override timeout for a specific method -client.dummy.generate_stream(...,{ - timeout_in_seconds=1 -}) -``` - -### Custom Client - -You can override the `httpx` client to customize it for your use-case. Some common use-cases include support for proxies -and transports. -```python -import httpx -from seed import SeedStreaming - -client = SeedStreaming( - ..., - http_client=httpx.Client( - proxies="http://my.test.proxy.example.com", - transport=httpx.HTTPTransport(local_address="0.0.0.0"), - ), -) -``` - -## Contributing - -While we value open-source contributions to this SDK, this library is generated programmatically. -Additions made directly to this library would have to be moved over to our generation code, -otherwise they would be overwritten upon the next generated release. Feel free to open a PR as -a proof of concept, but know that we will not be able to merge it as-is. We suggest opening -an issue first to discuss with us! - -On the other hand, contributions to the README are always very welcome! diff --git a/seed/python-sdk/undiscriminated-unions/README.md b/seed/python-sdk/undiscriminated-unions/README.md index e5e93da45cc..e69de29bb2d 100644 --- a/seed/python-sdk/undiscriminated-unions/README.md +++ b/seed/python-sdk/undiscriminated-unions/README.md @@ -1,131 +0,0 @@ -# Seed Python Library - -[![fern shield](https://img.shields.io/badge/%F0%9F%8C%BF-SDK%20generated%20by%20Fern-brightgreen)](https://github.com/fern-api/fern) -[![pypi](https://img.shields.io/pypi/v/fern_undiscriminated-unions)](https://pypi.python.org/pypi/fern_undiscriminated-unions) - -The Seed Python library provides convenient access to the Seed API from Python. - -## Installation - -```sh -pip install fern_undiscriminated-unions -``` - -## Usage - -Instantiate and use the client with the following: - -```python -from seed import SeedUndiscriminatedUnions - -client = SeedUndiscriminatedUnions( - base_url="https://yourhost.com/path/to/api", -) -client.union.get( - request="string", -) -``` - -## Async Client - -The SDK also exports an `async` client so that you can make non-blocking calls to our API. - -```python -import asyncio - -from seed import AsyncSeedUndiscriminatedUnions - -client = AsyncSeedUndiscriminatedUnions( - base_url="https://yourhost.com/path/to/api", -) - - -async def main() -> None: - await client.union.get( - request="string", - ) - - -asyncio.run(main()) -``` - -## Exception Handling - -When the API returns a non-success status code (4xx or 5xx response), a subclass of the following error -will be thrown. - -```python -from seed.core.api_error import ApiError - -try: - client.union.get(...) -except ApiError as e: - print(e.status_code) - print(e.body) -``` - -## Advanced - -### Retries - -The SDK is instrumented with automatic retries with exponential backoff. A request will be retried as long -as the request is deemed retriable and the number of retry attempts has not grown larger than the configured -retry limit (default: 2). - -A request is deemed retriable when any of the following HTTP status codes is returned: - -- [408](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/408) (Timeout) -- [429](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/429) (Too Many Requests) -- [5XX](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/500) (Internal Server Errors) - -Use the `max_retries` request option to configure this behavior. - -```python -client.union.get(...,{ - max_retries=1 -}) -``` - -### Timeouts - -The SDK defaults to a 60 second timeout. You can configure this with a timeout option at the client or request level. - -```python - -from seed import SeedUndiscriminatedUnions - -client = SeedUndiscriminatedUnions(..., { timeout=20.0 }, ) - - -# Override timeout for a specific method -client.union.get(...,{ - timeout_in_seconds=1 -}) -``` - -### Custom Client - -You can override the `httpx` client to customize it for your use-case. Some common use-cases include support for proxies -and transports. -```python -import httpx -from seed import SeedUndiscriminatedUnions - -client = SeedUndiscriminatedUnions( - ..., - http_client=httpx.Client( - proxies="http://my.test.proxy.example.com", - transport=httpx.HTTPTransport(local_address="0.0.0.0"), - ), -) -``` - -## Contributing - -While we value open-source contributions to this SDK, this library is generated programmatically. -Additions made directly to this library would have to be moved over to our generation code, -otherwise they would be overwritten upon the next generated release. Feel free to open a PR as -a proof of concept, but know that we will not be able to merge it as-is. We suggest opening -an issue first to discuss with us! - -On the other hand, contributions to the README are always very welcome! diff --git a/seed/python-sdk/unions/no-custom-config/README.md b/seed/python-sdk/unions/no-custom-config/README.md index f64496f58a3..e69de29bb2d 100644 --- a/seed/python-sdk/unions/no-custom-config/README.md +++ b/seed/python-sdk/unions/no-custom-config/README.md @@ -1,131 +0,0 @@ -# Seed Python Library - -[![fern shield](https://img.shields.io/badge/%F0%9F%8C%BF-SDK%20generated%20by%20Fern-brightgreen)](https://github.com/fern-api/fern) -[![pypi](https://img.shields.io/pypi/v/fern_unions)](https://pypi.python.org/pypi/fern_unions) - -The Seed Python library provides convenient access to the Seed API from Python. - -## Installation - -```sh -pip install fern_unions -``` - -## Usage - -Instantiate and use the client with the following: - -```python -from seed import SeedUnions - -client = SeedUnions( - base_url="https://yourhost.com/path/to/api", -) -client.union.get( - id="string", -) -``` - -## Async Client - -The SDK also exports an `async` client so that you can make non-blocking calls to our API. - -```python -import asyncio - -from seed import AsyncSeedUnions - -client = AsyncSeedUnions( - base_url="https://yourhost.com/path/to/api", -) - - -async def main() -> None: - await client.union.get( - id="string", - ) - - -asyncio.run(main()) -``` - -## Exception Handling - -When the API returns a non-success status code (4xx or 5xx response), a subclass of the following error -will be thrown. - -```python -from seed.core.api_error import ApiError - -try: - client.union.get(...) -except ApiError as e: - print(e.status_code) - print(e.body) -``` - -## Advanced - -### Retries - -The SDK is instrumented with automatic retries with exponential backoff. A request will be retried as long -as the request is deemed retriable and the number of retry attempts has not grown larger than the configured -retry limit (default: 2). - -A request is deemed retriable when any of the following HTTP status codes is returned: - -- [408](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/408) (Timeout) -- [429](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/429) (Too Many Requests) -- [5XX](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/500) (Internal Server Errors) - -Use the `max_retries` request option to configure this behavior. - -```python -client.union.get(...,{ - max_retries=1 -}) -``` - -### Timeouts - -The SDK defaults to a 60 second timeout. You can configure this with a timeout option at the client or request level. - -```python - -from seed import SeedUnions - -client = SeedUnions(..., { timeout=20.0 }, ) - - -# Override timeout for a specific method -client.union.get(...,{ - timeout_in_seconds=1 -}) -``` - -### Custom Client - -You can override the `httpx` client to customize it for your use-case. Some common use-cases include support for proxies -and transports. -```python -import httpx -from seed import SeedUnions - -client = SeedUnions( - ..., - http_client=httpx.Client( - proxies="http://my.test.proxy.example.com", - transport=httpx.HTTPTransport(local_address="0.0.0.0"), - ), -) -``` - -## Contributing - -While we value open-source contributions to this SDK, this library is generated programmatically. -Additions made directly to this library would have to be moved over to our generation code, -otherwise they would be overwritten upon the next generated release. Feel free to open a PR as -a proof of concept, but know that we will not be able to merge it as-is. We suggest opening -an issue first to discuss with us! - -On the other hand, contributions to the README are always very welcome! diff --git a/seed/python-sdk/unions/union-utils/README.md b/seed/python-sdk/unions/union-utils/README.md index f64496f58a3..e69de29bb2d 100644 --- a/seed/python-sdk/unions/union-utils/README.md +++ b/seed/python-sdk/unions/union-utils/README.md @@ -1,131 +0,0 @@ -# Seed Python Library - -[![fern shield](https://img.shields.io/badge/%F0%9F%8C%BF-SDK%20generated%20by%20Fern-brightgreen)](https://github.com/fern-api/fern) -[![pypi](https://img.shields.io/pypi/v/fern_unions)](https://pypi.python.org/pypi/fern_unions) - -The Seed Python library provides convenient access to the Seed API from Python. - -## Installation - -```sh -pip install fern_unions -``` - -## Usage - -Instantiate and use the client with the following: - -```python -from seed import SeedUnions - -client = SeedUnions( - base_url="https://yourhost.com/path/to/api", -) -client.union.get( - id="string", -) -``` - -## Async Client - -The SDK also exports an `async` client so that you can make non-blocking calls to our API. - -```python -import asyncio - -from seed import AsyncSeedUnions - -client = AsyncSeedUnions( - base_url="https://yourhost.com/path/to/api", -) - - -async def main() -> None: - await client.union.get( - id="string", - ) - - -asyncio.run(main()) -``` - -## Exception Handling - -When the API returns a non-success status code (4xx or 5xx response), a subclass of the following error -will be thrown. - -```python -from seed.core.api_error import ApiError - -try: - client.union.get(...) -except ApiError as e: - print(e.status_code) - print(e.body) -``` - -## Advanced - -### Retries - -The SDK is instrumented with automatic retries with exponential backoff. A request will be retried as long -as the request is deemed retriable and the number of retry attempts has not grown larger than the configured -retry limit (default: 2). - -A request is deemed retriable when any of the following HTTP status codes is returned: - -- [408](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/408) (Timeout) -- [429](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/429) (Too Many Requests) -- [5XX](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/500) (Internal Server Errors) - -Use the `max_retries` request option to configure this behavior. - -```python -client.union.get(...,{ - max_retries=1 -}) -``` - -### Timeouts - -The SDK defaults to a 60 second timeout. You can configure this with a timeout option at the client or request level. - -```python - -from seed import SeedUnions - -client = SeedUnions(..., { timeout=20.0 }, ) - - -# Override timeout for a specific method -client.union.get(...,{ - timeout_in_seconds=1 -}) -``` - -### Custom Client - -You can override the `httpx` client to customize it for your use-case. Some common use-cases include support for proxies -and transports. -```python -import httpx -from seed import SeedUnions - -client = SeedUnions( - ..., - http_client=httpx.Client( - proxies="http://my.test.proxy.example.com", - transport=httpx.HTTPTransport(local_address="0.0.0.0"), - ), -) -``` - -## Contributing - -While we value open-source contributions to this SDK, this library is generated programmatically. -Additions made directly to this library would have to be moved over to our generation code, -otherwise they would be overwritten upon the next generated release. Feel free to open a PR as -a proof of concept, but know that we will not be able to merge it as-is. We suggest opening -an issue first to discuss with us! - -On the other hand, contributions to the README are always very welcome! diff --git a/seed/python-sdk/unknown/README.md b/seed/python-sdk/unknown/README.md index 5bb27c1c562..e69de29bb2d 100644 --- a/seed/python-sdk/unknown/README.md +++ b/seed/python-sdk/unknown/README.md @@ -1,131 +0,0 @@ -# Seed Python Library - -[![fern shield](https://img.shields.io/badge/%F0%9F%8C%BF-SDK%20generated%20by%20Fern-brightgreen)](https://github.com/fern-api/fern) -[![pypi](https://img.shields.io/pypi/v/fern_unknown)](https://pypi.python.org/pypi/fern_unknown) - -The Seed Python library provides convenient access to the Seed API from Python. - -## Installation - -```sh -pip install fern_unknown -``` - -## Usage - -Instantiate and use the client with the following: - -```python -from seed import SeedUnknownAsAny - -client = SeedUnknownAsAny( - base_url="https://yourhost.com/path/to/api", -) -client.unknown.post( - request={"key": "value"}, -) -``` - -## Async Client - -The SDK also exports an `async` client so that you can make non-blocking calls to our API. - -```python -import asyncio - -from seed import AsyncSeedUnknownAsAny - -client = AsyncSeedUnknownAsAny( - base_url="https://yourhost.com/path/to/api", -) - - -async def main() -> None: - await client.unknown.post( - request={"key": "value"}, - ) - - -asyncio.run(main()) -``` - -## Exception Handling - -When the API returns a non-success status code (4xx or 5xx response), a subclass of the following error -will be thrown. - -```python -from seed.core.api_error import ApiError - -try: - client.unknown.post() -except ApiError as e: - print(e.status_code) - print(e.body) -``` - -## Advanced - -### Retries - -The SDK is instrumented with automatic retries with exponential backoff. A request will be retried as long -as the request is deemed retriable and the number of retry attempts has not grown larger than the configured -retry limit (default: 2). - -A request is deemed retriable when any of the following HTTP status codes is returned: - -- [408](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/408) (Timeout) -- [429](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/429) (Too Many Requests) -- [5XX](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/500) (Internal Server Errors) - -Use the `max_retries` request option to configure this behavior. - -```python -client.unknown.post({ - max_retries=1 -}) -``` - -### Timeouts - -The SDK defaults to a 60 second timeout. You can configure this with a timeout option at the client or request level. - -```python - -from seed import SeedUnknownAsAny - -client = SeedUnknownAsAny(..., { timeout=20.0 }, ) - - -# Override timeout for a specific method -client.unknown.post({ - timeout_in_seconds=1 -}) -``` - -### Custom Client - -You can override the `httpx` client to customize it for your use-case. Some common use-cases include support for proxies -and transports. -```python -import httpx -from seed import SeedUnknownAsAny - -client = SeedUnknownAsAny( - ..., - http_client=httpx.Client( - proxies="http://my.test.proxy.example.com", - transport=httpx.HTTPTransport(local_address="0.0.0.0"), - ), -) -``` - -## Contributing - -While we value open-source contributions to this SDK, this library is generated programmatically. -Additions made directly to this library would have to be moved over to our generation code, -otherwise they would be overwritten upon the next generated release. Feel free to open a PR as -a proof of concept, but know that we will not be able to merge it as-is. We suggest opening -an issue first to discuss with us! - -On the other hand, contributions to the README are always very welcome! diff --git a/seed/python-sdk/validation/no-custom-config/README.md b/seed/python-sdk/validation/no-custom-config/README.md index 451cc730ba5..e69de29bb2d 100644 --- a/seed/python-sdk/validation/no-custom-config/README.md +++ b/seed/python-sdk/validation/no-custom-config/README.md @@ -1,137 +0,0 @@ -# Seed Python Library - -[![fern shield](https://img.shields.io/badge/%F0%9F%8C%BF-SDK%20generated%20by%20Fern-brightgreen)](https://github.com/fern-api/fern) -[![pypi](https://img.shields.io/pypi/v/fern_validation)](https://pypi.python.org/pypi/fern_validation) - -The Seed Python library provides convenient access to the Seed API from Python. - -## Installation - -```sh -pip install fern_validation -``` - -## Usage - -Instantiate and use the client with the following: - -```python -from seed import SeedValidation - -client = SeedValidation( - base_url="https://yourhost.com/path/to/api", -) -client.create( - decimal=1.1, - even=1, - name="string", - shape="SQUARE", -) -``` - -## Async Client - -The SDK also exports an `async` client so that you can make non-blocking calls to our API. - -```python -import asyncio - -from seed import AsyncSeedValidation - -client = AsyncSeedValidation( - base_url="https://yourhost.com/path/to/api", -) - - -async def main() -> None: - await client.create( - decimal=1.1, - even=1, - name="string", - shape="SQUARE", - ) - - -asyncio.run(main()) -``` - -## Exception Handling - -When the API returns a non-success status code (4xx or 5xx response), a subclass of the following error -will be thrown. - -```python -from seed.core.api_error import ApiError - -try: - client.create(...) -except ApiError as e: - print(e.status_code) - print(e.body) -``` - -## Advanced - -### Retries - -The SDK is instrumented with automatic retries with exponential backoff. A request will be retried as long -as the request is deemed retriable and the number of retry attempts has not grown larger than the configured -retry limit (default: 2). - -A request is deemed retriable when any of the following HTTP status codes is returned: - -- [408](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/408) (Timeout) -- [429](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/429) (Too Many Requests) -- [5XX](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/500) (Internal Server Errors) - -Use the `max_retries` request option to configure this behavior. - -```python -client.create(...,{ - max_retries=1 -}) -``` - -### Timeouts - -The SDK defaults to a 60 second timeout. You can configure this with a timeout option at the client or request level. - -```python - -from seed import SeedValidation - -client = SeedValidation(..., { timeout=20.0 }, ) - - -# Override timeout for a specific method -client.create(...,{ - timeout_in_seconds=1 -}) -``` - -### Custom Client - -You can override the `httpx` client to customize it for your use-case. Some common use-cases include support for proxies -and transports. -```python -import httpx -from seed import SeedValidation - -client = SeedValidation( - ..., - http_client=httpx.Client( - proxies="http://my.test.proxy.example.com", - transport=httpx.HTTPTransport(local_address="0.0.0.0"), - ), -) -``` - -## Contributing - -While we value open-source contributions to this SDK, this library is generated programmatically. -Additions made directly to this library would have to be moved over to our generation code, -otherwise they would be overwritten upon the next generated release. Feel free to open a PR as -a proof of concept, but know that we will not be able to merge it as-is. We suggest opening -an issue first to discuss with us! - -On the other hand, contributions to the README are always very welcome! diff --git a/seed/python-sdk/validation/with-defaults/README.md b/seed/python-sdk/validation/with-defaults/README.md index 451cc730ba5..e69de29bb2d 100644 --- a/seed/python-sdk/validation/with-defaults/README.md +++ b/seed/python-sdk/validation/with-defaults/README.md @@ -1,137 +0,0 @@ -# Seed Python Library - -[![fern shield](https://img.shields.io/badge/%F0%9F%8C%BF-SDK%20generated%20by%20Fern-brightgreen)](https://github.com/fern-api/fern) -[![pypi](https://img.shields.io/pypi/v/fern_validation)](https://pypi.python.org/pypi/fern_validation) - -The Seed Python library provides convenient access to the Seed API from Python. - -## Installation - -```sh -pip install fern_validation -``` - -## Usage - -Instantiate and use the client with the following: - -```python -from seed import SeedValidation - -client = SeedValidation( - base_url="https://yourhost.com/path/to/api", -) -client.create( - decimal=1.1, - even=1, - name="string", - shape="SQUARE", -) -``` - -## Async Client - -The SDK also exports an `async` client so that you can make non-blocking calls to our API. - -```python -import asyncio - -from seed import AsyncSeedValidation - -client = AsyncSeedValidation( - base_url="https://yourhost.com/path/to/api", -) - - -async def main() -> None: - await client.create( - decimal=1.1, - even=1, - name="string", - shape="SQUARE", - ) - - -asyncio.run(main()) -``` - -## Exception Handling - -When the API returns a non-success status code (4xx or 5xx response), a subclass of the following error -will be thrown. - -```python -from seed.core.api_error import ApiError - -try: - client.create(...) -except ApiError as e: - print(e.status_code) - print(e.body) -``` - -## Advanced - -### Retries - -The SDK is instrumented with automatic retries with exponential backoff. A request will be retried as long -as the request is deemed retriable and the number of retry attempts has not grown larger than the configured -retry limit (default: 2). - -A request is deemed retriable when any of the following HTTP status codes is returned: - -- [408](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/408) (Timeout) -- [429](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/429) (Too Many Requests) -- [5XX](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/500) (Internal Server Errors) - -Use the `max_retries` request option to configure this behavior. - -```python -client.create(...,{ - max_retries=1 -}) -``` - -### Timeouts - -The SDK defaults to a 60 second timeout. You can configure this with a timeout option at the client or request level. - -```python - -from seed import SeedValidation - -client = SeedValidation(..., { timeout=20.0 }, ) - - -# Override timeout for a specific method -client.create(...,{ - timeout_in_seconds=1 -}) -``` - -### Custom Client - -You can override the `httpx` client to customize it for your use-case. Some common use-cases include support for proxies -and transports. -```python -import httpx -from seed import SeedValidation - -client = SeedValidation( - ..., - http_client=httpx.Client( - proxies="http://my.test.proxy.example.com", - transport=httpx.HTTPTransport(local_address="0.0.0.0"), - ), -) -``` - -## Contributing - -While we value open-source contributions to this SDK, this library is generated programmatically. -Additions made directly to this library would have to be moved over to our generation code, -otherwise they would be overwritten upon the next generated release. Feel free to open a PR as -a proof of concept, but know that we will not be able to merge it as-is. We suggest opening -an issue first to discuss with us! - -On the other hand, contributions to the README are always very welcome! diff --git a/seed/python-sdk/variables/README.md b/seed/python-sdk/variables/README.md index 9f3e8dbaecb..e69de29bb2d 100644 --- a/seed/python-sdk/variables/README.md +++ b/seed/python-sdk/variables/README.md @@ -1,131 +0,0 @@ -# Seed Python Library - -[![fern shield](https://img.shields.io/badge/%F0%9F%8C%BF-SDK%20generated%20by%20Fern-brightgreen)](https://github.com/fern-api/fern) -[![pypi](https://img.shields.io/pypi/v/fern_variables)](https://pypi.python.org/pypi/fern_variables) - -The Seed Python library provides convenient access to the Seed API from Python. - -## Installation - -```sh -pip install fern_variables -``` - -## Usage - -Instantiate and use the client with the following: - -```python -from seed import SeedVariables - -client = SeedVariables( - base_url="https://yourhost.com/path/to/api", -) -client.service.post( - endpoint_param="string", -) -``` - -## Async Client - -The SDK also exports an `async` client so that you can make non-blocking calls to our API. - -```python -import asyncio - -from seed import AsyncSeedVariables - -client = AsyncSeedVariables( - base_url="https://yourhost.com/path/to/api", -) - - -async def main() -> None: - await client.service.post( - endpoint_param="string", - ) - - -asyncio.run(main()) -``` - -## Exception Handling - -When the API returns a non-success status code (4xx or 5xx response), a subclass of the following error -will be thrown. - -```python -from seed.core.api_error import ApiError - -try: - client.service.post() -except ApiError as e: - print(e.status_code) - print(e.body) -``` - -## Advanced - -### Retries - -The SDK is instrumented with automatic retries with exponential backoff. A request will be retried as long -as the request is deemed retriable and the number of retry attempts has not grown larger than the configured -retry limit (default: 2). - -A request is deemed retriable when any of the following HTTP status codes is returned: - -- [408](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/408) (Timeout) -- [429](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/429) (Too Many Requests) -- [5XX](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/500) (Internal Server Errors) - -Use the `max_retries` request option to configure this behavior. - -```python -client.service.post({ - max_retries=1 -}) -``` - -### Timeouts - -The SDK defaults to a 60 second timeout. You can configure this with a timeout option at the client or request level. - -```python - -from seed import SeedVariables - -client = SeedVariables(..., { timeout=20.0 }, ) - - -# Override timeout for a specific method -client.service.post({ - timeout_in_seconds=1 -}) -``` - -### Custom Client - -You can override the `httpx` client to customize it for your use-case. Some common use-cases include support for proxies -and transports. -```python -import httpx -from seed import SeedVariables - -client = SeedVariables( - ..., - http_client=httpx.Client( - proxies="http://my.test.proxy.example.com", - transport=httpx.HTTPTransport(local_address="0.0.0.0"), - ), -) -``` - -## Contributing - -While we value open-source contributions to this SDK, this library is generated programmatically. -Additions made directly to this library would have to be moved over to our generation code, -otherwise they would be overwritten upon the next generated release. Feel free to open a PR as -a proof of concept, but know that we will not be able to merge it as-is. We suggest opening -an issue first to discuss with us! - -On the other hand, contributions to the README are always very welcome! diff --git a/seed/python-sdk/version-no-default/README.md b/seed/python-sdk/version-no-default/README.md index 6522d9c34b2..e69de29bb2d 100644 --- a/seed/python-sdk/version-no-default/README.md +++ b/seed/python-sdk/version-no-default/README.md @@ -1,131 +0,0 @@ -# Seed Python Library - -[![fern shield](https://img.shields.io/badge/%F0%9F%8C%BF-SDK%20generated%20by%20Fern-brightgreen)](https://github.com/fern-api/fern) -[![pypi](https://img.shields.io/pypi/v/fern_version-no-default)](https://pypi.python.org/pypi/fern_version-no-default) - -The Seed Python library provides convenient access to the Seed API from Python. - -## Installation - -```sh -pip install fern_version-no-default -``` - -## Usage - -Instantiate and use the client with the following: - -```python -from seed import SeedVersion - -client = SeedVersion( - base_url="https://yourhost.com/path/to/api", -) -client.user.get_user( - user_id="string", -) -``` - -## Async Client - -The SDK also exports an `async` client so that you can make non-blocking calls to our API. - -```python -import asyncio - -from seed import AsyncSeedVersion - -client = AsyncSeedVersion( - base_url="https://yourhost.com/path/to/api", -) - - -async def main() -> None: - await client.user.get_user( - user_id="string", - ) - - -asyncio.run(main()) -``` - -## Exception Handling - -When the API returns a non-success status code (4xx or 5xx response), a subclass of the following error -will be thrown. - -```python -from seed.core.api_error import ApiError - -try: - client.user.get_user() -except ApiError as e: - print(e.status_code) - print(e.body) -``` - -## Advanced - -### Retries - -The SDK is instrumented with automatic retries with exponential backoff. A request will be retried as long -as the request is deemed retriable and the number of retry attempts has not grown larger than the configured -retry limit (default: 2). - -A request is deemed retriable when any of the following HTTP status codes is returned: - -- [408](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/408) (Timeout) -- [429](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/429) (Too Many Requests) -- [5XX](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/500) (Internal Server Errors) - -Use the `max_retries` request option to configure this behavior. - -```python -client.user.get_user({ - max_retries=1 -}) -``` - -### Timeouts - -The SDK defaults to a 60 second timeout. You can configure this with a timeout option at the client or request level. - -```python - -from seed import SeedVersion - -client = SeedVersion(..., { timeout=20.0 }, ) - - -# Override timeout for a specific method -client.user.get_user({ - timeout_in_seconds=1 -}) -``` - -### Custom Client - -You can override the `httpx` client to customize it for your use-case. Some common use-cases include support for proxies -and transports. -```python -import httpx -from seed import SeedVersion - -client = SeedVersion( - ..., - http_client=httpx.Client( - proxies="http://my.test.proxy.example.com", - transport=httpx.HTTPTransport(local_address="0.0.0.0"), - ), -) -``` - -## Contributing - -While we value open-source contributions to this SDK, this library is generated programmatically. -Additions made directly to this library would have to be moved over to our generation code, -otherwise they would be overwritten upon the next generated release. Feel free to open a PR as -a proof of concept, but know that we will not be able to merge it as-is. We suggest opening -an issue first to discuss with us! - -On the other hand, contributions to the README are always very welcome! diff --git a/seed/python-sdk/version/README.md b/seed/python-sdk/version/README.md index 36cedb3fd2d..e69de29bb2d 100644 --- a/seed/python-sdk/version/README.md +++ b/seed/python-sdk/version/README.md @@ -1,131 +0,0 @@ -# Seed Python Library - -[![fern shield](https://img.shields.io/badge/%F0%9F%8C%BF-SDK%20generated%20by%20Fern-brightgreen)](https://github.com/fern-api/fern) -[![pypi](https://img.shields.io/pypi/v/fern_version)](https://pypi.python.org/pypi/fern_version) - -The Seed Python library provides convenient access to the Seed API from Python. - -## Installation - -```sh -pip install fern_version -``` - -## Usage - -Instantiate and use the client with the following: - -```python -from seed import SeedVersion - -client = SeedVersion( - base_url="https://yourhost.com/path/to/api", -) -client.user.get_user( - user_id="string", -) -``` - -## Async Client - -The SDK also exports an `async` client so that you can make non-blocking calls to our API. - -```python -import asyncio - -from seed import AsyncSeedVersion - -client = AsyncSeedVersion( - base_url="https://yourhost.com/path/to/api", -) - - -async def main() -> None: - await client.user.get_user( - user_id="string", - ) - - -asyncio.run(main()) -``` - -## Exception Handling - -When the API returns a non-success status code (4xx or 5xx response), a subclass of the following error -will be thrown. - -```python -from seed.core.api_error import ApiError - -try: - client.user.get_user() -except ApiError as e: - print(e.status_code) - print(e.body) -``` - -## Advanced - -### Retries - -The SDK is instrumented with automatic retries with exponential backoff. A request will be retried as long -as the request is deemed retriable and the number of retry attempts has not grown larger than the configured -retry limit (default: 2). - -A request is deemed retriable when any of the following HTTP status codes is returned: - -- [408](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/408) (Timeout) -- [429](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/429) (Too Many Requests) -- [5XX](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/500) (Internal Server Errors) - -Use the `max_retries` request option to configure this behavior. - -```python -client.user.get_user({ - max_retries=1 -}) -``` - -### Timeouts - -The SDK defaults to a 60 second timeout. You can configure this with a timeout option at the client or request level. - -```python - -from seed import SeedVersion - -client = SeedVersion(..., { timeout=20.0 }, ) - - -# Override timeout for a specific method -client.user.get_user({ - timeout_in_seconds=1 -}) -``` - -### Custom Client - -You can override the `httpx` client to customize it for your use-case. Some common use-cases include support for proxies -and transports. -```python -import httpx -from seed import SeedVersion - -client = SeedVersion( - ..., - http_client=httpx.Client( - proxies="http://my.test.proxy.example.com", - transport=httpx.HTTPTransport(local_address="0.0.0.0"), - ), -) -``` - -## Contributing - -While we value open-source contributions to this SDK, this library is generated programmatically. -Additions made directly to this library would have to be moved over to our generation code, -otherwise they would be overwritten upon the next generated release. Feel free to open a PR as -a proof of concept, but know that we will not be able to merge it as-is. We suggest opening -an issue first to discuss with us! - -On the other hand, contributions to the README are always very welcome!