mgnipy.emgapi_v2_client.api.miscellaneous package

mgnipy.emgapi_v2_client.api.miscellaneous package#

Contains endpoint functions for accessing the API

Submodules#

mgnipy.emgapi_v2_client.api.miscellaneous.list_mgnify_biomes module#

mgnipy.emgapi_v2_client.api.miscellaneous.list_mgnify_biomes.sync_detailed(*, client, biome_lineage=<mgnipy.emgapi_v2_client.types.Unset object>, max_depth=<mgnipy.emgapi_v2_client.types.Unset object>, page=1, page_size=<mgnipy.emgapi_v2_client.types.Unset object>)[source]#

List all biomes

List all biomes in the MGnify database.

Parameters:

  • biome_lineage (None | str | Unset) – The lineage to match, including all descendant biomes

  • max_depth (int | None | Unset) – Maximum depth of the biome lineage to include, e.g. root is 1 and root:Host-Associated:Human is level 3

  • page (int | Unset) – Default: 1.

  • page_size (int | None | Unset)

  • client (AuthenticatedClient | Client)

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[NinjaPaginationResponseSchemaBiome]

Return type:

Response[NinjaPaginationResponseSchemaBiome]

mgnipy.emgapi_v2_client.api.miscellaneous.list_mgnify_biomes.sync(*, client, biome_lineage=<mgnipy.emgapi_v2_client.types.Unset object>, max_depth=<mgnipy.emgapi_v2_client.types.Unset object>, page=1, page_size=<mgnipy.emgapi_v2_client.types.Unset object>)[source]#

List all biomes

List all biomes in the MGnify database.

Parameters:

  • biome_lineage (None | str | Unset) – The lineage to match, including all descendant biomes

  • max_depth (int | None | Unset) – Maximum depth of the biome lineage to include, e.g. root is 1 and root:Host-Associated:Human is level 3

  • page (int | Unset) – Default: 1.

  • page_size (int | None | Unset)

  • client (AuthenticatedClient | Client)

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:

NinjaPaginationResponseSchemaBiome

Return type:

NinjaPaginationResponseSchemaBiome | None

async mgnipy.emgapi_v2_client.api.miscellaneous.list_mgnify_biomes.asyncio_detailed(*, client, biome_lineage=<mgnipy.emgapi_v2_client.types.Unset object>, max_depth=<mgnipy.emgapi_v2_client.types.Unset object>, page=1, page_size=<mgnipy.emgapi_v2_client.types.Unset object>)[source]#

List all biomes

List all biomes in the MGnify database.

Parameters:

  • biome_lineage (None | str | Unset) – The lineage to match, including all descendant biomes

  • max_depth (int | None | Unset) – Maximum depth of the biome lineage to include, e.g. root is 1 and root:Host-Associated:Human is level 3

  • page (int | Unset) – Default: 1.

  • page_size (int | None | Unset)

  • client (AuthenticatedClient | Client)

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[NinjaPaginationResponseSchemaBiome]

Return type:

Response[NinjaPaginationResponseSchemaBiome]

async mgnipy.emgapi_v2_client.api.miscellaneous.list_mgnify_biomes.asyncio(*, client, biome_lineage=<mgnipy.emgapi_v2_client.types.Unset object>, max_depth=<mgnipy.emgapi_v2_client.types.Unset object>, page=1, page_size=<mgnipy.emgapi_v2_client.types.Unset object>)[source]#

List all biomes

List all biomes in the MGnify database.

Parameters:

  • biome_lineage (None | str | Unset) – The lineage to match, including all descendant biomes

  • max_depth (int | None | Unset) – Maximum depth of the biome lineage to include, e.g. root is 1 and root:Host-Associated:Human is level 3

  • page (int | Unset) – Default: 1.

  • page_size (int | None | Unset)

  • client (AuthenticatedClient | Client)

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:

NinjaPaginationResponseSchemaBiome

Return type:

NinjaPaginationResponseSchemaBiome | None

Contents