MishkaPay.Invoice.Lines (Mishka Pay v0.0.1)

Copy Markdown View Source

Summary

Types

t()

The struct that builder/1 returns.

Functions

A sample %MishkaPay.Invoice.Lines{} populated from defaults + type-based fallbacks.

Types

t()

@type t() :: %MishkaPay.Invoice.Lines{
  amount: Money.t() | nil,
  description: String.t() | nil,
  id: String.t() | nil,
  period_end: DateTime.t() | nil,
  period_start: DateTime.t() | nil,
  price_id: String.t() | nil,
  proration: boolean() | nil,
  quantity: non_neg_integer() | nil
}

The struct that builder/1 returns.

FieldTypeRequiredDefaultDescriptionDerives
:idString.t() | nilnovalidate(string)
:descriptionString.t() | nilnovalidate(string)
:amountMoney.t() | nilnovalidator {MishkaPay.Money, :signed_field}
:quantitynon_neg_integer() | nilnovalidate(integer)
:price_idString.t() | nilnovalidate(string)
:prorationboolean() | nilnofalsevalidate(boolean)
:period_startDateTime.t() | nilnovalidate(struct)
:period_endDateTime.t() | nilnovalidate(struct)

Functions

builder(attrs_or_input, error \\ false)

enforce_keys()

enforce_keys(field)

example()

A sample %MishkaPay.Invoice.Lines{} populated from defaults + type-based fallbacks.

keys()

keys(field)