maptekblastlogic.api.charge_plans package

Submodules

maptekblastlogic.api.charge_plans.get_charge_plan_by_hole_id module

maptekblastlogic.api.charge_plans.get_charge_plan_by_hole_id.sync_detailed(site_code, hole_id, *, client)[source]

Get the charge plan for a hole.

Requires permissions: View Blasts

Parameters:
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[ChargePlanModel, ErrorModel]]

Return type:

Response[ChargePlanModel | ErrorModel]

maptekblastlogic.api.charge_plans.get_charge_plan_by_hole_id.sync(site_code, hole_id, *, client)[source]

Get the charge plan for a hole.

Requires permissions: View Blasts

Parameters:
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[ChargePlanModel, ErrorModel]

Return type:

ChargePlanModel | ErrorModel | None

async maptekblastlogic.api.charge_plans.get_charge_plan_by_hole_id.asyncio_detailed(site_code, hole_id, *, client)[source]

Get the charge plan for a hole.

Requires permissions: View Blasts

Parameters:
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[ChargePlanModel, ErrorModel]]

Return type:

Response[ChargePlanModel | ErrorModel]

async maptekblastlogic.api.charge_plans.get_charge_plan_by_hole_id.asyncio(site_code, hole_id, *, client)[source]

Get the charge plan for a hole.

Requires permissions: View Blasts

Parameters:
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[ChargePlanModel, ErrorModel]

Return type:

ChargePlanModel | ErrorModel | None

maptekblastlogic.api.charge_plans.get_charge_plans_by_blast_id module

maptekblastlogic.api.charge_plans.get_charge_plans_by_blast_id.sync_detailed(site_code, blast_id, *, client)[source]

Get charge plans for all holes in a blast.

Requires permissions: View Blasts

Parameters:
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[ErrorModel, List[‘ChargePlanModel’]]]

Return type:

Response[ErrorModel | List[ChargePlanModel]]

maptekblastlogic.api.charge_plans.get_charge_plans_by_blast_id.sync(site_code, blast_id, *, client)[source]

Get charge plans for all holes in a blast.

Requires permissions: View Blasts

Parameters:
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[ErrorModel, List[‘ChargePlanModel’]]

Return type:

ErrorModel | List[ChargePlanModel] | None

async maptekblastlogic.api.charge_plans.get_charge_plans_by_blast_id.asyncio_detailed(site_code, blast_id, *, client)[source]

Get charge plans for all holes in a blast.

Requires permissions: View Blasts

Parameters:
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[ErrorModel, List[‘ChargePlanModel’]]]

Return type:

Response[ErrorModel | List[ChargePlanModel]]

async maptekblastlogic.api.charge_plans.get_charge_plans_by_blast_id.asyncio(site_code, blast_id, *, client)[source]

Get charge plans for all holes in a blast.

Requires permissions: View Blasts

Parameters:
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[ErrorModel, List[‘ChargePlanModel’]]

Return type:

ErrorModel | List[ChargePlanModel] | None