mgnipy.emgapi_v2_client.api.private_data package

mgnipy.emgapi_v2_client.api.private_data package#

Contains endpoint functions for accessing the API

Submodules#

mgnipy.emgapi_v2_client.api.private_data.list_private_mgnify_studies module#

mgnipy.emgapi_v2_client.api.private_data.list_private_mgnify_studies.sync_detailed(*, client, page=1, page_size=<mgnipy.emgapi_v2_client.types.Unset object>)[source]#

List all private studies available from MGnify

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

Return type:

Response[NinjaPaginationResponseSchemaMGnifyStudy]

mgnipy.emgapi_v2_client.api.private_data.list_private_mgnify_studies.sync(*, client, page=1, page_size=<mgnipy.emgapi_v2_client.types.Unset object>)[source]#

List all private studies available from MGnify

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:

NinjaPaginationResponseSchemaMGnifyStudy

Return type:

NinjaPaginationResponseSchemaMGnifyStudy | None

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

List all private studies available from MGnify

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

Return type:

Response[NinjaPaginationResponseSchemaMGnifyStudy]

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

List all private studies available from MGnify

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:

NinjaPaginationResponseSchemaMGnifyStudy

Return type:

NinjaPaginationResponseSchemaMGnifyStudy | None

Contents