View Source DocuSign.RequestBuilder (DocuSign v1.2.0)
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
Due to a bug in httpc, POST, PATCH and PUT requests will fail, if the body is empty
Specify the request method when building a request
Prune nils from map
Specify the request method when building a request
Functions
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
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
@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
Due to a bug in httpc, POST, PATCH and PUT requests will fail, if the body is empty
This function will ensure, that the body param is always set
Parameters
- request (Map) - Collected request options
Returns
Map
Specify the request method when building a request
Parameters
- request (Map) - Collected request options
- m (atom) - Request method
Returns
Map
Prune nils from map
Parameters
- map (Map) - Input Map
Returns
Map
Specify the request method when building a request
Parameters
- request (Map) - Collected request options
- u (String) - Request URL
Returns
Map