Skip to content

katana_public_api_client.api.supplier.update_supplier

katana_public_api_client.api.supplier.update_supplier

Classes

Functions

asyncio(id, *, client, body) async

Update a supplier

Updates the specified supplier by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

Parameters:

  • id (int) –
  • body (UpdateSupplierRequest) –

    Request payload for updating an existing supplier's contact information and details Example: {'name': 'Premium Kitchen Supplies Ltd', 'email': 'orders@premiumkitchen.com', 'phone': '+1-555-0134', 'currency': 'USD', 'comment': 'Primary supplier for kitchen equipment and utensils. Excellent customer service.'}.

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:

Source code in katana_public_api_client/api/supplier/update_supplier.py 
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
216
217
218
219
220
221
222
223
async def asyncio(
    id: int,
    *,
    client: AuthenticatedClient | Client,
    body: UpdateSupplierRequest,
) -> DetailedErrorResponse | ErrorResponse | Supplier | None:
    """Update a supplier

     Updates the specified supplier by setting the values of the parameters passed.
        Any parameters not provided will be left unchanged.

    Args:
        id (int):
        body (UpdateSupplierRequest): Request payload for updating an existing supplier's contact
            information and details Example: {'name': 'Premium Kitchen Supplies Ltd', 'email':
            'orders@premiumkitchen.com', 'phone': '+1-555-0134', 'currency': 'USD', 'comment':
            'Primary supplier for kitchen equipment and utensils. Excellent customer service.'}.

    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:
        Union[DetailedErrorResponse, ErrorResponse, Supplier]
    """

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

asyncio_detailed(id, *, client, body) async

Update a supplier

Updates the specified supplier by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

Parameters:

  • id (int) –
  • body (UpdateSupplierRequest) –

    Request payload for updating an existing supplier's contact information and details Example: {'name': 'Premium Kitchen Supplies Ltd', 'email': 'orders@premiumkitchen.com', 'phone': '+1-555-0134', 'currency': 'USD', 'comment': 'Primary supplier for kitchen equipment and utensils. Excellent customer service.'}.

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:

Source code in katana_public_api_client/api/supplier/update_supplier.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
184
185
186
187
async def asyncio_detailed(
    id: int,
    *,
    client: AuthenticatedClient | Client,
    body: UpdateSupplierRequest,
) -> Response[DetailedErrorResponse | ErrorResponse | Supplier]:
    """Update a supplier

     Updates the specified supplier by setting the values of the parameters passed.
        Any parameters not provided will be left unchanged.

    Args:
        id (int):
        body (UpdateSupplierRequest): Request payload for updating an existing supplier's contact
            information and details Example: {'name': 'Premium Kitchen Supplies Ltd', 'email':
            'orders@premiumkitchen.com', 'phone': '+1-555-0134', 'currency': 'USD', 'comment':
            'Primary supplier for kitchen equipment and utensils. Excellent customer service.'}.

    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[Union[DetailedErrorResponse, ErrorResponse, Supplier]]
    """

    kwargs = _get_kwargs(
        id=id,
        body=body,
    )

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

    return _build_response(client=client, response=response)

sync(id, *, client, body)

Update a supplier

Updates the specified supplier by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

Parameters:

  • id (int) –
  • body (UpdateSupplierRequest) –

    Request payload for updating an existing supplier's contact information and details Example: {'name': 'Premium Kitchen Supplies Ltd', 'email': 'orders@premiumkitchen.com', 'phone': '+1-555-0134', 'currency': 'USD', 'comment': 'Primary supplier for kitchen equipment and utensils. Excellent customer service.'}.

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:

Source code in katana_public_api_client/api/supplier/update_supplier.py 
119
120
121
122
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(
    id: int,
    *,
    client: AuthenticatedClient | Client,
    body: UpdateSupplierRequest,
) -> DetailedErrorResponse | ErrorResponse | Supplier | None:
    """Update a supplier

     Updates the specified supplier by setting the values of the parameters passed.
        Any parameters not provided will be left unchanged.

    Args:
        id (int):
        body (UpdateSupplierRequest): Request payload for updating an existing supplier's contact
            information and details Example: {'name': 'Premium Kitchen Supplies Ltd', 'email':
            'orders@premiumkitchen.com', 'phone': '+1-555-0134', 'currency': 'USD', 'comment':
            'Primary supplier for kitchen equipment and utensils. Excellent customer service.'}.

    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:
        Union[DetailedErrorResponse, ErrorResponse, Supplier]
    """

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

sync_detailed(id, *, client, body)

Update a supplier

Updates the specified supplier by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

Parameters:

  • id (int) –
  • body (UpdateSupplierRequest) –

    Request payload for updating an existing supplier's contact information and details Example: {'name': 'Premium Kitchen Supplies Ltd', 'email': 'orders@premiumkitchen.com', 'phone': '+1-555-0134', 'currency': 'USD', 'comment': 'Primary supplier for kitchen equipment and utensils. Excellent customer service.'}.

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:

Source code in katana_public_api_client/api/supplier/update_supplier.py 
 80
 81
 82
 83
 84
 85
 86
 87
 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
def sync_detailed(
    id: int,
    *,
    client: AuthenticatedClient | Client,
    body: UpdateSupplierRequest,
) -> Response[DetailedErrorResponse | ErrorResponse | Supplier]:
    """Update a supplier

     Updates the specified supplier by setting the values of the parameters passed.
        Any parameters not provided will be left unchanged.

    Args:
        id (int):
        body (UpdateSupplierRequest): Request payload for updating an existing supplier's contact
            information and details Example: {'name': 'Premium Kitchen Supplies Ltd', 'email':
            'orders@premiumkitchen.com', 'phone': '+1-555-0134', 'currency': 'USD', 'comment':
            'Primary supplier for kitchen equipment and utensils. Excellent customer service.'}.

    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[Union[DetailedErrorResponse, ErrorResponse, Supplier]]
    """

    kwargs = _get_kwargs(
        id=id,
        body=body,
    )

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

    return _build_response(client=client, response=response)