postivo-client 0.0.5

POSTIVO.PL Hybrid Mail Services REST API Client SDK

POSTIVO.PL REST API Client SDK for Python (postivo-client)

This package provides the POSTIVO.PL Hybrid Mail Services SDK for Python, allowing you to dispatch shipments directly from your application via the POSTIVO.PL platform.

Additional documentation:

Comprehensive documentation of all methods and types is available below in Available Resources and Operations.

You can also refer to the REST API v1 documentation for additional details about this SDK.

Table of Contents

• POSTIVO.PL REST API Client SDK for Python (postivo-client)
  • Additional documentation:
  • SDK Installation
  • IDE Support
  • SDK Example Usage
  • Authentication
  • Available Resources and Operations
  • Retries
  • Error Handling
  • Server Selection
  • Custom HTTP Client
  • Resource Management
  • Debugging
• Development
  • Maturity
  • Contributions

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 postivo-client

PIP

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

pip install postivo-client

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 postivo-client

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 postivo-client 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.9"
# dependencies = [
#     "postivo-client",
# ]
# ///

from postivo_client import Client

sdk = Client(
  # 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.

• PyCharm Pydantic Plugin

SDK Example Usage

Sending Shipment to single recipient

This example demonstrates simple sending Shipment to a single recipient:

# Synchronous Example
from postivo_client import Client


with Client(
    bearer="<YOUR API ACCESS TOKEN>",
) as client:

    res = client.shipments.dispatch(recipients={
        "name": "Jan Nowak",
        "name2": "Firma testowa Sp. z o.o.",
        "address": "ul. Testowa",
        "home_number": "23",
        "flat_number": "2",
        "post_code": "00-999",
        "city": "Warszawa",
        "country": "PL",
        "phone_number": "[phone]",
        "postscript": "Komunikat",
        "custom_id": "1234567890",
    }, documents=[
        {
            "file_stream": "<document_1 content encoded to base64>",
            "file_name": "document1.pdf",
        },
        {
            "file_stream": "<document_2 content encoded to base64>",
            "file_name": "document2.pdf",
        },
    ], options={
        "predefined_config_id": 2670,
    })

    # Handle response
    print(res)

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

# Asynchronous Example
import asyncio
from postivo_client import Client

async def main():

    async with Client(
        bearer="<YOUR API ACCESS TOKEN>",
    ) as client:

        res = await client.shipments.dispatch_async(recipients={
            "name": "Jan Nowak",
            "name2": "Firma testowa Sp. z o.o.",
            "address": "ul. Testowa",
            "home_number": "23",
            "flat_number": "2",
            "post_code": "00-999",
            "city": "Warszawa",
            "country": "PL",
            "phone_number": "[phone]",
            "postscript": "Komunikat",
            "custom_id": "1234567890",
        }, documents=[
            {
                "file_stream": "<document_1 content encoded to base64>",
                "file_name": "document1.pdf",
            },
            {
                "file_stream": "<document_2 content encoded to base64>",
                "file_name": "document2.pdf",
            },
        ], options={
            "predefined_config_id": 2670,
        })

        # Handle response
        print(res)

asyncio.run(main())

Checking the price of a shipment for single recipient

This example demonstrates simple checking the price of a Shipment to a single recipient:

# Synchronous Example
from postivo_client import Client


with Client(
    bearer="<YOUR API ACCESS TOKEN>",
) as client:

    res = client.shipments.price(recipients={
        "name": "Jan Nowak",
        "name2": "Firma testowa Sp. z o.o.",
        "address": "ul. Testowa",
        "home_number": "23",
        "flat_number": "2",
        "post_code": "00-999",
        "city": "Warszawa",
        "country": "PL",
        "phone_number": "[phone]",
        "postscript": "Komunikat",
        "custom_id": "1234567890",
    }, documents=[
        {
            "file_stream": "<document_1 content encoded to base64>",
            "file_name": "document1.pdf",
        },
        {
            "file_stream": "<document_2 content encoded to base64>",
            "file_name": "document2.pdf",
        },
    ], options={
        "predefined_config_id": 2670,
    })

    # Handle response
    print(res)

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

# Asynchronous Example
import asyncio
from postivo_client import Client

async def main():

    async with Client(
        bearer="<YOUR API ACCESS TOKEN>",
    ) as client:

        res = await client.shipments.price_async(recipients={
            "name": "Jan Nowak",
            "name2": "Firma testowa Sp. z o.o.",
            "address": "ul. Testowa",
            "home_number": "23",
            "flat_number": "2",
            "post_code": "00-999",
            "city": "Warszawa",
            "country": "PL",
            "phone_number": "[phone]",
            "postscript": "Komunikat",
            "custom_id": "1234567890",
        }, documents=[
            {
                "file_stream": "<document_1 content encoded to base64>",
                "file_name": "document1.pdf",
            },
            {
                "file_stream": "<document_2 content encoded to base64>",
                "file_name": "document2.pdf",
            },
        ], options={
            "predefined_config_id": 2670,
        })

        # Handle response
        print(res)

asyncio.run(main())

Authentication

Per-Client Security Schemes

This SDK supports the following security scheme globally:

Name	Type	Scheme	Environment Variable
bearer	http	HTTP Bearer	CLIENT_BEARER

To authenticate with the API the bearer parameter must be set when initializing the SDK client instance. For example:

from postivo_client import Client


with Client(
    bearer="<YOUR API ACCESS TOKEN>",
) as client:

    res = client.accounts.get()

    # Handle response
    print(res)

Available Resources and Operations

Available methods

accounts

• get - Retrieve account details
• get_subaccount - Get subaccount details

address_book.contacts

• list - List contacts
• add - Add a new contact
• get - Retrieve contact details
• update - Update a contact
• delete - Delete a contact
• remove_from_group - Remove a contact from a group
• add_to_group - Add a contact to a group

address_book.contacts.by_ext_id

• get - Retrieve contact details by EXT_ID
• update - Update a contact by EXT_ID
• delete - Delete a contact by EXT_ID
• remove_from_group - Remove a contact from a group by EXT_ID
• add_to_group - Add a contact to a group by EXT_ID

address_book.groups

• list - List groups
• add - Add a new group
• get - Retrieve group details
• update - Update a group
• delete - Delete a group

common

• ping - Check API availability and version

metadata

• list - List metadata
• get_predefined_configs - List predefined configs

senders

• list - List senders
• add - Add a new sender
• delete - Delete a sender
• verify - Verify sender

shipments

• status - Retrieve shipment details with status events
• cancel - Cancel shipments
• dispatch - Dispatch a new shipment
• documents - Retrieve documents related to a shipment
• price - Check the shipment price

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 postivo_client import Client
from postivo_client.utils import BackoffStrategy, RetryConfig


with Client(
    bearer="<YOUR API ACCESS TOKEN>",
) as client:

    res = client.accounts.get(,
        RetryConfig("backoff", BackoffStrategy(1, 50, 1.1, 100), False))

    # Handle response
    print(res)

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 postivo_client import Client
from postivo_client.utils import BackoffStrategy, RetryConfig


with Client(
    retry_config=RetryConfig("backoff", BackoffStrategy(1, 50, 1.1, 100), False),
    bearer="<YOUR API ACCESS TOKEN>",
) as client:

    res = client.accounts.get()

    # Handle response
    print(res)

Error Handling

ClientError 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
err.data		Optional. Some errors may contain structured data. See Error Classes.

Example

from postivo_client import Client, errors


with Client(
    bearer="<YOUR API ACCESS TOKEN>",
) as client:
    res = None
    try:

        res = client.accounts.get()

        # Handle response
        print(res)


    except errors.ClientError 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)

        # Depending on the method different errors may be thrown
        if isinstance(e, errors.ErrorResponse):
            print(e.data.type)  # Optional[str]
            print(e.data.status)  # Optional[int]
            print(e.data.title)  # Optional[str]
            print(e.data.detail)  # Optional[str]
            print(e.data.code)  # Optional[str]

