ultracart_api 3.9.1 → 3.9.4

data/lib/ultracart_api/models/customer_loyalty.rb

@@ -17,6 +17,12 @@ module UltracartClient
     # Current Points
     attr_accessor :current_points
 
+    # Loyalty Cashback / Store credit balance (internal gift certificate balance)
+    attr_accessor :internal_gift_certificate_balance
+
+    # Internal gift certificate oid used to tracking loyalty cashback / store credit.
+    attr_accessor :internal_gift_certificate_oid
+
     # Ledger entries
     attr_accessor :ledger_entries
 
@@ -30,6 +36,8 @@ module UltracartClient
     def self.attribute_map
       {
         :'current_points' => :'current_points',
+        :'internal_gift_certificate_balance' => :'internal_gift_certificate_balance',
+        :'internal_gift_certificate_oid' => :'internal_gift_certificate_oid',
         :'ledger_entries' => :'ledger_entries',
         :'pending_points' => :'pending_points',
         :'redemptions' => :'redemptions'
@@ -40,6 +48,8 @@ module UltracartClient
     def self.swagger_types
       {
         :'current_points' => :'Integer',
+        :'internal_gift_certificate_balance' => :'String',
+        :'internal_gift_certificate_oid' => :'Integer',
         :'ledger_entries' => :'Array<CustomerLoyaltyLedger>',
         :'pending_points' => :'Integer',
         :'redemptions' => :'Array<CustomerLoyaltyRedemption>'
@@ -58,6 +68,14 @@ module UltracartClient
         self.current_points = attributes[:'current_points']
       end
 
+      if attributes.has_key?(:'internal_gift_certificate_balance')
+        self.internal_gift_certificate_balance = attributes[:'internal_gift_certificate_balance']
+      end
+
+      if attributes.has_key?(:'internal_gift_certificate_oid')
+        self.internal_gift_certificate_oid = attributes[:'internal_gift_certificate_oid']
+      end
+
       if attributes.has_key?(:'ledger_entries')
         if (value = attributes[:'ledger_entries']).is_a?(Array)
           self.ledger_entries = value
@@ -94,6 +112,8 @@ module UltracartClient
       return true if self.equal?(o)
       self.class == o.class &&
           current_points == o.current_points &&
+          internal_gift_certificate_balance == o.internal_gift_certificate_balance &&
+          internal_gift_certificate_oid == o.internal_gift_certificate_oid &&
           ledger_entries == o.ledger_entries &&
           pending_points == o.pending_points &&
           redemptions == o.redemptions
@@ -108,7 +128,7 @@ module UltracartClient
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [current_points, ledger_entries, pending_points, redemptions].hash
+      [current_points, internal_gift_certificate_balance, internal_gift_certificate_oid, ledger_entries, pending_points, redemptions].hash
     end
 
     # Builds the object from hash

data/lib/ultracart_api/models/customer_tag.rb

@@ -48,8 +48,8 @@ module UltracartClient
     # @return Array for valid properties with the reasons
     def list_invalid_properties
       invalid_properties = Array.new
-      if !@tag_value.nil? && @tag_value.to_s.length > 100
-        invalid_properties.push('invalid value for "tag_value", the character length must be smaller than or equal to 100.')
+      if !@tag_value.nil? && @tag_value.to_s.length > 250
+        invalid_properties.push('invalid value for "tag_value", the character length must be smaller than or equal to 250.')
       end
 
       invalid_properties
@@ -58,15 +58,15 @@ module UltracartClient
     # Check to see if the all the properties in the model are valid
     # @return true if the model is valid
     def valid?
-      return false if !@tag_value.nil? && @tag_value.to_s.length > 100
+      return false if !@tag_value.nil? && @tag_value.to_s.length > 250
       true
     end
 
     # Custom attribute writer method with validation
     # @param [Object] tag_value Value to be assigned
     def tag_value=(tag_value)
-      if !tag_value.nil? && tag_value.to_s.length > 100
-        fail ArgumentError, 'invalid value for "tag_value", the character length must be smaller than or equal to 100.'
+      if !tag_value.nil? && tag_value.to_s.length > 250
+        fail ArgumentError, 'invalid value for "tag_value", the character length must be smaller than or equal to 250.'
       end
 
       @tag_value = tag_value

data/lib/ultracart_api/models/distribution_center.rb

@@ -112,6 +112,9 @@ module UltracartClient
     # State of the distribution center
     attr_accessor :state
 
+    # True if monetary amounts should be zeroed before transmission
+    attr_accessor :transmit_blank_costs
+
     # Transport mechanism for this distribution center
     attr_accessor :transport
 
@@ -151,6 +154,7 @@ module UltracartClient
         :'shipment_cutoff_time_tuesday' => :'shipment_cutoff_time_tuesday',
         :'shipment_cutoff_time_wednesday' => :'shipment_cutoff_time_wednesday',
         :'state' => :'state',
+        :'transmit_blank_costs' => :'transmit_blank_costs',
         :'transport' => :'transport'
       }
     end
@@ -191,6 +195,7 @@ module UltracartClient
         :'shipment_cutoff_time_tuesday' => :'String',
         :'shipment_cutoff_time_wednesday' => :'String',
         :'state' => :'String',
+        :'transmit_blank_costs' => :'BOOLEAN',
         :'transport' => :'String'
       }
     end
