MailSlurpAPI.Api.ApiUserController (mailslurp v15.14.0)

API calls for all endpoints tagged ApiUserController.

Link to this section Summary

Functions

Utility function to extract properties from JSON objects in language where this is cumbersome.

Parameters

  • connection (MailSlurpAPI.Connection): Connection to server
  • opts (KeywordList): [optional] Optional parameters

Returns

} on success {:error, info} on failure

Link to this section Functions

Link to this function

get_json_property_as_string(connection, property, body, opts \\ [])

@spec get_json_property_as_string(Tesla.Env.client(), String.t(), Map, keyword()) ::
  {:ok, String.t()} | {:error, Tesla.Env.t()}

Utility function to extract properties from JSON objects in language where this is cumbersome.

parameters

Parameters

  • connection (MailSlurpAPI.Connection): Connection to server
  • property (String.t): JSON property name or dot separated path selector such as a.b.c
  • body (Map):
  • opts (KeywordList): [optional] Optional parameters

returns

Returns

} on success {:error, info} on failure

Link to this function

get_user_info(connection, opts \\ [])

@spec get_user_info(Tesla.Env.client(), keyword()) ::
  {:ok, MailSlurpAPI.Model.UserInfoDto.t()} | {:error, Tesla.Env.t()}

parameters

Parameters

  • connection (MailSlurpAPI.Connection): Connection to server
  • opts (KeywordList): [optional] Optional parameters

returns

Returns

} on success {:error, info} on failure