ultracart_api 4.1.136 → 4.1.140

data/lib/ultracart_api/models/channel_partner_order.rb

@@ -24,6 +24,9 @@ module UltracartClient
     # Affiliate Sub Id
     attr_accessor :affiliate_sub_id
 
+    # Names of pricing tiers to price this order against, without associating a customer profile.  An unknown tier name will fail the import.  An item that also supplies arbitrary_unit_cost keeps that cost and ignores the tier.  If a customer profile is attached to this order during checkout, these tiers are granted to that profile permanently.
+    attr_accessor :arbitrary_pricing_tier_names
+
     # Arbitrary shipping handling total
     attr_accessor :arbitrary_shipping_handling_total
 
@@ -333,6 +336,7 @@ module UltracartClient
         :'advertising_source' => :'advertisingSource',
         :'affiliate_id' => :'affiliate_id',
         :'affiliate_sub_id' => :'affiliate_sub_id',
+        :'arbitrary_pricing_tier_names' => :'arbitrary_pricing_tier_names',
         :'arbitrary_shipping_handling_total' => :'arbitrary_shipping_handling_total',
         :'arbitrary_subtotal_discount' => :'arbitrary_subtotal_discount',
         :'arbitrary_tax' => :'arbitrary_tax',
@@ -441,6 +445,7 @@ module UltracartClient
         :'advertising_source' => :'String',
         :'affiliate_id' => :'String',
         :'affiliate_sub_id' => :'String',
+        :'arbitrary_pricing_tier_names' => :'Array<String>',
         :'arbitrary_shipping_handling_total' => :'Float',
         :'arbitrary_subtotal_discount' => :'Float',
         :'arbitrary_tax' => :'Float',
@@ -571,6 +576,12 @@ module UltracartClient
         self.affiliate_sub_id = attributes[:'affiliate_sub_id']
       end
 
+      if attributes.key?(:'arbitrary_pricing_tier_names')
+        if (value = attributes[:'arbitrary_pricing_tier_names']).is_a?(Array)
+          self.arbitrary_pricing_tier_names = value
+        end
+      end
+
       if attributes.key?(:'arbitrary_shipping_handling_total')
         self.arbitrary_shipping_handling_total = attributes[:'arbitrary_shipping_handling_total']
       end
@@ -1566,6 +1577,7 @@ module UltracartClient
           advertising_source == o.advertising_source &&
           affiliate_id == o.affiliate_id &&
           affiliate_sub_id == o.affiliate_sub_id &&
+          arbitrary_pricing_tier_names == o.arbitrary_pricing_tier_names &&
           arbitrary_shipping_handling_total == o.arbitrary_shipping_handling_total &&
           arbitrary_subtotal_discount == o.arbitrary_subtotal_discount &&
           arbitrary_tax == o.arbitrary_tax &&