@@ -335,6 +340,10 @@ module UltracartClient
         self.state = attributes[:'state']
       end
 
+      if attributes.has_key?(:'transmit_blank_costs')
+        self.transmit_blank_costs = attributes[:'transmit_blank_costs']
+      end
+
       if attributes.has_key?(:'transport')
         self.transport = attributes[:'transport']
       end
@@ -391,6 +400,7 @@ module UltracartClient
           shipment_cutoff_time_tuesday == o.shipment_cutoff_time_tuesday &&
           shipment_cutoff_time_wednesday == o.shipment_cutoff_time_wednesday &&
           state == o.state &&
+          transmit_blank_costs == o.transmit_blank_costs &&
           transport == o.transport
     end
 
@@ -403,7 +413,7 @@ module UltracartClient
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [address1, address2, city, code, country_code, default_center, default_handles_all_items, distribution_center_oid, duns, estimate_from_distribution_center_oid, ftp_password, hold_before_shipment_minutes, hold_before_transmission, hold_auto_order_before_shipment_minutes, latitude, longitude, name, no_customer_direct_shipments, no_split_shipment, postal_code, process_days, process_inventory_start_time, process_inventory_stop_time, require_asn, send_kit_instead_of_components, shipment_cutoff_time_friday, shipment_cutoff_time_monday, shipment_cutoff_time_saturday, shipment_cutoff_time_sunday, shipment_cutoff_time_thursday, shipment_cutoff_time_tuesday, shipment_cutoff_time_wednesday, state, transport].hash
+      [address1, address2, city, code, country_code, default_center, default_handles_all_items, distribution_center_oid, duns, estimate_from_distribution_center_oid, ftp_password, hold_before_shipment_minutes, hold_before_transmission, hold_auto_order_before_shipment_minutes, latitude, longitude, name, no_customer_direct_shipments, no_split_shipment, postal_code, process_days, process_inventory_start_time, process_inventory_stop_time, require_asn, send_kit_instead_of_components, shipment_cutoff_time_friday, shipment_cutoff_time_monday, shipment_cutoff_time_saturday, shipment_cutoff_time_sunday, shipment_cutoff_time_thursday, shipment_cutoff_time_tuesday, shipment_cutoff_time_wednesday, state, transmit_blank_costs, transport].hash
     end
 
     # Builds the object from hash

data/lib/ultracart_api/models/email_commseq_postcard.rb

@@ -44,6 +44,12 @@ module UltracartClient
     # Postcard front container uuid
     attr_accessor :postcard_front_container_uuid
 
