ultracart_api 3.1.14 → 3.1.37

data/lib/ultracart_api/models/email_flow.rb

@@ -35,9 +35,12 @@ module UltracartClient
     # Email flow UUID
     attr_accessor :email_flow_uuid
 
-    # True if the customer should end the flow once they purchase
+    # True if the customer should end the flow once they purchase from an email on this flow
     attr_accessor :end_once_customer_purchases
 
+    # True if the customer should end the flow once they purchase from any source
+    attr_accessor :end_once_customer_purchases_anywhere
+
     # Number of enrolled customers.
     attr_accessor :enrolled_customers
 
@@ -106,6 +109,7 @@ module UltracartClient
         :'email_communication_sequence_uuid' => :'email_communication_sequence_uuid',
         :'email_flow_uuid' => :'email_flow_uuid',
         :'end_once_customer_purchases' => :'end_once_customer_purchases',
+        :'end_once_customer_purchases_anywhere' => :'end_once_customer_purchases_anywhere',
         :'enrolled_customers' => :'enrolled_customers',
         :'esp_domain_user' => :'esp_domain_user',
         :'esp_domain_uuid' => :'esp_domain_uuid',
@@ -139,6 +143,7 @@ module UltracartClient
         :'email_communication_sequence_uuid' => :'String',
         :'email_flow_uuid' => :'String',
         :'end_once_customer_purchases' => :'BOOLEAN',
+        :'end_once_customer_purchases_anywhere' => :'BOOLEAN',
         :'enrolled_customers' => :'Integer',
         :'esp_domain_user' => :'String',
         :'esp_domain_uuid' => :'String',
@@ -201,6 +206,10 @@ module UltracartClient
         self.end_once_customer_purchases = attributes[:'end_once_customer_purchases']
       end
 
+      if attributes.has_key?(:'end_once_customer_purchases_anywhere')
+        self.end_once_customer_purchases_anywhere = attributes[:'end_once_customer_purchases_anywhere']
+      end
+
       if attributes.has_key?(:'enrolled_customers')
         self.enrolled_customers = attributes[:'enrolled_customers']
       end
@@ -319,6 +328,7 @@ module UltracartClient
           email_communication_sequence_uuid == o.email_communication_sequence_uuid &&
           email_flow_uuid == o.email_flow_uuid &&
           end_once_customer_purchases == o.end_once_customer_purchases &&
+          end_once_customer_purchases_anywhere == o.end_once_customer_purchases_anywhere &&
           enrolled_customers == o.enrolled_customers &&
           esp_domain_user == o.esp_domain_user &&
           esp_domain_uuid == o.esp_domain_uuid &&
@@ -349,7 +359,7 @@ module UltracartClient
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [allow_multiple_concurrent_enrollments, back_populating, click_rate_formatted, created_dts, deleted, email_communication_sequence_uuid, email_flow_uuid, end_once_customer_purchases, enrolled_customers, esp_domain_user, esp_domain_uuid, esp_flow_folder_uuid, esp_friendly_name, filter_profile_equation_json, library_item_oid, merchant_id, name, open_rate_formatted, revenue_formatted, revenue_per_customer_formatted, screenshot_large_full_url, status, status_dts, storefront_oid, trigger_parameter, trigger_parameter_name, trigger_type].hash
+      [allow_multiple_concurrent_enrollments, back_populating, click_rate_formatted, created_dts, deleted, email_communication_sequence_uuid, email_flow_uuid, end_once_customer_purchases, end_once_customer_purchases_anywhere, enrolled_customers, esp_domain_user, esp_domain_uuid, esp_flow_folder_uuid, esp_friendly_name, filter_profile_equation_json, library_item_oid, merchant_id, name, open_rate_formatted, revenue_formatted, revenue_per_customer_formatted, screenshot_large_full_url, status, status_dts, storefront_oid, trigger_parameter, trigger_parameter_name, trigger_type].hash
     end
 
     # Builds the object from hash

data/lib/ultracart_api/models/library_item_attribute.rb

@@ -14,8 +14,6 @@ require 'date'
 
 module UltracartClient
   class LibraryItemAttribute
-    attr_accessor :library_item_oid
-
     attr_accessor :name
 
     attr_accessor :value
@@ -23,7 +21,6 @@ module UltracartClient
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
-        :'library_item_oid' => :'libraryItemOid',
         :'name' => :'name',
         :'value' => :'value'
       }
@@ -32,7 +29,6 @@ module UltracartClient
     # Attribute type mapping.
     def self.swagger_types
       {
-        :'library_item_oid' => :'Integer',
         :'name' => :'String',
         :'value' => :'String'
       }
