google_api_firestore v0.0.1 GoogleApi.Firestore.V1beta1.RequestBuilder View Source

Helper functions for building Tesla requests

Link to this section Summary

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

add_optional_params(request, definitions, list)

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

Add optional parameters to the request

Map

add_param(request, location, key, value)

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

Add optional parameters to the request

Map

decode(env, struct \\ nil, opts \\ [])

decode(Tesla.Env.t(), struct() | false, keyword()) ::
  {:ok, struct()} | {:error, Tesla.Env.t()}

Handle the response for a Tesla request

env (Tesla.Env) - The response object
struct (struct | false) - The shape of the struct to deserialize into. If false, returns the Tesla response.
opts (KeywordList) - [optional] Optional parameters
- :dataWrapped (boolean()): If true, the remove the wrapping “data” field.

{:ok, struct} on success {:error, info} on failure

method(request, m)

method(map(), String.t()) :: map()

Specify the request method when building a request

Map

replace_path_template_vars(u, replacements)

url(request, u)

url(request, u, replacements)

url(map(), String.t(), Map.t()) :: map()

Specify the request method when building a request

Map