maptekblastlogic.api.sites package

Submodules

maptekblastlogic.api.sites.get_sites module

maptekblastlogic.api.sites.get_sites.sync_detailed(*, client)[source]

Get a list of all sites.

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

Parameters:

client (AuthenticatedClient)

Return type:

Response[ErrorModel | List[SiteModel]]

maptekblastlogic.api.sites.get_sites.sync(*, client)[source]

Get a list of all sites.

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

Parameters:

client (AuthenticatedClient)

Return type:

ErrorModel | List[SiteModel] | None

async maptekblastlogic.api.sites.get_sites.asyncio_detailed(*, client)[source]

Get a list of all sites.

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

Parameters:

client (AuthenticatedClient)

Return type:

Response[ErrorModel | List[SiteModel]]

async maptekblastlogic.api.sites.get_sites.asyncio(*, client)[source]

Get a list of all sites.

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

Parameters:

client (AuthenticatedClient)

Return type:

ErrorModel | List[SiteModel] | None