View Source DocuSign.RequestBuilder (DocuSign v1.0.0)
Helper functions for building Tesla requests
Link to this section 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
Link to this section Functions
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
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
@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
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
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
Parameters
- request (Map) - Collected request options
returns
Returns
Map
Specify the request method when building a request
parameters
Parameters
- request (Map) - Collected request options
- m (atom) - Request method
returns
Returns
Map
Prune nils from map
parameters
Parameters
- map (Map) - Input Map
returns
Returns
Map
Specify the request method when building a request
parameters
Parameters
- request (Map) - Collected request options
- u (String) - Request URL
returns
Returns
Map