Python Client SDK for Unified.to

Navigation

Verified details

These details have been verified by PyPI
Maintainers
Avatar for unified from gravatar.com unified

Unverified details

These details have not been verified by PyPI
Project links
Meta
  • Author: Unified API Inc.
  • Requires: Python >=3.10
Classifiers
Report project as malware

Project description

Summary

Unified.to API: One API to Rule Them All

For more information about the API: API Documentation

Table of Contents

SDK Installation

[!NOTE] Python version upgrade policy

Once a Python version reaches its official end of life date, a 3-month grace period is provided for users to upgrade. Following this grace period, the minimum python version supported in the SDK will be updated.

The SDK can be installed with uv, pip, or poetry package managers.

uv

uv is a fast Python package installer and resolver, designed as a drop-in replacement for pip and pip-tools. It's recommended for its speed and modern Python tooling capabilities.

uv add Unified-python-sdk

PIP

PIP is the default package installer for Python, enabling easy installation and management of packages from PyPI via the command line.

pip install Unified-python-sdk

Poetry

Poetry is a modern tool that simplifies dependency management and package publishing by using a single pyproject.toml file to handle project metadata and dependencies.

poetry add Unified-python-sdk

Shell and script usage with uv

You can use this SDK in a Python shell with uv and the uvx command that comes with it like so:

uvx --from Unified-python-sdk python

It's also possible to write a standalone Python script without needing to set up a whole project like so:

#!/usr/bin/env -S uv run --script
# /// script
# requires-python = ">=3.10"
# dependencies = [
#     "Unified-python-sdk",
# ]
# ///

from unified_python_sdk import UnifiedTo

sdk = UnifiedTo(
  # SDK arguments
)

# Rest of script here...

Once that is saved to a file, you can run it with uv run script.py where script.py can be replaced with the actual file name.

IDE Support

PyCharm

Generally, the SDK will work well with most IDEs out of the box. However, when using PyCharm, you can enjoy much better integration with Pydantic by installing an additional plugin.

SDK Example Usage

Example

# Synchronous Example
from unified_python_sdk import UnifiedTo
from unified_python_sdk.models import shared


with UnifiedTo(
    security=shared.Security(
        jwt="<YOUR_API_KEY_HERE>",
    ),
) as unified_to:

    res = unified_to.accounting.create_accounting_account(request={
        "accounting_account": {},
        "connection_id": "<id>",
    })

    assert res.accounting_account is not None

    # Handle response
    print(res.accounting_account)

The same SDK client can also be used to make asynchronous requests by importing asyncio.

# Asynchronous Example
import asyncio
from unified_python_sdk import UnifiedTo
from unified_python_sdk.models import shared

async def main():

    async with UnifiedTo(
        security=shared.Security(
            jwt="<YOUR_API_KEY_HERE>",
        ),
    ) as unified_to:

        res = await unified_to.accounting.create_accounting_account_async(request={
            "accounting_account": {},
            "connection_id": "<id>",
        })

        assert res.accounting_account is not None

        # Handle response
        print(res.accounting_account)

asyncio.run(main())

Available Resources and Operations

Available methods

Account

Accounting

Activity

Ad

Ads

Apicall

Application

Applicationstatus

Assessment

Ats

Auth

Availability

Balancesheet

Bankaccount

Benefit

Bill

Branch

Busy

Calendar

Call

Campaign

Candidate

Carrier

Cashflow

Category

Change

Channel

Class

Collection

Comment

Commerce

Commit

Company

Connection

Contact

Content

Course

Creative

Creditmemo

Crm

Customer

Deal

Deduction

Device

Document

Embedding

Employee

Enrich

Environment

Event

Expense

File

Form

Forms

Genai

Group

Hris

Insertionorder

Instructor

Integration

Interview

Inventory

Invoice

Issue

Item

Itemvariant

Job

Journal

Kms

Label

Lead

Link

List

Lms

Location

Login

Martech

Member

Message

Messaging

Metadata

Model

Note

Order

Organization

Package

Page

Passthrough

Payment

Payout

Payslip

Person

Pipeline

Profitloss

Project

Promoted

Prompt

Pullrequest

Purchaseorder

Rate

Recording

Refund

Repo

Report

Repository

Request

Reservation

Review

Saleschannel

Salesorder

Scim

Scorecard

Shipment

Shipping

Space

Storage

Student

Submission

