Bourse.Signing.Request (bourse v0.1.0)

Copy Markdown View Source

The unsigned request handed to a signing pattern.

This is the input half of the Bourse.Signing.Behaviour contract: every pattern receives one of these and returns a Bourse.Signing.SignedRequest. :path is the endpoint path without the base URL, and :params holds the query or body parameters the pattern is free to sign, reorder, or encode.

Summary

Types

method()
t()

Types

method()

@type method() :: :get | :post | :put | :delete | :patch

t()

@type t() :: %Bourse.Signing.Request{
  body: String.t() | nil,
  method: method(),
  params: map(),
  path: String.t()
}