SEO.JSONLD.RepaymentSpecification (SEO v0.3.0-rc.0)

View Source

A structured value representing repayment.

Helper for building a Schema.org RepaymentSpecification JSON-LD structure.

Summary

Types

attrs()
t()

A JSON-LD map ready to be nested or rendered. String-keyed, always includes "@type" set to "RepaymentSpecification", plus any camelCased field keys the caller provided (see build/1). "@context" is added at render time by SEO.JSONLD.meta/1 on the top-level node only.

Functions

build(attrs)

Build a RepaymentSpecification JSON-LD map.

Types

attrs()

@type attrs() ::
  %{
    optional(:down_payment) => number() | SEO.JSONLD.MonetaryAmount.t() | map(),
    optional(:early_prepayment_penalty) =>
      SEO.JSONLD.MonetaryAmount.t() | map(),
    optional(:loan_payment_amount) => SEO.JSONLD.MonetaryAmount.t() | map(),
    optional(:loan_payment_frequency) => number(),
    optional(:number_of_loan_payments) => number(),
    optional(:additional_type) => String.t() | URI.t(),
    optional(:alternate_name) => String.t(),
    optional(:description) => SEO.JSONLD.TextObject.t() | map() | String.t(),
    optional(:disambiguating_description) => String.t(),
    optional(:identifier) =>
      String.t() | URI.t() | SEO.JSONLD.PropertyValue.t() | map(),
    optional(:image) =>
      URI.t() | String.t() | SEO.JSONLD.ImageObject.t() | map(),
    optional(:main_entity_of_page) =>
      SEO.JSONLD.CreativeWork.t() | map() | URI.t() | String.t(),
    optional(:name) => String.t(),
    optional(:owner) =>
      SEO.JSONLD.Organization.t() | map() | SEO.JSONLD.Person.t(),
    optional(:potential_action) => SEO.JSONLD.Action.t() | map(),
    optional(:same_as) => URI.t() | String.t(),
    optional(:subject_of) =>
      SEO.JSONLD.Event.t() | map() | SEO.JSONLD.CreativeWork.t(),
    optional(:url) => URI.t() | String.t()
  }
  | [
      down_payment: number() | SEO.JSONLD.MonetaryAmount.t() | map(),
      early_prepayment_penalty: SEO.JSONLD.MonetaryAmount.t() | map(),
      loan_payment_amount: SEO.JSONLD.MonetaryAmount.t() | map(),
      loan_payment_frequency: number(),
      number_of_loan_payments: number(),
      additional_type: String.t() | URI.t(),
      alternate_name: String.t(),
      description: SEO.JSONLD.TextObject.t() | map() | String.t(),
      disambiguating_description: String.t(),
      identifier: String.t() | URI.t() | SEO.JSONLD.PropertyValue.t() | map(),
      image: URI.t() | String.t() | SEO.JSONLD.ImageObject.t() | map(),
      main_entity_of_page:
        SEO.JSONLD.CreativeWork.t() | map() | URI.t() | String.t(),
      name: String.t(),
      owner: SEO.JSONLD.Organization.t() | map() | SEO.JSONLD.Person.t(),
      potential_action: SEO.JSONLD.Action.t() | map(),
      same_as: URI.t() | String.t(),
      subject_of: SEO.JSONLD.Event.t() | map() | SEO.JSONLD.CreativeWork.t(),
      url: URI.t() | String.t()
    ]

t()

@type t() :: %{required(String.t()) => term()}

A JSON-LD map ready to be nested or rendered. String-keyed, always includes "@type" set to "RepaymentSpecification", plus any camelCased field keys the caller provided (see build/1). "@context" is added at render time by SEO.JSONLD.meta/1 on the top-level node only.

Functions

build(attrs)

@spec build(attrs()) :: t()

Build a RepaymentSpecification JSON-LD map.

Fields

  • :down_payment - a type of payment made in cash during the onset of the purchase of an expensive good/service. The payment typically represents only a percentage of the full purchase price.
  • :early_prepayment_penalty - The amount to be paid as a penalty in the event of early payment of the loan.
  • :loan_payment_amount - The amount of money to pay in a single payment.
  • :loan_payment_frequency - Frequency of payments due, i.e. number of months between payments. This is defined as a frequency, i.e. the reciprocal of a period of time.
  • :number_of_loan_payments - The number of payments contractually required at origination to repay the loan. For monthly paying loans this is the number of months from the contractual first payment date to the maturity date.

Inherited properties

Additional properties are available through the inheritance chain. See each ancestor's docs for its properties: