Skip to content

statuspro_public_api_client.api.statuses.get_statuses

statuspro_public_api_client.api.statuses.get_statuses

Classes

Functions

asyncio(*, client) async

Get all defined statuses for your account

Limited to 60 requests per minute.

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:

  • ErrorResponse | list[StatusDefinition] | None –

    ErrorResponse | list[StatusDefinition]

Source code in statuspro_public_api_client/api/statuses/get_statuses.py 
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
async def asyncio(
    *,
    client: AuthenticatedClient | Client,
) -> ErrorResponse | list[StatusDefinition] | None:
    """Get all defined statuses for your account

     Limited to 60 requests per minute.

    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:
        ErrorResponse | list[StatusDefinition]
    """

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

asyncio_detailed(*, client) async

Get all defined statuses for your account

Limited to 60 requests per minute.

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[ErrorResponse | list[StatusDefinition]] –

    Response[ErrorResponse | list[StatusDefinition]]

Source code in statuspro_public_api_client/api/statuses/get_statuses.py 
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
async def asyncio_detailed(
    *,
    client: AuthenticatedClient | Client,
) -> Response[ErrorResponse | list[StatusDefinition]]:
    """Get all defined statuses for your account

     Limited to 60 requests per minute.

    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[ErrorResponse | list[StatusDefinition]]
    """

    kwargs = _get_kwargs()

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

    return _build_response(client=client, response=response)

sync(*, client)

Get all defined statuses for your account

Limited to 60 requests per minute.

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:

  • ErrorResponse | list[StatusDefinition] | None –

    ErrorResponse | list[StatusDefinition]

Source code in statuspro_public_api_client/api/statuses/get_statuses.py 
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
def sync(
    *,
    client: AuthenticatedClient | Client,
) -> ErrorResponse | list[StatusDefinition] | None:
    """Get all defined statuses for your account

     Limited to 60 requests per minute.

    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:
        ErrorResponse | list[StatusDefinition]
    """

    return sync_detailed(
        client=client,
    ).parsed

sync_detailed(*, client)

Get all defined statuses for your account

Limited to 60 requests per minute.

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[ErrorResponse | list[StatusDefinition]] –

    Response[ErrorResponse | list[StatusDefinition]]

Source code in statuspro_public_api_client/api/statuses/get_statuses.py 
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
def sync_detailed(
    *,
    client: AuthenticatedClient | Client,
) -> Response[ErrorResponse | list[StatusDefinition]]:
    """Get all defined statuses for your account

     Limited to 60 requests per minute.

    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[ErrorResponse | list[StatusDefinition]]
    """

    kwargs = _get_kwargs()

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

    return _build_response(client=client, response=response)