Skip to content

katana_public_api_client.api.demand_forecast.get_demand_forecasts

katana_public_api_client.api.demand_forecast.get_demand_forecasts

Classes

Functions

asyncio(*, client, variant_id, location_id) async

List planned demand forecast for variant in location

Returns planned forecasted demand for a variant in given location.

Parameters:

  • variant_id (int) –
  • location_id (int) –

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/demand_forecast/get_demand_forecasts.py 
174
175
176
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
async def asyncio(
    *,
    client: AuthenticatedClient | Client,
    variant_id: int,
    location_id: int,
) -> DemandForecastResponse | ErrorResponse | None:
    """List planned demand forecast for variant in location

     Returns planned forecasted demand for a variant in given location.

    Args:
        variant_id (int):
        location_id (int):

    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:
        DemandForecastResponse | ErrorResponse
    """

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

asyncio_detailed(*, client, variant_id, location_id) async

List planned demand forecast for variant in location

Returns planned forecasted demand for a variant in given location.

Parameters:

  • variant_id (int) –
  • location_id (int) –

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/demand_forecast/get_demand_forecasts.py 
141
142
143
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
async def asyncio_detailed(
    *,
    client: AuthenticatedClient | Client,
    variant_id: int,
    location_id: int,
) -> Response[DemandForecastResponse | ErrorResponse]:
    """List planned demand forecast for variant in location

     Returns planned forecasted demand for a variant in given location.

    Args:
        variant_id (int):
        location_id (int):

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

    kwargs = _get_kwargs(
        variant_id=variant_id,
        location_id=location_id,
    )

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

    return _build_response(client=client, response=response)

sync(*, client, variant_id, location_id)

List planned demand forecast for variant in location

Returns planned forecasted demand for a variant in given location.

Parameters:

  • variant_id (int) –
  • location_id (int) –

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/demand_forecast/get_demand_forecasts.py 
111
112
113
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
def sync(
    *,
    client: AuthenticatedClient | Client,
    variant_id: int,
    location_id: int,
) -> DemandForecastResponse | ErrorResponse | None:
    """List planned demand forecast for variant in location

     Returns planned forecasted demand for a variant in given location.

    Args:
        variant_id (int):
        location_id (int):

    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:
        DemandForecastResponse | ErrorResponse
    """

    return sync_detailed(
        client=client,
        variant_id=variant_id,
        location_id=location_id,
    ).parsed

sync_detailed(*, client, variant_id, location_id)

List planned demand forecast for variant in location

Returns planned forecasted demand for a variant in given location.

Parameters:

  • variant_id (int) –
  • location_id (int) –

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/demand_forecast/get_demand_forecasts.py 
 76
 77
 78
 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
def sync_detailed(
    *,
    client: AuthenticatedClient | Client,
    variant_id: int,
    location_id: int,
) -> Response[DemandForecastResponse | ErrorResponse]:
    """List planned demand forecast for variant in location

     Returns planned forecasted demand for a variant in given location.

    Args:
        variant_id (int):
        location_id (int):

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

    kwargs = _get_kwargs(
        variant_id=variant_id,
        location_id=location_id,
    )

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

    return _build_response(client=client, response=response)