workarea-listrak 5.0.1

data/app/services/workarea/listrak/models/list.rb

@@ -0,0 +1,204 @@
+module Workarea
+  module Listrak
+    module Models
+      class List
+        attr_reader :hash
+
+        def initialize(hash)
+          @hash = hash
+        end
+
+        # Identifier used to locate the list.
+        #
+        # @return [Integer]
+        #
+        def id
+          hash["listId"]
+        end
+
+        # Name of the list.
+        #
+        # @return [String]
+        #
+        def name
+          hash["listName"]
+        end
+
+        # Identifier of the folder associated with the list.
+        #
+        # @return [Integer]
+        #
+        def folder_id
+          hash["folderId"]
+        end
+
+        # Identifier of the IP pool associated with the list.
+        #
+        # @return [Integer]
+        #
+        def ip_pool_id
+          hash["ipPoolId"]
+        end
+
+        # Alias domain for email bounces.
+        #
+        # @return [String]
+        #
+        def bounce_domain_alias
+          hash["bounceDomainAlias"]
+        end
+
+        # Bounce handling method for the list. Allowed values are None, Standard, and Aggressive.
+        #
+        # @return [String]
+        #
+        def bounce_handling
+          hash["bounceHandling"]
+        end
+
+        # The number of bounces that are allowed before being automatically unsubscribed.
+        #
+        # @return [Integer]
+        #
+        def bounce_unsubscribe_count
+          hash["bounceUnsubscribeCount"]
+        end
+
+        # The creation date of the list.
+        #
+        # @return [DateTime]
+        #
+        def create_date
+          DateTime.strptime(hash["createDate"], '%FT%T')
+        end
+
+        # Whether browser link is enabled.
+        #
+        # @return [Boolean]
+        #
+        def enable_browser_link
+          hash["enableBrowserLink"]
+        end
+
+        # Whether double opt-in is enabled.
+        #
+        # @return [Boolean]
+        #
+        def enable_double_opt_in
+          hash["enableDoubleOptIn"]
+        end
+
+        # Whether dynamic content is enabled.
+        #
+        # @return [Boolean]
+        #
+        def enable_dynamic_content
+          hash["enableDynamicContent"]
+        end
+
+        # Whether Google Analytics is enabled.
+        #
+        # @return [Boolean]
+        #
+        def enable_google_analytics
+          hash["enableGoogleAnalytics"]
+        end
+
+        # Whether internationalization is enabled.
+        #
+        # @return [Boolean]
+        #
+        def enable_internationalization
+          hash["enableInternationalization"]
+        end
+
+        # Whether list hygiene is enabled.
+        #
+        # @return [Boolean]
+        #
+        def enable_list_hygiene
+          hash["enableListHygiene"]
+        end
+
+        # Whether unsubscribe information is automatically included in message headers.
+        #
+        # return [Boolean]
+        #
+        def enable_list_removal_header
+          hash["enableListRemovalHeader"]
+        end
+
+        # Whether the list removal link is automatically included.
+        #
+        # @return [Boolean]
+        #
+        def enable_list_removal_link
+          hash["enableListRemovalLink"]
+        end
+
+        # Whether Listrak Analytics is enabled.
+        #
+        # @return [Boolean]
+        def enable_listrak_analytics
+          hash["enableListrakAnalytics"]
+        end
+
+        # Whether personalization is available in Spam Score.
+        #
+        # @return [Boolean]
+        #
+        def enable_spam_score_personalization
+          hash["enableSpamScorePersonalization"]
+        end
+
+        # Whether personalization is enabled for a recipient's To name.
+        #
+        # @return [Boolean]
+        #
+        def enable_to_name_personalization
+          hash["enableToNamePersonalization"]
+        end
+
+        # The From email address used by default when sending messages.
+        #
+        # @return [String]
+        #
+        def from_email
+          hash["fromEmail"]
+        end
+
+        # The From name used by default when sending messages.
+        #
+        # @return [String]
+        #
+        def from_name
+          hash["fromName"]
+        end
+
+        # Google tracking domains of the list.
+        #
+        # @return [Array<String>]
+        #
+        def google_tracking_domains
+          hash["googleTrackingDomains"]
+        end
+
+        # Alias domain for links in the list's messages.
+        #
+        # return [String]
+        #
+        def link_domain_alias
+          hash["linkDomainAlias"]
+        end
+
+        # Alias domain for media in the list's messages.
+        #
+        # @return [String]
+        #
+        def media_domain_alias
+          hash["mediaDomainAlias"]
+        end
+      end
+    end
+  end
+end

