WhatIfScenarios#

class fews_py_wrapper._api.endpoints.WhatIfScenarios[source]#
static endpoint_function(*, client, what_if_template_id=<fews_openapi_py_client.types.Unset object>, single_run_what_if=<fews_openapi_py_client.types.Unset object>, name=<fews_openapi_py_client.types.Unset object>, document_format=<fews_openapi_py_client.types.Unset object>, document_version=<fews_openapi_py_client.types.Unset object>)#

Add a whatif scenario, for now only properties can be added to the scenario

Add a whatif scenario, for now only properties can be added to the scenario

Parameters:

  • what_if_template_id (str | Unset) – Example: mywhatIfTemplateId.

  • single_run_what_if (PostWhatIfScenariosSingleRunWhatIf | Unset) – Example: singleRunWhatIf.

  • name (str | Unset) – Example: myName.

  • document_format (PostWhatIfScenariosDocumentFormat | Unset)

  • document_version (str | Unset)

  • client (AuthenticatedClient | Client)

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[Any]

Return type:

Response[Any]

execute(*, client, **kwargs)[source]#

Execute the API endpoint call.

Parameters:

  • client (AuthenticatedClient | Client) – AuthenticatedClient or Client instance for API calls.

  • document_format – Format of the returned document.

  • **kwargs (Any) – Keyword arguments for the API call.

Returns:

Parsed JSON response from the API.

Return type:

dict