whitelabelmachinename-ruby-sdk 3.0.6 → 3.1.2

data/lib/whitelabelmachinename-ruby-sdk/models/invoice_reimbursement_with_refund_reference.rb

@@ -0,0 +1,401 @@
+=begin
+The WhiteLabelName API allows an easy interaction with the WhiteLabelName web service.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+
+=end
+
+require 'date'
+
+module WhiteLabelMachineName
+  # 
+  class InvoiceReimbursementWithRefundReference
+    # 
+    attr_accessor :amount
+
+    # The created on date indicates the date on which the entity was stored into the database.
+    attr_accessor :created_on
+
+    # 
+    attr_accessor :currency
+
+    # 
+    attr_accessor :discarded_by
+
+    # 
+    attr_accessor :discarded_on
+
+    # The ID is the primary key of the entity. The ID identifies the entity uniquely.
+    attr_accessor :id
+
+    # The linked space id holds the ID of the space to which the entity belongs to.
+    attr_accessor :linked_space_id
+
+    # 
+    attr_accessor :payment_connector_configuration
+
+    # 
+    attr_accessor :payment_initiation_advice_file
+
+    # 
+    attr_accessor :processed_by
+
+    # 
+    attr_accessor :processed_on
+
+    # 
+    attr_accessor :recipient_city
+
+    # 
+    attr_accessor :recipient_country
+
+    # 
+    attr_accessor :recipient_family_name
+
+    # 
+    attr_accessor :recipient_given_name
+
+    # 
+    attr_accessor :recipient_iban
+
+    # 
+    attr_accessor :recipient_postcode
+
+    # 
+    attr_accessor :recipient_street
+
+    # 
+    attr_accessor :sender_iban
+
+    # 
+    attr_accessor :state
+
+    # The version number indicates the version of the entity. The version is incremented whenever the entity is changed.
+    attr_accessor :version
+
+    # 
+    attr_accessor :refund_merchant_reference
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'amount' => :'amount',
+        :'created_on' => :'createdOn',
+        :'currency' => :'currency',
+        :'discarded_by' => :'discardedBy',
+        :'discarded_on' => :'discardedOn',
+        :'id' => :'id',
+        :'linked_space_id' => :'linkedSpaceId',
+        :'payment_connector_configuration' => :'paymentConnectorConfiguration',
+        :'payment_initiation_advice_file' => :'paymentInitiationAdviceFile',
+        :'processed_by' => :'processedBy',
+        :'processed_on' => :'processedOn',
+        :'recipient_city' => :'recipientCity',
+        :'recipient_country' => :'recipientCountry',
+        :'recipient_family_name' => :'recipientFamilyName',
+        :'recipient_given_name' => :'recipientGivenName',
+        :'recipient_iban' => :'recipientIban',
+        :'recipient_postcode' => :'recipientPostcode',
+        :'recipient_street' => :'recipientStreet',
+        :'sender_iban' => :'senderIban',
+        :'state' => :'state',
+        :'version' => :'version',
+        :'refund_merchant_reference' => :'refundMerchantReference'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        :'amount' => :'Float',
+        :'created_on' => :'DateTime',
+        :'currency' => :'String',
+        :'discarded_by' => :'Integer',
+        :'discarded_on' => :'DateTime',
+        :'id' => :'Integer',
+        :'linked_space_id' => :'Integer',
+        :'payment_connector_configuration' => :'PaymentConnectorConfiguration',
+        :'payment_initiation_advice_file' => :'PaymentInitiationAdviceFile',
+        :'processed_by' => :'Integer',
+        :'processed_on' => :'DateTime',
+        :'recipient_city' => :'String',
+        :'recipient_country' => :'String',
+        :'recipient_family_name' => :'String',
+        :'recipient_given_name' => :'String',
+        :'recipient_iban' => :'String',
+        :'recipient_postcode' => :'String',
+        :'recipient_street' => :'String',
+        :'sender_iban' => :'String',
+        :'state' => :'InvoiceReimbursementState',
+        :'version' => :'Integer',
+        :'refund_merchant_reference' => :'String'
+      }
+    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?(:'amount')
+        self.amount = attributes[:'amount']
+      end
+
+      if attributes.has_key?(:'createdOn')
+        self.created_on = attributes[:'createdOn']
+      end
+
+      if attributes.has_key?(:'currency')
+        self.currency = attributes[:'currency']
+      end
+
+      if attributes.has_key?(:'discardedBy')
+        self.discarded_by = attributes[:'discardedBy']
+      end
+
+      if attributes.has_key?(:'discardedOn')
+        self.discarded_on = attributes[:'discardedOn']
+      end
+
+      if attributes.has_key?(:'id')
+        self.id = attributes[:'id']
+      end
+
+      if attributes.has_key?(:'linkedSpaceId')
+        self.linked_space_id = attributes[:'linkedSpaceId']
+      end
+
+      if attributes.has_key?(:'paymentConnectorConfiguration')
+        self.payment_connector_configuration = attributes[:'paymentConnectorConfiguration']
+      end
+
+      if attributes.has_key?(:'paymentInitiationAdviceFile')
+        self.payment_initiation_advice_file = attributes[:'paymentInitiationAdviceFile']
+      end
+
+      if attributes.has_key?(:'processedBy')
+        self.processed_by = attributes[:'processedBy']
+      end
+
+      if attributes.has_key?(:'processedOn')
+        self.processed_on = attributes[:'processedOn']
+      end
+
+      if attributes.has_key?(:'recipientCity')
+        self.recipient_city = attributes[:'recipientCity']
+      end
+
+      if attributes.has_key?(:'recipientCountry')
+        self.recipient_country = attributes[:'recipientCountry']
+      end
+
+      if attributes.has_key?(:'recipientFamilyName')
+        self.recipient_family_name = attributes[:'recipientFamilyName']
+      end
+
+      if attributes.has_key?(:'recipientGivenName')
+        self.recipient_given_name = attributes[:'recipientGivenName']
+      end
+
+      if attributes.has_key?(:'recipientIban')
+        self.recipient_iban = attributes[:'recipientIban']
+      end
+
+      if attributes.has_key?(:'recipientPostcode')
+        self.recipient_postcode = attributes[:'recipientPostcode']
+      end
+
+      if attributes.has_key?(:'recipientStreet')
+        self.recipient_street = attributes[:'recipientStreet']
+      end
+
+      if attributes.has_key?(:'senderIban')
+        self.sender_iban = attributes[:'senderIban']
+      end
+
+      if attributes.has_key?(:'state')
+        self.state = attributes[:'state']
+      end
+
+      if attributes.has_key?(:'version')
+        self.version = attributes[:'version']
+      end
+
+      if attributes.has_key?(:'refundMerchantReference')
+        self.refund_merchant_reference = attributes[:'refundMerchantReference']
+      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 &&
+          amount == o.amount &&
+          created_on == o.created_on &&
+          currency == o.currency &&
+          discarded_by == o.discarded_by &&
+          discarded_on == o.discarded_on &&
+          id == o.id &&
+          linked_space_id == o.linked_space_id &&
+          payment_connector_configuration == o.payment_connector_configuration &&
+          payment_initiation_advice_file == o.payment_initiation_advice_file &&
+          processed_by == o.processed_by &&
+          processed_on == o.processed_on &&
+          recipient_city == o.recipient_city &&
+          recipient_country == o.recipient_country &&
+          recipient_family_name == o.recipient_family_name &&
+          recipient_given_name == o.recipient_given_name &&
+          recipient_iban == o.recipient_iban &&
+          recipient_postcode == o.recipient_postcode &&
+          recipient_street == o.recipient_street &&
+          sender_iban == o.sender_iban &&
+          state == o.state &&
+          version == o.version &&
+          refund_merchant_reference == o.refund_merchant_reference
+    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
+      [amount, created_on, currency, discarded_by, discarded_on, id, linked_space_id, payment_connector_configuration, payment_initiation_advice_file, processed_by, processed_on, recipient_city, recipient_country, recipient_family_name, recipient_given_name, recipient_iban, recipient_postcode, recipient_street, sender_iban, state, version, refund_merchant_reference].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 = WhiteLabelMachineName.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/whitelabelmachinename-ruby-sdk/models/line_item_type.rb