@@ -46,10 +42,6 @@ module UltracartClient
       # convert string to symbol for hash key
       attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }
 
-      if attributes.has_key?(:'libraryItemOid')
-        self.library_item_oid = attributes[:'libraryItemOid']
-      end
-
       if attributes.has_key?(:'name')
         self.name = attributes[:'name']
       end
@@ -77,7 +69,6 @@ module UltracartClient
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
-          library_item_oid == o.library_item_oid &&
           name == o.name &&
           value == o.value
     end
@@ -91,7 +82,7 @@ module UltracartClient
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [library_item_oid, name, value].hash
+      [name, value].hash
     end
 
     # Builds the object from hash

data/lib/ultracart_api/models/order_process_payment_request.rb

@@ -14,12 +14,16 @@ require 'date'
 
 module UltracartClient
   class OrderProcessPaymentRequest
+    # Specific amount to bill (optional).  If not specified the total of the order is billed.
+    attr_accessor :amount
+
     # Card verification number token from hosted fields used during credit card transaction processing (optional)
     attr_accessor :card_verification_number_token
 
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
+        :'amount' => :'amount',
         :'card_verification_number_token' => :'card_verification_number_token'
       }
     end
@@ -27,6 +31,7 @@ module UltracartClient
     # Attribute type mapping.
     def self.swagger_types
       {
+        :'amount' => :'Float',
         :'card_verification_number_token' => :'String'
       }
     end
@@ -39,6 +44,10 @@ module UltracartClient
       # convert string to symbol for hash key
       attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }
 
+      if attributes.has_key?(:'amount')
+        self.amount = attributes[:'amount']
+      end
+
       if attributes.has_key?(:'card_verification_number_token')
         self.card_verification_number_token = attributes[:'card_verification_number_token']
       end
@@ -62,6 +71,7 @@ module UltracartClient
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
+          amount == o.amount &&
           card_verification_number_token == o.card_verification_number_token
     end
 
@@ -74,7 +84,7 @@ module UltracartClient
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [card_verification_number_token].hash
+      [amount, card_verification_number_token].hash
     end
 
     # Builds the object from hash

data/lib/ultracart_api/models/order_query.rb

@@ -110,12 +110,18 @@ module UltracartClient
     # Screen branding theme code associated with the order (legacy checkout)
     attr_accessor :screen_branding_theme_code
 
-    # Date/time that the order was shipping
+    # Date/time that the order was shipped
     attr_accessor :shipment_date_begin
 
     # Date/time that the order was shipped
     attr_accessor :shipment_date_end
 
+    # Date/time that the order should ship on
+    attr_accessor :shipped_on_date_begin
+
+    # Date/time that the order should ship on
+    attr_accessor :shipped_on_date_end
+
     # State for United States otherwise region or province for other countries
     attr_accessor :state_region
 
@@ -184,6 +190,8 @@ module UltracartClient
         :'screen_branding_theme_code' => :'screen_branding_theme_code',
         :'shipment_date_begin' => :'shipment_date_begin',
         :'shipment_date_end' => :'shipment_date_end',
+        :'shipped_on_date_begin' => :'shipped_on_date_begin',
+        :'shipped_on_date_end' => :'shipped_on_date_end',
         :'state_region' => :'state_region',
         :'storefront_host_name' => :'storefront_host_name',
         :'total' => :'total'
@@ -227,6 +235,8 @@ module UltracartClient
         :'screen_branding_theme_code' => :'String',
         :'shipment_date_begin' => :'String',
         :'shipment_date_end' => :'String',
+        :'shipped_on_date_begin' => :'String',
+        :'shipped_on_date_end' => :'String',
         :'state_region' => :'String',
         :'storefront_host_name' => :'String',
         :'total' => :'Float'
@@ -377,6 +387,14 @@ module UltracartClient
         self.shipment_date_end = attributes[:'shipment_date_end']
       end
 
+      if attributes.has_key?(:'shipped_on_date_begin')
+        self.shipped_on_date_begin = attributes[:'shipped_on_date_begin']
+      end
+
+      if attributes.has_key?(:'shipped_on_date_end')
+        self.shipped_on_date_end = attributes[:'shipped_on_date_end']
+      end
+
       if attributes.has_key?(:'state_region')
         self.state_region = attributes[:'state_region']
       end
@@ -646,6 +664,8 @@ module UltracartClient
           screen_branding_theme_code == o.screen_branding_theme_code &&
           shipment_date_begin == o.shipment_date_begin &&
           shipment_date_end == o.shipment_date_end &&
