fdx-api-sdk-ruby 1.0.0

data/lib/fdx_api/models/other_security_entity.rb

@@ -0,0 +1,94 @@
+# fdx_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+require_relative 'security_entity'
+
+module FdxApi
+  # 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',
+                   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,
+            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'
+
+      # 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,
+                              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_api/models/page_metadata.rb

@@ -0,0 +1,108 @@
+# fdx_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxApi
+  # Offset IDs 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. Implementation specific
+    # @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 :prev_offset
+
+    # 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['prev_offset'] = 'prevOffset'
+      @_hash['total_elements'] = 'totalElements'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        next_offset
+        prev_offset
+        total_elements
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(next_offset: SKIP, prev_offset: 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
+      @prev_offset = prev_offset unless prev_offset == 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
+      prev_offset = hash.key?('prevOffset') ? hash['prevOffset'] : 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,
+                       prev_offset: prev_offset,
+                       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}, prev_offset: #{@prev_offset}, 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}, prev_offset: #{@prev_offset.inspect},"\
+      " total_elements: #{@total_elements.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/fdx_api/models/page_metadata_links.rb

@@ -0,0 +1,95 @@
+# fdx_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxApi
+  # Resource URLs for navigating result sets
+  class PageMetadataLinks < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Resource URL for retrieving next dataset
+    # @return [HateoasLink]
+    attr_accessor :mnext
+
+    # Resource URL for retrieving previous dataset
+    # @return [HateoasLink]
+    attr_accessor :prev
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['mnext'] = 'next'
+      @_hash['prev'] = 'prev'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        mnext
+        prev
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(mnext: SKIP, prev: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @mnext = mnext unless mnext == SKIP
+      @prev = prev unless prev == 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.
+      mnext = HateoasLink.from_hash(hash['next']) if hash['next']
+      prev = HateoasLink.from_hash(hash['prev']) if hash['prev']
+
+      # 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.
+      PageMetadataLinks.new(mnext: mnext,
+                            prev: prev,
+                            additional_properties: additional_properties)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [PageMetadataLinks | 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} mnext: #{@mnext}, prev: #{@prev}, 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} mnext: #{@mnext.inspect}, prev: #{@prev.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/fdx_api/models/page_metadata_links1.rb

@@ -0,0 +1,85 @@
+# fdx_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxApi
+  # Links used to paginate results
+  class PageMetadataLinks1 < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Resource URL for retrieving next dataset
+    # @return [HateoasLink]
+    attr_accessor :mnext
+
+    # Resource URL for retrieving previous dataset
+    # @return [HateoasLink]
+    attr_accessor :prev
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['mnext'] = 'next'
+      @_hash['prev'] = 'prev'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        mnext
+        prev
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(mnext: SKIP, prev: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @mnext = mnext unless mnext == SKIP
+      @prev = prev unless prev == 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.
+      mnext = HateoasLink.from_hash(hash['next']) if hash['next']
+      prev = HateoasLink.from_hash(hash['prev']) if hash['prev']
+
+      # 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.
+      PageMetadataLinks1.new(mnext: mnext,
+                             prev: prev,
+                             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} mnext: #{@mnext}, prev: #{@prev}, 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} mnext: #{@mnext.inspect}, prev: #{@prev.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/fdx_api/models/party_entity.rb

@@ -0,0 +1,139 @@
+# fdx_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxApi
+  # FDX Participant - an entity or person that is a part of a FDX API
+  # transaction
+  class PartyEntity < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Human recognizable common name
+    # @return [String]
+    attr_accessor :name
+
+    # Extensible string enum identifying the type of the party
+    # @return [PartyType]
+    attr_accessor :type
+
+    # URI for party, where an end user could learn more about the company or
+    # application involved in the data sharing chain
+    # @return [String]
+    attr_accessor :home_uri
+
+    # URI for a logo asset to be displayed to the end user
+    # @return [String]
+    attr_accessor :logo_uri
+
+    # The registry containing the party's registration with name and id: FDX,
+    # GLEIF, ICANN, PRIVATE
+    # @return [Registry]
+    attr_accessor :registry
+
+    # Registered name of party
+    # @return [String]
+    attr_accessor :registered_entity_name
+
+    # Registered id of party
+    # @return [String]
+    attr_accessor :registered_entity_id
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['name'] = 'name'
+      @_hash['type'] = 'type'
+      @_hash['home_uri'] = 'homeUri'
+      @_hash['logo_uri'] = 'logoUri'
+      @_hash['registry'] = 'registry'
+      @_hash['registered_entity_name'] = 'registeredEntityName'
+      @_hash['registered_entity_id'] = 'registeredEntityId'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        home_uri
+        logo_uri
+        registry
+        registered_entity_name
+        registered_entity_id
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(name:, type:, home_uri: SKIP, logo_uri: SKIP, registry: SKIP,
+                   registered_entity_name: SKIP, registered_entity_id: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @name = name
+      @type = type
+      @home_uri = home_uri unless home_uri == SKIP
+      @logo_uri = logo_uri unless logo_uri == SKIP
+      @registry = registry unless registry == SKIP
+      @registered_entity_name = registered_entity_name unless registered_entity_name == SKIP
+      @registered_entity_id = registered_entity_id unless registered_entity_id == 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.
+      name = hash.key?('name') ? hash['name'] : nil
+      type = hash.key?('type') ? hash['type'] : nil
+      home_uri = hash.key?('homeUri') ? hash['homeUri'] : SKIP
+      logo_uri = hash.key?('logoUri') ? hash['logoUri'] : SKIP
+      registry = hash.key?('registry') ? hash['registry'] : SKIP
+      registered_entity_name =
+        hash.key?('registeredEntityName') ? hash['registeredEntityName'] : SKIP
+      registered_entity_id =
+        hash.key?('registeredEntityId') ? hash['registeredEntityId'] : 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.
+      PartyEntity.new(name: name,
+                      type: type,
+                      home_uri: home_uri,
+                      logo_uri: logo_uri,
+                      registry: registry,
+                      registered_entity_name: registered_entity_name,
+                      registered_entity_id: registered_entity_id,
+                      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} name: #{@name}, type: #{@type}, home_uri: #{@home_uri}, logo_uri:"\
+      " #{@logo_uri}, registry: #{@registry}, registered_entity_name: #{@registered_entity_name},"\
+      " registered_entity_id: #{@registered_entity_id}, 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} name: #{@name.inspect}, type: #{@type.inspect}, home_uri:"\
+      " #{@home_uri.inspect}, logo_uri: #{@logo_uri.inspect}, registry: #{@registry.inspect},"\
+      " registered_entity_name: #{@registered_entity_name.inspect}, registered_entity_id:"\
+      " #{@registered_entity_id.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/fdx_api/models/party_group_entity.rb

@@ -0,0 +1,86 @@
+# fdx_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxApi
+  # Entity that allows payment initiation parties to be grouped using specific
+  # business rules. Each payment initiation party can belong to many groups.
+  class PartyGroupEntity < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Unique identifier of a group of payment initiation parties
+    # @return [String]
+    attr_accessor :group_id
+
+    # Associated name with the group of payment initiation parties
+    # @return [String]
+    attr_accessor :name
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['group_id'] = 'groupId'
+      @_hash['name'] = 'name'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        group_id
+        name
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(group_id: SKIP, name: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @group_id = group_id unless group_id == SKIP
+      @name = name unless 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.
+      group_id = hash.key?('groupId') ? hash['groupId'] : SKIP
+      name = hash.key?('name') ? hash['name'] : 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.
+      PartyGroupEntity.new(group_id: group_id,
+                           name: name,
+                           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} group_id: #{@group_id}, name: #{@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} group_id: #{@group_id.inspect}, name: #{@name.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/fdx_api/models/party_status.rb

@@ -0,0 +1,33 @@
+# fdx_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxApi
+  # Defines the party lifecycle.   * `ACTIVE`: Party is ready to participate in
+  # money movement   * `DELETED`: Party has been deleted and will not move into
+  # any other state   * `PENDING`: Party is not yet ready to participate in
+  # money movement   * `REJECTED`: Party was found to be invalid and cannot
+  # participate in money movement
+  class PartyStatus
+    PARTY_STATUS = [
+      # TODO: Write general description for ACTIVE
+      ACTIVE = 'ACTIVE'.freeze,
+
+      # TODO: Write general description for DELETED
+      DELETED = 'DELETED'.freeze,
+
+      # TODO: Write general description for PENDING
+      PENDING = 'PENDING'.freeze,
+
+      # TODO: Write general description for REJECTED
+      REJECTED = 'REJECTED'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+  end
+end

data/lib/fdx_api/models/party_status1.rb

@@ -0,0 +1,29 @@
+# fdx_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxApi
+  # Current status of the payment initiation party entry
+  class PartyStatus1
+    PARTY_STATUS1 = [
+      # TODO: Write general description for ACTIVE
+      ACTIVE = 'ACTIVE'.freeze,
+
+      # TODO: Write general description for DELETED
+      DELETED = 'DELETED'.freeze,
+
+      # TODO: Write general description for PENDING
+      PENDING = 'PENDING'.freeze,
+
+      # TODO: Write general description for REJECTED
+      REJECTED = 'REJECTED'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+  end
+end

data/lib/fdx_api/models/party_status3.rb

@@ -0,0 +1,29 @@
+# fdx_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxApi
+  # Defines the Merchant's lifecycle
+  class PartyStatus3
+    PARTY_STATUS3 = [
+      # TODO: Write general description for ACTIVE
+      ACTIVE = 'ACTIVE'.freeze,
+
+      # TODO: Write general description for DELETED
+      DELETED = 'DELETED'.freeze,
+
+      # TODO: Write general description for PENDING
+      PENDING = 'PENDING'.freeze,
+
+      # TODO: Write general description for REJECTED
+      REJECTED = 'REJECTED'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+  end
+end