Skip to content

katana_public_api_client.api.customer_address.update_customer_address

katana_public_api_client.api.customer_address.update_customer_address

Classes

Functions

asyncio(id, *, client, body) async

Update a customer address

Updates a customer address.

Parameters:

  • id (int) –
  • body (UpdateCustomerAddressBody) –

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/customer_address/update_customer_address.py
async def asyncio(
    id: int,
    *,
    client: AuthenticatedClient | Client,
    body: UpdateCustomerAddressBody,
) -> Any | ErrorResponse | None:
    """Update a customer address

     Updates a customer address.

    Args:
        id (int):
        body (UpdateCustomerAddressBody):

    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[Any, ErrorResponse]
    """

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

asyncio_detailed(id, *, client, body) async

Update a customer address

Updates a customer address.

Parameters:

  • id (int) –
  • body (UpdateCustomerAddressBody) –

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/customer_address/update_customer_address.py
async def asyncio_detailed(
    id: int,
    *,
    client: AuthenticatedClient | Client,
    body: UpdateCustomerAddressBody,
) -> Response[Any | ErrorResponse]:
    """Update a customer address

     Updates a customer address.

    Args:
        id (int):
        body (UpdateCustomerAddressBody):

    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[Any, ErrorResponse]]
    """

    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 customer address

Updates a customer address.

Parameters:

  • id (int) –
  • body (UpdateCustomerAddressBody) –

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/customer_address/update_customer_address.py
def sync(
    id: int,
    *,
    client: AuthenticatedClient | Client,
    body: UpdateCustomerAddressBody,
) -> Any | ErrorResponse | None:
    """Update a customer address

     Updates a customer address.

    Args:
        id (int):
        body (UpdateCustomerAddressBody):

    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[Any, ErrorResponse]
    """

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

sync_detailed(id, *, client, body)

Update a customer address

Updates a customer address.

Parameters:

  • id (int) –
  • body (UpdateCustomerAddressBody) –

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/customer_address/update_customer_address.py
def sync_detailed(
    id: int,
    *,
    client: AuthenticatedClient | Client,
    body: UpdateCustomerAddressBody,
) -> Response[Any | ErrorResponse]:
    """Update a customer address

     Updates a customer address.

    Args:
        id (int):
        body (UpdateCustomerAddressBody):

    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[Any, ErrorResponse]]
    """

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

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

    return _build_response(client=client, response=response)