Paypal.Common.Link (Paypal v0.1.1)

View Source

The link is accumulating all of the required information for handling the HATEOAS links.

Summary

Types

t()

The possible values for the links are

Types

t()

@type t() :: %Paypal.Common.Link{
  enc_type: String.t() | nil,
  href: String.t() | nil,
  method: any() | nil,
  rel: String.t() | nil
}

The possible values for the links are:

  • enc_type is the kind of encoding the request is providing or requiring. It's not compulsory for most of the links.
  • href is the URL for the link.
  • rel is the name for the link. The name is based on the RFC-8288.
  • method is the HTTP method that is needed for the request.