cybersource_rest_client 0.0.85 → 0.0.87

data/lib/cybersource_rest_client/models/unifiedrisk_merchant_merchant_descriptor.rb

@@ -0,0 +1,389 @@
+=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 UnifiedriskMerchantMerchantDescriptor
+    # Your merchant name.**Note** For Paymentech processor using Cybersource Payouts, the maximum data length is 22.#### PIN debit Your business name. This name is displayed on the cardholder's statement. When you include more than one consecutive space, extra spaces are removed.When you do not include this value in your PIN debit request, the merchant name from your account is used. **Important** This value must consist of English characters.Optional field for PIN debit credit or PIN debit pu
+    attr_accessor :name
+
+    # Address of company's website provided by merchant
+    attr_accessor :url
+
+    # Primary contact email address of the merchant, used for notifications, dispute communications, and merchant verification purposes
+    attr_accessor :email
+
+    # Primary phone number of the merchant in E.164 format (e.g., +14155552671), used for contact and identity verification
+    attr_accessor :phone_number
+
+    # Risk classification or category assigned to the merchant based on their industry, transaction patterns, and historical fraud rates (e.g., HIGH, MEDIUM, LOW)
+    attr_accessor :risk_profile
+
+    # Names or identifiers of individuals authorized to sign agreements and take financial actions on behalf of the merchant entity
+    attr_accessor :authorized_signatories
+
+    # The date the merchant account was or is scheduled to be closed, in ISO 8601 format (YYYY-MM-DD). Used for tracking merchant lifecycle events
+    attr_accessor :close_date
+
+    # The ISO 3166-1 alpha-3 country code where the merchant business is legally incorporated (e.g., GBR, USA, IND)
+    attr_accessor :country_incorporated
+
+    # The merchant's score as assessed by the acquirer or a credit bureau, used for underwriting and risk decisions during merchant onboarding
+    attr_accessor :credit_score
+
+    # The date the merchant's business was formally established or incorporated, in ISO 8601 format (YYYY-MM-DD). Used for business tenure risk assessment
+    attr_accessor :date_of_establishment
+
+    # The date of the most recent ownership change for the merchant entity, in ISO 8601 format. Ownership changes can indicate elevated risk and require re-underwriting
+    attr_accessor :dateof_ownership_change
+
+    # Indicates whether the merchant supports e-commerce transactions and the level of online payment capability (e.g., FULL, PARTIAL, NONE)
+    attr_accessor :ecommerce_support
+
+    attr_accessor :expected_average_ticket_size
+
+    attr_accessor :expected_annual_sales
+
+    attr_accessor :expected_monthly_sales
+
+    # Defines the type of financial limit applied to the merchant (e.g., SINGLE_TRANSACTION, DAILY, MONTHLY, ANNUAL). Used to enforce risk controls during payment processing
+    attr_accessor :limit_type
+
+    attr_accessor :limit_value
+
+    attr_accessor :hierarchy
+
+    # The primary category of goods or services sold by the merchant (e.g., Electronics, Clothing, Travel Services). Used alongside MCC for granular risk profiling
+    attr_accessor :primary_goods
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'name' => :'name',
+        :'url' => :'url',
+        :'email' => :'email',
+        :'phone_number' => :'phoneNumber',
+        :'risk_profile' => :'riskProfile',
+        :'authorized_signatories' => :'authorizedSignatories',
+        :'close_date' => :'closeDate',
+        :'country_incorporated' => :'countryIncorporated',
+        :'credit_score' => :'creditScore',
+        :'date_of_establishment' => :'dateOfEstablishment',
+        :'dateof_ownership_change' => :'dateofOwnershipChange',
+        :'ecommerce_support' => :'ecommerceSupport',
+        :'expected_average_ticket_size' => :'expectedAverageTicketSize',
+        :'expected_annual_sales' => :'expectedAnnualSales',
+        :'expected_monthly_sales' => :'expectedMonthlySales',
+        :'limit_type' => :'limitType',
+        :'limit_value' => :'limitValue',
+        :'hierarchy' => :'hierarchy',
+        :'primary_goods' => :'primaryGoods'
+      }
+    end
+
+    # Attribute mapping from JSON key to ruby-style variable name.
+    def self.json_map
+      {
+        :'name' => :'name',
+        :'url' => :'url',
+        :'email' => :'email',
+        :'phone_number' => :'phone_number',
+        :'risk_profile' => :'risk_profile',
+        :'authorized_signatories' => :'authorized_signatories',
+        :'close_date' => :'close_date',
+        :'country_incorporated' => :'country_incorporated',
+        :'credit_score' => :'credit_score',
+        :'date_of_establishment' => :'date_of_establishment',
+        :'dateof_ownership_change' => :'dateof_ownership_change',
+        :'ecommerce_support' => :'ecommerce_support',
+        :'expected_average_ticket_size' => :'expected_average_ticket_size',
+        :'expected_annual_sales' => :'expected_annual_sales',
+        :'expected_monthly_sales' => :'expected_monthly_sales',
+        :'limit_type' => :'limit_type',
+        :'limit_value' => :'limit_value',
+        :'hierarchy' => :'hierarchy',
+        :'primary_goods' => :'primary_goods'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        :'name' => :'String',
+        :'url' => :'String',
+        :'email' => :'String',
+        :'phone_number' => :'String',
+        :'risk_profile' => :'String',
+        :'authorized_signatories' => :'String',
+        :'close_date' => :'String',
+        :'country_incorporated' => :'String',
+        :'credit_score' => :'Integer',
+        :'date_of_establishment' => :'String',
+        :'dateof_ownership_change' => :'String',
+        :'ecommerce_support' => :'String',
+        :'expected_average_ticket_size' => :'UnifiedriskMerchantMerchantDescriptorExpectedAverageTicketSize',
+        :'expected_annual_sales' => :'UnifiedriskMerchantMerchantDescriptorExpectedAnnualSales',
+        :'expected_monthly_sales' => :'UnifiedriskMerchantMerchantDescriptorExpectedMonthlySales',
+        :'limit_type' => :'String',
+        :'limit_value' => :'UnifiedriskMerchantMerchantDescriptorLimitValue',
+        :'hierarchy' => :'UnifiedriskMerchantMerchantDescriptorHierarchy',
+        :'primary_goods' => :'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?(:'name')
+        self.name = attributes[:'name']
+      end
+
+      if attributes.has_key?(:'url')
+        self.url = attributes[:'url']
+      end
+
+      if attributes.has_key?(:'email')
+        self.email = attributes[:'email']
+      end
+
+      if attributes.has_key?(:'phoneNumber')
+        self.phone_number = attributes[:'phoneNumber']
+      end
+
+      if attributes.has_key?(:'riskProfile')
+        self.risk_profile = attributes[:'riskProfile']
+      end
+
+      if attributes.has_key?(:'authorizedSignatories')
+        self.authorized_signatories = attributes[:'authorizedSignatories']
+      end
+
+      if attributes.has_key?(:'closeDate')
+        self.close_date = attributes[:'closeDate']
+      end
+
+      if attributes.has_key?(:'countryIncorporated')
+        self.country_incorporated = attributes[:'countryIncorporated']
+      end
+
+      if attributes.has_key?(:'creditScore')
+        self.credit_score = attributes[:'creditScore']
+      end
+
+      if attributes.has_key?(:'dateOfEstablishment')
+        self.date_of_establishment = attributes[:'dateOfEstablishment']
+      end
+
+      if attributes.has_key?(:'dateofOwnershipChange')
+        self.dateof_ownership_change = attributes[:'dateofOwnershipChange']
+      end
+
+      if attributes.has_key?(:'ecommerceSupport')
+        self.ecommerce_support = attributes[:'ecommerceSupport']
+      end
+
+      if attributes.has_key?(:'expectedAverageTicketSize')
+        self.expected_average_ticket_size = attributes[:'expectedAverageTicketSize']
+      end
+
+      if attributes.has_key?(:'expectedAnnualSales')
+        self.expected_annual_sales = attributes[:'expectedAnnualSales']
+      end
+
+      if attributes.has_key?(:'expectedMonthlySales')
+        self.expected_monthly_sales = attributes[:'expectedMonthlySales']
+      end
+
+      if attributes.has_key?(:'limitType')
+        self.limit_type = attributes[:'limitType']
+      end
+
+      if attributes.has_key?(:'limitValue')
+        self.limit_value = attributes[:'limitValue']
+      end
+
+      if attributes.has_key?(:'hierarchy')
+        self.hierarchy = attributes[:'hierarchy']
+      end
+
+      if attributes.has_key?(:'primaryGoods')
+        self.primary_goods = attributes[:'primaryGoods']
+      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
+
+    # Custom attribute writer method with validation
+    # @param [Object] url Value to be assigned
+    def url=(url)
+      @url = url
+    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 &&
+          name == o.name &&
+          url == o.url &&
+          email == o.email &&
+          phone_number == o.phone_number &&
+          risk_profile == o.risk_profile &&
+          authorized_signatories == o.authorized_signatories &&
+          close_date == o.close_date &&
+          country_incorporated == o.country_incorporated &&
+          credit_score == o.credit_score &&
+          date_of_establishment == o.date_of_establishment &&
+          dateof_ownership_change == o.dateof_ownership_change &&
+          ecommerce_support == o.ecommerce_support &&
+          expected_average_ticket_size == o.expected_average_ticket_size &&
+          expected_annual_sales == o.expected_annual_sales &&
+          expected_monthly_sales == o.expected_monthly_sales &&
+          limit_type == o.limit_type &&
+          limit_value == o.limit_value &&
+          hierarchy == o.hierarchy &&
+          primary_goods == o.primary_goods
+    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
+      [name, url, email, phone_number, risk_profile, authorized_signatories, close_date, country_incorporated, credit_score, date_of_establishment, dateof_ownership_change, ecommerce_support, expected_average_ticket_size, expected_annual_sales, expected_monthly_sales, limit_type, limit_value, hierarchy, primary_goods].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

data/lib/cybersource_rest_client/models/unifiedrisk_merchant_merchant_descriptor_expected_annual_sales.rb

@@ -0,0 +1,268 @@
+=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
+  # Merchant's projected annual sales volume and value, declared during onboarding and used for risk threshold calibration
+  class UnifiedriskMerchantMerchantDescriptorExpectedAnnualSales
+    # Nested container for expected annual sales data
+    attr_accessor :expected_annual_sales
+
+    # ISO 4217 3-letter code for the base reference currency for annual sales
+    attr_accessor :base_currency
+
+    # Expected annual sales value in the base currency, in minor units
+    attr_accessor :base_value
+
+    # ISO 4217 3-letter currency code for the expected annual sales amount
+    attr_accessor :currency
+
+    # ISO 4217 3-letter code for the merchant's local currency for annual sales
+    attr_accessor :merchant_currency
+
+    # Expected annual sales in the merchant's local currency, in minor units
+    attr_accessor :merchant_value
+
+    # Expected annual sales amount in the specified currency, in minor units
+    attr_accessor :value
+
+    # Expected number of transactions per year, used alongside sales value for per-transaction risk profiling
+    attr_accessor :expected_annual_volume
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'expected_annual_sales' => :'expectedAnnualSales',
+        :'base_currency' => :'baseCurrency',
+        :'base_value' => :'baseValue',
+        :'currency' => :'currency',
+        :'merchant_currency' => :'merchantCurrency',
+        :'merchant_value' => :'merchantValue',
+        :'value' => :'value',
+        :'expected_annual_volume' => :'expectedAnnualVolume'
+      }
+    end
+
+    # Attribute mapping from JSON key to ruby-style variable name.
+    def self.json_map
+      {
+        :'expected_annual_sales' => :'expected_annual_sales',
+        :'base_currency' => :'base_currency',
+        :'base_value' => :'base_value',
+        :'currency' => :'currency',
+        :'merchant_currency' => :'merchant_currency',
+        :'merchant_value' => :'merchant_value',
+        :'value' => :'value',
+        :'expected_annual_volume' => :'expected_annual_volume'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        :'expected_annual_sales' => :'Object',
+        :'base_currency' => :'String',
+        :'base_value' => :'Integer',
+        :'currency' => :'String',
+        :'merchant_currency' => :'String',
+        :'merchant_value' => :'Integer',
+        :'value' => :'Integer',
+        :'expected_annual_volume' => :'Integer'
+      }
+    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?(:'expectedAnnualSales')
+        self.expected_annual_sales = attributes[:'expectedAnnualSales']
+      end
+
+      if attributes.has_key?(:'baseCurrency')
+        self.base_currency = attributes[:'baseCurrency']
+      end
+
+      if attributes.has_key?(:'baseValue')
+        self.base_value = attributes[:'baseValue']
+      end
+
+      if attributes.has_key?(:'currency')
+        self.currency = attributes[:'currency']
+      end
+
+      if attributes.has_key?(:'merchantCurrency')
+        self.merchant_currency = attributes[:'merchantCurrency']
+      end
+
+      if attributes.has_key?(:'merchantValue')
+        self.merchant_value = attributes[:'merchantValue']
+      end
+
+      if attributes.has_key?(:'value')
+        self.value = attributes[:'value']
+      end
+
+      if attributes.has_key?(:'expectedAnnualVolume')
+        self.expected_annual_volume = attributes[:'expectedAnnualVolume']
+      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 &&
+          expected_annual_sales == o.expected_annual_sales &&
+          base_currency == o.base_currency &&
+          base_value == o.base_value &&
+          currency == o.currency &&
+          merchant_currency == o.merchant_currency &&
+          merchant_value == o.merchant_value &&
+          value == o.value &&
+          expected_annual_volume == o.expected_annual_volume
+    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
+      [expected_annual_sales, base_currency, base_value, currency, merchant_currency, merchant_value, value, expected_annual_volume].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