Subscription

Target

Task

Taxrate

Ticket

Ticketing

Timeoff

Timeshift

Tracking

Transaction

Trialbalance

Uc

Unified

User

Verification

Webhook

Webinar

File uploads

Certain SDK methods accept file objects as part of a request body or multi-part request. It is possible and typically recommended to upload files as a stream rather than reading the entire contents into memory. This avoids excessive memory consumption and potentially crashing with out-of-memory errors when working with very large files. The following example demonstrates how to attach a file stream to a request.

[!TIP]

For endpoints that handle file uploads bytes arrays can also be used. However, using streams is recommended for large files.

from unified_python_sdk import UnifiedTo
from unified_python_sdk.models import shared


with UnifiedTo(
    security=shared.Security(
        jwt="<YOUR_API_KEY_HERE>",
    ),
) as unified_to:

    res = unified_to.passthrough.create_passthrough_raw(request={
        "connection_id": "<id>",
        "path": "/var/log",
    })

    assert res.default_application_json_any is not None

    # Handle response
    print(res.default_application_json_any)

Retries

Some of the endpoints in this SDK support retries. If you use the SDK without any configuration, it will fall back to the default retry strategy provided by the API. However, the default retry strategy can be overridden on a per-operation basis, or across the entire SDK.

To change the default retry strategy for a single API call, simply provide a RetryConfig object to the call:

from unified_python_sdk import UnifiedTo
from unified_python_sdk.models import shared
from unified_python_sdk.utils import BackoffStrategy, RetryConfig


with UnifiedTo(
    security=shared.Security(
        jwt="<YOUR_API_KEY_HERE>",
    ),
) as unified_to:

    res = unified_to.accounting.create_accounting_account(request={
        "accounting_account": {},
        "connection_id": "<id>",
    },
        RetryConfig("backoff", BackoffStrategy(1, 50, 1.1, 100), False))

    assert res.accounting_account is not None

    # Handle response
    print(res.accounting_account)

If you'd like to override the default retry strategy for all operations that support retries, you can use the retry_config optional parameter when initializing the SDK:

from unified_python_sdk import UnifiedTo
from unified_python_sdk.models import shared
from unified_python_sdk.utils import BackoffStrategy, RetryConfig


with UnifiedTo(
    retry_config=RetryConfig("backoff", BackoffStrategy(1, 50, 1.1, 100), False),
    security=shared.Security(
        jwt="<YOUR_API_KEY_HERE>",
    ),
) as unified_to:

    res = unified_to.accounting.create_accounting_account(request={
        "accounting_account": {},
        "connection_id": "<id>",
    })

    assert res.accounting_account is not None

    # Handle response
    print(res.accounting_account)

Error Handling

UnifiedToError is the base class for all HTTP error responses. It has the following properties:

Property Type Description
err.message str Error message
err.status_code int HTTP response status code eg 404
err.headers httpx.Headers HTTP response headers
err.body str HTTP body. Can be empty string if no body is returned.
err.raw_response httpx.Response Raw HTTP response

Example

from unified_python_sdk import UnifiedTo
from unified_python_sdk.models import errors, shared


with UnifiedTo(
    security=shared.Security(
        jwt="<YOUR_API_KEY_HERE>",
    ),
) as unified_to:
    res = None
    try:

        res = unified_to.accounting.create_accounting_account(request={
            "accounting_account": {},
            "connection_id": "<id>",
        })

        assert res.accounting_account is not None

        # Handle response
        print(res.accounting_account)


    except errors.UnifiedToError as e:
        # The base class for HTTP error responses
        print(e.message)
        print(e.status_code)
        print(e.body)
        print(e.headers)
        print(e.raw_response)

Error Classes

Primary error:

Less common errors (5)

Network errors:

Inherit from UnifiedToError:

  • ResponseValidationError: Type mismatch between the response data and the expected Pydantic model. Provides access to the Pydantic validation error via the cause attribute.

Server Selection

Select Server by Index

You can override the default server globally by passing a server index to the server_idx: int optional parameter when initializing the SDK client instance. The selected server will then be used as the default on the operations that use it. This table lists the indexes associated with the available servers:

# Server Description
0 https://api.unified.to North American data region
1 https://api-eu.unified.to European data region
2 https://api-au.unified.to Australian data region

Example

from unified_python_sdk import UnifiedTo
from unified_python_sdk.models import shared


