cybersource_rest_client 0.0.82 → 0.0.84

data/lib/cybersource_rest_client/models/ptsv1pullfundstransfer_recipient_information.rb

@@ -0,0 +1,607 @@
+=begin
+#CyberSource Merged Spec
+
+#All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html
+
+OpenAPI spec version: 0.0.1
+
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+Swagger Codegen version: 2.4.38
+=end
+
+require 'date'
+
+module CyberSource
+  class Ptsv1pullfundstransferRecipientInformation
+    # Recipient's state. Use the State, Province, and Territory Codes for the United States and Canada. Value must be an ISO Standard State Code:  https://developer.cybersource.com/library/documentation/sbc/quickref/states_and_provinces.pdf 
+    attr_accessor :administrative_area
+
+    # Recipient's postal code. 
+    attr_accessor :postal_code
+
+    # Recipient's country code. Check that this field contains 2-character alpha ISO 3166-1 standard values. 
+    attr_accessor :country
+
+    attr_accessor :personal_identification
+
+    # Recipient's first name. 
+    attr_accessor :first_name
+
+    # Middle Initial of recipient. This field is supported by FDC Compass. 
+    attr_accessor :middle_initial
+
+    # Recipient's middle name. This field is a pass through, which means that CyberSource does not verify the value or modify it in any way before sending it to the processor. If the field is not required for the transaction, CyberSource does not forward it to the processor. 
+    attr_accessor :middle_name
+
+    # Recipient's last name. Conditional field. If `recipientInformation.sameAsSender` = `false`, this field is mandatory. 
+    attr_accessor :last_name
+
+    # Street address of recipient. This field is conditional: it is required if using neither a Customer nor Payment Instrument token. 
+    attr_accessor :address1
+
+    # Second line of the recipient's address. 
+    attr_accessor :address2
+
+    # This field contains the house or the building number of the recipient address. 
+    attr_accessor :building_number
+
+    # Recipient city. 
+    attr_accessor :locality
+
+    # Government-issued identification number.  Conditional: This field is mandatory if the `processingInformation.businessApplicationId` is any of the following:   - `AA` - `PP` - `TU` - `BI` - `WT` - `FT` - and country code = `BR`, `AR`, `CO`, `PE`, in `recipientInformation.countryCode` (Argentina, Brazil, Colombia, and Peru) 
+    attr_accessor :identification_number
+
+    # `B` for Business or `I` for individual.  Conditional:  If `recipientInformation.identificationNumber` is present, then this field is mandatory. 
+    attr_accessor :type
+
+    # Recipient first name, this will be concatenated with the 4-digit originator abbreviation. 
+    attr_accessor :descriptor
+
+    # Identifier for the recipient's account. 
+    attr_accessor :account_id
+
+    # Identifies the recipient's account type. This field is applicable for AFT transactions.  Valid values are:  - `00` Other - `01` Routing transit number (RTN) and bank account - `02` IBAN - `03` Card account - `04` Email - `05` Phone number - `06` Bank account number (BAN) and bank identification code (BIC) - `07` Wallet ID - `08` Social network ID 
+    attr_accessor :account_type
+
+    # Account owner alias name. 
+    attr_accessor :alias_name
+
+    # Account Owner Country of Birth 
+    attr_accessor :country_of_birth
+
+    # Recipient's date of birth. Format: YYYYMMDD. 
+    attr_accessor :date_of_birth
+
+    # Account Owner email address 
+    attr_accessor :email
+
+    # Account Owner Nationality 
+    attr_accessor :nationality
+
+    # Account Owner Occupation 
+    attr_accessor :occupation
+
+    # This field contains the street name of the recipient's address. 
+    attr_accessor :street_name
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'administrative_area' => :'administrativeArea',
+        :'postal_code' => :'postalCode',
+        :'country' => :'country',
+        :'personal_identification' => :'personalIdentification',
+        :'first_name' => :'firstName',
+        :'middle_initial' => :'middleInitial',
+        :'middle_name' => :'middleName',
+        :'last_name' => :'lastName',
+        :'address1' => :'address1',
+        :'address2' => :'address2',
+        :'building_number' => :'buildingNumber',
+        :'locality' => :'locality',
+        :'identification_number' => :'identificationNumber',
+        :'type' => :'type',
+        :'descriptor' => :'descriptor',
+        :'account_id' => :'accountId',
+        :'account_type' => :'accountType',
+        :'alias_name' => :'aliasName',
+        :'country_of_birth' => :'countryOfBirth',
+        :'date_of_birth' => :'dateOfBirth',
+        :'email' => :'email',
+        :'nationality' => :'nationality',
+        :'occupation' => :'occupation',
+        :'street_name' => :'streetName'
+      }
+    end
+
+    # Attribute mapping from JSON key to ruby-style variable name.
+    def self.json_map
+      {
+        :'administrative_area' => :'administrative_area',
+        :'postal_code' => :'postal_code',
+        :'country' => :'country',
+        :'personal_identification' => :'personal_identification',
+        :'first_name' => :'first_name',
+        :'middle_initial' => :'middle_initial',
+        :'middle_name' => :'middle_name',
+        :'last_name' => :'last_name',
+        :'address1' => :'address1',
+        :'address2' => :'address2',
+        :'building_number' => :'building_number',
+        :'locality' => :'locality',
+        :'identification_number' => :'identification_number',
+        :'type' => :'type',
+        :'descriptor' => :'descriptor',
+        :'account_id' => :'account_id',
+        :'account_type' => :'account_type',
+        :'alias_name' => :'alias_name',
+        :'country_of_birth' => :'country_of_birth',
+        :'date_of_birth' => :'date_of_birth',
+        :'email' => :'email',
+        :'nationality' => :'nationality',
+        :'occupation' => :'occupation',
+        :'street_name' => :'street_name'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        :'administrative_area' => :'String',
+        :'postal_code' => :'String',
+        :'country' => :'String',
+        :'personal_identification' => :'Ptsv1pullfundstransferRecipientInformationPersonalIdentification',
+        :'first_name' => :'String',
+        :'middle_initial' => :'String',
+        :'middle_name' => :'String',
+        :'last_name' => :'String',
+        :'address1' => :'String',
+        :'address2' => :'String',
+        :'building_number' => :'String',
+        :'locality' => :'String',
+        :'identification_number' => :'String',
+        :'type' => :'String',
+        :'descriptor' => :'String',
+        :'account_id' => :'String',
+        :'account_type' => :'String',
+        :'alias_name' => :'String',
+        :'country_of_birth' => :'String',
+        :'date_of_birth' => :'String',
+        :'email' => :'String',
+        :'nationality' => :'String',
+        :'occupation' => :'String',
+        :'street_name' => :'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?(:'administrativeArea')
+        self.administrative_area = attributes[:'administrativeArea']
+      end
+
+      if attributes.has_key?(:'postalCode')
+        self.postal_code = attributes[:'postalCode']
+      end
+
+      if attributes.has_key?(:'country')
+        self.country = attributes[:'country']
+      end
+
+      if attributes.has_key?(:'personalIdentification')
+        self.personal_identification = attributes[:'personalIdentification']
+      end
+
+      if attributes.has_key?(:'firstName')
+        self.first_name = attributes[:'firstName']
+      end
+
+      if attributes.has_key?(:'middleInitial')
+        self.middle_initial = attributes[:'middleInitial']
+      end
+
+      if attributes.has_key?(:'middleName')
+        self.middle_name = attributes[:'middleName']
+      end
+
+      if attributes.has_key?(:'lastName')
+        self.last_name = attributes[:'lastName']
+      end
+
+      if attributes.has_key?(:'address1')
+        self.address1 = attributes[:'address1']
+      end
+
+      if attributes.has_key?(:'address2')
+        self.address2 = attributes[:'address2']
+      end
+
+      if attributes.has_key?(:'buildingNumber')
+        self.building_number = attributes[:'buildingNumber']
+      end
+
+      if attributes.has_key?(:'locality')
+        self.locality = attributes[:'locality']
+      end
+
+      if attributes.has_key?(:'identificationNumber')
+        self.identification_number = attributes[:'identificationNumber']
+      end
+
+      if attributes.has_key?(:'type')
+        self.type = attributes[:'type']
+      end
+
+      if attributes.has_key?(:'descriptor')
+        self.descriptor = attributes[:'descriptor']
+      end
+
+      if attributes.has_key?(:'accountId')
+        self.account_id = attributes[:'accountId']
+      end
+
+      if attributes.has_key?(:'accountType')
+        self.account_type = attributes[:'accountType']
+      end
+
+      if attributes.has_key?(:'aliasName')
+        self.alias_name = attributes[:'aliasName']
+      end
+
+      if attributes.has_key?(:'countryOfBirth')
+        self.country_of_birth = attributes[:'countryOfBirth']
+      end
+
+      if attributes.has_key?(:'dateOfBirth')
+        self.date_of_birth = attributes[:'dateOfBirth']
+      end
+
+      if attributes.has_key?(:'email')
+        self.email = attributes[:'email']
+      end
+
+      if attributes.has_key?(:'nationality')
+        self.nationality = attributes[:'nationality']
+      end
+
+      if attributes.has_key?(:'occupation')
+        self.occupation = attributes[:'occupation']
+      end
+
+      if attributes.has_key?(:'streetName')
+        self.street_name = attributes[:'streetName']
+      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 !@country.nil? && @country !~ Regexp.new(/^(\\s{0,2}|.{2})$/)
+        #invalid_properties.push('invalid value for "country", must conform to the pattern /^(\\s{0,2}|.{2})$/.')
+      #end
+
+      #if !@country_of_birth.nil? && @country_of_birth !~ Regexp.new(/^(\\s{0,2}|.{2})$/)
+        #invalid_properties.push('invalid value for "country_of_birth", must conform to the pattern /^(\\s{0,2}|.{2})$/.')
+      #end
+
+      #if !@nationality.nil? && @nationality !~ Regexp.new(/^(\\s{0,2}|.{2})$/)
+        #invalid_properties.push('invalid value for "nationality", must conform to the pattern /^(\\s{0,2}|.{2})$/.')
+      #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 !@country.nil? && @country !~ Regexp.new(/^(\\s{0,2}|.{2})$/)
+      #return false if !@country_of_birth.nil? && @country_of_birth !~ Regexp.new(/^(\\s{0,2}|.{2})$/)
+      #return false if !@nationality.nil? && @nationality !~ Regexp.new(/^(\\s{0,2}|.{2})$/)
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] administrative_area Value to be assigned
+    def administrative_area=(administrative_area)
+      @administrative_area = administrative_area
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] postal_code Value to be assigned
+    def postal_code=(postal_code)
+      @postal_code = postal_code
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] country Value to be assigned
+    def country=(country)
+      #if !country.nil? && country !~ Regexp.new(/^(\\s{0,2}|.{2})$/)
+        #fail ArgumentError, 'invalid value for "country", must conform to the pattern /^(\\s{0,2}|.{2})$/.'
+      #end
+
+      @country = country
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] first_name Value to be assigned
+    def first_name=(first_name)
+      @first_name = first_name
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] middle_initial Value to be assigned
+    def middle_initial=(middle_initial)
+      @middle_initial = middle_initial
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] middle_name Value to be assigned
+    def middle_name=(middle_name)
+      @middle_name = middle_name
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] last_name Value to be assigned
+    def last_name=(last_name)
+      @last_name = last_name
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] address1 Value to be assigned
+    def address1=(address1)
+      @address1 = address1
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] address2 Value to be assigned
+    def address2=(address2)
+      @address2 = address2
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] building_number Value to be assigned
+    def building_number=(building_number)
+      @building_number = building_number
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] locality Value to be assigned
+    def locality=(locality)
+      @locality = locality
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] identification_number Value to be assigned
+    def identification_number=(identification_number)
+      @identification_number = identification_number
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] type Value to be assigned
+    def type=(type)
+      @type = type
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] descriptor Value to be assigned
+    def descriptor=(descriptor)
+      @descriptor = descriptor
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] account_id Value to be assigned
+    def account_id=(account_id)
+      @account_id = account_id
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] account_type Value to be assigned
+    def account_type=(account_type)
+      @account_type = account_type
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] alias_name Value to be assigned
+    def alias_name=(alias_name)
+      @alias_name = alias_name
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] country_of_birth Value to be assigned
+    def country_of_birth=(country_of_birth)
+      #if !country_of_birth.nil? && country_of_birth !~ Regexp.new(/^(\\s{0,2}|.{2})$/)
+        #fail ArgumentError, 'invalid value for "country_of_birth", must conform to the pattern /^(\\s{0,2}|.{2})$/.'
+      #end
+
+      @country_of_birth = country_of_birth
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] date_of_birth Value to be assigned
+    def date_of_birth=(date_of_birth)
+      @date_of_birth = date_of_birth
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] email Value to be assigned
+    def email=(email)
+      @email = email
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] nationality Value to be assigned
+    def nationality=(nationality)
+      #if !nationality.nil? && nationality !~ Regexp.new(/^(\\s{0,2}|.{2})$/)
+        #fail ArgumentError, 'invalid value for "nationality", must conform to the pattern /^(\\s{0,2}|.{2})$/.'
+      #end
+
+      @nationality = nationality
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] occupation Value to be assigned
+    def occupation=(occupation)
+      @occupation = occupation
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] street_name Value to be assigned
+    def street_name=(street_name)
+      @street_name = street_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 &&
+          administrative_area == o.administrative_area &&
+          postal_code == o.postal_code &&
+          country == o.country &&
+          personal_identification == o.personal_identification &&
+          first_name == o.first_name &&
+          middle_initial == o.middle_initial &&
+          middle_name == o.middle_name &&
+          last_name == o.last_name &&
+          address1 == o.address1 &&
+          address2 == o.address2 &&
+          building_number == o.building_number &&
+          locality == o.locality &&
+          identification_number == o.identification_number &&
+          type == o.type &&
+          descriptor == o.descriptor &&
+          account_id == o.account_id &&
+          account_type == o.account_type &&
+          alias_name == o.alias_name &&
+          country_of_birth == o.country_of_birth &&
+          date_of_birth == o.date_of_birth &&
+          email == o.email &&
+          nationality == o.nationality &&
+          occupation == o.occupation &&
+          street_name == o.street_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 [Fixnum] Hash code
+    def hash
+      [administrative_area, postal_code, country, personal_identification, first_name, middle_initial, middle_name, last_name, address1, address2, building_number, locality, identification_number, type, descriptor, account_id, account_type, alias_name, country_of_birth, date_of_birth, email, nationality, occupation, street_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 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 the attribute
+          # is documented as an array but the input is not
+          if attributes[self.class.attribute_map[key]].is_a?(Array)
+            self.send("#{self.class.json_map[key]}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
+          end
+        elsif !attributes[self.class.attribute_map[key]].nil?
+          self.send("#{self.class.json_map[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 = CyberSource.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