cybersource-apimatic-sdk 0.0.1

data/lib/cyber_source_merged_spec/models/merchant_defined_field_definition_request.rb

@@ -0,0 +1,214 @@
+# cyber_source_merged_spec
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module CyberSourceMergedSpec
+  # MerchantDefinedFieldDefinitionRequest Model.
+  class MerchantDefinedFieldDefinitionRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [FieldType]
+    attr_accessor :field_type
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :label
+
+    # TODO: Write general description for this method
+    # @return [TrueClass | FalseClass]
+    attr_accessor :customer_visible
+
+    # Should be used only if fieldType = "text"
+    # @return [Integer]
+    attr_accessor :text_min_length
+
+    # Should be used only if fieldType = "text"
+    # @return [Integer]
+    attr_accessor :text_max_length
+
+    # Should be used only if fieldType = "text"
+    # @return [String]
+    attr_accessor :text_default_value
+
+    # Should be mandatory and used only if fieldType = "select"
+    # @return [String]
+    attr_accessor :possible_values
+
+    # Should be mandatory and used only if fieldType = "select"
+    # @return [TrueClass | FalseClass]
+    attr_accessor :read_only
+
+    # Should be mandatory and used only if fieldType = "select"
+    # @return [Integer]
+    attr_accessor :merchant_defined_data_index
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['field_type'] = 'fieldType'
+      @_hash['label'] = 'label'
+      @_hash['customer_visible'] = 'customerVisible'
+      @_hash['text_min_length'] = 'textMinLength'
+      @_hash['text_max_length'] = 'textMaxLength'
+      @_hash['text_default_value'] = 'textDefaultValue'
+      @_hash['possible_values'] = 'possibleValues'
+      @_hash['read_only'] = 'readOnly'
+      @_hash['merchant_defined_data_index'] = 'merchantDefinedDataIndex'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        customer_visible
+        text_min_length
+        text_max_length
+        text_default_value
+        possible_values
+        read_only
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(field_type:, label:, merchant_defined_data_index:,
+                   customer_visible: false, text_min_length: 0,
+                   text_max_length: 100, text_default_value: SKIP,
+                   possible_values: SKIP, read_only: false,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @field_type = field_type
+      @label = label
+      @customer_visible = customer_visible unless customer_visible == SKIP
+      @text_min_length = text_min_length unless text_min_length == SKIP
+      @text_max_length = text_max_length unless text_max_length == SKIP
+      @text_default_value = text_default_value unless text_default_value == SKIP
+      @possible_values = possible_values unless possible_values == SKIP
+      @read_only = read_only unless read_only == SKIP
+      @merchant_defined_data_index = merchant_defined_data_index
+      @additional_properties = additional_properties
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      field_type = hash.key?('fieldType') ? hash['fieldType'] : nil
+      label = hash.key?('label') ? hash['label'] : nil
+      merchant_defined_data_index =
+        hash.key?('merchantDefinedDataIndex') ? hash['merchantDefinedDataIndex'] : nil
+      customer_visible = hash['customerVisible'] ||= false
+      text_min_length = hash['textMinLength'] ||= 0
+      text_max_length = hash['textMaxLength'] ||= 100
+      text_default_value =
+        hash.key?('textDefaultValue') ? hash['textDefaultValue'] : SKIP
+      possible_values =
+        hash.key?('possibleValues') ? hash['possibleValues'] : SKIP
+      read_only = hash['readOnly'] ||= false
+
+      # Create a new hash for additional properties, removing known properties.
+      new_hash = hash.reject { |k, _| names.value?(k) }
+
+      additional_properties = APIHelper.get_additional_properties(
+        new_hash, proc { |value| value }
+      )
+
+      # Create object from extracted values.
+      MerchantDefinedFieldDefinitionRequest.new(field_type: field_type,
+                                                label: label,
+                                                merchant_defined_data_index: merchant_defined_data_index,
+                                                customer_visible: customer_visible,
+                                                text_min_length: text_min_length,
+                                                text_max_length: text_max_length,
+                                                text_default_value: text_default_value,
+                                                possible_values: possible_values,
+                                                read_only: read_only,
+                                                additional_properties: additional_properties)
+    end
+
+    def self.from_element(root)
+      field_type = XmlUtilities.from_element(root, 'fieldType', String)
+      label = XmlUtilities.from_element(root, 'label', String)
+      merchant_defined_data_index = XmlUtilities.from_element(
+        root, 'merchantDefinedDataIndex', Integer
+      )
+      customer_visible = XmlUtilities.from_element(root, 'customerVisible',
+                                                   TrueClass)
+      text_min_length = XmlUtilities.from_element(root, 'textMinLength',
+                                                  Integer)
+      text_max_length = XmlUtilities.from_element(root, 'textMaxLength',
+                                                  Integer)
+      text_default_value = XmlUtilities.from_element(root, 'textDefaultValue',
+                                                     String)
+      possible_values = XmlUtilities.from_element(root, 'possibleValues',
+                                                  String)
+      read_only = XmlUtilities.from_element(root, 'readOnly', TrueClass)
+
+      new(field_type: field_type,
+          label: label,
+          merchant_defined_data_index: merchant_defined_data_index,
+          customer_visible: customer_visible,
+          text_min_length: text_min_length,
+          text_max_length: text_max_length,
+          text_default_value: text_default_value,
+          possible_values: possible_values,
+          read_only: read_only,
+          additional_properties: additional_properties)
+    end
+
+    def to_xml_element(doc, root_name)
+      root = doc.create_element(root_name)
+
+      XmlUtilities.add_as_subelement(doc, root, 'fieldType', field_type)
+      XmlUtilities.add_as_subelement(doc, root, 'label', label)
+      XmlUtilities.add_as_subelement(doc, root, 'merchantDefinedDataIndex',
+                                     merchant_defined_data_index)
+      XmlUtilities.add_as_subelement(doc, root, 'customerVisible',
+                                     customer_visible)
+      XmlUtilities.add_as_subelement(doc, root, 'textMinLength',
+                                     text_min_length)
+      XmlUtilities.add_as_subelement(doc, root, 'textMaxLength',
+                                     text_max_length)
+      XmlUtilities.add_as_subelement(doc, root, 'textDefaultValue',
+                                     text_default_value)
+      XmlUtilities.add_as_subelement(doc, root, 'possibleValues',
+                                     possible_values)
+      XmlUtilities.add_as_subelement(doc, root, 'readOnly', read_only)
+      XmlUtilities.add_as_subelement(doc, root, 'additional_properties',
+                                     additional_properties)
+
+      root
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} field_type: #{@field_type}, label: #{@label}, customer_visible:"\
+      " #{@customer_visible}, text_min_length: #{@text_min_length}, text_max_length:"\
+      " #{@text_max_length}, text_default_value: #{@text_default_value}, possible_values:"\
+      " #{@possible_values}, read_only: #{@read_only}, merchant_defined_data_index:"\
+      " #{@merchant_defined_data_index}, additional_properties: #{@additional_properties}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} field_type: #{@field_type.inspect}, label: #{@label.inspect},"\
+      " customer_visible: #{@customer_visible.inspect}, text_min_length:"\
+      " #{@text_min_length.inspect}, text_max_length: #{@text_max_length.inspect},"\
+      " text_default_value: #{@text_default_value.inspect}, possible_values:"\
+      " #{@possible_values.inspect}, read_only: #{@read_only.inspect},"\
+      " merchant_defined_data_index: #{@merchant_defined_data_index.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/cyber_source_merged_spec/models/merchant_defined_field_value.rb