+    # URL for front screenshot
+    attr_accessor :screenshot_front_url
+
+    # URL for back screenshot
+    attr_accessor :screenshot_small_full_url
+
     # Storefront oid
     attr_accessor :storefront_oid
 
@@ -60,6 +66,8 @@ module UltracartClient
         :'postcard_container_cjson_last_modified_dts' => :'postcard_container_cjson_last_modified_dts',
         :'postcard_front_container_cjson' => :'postcard_front_container_cjson',
         :'postcard_front_container_uuid' => :'postcard_front_container_uuid',
+        :'screenshot_front_url' => :'screenshot_front_url',
+        :'screenshot_small_full_url' => :'screenshot_small_full_url',
         :'storefront_oid' => :'storefront_oid'
       }
     end
@@ -77,6 +85,8 @@ module UltracartClient
         :'postcard_container_cjson_last_modified_dts' => :'String',
         :'postcard_front_container_cjson' => :'String',
         :'postcard_front_container_uuid' => :'String',
+        :'screenshot_front_url' => :'String',
+        :'screenshot_small_full_url' => :'String',
         :'storefront_oid' => :'Integer'
       }
     end
@@ -129,6 +139,14 @@ module UltracartClient
         self.postcard_front_container_uuid = attributes[:'postcard_front_container_uuid']
       end
 
+      if attributes.has_key?(:'screenshot_front_url')
+        self.screenshot_front_url = attributes[:'screenshot_front_url']
+      end
+
+      if attributes.has_key?(:'screenshot_small_full_url')
+        self.screenshot_small_full_url = attributes[:'screenshot_small_full_url']
+      end
+
       if attributes.has_key?(:'storefront_oid')
         self.storefront_oid = attributes[:'storefront_oid']
       end
@@ -162,6 +180,8 @@ module UltracartClient
           postcard_container_cjson_last_modified_dts == o.postcard_container_cjson_last_modified_dts &&
           postcard_front_container_cjson == o.postcard_front_container_cjson &&
           postcard_front_container_uuid == o.postcard_front_container_uuid &&
+          screenshot_front_url == o.screenshot_front_url &&
+          screenshot_small_full_url == o.screenshot_small_full_url &&
           storefront_oid == o.storefront_oid
     end
 
@@ -174,7 +194,7 @@ module UltracartClient
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [deleted, edited_by_user, email_communication_sequence_postcard_uuid, filter_profile_equation_json, merchant_id, postcard_back_container_cjson, postcard_back_container_uuid, postcard_container_cjson_last_modified_dts, postcard_front_container_cjson, postcard_front_container_uuid, storefront_oid].hash
+      [deleted, edited_by_user, email_communication_sequence_postcard_uuid, filter_profile_equation_json, merchant_id, postcard_back_container_cjson, postcard_back_container_uuid, postcard_container_cjson_last_modified_dts, postcard_front_container_cjson, postcard_front_container_uuid, screenshot_front_url, screenshot_small_full_url, storefront_oid].hash
     end
 
     # Builds the object from hash

data/lib/ultracart_api/models/email_commseq_webhook_send_test_response.rb

