View Source CozyLark.ServerSideAPI.Request (cozy_lark v0.4.1)

Link to this section Summary

Types

The optional request body.

The request headers.

The request metadata.

The request method.

The request path.

The request private information, which is useful for passing data to other modules.

The optional request query.

The request scheme.

t()

Functions

Builds a request from a config and an spec.

Link to this section Types

@type body() :: map() | nil

The optional request body.

@type headers() :: %{
  optional(header_name :: String.t()) => header_value :: String.t()
}

The request headers.

@type meta() :: %{optional(atom()) => term()}

The request metadata.

@type method() :: String.t()

The request method.

@type path() :: String.t()

The request path.

@type private() :: %{optional(atom()) => term()}

The request private information, which is useful for passing data to other modules.

@type query() :: %{
  optional(query_name :: String.t()) =>
    query_value :: boolean() | number() | String.t()
}

The optional request query.

@type scheme() :: String.t()

The request scheme.

@type t() :: %CozyLark.ServerSideAPI.Request{
  body: body(),
  headers: headers(),
  host: String.t(),
  meta: meta(),
  method: method(),
  path: path(),
  port: :inet.port_number(),
  private: private(),
  query: query(),
  scheme: scheme()
}

Link to this section Functions

Builds a request from a config and an spec.