tolt 0.1.0__py3-none-any.whl

tolt/CONTRIBUTING.md

@@ -0,0 +1,125 @@
+# Contributing
+
+Thanks for your interest in contributing to this SDK! This document provides guidelines for contributing to the project.
+
+## Getting Started
+
+### Prerequisites
+
+- Python 3.9+
+- pip
+- poetry
+
+### Installation
+
+Install the project dependencies:
+
+```bash
+poetry install
+```
+
+### Building
+
+Build the project:
+
+```bash
+poetry build
+```
+
+### Testing
+
+Run the test suite:
+
+```bash
+poetry run pytest
+```
+
+### Linting and Formatting
+
+Check code style:
+
+```bash
+poetry run ruff check .
+poetry run ruff format .
+```
+
+### Type Checking
+
+Run the type checker:
+
+```bash
+poetry run mypy .
+```
+
+## About Generated Code
+
+**Important**: Most files in this SDK are automatically generated by [Fern](https://buildwithfern.com) from the API definition. Direct modifications to generated files will be overwritten the next time the SDK is generated.
+
+### Generated Files
+
+The following directories contain generated code:
+- `src/` - API client classes and types
+- Most Python files in the project
+
+### How to Customize
+
+If you need to customize the SDK, you have two options:
+
+#### Option 1: Use `.fernignore`
+
+For custom code that should persist across SDK regenerations:
+
+1. Create a `.fernignore` file in the project root
+2. Add file patterns for files you want to preserve (similar to `.gitignore` syntax)
+3. Add your custom code to those files
+
+Files listed in `.fernignore` will not be overwritten when the SDK is regenerated.
+
+For more information, see the [Fern documentation on custom code](https://buildwithfern.com/learn/sdks/overview/custom-code).
+
+#### Option 2: Contribute to the Generator
+
+If you want to change how code is generated for all users of this SDK:
+
+1. The Python SDK generator lives in the [Fern repository](https://github.com/fern-api/fern)
+2. Generator code is located at `generators/python-v2/`
+3. Follow the [Fern contributing guidelines](https://github.com/fern-api/fern/blob/main/CONTRIBUTING.md)
+4. Submit a pull request with your changes to the generator
+
+This approach is best for:
+- Bug fixes in generated code
+- New features that would benefit all users
+- Improvements to code generation patterns
+
+## Making Changes
+
+### Workflow
+
+1. Create a new branch for your changes
+2. Make your modifications
+3. Run tests to ensure nothing breaks: `poetry run pytest`
+4. Run linting and formatting: `poetry run ruff check .` and `poetry run ruff format .`
+5. Run type checking: `poetry run mypy .`
+6. Build the project: `poetry build`
+7. Commit your changes with a clear commit message
+8. Push your branch and create a pull request
+
+### Commit Messages
+
+Write clear, descriptive commit messages that explain what changed and why.
+
+### Code Style
+
+This project uses automated code formatting and linting. Run `poetry run ruff format .` and `poetry run ruff check .` before committing to ensure your code meets the project's style guidelines.
+
+## Questions or Issues?
+
+If you have questions or run into issues:
+
+1. Check the [Fern documentation](https://buildwithfern.com)
+2. Search existing [GitHub issues](https://github.com/fern-api/fern/issues)
+3. Open a new issue if your question hasn't been addressed
+
+## License
+
+By contributing to this project, you agree that your contributions will be licensed under the same license as the project.

tolt/README.md

@@ -0,0 +1,188 @@
+# Tolt Python Library
+
+[![fern shield](https://img.shields.io/badge/%F0%9F%8C%BF-Built%20with%20Fern-brightgreen)](https://buildwithfern.com?utm_source=github&utm_medium=github&utm_campaign=readme&utm_source=Tolt%2FPython)
+[![pypi](https://img.shields.io/pypi/v/tolt)](https://pypi.python.org/pypi/tolt)
+
+The Tolt Python library provides convenient access to the Tolt APIs from Python.
+
+## Table of Contents
+
+- [Installation](#installation)
+- [Reference](#reference)
+- [Usage](#usage)
+- [Environments](#environments)
+- [Async Client](#async-client)
+- [Exception Handling](#exception-handling)
+- [Advanced](#advanced)
+  - [Access Raw Response Data](#access-raw-response-data)
+  - [Retries](#retries)
+  - [Timeouts](#timeouts)
+  - [Custom Client](#custom-client)
+- [Contributing](#contributing)
+
+## Installation
+
+```sh
+pip install tolt
+```
+
+## Reference
+
+A full reference for this library is available [here](./reference.md).
+
+## Usage
+
+Instantiate and use the client with the following:
+
+```python
+from tolt import ToltApi
+
+client = ToltApi(
+    token="<token>",
+)
+
+client.partners.approve_partner(
+    id="id",
+)
+```
+
+## Environments
+
+This SDK allows you to configure different environments for API requests.
+
+```python
+from tolt import ToltApi
+from tolt.environment import ToltApiEnvironment
+
+client = ToltApi(
+    environment=ToltApiEnvironment.PRODUCTION,
+)
+```
+
+## Async Client
+
+The SDK also exports an `async` client so that you can make non-blocking calls to our API. Note that if you are constructing an Async httpx client class to pass into this client, use `httpx.AsyncClient()` instead of `httpx.Client()` (e.g. for the `httpx_client` parameter of this client).
+
+```python
+import asyncio
+
+from tolt import AsyncToltApi
+
+client = AsyncToltApi(
+    token="<token>",
+)
+
+
+async def main() -> None:
+    await client.partners.approve_partner(
+        id="id",
+    )
+
+
+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 tolt.core.api_error import ApiError
+
+try:
+    client.partners.approve_partner(...)
+except ApiError as e:
+    print(e.status_code)
+    print(e.body)
+```
+
+## Advanced
+
+### Access Raw Response Data
+
+The SDK provides access to raw response data, including headers, through the `.with_raw_response` property.
+The `.with_raw_response` property returns a "raw" client that can be used to access the `.headers` and `.data` attributes.
+
+```python
+from tolt import ToltApi
+
+client = ToltApi(...)
+response = client.partners.with_raw_response.approve_partner(...)
+print(response.headers)  # access the response headers
+print(response.status_code)  # access the response status code
+print(response.data)  # access the underlying object
+```
+
+### Retries
+
+The SDK is instrumented with automatic retries with exponential backoff. A request will be retried as long
+as the request is deemed retryable and the number of retry attempts has not grown larger than the configured
+retry limit (default: 2).
+
+Which status codes are retried depends on the `retryStatusCodes` generator configuration:
+
+**`legacy`** (current default): retries on
+- [408](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/408) (Timeout)
+- [409](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/409) (Conflict)
+- [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#server_error_responses) (All server errors, including 500)
+
+**`recommended`**: retries on
+- [408](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/408) (Timeout)
+- [409](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/409) (Conflict)
+- [429](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/429) (Too Many Requests)
+- [502](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/502) (Bad Gateway)
+- [503](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/503) (Service Unavailable)
+- [504](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/504) (Gateway Timeout)
+
+Use the `max_retries` request option to configure this behavior.
+
+```python
+client.partners.approve_partner(..., request_options={
+    "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 tolt import ToltApi
+
+client = ToltApi(..., timeout=20.0)
+
+# Override timeout for a specific method
+client.partners.approve_partner(..., request_options={
+    "timeout": 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 tolt import ToltApi
+
+client = ToltApi(
+    ...,
+    httpx_client=httpx.Client(
+        proxy="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!

tolt/__init__.py

@@ -0,0 +1,315 @@
+# This file was auto-generated by Fern from our API Definition.
+
+# isort: skip_file
+
+import typing
+from importlib import import_module
+
+if typing.TYPE_CHECKING:
+    from .types import (
+        Click,
+        Commission,
+        Customer,
+        Error,
+        Flow,
+        Group,
+        Link,
+        Partner,
+        Program,
+        PromotionCode,
+        ReportsOverview,
+        ReportsOverviewCommissionsItem,
+        ReportsOverviewRevenueItem,
+        RerunFlowsResult,
+        Transaction,
+    )
+    from .errors import BadRequestError, ConflictError, NotFoundError, UnauthorizedError
+    from . import (
+        clicks,
+        commissions,
+        customers,
+        flows,
+        groups,
+        links,
+        partners,
+        programs,
+        promotion_codes,
+        reports,
+        transactions,
+    )
+    from ._default_clients import DefaultAioHttpClient, DefaultAsyncHttpxClient
+    from .clicks import GetClickResponse, ListClicksRequestOrder, ListClicksResponse
+    from .client import AsyncToltApi, ToltApi
+    from .commissions import (
+        ApproveCommissionResponse,
+        CreateCommissionRequest,
+        CreateCommissionResponse,
+        DeclineCommissionResponse,
+        DeleteCommissionResponse,
+        GetCommissionResponse,
+        ListCommissionsRequestOrder,
+        ListCommissionsResponse,
+        UpdateCommissionResponse,
+    )
+    from .customers import (
+        CreateCustomerRequest,
+        CreateCustomerResponse,
+        DeleteCustomerResponse,
+        GetCustomerResponse,
+        ListCustomersRequestOrder,
+        ListCustomersResponse,
+        UpdateCustomerResponse,
+    )
+    from .environment import ToltApiEnvironment
+    from .flows import GetFlowResponse, ListFlowsRequestActive, ListFlowsRequestOrder, ListFlowsResponse
+    from .groups import GetGroupResponse, ListGroupsRequestDefault, ListGroupsRequestOrder, ListGroupsResponse
+    from .links import (
+        CreateLinkResponse,
+        DeleteLinkResponse,
+        GetLinkResponse,
+        ListLinksRequestOrder,
+        ListLinksResponse,
+        UpdateLinkResponse,
+    )
+    from .partners import (
+        ApprovePartnerResponse,
+        GetPartnerResponse,
+        ListPartnersRequestOrder,
+        ListPartnersRequestStatus,
+        ListPartnersResponse,
+        RejectPartnerResponse,
+        SuspendPartnerResponse,
+    )
+    from .programs import GetProgramResponse, ListProgramsRequestOrder, ListProgramsResponse
+    from .promotion_codes import (
+        CreatePromotionCodeResponse,
+        DeletePromotionCodeResponse,
+        GetPromotionCodeResponse,
+        ListPromotionCodesRequestOrder,
+        ListPromotionCodesResponse,
+        UpdatePromotionCodeResponse,
+    )
+    from .reports import ReportsOverviewResponse
+    from .transactions import (
+        CreateTransactionResponse,
+        DeleteTransactionResponse,
+        GetTransactionResponse,
+        ListTransactionsRequestOrder,
+        ListTransactionsResponse,
+        RefundTransactionResponse,
+        RerunTransactionFlowsResponse,
+        UpdateTransactionResponse,
+    )
+_dynamic_imports: typing.Dict[str, str] = {
+    "ApproveCommissionResponse": ".commissions",
+    "ApprovePartnerResponse": ".partners",
+    "AsyncToltApi": ".client",
+    "BadRequestError": ".errors",
+    "Click": ".types",
+    "Commission": ".types",
+    "ConflictError": ".errors",
+    "CreateCommissionRequest": ".commissions",
+    "CreateCommissionResponse": ".commissions",
+    "CreateCustomerRequest": ".customers",
+    "CreateCustomerResponse": ".customers",
+    "CreateLinkResponse": ".links",
+    "CreatePromotionCodeResponse": ".promotion_codes",
+    "CreateTransactionResponse": ".transactions",
+    "Customer": ".types",
+    "DeclineCommissionResponse": ".commissions",
+    "DefaultAioHttpClient": "._default_clients",
+    "DefaultAsyncHttpxClient": "._default_clients",
+    "DeleteCommissionResponse": ".commissions",
+    "DeleteCustomerResponse": ".customers",
+    "DeleteLinkResponse": ".links",
+    "DeletePromotionCodeResponse": ".promotion_codes",
+    "DeleteTransactionResponse": ".transactions",
+    "Error": ".types",
+    "Flow": ".types",
+    "GetClickResponse": ".clicks",
+    "GetCommissionResponse": ".commissions",
+    "GetCustomerResponse": ".customers",
+    "GetFlowResponse": ".flows",
+    "GetGroupResponse": ".groups",
+    "GetLinkResponse": ".links",
+    "GetPartnerResponse": ".partners",
+    "GetProgramResponse": ".programs",
+    "GetPromotionCodeResponse": ".promotion_codes",
+    "GetTransactionResponse": ".transactions",
+    "Group": ".types",
+    "Link": ".types",
+    "ListClicksRequestOrder": ".clicks",
+    "ListClicksResponse": ".clicks",
+    "ListCommissionsRequestOrder": ".commissions",
+    "ListCommissionsResponse": ".commissions",
+    "ListCustomersRequestOrder": ".customers",
+    "ListCustomersResponse": ".customers",
+    "ListFlowsRequestActive": ".flows",
+    "ListFlowsRequestOrder": ".flows",
+    "ListFlowsResponse": ".flows",
+    "ListGroupsRequestDefault": ".groups",
+    "ListGroupsRequestOrder": ".groups",
+    "ListGroupsResponse": ".groups",
+    "ListLinksRequestOrder": ".links",
+    "ListLinksResponse": ".links",
+    "ListPartnersRequestOrder": ".partners",
+    "ListPartnersRequestStatus": ".partners",
+    "ListPartnersResponse": ".partners",
+    "ListProgramsRequestOrder": ".programs",
+    "ListProgramsResponse": ".programs",
+    "ListPromotionCodesRequestOrder": ".promotion_codes",
+    "ListPromotionCodesResponse": ".promotion_codes",
+    "ListTransactionsRequestOrder": ".transactions",
+    "ListTransactionsResponse": ".transactions",
+    "NotFoundError": ".errors",
+    "Partner": ".types",
+    "Program": ".types",
+    "PromotionCode": ".types",
+    "RefundTransactionResponse": ".transactions",
+    "RejectPartnerResponse": ".partners",
+    "ReportsOverview": ".types",
+    "ReportsOverviewCommissionsItem": ".types",
+    "ReportsOverviewResponse": ".reports",
+    "ReportsOverviewRevenueItem": ".types",
+    "RerunFlowsResult": ".types",
+    "RerunTransactionFlowsResponse": ".transactions",
+    "SuspendPartnerResponse": ".partners",
+    "ToltApi": ".client",
+    "ToltApiEnvironment": ".environment",
+    "Transaction": ".types",
+    "UnauthorizedError": ".errors",
+    "UpdateCommissionResponse": ".commissions",
+    "UpdateCustomerResponse": ".customers",
+    "UpdateLinkResponse": ".links",
+    "UpdatePromotionCodeResponse": ".promotion_codes",
+    "UpdateTransactionResponse": ".transactions",
+    "clicks": ".clicks",
+    "commissions": ".commissions",
+    "customers": ".customers",
+    "flows": ".flows",
+    "groups": ".groups",
+    "links": ".links",
+    "partners": ".partners",
+    "programs": ".programs",
+    "promotion_codes": ".promotion_codes",
+    "reports": ".reports",
+    "transactions": ".transactions",
+}
+
+
+def __getattr__(attr_name: str) -> typing.Any:
+    module_name = _dynamic_imports.get(attr_name)
+    if module_name is None:
+        raise AttributeError(f"No {attr_name} found in _dynamic_imports for module name -> {__name__}")
+    try:
+        module = import_module(module_name, __package__)
+        if module_name == f".{attr_name}":
+            return module
+        else:
+            return getattr(module, attr_name)
+    except ImportError as e:
+        raise ImportError(f"Failed to import {attr_name} from {module_name}: {e}") from e
+    except AttributeError as e:
+        raise AttributeError(f"Failed to get {attr_name} from {module_name}: {e}") from e
+
+
+def __dir__():
+    lazy_attrs = list(_dynamic_imports.keys())
+    return sorted(lazy_attrs)
+
+
+__all__ = [
+    "ApproveCommissionResponse",
+    "ApprovePartnerResponse",
+    "AsyncToltApi",
+    "BadRequestError",
+    "Click",
+    "Commission",
+    "ConflictError",
+    "CreateCommissionRequest",
+    "CreateCommissionResponse",
+    "CreateCustomerRequest",
+    "CreateCustomerResponse",
+    "CreateLinkResponse",
+    "CreatePromotionCodeResponse",
+    "CreateTransactionResponse",
+    "Customer",
+    "DeclineCommissionResponse",
+    "DefaultAioHttpClient",
+    "DefaultAsyncHttpxClient",
+    "DeleteCommissionResponse",
+    "DeleteCustomerResponse",
+    "DeleteLinkResponse",
+    "DeletePromotionCodeResponse",
+    "DeleteTransactionResponse",
+    "Error",
+    "Flow",
+    "GetClickResponse",
+    "GetCommissionResponse",
+    "GetCustomerResponse",
+    "GetFlowResponse",
+    "GetGroupResponse",
+    "GetLinkResponse",
+    "GetPartnerResponse",
+    "GetProgramResponse",
+    "GetPromotionCodeResponse",
+    "GetTransactionResponse",
+    "Group",
+    "Link",
+    "ListClicksRequestOrder",
+    "ListClicksResponse",
+    "ListCommissionsRequestOrder",
+    "ListCommissionsResponse",
+    "ListCustomersRequestOrder",
+    "ListCustomersResponse",
+    "ListFlowsRequestActive",
+    "ListFlowsRequestOrder",
+    "ListFlowsResponse",
+    "ListGroupsRequestDefault",
+    "ListGroupsRequestOrder",
+    "ListGroupsResponse",
+    "ListLinksRequestOrder",
+    "ListLinksResponse",
+    "ListPartnersRequestOrder",
+    "ListPartnersRequestStatus",
+    "ListPartnersResponse",
+    "ListProgramsRequestOrder",
+    "ListProgramsResponse",
+    "ListPromotionCodesRequestOrder",
+    "ListPromotionCodesResponse",
+    "ListTransactionsRequestOrder",
+    "ListTransactionsResponse",
+    "NotFoundError",
+    "Partner",
+    "Program",
+    "PromotionCode",
+    "RefundTransactionResponse",
+    "RejectPartnerResponse",
+    "ReportsOverview",
+    "ReportsOverviewCommissionsItem",
+    "ReportsOverviewResponse",
+    "ReportsOverviewRevenueItem",
+    "RerunFlowsResult",
+    "RerunTransactionFlowsResponse",
+    "SuspendPartnerResponse",
+    "ToltApi",
+    "ToltApiEnvironment",
+    "Transaction",
+    "UnauthorizedError",
+    "UpdateCommissionResponse",
+    "UpdateCustomerResponse",
+    "UpdateLinkResponse",
+    "UpdatePromotionCodeResponse",
+    "UpdateTransactionResponse",
+    "clicks",
+    "commissions",
+    "customers",
+    "flows",
+    "groups",
+    "links",
+    "partners",
+    "programs",
+    "promotion_codes",
+    "reports",
+    "transactions",
+]

tolt/_default_clients.py

@@ -0,0 +1,30 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+import httpx
+
+SDK_DEFAULT_TIMEOUT = 60
+
+try:
+    import httpx_aiohttp  # type: ignore[import-not-found]
+except ImportError:
+
+    class DefaultAioHttpClient(httpx.AsyncClient):  # type: ignore
+        def __init__(self, **kwargs: typing.Any) -> None:
+            raise RuntimeError("To use the aiohttp client, install the aiohttp extra: pip install tolt[aiohttp]")
+
+else:
+
+    class DefaultAioHttpClient(httpx_aiohttp.HttpxAiohttpClient):  # type: ignore
+        def __init__(self, **kwargs: typing.Any) -> None:
+            kwargs.setdefault("timeout", SDK_DEFAULT_TIMEOUT)
+            kwargs.setdefault("follow_redirects", True)
+            super().__init__(**kwargs)
+
+
+class DefaultAsyncHttpxClient(httpx.AsyncClient):
+    def __init__(self, **kwargs: typing.Any) -> None:
+        kwargs.setdefault("timeout", SDK_DEFAULT_TIMEOUT)
+        kwargs.setdefault("follow_redirects", True)
+        super().__init__(**kwargs)

tolt/clicks/__init__.py

@@ -0,0 +1,38 @@
+# This file was auto-generated by Fern from our API Definition.
+
+# isort: skip_file
+
+import typing
+from importlib import import_module
+
+if typing.TYPE_CHECKING:
+    from .types import GetClickResponse, ListClicksRequestOrder, ListClicksResponse
+_dynamic_imports: typing.Dict[str, str] = {
+    "GetClickResponse": ".types",
+    "ListClicksRequestOrder": ".types",
+    "ListClicksResponse": ".types",
+}
+
+
+def __getattr__(attr_name: str) -> typing.Any:
+    module_name = _dynamic_imports.get(attr_name)
+    if module_name is None:
+        raise AttributeError(f"No {attr_name} found in _dynamic_imports for module name -> {__name__}")
+    try:
+        module = import_module(module_name, __package__)
+        if module_name == f".{attr_name}":
+            return module
+        else:
+            return getattr(module, attr_name)
+    except ImportError as e:
+        raise ImportError(f"Failed to import {attr_name} from {module_name}: {e}") from e
+    except AttributeError as e:
+        raise AttributeError(f"Failed to get {attr_name} from {module_name}: {e}") from e
+
+
+def __dir__():
+    lazy_attrs = list(_dynamic_imports.keys())
+    return sorted(lazy_attrs)
+
+
+__all__ = ["GetClickResponse", "ListClicksRequestOrder", "ListClicksResponse"]