Skip to content

katana_public_api_client.api.supplier_address.create_supplier_address

katana_public_api_client.api.supplier_address.create_supplier_address

Classes

Functions

asyncio(*, client, body) async

Create a supplier address

Add an address to an existing supplier. If the new address is the first one, it is assigned as the default. (A Supplier can have only one address for now)

Parameters:

  • body (CreateSupplierAddressRequest) –

    Request payload for creating a new address for an existing supplier Example: {'supplier_id': 4001, 'line_1': '856 Distribution Center Dr', 'line_2': None, 'city': 'Milwaukee', 'state': 'WI', 'zip': '53218', 'country': 'US'}.

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_address/create_supplier_address.py 
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
async def asyncio(
    *,
    client: AuthenticatedClient | Client,
    body: CreateSupplierAddressRequest,
) -> DetailedErrorResponse | ErrorResponse | SupplierAddress | None:
    """Create a supplier address

     Add an address to an existing supplier. If the new address is the first one, it is assigned as
      the default. (A Supplier can have only one address for now)

    Args:
        body (CreateSupplierAddressRequest): Request payload for creating a new address for an
            existing supplier Example: {'supplier_id': 4001, 'line_1': '856 Distribution Center Dr',
            'line_2': None, 'city': 'Milwaukee', 'state': 'WI', 'zip': '53218', 'country': 'US'}.

    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, SupplierAddress]
    """

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

asyncio_detailed(*, client, body) async

Create a supplier address

Add an address to an existing supplier. If the new address is the first one, it is assigned as the default. (A Supplier can have only one address for now)

Parameters:

  • body (CreateSupplierAddressRequest) –

    Request payload for creating a new address for an existing supplier Example: {'supplier_id': 4001, 'line_1': '856 Distribution Center Dr', 'line_2': None, 'city': 'Milwaukee', 'state': 'WI', 'zip': '53218', 'country': 'US'}.

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_address/create_supplier_address.py 
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
async def asyncio_detailed(
    *,
    client: AuthenticatedClient | Client,
    body: CreateSupplierAddressRequest,
) -> Response[DetailedErrorResponse | ErrorResponse | SupplierAddress]:
    """Create a supplier address

     Add an address to an existing supplier. If the new address is the first one, it is assigned as
      the default. (A Supplier can have only one address for now)

    Args:
        body (CreateSupplierAddressRequest): Request payload for creating a new address for an
            existing supplier Example: {'supplier_id': 4001, 'line_1': '856 Distribution Center Dr',
            'line_2': None, 'city': 'Milwaukee', 'state': 'WI', 'zip': '53218', 'country': 'US'}.

    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, SupplierAddress]]
    """

    kwargs = _get_kwargs(
        body=body,
    )

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

    return _build_response(client=client, response=response)

sync(*, client, body)

Create a supplier address

Add an address to an existing supplier. If the new address is the first one, it is assigned as the default. (A Supplier can have only one address for now)

Parameters:

  • body (CreateSupplierAddressRequest) –

    Request payload for creating a new address for an existing supplier Example: {'supplier_id': 4001, 'line_1': '856 Distribution Center Dr', 'line_2': None, 'city': 'Milwaukee', 'state': 'WI', 'zip': '53218', 'country': 'US'}.

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_address/create_supplier_address.py 
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
def sync(
    *,
    client: AuthenticatedClient | Client,
    body: CreateSupplierAddressRequest,
) -> DetailedErrorResponse | ErrorResponse | SupplierAddress | None:
    """Create a supplier address

     Add an address to an existing supplier. If the new address is the first one, it is assigned as
      the default. (A Supplier can have only one address for now)

    Args:
        body (CreateSupplierAddressRequest): Request payload for creating a new address for an
            existing supplier Example: {'supplier_id': 4001, 'line_1': '856 Distribution Center Dr',
            'line_2': None, 'city': 'Milwaukee', 'state': 'WI', 'zip': '53218', 'country': 'US'}.

    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, SupplierAddress]
    """

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

sync_detailed(*, client, body)

Create a supplier address

Add an address to an existing supplier. If the new address is the first one, it is assigned as the default. (A Supplier can have only one address for now)

Parameters:

  • body (CreateSupplierAddressRequest) –

    Request payload for creating a new address for an existing supplier Example: {'supplier_id': 4001, 'line_1': '856 Distribution Center Dr', 'line_2': None, 'city': 'Milwaukee', 'state': 'WI', 'zip': '53218', 'country': 'US'}.

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_address/create_supplier_address.py 
 79
 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
def sync_detailed(
    *,
    client: AuthenticatedClient | Client,
    body: CreateSupplierAddressRequest,
) -> Response[DetailedErrorResponse | ErrorResponse | SupplierAddress]:
    """Create a supplier address

     Add an address to an existing supplier. If the new address is the first one, it is assigned as
      the default. (A Supplier can have only one address for now)

    Args:
        body (CreateSupplierAddressRequest): Request payload for creating a new address for an
            existing supplier Example: {'supplier_id': 4001, 'line_1': '856 Distribution Center Dr',
            'line_2': None, 'city': 'Milwaukee', 'state': 'WI', 'zip': '53218', 'country': 'US'}.

    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, SupplierAddress]]
    """

    kwargs = _get_kwargs(
        body=body,
    )

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

    return _build_response(client=client, response=response)