@@ -0,0 +1,242 @@
+=begin
+#UltraCart Rest API V2
+
+#UltraCart REST API Version 2
+
+OpenAPI spec version: 2.0.0
+Contact: support@ultracart.com
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+Swagger Codegen version: 2.4.15-SNAPSHOT
+
+=end
+
+require 'date'
+
+module UltracartClient
+  class EmailCommseqWebhookSendTestResponse
+    attr_accessor :error
+
+    attr_accessor :metadata
+
+    # HTTP Request
+    attr_accessor :request
+
+    # HTTP Response
+    attr_accessor :response
+
+    # HTTP Status Code
+    attr_accessor :status_code
+
+    # Indicates if API call was successful
+    attr_accessor :success
+
+    attr_accessor :warning
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'error' => :'error',
+        :'metadata' => :'metadata',
+        :'request' => :'request',
+        :'response' => :'response',
+        :'status_code' => :'status_code',
+        :'success' => :'success',
+        :'warning' => :'warning'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        :'error' => :'Error',
+        :'metadata' => :'ResponseMetadata',
+        :'request' => :'String',
+        :'response' => :'String',
+        :'status_code' => :'Integer',
+        :'success' => :'BOOLEAN',
+        :'warning' => :'Warning'
+      }
+    end
+
+    # Initializes the object
+    # @param [Hash] attributes Model attributes in the form of hash
+    def initialize(attributes = {})
+      return unless attributes.is_a?(Hash)
+
+      # convert string to symbol for hash key
+      attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }
+
+      if attributes.has_key?(:'error')
+        self.error = attributes[:'error']
+      end
+
+      if attributes.has_key?(:'metadata')
+        self.metadata = attributes[:'metadata']
+      end
+
+      if attributes.has_key?(:'request')
+        self.request = attributes[:'request']
+      end
+
+      if attributes.has_key?(:'response')
+        self.response = attributes[:'response']
+      end
+
+      if attributes.has_key?(:'status_code')
+        self.status_code = attributes[:'status_code']
+      end
+
+      if attributes.has_key?(:'success')
+        self.success = attributes[:'success']
+      end
+
+      if attributes.has_key?(:'warning')
+        self.warning = attributes[:'warning']
+      end
+    end
+
+    # Show invalid properties with the reasons. Usually used together with valid?
+    # @return Array for valid properties with the reasons
+    def list_invalid_properties
+      invalid_properties = Array.new
+      invalid_properties
+    end
+
+    # Check to see if the all the properties in the model are valid
+    # @return true if the model is valid
+    def valid?
+      true
+    end
+
+    # Checks equality by comparing each attribute.
+    # @param [Object] Object to be compared
+    def ==(o)
+      return true if self.equal?(o)
+      self.class == o.class &&
+          error == o.error &&
+          metadata == o.metadata &&
+          request == o.request &&
+          response == o.response &&
+          status_code == o.status_code &&
+          success == o.success &&
+          warning == o.warning
+    end
+
+    # @see the `==` method
+    # @param [Object] Object to be compared
+    def eql?(o)
+      self == o
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Fixnum] Hash code
+    def hash
+      [error, metadata, request, response, status_code, success, warning].hash
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def build_from_hash(attributes)
+      return nil unless attributes.is_a?(Hash)
+      self.class.swagger_types.each_pair do |key, type|
+        if type =~ /\AArray<(.*)>/i
+          # check to ensure the input is an array given that the attribute
+          # is documented as an array but the input is not
+          if attributes[self.class.attribute_map[key]].is_a?(Array)
+            self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
+          end
+        elsif !attributes[self.class.attribute_map[key]].nil?
+          self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
+        end # or else data not found in attributes(hash), not an issue as the data can be optional
+      end
+
+      self
+    end
+
+    # Deserializes the data based on type
+    # @param string type Data type
+    # @param string value Value to be deserialized
+    # @return [Object] Deserialized data
+    def _deserialize(type, value)
+      case type.to_sym
+      when :DateTime
+        DateTime.parse(value)
+      when :Date
+        Date.parse(value)
+      when :String
+        value.to_s
+      when :Integer
+        value.to_i
+      when :Float
+        value.to_f
+      when :BOOLEAN
+        if value.to_s =~ /\A(true|t|yes|y|1)\z/i
+          true
+        else
+          false
+        end
+      when :Object
+        # generic object (usually a Hash), return directly
+        value
+      when /\AArray<(?<inner_type>.+)>\z/
+        inner_type = Regexp.last_match[:inner_type]
+        value.map { |v| _deserialize(inner_type, v) }
+      when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
+        k_type = Regexp.last_match[:k_type]
+        v_type = Regexp.last_match[:v_type]
+        {}.tap do |hash|
+          value.each do |k, v|
+            hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
+          end
+        end
+      else # model
+        temp_model = UltracartClient.const_get(type).new
+        temp_model.build_from_hash(value)
+      end
+    end
+
+    # Returns the string representation of the object
+    # @return [String] String presentation of the object
+    def to_s
+      to_hash.to_s
+    end
+
+    # to_body is an alias to to_hash (backward compatibility)
+    # @return [Hash] Returns the object in the form of hash
+    def to_body
+      to_hash
+    end
+
+    # Returns the object in the form of hash
+    # @return [Hash] Returns the object in the form of hash
+    def to_hash
+      hash = {}
+      self.class.attribute_map.each_pair do |attr, param|
+        value = self.send(attr)
+        next if value.nil?
+        hash[param] = _to_hash(value)
+      end
+      hash
+    end
+
+    # Outputs non-array value in the form of hash
+    # For object, use to_hash. Otherwise, just return the value
+    # @param [Object] value Any valid value
+    # @return [Hash] Returns the value in the form of hash
+    def _to_hash(value)
+      if value.is_a?(Array)
+        value.compact.map { |v| _to_hash(v) }
+      elsif value.is_a?(Hash)
+        {}.tap do |hash|
+          value.each { |k, v| hash[k] = _to_hash(v) }
+        end
+      elsif value.respond_to? :to_hash
+        value.to_hash
+      else
+        value
+      end
+    end
+
+  end
+end

