mgnipy.emgapi_v2_client.api.authentication.token_obtain_sliding module

mgnipy.emgapi_v2_client.api.authentication.token_obtain_sliding module#

async mgnipy.emgapi_v2_client.api.authentication.token_obtain_sliding.asyncio(*, client, body)[source]#

Obtain an authentication token using Webin credentials.

Obtain an authentication JWT token using Webin credentials. This token is sliding, i.e. it can be

used both to access private data endpoints and to refresh itself after expiry.

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:

WebinTokenResponse

Return type:

WebinTokenResponse | None

async mgnipy.emgapi_v2_client.api.authentication.token_obtain_sliding.asyncio_detailed(*, client, body)[source]#

Obtain an authentication token using Webin credentials.

Obtain an authentication JWT token using Webin credentials. This token is sliding, i.e. it can be

used both to access private data endpoints and to refresh itself after expiry.

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

Return type:

Response[WebinTokenResponse]

mgnipy.emgapi_v2_client.api.authentication.token_obtain_sliding.sync(*, client, body)[source]#

Obtain an authentication token using Webin credentials.

Obtain an authentication JWT token using Webin credentials. This token is sliding, i.e. it can be

used both to access private data endpoints and to refresh itself after expiry.

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:

WebinTokenResponse

Return type:

WebinTokenResponse | None

mgnipy.emgapi_v2_client.api.authentication.token_obtain_sliding.sync_detailed(*, client, body)[source]#

Obtain an authentication token using Webin credentials.

Obtain an authentication JWT token using Webin credentials. This token is sliding, i.e. it can be

used both to access private data endpoints and to refresh itself after expiry.

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

Return type:

Response[WebinTokenResponse]

Contents