Siftsciex

v0.5.0

Siftsciex v0.5.0 Siftsciex.Event.Payload.Listing View Source

This represents a $listing object for Sift Science

Link to this section Summary

Types

data()
string_attr()
t()

Functions

new(listing)

Creates a new listing record for a Sift Science Event payload

Link to this section Types

Link to this type data() View Source 
data() :: %{
  optional(string_attr()) => String.t(),
  optional(:contact_address) => Siftsciex.Event.Payload.Address.data(),
  optional(:locations) => [Siftsciex.Event.Payload.Address.data()],
  optional(:listed_items) => [Siftsciex.Event.Payload.Item.data()],
  optional(:images) => [Siftsciex.Event.Payload.Image.data()],
  optional(:expiration_time) =>
    Siftsciex.Event.Payload.payload_int() | DateTime.t()
}
Link to this type string_attr() View Source 
string_attr() :: :subject | :body
Link to this type t() View Source 
t() :: %Siftsciex.Event.Payload.Listing{
  "$body": Siftsciex.Event.Payload.payload_string(),
  "$contact_address": :empty | Siftsciex.Event.Payload.Address.t(),
  "$contact_email": term(),
  "$expiration_time": Siftsciex.Event.Payload.payload_int(),
  "$images": :empty | [Siftsciex.Event.Payload.Image.t()],
  "$listed_items": :empty | [Siftsciex.Event.Payload.Item.t()],
  "$locations": :empty | [Siftsciex.Event.Payload.Address.t()],
  "$subject": Siftsciex.Event.Payload.payload_string()
}

Link to this section Functions

Link to this function new(listing) View Source 
new(data()) :: Siftsciex.Event.Payload.Listing.t()

Creates a new listing record for a Sift Science Event payload.

Parameters

Examples 

iex> Listing.new(%{subject: "Midterm"})
%Listing{"$subject": "Midterm"}

iex> Listing.new(%{locations: [%{city: "Albuquerque"}]})
%Listing{"$locations": [%Siftsciex.Event.Payload.Address{"$city": "Albuquerque"}]}

iex> Listing.new(%{listed_items: [%{item_id: "8", quantity: 1}, %{item_id: "1", quantity: 33}]})
%Listing{"$listed_items": [%Siftsciex.Event.Payload.Item{"$item_id": "8", "$quantity": 1}, %Siftsciex.Event.Payload.Item{"$item_id": "1", "$quantity": 33}]}