Skip to content

statuspro_public_api_client.api.orders.add_order_comment

statuspro_public_api_client.api.orders.add_order_comment

Classes

Functions

asyncio(order, *, client, body) async

Add a comment to the order

Limited to 60 requests per minute.

Parameters:

  • order (int) –
  • body (AddOrderCommentRequest) –

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 | MessageResponse | ValidationErrorResponse | None –

    ErrorResponse | MessageResponse | ValidationErrorResponse

Source code in statuspro_public_api_client/api/orders/add_order_comment.py 
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
async def asyncio(
    order: int,
    *,
    client: AuthenticatedClient | Client,
    body: AddOrderCommentRequest,
) -> ErrorResponse | MessageResponse | ValidationErrorResponse | None:
    """Add a comment to the order

     Limited to 60 requests per minute.

    Args:
        order (int):
        body (AddOrderCommentRequest):

    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 | MessageResponse | ValidationErrorResponse
    """

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

asyncio_detailed(order, *, client, body) async

Add a comment to the order

Limited to 60 requests per minute.

Parameters:

  • order (int) –
  • body (AddOrderCommentRequest) –

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 | MessageResponse | ValidationErrorResponse] –

    Response[ErrorResponse | MessageResponse | ValidationErrorResponse]

Source code in statuspro_public_api_client/api/orders/add_order_comment.py 
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
async def asyncio_detailed(
    order: int,
    *,
    client: AuthenticatedClient | Client,
    body: AddOrderCommentRequest,
) -> Response[ErrorResponse | MessageResponse | ValidationErrorResponse]:
    """Add a comment to the order

     Limited to 60 requests per minute.

    Args:
        order (int):
        body (AddOrderCommentRequest):

    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 | MessageResponse | ValidationErrorResponse]
    """

    kwargs = _get_kwargs(
        order=order,
        body=body,
    )

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

    return _build_response(client=client, response=response)

sync(order, *, client, body)

Add a comment to the order

Limited to 60 requests per minute.

Parameters:

  • order (int) –
  • body (AddOrderCommentRequest) –

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 | MessageResponse | ValidationErrorResponse | None –

    ErrorResponse | MessageResponse | ValidationErrorResponse

Source code in statuspro_public_api_client/api/orders/add_order_comment.py 
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
def sync(
    order: int,
    *,
    client: AuthenticatedClient | Client,
    body: AddOrderCommentRequest,
) -> ErrorResponse | MessageResponse | ValidationErrorResponse | None:
    """Add a comment to the order

     Limited to 60 requests per minute.

    Args:
        order (int):
        body (AddOrderCommentRequest):

    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 | MessageResponse | ValidationErrorResponse
    """

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

sync_detailed(order, *, client, body)

Add a comment to the order

Limited to 60 requests per minute.

Parameters:

  • order (int) –
  • body (AddOrderCommentRequest) –

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 | MessageResponse | ValidationErrorResponse] –

    Response[ErrorResponse | MessageResponse | ValidationErrorResponse]

Source code in statuspro_public_api_client/api/orders/add_order_comment.py 
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
def sync_detailed(
    order: int,
    *,
    client: AuthenticatedClient | Client,
    body: AddOrderCommentRequest,
) -> Response[ErrorResponse | MessageResponse | ValidationErrorResponse]:
    """Add a comment to the order

     Limited to 60 requests per minute.

    Args:
        order (int):
        body (AddOrderCommentRequest):

    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 | MessageResponse | ValidationErrorResponse]
    """

    kwargs = _get_kwargs(
        order=order,
        body=body,
    )

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

    return _build_response(client=client, response=response)