docspring v0.0.4

View Source Docspring.RequestBuilder (docspring v0.0.4)

Helper functions for building Tesla requests

Link to this section Summary

Functions

add_optional_params(request, definitions, list)

Add optional parameters to the request

add_param(request, location, key, value)

Add optional parameters to the request

decode(response)

Handle the response for a Tesla request

decode(env, struct)
method(request, m)

Specify the request method when building a request

url(request, u)

Specify the request method when building a request

Link to this section Functions

Link to this function

add_optional_params(request, definitions, list)

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

Add optional parameters to the request

parameters

 Parameters

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

returns

 Returns

Map

Link to this function

add_param(request, location, key, value)

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

Add optional parameters to the request

parameters

 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

 Returns

Map

Link to this function

decode(response)

View Source 
@spec decode(Tesla.Env.t() | term()) ::
  {:ok, struct()} | {:error, Tesla.Env.t()} | {:error, term()}

Handle the response for a Tesla request

parameters

 Parameters

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

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

returns

 Returns

on success {:error, term} on failure

Link to this function

decode(env, struct)

View Source 
@spec decode(Tesla.Env.t() | term(), false | struct() | [struct()]) ::
  {:ok, struct()} | {:error, Tesla.Env.t()} | {:error, term()}
Link to this function

method(request, m)

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

Specify the request method when building a request

parameters

 Parameters

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

returns

 Returns

Map

Link to this function

url(request, u)

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

Specify the request method when building a request

parameters

 Parameters

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

returns

 Returns

Map