Conversion technologies¶
Operations on conversion technologies. Available on the client as client.conversion_technologies.
conversion_technologies.create¶
async def create(
scenario_guid: str,
request: ConversionTechnologyRequestDtoV2,
) -> ConversionTechnologyResponseDtoV2
Create a conversion technology in a scenario.
REST operation: POST /sympheny-app/v2_2/scenarios/{scenarioGuid}/conversion-technologies
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
scenario_guid |
str |
yes | GUID of the scenario. |
request |
ConversionTechnologyRequestDtoV2 |
yes | Request body. |
Returns: ConversionTechnologyResponseDtoV2
async with AsyncSympheny(username, password) as client:
technology = await client.conversion_technologies.create(scenario_guid, request)
with Sympheny(username, password) as client:
technology = client.conversion_technologies.create(scenario_guid, request)
conversion_technologies.list¶
async def list(scenario_guid: str) -> ConversionTechnologyListResponseDtoV2
List the conversion technologies of a scenario.
REST operation: GET /sympheny-app/v2/scenarios/{scenarioGuid}/conversion-technologies
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
scenario_guid |
str |
yes | GUID of the scenario. |
Returns: ConversionTechnologyListResponseDtoV2
async with AsyncSympheny(username, password) as client:
technologies = await client.conversion_technologies.list(scenario_guid)
with Sympheny(username, password) as client:
technologies = client.conversion_technologies.list(scenario_guid)
conversion_technologies.get¶
async def get(technology_guid: str) -> ConversionTechnologyDetailResponseDtoV2
Get conversion technology details.
REST operation: GET /sympheny-app/v2/scenarios/conversion-technologies/{guid}
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
technology_guid |
str |
yes | GUID of the technology. |
Returns: ConversionTechnologyDetailResponseDtoV2
async with AsyncSympheny(username, password) as client:
technology = await client.conversion_technologies.get(technology_guid)
with Sympheny(username, password) as client:
technology = client.conversion_technologies.get(technology_guid)
conversion_technologies.update¶
async def update(
technology_guid: str,
request: ConversionTechnologyDetailResponseDtoV2,
) -> ConversionTechnologyResponseDtoV2
Update a conversion technology.
REST operation: PUT /sympheny-app/v2_1/scenarios/conversion-technologies/{guid}
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
technology_guid |
str |
yes | GUID of the technology. |
request |
ConversionTechnologyDetailResponseDtoV2 |
yes | Request body. |
Returns: ConversionTechnologyResponseDtoV2
async with AsyncSympheny(username, password) as client:
technology = await client.conversion_technologies.update(technology_guid, request)
with Sympheny(username, password) as client:
technology = client.conversion_technologies.update(technology_guid, request)
conversion_technologies.delete¶
async def delete(technology_guid: str) -> None
Delete a conversion technology.
REST operation: DELETE /sympheny-app/v2/scenarios/conversion-technologies/{guid}
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
technology_guid |
str |
yes | GUID of the technology. |
Returns: None
async with AsyncSympheny(username, password) as client:
await client.conversion_technologies.delete(technology_guid)
with Sympheny(username, password) as client:
client.conversion_technologies.delete(technology_guid)