mgnipy.emgapi_v2_client.api.studies.list_super_studies module

mgnipy.emgapi_v2_client.api.studies.list_super_studies module#

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

List all Super Studies

Super Studies are collections of MGnify Studies associated with major initiatives.

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:

NinjaPaginationResponseSchemaSuperStudy

Return type:

NinjaPaginationResponseSchemaSuperStudy | None

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

List all Super Studies

Super Studies are collections of MGnify Studies associated with major initiatives.

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

Return type:

Response[NinjaPaginationResponseSchemaSuperStudy]

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

List all Super Studies

Super Studies are collections of MGnify Studies associated with major initiatives.

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:

NinjaPaginationResponseSchemaSuperStudy

Return type:

NinjaPaginationResponseSchemaSuperStudy | None

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

List all Super Studies

Super Studies are collections of MGnify Studies associated with major initiatives.

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

Return type:

Response[NinjaPaginationResponseSchemaSuperStudy]

Contents