data/lib/ultracart_api/models/email_domain.rb

@@ -30,6 +30,8 @@ module UltracartClient
 
     attr_accessor :provider
 
+    attr_accessor :spf
+
     attr_accessor :start_dkim_dts
 
     attr_accessor :start_identity_dts
@@ -47,6 +49,7 @@ module UltracartClient
         :'identity_status' => :'identity_status',
         :'merchant_id' => :'merchant_id',
         :'provider' => :'provider',
+        :'spf' => :'spf',
         :'start_dkim_dts' => :'start_dkim_dts',
         :'start_identity_dts' => :'start_identity_dts',
         :'verification' => :'verification'
@@ -64,6 +67,7 @@ module UltracartClient
         :'identity_status' => :'String',
         :'merchant_id' => :'String',
         :'provider' => :'String',
+        :'spf' => :'VerificationRecord',
         :'start_dkim_dts' => :'String',
         :'start_identity_dts' => :'String',
         :'verification' => :'VerificationRecord'
@@ -112,6 +116,10 @@ module UltracartClient
         self.provider = attributes[:'provider']
       end
 
+      if attributes.has_key?(:'spf')
+        self.spf = attributes[:'spf']
+      end
+
       if attributes.has_key?(:'start_dkim_dts')
         self.start_dkim_dts = attributes[:'start_dkim_dts']
       end
@@ -151,6 +159,7 @@ module UltracartClient
           identity_status == o.identity_status &&
           merchant_id == o.merchant_id &&
           provider == o.provider &&
+          spf == o.spf &&
           start_dkim_dts == o.start_dkim_dts &&
           start_identity_dts == o.start_identity_dts &&
           verification == o.verification
@@ -165,7 +174,7 @@ module UltracartClient
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [comment, dkim, dkim_status, domain, esp_domain_uuid, identity_status, merchant_id, provider, start_dkim_dts, start_identity_dts, verification].hash
+      [comment, dkim, dkim_status, domain, esp_domain_uuid, identity_status, merchant_id, provider, spf, start_dkim_dts, start_identity_dts, verification].hash
     end
 
     # Builds the object from hash

data/lib/ultracart_api/models/gift_certificate.rb

@@ -20,6 +20,9 @@ module UltracartClient
     # The code used by the customer to purchase against this gift certificate.
     attr_accessor :code
 
+    # This is the customer profile oid associated with this internally managed gift certificate.
+    attr_accessor :customer_profile_oid
+
     # True if this gift certificate was deleted.
     attr_accessor :deleted
 
@@ -32,6 +35,9 @@ module UltracartClient
     # Gift certificate oid.
     attr_accessor :gift_certificate_oid
 
