Skip to content

Email info

get(body=Body(), execution_id=None, token=Depends(oauth2_scheme)) async

Return a details of email info

Parameters:

Name Type Description Default
body EntityGetRequest

A list of requested entity. Defaults to Body().

Body()
execution_id str

Unique identifier of the execution. Defaults to None.

None
token str

The authentication token. Defaults to Depends(oauth2_scheme).

Depends(oauth2_scheme)

Raises:

Type Description
HTTPException
status_code

HTTP_400_BAD_REQUEST

message

Problem on get email info details

body

exception message

Returns:

Type Description
EmailInfoListResponse

A Dictionary with

EmailInfoListResponse
  • "entities" as key , (List[EmailInfo]) as value
EmailInfoListResponse
  • "total" as key : record count as value

list(body=Body(), execution_id=None, token=Depends(oauth2_scheme)) async

Return a list of email info

Parameters:

Name Type Description Default
body EntitiesListRequest

A list of requested entities. Defaults to Body().

Body()
execution_id str

Unique identifier of the execution. Defaults to None.

None
token str

The authentication token. Defaults to Depends(oauth2_scheme).

Depends(oauth2_scheme)

Raises:

Type Description
HTTPException

HTTP_400_BAD_REQUEST - Problem on get email info list

Returns:

Type Description
EmailInfoListResponse

A Dictionary with

  • "entities" as key , (List[EmailInfo]) as value

  • "total" as key : record count as value

save(body=Body(), execution_id=None, token=Depends(oauth2_scheme)) async

Save or update an email info

Parameters:

Name Type Description Default
body EntityGetRequest

A list of requested entity. Defaults to Body().

Body()
execution_id str

Unique identifier of the execution. Defaults to None.

None
token str

The authentication token. Defaults to Depends(oauth2_scheme).

Depends(oauth2_scheme)

Raises:

Type Description
HTTPException
status_code

HTTP_400_BAD_REQUEST

message

Problem on get email info details

body

exception message

Returns:

Name Type Description
EmailInfo EmailInfo

The new or updated EmailInfo