data/app/services/workarea/listrak/models/message_form.rb

@@ -0,0 +1,147 @@
+module Workarea
+  module Listrak
+    module Models
+      class MessageForm
+        attr_reader :options
+
+        def initialize(from_email:, from_name:, subject:, **options)
+          @from_email = from_email
+          @from_name = from_name
+          @subject = subject
+          @options = options.symbolize_keys
+        end
+
+        def to_json
+          {
+            campaignId: campaign_id,
+            bodyHtml: body_html,
+            bodyText: body_text,
+            codePage: code_page,
+            enablePassalong: enable_passalong,
+            enableTracking: enable_tracking,
+            fromEmail: from_email,
+            fromName: from_name,
+            googleAnalyticsCampaignName: google_analytics_campaign_name,
+            googleAnalyticsCampaignContent: google_analytics_campaign_content,
+            replyEmail: reply_email,
+            savedAudienceId: save_audience_id,
+            subject: subject,
+            toName: to_name
+          }.compact.to_json
+        end
+
+        # Identifier of the campaign associated with the message.
+        #
+        # @return [Integer]
+        #
+        def campaign_id
+          options[:campaign_id]
+        end
+
+        # HTML body that will be sent in the message.
+        #
+        # @return [String]
+        #
+        def body_html
+          options[:body_html]
+        end
+
+        # Text body that will be sent in the message.
+        #
+        # @return [String]
+        #
+        def body_text
+          options[:body_text]
+        end
+
+        # Type of CodePage used in the message.
+        #
+        # @return [Integer]
+        #
+        def code_page
+          options[:code_page]
+        end
+
+        # Whether passalong is enabled.
+        #
+        # @return [Boolean]
+        #
+        def enable_passalong
+          options[:enable_passalong]
+        end
+
+        # Whether tracking is enabled.
+        #
+        # @return [Boolean]
+        #
+        def enable_tracking
+          options[:enable_tracking]
+        end
+
+        # The from email address that will be used for the message.
+        #
+        # @return [String]
+        #
+        def from_email
+          @from_email
+        end
+
+        # The from name that will be used for the message.
+        #
+        # @return [String]
+        #
+        def from_name
+          @from_name
+        end
+
+        # The Google Analytics campaign name to be used for message tracking.
+        #
+        # @return [String]
+        #
+        def google_analytics_campaign_name
+          options[:google_analytics_campaign_name]
+        end
+
+        # The Google Analytics campaign content to be used for message tracking.
+        #
+        # @return [String]
+        #
+        def google_analytics_campaign_content
+          options[:google_analytics_campaign_content]
+        end
+
+        # The reply email address that will be used for the message.
+        #
+        # @return [String]
+        #
+        def reply_email
+          options[:reply_email]
+        end
+
+        # Identifier of the SavedAudience to use for recipient filtering.
+        #
+        # @return [Integer]
+        #
+        def save_audience_id
+          options[:save_audience_id]
+        end
+
+        # Subject of the message.
+        #
+        # @return [String]
+        #
+        def subject
+          @subject
+        end
+
+        # The to name that will be used for the message.
+        #
+        # @return [String]
+        #
+        def to_name
+          options[:to_name]
+        end
+      end
+    end
+  end
+end

data/app/services/workarea/listrak/models/order_form.rb