with UnifiedTo(
    server_idx=0,
    security=shared.Security(
        jwt="<YOUR_API_KEY_HERE>",
    ),
) as unified_to:

    res = unified_to.accounting.create_accounting_account(request={
        "accounting_account": {},
        "connection_id": "<id>",
    })

    assert res.accounting_account is not None

    # Handle response
    print(res.accounting_account)

Override Server URL Per-Client

The default server can also be overridden globally by passing a URL to the server_url: str optional parameter when initializing the SDK client instance. For example:

from unified_python_sdk import UnifiedTo
from unified_python_sdk.models import shared


with UnifiedTo(
    server_url="https://api-au.unified.to",
    security=shared.Security(
        jwt="<YOUR_API_KEY_HERE>",
    ),
) as unified_to:

    res = unified_to.accounting.create_accounting_account(request={
        "accounting_account": {},
        "connection_id": "<id>",
    })

    assert res.accounting_account is not None

    # Handle response
    print(res.accounting_account)

Custom HTTP Client

The Python SDK makes API calls using the httpx HTTP library. In order to provide a convenient way to configure timeouts, cookies, proxies, custom headers, and other low-level configuration, you can initialize the SDK client with your own HTTP client instance. Depending on whether you are using the sync or async version of the SDK, you can pass an instance of HttpClient or AsyncHttpClient respectively, which are Protocol's ensuring that the client has the necessary methods to make API calls. This allows you to wrap the client with your own custom logic, such as adding custom headers, logging, or error handling, or you can just pass an instance of httpx.Client or httpx.AsyncClient directly.

For example, you could specify a header for every request that this sdk makes as follows:

from unified_python_sdk import UnifiedTo
import httpx

http_client = httpx.Client(headers={"x-custom-header": "someValue"})
s = UnifiedTo(client=http_client)

or you could wrap the client with your own custom logic:

from unified_python_sdk import UnifiedTo
from unified_python_sdk.httpclient import AsyncHttpClient
import httpx

class CustomClient(AsyncHttpClient):
    client: AsyncHttpClient

    def __init__(self, client: AsyncHttpClient):
        self.client = client

    async def send(
        self,
        request: httpx.Request,
        *,
        stream: bool = False,
        auth: Union[
            httpx._types.AuthTypes, httpx._client.UseClientDefault, None
        ] = httpx.USE_CLIENT_DEFAULT,
        follow_redirects: Union[
            bool, httpx._client.UseClientDefault
        ] = httpx.USE_CLIENT_DEFAULT,
    ) -> httpx.Response:
        request.headers["Client-Level-Header"] = "added by client"

        return await self.client.send(
            request, stream=stream, auth=auth, follow_redirects=follow_redirects
        )

    def build_request(
        self,
        method: str,
        url: httpx._types.URLTypes,
        *,
        content: Optional[httpx._types.RequestContent] = None,
        data: Optional[httpx._types.RequestData] = None,
        files: Optional[httpx._types.RequestFiles] = None,
        json: Optional[Any] = None,
        params: Optional[httpx._types.QueryParamTypes] = None,
        headers: Optional[httpx._types.HeaderTypes] = None,
        cookies: Optional[httpx._types.CookieTypes] = None,
        timeout: Union[
            httpx._types.TimeoutTypes, httpx._client.UseClientDefault
        ] = httpx.USE_CLIENT_DEFAULT,
        extensions: Optional[httpx._types.RequestExtensions] = None,
    ) -> httpx.Request:
        return self.client.build_request(
            method,
            url,
            content=content,
            data=data,
            files=files,
            json=json,
            params=params,
            headers=headers,
            cookies=cookies,
            timeout=timeout,
            extensions=extensions,
        )

s = UnifiedTo(async_client=CustomClient(httpx.AsyncClient()))

Authentication

Per-Client Security Schemes

This SDK supports the following security scheme globally:

Name Type Scheme
jwt apiKey API key

You can set the security parameters through the security optional parameter when initializing the SDK client instance. For example:

from unified_python_sdk import UnifiedTo
from unified_python_sdk.models import shared


with UnifiedTo(
    security=shared.Security(
        jwt="<YOUR_API_KEY_HERE>",
    ),
) as unified_to:

    res = unified_to.accounting.create_accounting_account(request={
        "accounting_account": {},
        "connection_id": "<id>",
    })

    assert res.accounting_account is not None

    # Handle response
    print(res.accounting_account)