+    # This is an internally managed gift certificate associated with the loyalty cash rewards program.
+    attr_accessor :internal
+
     # A list of all ledger activity for this gift certificate.
     attr_accessor :ledger_entries
 
@@ -55,10 +61,12 @@ module UltracartClient
       {
         :'activated' => :'activated',
         :'code' => :'code',
+        :'customer_profile_oid' => :'customer_profile_oid',
         :'deleted' => :'deleted',
         :'email' => :'email',
         :'expiration_dts' => :'expiration_dts',
         :'gift_certificate_oid' => :'gift_certificate_oid',
+        :'internal' => :'internal',
         :'ledger_entries' => :'ledger_entries',
         :'merchant_id' => :'merchant_id',
         :'merchant_note' => :'merchant_note',
@@ -73,10 +81,12 @@ module UltracartClient
       {
         :'activated' => :'BOOLEAN',
         :'code' => :'String',
+        :'customer_profile_oid' => :'Integer',
         :'deleted' => :'BOOLEAN',
         :'email' => :'String',
         :'expiration_dts' => :'String',
         :'gift_certificate_oid' => :'Integer',
+        :'internal' => :'BOOLEAN',
         :'ledger_entries' => :'Array<GiftCertificateLedgerEntry>',
         :'merchant_id' => :'String',
         :'merchant_note' => :'String',
@@ -102,6 +112,10 @@ module UltracartClient
         self.code = attributes[:'code']
       end
 
+      if attributes.has_key?(:'customer_profile_oid')
+        self.customer_profile_oid = attributes[:'customer_profile_oid']
+      end
+
       if attributes.has_key?(:'deleted')
         self.deleted = attributes[:'deleted']
       end
@@ -118,6 +132,10 @@ module UltracartClient
         self.gift_certificate_oid = attributes[:'gift_certificate_oid']
       end
 
+      if attributes.has_key?(:'internal')
+        self.internal = attributes[:'internal']
+      end
+
       if attributes.has_key?(:'ledger_entries')
         if (value = attributes[:'ledger_entries']).is_a?(Array)
           self.ledger_entries = value
@@ -149,15 +167,30 @@ module UltracartClient
     # @return Array for valid properties with the reasons
     def list_invalid_properties
       invalid_properties = Array.new
+      if !@email.nil? && @email.to_s.length > 100
+        invalid_properties.push('invalid value for "email", the character length must be smaller than or equal to 100.')
+      end
+
       invalid_properties
     end
 
     # Check to see if the all the properties in the model are valid
     # @return true if the model is valid
     def valid?
+      return false if !@email.nil? && @email.to_s.length > 100
       true
     end
 
+    # Custom attribute writer method with validation
+    # @param [Object] email Value to be assigned
+    def email=(email)
+      if !email.nil? && email.to_s.length > 100
+        fail ArgumentError, 'invalid value for "email", the character length must be smaller than or equal to 100.'
+      end
+
+      @email = email
+    end
+
     # Checks equality by comparing each attribute.
     # @param [Object] Object to be compared
     def ==(o)
@@ -165,10 +198,12 @@ module UltracartClient
       self.class == o.class &&
           activated == o.activated &&
           code == o.code &&
+          customer_profile_oid == o.customer_profile_oid &&
           deleted == o.deleted &&
           email == o.email &&
           expiration_dts == o.expiration_dts &&
           gift_certificate_oid == o.gift_certificate_oid &&
+          internal == o.internal &&
           ledger_entries == o.ledger_entries &&
           merchant_id == o.merchant_id &&
           merchant_note == o.merchant_note &&
@@ -186,7 +221,7 @@ module UltracartClient
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [activated, code, deleted, email, expiration_dts, gift_certificate_oid, ledger_entries, merchant_id, merchant_note, original_balance, reference_order_id, remaining_balance].hash
+      [activated, code, customer_profile_oid, deleted, email, expiration_dts, gift_certificate_oid, internal, ledger_entries, merchant_id, merchant_note, original_balance, reference_order_id, remaining_balance].hash
     end
 
     # Builds the object from hash