@@ -24,6 +24,7 @@ module WhiteLabelMachineName
     DISCOUNT = 'DISCOUNT'.freeze
     FEE = 'FEE'.freeze
     PRODUCT = 'PRODUCT'.freeze
+    TIP = 'TIP'.freeze
 
     # Builds the enum from string
     # @param [String] The enum value in the form of the string

data/lib/whitelabelmachinename-ruby-sdk/models/payment_app_charge_attempt_target_state.rb

@@ -0,0 +1,35 @@
+=begin
+The WhiteLabelName API allows an easy interaction with the WhiteLabelName web service.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+
+=end
+
+require 'date'
+
+module WhiteLabelMachineName
+  class PaymentAppChargeAttemptTargetState
+    
+    SUCCESSFUL = 'SUCCESSFUL'.freeze
+    FAILED = 'FAILED'.freeze
+
+    # Builds the enum from string
+    # @param [String] The enum value in the form of the string
+    # @return [String] The enum value
+    def build_from_hash(value)
+      constantValues = PaymentAppChargeAttemptTargetState.constants.select { |c| PaymentAppChargeAttemptTargetState::const_get(c) == value }
+      raise "Invalid ENUM value #{value} for class #PaymentAppChargeAttemptTargetState" if constantValues.empty?
+      value
+    end
+  end
+end

