maptekblastlogic.api.blasts package

Submodules

maptekblastlogic.api.blasts.blast_search module

maptekblastlogic.api.blasts.blast_search.sync_detailed(site_code, *, client, blast_name_pattern=<maptekblastlogic.types.Unset object>, status=<maptekblastlogic.types.Unset object>)

Search for blasts by name and status.

Requires permissions: View Blasts

Parameters:

• site_code (str)

• blast_name_pattern (Union[None, Unset, str])

• status (Union[None, Unset, str])

• 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[‘BlastModel’]]]

Return type:

Response[ErrorModel | List[BlastModel]]

maptekblastlogic.api.blasts.blast_search.sync(site_code, *, client, blast_name_pattern=<maptekblastlogic.types.Unset object>, status=<maptekblastlogic.types.Unset object>)

Search for blasts by name and status.

Requires permissions: View Blasts

Parameters:

• site_code (str)

• blast_name_pattern (Union[None, Unset, str])

• status (Union[None, Unset, str])

• 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[‘BlastModel’]]

Return type:

ErrorModel | List[BlastModel] | None

async maptekblastlogic.api.blasts.blast_search.asyncio_detailed(site_code, *, client, blast_name_pattern=<maptekblastlogic.types.Unset object>, status=<maptekblastlogic.types.Unset object>)

Search for blasts by name and status.

Requires permissions: View Blasts

Parameters:

• site_code (str)

• blast_name_pattern (Union[None, Unset, str])

• status (Union[None, Unset, str])

• 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[‘BlastModel’]]]

Return type:

Response[ErrorModel | List[BlastModel]]

async maptekblastlogic.api.blasts.blast_search.asyncio(site_code, *, client, blast_name_pattern=<maptekblastlogic.types.Unset object>, status=<maptekblastlogic.types.Unset object>)

Search for blasts by name and status.

Requires permissions: View Blasts

Parameters:

• site_code (str)

• blast_name_pattern (Union[None, Unset, str])

• status (Union[None, Unset, str])

• 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[‘BlastModel’]]

Return type:

ErrorModel | List[BlastModel] | None

maptekblastlogic.api.blasts.get_blast_by_id module

maptekblastlogic.api.blasts.get_blast_by_id.sync_detailed(site_code, blast_id, *, client)

Get a blast by its ID.

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[BlastModel, ErrorModel]]

Return type:

Response[BlastModel | ErrorModel]

maptekblastlogic.api.blasts.get_blast_by_id.sync(site_code, blast_id, *, client)

Get a blast by its ID.

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[BlastModel, ErrorModel]

Return type:

BlastModel | ErrorModel | None

async maptekblastlogic.api.blasts.get_blast_by_id.asyncio_detailed(site_code, blast_id, *, client)

Get a blast by its ID.

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[BlastModel, ErrorModel]]

Return type:

Response[BlastModel | ErrorModel]

async maptekblastlogic.api.blasts.get_blast_by_id.asyncio(site_code, blast_id, *, client)

Get a blast by its ID.

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[BlastModel, ErrorModel]

Return type:

BlastModel | ErrorModel | None