@@ -0,0 +1,105 @@
+# cyber_source_merged_spec
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module CyberSourceMergedSpec
+  # MerchantDefinedFieldValue Model.
+  class MerchantDefinedFieldValue < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [Integer]
+    attr_accessor :definition_id
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :value
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['definition_id'] = 'definitionId'
+      @_hash['value'] = 'value'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        definition_id
+        value
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(definition_id: SKIP, value: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @definition_id = definition_id unless definition_id == SKIP
+      @value = value unless value == SKIP
+      @additional_properties = additional_properties
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      definition_id = hash.key?('definitionId') ? hash['definitionId'] : SKIP
+      value = hash.key?('value') ? hash['value'] : SKIP
+
+      # Create a new hash for additional properties, removing known properties.
+      new_hash = hash.reject { |k, _| names.value?(k) }
+
+      additional_properties = APIHelper.get_additional_properties(
+        new_hash, proc { |value| value }
+      )
+
+      # Create object from extracted values.
+      MerchantDefinedFieldValue.new(definition_id: definition_id,
+                                    value: value,
+                                    additional_properties: additional_properties)
+    end
+
+    def self.from_element(root)
+      definition_id = XmlUtilities.from_element(root, 'definitionId', Integer)
+      value = XmlUtilities.from_element(root, 'value', String)
+
+      new(definition_id: definition_id,
+          value: value,
+          additional_properties: additional_properties)
+    end
+
+    def to_xml_element(doc, root_name)
+      root = doc.create_element(root_name)
+
+      XmlUtilities.add_as_subelement(doc, root, 'definitionId', definition_id)
+      XmlUtilities.add_as_subelement(doc, root, 'value', value)
+      XmlUtilities.add_as_subelement(doc, root, 'additional_properties',
+                                     additional_properties)
+
+      root
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} definition_id: #{@definition_id}, value: #{@value}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} definition_id: #{@definition_id.inspect}, value: #{@value.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/cyber_source_merged_spec/models/merchant_defined_field_values_with_definition.rb

