fdx-apimatic-sdk 0.0.1

data/lib/fdx_v660_api/models/order_type.rb

@@ -0,0 +1,60 @@
+# fdx_v660_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxV660Api
+  # The type of the order
+  class OrderType
+    ORDER_TYPE = [
+      # TODO: Write general description for BUY
+      BUY = 'BUY'.freeze,
+
+      # TODO: Write general description for BUYTOCOVER
+      BUYTOCOVER = 'BUYTOCOVER'.freeze,
+
+      # TODO: Write general description for BUYTOOPEN
+      BUYTOOPEN = 'BUYTOOPEN'.freeze,
+
+      # TODO: Write general description for SELL
+      SELL = 'SELL'.freeze,
+
+      # TODO: Write general description for SELLCLOSE
+      SELLCLOSE = 'SELLCLOSE'.freeze,
+
+      # TODO: Write general description for SELLSHORT
+      SELLSHORT = 'SELLSHORT'.freeze,
+
+      # TODO: Write general description for SELLTOCOVER
+      SELLTOCOVER = 'SELLTOCOVER'.freeze,
+
+      # TODO: Write general description for SELLTOOPEN
+      SELLTOOPEN = 'SELLTOOPEN'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+
+    def self.from_value(value, default_value = BUY)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'buy' then BUY
+      when 'buytocover' then BUYTOCOVER
+      when 'buytoopen' then BUYTOOPEN
+      when 'sell' then SELL
+      when 'sellclose' then SELLCLOSE
+      when 'sellshort' then SELLSHORT
+      when 'selltocover' then SELLTOCOVER
+      when 'selltoopen' then SELLTOOPEN
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/fdx_v660_api/models/order_type2.rb

@@ -0,0 +1,61 @@
+# fdx_v660_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxV660Api
+  # Type of order. One of BUY, SELL, BUYTOCOVER, BUYTOOPEN, SELLTOCOVER,
+  # SELLTOOPEN, SELLSHORT, SELLCLOSE
+  class OrderType2
+    ORDER_TYPE2 = [
+      # TODO: Write general description for BUY
+      BUY = 'BUY'.freeze,
+
+      # TODO: Write general description for BUYTOCOVER
+      BUYTOCOVER = 'BUYTOCOVER'.freeze,
+
+      # TODO: Write general description for BUYTOOPEN
+      BUYTOOPEN = 'BUYTOOPEN'.freeze,
+
+      # TODO: Write general description for SELL
+      SELL = 'SELL'.freeze,
+
+      # TODO: Write general description for SELLCLOSE
+      SELLCLOSE = 'SELLCLOSE'.freeze,
+
+      # TODO: Write general description for SELLSHORT
+      SELLSHORT = 'SELLSHORT'.freeze,
+
+      # TODO: Write general description for SELLTOCOVER
+      SELLTOCOVER = 'SELLTOCOVER'.freeze,
+
+      # TODO: Write general description for SELLTOOPEN
+      SELLTOOPEN = 'SELLTOOPEN'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+
+    def self.from_value(value, default_value = BUY)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'buy' then BUY
+      when 'buytocover' then BUYTOCOVER
+      when 'buytoopen' then BUYTOOPEN
+      when 'sell' then SELL
+      when 'sellclose' then SELLCLOSE
+      when 'sellshort' then SELLSHORT
+      when 'selltocover' then SELLTOCOVER
+      when 'selltoopen' then SELLTOOPEN
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/fdx_v660_api/models/organization_name_entity.rb

@@ -0,0 +1,89 @@
+# fdx_v660_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxV660Api
+  # Logical grouping of name attributes that are particular to an Organization
+  # type of payment initiation party. Japanese participants should send 'Kana'
+  # values in name fields using the character set defined by Zengin (Japanese
+  # Banks' Payment Clearing Network)
+  class OrganizationNameEntity < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Name value of the organization
+    # @return [String]
+    attr_accessor :company_name
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['company_name'] = 'companyName'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        company_name
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(company_name: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @company_name = company_name unless company_name == 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.
+      company_name = hash.key?('companyName') ? hash['companyName'] : 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.
+      OrganizationNameEntity.new(company_name: company_name,
+                                 additional_properties: additional_properties)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [OrganizationNameEntity | Hash] The value against the validation is performed.
+    def self.validate(value)
+      return true if value.instance_of? self
+
+      return false unless value.instance_of? Hash
+
+      true
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} company_name: #{@company_name}, 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} company_name: #{@company_name.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/fdx_v660_api/models/other_security_entity.rb

@@ -0,0 +1,106 @@
+# fdx_v660_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+require_relative 'security_entity'
+
+module FdxV660Api
+  # Any other kind of security
+  class OtherSecurityEntity < SecurityEntity
+    # Description of other security
+    # @return [String]
+    attr_accessor :type_description
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['type_description'] = 'typeDescription'
+      @_hash = super().merge(@_hash)
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      _arr = %w[
+        type_description
+      ]
+      (_arr << super()).flatten!
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      _arr = []
+      (_arr << super()).flatten!
+    end
+
+    def initialize(type_description: SKIP,
+                   security_category: 'Other Security entity',
+                   fi_attributes: SKIP, additional_properties: nil)
+      @type_description = type_description unless type_description == SKIP
+      @additional_properties = additional_properties
+
+      # Call the constructor of the base class
+      super(security_category: security_category,
+            fi_attributes: fi_attributes,
+            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.
+      type_description =
+        hash.key?('typeDescription') ? hash['typeDescription'] : SKIP
+      security_category = hash['securityCategory'] ||= 'Other Security entity'
+      # Parameter is an array, so we need to iterate through it
+      fi_attributes = nil
+      unless hash['fiAttributes'].nil?
+        fi_attributes = []
+        hash['fiAttributes'].each do |structure|
+          fi_attributes << (FiAttributeEntity.from_hash(structure) if structure)
+        end
+      end
+
+      fi_attributes = SKIP unless hash.key?('fiAttributes')
+
+      # 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.
+      OtherSecurityEntity.new(type_description: type_description,
+                              security_category: security_category,
+                              fi_attributes: fi_attributes,
+                              additional_properties: additional_properties)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [OtherSecurityEntity | Hash] The value against the validation is performed.
+    def self.validate(value)
+      return true if value.instance_of? self
+
+      return false unless value.instance_of? Hash
+
+      true
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      super_string = super().sub(/^<[^ ]+ /, '').sub(/>$/, '')
+      "<#{class_name} #{super_string}, type_description: #{@type_description}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      super_string = super().inspect.sub(/^<[^ ]+ /, '').sub(/>$/, '')
+      "<#{class_name} #{super_string}, type_description: #{@type_description.inspect}>"
+    end
+  end
+end

data/lib/fdx_v660_api/models/page_metadata.rb

@@ -0,0 +1,134 @@
+# fdx_v660_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxV660Api
+  # Page keys for navigating result sets
+  class PageMetadata < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Opaque identifier. Does not need to be numeric or have any specific
+    # pattern. Deprecated in favor of nextPageKey, will be removed with a future
+    # major release
+    # @return [String]
+    attr_accessor :next_offset
+
+    # Opaque identifier. Does not need to be numeric or have any specific
+    # pattern. Implementation specific
+    # @return [String]
+    attr_accessor :next_page_key
+
+    # Opaque identifier. Does not need to be numeric or have any specific
+    # pattern. Deprecated in favor of previousPageKey, will be removed with a
+    # future major release
+    # @return [String]
+    attr_accessor :prev_offset
+
+    # Opaque identifier. Does not need to be numeric or have any specific
+    # pattern. Implementation specific
+    # @return [String]
+    attr_accessor :previous_page_key
+
+    # Total number of elements
+    # @return [Integer]
+    attr_accessor :total_elements
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['next_offset'] = 'nextOffset'
+      @_hash['next_page_key'] = 'nextPageKey'
+      @_hash['prev_offset'] = 'prevOffset'
+      @_hash['previous_page_key'] = 'previousPageKey'
+      @_hash['total_elements'] = 'totalElements'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        next_offset
+        next_page_key
+        prev_offset
+        previous_page_key
+        total_elements
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(next_offset: SKIP, next_page_key: SKIP, prev_offset: SKIP,
+                   previous_page_key: SKIP, total_elements: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @next_offset = next_offset unless next_offset == SKIP
+      @next_page_key = next_page_key unless next_page_key == SKIP
+      @prev_offset = prev_offset unless prev_offset == SKIP
+      @previous_page_key = previous_page_key unless previous_page_key == SKIP
+      @total_elements = total_elements unless total_elements == 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.
+      next_offset = hash.key?('nextOffset') ? hash['nextOffset'] : SKIP
+      next_page_key = hash.key?('nextPageKey') ? hash['nextPageKey'] : SKIP
+      prev_offset = hash.key?('prevOffset') ? hash['prevOffset'] : SKIP
+      previous_page_key =
+        hash.key?('previousPageKey') ? hash['previousPageKey'] : SKIP
+      total_elements = hash.key?('totalElements') ? hash['totalElements'] : 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.
+      PageMetadata.new(next_offset: next_offset,
+                       next_page_key: next_page_key,
+                       prev_offset: prev_offset,
+                       previous_page_key: previous_page_key,
+                       total_elements: total_elements,
+                       additional_properties: additional_properties)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [PageMetadata | Hash] The value against the validation is performed.
+    def self.validate(value)
+      return true if value.instance_of? self
+
+      return false unless value.instance_of? Hash
+
+      true
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} next_offset: #{@next_offset}, next_page_key: #{@next_page_key},"\
+      " prev_offset: #{@prev_offset}, previous_page_key: #{@previous_page_key}, total_elements:"\
+      " #{@total_elements}, 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} next_offset: #{@next_offset.inspect}, next_page_key:"\
+      " #{@next_page_key.inspect}, prev_offset: #{@prev_offset.inspect}, previous_page_key:"\
+      " #{@previous_page_key.inspect}, total_elements: #{@total_elements.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/fdx_v660_api/models/page_metadata3.rb

@@ -0,0 +1,124 @@
+# fdx_v660_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxV660Api
+  # Information required to paginate results
+  class PageMetadata3 < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Opaque identifier. Does not need to be numeric or have any specific
+    # pattern. Deprecated in favor of nextPageKey, will be removed with a future
+    # major release
+    # @return [String]
+    attr_accessor :next_offset
+
+    # Opaque identifier. Does not need to be numeric or have any specific
+    # pattern. Implementation specific
+    # @return [String]
+    attr_accessor :next_page_key
+
+    # Opaque identifier. Does not need to be numeric or have any specific
+    # pattern. Deprecated in favor of previousPageKey, will be removed with a
+    # future major release
+    # @return [String]
+    attr_accessor :prev_offset
+
+    # Opaque identifier. Does not need to be numeric or have any specific
+    # pattern. Implementation specific
+    # @return [String]
+    attr_accessor :previous_page_key
+
+    # Total number of elements
+    # @return [Integer]
+    attr_accessor :total_elements
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['next_offset'] = 'nextOffset'
+      @_hash['next_page_key'] = 'nextPageKey'
+      @_hash['prev_offset'] = 'prevOffset'
+      @_hash['previous_page_key'] = 'previousPageKey'
+      @_hash['total_elements'] = 'totalElements'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        next_offset
+        next_page_key
+        prev_offset
+        previous_page_key
+        total_elements
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(next_offset: SKIP, next_page_key: SKIP, prev_offset: SKIP,
+                   previous_page_key: SKIP, total_elements: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @next_offset = next_offset unless next_offset == SKIP
+      @next_page_key = next_page_key unless next_page_key == SKIP
+      @prev_offset = prev_offset unless prev_offset == SKIP
+      @previous_page_key = previous_page_key unless previous_page_key == SKIP
+      @total_elements = total_elements unless total_elements == 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.
+      next_offset = hash.key?('nextOffset') ? hash['nextOffset'] : SKIP
+      next_page_key = hash.key?('nextPageKey') ? hash['nextPageKey'] : SKIP
+      prev_offset = hash.key?('prevOffset') ? hash['prevOffset'] : SKIP
+      previous_page_key =
+        hash.key?('previousPageKey') ? hash['previousPageKey'] : SKIP
+      total_elements = hash.key?('totalElements') ? hash['totalElements'] : 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.
+      PageMetadata3.new(next_offset: next_offset,
+                        next_page_key: next_page_key,
+                        prev_offset: prev_offset,
+                        previous_page_key: previous_page_key,
+                        total_elements: total_elements,
+                        additional_properties: additional_properties)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} next_offset: #{@next_offset}, next_page_key: #{@next_page_key},"\
+      " prev_offset: #{@prev_offset}, previous_page_key: #{@previous_page_key}, total_elements:"\
+      " #{@total_elements}, 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} next_offset: #{@next_offset.inspect}, next_page_key:"\
+      " #{@next_page_key.inspect}, prev_offset: #{@prev_offset.inspect}, previous_page_key:"\
+      " #{@previous_page_key.inspect}, total_elements: #{@total_elements.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/fdx_v660_api/models/page_metadata5.rb

@@ -0,0 +1,125 @@
+# fdx_v660_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxV660Api
+  # Page keys for navigating result sets. Pagination for
+  # `/accounts/{accountId}/payment-network` is deprecated in v6.5
+  class PageMetadata5 < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Opaque identifier. Does not need to be numeric or have any specific
+    # pattern. Deprecated in favor of nextPageKey, will be removed with a future
+    # major release
+    # @return [String]
+    attr_accessor :next_offset
+
+    # Opaque identifier. Does not need to be numeric or have any specific
+    # pattern. Implementation specific
+    # @return [String]
+    attr_accessor :next_page_key
+
+    # Opaque identifier. Does not need to be numeric or have any specific
+    # pattern. Deprecated in favor of previousPageKey, will be removed with a
+    # future major release
+    # @return [String]
+    attr_accessor :prev_offset
+
+    # Opaque identifier. Does not need to be numeric or have any specific
+    # pattern. Implementation specific
+    # @return [String]
+    attr_accessor :previous_page_key
+
+    # Total number of elements
+    # @return [Integer]
+    attr_accessor :total_elements
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['next_offset'] = 'nextOffset'
+      @_hash['next_page_key'] = 'nextPageKey'
+      @_hash['prev_offset'] = 'prevOffset'
+      @_hash['previous_page_key'] = 'previousPageKey'
+      @_hash['total_elements'] = 'totalElements'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        next_offset
+        next_page_key
+        prev_offset
+        previous_page_key
+        total_elements
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(next_offset: SKIP, next_page_key: SKIP, prev_offset: SKIP,
+                   previous_page_key: SKIP, total_elements: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @next_offset = next_offset unless next_offset == SKIP
+      @next_page_key = next_page_key unless next_page_key == SKIP
+      @prev_offset = prev_offset unless prev_offset == SKIP
+      @previous_page_key = previous_page_key unless previous_page_key == SKIP
+      @total_elements = total_elements unless total_elements == 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.
+      next_offset = hash.key?('nextOffset') ? hash['nextOffset'] : SKIP
+      next_page_key = hash.key?('nextPageKey') ? hash['nextPageKey'] : SKIP
+      prev_offset = hash.key?('prevOffset') ? hash['prevOffset'] : SKIP
+      previous_page_key =
+        hash.key?('previousPageKey') ? hash['previousPageKey'] : SKIP
+      total_elements = hash.key?('totalElements') ? hash['totalElements'] : 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.
+      PageMetadata5.new(next_offset: next_offset,
+                        next_page_key: next_page_key,
+                        prev_offset: prev_offset,
+                        previous_page_key: previous_page_key,
+                        total_elements: total_elements,
+                        additional_properties: additional_properties)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} next_offset: #{@next_offset}, next_page_key: #{@next_page_key},"\
+      " prev_offset: #{@prev_offset}, previous_page_key: #{@previous_page_key}, total_elements:"\
+      " #{@total_elements}, 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} next_offset: #{@next_offset.inspect}, next_page_key:"\
+      " #{@next_page_key.inspect}, prev_offset: #{@prev_offset.inspect}, previous_page_key:"\
+      " #{@previous_page_key.inspect}, total_elements: #{@total_elements.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end