maptekblastlogic.api.dipping_entries package
Submodules
maptekblastlogic.api.dipping_entries.create_dipping_entry module
- maptekblastlogic.api.dipping_entries.create_dipping_entry.sync_detailed(site_code, *, client, body)[source]
Create a new dipping entry.
Requires permissions: Edit Entries
- Parameters:
site_code (str)
body (DippingEntryModel) – Details of a dipping activity on a hole.
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, int]]
- Return type:
- maptekblastlogic.api.dipping_entries.create_dipping_entry.sync(site_code, *, client, body)[source]
Create a new dipping entry.
Requires permissions: Edit Entries
- Parameters:
site_code (str)
body (DippingEntryModel) – Details of a dipping activity on a hole.
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, int]
- Return type:
ErrorModel | int | None
- async maptekblastlogic.api.dipping_entries.create_dipping_entry.asyncio_detailed(site_code, *, client, body)[source]
Create a new dipping entry.
Requires permissions: Edit Entries
- Parameters:
site_code (str)
body (DippingEntryModel) – Details of a dipping activity on a hole.
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, int]]
- Return type:
- async maptekblastlogic.api.dipping_entries.create_dipping_entry.asyncio(site_code, *, client, body)[source]
Create a new dipping entry.
Requires permissions: Edit Entries
- Parameters:
site_code (str)
body (DippingEntryModel) – Details of a dipping activity on a hole.
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, int]
- Return type:
ErrorModel | int | None
maptekblastlogic.api.dipping_entries.get_dipping_entries_by_blast_id module
- maptekblastlogic.api.dipping_entries.get_dipping_entries_by_blast_id.sync_detailed(site_code, blast_id, *, client)[source]
Get dipping entries for 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[‘DippingEntryModel’]]]
- Return type:
- maptekblastlogic.api.dipping_entries.get_dipping_entries_by_blast_id.sync(site_code, blast_id, *, client)[source]
Get dipping entries for 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[‘DippingEntryModel’]]
- Return type:
ErrorModel | List[DippingEntryModel] | None
- async maptekblastlogic.api.dipping_entries.get_dipping_entries_by_blast_id.asyncio_detailed(site_code, blast_id, *, client)[source]
Get dipping entries for 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[‘DippingEntryModel’]]]
- Return type:
- async maptekblastlogic.api.dipping_entries.get_dipping_entries_by_blast_id.asyncio(site_code, blast_id, *, client)[source]
Get dipping entries for 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[‘DippingEntryModel’]]
- Return type:
ErrorModel | List[DippingEntryModel] | None
maptekblastlogic.api.dipping_entries.get_dipping_entries_by_hole_id module
- maptekblastlogic.api.dipping_entries.get_dipping_entries_by_hole_id.sync_detailed(site_code, hole_id, *, client)[source]
Get dipping entries for a hole.
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, List[‘DippingEntryModel’]]]
- Return type:
- maptekblastlogic.api.dipping_entries.get_dipping_entries_by_hole_id.sync(site_code, hole_id, *, client)[source]
Get dipping entries for a hole.
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, List[‘DippingEntryModel’]]
- Return type:
ErrorModel | List[DippingEntryModel] | None
- async maptekblastlogic.api.dipping_entries.get_dipping_entries_by_hole_id.asyncio_detailed(site_code, hole_id, *, client)[source]
Get dipping entries for a hole.
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, List[‘DippingEntryModel’]]]
- Return type:
- async maptekblastlogic.api.dipping_entries.get_dipping_entries_by_hole_id.asyncio(site_code, hole_id, *, client)[source]
Get dipping entries for a hole.
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, List[‘DippingEntryModel’]]
- Return type:
ErrorModel | List[DippingEntryModel] | None
maptekblastlogic.api.dipping_entries.get_dipping_entry_by_id module
- maptekblastlogic.api.dipping_entries.get_dipping_entry_by_id.sync_detailed(site_code, dipping_entry_id, *, client)[source]
Get a dipping entry.
Requires permissions: View Blasts
- Parameters:
site_code (str)
dipping_entry_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[DippingEntryModel, ErrorModel]]
- Return type:
- maptekblastlogic.api.dipping_entries.get_dipping_entry_by_id.sync(site_code, dipping_entry_id, *, client)[source]
Get a dipping entry.
Requires permissions: View Blasts
- Parameters:
site_code (str)
dipping_entry_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[DippingEntryModel, ErrorModel]
- Return type:
DippingEntryModel | ErrorModel | None
- async maptekblastlogic.api.dipping_entries.get_dipping_entry_by_id.asyncio_detailed(site_code, dipping_entry_id, *, client)[source]
Get a dipping entry.
Requires permissions: View Blasts
- Parameters:
site_code (str)
dipping_entry_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[DippingEntryModel, ErrorModel]]
- Return type:
- async maptekblastlogic.api.dipping_entries.get_dipping_entry_by_id.asyncio(site_code, dipping_entry_id, *, client)[source]
Get a dipping entry.
Requires permissions: View Blasts
- Parameters:
site_code (str)
dipping_entry_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[DippingEntryModel, ErrorModel]
- Return type:
DippingEntryModel | ErrorModel | None
maptekblastlogic.api.dipping_entries.update_dipping_entry module
- maptekblastlogic.api.dipping_entries.update_dipping_entry.sync_detailed(site_code, dipping_entry_id, *, client, body, if_match)[source]
Update an existing dipping entry.
Requires permissions: Edit Entries
- Parameters:
site_code (str)
dipping_entry_id (int)
if_match (str)
body (DippingEntryModel) – Details of a dipping activity on a hole.
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[Any, ErrorModel]]
- Return type:
- maptekblastlogic.api.dipping_entries.update_dipping_entry.sync(site_code, dipping_entry_id, *, client, body, if_match)[source]
Update an existing dipping entry.
Requires permissions: Edit Entries
- Parameters:
site_code (str)
dipping_entry_id (int)
if_match (str)
body (DippingEntryModel) – Details of a dipping activity on a hole.
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[Any, ErrorModel]
- Return type:
Any | ErrorModel | None
- async maptekblastlogic.api.dipping_entries.update_dipping_entry.asyncio_detailed(site_code, dipping_entry_id, *, client, body, if_match)[source]
Update an existing dipping entry.
Requires permissions: Edit Entries
- Parameters:
site_code (str)
dipping_entry_id (int)
if_match (str)
body (DippingEntryModel) – Details of a dipping activity on a hole.
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[Any, ErrorModel]]
- Return type:
- async maptekblastlogic.api.dipping_entries.update_dipping_entry.asyncio(site_code, dipping_entry_id, *, client, body, if_match)[source]
Update an existing dipping entry.
Requires permissions: Edit Entries
- Parameters:
site_code (str)
dipping_entry_id (int)
if_match (str)
body (DippingEntryModel) – Details of a dipping activity on a hole.
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[Any, ErrorModel]
- Return type:
Any | ErrorModel | None