@@ -0,0 +1,352 @@
+module Workarea
+  module Listrak
+    module Models
+      class OrderForm
+        attr_reader :order
+
+        def initialize(order)
+          @order = order
+        end
+
+        def as_json(_options)
+          {
+            associateID: associate_id,
+            billingAddress: billing_address,
+            couponCode: coupon_code,
+            customerNumber: customer_number,
+            dateEntered: date_entered,
+            discountTotal: discount_total,
+            email: email,
+            handlingTotal: handling_total,
+            items: items,
+            itemTotal: item_total,
+            merchandiseDiscount: merchandise_discount,
+            merchandiseDiscountDescription: merchandise_discount_description,
+            merchandiseDiscountType: merchandise_discount_type,
+            meta1: meta1,
+            meta2: meta2,
+            meta3: meta3,
+            meta4: meta4,
+            meta5: meta5,
+            nonMerchandiseDiscount: non_merchandise_discount,
+            nonMerchandiseDiscountDescription: non_merchandise_discount_description,
+            nonMerchandiseDiscountType: non_merchandise_discount_type,
+            orderNumber: order_number,
+            orderTotal: order_total,
+            shipDate: ship_date,
+            shippingAddress: shipping_address,
+            shippingMethod: shipping_method,
+            shippingTotal: shipping_total,
+            source: source,
+            status: status,
+            storeNumber: store_number,
+            taxTotal: tax_total,
+            trackingNumber: tracking_number
+          }
+        end
+
+        # Associate ID of order
+        #
+        # @return [String]
+        def associate_id
+        end
+
+        # Billing address of order
+        #
+        # @return [Workarea::Listrak::Models::Address]
+        #
+        def billing_address
+          Workarea::Listrak::Models::Address.new payment.address
+        end
+
+        # Coupon code used with order
+        #
+        # limited to 32 characters
+        #
+        # @return [String]
+        #
+        def coupon_code
+          order.promo_codes.first
+        end
+
+        # Internal customer number
+        #
+        # limited to 20 characters
+        #
+        # @return [String]
+        #
+        def customer_number
+          order.user_id.to_s
+        end
+
+        # Timestamp of order date (ET)
+        #
+        # @return [String] DateTime in %FT%TZ
+        #
+        def date_entered
+          order.placed_at.strftime '%FT%TZ'
+        end
+
+        # Total value of order discount
+        #
+        # @return [Float]
+        #
+        def discount_total
+          order.price_adjustments
+            .select { |pa| pa.data['discount_value'].present? && pa.price != 'item' }
+            .sum { |d| d.data['discount_value'] }
+            .abs
+            .try(:to_f)
+        end
+
+        # Email address of customer. This property is required for
+        # accounts that are not CRM enabled.
+        #
+        # limited to 100 characters
+        #
+        # @return [String]
+        #
+        def email
+          order.email
+        end
+
+        # Total handling costs
+        #
+        # @return [Float]
+        #
+        def handling_total
+          shipping.shipping_total.to_f
+        end
+
+        # Order items
+        #
+        # @return [Array<Workarea::Listrak::Models::OrderItem>]
+        #
+        def items
+          @order_items ||= order.items.map do |order_item|
+            Workarea::Listrak::Models::OrderItem.new order, order_item
+          end
+        end
+
+        # Total cost of items ordered (subtotal)
+        #
+        # @return [Float]
+        #
+        def item_total
+          order.subtotal_price.to_f
+        end
+
+        # Discount applied to the merchandise of the order
+        #
+        # @return [Float]
+        #
+        def merchandise_discount
+          order.price_adjustments
+            .select { |pa| pa.data['discount_value'].present? && pa.price == 'item' }
+            .sum { |d| d.data['discount_value'] }
+            .abs
+            .try(:to_f)
+        end
+
+        # Description of the discount applied to the merchandise of the order
+        #
+        # @return [String]
+        #
+        def merchandise_discount_description
+        end
+
+        # Type of discount applied to the merchandise of the order
+        #
+        # "NotSet" "PriceOverride" "PriceRule" "Promotion" "SeniorCitizen" "Markdown" "Coupon" "QuantityDiscount" "Rebate" "CashDiscount" "TradeDiscount" "TradeInKind" "PromptPaymentDiscount" "GeneralDiscount" "GiftVoucher" "FlexibleDiscount" "RewardProgram" "ManufacturerReward" "CreditCardReward"
+        #
+        # @return [String]
+        #
+        def merchandise_discount_type
+        end
+
+        # Additional meta information
+        #
+        # limited to 500 characters
+        #
+        # @return [String]
+        #
+        def meta1
+        end
+
+        # Additional meta information
+        #
+        # limted to 500 characters
+        #
+        # @return [String]
+        #
+        def meta2
+        end
+
+        # Additional meta information
+        #
+        # limted to 500 characters
+        #
+        # @return [String]
+        #
+        def meta3
+        end
+
+        # Additional meta information
+        #
+        # limted to 500 characters
+        #
+        # @return [String]
+        #
+        def meta4
+        end
+
+        # Additional meta information
+        #
+        # limted to 500 characters
+        #
+        # @return [String]
+        #
+        def meta5
+        end
+
+        # Discounts applied to the order that is not related to the merchandise
+        #
+        # @return [Float]
+        #
+        def non_merchandise_discount
+        end
+
+        # Description of the discount applied to the order not related to the merchandise
+        #
+        # @return [String]
+        #
+        def non_merchandise_discount_description
+        end
+
+        # Type of discount applied to the order not related to the merchandise
+        #
+        # "NotSet" "PriceOverride" "PriceRule" "Promotion" "SeniorCitizen" "Markdown" "Coupon" "QuantityDiscount" "Rebate" "CashDiscount" "TradeDiscount" "TradeInKind" "PromptPaymentDiscount" "GeneralDiscount" "GiftVoucher" "FlexibleDiscount" "RewardProgram" "ManufacturerReward" "CreditCardReward"
+        #
+        # @return [String]
+        #
+        def non_merchandise_discount_type
+        end
+
+        # Unique order number
+        #
+        # limited to 50 characters
+        #
+        # @return [String]
+        #
+        def order_number
+          order.id.to_s
+        end
+
+        # Total value of order
+        #
+        # return [Float]
+        #
+        def order_total
+          order.total_value.to_f
+        end
+
+        # Timestamp when entire order shipped (ET)
+        #
+        # @return [String]
+        #
+        def ship_date
+        end
+
+        # Shipping address of order
+        #
+        # @return [Workarea::Listrak::Models::Address]
+        #
+        def shipping_address
+          Workarea::Listrak::Models::Address.new shipping.address
+        end
+
+        # Shipping method (e.g. UPS Ground)
+        #
+        # limted to 32 characters
+        #
+        # @return [String]
+        #
+        def shipping_method
+          shipping.shipping_service&.name
+        end
+
+        # Total shipping costs
+        #
+        # @return [Float]
+        #
+        def shipping_total
+          order.shipping_total.to_f
+        end
+
+        # Describes the source at which the order was placed (online, POS, etc.)
+        #
+        # limted to 25 characters
+        #
+        # @return [String]
+        #
+        def source
+          'web'
+        end
+
+        # Status indicator
+        #
+        # "NotSet" "Misc" "PreOrder" "BackOrder" "Pending" "Hold" "Processing" "Shipped" "Completed" "Returned" "Canceled" "Unknown" "Closed"
+        #
+        # @return [String]
+        #
+        def status
+          order.status
+        end
+
+        # Brick and mortar store location
+        #
+        # limited to 100 characters
+        #
+        # @return [String]
+        #
+        def store_number
+        end
+
+        # Total sales tax charged
+        #
+        # @return [Float]
+        #
+        def tax_total
+          order.tax_total.to_f
+        end
+
+        # Shipment tracking number
+        #
+        # limited to 32 characters
+        #
+        # @return [String]
+        #
+        def tracking_number
+        end
+
+        private
+
+          def payment
+            @payment ||= Workarea::Payment.find order.id
+          end
+
+          def fulfillment
+            @fulfillment ||= Workarea::Fulfillment.find order.id
+          end
+
+          def shippings
+            @shippings ||= Workarea::Shipping.by_order(order.id).to_a
+          end
+
+          def shipping
+            shippings.first
+          end
+      end
+    end
+  end
+end