+          shipped_on_date_begin == o.shipped_on_date_begin &&
+          shipped_on_date_end == o.shipped_on_date_end &&
           state_region == o.state_region &&
           storefront_host_name == o.storefront_host_name &&
           total == o.total
@@ -660,7 +680,7 @@ module UltracartClient
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [cc_email, channel_partner_code, channel_partner_order_id, city, company, country_code, creation_date_begin, creation_date_end, current_stage, custom_field_1, custom_field_2, custom_field_3, custom_field_4, custom_field_5, custom_field_6, custom_field_7, customer_profile_oid, email, first_name, item_id, last_name, order_id, payment_date_begin, payment_date_end, payment_method, phone, postal_code, purchase_order_number, refund_date_begin, refund_date_end, rma, screen_branding_theme_code, shipment_date_begin, shipment_date_end, state_region, storefront_host_name, total].hash
+      [cc_email, channel_partner_code, channel_partner_order_id, city, company, country_code, creation_date_begin, creation_date_end, current_stage, custom_field_1, custom_field_2, custom_field_3, custom_field_4, custom_field_5, custom_field_6, custom_field_7, customer_profile_oid, email, first_name, item_id, last_name, order_id, payment_date_begin, payment_date_end, payment_method, phone, postal_code, purchase_order_number, refund_date_begin, refund_date_end, rma, screen_branding_theme_code, shipment_date_begin, shipment_date_end, shipped_on_date_begin, shipped_on_date_end, state_region, storefront_host_name, total].hash
     end
 
     # Builds the object from hash

data/lib/ultracart_api/models/screen_recording.rb

@@ -14,14 +14,36 @@ require 'date'
 
 module UltracartClient
   class ScreenRecording
+    attr_accessor :ad_platform
+
     attr_accessor :analytics_client_oid
 
     attr_accessor :analytics_session_dts
 
     attr_accessor :analytics_session_oid
 
+    # Campaign Name
+    attr_accessor :communications_campaign_name
+
+    # Campaign UUID
+    attr_accessor :communications_campaign_uuid
+
+    # Email subject
+    attr_accessor :communications_email_subject
+
+    # Email UUID
+    attr_accessor :communications_email_uuid
+
+    # Flow Name
+    attr_accessor :communications_flow_name
+
+    # Flow UUID
+    attr_accessor :communications_flow_uuid
+
     attr_accessor :email
 
+    attr_accessor :email_domain
+
     # Ending timestamp
     attr_accessor :end_timestamp
 
@@ -43,6 +65,9 @@ module UltracartClient
 
     attr_accessor :geolocation_state
 
+    # Language ISO code
+    attr_accessor :language_iso_code
+
     attr_accessor :merchant_id
 
     attr_accessor :merchant_notes
@@ -53,6 +78,11 @@ module UltracartClient
 
     attr_accessor :page_views
 
+    # ISO 3 Letter language code that the customer would prefer
+    attr_accessor :preferred_language
+
+    attr_accessor :referrer_domain
+
     attr_accessor :rrweb_version
 
     attr_accessor :screen_recording_uuid
@@ -80,6 +110,12 @@ module UltracartClient
 
     attr_accessor :user_properties
 
+    # UTM Campaign
+    attr_accessor :utm_campaign
+
+    # UTM Source
+    attr_accessor :utm_source
+
     # Timestamp this visitor was first seen
     attr_accessor :visitor_first_seen
 
@@ -94,10 +130,18 @@ module UltracartClient
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
+        :'ad_platform' => :'ad_platform',
         :'analytics_client_oid' => :'analytics_client_oid',
         :'analytics_session_dts' => :'analytics_session_dts',
         :'analytics_session_oid' => :'analytics_session_oid',
+        :'communications_campaign_name' => :'communications_campaign_name',
+        :'communications_campaign_uuid' => :'communications_campaign_uuid',
+        :'communications_email_subject' => :'communications_email_subject',
+        :'communications_email_uuid' => :'communications_email_uuid',
+        :'communications_flow_name' => :'communications_flow_name',
+        :'communications_flow_uuid' => :'communications_flow_uuid',
         :'email' => :'email',
+        :'email_domain' => :'email_domain',
         :'end_timestamp' => :'end_timestamp',
         :'esp_customer_uuid' => :'esp_customer_uuid',
         :'events_gz_size' => :'events_gz_size',
@@ -107,11 +151,14 @@ module UltracartClient
         :'geolocation' => :'geolocation',
         :'geolocation_country' => :'geolocation_country',
         :'geolocation_state' => :'geolocation_state',
+        :'language_iso_code' => :'language_iso_code',
         :'merchant_id' => :'merchant_id',
         :'merchant_notes' => :'merchant_notes',
         :'order_id' => :'order_id',
         :'page_view_count' => :'page_view_count',
         :'page_views' => :'page_views',
