maptekblastlogic.api.loaded_decks package

Submodules

maptekblastlogic.api.loaded_decks.create_loaded_deck module

maptekblastlogic.api.loaded_decks.create_loaded_deck.sync_detailed(site_code, *, client, body)[source]

Create a new Loaded Deck.

Requires permissions: Edit Charging Events

Parameters:

  • site_code (str)

  • body (LoadedDeckModel) – Describes the loading of an individual deck. This is raw data collected from the field that has not been validated and reconciled in BlastLogic Desktop. As such, decks may overlap with each other. This data should not be relied upon as the current state of the 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:

Response[ErrorModel | int]

maptekblastlogic.api.loaded_decks.create_loaded_deck.sync(site_code, *, client, body)[source]

Create a new Loaded Deck.

Requires permissions: Edit Charging Events

Parameters:

  • site_code (str)

  • body (LoadedDeckModel) – Describes the loading of an individual deck. This is raw data collected from the field that has not been validated and reconciled in BlastLogic Desktop. As such, decks may overlap with each other. This data should not be relied upon as the current state of the 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.loaded_decks.create_loaded_deck.asyncio_detailed(site_code, *, client, body)[source]

Create a new Loaded Deck.

Requires permissions: Edit Charging Events

Parameters:

  • site_code (str)

  • body (LoadedDeckModel) – Describes the loading of an individual deck. This is raw data collected from the field that has not been validated and reconciled in BlastLogic Desktop. As such, decks may overlap with each other. This data should not be relied upon as the current state of the 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:

Response[ErrorModel | int]

async maptekblastlogic.api.loaded_decks.create_loaded_deck.asyncio(site_code, *, client, body)[source]

Create a new Loaded Deck.

Requires permissions: Edit Charging Events

Parameters:

  • site_code (str)

  • body (LoadedDeckModel) – Describes the loading of an individual deck. This is raw data collected from the field that has not been validated and reconciled in BlastLogic Desktop. As such, decks may overlap with each other. This data should not be relied upon as the current state of the 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.loaded_decks.get_loaded_deck_by_id module

maptekblastlogic.api.loaded_decks.get_loaded_deck_by_id.sync_detailed(site_code, loaded_deck_id, *, client)[source]

Get a loaded deck by its ID.

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, LoadedDeckModel]]

Return type:

Response[ErrorModel | LoadedDeckModel]

maptekblastlogic.api.loaded_decks.get_loaded_deck_by_id.sync(site_code, loaded_deck_id, *, client)[source]

Get a loaded deck by its ID.

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, LoadedDeckModel]

Return type:

ErrorModel | LoadedDeckModel | None

async maptekblastlogic.api.loaded_decks.get_loaded_deck_by_id.asyncio_detailed(site_code, loaded_deck_id, *, client)[source]

Get a loaded deck by its ID.

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, LoadedDeckModel]]

Return type:

Response[ErrorModel | LoadedDeckModel]

async maptekblastlogic.api.loaded_decks.get_loaded_deck_by_id.asyncio(site_code, loaded_deck_id, *, client)[source]

Get a loaded deck by its ID.

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, LoadedDeckModel]

Return type:

ErrorModel | LoadedDeckModel | None

maptekblastlogic.api.loaded_decks.get_loaded_decks_by_blast_id module

maptekblastlogic.api.loaded_decks.get_loaded_decks_by_blast_id.sync_detailed(site_code, blast_id, *, client)[source]

Get loaded decks 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[‘LoadedDeckModel’]]]

Return type:

Response[ErrorModel | List[LoadedDeckModel]]

maptekblastlogic.api.loaded_decks.get_loaded_decks_by_blast_id.sync(site_code, blast_id, *, client)[source]

Get loaded decks 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[‘LoadedDeckModel’]]

Return type:

ErrorModel | List[LoadedDeckModel] | None

async maptekblastlogic.api.loaded_decks.get_loaded_decks_by_blast_id.asyncio_detailed(site_code, blast_id, *, client)[source]

