maptekblastlogic.api.holes package
Submodules
maptekblastlogic.api.holes.get_hole_by_id module
- maptekblastlogic.api.holes.get_hole_by_id.sync_detailed(site_code, hole_id, *, client)[source]
Get a hole by its ID.
Requires permissions: View Blasts
- Parameters:
site_code (str)
hole_id (int)
client (AuthenticatedClient)
- 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, HoleModel]]
- Return type:
- maptekblastlogic.api.holes.get_hole_by_id.sync(site_code, hole_id, *, client)[source]
Get a hole by its ID.
Requires permissions: View Blasts
- Parameters:
site_code (str)
hole_id (int)
client (AuthenticatedClient)
- 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, HoleModel]
- Return type:
ErrorModel | HoleModel | None
- async maptekblastlogic.api.holes.get_hole_by_id.asyncio_detailed(site_code, hole_id, *, client)[source]
Get a hole by its ID.
Requires permissions: View Blasts
- Parameters:
site_code (str)
hole_id (int)
client (AuthenticatedClient)
- 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, HoleModel]]
- Return type:
- async maptekblastlogic.api.holes.get_hole_by_id.asyncio(site_code, hole_id, *, client)[source]
Get a hole by its ID.
Requires permissions: View Blasts
- Parameters:
site_code (str)
hole_id (int)
client (AuthenticatedClient)
- 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, HoleModel]
- Return type:
ErrorModel | HoleModel | None
maptekblastlogic.api.holes.get_holes_by_blast_id module
- maptekblastlogic.api.holes.get_holes_by_blast_id.sync_detailed(site_code, blast_id, *, client)[source]
Get all holes in a blast.
Requires permissions: View Blasts
- Parameters:
site_code (str)
blast_id (int)
client (AuthenticatedClient)
- 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[‘HoleModel’]]]
- Return type:
- maptekblastlogic.api.holes.get_holes_by_blast_id.sync(site_code, blast_id, *, client)[source]
Get all holes in a blast.
Requires permissions: View Blasts
- Parameters:
site_code (str)
blast_id (int)
client (AuthenticatedClient)
- 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[‘HoleModel’]]
- Return type:
ErrorModel | List[HoleModel] | None
- async maptekblastlogic.api.holes.get_holes_by_blast_id.asyncio_detailed(site_code, blast_id, *, client)[source]
Get all holes in a blast.
Requires permissions: View Blasts
- Parameters:
site_code (str)
blast_id (int)
client (AuthenticatedClient)
- 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[‘HoleModel’]]]
- Return type:
- async maptekblastlogic.api.holes.get_holes_by_blast_id.asyncio(site_code, blast_id, *, client)[source]
Get all holes in a blast.
Requires permissions: View Blasts
- Parameters:
site_code (str)
blast_id (int)
client (AuthenticatedClient)
- 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[‘HoleModel’]]
- Return type:
ErrorModel | List[HoleModel] | None
maptekblastlogic.api.holes.get_holes_by_ids module
- maptekblastlogic.api.holes.get_holes_by_ids.sync_detailed(site_code, *, client, body)[source]
Get holes by their IDs.
Requires permissions: View Blasts
- Parameters:
site_code (str)
body (List[int])
client (AuthenticatedClient)
- 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[‘HoleModel’]]]
- Return type:
- maptekblastlogic.api.holes.get_holes_by_ids.sync(site_code, *, client, body)[source]
Get holes by their IDs.
Requires permissions: View Blasts
- Parameters:
site_code (str)
body (List[int])
client (AuthenticatedClient)
- 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[‘HoleModel’]]
- Return type:
ErrorModel | List[HoleModel] | None
- async maptekblastlogic.api.holes.get_holes_by_ids.asyncio_detailed(site_code, *, client, body)[source]
Get holes by their IDs.
Requires permissions: View Blasts
- Parameters:
site_code (str)
body (List[int])
client (AuthenticatedClient)
- 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[‘HoleModel’]]]
- Return type:
- async maptekblastlogic.api.holes.get_holes_by_ids.asyncio(site_code, *, client, body)[source]
Get holes by their IDs.
Requires permissions: View Blasts
- Parameters:
site_code (str)
body (List[int])
client (AuthenticatedClient)
- 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[‘HoleModel’]]
- Return type:
ErrorModel | List[HoleModel] | None