+        :'preferred_language' => :'preferred_language',
+        :'referrer_domain' => :'referrer_domain',
         :'rrweb_version' => :'rrweb_version',
         :'screen_recording_uuid' => :'screen_recording_uuid',
         :'signed_download_url' => :'signed_download_url',
@@ -125,6 +172,8 @@ module UltracartClient
         :'user_agent_raw' => :'user_agent_raw',
         :'user_ip' => :'user_ip',
         :'user_properties' => :'user_properties',
+        :'utm_campaign' => :'utm_campaign',
+        :'utm_source' => :'utm_source',
         :'visitor_first_seen' => :'visitor_first_seen',
         :'visitor_number' => :'visitor_number',
         :'watched' => :'watched',
@@ -136,10 +185,18 @@ module UltracartClient
     # Attribute type mapping.
     def self.swagger_types
       {
+        :'ad_platform' => :'ScreenRecordingAdPlatform',
         :'analytics_client_oid' => :'Integer',
         :'analytics_session_dts' => :'Integer',
         :'analytics_session_oid' => :'Integer',
+        :'communications_campaign_name' => :'String',
+        :'communications_campaign_uuid' => :'String',
+        :'communications_email_subject' => :'String',
+        :'communications_email_uuid' => :'String',
+        :'communications_flow_name' => :'String',
+        :'communications_flow_uuid' => :'String',
         :'email' => :'String',
+        :'email_domain' => :'String',
         :'end_timestamp' => :'String',
         :'esp_customer_uuid' => :'String',
         :'events_gz_size' => :'Integer',
@@ -149,11 +206,14 @@ module UltracartClient
         :'geolocation' => :'GeoPoint',
         :'geolocation_country' => :'String',
         :'geolocation_state' => :'String',
+        :'language_iso_code' => :'String',
         :'merchant_id' => :'String',
         :'merchant_notes' => :'String',
         :'order_id' => :'String',
         :'page_view_count' => :'Integer',
         :'page_views' => :'Array<ScreenRecordingPageView>',
+        :'preferred_language' => :'String',
+        :'referrer_domain' => :'String',
         :'rrweb_version' => :'String',
         :'screen_recording_uuid' => :'String',
         :'signed_download_url' => :'String',
@@ -167,6 +227,8 @@ module UltracartClient
         :'user_agent_raw' => :'String',
         :'user_ip' => :'String',
         :'user_properties' => :'Array<ScreenRecordingUserProperty>',
+        :'utm_campaign' => :'String',
+        :'utm_source' => :'String',
         :'visitor_first_seen' => :'String',
         :'visitor_number' => :'Integer',
         :'watched' => :'BOOLEAN',
@@ -183,6 +245,10 @@ module UltracartClient
       # convert string to symbol for hash key
       attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }
 
+      if attributes.has_key?(:'ad_platform')
+        self.ad_platform = attributes[:'ad_platform']
+      end
+
       if attributes.has_key?(:'analytics_client_oid')
         self.analytics_client_oid = attributes[:'analytics_client_oid']
       end
@@ -195,10 +261,38 @@ module UltracartClient
         self.analytics_session_oid = attributes[:'analytics_session_oid']
       end
 
+      if attributes.has_key?(:'communications_campaign_name')
+        self.communications_campaign_name = attributes[:'communications_campaign_name']
+      end
+
+      if attributes.has_key?(:'communications_campaign_uuid')
+        self.communications_campaign_uuid = attributes[:'communications_campaign_uuid']
+      end
+
+      if attributes.has_key?(:'communications_email_subject')
+        self.communications_email_subject = attributes[:'communications_email_subject']
+      end
+
+      if attributes.has_key?(:'communications_email_uuid')
+        self.communications_email_uuid = attributes[:'communications_email_uuid']
+      end
+
+      if attributes.has_key?(:'communications_flow_name')
+        self.communications_flow_name = attributes[:'communications_flow_name']
+      end
+
+      if attributes.has_key?(:'communications_flow_uuid')
+        self.communications_flow_uuid = attributes[:'communications_flow_uuid']
+      end
+
       if attributes.has_key?(:'email')
         self.email = attributes[:'email']
       end
 
+      if attributes.has_key?(:'email_domain')
+        self.email_domain = attributes[:'email_domain']
+      end
+
       if attributes.has_key?(:'end_timestamp')
         self.end_timestamp = attributes[:'end_timestamp']
       end
@@ -237,6 +331,10 @@ module UltracartClient
         self.geolocation_state = attributes[:'geolocation_state']
       end
 