Resource Management

The UnifiedTo class implements the context manager protocol and registers a finalizer function to close the underlying sync and async HTTPX clients it uses under the hood. This will close HTTP connections, release memory and free up other resources held by the SDK. In short-lived Python programs and notebooks that make a few SDK method calls, resource management may not be a concern. However, in longer-lived programs, it is beneficial to create a single SDK instance via a context manager and reuse it across the application.

from unified_python_sdk import UnifiedTo
from unified_python_sdk.models import shared
def main():

    with UnifiedTo(
        security=shared.Security(
            jwt="<YOUR_API_KEY_HERE>",
        ),
    ) as unified_to:
        # Rest of application here...


# Or when using async:
async def amain():

    async with UnifiedTo(
        security=shared.Security(
            jwt="<YOUR_API_KEY_HERE>",
        ),
    ) as unified_to:
        # Rest of application here...

Debugging

You can setup your SDK to emit debug logs for SDK requests and responses.

You can pass your own logger class directly into your SDK.

from unified_python_sdk import UnifiedTo
import logging

logging.basicConfig(level=logging.DEBUG)
s = UnifiedTo(debug_logger=logging.getLogger("unified_python_sdk"))

Contributions

While we value open-source contributions to this SDK, this library is generated programmatically. Feel free to open a PR or a Github issue as a proof of concept and we'll do our best to include it in a future release!

SDK Created by Speakeasy

Project details

Verified details

These details have been verified by PyPI
Maintainers
Avatar for unified from gravatar.com unified

Unverified details

These details have not been verified by PyPI
Project links
Meta
  • Author: Unified API Inc.
  • Requires: Python >=3.10
Classifiers

Release history Release notifications | RSS feed

This version

0.57.29

0.57.28

0.57.27

0.57.26

0.57.25

0.57.24

0.57.23

0.57.22

0.57.21

0.57.20

0.57.19

0.57.18

0.57.17

0.57.16

0.57.15

0.57.14

0.57.13

0.57.11

0.57.10

0.57.9

0.57.8

0.57.7

0.57.6

0.57.5

0.57.4

0.57.3

0.57.2

0.57.1

0.57.0

0.56.26

0.56.25

0.56.24

0.56.23

0.56.22

0.56.21

0.56.20

0.56.19

0.56.18

0.56.17

0.56.16

0.56.15

0.56.14

0.56.13

0.56.12

0.56.11

0.56.10

0.56.9

0.56.8

0.56.7

0.56.6

0.56.5

0.56.4

0.56.3

0.56.2

0.56.1

0.56.0

0.55.1

0.55.0

0.54.18

0.54.17

0.54.16

0.54.15

0.54.14

0.54.13

0.54.12

0.54.11

0.54.9

0.54.7

0.54.5

0.54.3

0.54.2

0.54.1

0.54.0

0.53.3

0.53.2

0.53.1

0.53.0

0.52.3

0.52.2

0.52.1

0.52.0

0.51.2

0.51.1

0.51.0

0.50.0

0.49.8

0.49.7

0.49.6

0.49.5

0.49.4

0.49.3

0.49.2

0.49.1

0.49.0

0.48.16

0.48.15

0.48.14

0.48.13

0.48.12

0.48.11

0.48.10

0.48.9

0.48.8

0.48.7

0.48.6

0.48.5

0.48.4

0.48.3

0.48.2

0.48.1

0.48.0

0.47.6

0.47.5

0.47.4

0.47.3

0.47.2

0.47.1

0.47.0

0.46.3

0.46.2

0.46.1

0.46.0

0.45.1

0.45.0

0.44.1

0.44.0

0.43.1

0.43.0

0.42.3

0.42.2

0.42.1

0.42.0

0.41.1

0.41.0

0.40.11

0.40.10

0.40.9

0.40.8

0.40.7

0.40.6

0.40.5

0.40.4

0.40.3

0.40.2

0.40.1

0.40.0

0.39.1

0.38.1

0.37.1

0.36.1

0.35.1

0.34.1

0.33.1

0.32.1

0.31.1

0.30.1

0.29.18

0.29.16

0.29.14

0.29.12

0.29.10

0.29.8

0.29.6

0.29.4

0.29.2

0.29.1

0.29.0

0.28.6

0.28.4

0.28.3

0.28.2