@@ -1671,7 +1683,7 @@ module UltracartClient
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [advertising_source, affiliate_id, affiliate_sub_id, arbitrary_shipping_handling_total, arbitrary_subtotal_discount, arbitrary_tax, arbitrary_tax_rate, arbitrary_taxable_subtotal, arbitrary_taxable_subtotal_discount, associate_with_customer_profile_if_present, auto_approve_purchase_order, billto_address1, billto_address2, billto_city, billto_company, billto_country_code, billto_day_phone, billto_evening_phone, billto_first_name, billto_last_name, billto_postal_code, billto_state_region, billto_title, cc_email, channel_partner_order_id, consider_recurring, coupons, creation_dts, credit_card_authorization_amount, credit_card_authorization_dts, credit_card_authorization_number, credit_card_expiration_month, credit_card_expiration_year, credit_card_type, custom_field1, custom_field2, custom_field3, custom_field4, custom_field5, custom_field6, custom_field7, delivery_date, echeck_bank_aba_code, echeck_bank_account_name, echeck_bank_account_number, echeck_bank_account_type, echeck_bank_name, echeck_bank_owner_type, echeck_customer_tax_id, echeck_drivers_license_dob, echeck_drivers_license_number, echeck_drivers_license_state, email, gift, gift_email, gift_message, hosted_fields_card_token, hosted_fields_cvv_token, insurance_application_id, insurance_claim_id, ip_address, items, least_cost_route, least_cost_route_shipping_methods, mailing_list_opt_in, no_realtime_payment_processing, payment_method, purchase_order_number, rotating_transaction_gateway_code, sales_rep_code, screen_branding_theme_code, ship_on_date, ship_to_residential, shipping_method, shipto_address1, shipto_address2, shipto_city, shipto_company, shipto_country_code, shipto_day_phone, shipto_evening_phone, shipto_first_name, shipto_last_name, shipto_postal_code, shipto_state_region, shipto_title, skip_auto_order_setup, skip_payment_processing, special_instructions, store_completed, store_if_payment_declines, storefront_host_name, tax_county, tax_exempt, transaction, treat_warnings_as_errors, use_prior_payment_information_from_order_id].hash
+      [advertising_source, affiliate_id, affiliate_sub_id, arbitrary_pricing_tier_names, arbitrary_shipping_handling_total, arbitrary_subtotal_discount, arbitrary_tax, arbitrary_tax_rate, arbitrary_taxable_subtotal, arbitrary_taxable_subtotal_discount, associate_with_customer_profile_if_present, auto_approve_purchase_order, billto_address1, billto_address2, billto_city, billto_company, billto_country_code, billto_day_phone, billto_evening_phone, billto_first_name, billto_last_name, billto_postal_code, billto_state_region, billto_title, cc_email, channel_partner_order_id, consider_recurring, coupons, creation_dts, credit_card_authorization_amount, credit_card_authorization_dts, credit_card_authorization_number, credit_card_expiration_month, credit_card_expiration_year, credit_card_type, custom_field1, custom_field2, custom_field3, custom_field4, custom_field5, custom_field6, custom_field7, delivery_date, echeck_bank_aba_code, echeck_bank_account_name, echeck_bank_account_number, echeck_bank_account_type, echeck_bank_name, echeck_bank_owner_type, echeck_customer_tax_id, echeck_drivers_license_dob, echeck_drivers_license_number, echeck_drivers_license_state, email, gift, gift_email, gift_message, hosted_fields_card_token, hosted_fields_cvv_token, insurance_application_id, insurance_claim_id, ip_address, items, least_cost_route, least_cost_route_shipping_methods, mailing_list_opt_in, no_realtime_payment_processing, payment_method, purchase_order_number, rotating_transaction_gateway_code, sales_rep_code, screen_branding_theme_code, ship_on_date, ship_to_residential, shipping_method, shipto_address1, shipto_address2, shipto_city, shipto_company, shipto_country_code, shipto_day_phone, shipto_evening_phone, shipto_first_name, shipto_last_name, shipto_postal_code, shipto_state_region, shipto_title, skip_auto_order_setup, skip_payment_processing, special_instructions, store_completed, store_if_payment_declines, storefront_host_name, tax_county, tax_exempt, transaction, treat_warnings_as_errors, use_prior_payment_information_from_order_id].hash
     end
 
     # Builds the object from hash

data/lib/ultracart_api/models/conversation_pbx_pay_connector.rb