Get loaded decks 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[‘LoadedDeckModel’]]]

Return type:

Response[ErrorModel | List[LoadedDeckModel]]

async maptekblastlogic.api.loaded_decks.get_loaded_decks_by_blast_id.asyncio(site_code, blast_id, *, client)[source]

Get loaded decks 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[‘LoadedDeckModel’]]

Return type:

ErrorModel | List[LoadedDeckModel] | None

maptekblastlogic.api.loaded_decks.get_loaded_decks_by_hole_id module

maptekblastlogic.api.loaded_decks.get_loaded_decks_by_hole_id.sync_detailed(site_code, hole_id, *, client)[source]

Get loaded decks 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[ErrorModel, List[‘LoadedDeckModel’]]]

Return type:

Response[ErrorModel | List[LoadedDeckModel]]

maptekblastlogic.api.loaded_decks.get_loaded_decks_by_hole_id.sync(site_code, hole_id, *, client)[source]

Get loaded decks 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[ErrorModel, List[‘LoadedDeckModel’]]

Return type:

ErrorModel | List[LoadedDeckModel] | None

async maptekblastlogic.api.loaded_decks.get_loaded_decks_by_hole_id.asyncio_detailed(site_code, hole_id, *, client)[source]

Get loaded decks 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[ErrorModel, List[‘LoadedDeckModel’]]]

Return type:

Response[ErrorModel | List[LoadedDeckModel]]

async maptekblastlogic.api.loaded_decks.get_loaded_decks_by_hole_id.asyncio(site_code, hole_id, *, client)[source]

Get loaded decks 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[ErrorModel, List[‘LoadedDeckModel’]]

Return type:

ErrorModel | List[LoadedDeckModel] | None

maptekblastlogic.api.loaded_decks.update_loaded_deck module

maptekblastlogic.api.loaded_decks.update_loaded_deck.sync_detailed(site_code, loaded_deck_id, *, client, body, if_match)[source]

Update an existing Loaded Deck.

Requires permissions: Edit Charging Events

Parameters:

  • site_code (str)

  • loaded_deck_id (int)

  • if_match (str)

  • body (LoadedDeckModel) – Describes the loading of an individual deck. This is raw data collected from the field that has not been validated and reconciled in BlastLogic Desktop. As such, decks may overlap with each other. This data should not be relied upon as the current state of the 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:

Response[Any | ErrorModel]

maptekblastlogic.api.loaded_decks.update_loaded_deck.sync(site_code, loaded_deck_id, *, client, body, if_match)[source]

Update an existing Loaded Deck.

Requires permissions: Edit Charging Events

Parameters:

  • site_code (str)

  • loaded_deck_id (int)

  • if_match (str)

  • body (LoadedDeckModel) – Describes the loading of an individual deck. This is raw data collected from the field that has not been validated and reconciled in BlastLogic Desktop. As such, decks may overlap with each other. This data should not be relied upon as the current state of the 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.loaded_decks.update_loaded_deck.asyncio_detailed(site_code, loaded_deck_id, *, client, body, if_match)[source]

Update an existing Loaded Deck.

Requires permissions: Edit Charging Events

Parameters:

  • site_code (str)

  • loaded_deck_id (int)

  • if_match (str)

  • body (LoadedDeckModel) – Describes the loading of an individual deck. This is raw data collected from the field that has not been validated and reconciled in BlastLogic Desktop. As such, decks may overlap with each other. This data should not be relied upon as the current state of the 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:

Response[Any | ErrorModel]

async maptekblastlogic.api.loaded_decks.update_loaded_deck.asyncio(site_code, loaded_deck_id, *, client, body, if_match)[source]

Update an existing Loaded Deck.

Requires permissions: Edit Charging Events

Parameters:

  • site_code (str)

  • loaded_deck_id (int)

  • if_match (str)

  • body (LoadedDeckModel) – Describes the loading of an individual deck. This is raw data collected from the field that has not been validated and reconciled in BlastLogic Desktop. As such, decks may overlap with each other. This data should not be relied upon as the current state of the 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