Data API — Deliveries
deliveries_get
sync(client: AuthenticatedClient | Client, states: str | Unset = UNSET, subscriber_id: UUID | Unset = UNSET, event_id: UUID | Unset = UNSET, page: int | Unset = UNSET, page_size: int | Unset = UNSET) -> ProblemDetails | list[DeliveryResponse] | list[ErrorResponse] | NoneParameter | Type | Default |
|---|---|---|
client | AuthenticatedClient | Client | required |
states | str | Unset | UNSET |
subscriber_id | UUID | Unset | UNSET |
event_id | UUID | Unset | UNSET |
page | int | Unset | UNSET |
page_size | int | Unset | UNSET |
Returns: ProblemDetails | list[DeliveryResponse] | list[ErrorResponse] | None
Raises:
Exception | Condition |
|---|---|
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. |
deliveries_purge
sync(client: AuthenticatedClient | Client) -> Any | ProblemDetails | list[ErrorResponse] | NoneParameter | Type | Default |
|---|---|---|
client | AuthenticatedClient | Client | required |
Returns: Any | ProblemDetails | list[ErrorResponse] | None
Raises:
Exception | Condition |
|---|---|
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. |
delivery_cancel
sync(client: AuthenticatedClient | Client, delivery_id: UUID | Unset = UNSET) -> DeliveryResponse | ProblemDetails | list[ErrorResponse] | NoneParameter | Type | Default |
|---|---|---|
client | AuthenticatedClient | Client | required |
delivery_id | UUID | Unset | UNSET |
Returns: DeliveryResponse | ProblemDetails | list[ErrorResponse] | None
Raises:
Exception | Condition |
|---|---|
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. |