Error Classes

Primary errors:

• ClientError: The base class for HTTP error responses.
  • ErrorResponse: Problem Details object (RFC 9457) describing the error.

Less common errors (5)

Network errors:

• httpx.RequestError: Base class for request errors.
  • httpx.ConnectError: HTTP client was unable to make a request to a server.
  • httpx.TimeoutException: HTTP request timed out.

Inherit from ClientError:

• 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 Name

You can override the default server globally by passing a server name to the server: str 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 names associated with the available servers:

Name	Server	Description
prod	https://api.postivo.pl/rest/v1	Production system
sandbox	https://api.postivo.pl/rest-sandbox/v1	Test system (SANDBOX)

Example

from postivo_client import Client


with Client(
    server="sandbox",
    bearer="<YOUR API ACCESS TOKEN>",
) as client:

    res = client.accounts.get()

    # Handle response
    print(res)

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 postivo_client import Client


with Client(
    server_url="https://api.postivo.pl/rest/v1",
    bearer="<YOUR API ACCESS TOKEN>",
) as client:

    res = client.accounts.get()

    # Handle response
    print(res)

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 postivo_client import Client
import httpx

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

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

from postivo_client import Client
from postivo_client.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 = Client(async_client=CustomClient(httpx.AsyncClient()))

Resource Management

The Client 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 postivo_client import Client
def main():

    with Client(
        bearer="<YOUR API ACCESS TOKEN>",
    ) as client:
        # Rest of application here...


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

    async with Client(
        bearer="<YOUR API ACCESS TOKEN>",
    ) as client:
        # 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 postivo_client import Client
import logging

logging.basicConfig(level=logging.DEBUG)
s = Client(debug_logger=logging.getLogger("postivo_client"))

You can also enable a default debug logger by setting an environment variable CLIENT_DEBUG to true.

Development

Maturity

This SDK is in beta, and there may be breaking changes between versions without a major version update. Therefore, we recommend pinning usage to a specific package version. This way, you can install the same version each time without breaking changes unless you are intentionally looking for the latest version.

Contributions

While we value open-source contributions to this SDK, this library is generated programmatically. Any manual changes added to internal files will be overwritten on the next generation. We look forward to hearing your feedback. Feel free to open a PR or an issue with a proof of concept and we'll do our best to include it in a future release.