@@ -0,0 +1,426 @@
+=begin
+#UltraCart Rest API V2
+
+#UltraCart REST API Version 2
+
+The version of the OpenAPI document: 2.0.0
+Contact: support@ultracart.com
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 6.0.1-SNAPSHOT
+
+=end
+
+require 'date'
+require 'time'
+
+module UltracartClient
+  class ConversationPbxPayConnector
+    # Description of the connector
+    attr_accessor :description
+
+    # Environment the connector points at.  Only live connectors are returned.  Sandbox and unconfigured connectors are ignored.
+    attr_accessor :environment
+
+    # Friendly name of the connector as shown in the Twilio console
+    attr_accessor :friendly_name
+
+    # Merchant Id
+    attr_accessor :merchant_id
+
+    # Payment processor behind this connector
+    attr_accessor :processor
+
+    # The processor account this connector is bound to (Stripe connected account id or Braintree merchant id).  A payment captured with this connector can only be charged within this account.
+    attr_accessor :processor_account_id
+
+    # Twilio installed add-on SID for this connector
+    attr_accessor :sid
+
+    # Unique name of the connector.  This is the value used for the paymentConnector attribute of the Twilio Pay verb.
+    attr_accessor :unique_name
+
+    class EnumAttributeValidator
+      attr_reader :datatype
+      attr_reader :allowable_values
+
+      def initialize(datatype, allowable_values)
+        @allowable_values = allowable_values.map do |value|
+          case datatype.to_s
+          when /Integer/i
+            value.to_i
+          when /Float/i
+            value.to_f
+          else
+            value
+          end
+        end
+      end
+
+      def valid?(value)
+        !value || allowable_values.include?(value)
+      end
+    end
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'description' => :'description',
+        :'environment' => :'environment',
+        :'friendly_name' => :'friendly_name',
+        :'merchant_id' => :'merchant_id',
+        :'processor' => :'processor',
+        :'processor_account_id' => :'processor_account_id',
+        :'sid' => :'sid',
+        :'unique_name' => :'unique_name'
+      }
+    end
+
+    # Returns all the JSON keys this model knows about
+    def self.acceptable_attributes
+      attribute_map.values
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'description' => :'String',
+        :'environment' => :'String',
+        :'friendly_name' => :'String',
+        :'merchant_id' => :'String',
+        :'processor' => :'String',
+        :'processor_account_id' => :'String',
+        :'sid' => :'String',
+        :'unique_name' => :'String'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+      ])
+    end
+
+    # Initializes the object
+    # @param [Hash] attributes Model attributes in the form of hash
+    def initialize(attributes = {})
+      if (!attributes.is_a?(Hash))
+        fail ArgumentError, "The input argument (attributes) must be a hash in `UltracartClient::ConversationPbxPayConnector` initialize method"
+      end
+
+      # check to see if the attribute exists and convert string to symbol for hash key
+      attributes = attributes.each_with_object({}) { |(k, v), h|
+        if (!self.class.attribute_map.key?(k.to_sym))
+          fail ArgumentError, "`#{k}` is not a valid attribute in `UltracartClient::ConversationPbxPayConnector`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
+        end
+        h[k.to_sym] = v
+      }
+
+      if attributes.key?(:'description')
+        self.description = attributes[:'description']
+      end
+
+      if attributes.key?(:'environment')
+        self.environment = attributes[:'environment']
+      end
+
+      if attributes.key?(:'friendly_name')
+        self.friendly_name = attributes[:'friendly_name']
+      end
+
+      if attributes.key?(:'merchant_id')
+        self.merchant_id = attributes[:'merchant_id']
+      end
+
+      if attributes.key?(:'processor')
+        self.processor = attributes[:'processor']
+      end
+
+      if attributes.key?(:'processor_account_id')
+        self.processor_account_id = attributes[:'processor_account_id']
+      end
+
+      if attributes.key?(:'sid')
+        self.sid = attributes[:'sid']
+      end
+
+      if attributes.key?(:'unique_name')
+        self.unique_name = attributes[:'unique_name']
+      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
+      if !@description.nil? && @description.to_s.length > 250
+        invalid_properties.push('invalid value for "description", the character length must be smaller than or equal to 250.')
+      end
+
+      if !@friendly_name.nil? && @friendly_name.to_s.length > 100
+        invalid_properties.push('invalid value for "friendly_name", the character length must be smaller than or equal to 100.')
+      end
+
+      if !@merchant_id.nil? && @merchant_id.to_s.length > 5
+        invalid_properties.push('invalid value for "merchant_id", the character length must be smaller than or equal to 5.')
+      end
+
+      if !@processor_account_id.nil? && @processor_account_id.to_s.length > 100
+        invalid_properties.push('invalid value for "processor_account_id", the character length must be smaller than or equal to 100.')
+      end
+
+      if !@sid.nil? && @sid.to_s.length > 50
+        invalid_properties.push('invalid value for "sid", the character length must be smaller than or equal to 50.')
+      end
+
+      if !@unique_name.nil? && @unique_name.to_s.length > 100
+        invalid_properties.push('invalid value for "unique_name", 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 !@description.nil? && @description.to_s.length > 250
+      environment_validator = EnumAttributeValidator.new('String', ["live"])
+      return false unless environment_validator.valid?(@environment)
+      return false if !@friendly_name.nil? && @friendly_name.to_s.length > 100
+      return false if !@merchant_id.nil? && @merchant_id.to_s.length > 5
+      processor_validator = EnumAttributeValidator.new('String', ["stripe", "braintree", "generic", "unknown"])
+      return false unless processor_validator.valid?(@processor)
+      return false if !@processor_account_id.nil? && @processor_account_id.to_s.length > 100
+      return false if !@sid.nil? && @sid.to_s.length > 50
+      return false if !@unique_name.nil? && @unique_name.to_s.length > 100
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] description Value to be assigned
+    def description=(description)
+      if !description.nil? && description.to_s.length > 250
+        fail ArgumentError, 'invalid value for "description", the character length must be smaller than or equal to 250.'
+      end
+
+      @description = description
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] environment Object to be assigned
+    def environment=(environment)
+      validator = EnumAttributeValidator.new('String', ["live"])
+      unless validator.valid?(environment)
+        fail ArgumentError, "invalid value for \"environment\", must be one of #{validator.allowable_values}."
+      end
+      @environment = environment
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] friendly_name Value to be assigned
+    def friendly_name=(friendly_name)
+      if !friendly_name.nil? && friendly_name.to_s.length > 100
+        fail ArgumentError, 'invalid value for "friendly_name", the character length must be smaller than or equal to 100.'
+      end
+
+      @friendly_name = friendly_name
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] merchant_id Value to be assigned
+    def merchant_id=(merchant_id)
+      if !merchant_id.nil? && merchant_id.to_s.length > 5
+        fail ArgumentError, 'invalid value for "merchant_id", the character length must be smaller than or equal to 5.'
+      end
+
+      @merchant_id = merchant_id
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] processor Object to be assigned
+    def processor=(processor)
+      validator = EnumAttributeValidator.new('String', ["stripe", "braintree", "generic", "unknown"])
+      unless validator.valid?(processor)
+        fail ArgumentError, "invalid value for \"processor\", must be one of #{validator.allowable_values}."
+      end
+      @processor = processor
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] processor_account_id Value to be assigned
+    def processor_account_id=(processor_account_id)
+      if !processor_account_id.nil? && processor_account_id.to_s.length > 100
+        fail ArgumentError, 'invalid value for "processor_account_id", the character length must be smaller than or equal to 100.'
+      end
+
+      @processor_account_id = processor_account_id
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] sid Value to be assigned
+    def sid=(sid)
+      if !sid.nil? && sid.to_s.length > 50
+        fail ArgumentError, 'invalid value for "sid", the character length must be smaller than or equal to 50.'
+      end
+
+      @sid = sid
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] unique_name Value to be assigned
+    def unique_name=(unique_name)
+      if !unique_name.nil? && unique_name.to_s.length > 100
+        fail ArgumentError, 'invalid value for "unique_name", the character length must be smaller than or equal to 100.'
+      end
+
+      @unique_name = unique_name
+    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 &&
+          description == o.description &&
+          environment == o.environment &&
+          friendly_name == o.friendly_name &&
+          merchant_id == o.merchant_id &&
+          processor == o.processor &&
+          processor_account_id == o.processor_account_id &&
+          sid == o.sid &&
+          unique_name == o.unique_name
+    end
+
+    # @see the `==` method
+    # @param [Object] Object to be compared
+    def eql?(o)
+      self == o
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Integer] Hash code
+    def hash
+      [description, environment, friendly_name, merchant_id, processor, processor_account_id, sid, unique_name].hash
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def self.build_from_hash(attributes)
+      new.build_from_hash(attributes)
+    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)
+      attributes = attributes.transform_keys(&:to_sym)
+      self.class.openapi_types.each_pair do |key, type|
+        if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
+          self.send("#{key}=", nil)
+        elsif 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
+      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 :Time
+        Time.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
+        # models (e.g. Pet) or oneOf
+        klass = UltracartClient.const_get(type)
+        klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.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)
+        if value.nil?
+          is_nullable = self.class.openapi_nullable.include?(attr)
+          next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
+        end
+
+        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