fdx-apimatic-sdk 0.0.1

data/lib/fdx_v660_api/models/party_entity1.rb

@@ -0,0 +1,138 @@
+# fdx_v660_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxV660Api
+  # Publisher of notification
+  class PartyEntity1 < 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 [PartyType3]
+    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 [Registry3]
+    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.
+      PartyEntity1.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_v660_api/models/party_entity2.rb

@@ -0,0 +1,138 @@
+# fdx_v660_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxV660Api
+  # Subscriber to this notification
+  class PartyEntity2 < 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 [PartyType3]
+    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 [Registry3]
+    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.
+      PartyEntity2.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_v660_api/models/party_entity3.rb

@@ -0,0 +1,138 @@
+# fdx_v660_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxV660Api
+  # The Party who is subscribing to the notification
+  class PartyEntity3 < 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 [PartyType3]
+    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 [Registry3]
+    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.
+      PartyEntity3.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_v660_api/models/party_entity4.rb

@@ -0,0 +1,140 @@
+# fdx_v660_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxV660Api
+  # Identity of the party responsible for identifying and reporting the
+  # suspected fraud. This might be the DP, DAP, a vendor, a payment network, or
+  # other entity
+  class PartyEntity4 < 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 [PartyType3]
+    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 [Registry3]
+    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.
+      PartyEntity4.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_v660_api/models/party_group_entity.rb

@@ -0,0 +1,86 @@
+# fdx_v660_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxV660Api
+  # 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_v660_api/models/party_status.rb

@@ -0,0 +1,48 @@
+# fdx_v660_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxV660Api
+  # 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
+
+    def self.from_value(value, default_value = ACTIVE)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'active' then ACTIVE
+      when 'deleted' then DELETED
+      when 'pending' then PENDING
+      when 'rejected' then REJECTED
+      else
+        default_value
+      end
+    end
+  end
+end