+      if attributes.has_key?(:'language_iso_code')
+        self.language_iso_code = attributes[:'language_iso_code']
+      end
+
       if attributes.has_key?(:'merchant_id')
         self.merchant_id = attributes[:'merchant_id']
       end
@@ -259,6 +357,14 @@ module UltracartClient
         end
       end
 
+      if attributes.has_key?(:'preferred_language')
+        self.preferred_language = attributes[:'preferred_language']
+      end
+
+      if attributes.has_key?(:'referrer_domain')
+        self.referrer_domain = attributes[:'referrer_domain']
+      end
+
       if attributes.has_key?(:'rrweb_version')
         self.rrweb_version = attributes[:'rrweb_version']
       end
@@ -319,6 +425,14 @@ module UltracartClient
         end
       end
 
+      if attributes.has_key?(:'utm_campaign')
+        self.utm_campaign = attributes[:'utm_campaign']
+      end
+
+      if attributes.has_key?(:'utm_source')
+        self.utm_source = attributes[:'utm_source']
+      end
+
       if attributes.has_key?(:'visitor_first_seen')
         self.visitor_first_seen = attributes[:'visitor_first_seen']
       end
@@ -358,10 +472,18 @@ module UltracartClient
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
+          ad_platform == o.ad_platform &&
           analytics_client_oid == o.analytics_client_oid &&
           analytics_session_dts == o.analytics_session_dts &&
           analytics_session_oid == o.analytics_session_oid &&
+          communications_campaign_name == o.communications_campaign_name &&
+          communications_campaign_uuid == o.communications_campaign_uuid &&
+          communications_email_subject == o.communications_email_subject &&
+          communications_email_uuid == o.communications_email_uuid &&
+          communications_flow_name == o.communications_flow_name &&
+          communications_flow_uuid == o.communications_flow_uuid &&
           email == o.email &&
+          email_domain == o.email_domain &&
           end_timestamp == o.end_timestamp &&
           esp_customer_uuid == o.esp_customer_uuid &&
           events_gz_size == o.events_gz_size &&
@@ -371,11 +493,14 @@ module UltracartClient
           geolocation == o.geolocation &&
           geolocation_country == o.geolocation_country &&
           geolocation_state == o.geolocation_state &&
+          language_iso_code == o.language_iso_code &&
           merchant_id == o.merchant_id &&
           merchant_notes == o.merchant_notes &&
           order_id == o.order_id &&
           page_view_count == o.page_view_count &&
           page_views == o.page_views &&
+          preferred_language == o.preferred_language &&
+          referrer_domain == o.referrer_domain &&
           rrweb_version == o.rrweb_version &&
           screen_recording_uuid == o.screen_recording_uuid &&
           signed_download_url == o.signed_download_url &&
@@ -389,6 +514,8 @@ module UltracartClient
           user_agent_raw == o.user_agent_raw &&
           user_ip == o.user_ip &&
           user_properties == o.user_properties &&
+          utm_campaign == o.utm_campaign &&
+          utm_source == o.utm_source &&
           visitor_first_seen == o.visitor_first_seen &&
           visitor_number == o.visitor_number &&
           watched == o.watched &&
@@ -405,7 +532,7 @@ module UltracartClient
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [analytics_client_oid, analytics_session_dts, analytics_session_oid, email, end_timestamp, esp_customer_uuid, events_gz_size, events_json_key, favorite, favorites, geolocation, geolocation_country, geolocation_state, merchant_id, merchant_notes, order_id, page_view_count, page_views, rrweb_version, screen_recording_uuid, signed_download_url, start_timestamp, storefront_oids, storefronts, tags, time_on_site, ucacid, user_agent, user_agent_raw, user_ip, user_properties, visitor_first_seen, visitor_number, watched, window_height, window_width].hash
+      [ad_platform, analytics_client_oid, analytics_session_dts, analytics_session_oid, communications_campaign_name, communications_campaign_uuid, communications_email_subject, communications_email_uuid, communications_flow_name, communications_flow_uuid, email, email_domain, end_timestamp, esp_customer_uuid, events_gz_size, events_json_key, favorite, favorites, geolocation, geolocation_country, geolocation_state, language_iso_code, merchant_id, merchant_notes, order_id, page_view_count, page_views, preferred_language, referrer_domain, rrweb_version, screen_recording_uuid, signed_download_url, start_timestamp, storefront_oids, storefronts, tags, time_on_site, ucacid, user_agent, user_agent_raw, user_ip, user_properties, utm_campaign, utm_source, visitor_first_seen, visitor_number, watched, window_height, window_width].hash
     end
 
     # Builds the object from hash