MailSlurpAPI.RequestBuilder (mailslurp v15.17.22)

Helper functions for building Tesla requests

Summary

Functions

Add optional parameters to the request

Add optional parameters to the request

Handle the response for a Tesla request

Specify the request method when building a request

Specify the request method when building a request

Functions

Link to this function

add_optional_params(request, definitions, list)

@spec add_optional_params(map(), %{optional(atom()) => atom()}, keyword()) :: map()

Add optional parameters to the request

Parameters

  • request (Map) - Collected request options
  • definitions (Map) - Map of parameter name to parameter location.
  • options (KeywordList) - The provided optional parameters

Returns

Map

Link to this function

add_param(request, location, key, value)

@spec add_param(map(), atom(), atom(), any()) :: map()

Add optional parameters to the request

Parameters

  • request (Map) - Collected request options
  • location (atom) - Where to put the parameter
  • key (atom) - The name of the parameter
  • value (any) - The value of the parameter

Returns

Map

Link to this function

decode(env, struct)

@spec decode(Tesla.Env.t() | term(), false | struct() | [struct()]) ::
  {:ok, struct()} | {:ok, Tesla.Env.t()} | {:error, any()}

Handle the response for a Tesla request

Parameters

  • arg1 (Tesla.Env.t | term) - The response object

  • arg2 (:false | struct | [struct]) - The shape of the struct to deserialize into

Returns

on success {:error, term} on failure

Link to this function

evaluate_response(error, mapping)

Link to this function

method(request, m)

@spec method(map(), atom()) :: map()

Specify the request method when building a request

Parameters

  • request (Map) - Collected request options
  • m (atom) - Request method

Returns

Map

Link to this function

resolve_mapping(env, mapping, default \\ nil)

Link to this function

url(request, u)

@spec url(map(), String.t()) :: map()

Specify the request method when building a request

Parameters

  • request (Map) - Collected request options
  • u (String) - Request URL

Returns

Map