mgnipy.emgapi_v2_client.api.runs package

Contains endpoint functions for accessing the API

Submodules

mgnipy.emgapi_v2_client.api.runs.get_analysed_run module

mgnipy.emgapi_v2_client.api.runs.get_analysed_run.sync_detailed(accession, *, client)

Get the detail of a single analysed run

Get the detail of a single analysed run in the MGnify database.

Parameters:

• accession (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[AnalysedRunDetail]

Return type:

Response[AnalysedRunDetail]

mgnipy.emgapi_v2_client.api.runs.get_analysed_run.sync(accession, *, client)

Get the detail of a single analysed run

Get the detail of a single analysed run in the MGnify database.

Parameters:

• accession (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:

AnalysedRunDetail

Return type:

AnalysedRunDetail | None

async mgnipy.emgapi_v2_client.api.runs.get_analysed_run.asyncio_detailed(accession, *, client)

Get the detail of a single analysed run

Get the detail of a single analysed run in the MGnify database.

Parameters:

• accession (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[AnalysedRunDetail]

Return type:

Response[AnalysedRunDetail]

async mgnipy.emgapi_v2_client.api.runs.get_analysed_run.asyncio(accession, *, client)

Get the detail of a single analysed run

Get the detail of a single analysed run in the MGnify database.

Parameters:

• accession (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:

AnalysedRunDetail

Return type:

AnalysedRunDetail | None

mgnipy.emgapi_v2_client.api.runs.list_analysed_runs module

mgnipy.emgapi_v2_client.api.runs.list_analysed_runs.sync_detailed(*, client, has_experiment_type=<mgnipy.emgapi_v2_client.types.Unset object>, page=1, page_size=<mgnipy.emgapi_v2_client.types.Unset object>)

List all analysed runs

List all analysed runs in the MGnify database.

Parameters:

• has_experiment_type (ExperimentTypes | None | Unset) – If set, will only show runs with the specified experiment type

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

• page_size (int | None | Unset)

• 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[NinjaPaginationResponseSchemaAnalysedRun]

Return type:

Response[NinjaPaginationResponseSchemaAnalysedRun]

mgnipy.emgapi_v2_client.api.runs.list_analysed_runs.sync(*, client, has_experiment_type=<mgnipy.emgapi_v2_client.types.Unset object>, page=1, page_size=<mgnipy.emgapi_v2_client.types.Unset object>)

List all analysed runs

List all analysed runs in the MGnify database.

Parameters:

• has_experiment_type (ExperimentTypes | None | Unset) – If set, will only show runs with the specified experiment type

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

• page_size (int | None | Unset)

• 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:

NinjaPaginationResponseSchemaAnalysedRun

Return type:

NinjaPaginationResponseSchemaAnalysedRun | None

async mgnipy.emgapi_v2_client.api.runs.list_analysed_runs.asyncio_detailed(*, client, has_experiment_type=<mgnipy.emgapi_v2_client.types.Unset object>, page=1, page_size=<mgnipy.emgapi_v2_client.types.Unset object>)

List all analysed runs

List all analysed runs in the MGnify database.

Parameters:

• has_experiment_type (ExperimentTypes | None | Unset) – If set, will only show runs with the specified experiment type

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

• page_size (int | None | Unset)

• 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[NinjaPaginationResponseSchemaAnalysedRun]

Return type:

Response[NinjaPaginationResponseSchemaAnalysedRun]

async mgnipy.emgapi_v2_client.api.runs.list_analysed_runs.asyncio(*, client, has_experiment_type=<mgnipy.emgapi_v2_client.types.Unset object>, page=1, page_size=<mgnipy.emgapi_v2_client.types.Unset object>)

List all analysed runs

List all analysed runs in the MGnify database.

Parameters:

• has_experiment_type (ExperimentTypes | None | Unset) – If set, will only show runs with the specified experiment type

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

• page_size (int | None | Unset)

• 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:

NinjaPaginationResponseSchemaAnalysedRun

Return type:

NinjaPaginationResponseSchemaAnalysedRun | None

mgnipy.emgapi_v2_client.api.runs.list_runs_analyses module

mgnipy.emgapi_v2_client.api.runs.list_runs_analyses.sync_detailed(accession, *, client, page=1, page_size=<mgnipy.emgapi_v2_client.types.Unset object>)

List MGnify Analyses associated with this Run

MGnify analyses correspond to an individual Run or Assembly

Parameters:

• accession (str )

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

• page_size (int | None | Unset)

• 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[NinjaPaginationResponseSchemaMGnifyAnalysis]

Return type:

Response[NinjaPaginationResponseSchemaMGnifyAnalysis]

mgnipy.emgapi_v2_client.api.runs.list_runs_analyses.sync(accession, *, client, page=1, page_size=<mgnipy.emgapi_v2_client.types.Unset object>)

List MGnify Analyses associated with this Run

MGnify analyses correspond to an individual Run or Assembly

Parameters:

• accession (str )

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

• page_size (int | None | Unset)

• 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:

NinjaPaginationResponseSchemaMGnifyAnalysis

Return type:

NinjaPaginationResponseSchemaMGnifyAnalysis | None

async mgnipy.emgapi_v2_client.api.runs.list_runs_analyses.asyncio_detailed(accession, *, client, page=1, page_size=<mgnipy.emgapi_v2_client.types.Unset object>)

List MGnify Analyses associated with this Run

MGnify analyses correspond to an individual Run or Assembly

Parameters:

• accession (str )

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

• page_size (int | None | Unset)

• 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[NinjaPaginationResponseSchemaMGnifyAnalysis]

Return type:

Response[NinjaPaginationResponseSchemaMGnifyAnalysis]

async mgnipy.emgapi_v2_client.api.runs.list_runs_analyses.asyncio(accession, *, client, page=1, page_size=<mgnipy.emgapi_v2_client.types.Unset object>)

List MGnify Analyses associated with this Run

MGnify analyses correspond to an individual Run or Assembly

Parameters:

• accession (str )

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

• page_size (int | None | Unset)

• 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:

NinjaPaginationResponseSchemaMGnifyAnalysis

Return type:

NinjaPaginationResponseSchemaMGnifyAnalysis | None

mgnipy.emgapi_v2_client.api.runs.list_runs_assemblies module

mgnipy.emgapi_v2_client.api.runs.list_runs_assemblies.sync_detailed(accession, *, client, page=1, page_size=<mgnipy.emgapi_v2_client.types.Unset object>)

List Assemblies associated with this Run

Assemblies generated from or including this run

Parameters:

• accession (str )

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

• page_size (int | None | Unset)

• 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[NinjaPaginationResponseSchemaAssemblyDetail]

Return type:

Response[NinjaPaginationResponseSchemaAssemblyDetail]

mgnipy.emgapi_v2_client.api.runs.list_runs_assemblies.sync(accession, *, client, page=1, page_size=<mgnipy.emgapi_v2_client.types.Unset object>)

List Assemblies associated with this Run

Assemblies generated from or including this run

Parameters:

• accession (str )

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

• page_size (int | None | Unset)

• 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:

NinjaPaginationResponseSchemaAssemblyDetail

Return type:

NinjaPaginationResponseSchemaAssemblyDetail | None

async mgnipy.emgapi_v2_client.api.runs.list_runs_assemblies.asyncio_detailed(accession, *, client, page=1, page_size=<mgnipy.emgapi_v2_client.types.Unset object>)

List Assemblies associated with this Run

Assemblies generated from or including this run

Parameters:

• accession (str )

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

• page_size (int | None | Unset)

• 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[NinjaPaginationResponseSchemaAssemblyDetail]

Return type:

Response[NinjaPaginationResponseSchemaAssemblyDetail]

async mgnipy.emgapi_v2_client.api.runs.list_runs_assemblies.asyncio(accession, *, client, page=1, page_size=<mgnipy.emgapi_v2_client.types.Unset object>)

List Assemblies associated with this Run

Assemblies generated from or including this run

Parameters:

• accession (str )

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

• page_size (int | None | Unset)

• 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:

NinjaPaginationResponseSchemaAssemblyDetail

Return type:

NinjaPaginationResponseSchemaAssemblyDetail | None