@@ -0,0 +1,277 @@
+# cyber_source_merged_spec
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module CyberSourceMergedSpec
+  # MerchantDefinedFieldValuesWithDefinition Model.
+  class MerchantDefinedFieldValuesWithDefinition < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :reference_type
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :label
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :field_type
+
+    # TODO: Write general description for this method
+    # @return [TrueClass | FalseClass]
+    attr_accessor :customer_visible
+
+    # TODO: Write general description for this method
+    # @return [TrueClass | FalseClass]
+    attr_accessor :read_only
+
+    # TODO: Write general description for this method
+    # @return [Integer]
+    attr_accessor :text_min_length
+
+    # TODO: Write general description for this method
+    # @return [Integer]
+    attr_accessor :text_max_length
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :text_default_value
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :possible_values
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :value
+
+    # TODO: Write general description for this method
+    # @return [Integer]
+    attr_accessor :position
+
+    # TODO: Write general description for this method
+    # @return [Integer]
+    attr_accessor :definition_id
+
+    # TODO: Write general description for this method
+    # @return [Integer]
+    attr_accessor :merchant_defined_data_index
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['reference_type'] = 'referenceType'
+      @_hash['label'] = 'label'
+      @_hash['field_type'] = 'fieldType'
+      @_hash['customer_visible'] = 'customerVisible'
+      @_hash['read_only'] = 'readOnly'
+      @_hash['text_min_length'] = 'textMinLength'
+      @_hash['text_max_length'] = 'textMaxLength'
+      @_hash['text_default_value'] = 'textDefaultValue'
+      @_hash['possible_values'] = 'possibleValues'
+      @_hash['value'] = 'value'
+      @_hash['position'] = 'position'
+      @_hash['definition_id'] = 'definitionId'
+      @_hash['merchant_defined_data_index'] = 'merchantDefinedDataIndex'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        reference_type
+        label
+        field_type
+        customer_visible
+        read_only
+        text_min_length
+        text_max_length
+        text_default_value
+        possible_values
+        value
+        position
+        definition_id
+        merchant_defined_data_index
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(reference_type: SKIP, label: SKIP, field_type: SKIP,
+                   customer_visible: SKIP, read_only: SKIP,
+                   text_min_length: SKIP, text_max_length: SKIP,
+                   text_default_value: SKIP, possible_values: SKIP, value: SKIP,
+                   position: SKIP, definition_id: SKIP,
+                   merchant_defined_data_index: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @reference_type = reference_type unless reference_type == SKIP
+      @label = label unless label == SKIP
+      @field_type = field_type unless field_type == SKIP
+      @customer_visible = customer_visible unless customer_visible == SKIP
+      @read_only = read_only unless read_only == SKIP
+      @text_min_length = text_min_length unless text_min_length == SKIP
+      @text_max_length = text_max_length unless text_max_length == SKIP
+      @text_default_value = text_default_value unless text_default_value == SKIP
+      @possible_values = possible_values unless possible_values == SKIP
+      @value = value unless value == SKIP
+      @position = position unless position == SKIP
+      @definition_id = definition_id unless definition_id == SKIP
+      unless merchant_defined_data_index == SKIP
+        @merchant_defined_data_index =
+          merchant_defined_data_index
+      end
+      @additional_properties = additional_properties
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      reference_type = hash.key?('referenceType') ? hash['referenceType'] : SKIP
+      label = hash.key?('label') ? hash['label'] : SKIP
+      field_type = hash.key?('fieldType') ? hash['fieldType'] : SKIP
+      customer_visible =
+        hash.key?('customerVisible') ? hash['customerVisible'] : SKIP
+      read_only = hash.key?('readOnly') ? hash['readOnly'] : SKIP
+      text_min_length =
+        hash.key?('textMinLength') ? hash['textMinLength'] : SKIP
+      text_max_length =
+        hash.key?('textMaxLength') ? hash['textMaxLength'] : SKIP
+      text_default_value =
+        hash.key?('textDefaultValue') ? hash['textDefaultValue'] : SKIP
+      possible_values =
+        hash.key?('possibleValues') ? hash['possibleValues'] : SKIP
+      value = hash.key?('value') ? hash['value'] : SKIP
+      position = hash.key?('position') ? hash['position'] : SKIP
+      definition_id = hash.key?('definitionId') ? hash['definitionId'] : SKIP
+      merchant_defined_data_index =
+        hash.key?('merchantDefinedDataIndex') ? hash['merchantDefinedDataIndex'] : SKIP
+
+      # Create a new hash for additional properties, removing known properties.
+      new_hash = hash.reject { |k, _| names.value?(k) }
+
+      additional_properties = APIHelper.get_additional_properties(
+        new_hash, proc { |value| value }
+      )
+
+      # Create object from extracted values.
+      MerchantDefinedFieldValuesWithDefinition.new(reference_type: reference_type,
+                                                   label: label,
+                                                   field_type: field_type,
+                                                   customer_visible: customer_visible,
+                                                   read_only: read_only,
+                                                   text_min_length: text_min_length,
+                                                   text_max_length: text_max_length,
+                                                   text_default_value: text_default_value,
+                                                   possible_values: possible_values,
+                                                   value: value,
+                                                   position: position,
+                                                   definition_id: definition_id,
+                                                   merchant_defined_data_index: merchant_defined_data_index,
+                                                   additional_properties: additional_properties)
+    end
+
+    def self.from_element(root)
+      reference_type = XmlUtilities.from_element(root, 'referenceType', String)
+      label = XmlUtilities.from_element(root, 'label', String)
+      field_type = XmlUtilities.from_element(root, 'fieldType', String)
+      customer_visible = XmlUtilities.from_element(root, 'customerVisible',
+                                                   TrueClass)
+      read_only = XmlUtilities.from_element(root, 'readOnly', TrueClass)
+      text_min_length = XmlUtilities.from_element(root, 'textMinLength',
+                                                  Integer)
+      text_max_length = XmlUtilities.from_element(root, 'textMaxLength',
+                                                  Integer)
+      text_default_value = XmlUtilities.from_element(root, 'textDefaultValue',
+                                                     String)
+      possible_values = XmlUtilities.from_element(root, 'possibleValues',
+                                                  String)
+      value = XmlUtilities.from_element(root, 'value', String)
+      position = XmlUtilities.from_element(root, 'position', Integer)
+      definition_id = XmlUtilities.from_element(root, 'definitionId', Integer)
+      merchant_defined_data_index = XmlUtilities.from_element(
+        root, 'merchantDefinedDataIndex', Integer
+      )
+
+      new(reference_type: reference_type,
+          label: label,
+          field_type: field_type,
+          customer_visible: customer_visible,
+          read_only: read_only,
+          text_min_length: text_min_length,
+          text_max_length: text_max_length,
+          text_default_value: text_default_value,
+          possible_values: possible_values,
+          value: value,
+          position: position,
+          definition_id: definition_id,
+          merchant_defined_data_index: merchant_defined_data_index,
+          additional_properties: additional_properties)
+    end
+
+    def to_xml_element(doc, root_name)
+      root = doc.create_element(root_name)
+
+      XmlUtilities.add_as_subelement(doc, root, 'referenceType', reference_type)
+      XmlUtilities.add_as_subelement(doc, root, 'label', label)
+      XmlUtilities.add_as_subelement(doc, root, 'fieldType', field_type)
+      XmlUtilities.add_as_subelement(doc, root, 'customerVisible',
+                                     customer_visible)
+      XmlUtilities.add_as_subelement(doc, root, 'readOnly', read_only)
+      XmlUtilities.add_as_subelement(doc, root, 'textMinLength',
+                                     text_min_length)
+      XmlUtilities.add_as_subelement(doc, root, 'textMaxLength',
+                                     text_max_length)
+      XmlUtilities.add_as_subelement(doc, root, 'textDefaultValue',
+                                     text_default_value)
+      XmlUtilities.add_as_subelement(doc, root, 'possibleValues',
+                                     possible_values)
+      XmlUtilities.add_as_subelement(doc, root, 'value', value)
+      XmlUtilities.add_as_subelement(doc, root, 'position', position)
+      XmlUtilities.add_as_subelement(doc, root, 'definitionId', definition_id)
+      XmlUtilities.add_as_subelement(doc, root, 'merchantDefinedDataIndex',
+                                     merchant_defined_data_index)
+      XmlUtilities.add_as_subelement(doc, root, 'additional_properties',
+                                     additional_properties)
+
+      root
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} reference_type: #{@reference_type}, label: #{@label}, field_type:"\
+      " #{@field_type}, customer_visible: #{@customer_visible}, read_only: #{@read_only},"\
+      " text_min_length: #{@text_min_length}, text_max_length: #{@text_max_length},"\
+      " text_default_value: #{@text_default_value}, possible_values: #{@possible_values}, value:"\
+      " #{@value}, position: #{@position}, definition_id: #{@definition_id},"\
+      " merchant_defined_data_index: #{@merchant_defined_data_index}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} reference_type: #{@reference_type.inspect}, label: #{@label.inspect},"\
+      " field_type: #{@field_type.inspect}, customer_visible: #{@customer_visible.inspect},"\
+      " read_only: #{@read_only.inspect}, text_min_length: #{@text_min_length.inspect},"\
+      " text_max_length: #{@text_max_length.inspect}, text_default_value:"\
+      " #{@text_default_value.inspect}, possible_values: #{@possible_values.inspect}, value:"\
+      " #{@value.inspect}, position: #{@position.inspect}, definition_id:"\
+      " #{@definition_id.inspect}, merchant_defined_data_index:"\
+      " #{@merchant_defined_data_index.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end