Skip to content

statuspro_public_api_client.helpers

statuspro_public_api_client.helpers

Ergonomic helper facades for the StatusPro API client.

These classes wrap the generated API with domain-specific methods that reduce boilerplate for common workflows. Each helper is accessed as an attribute on StatusProClient (e.g. client.orders.list(...)).

Example

async with StatusProClient() as client: ... orders = await client.orders.list(per_page=50) ... statuses = await client.statuses.list()

Classes

Base(client)

Base class for all domain classes.

Provides common functionality and access to the StatusProClient instance.

Parameters:

  • client (StatusProClient) –

    The StatusProClient instance to use for API calls.

Parameters:

  • client (StatusProClient) –

    The StatusProClient instance to use for API calls.

Source code in statuspro_public_api_client/helpers/base.py 
20
21
22
23
24
25
26
def __init__(self, client: StatusProClient) -> None:
    """Initialize with a client instance.

    Args:
        client: The StatusProClient instance to use for API calls.
    """
    self._client = client
Functions

Orders(client)

Bases: Base

Ergonomic order operations that return domain Order models.

Source code in statuspro_public_api_client/helpers/base.py 
20
21
22
23
24
25
26
def __init__(self, client: StatusProClient) -> None:
    """Initialize with a client instance.

    Args:
        client: The StatusProClient instance to use for API calls.
    """
    self._client = client
Functions
get(order_id) async

Get a single order by id.

Source code in statuspro_public_api_client/helpers/orders.py 
56
57
58
59
60
61
62
63
64
65
async def get(self, order_id: int) -> Order:
    """Get a single order by id."""
    from statuspro_public_api_client.api.orders import get_order
    from statuspro_public_api_client.domain import Order
    from statuspro_public_api_client.models.order_response import OrderResponse
    from statuspro_public_api_client.utils import unwrap_as

    response = await get_order.asyncio_detailed(client=self._client, order=order_id)
    raw = unwrap_as(response, OrderResponse)
    return Order.model_validate(raw.to_dict())
list(*, search=None, status_code=None, tags=None, tags_any=None, financial_status=None, fulfillment_status=None, exclude_cancelled=None, due_date_from=None, due_date_to=None, page=None, per_page=None) async

List orders. Auto-paginates when page is not set.

Source code in statuspro_public_api_client/helpers/orders.py 
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
async def list(
    self,
    *,
    search: str | None = None,
    status_code: str | None = None,
    tags: builtins.list[str] | None = None,
    tags_any: builtins.list[str] | None = None,
    financial_status: builtins.list[str] | None = None,
    fulfillment_status: builtins.list[str] | None = None,
    exclude_cancelled: bool | None = None,
    due_date_from: str | None = None,
    due_date_to: str | None = None,
    page: int | None = None,
    per_page: int | None = None,
) -> builtins.list[Order]:
    """List orders. Auto-paginates when ``page`` is not set."""
    from statuspro_public_api_client.api.orders import list_orders
    from statuspro_public_api_client.domain import Order
    from statuspro_public_api_client.utils import unwrap_data

    kwargs: dict[str, Any] = {
        "client": self._client,
        "search": search,
        "status_code": status_code,
        "tags": tags,
        "tags_any": tags_any,
        "financial_status": financial_status,
        "fulfillment_status": fulfillment_status,
        "exclude_cancelled": exclude_cancelled,
        "due_date_from": due_date_from,
        "due_date_to": due_date_to,
        "page": page,
        "per_page": per_page,
    }
    kwargs = {k: v for k, v in kwargs.items() if v is not None}
    response = await list_orders.asyncio_detailed(**kwargs)
    raw_orders = unwrap_data(response, default=[])
    return [Order.model_validate(o.to_dict()) for o in raw_orders]
lookup(*, number, email) async

Look up an order by order number and customer email.

Source code in statuspro_public_api_client/helpers/orders.py 
67
68
69
70
71
72
73
74
75
76
77
78
async def lookup(self, *, number: str, email: str) -> Order:
    """Look up an order by order number and customer email."""
    from statuspro_public_api_client.api.orders import lookup_order
    from statuspro_public_api_client.domain import Order
    from statuspro_public_api_client.models.order_response import OrderResponse
    from statuspro_public_api_client.utils import unwrap_as

    response = await lookup_order.asyncio_detailed(
        client=self._client, number=number, email=email
    )
    raw = unwrap_as(response, OrderResponse)
    return Order.model_validate(raw.to_dict())

Statuses(client)

Bases: Base

Ergonomic status catalog operations.

Source code in statuspro_public_api_client/helpers/base.py 
20
21
22
23
24
25
26
def __init__(self, client: StatusProClient) -> None:
    """Initialize with a client instance.

    Args:
        client: The StatusProClient instance to use for API calls.
    """
    self._client = client
Functions
list() async

Return the full status catalog (/statuses).

Source code in statuspro_public_api_client/helpers/statuses.py 
17
18
19
20
21
22
23
24
25
async def list(self) -> builtins.list[Status]:
    """Return the full status catalog (``/statuses``)."""
    from statuspro_public_api_client.api.statuses import get_statuses
    from statuspro_public_api_client.domain import Status
    from statuspro_public_api_client.utils import unwrap_data

    response = await get_statuses.asyncio_detailed(client=self._client)
    raw = unwrap_data(response, default=[])
    return [Status.model_validate(s.to_dict()) for s in raw]
viable_for(order_id) async

Return statuses that are valid transitions from the order's current state.

Source code in statuspro_public_api_client/helpers/statuses.py 
27
28
29
30
31
32
33
34
35
36
37
async def viable_for(self, order_id: int) -> builtins.list[Status]:
    """Return statuses that are valid transitions from the order's current state."""
    from statuspro_public_api_client.api.orders import get_viable_statuses
    from statuspro_public_api_client.domain import Status
    from statuspro_public_api_client.utils import unwrap_data

    response = await get_viable_statuses.asyncio_detailed(
        client=self._client, order=order_id
    )
    raw = unwrap_data(response, default=[])
    return [Status.model_validate(s.to_dict()) for s in raw]