procore

v0.0.1

procore v0.0.1 Procore.Request

Holds the information needed to make a HTTP request. Defines functions to store this information in the struct.

Link to this section Summary

Types

t()
valid_request_type()

Functions

insert_body(request, body)

Stores the request body

insert_endpoint(request, endpoint)

Stores the endpoint

insert_query_params(request, query_params)

Stores the query params as a map

insert_request_type(request, request_type)

Stores the request type. Should be a valid_request_type

Link to this section Types

Link to this type t() 
t() :: %Procore.Request{
  body: %{},
  endpoint: String.t(),
  query_params: %{},
  request_type: valid_request_type() | :unset
}
Link to this type valid_request_type() 
valid_request_type() :: :get | :post

Link to this section Functions

Link to this function insert_body(request, body) 
insert_body(Request.t(), map()) :: Request.t()

Stores the request body.

Link to this function insert_endpoint(request, endpoint) 
insert_endpoint(Request.t(), String.t()) :: Request.t()

Stores the endpoint.

Link to this function insert_query_params(request, query_params) 
insert_query_params(Request.t(), map()) :: Request.t()

Stores the query params as a map.

Link to this function insert_request_type(request, request_type) 
insert_request_type(Request.t(), valid_request_type()) :: Request.t()

Stores the request type. Should be a valid_request_type.