statuspro_public_api_client.api.orders.bulk_update_order_status

statuspro_public_api_client.api.orders.bulk_update_order_status

Classes

Functions

asyncio(*, client, body) async

Queue a bulk status update for up to 50 orders

Limited to 5 requests per minute.

Parameters:

• body (BulkStatusUpdateRequest) –

Raises:

• UnexpectedStatus –

  If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.

• TimeoutException –

  If the request takes longer than Client.timeout.

Returns:

• BulkStatusUpdateResponse | ErrorResponse | ValidationErrorResponse | None –

  BulkStatusUpdateResponse | ErrorResponse | ValidationErrorResponse

Source code in statuspro_public_api_client/api/orders/bulk_update_order_status.py

async def asyncio(
    *,
    client: AuthenticatedClient | Client,
    body: BulkStatusUpdateRequest,
) -> BulkStatusUpdateResponse | ErrorResponse | ValidationErrorResponse | None:
    """Queue a bulk status update for up to 50 orders

     Limited to 5 requests per minute.

    Args:
        body (BulkStatusUpdateRequest):

    Raises:
        errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
        httpx.TimeoutException: If the request takes longer than Client.timeout.


    Returns:
        BulkStatusUpdateResponse | ErrorResponse | ValidationErrorResponse
    """

    return (
        await asyncio_detailed(
            client=client,
            body=body,
        )
    ).parsed

asyncio_detailed(*, client, body) async

Queue a bulk status update for up to 50 orders

Limited to 5 requests per minute.

Parameters:

• body (BulkStatusUpdateRequest) –

Raises:

• UnexpectedStatus –

  If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.

• TimeoutException –

  If the request takes longer than Client.timeout.

Returns:

• Response[BulkStatusUpdateResponse | ErrorResponse | ValidationErrorResponse] –

  Response[BulkStatusUpdateResponse | ErrorResponse | ValidationErrorResponse]

Source code in statuspro_public_api_client/api/orders/bulk_update_order_status.py

async def asyncio_detailed(
    *,
    client: AuthenticatedClient | Client,
    body: BulkStatusUpdateRequest,
) -> Response[BulkStatusUpdateResponse | ErrorResponse | ValidationErrorResponse]:
    """Queue a bulk status update for up to 50 orders

     Limited to 5 requests per minute.

    Args:
        body (BulkStatusUpdateRequest):

    Raises:
        errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
        httpx.TimeoutException: If the request takes longer than Client.timeout.


    Returns:
        Response[BulkStatusUpdateResponse | ErrorResponse | ValidationErrorResponse]
    """

    kwargs = _get_kwargs(
        body=body,
    )

    response = await client.get_async_httpx_client().request(**kwargs)

    return _build_response(client=client, response=response)

sync(*, client, body)

Queue a bulk status update for up to 50 orders

Limited to 5 requests per minute.

Parameters:

• body (BulkStatusUpdateRequest) –

Raises:

• UnexpectedStatus –

  If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.

• TimeoutException –

  If the request takes longer than Client.timeout.

Returns:

• BulkStatusUpdateResponse | ErrorResponse | ValidationErrorResponse | None –

  BulkStatusUpdateResponse | ErrorResponse | ValidationErrorResponse

Source code in statuspro_public_api_client/api/orders/bulk_update_order_status.py

def sync(
    *,
    client: AuthenticatedClient | Client,
    body: BulkStatusUpdateRequest,
) -> BulkStatusUpdateResponse | ErrorResponse | ValidationErrorResponse | None:
    """Queue a bulk status update for up to 50 orders

     Limited to 5 requests per minute.

    Args:
        body (BulkStatusUpdateRequest):

    Raises:
        errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
        httpx.TimeoutException: If the request takes longer than Client.timeout.


    Returns:
        BulkStatusUpdateResponse | ErrorResponse | ValidationErrorResponse
    """

    return sync_detailed(
        client=client,
        body=body,
    ).parsed

sync_detailed(*, client, body)

Queue a bulk status update for up to 50 orders

Limited to 5 requests per minute.

Parameters:

• body (BulkStatusUpdateRequest) –

Raises:

• UnexpectedStatus –

  If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.

• TimeoutException –

  If the request takes longer than Client.timeout.

Returns:

• Response[BulkStatusUpdateResponse | ErrorResponse | ValidationErrorResponse] –

  Response[BulkStatusUpdateResponse | ErrorResponse | ValidationErrorResponse]

Source code in statuspro_public_api_client/api/orders/bulk_update_order_status.py

def sync_detailed(
    *,
    client: AuthenticatedClient | Client,
    body: BulkStatusUpdateRequest,
) -> Response[BulkStatusUpdateResponse | ErrorResponse | ValidationErrorResponse]:
    """Queue a bulk status update for up to 50 orders

     Limited to 5 requests per minute.

    Args:
        body (BulkStatusUpdateRequest):

    Raises:
        errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
        httpx.TimeoutException: If the request takes longer than Client.timeout.


    Returns:
        Response[BulkStatusUpdateResponse | ErrorResponse | ValidationErrorResponse]
    """

    kwargs = _get_kwargs(
        body=body,
    )

    response = client.get_httpx_client().request(
        **kwargs,
    )

    return _build_response(client=client, response=response)