0.28.1

0.28.0

0.27.0

0.26.7

0.26.6

0.26.5

0.26.4

0.26.3

0.26.2

0.26.1

0.26.0

0.25.3

0.25.2

0.25.1

0.25.0

0.24.10

0.24.9

0.24.8

0.24.7

0.24.6

0.24.5

0.24.4

0.24.3

0.24.2

0.24.1

0.24.0

0.23.24

0.23.23

0.23.22

0.23.21

0.23.20

0.23.19

0.23.18

0.23.17

0.23.16

0.23.15

0.23.14

0.23.13

0.23.12

0.23.11

0.23.10

0.23.9

0.23.8

0.23.7

0.23.6

0.23.5

0.23.4

0.23.3

0.23.2

0.23.1

0.23.0

0.22.33

0.22.32

0.22.31

0.22.30

0.22.29

0.22.28

0.22.27

0.22.26

0.22.25

0.22.24

0.22.23

0.22.22

0.22.21

0.22.20

0.22.19

0.22.18

0.22.17

0.22.16

0.22.15

0.22.14

0.22.13

0.22.12

0.22.11

0.22.10

0.22.9

0.22.8

0.22.7

0.22.6

0.22.5

0.22.4

0.22.3

0.22.2

0.22.1

0.22.0

0.21.11

0.21.10

0.21.9

0.21.8

0.21.7

0.21.6

0.21.5

0.21.4

0.21.3

0.21.2

0.21.1

0.21.0

0.20.6

0.20.5

0.20.4

0.20.3

0.20.2

0.20.1

0.20.0

0.19.2

0.19.1

0.19.0

0.18.1

0.18.0

0.17.1

0.17.0

0.16.11

0.16.10

0.16.9

0.16.8

0.16.7

0.16.6

0.16.5

0.16.4

0.16.3

0.16.2

0.16.1

0.16.0

0.15.0

0.14.38

0.14.36

0.14.35

0.14.34

0.14.33

0.14.32

0.14.31

0.14.30

0.14.29

0.14.28

0.14.27

0.14.26

0.14.25

0.14.24

0.14.23

0.14.22

0.14.21

0.14.20

0.14.19

0.14.18

0.14.17

0.14.16

0.14.15

0.14.14

0.14.13

0.14.12

0.14.11

0.14.10

0.14.9

0.14.8

0.14.7

0.14.6

0.14.5

0.14.4

0.14.3

0.14.2

0.14.1

0.14.0

0.13.16

0.13.15

0.13.14

0.13.13

0.13.12

0.13.11

0.13.10

0.13.9

0.13.8

0.13.7

0.13.6

0.13.5

0.13.4

0.13.3

0.13.2

0.13.1

0.13.0

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

unified_python_sdk-0.57.29.tar.gz (603.2 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

unified_python_sdk-0.57.29-py3-none-any.whl (1.8 MB view details)

Uploaded Python 3

File details

Details for the file unified_python_sdk-0.57.29.tar.gz.

File metadata

  • Download URL: unified_python_sdk-0.57.29.tar.gz
  • Upload date:
  • Size: 603.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/2.2.1 CPython/3.10.20 Linux/6.8.0-1044-azure

File hashes

Hashes for unified_python_sdk-0.57.29.tar.gz
Algorithm Hash digest
SHA256 906f0d19cdb0d4192ebd870d770452264815308df4372ccd5181d5125a6574ea
MD5 3fd52efb4492d2ef722cacb8345842be
BLAKE2b-256 d0556f3f279367498bcf098c3eddc3a94887351dd3c53e724f120fa8dbae1cfb

See more details on using hashes here.

File details

Details for the file unified_python_sdk-0.57.29-py3-none-any.whl.

File metadata

  • Download URL: unified_python_sdk-0.57.29-py3-none-any.whl
  • Upload date:
  • Size: 1.8 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/2.2.1 CPython/3.10.20 Linux/6.8.0-1044-azure

File hashes

Hashes for unified_python_sdk-0.57.29-py3-none-any.whl
Algorithm Hash digest
SHA256 ccf5f1c5437e38e7fb68dfcefad0ca5e3a6b4cd46ac9961934c400325bc85d42
MD5 edfe42ca24706edf4f199179d67e64d6
BLAKE2b-256 a777296c29a81e6db43df0378f4134526f63249e89b660e66a8505c7017f942e

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page