data/lib/whitelabelmachinename-ruby-sdk/models/payment_app_charge_attempt_update_request.rb

@@ -0,0 +1,261 @@
+=begin
+The WhiteLabelName API allows an easy interaction with the WhiteLabelName web service.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+
+=end
+
+require 'date'
+
+module WhiteLabelMachineName
+  # The charge attempt update request allows to change the state of a charge attempt. The charge attempt must be linked with a processor that was created by the payment Web App that invokes the operation.
+  class PaymentAppChargeAttemptUpdateRequest
+    # This is the ID of the charge attempt that should be updated.
+    attr_accessor :charge_attempt_id
+
+    # The end user failure message indicates to the end user (buyer) why the payment failed. The message has to be in the language of the end user. The language is provided within the payment page invocation URL.
+    attr_accessor :end_user_failure_message
+
+    # The failure reason indicates why the charge attempt failed. It is required when the target state is FAILED.
+    attr_accessor :failure_reason_id
+
+    # The reference identifies the charge attempt within the systems of the external service provider. It is required when the target state is SUCCESSFUL.
+    attr_accessor :reference
+
+    # The target state defines the state into which the charge attempt should be switched into. Once the charge attempt changed the state it will not be possible to change it again.
+    attr_accessor :target_state
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'charge_attempt_id' => :'chargeAttemptId',
+        :'end_user_failure_message' => :'endUserFailureMessage',
+        :'failure_reason_id' => :'failureReasonId',
+        :'reference' => :'reference',
+        :'target_state' => :'targetState'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        :'charge_attempt_id' => :'Integer',
+        :'end_user_failure_message' => :'String',
+        :'failure_reason_id' => :'Integer',
+        :'reference' => :'String',
+        :'target_state' => :'PaymentAppChargeAttemptTargetState'
+      }
+    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?(:'chargeAttemptId')
+        self.charge_attempt_id = attributes[:'chargeAttemptId']
+      end
+
+      if attributes.has_key?(:'endUserFailureMessage')
+        self.end_user_failure_message = attributes[:'endUserFailureMessage']
+      end
+
+      if attributes.has_key?(:'failureReasonId')
+        self.failure_reason_id = attributes[:'failureReasonId']
+      end
+
+      if attributes.has_key?(:'reference')
+        self.reference = attributes[:'reference']
+      end
+
+      if attributes.has_key?(:'targetState')
+        self.target_state = attributes[:'targetState']
+      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 !@end_user_failure_message.nil? && @end_user_failure_message.to_s.length > 2000
+        invalid_properties.push('invalid value for "end_user_failure_message", the character length must be smaller than or equal to 2000.')
+      end
+
+      if !@reference.nil? && @reference.to_s.length > 100
+        invalid_properties.push('invalid value for "reference", 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 !@end_user_failure_message.nil? && @end_user_failure_message.to_s.length > 2000
+      return false if !@reference.nil? && @reference.to_s.length > 100
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] end_user_failure_message Value to be assigned
+    def end_user_failure_message=(end_user_failure_message)
+      if !end_user_failure_message.nil? && end_user_failure_message.to_s.length > 2000
+        fail ArgumentError, 'invalid value for "end_user_failure_message", the character length must be smaller than or equal to 2000.'
+      end
+
+      @end_user_failure_message = end_user_failure_message
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] reference Value to be assigned
+    def reference=(reference)
+      if !reference.nil? && reference.to_s.length > 100
+        fail ArgumentError, 'invalid value for "reference", the character length must be smaller than or equal to 100.'
+      end
+
+      @reference = reference
+    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 &&
+          charge_attempt_id == o.charge_attempt_id &&
+          end_user_failure_message == o.end_user_failure_message &&
+          failure_reason_id == o.failure_reason_id &&
+          reference == o.reference &&
+          target_state == o.target_state
+    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
+      [charge_attempt_id, end_user_failure_message, failure_reason_id, reference, target_state].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 = WhiteLabelMachineName.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