fdx-api-sdk-ruby 1.0.0

data/lib/fdx_api/models/payment_initiation_party_create_response_entity.rb

@@ -0,0 +1,85 @@
+# fdx_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxApi
+  # Entity that stores FI payment initiation party details. Each payment
+  # initiation party  will have a separate entry per FI customer, e.g. we might
+  # have multiple payment initiation parties that represent the same physical
+  # person, nevertheless since they are registered for separate customers then
+  # they will have separate entries.
+  class PaymentInitiationPartyCreateResponseEntity < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Unique identifier of a payment initiation party
+    # @return [String]
+    attr_accessor :payment_initiation_party_id
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['payment_initiation_party_id'] = 'paymentInitiationPartyId'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        payment_initiation_party_id
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(payment_initiation_party_id: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      unless payment_initiation_party_id == SKIP
+        @payment_initiation_party_id =
+          payment_initiation_party_id
+      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.
+      payment_initiation_party_id =
+        hash.key?('paymentInitiationPartyId') ? hash['paymentInitiationPartyId'] : 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.
+      PaymentInitiationPartyCreateResponseEntity.new(payment_initiation_party_id: payment_initiation_party_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} payment_initiation_party_id: #{@payment_initiation_party_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} payment_initiation_party_id: #{@payment_initiation_party_id.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/fdx_api/models/payment_initiation_party_entity.rb

@@ -0,0 +1,292 @@
+# fdx_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+require 'date'
+module FdxApi
+  # Party details for FI payment initiation. Each payment initiation party will
+  # have a separate entry per FI customer, for example we might have multiple
+  # payment initiation parties that represent the same physical person; since
+  # they are registered for separate customers they will have separate entries.
+  class PaymentInitiationPartyEntity < 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
+
+    # The PartyGroups to which this initiation party belongs.
+    # Optional, can be omitted if party belongs to no groups.
+    # @return [Array[PartyGroupEntity]]
+    attr_accessor :party_groups
+
+    # Name entity associated with the payment initiation party
+    # @return [PaymentInitiationPartyNameEntity1]
+    attr_accessor :payment_initiation_party_name
+
+    # Government-issued identification documents that are
+    # used to uniquely identify this payment initiation party
+    # @return [Array[GovernmentIssuedPartyIdentificationEntity]]
+    attr_accessor :government_issued_party_ids
+
+    # Registrations between this payment initiation party and its payment
+    # methods
+    # @return [Array[PaymentInitiationPartyToPaymentMethodEntity]]
+    attr_accessor :payment_methods
+
+    # Delivery addresses associated with this payment initiation party
+    # @return [Array[PaymentDeliveryAddressEntity]]
+    attr_accessor :locations
+
+    # Describes when the entity will be automatically deleted. The entity
+    # will not go into the "DELETED" state. If this value is null or not
+    # provided, the entity will not expire automatically
+    # @return [DateTime]
+    attr_accessor :expires_timestamp
+
+    # Current status of the payment initiation party entry
+    # @return [PartyStatus1]
+    attr_accessor :status
+
+    # Contact methods for this payment initiation party
+    # @return [Array[PaymentInitiationPartyContactMethodEntity]]
+    attr_accessor :contact_preferences
+
+    # 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['party_groups'] = 'partyGroups'
+      @_hash['payment_initiation_party_name'] = 'paymentInitiationPartyName'
+      @_hash['government_issued_party_ids'] = 'governmentIssuedPartyIds'
+      @_hash['payment_methods'] = 'paymentMethods'
+      @_hash['locations'] = 'locations'
+      @_hash['expires_timestamp'] = 'expiresTimestamp'
+      @_hash['status'] = 'status'
+      @_hash['contact_preferences'] = 'contactPreferences'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        home_uri
+        logo_uri
+        registry
+        registered_entity_name
+        registered_entity_id
+        party_groups
+        payment_initiation_party_name
+        government_issued_party_ids
+        payment_methods
+        locations
+        expires_timestamp
+        status
+        contact_preferences
+      ]
+    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,
+                   party_groups: SKIP, payment_initiation_party_name: SKIP,
+                   government_issued_party_ids: SKIP, payment_methods: SKIP,
+                   locations: SKIP, expires_timestamp: SKIP, status: SKIP,
+                   contact_preferences: 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
+      @party_groups = party_groups unless party_groups == SKIP
+      unless payment_initiation_party_name == SKIP
+        @payment_initiation_party_name =
+          payment_initiation_party_name
+      end
+      unless government_issued_party_ids == SKIP
+        @government_issued_party_ids =
+          government_issued_party_ids
+      end
+      @payment_methods = payment_methods unless payment_methods == SKIP
+      @locations = locations unless locations == SKIP
+      @expires_timestamp = expires_timestamp unless expires_timestamp == SKIP
+      @status = status unless status == SKIP
+      @contact_preferences = contact_preferences unless contact_preferences == 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
+      # Parameter is an array, so we need to iterate through it
+      party_groups = nil
+      unless hash['partyGroups'].nil?
+        party_groups = []
+        hash['partyGroups'].each do |structure|
+          party_groups << (PartyGroupEntity.from_hash(structure) if structure)
+        end
+      end
+
+      party_groups = SKIP unless hash.key?('partyGroups')
+      if hash['paymentInitiationPartyName']
+        payment_initiation_party_name = PaymentInitiationPartyNameEntity1.from_hash(hash['paymentInitiationPartyName'])
+      end
+      # Parameter is an array, so we need to iterate through it
+      government_issued_party_ids = nil
+      unless hash['governmentIssuedPartyIds'].nil?
+        government_issued_party_ids = []
+        hash['governmentIssuedPartyIds'].each do |structure|
+          government_issued_party_ids << (GovernmentIssuedPartyIdentificationEntity.from_hash(structure) if structure)
+        end
+      end
+
+      government_issued_party_ids = SKIP unless hash.key?('governmentIssuedPartyIds')
+      # Parameter is an array, so we need to iterate through it
+      payment_methods = nil
+      unless hash['paymentMethods'].nil?
+        payment_methods = []
+        hash['paymentMethods'].each do |structure|
+          payment_methods << (PaymentInitiationPartyToPaymentMethodEntity.from_hash(structure) if structure)
+        end
+      end
+
+      payment_methods = SKIP unless hash.key?('paymentMethods')
+      # Parameter is an array, so we need to iterate through it
+      locations = nil
+      unless hash['locations'].nil?
+        locations = []
+        hash['locations'].each do |structure|
+          locations << (PaymentDeliveryAddressEntity.from_hash(structure) if structure)
+        end
+      end
+
+      locations = SKIP unless hash.key?('locations')
+      expires_timestamp = if hash.key?('expiresTimestamp')
+                            (DateTimeHelper.from_rfc3339(hash['expiresTimestamp']) if hash['expiresTimestamp'])
+                          else
+                            SKIP
+                          end
+      status = hash.key?('status') ? hash['status'] : SKIP
+      # Parameter is an array, so we need to iterate through it
+      contact_preferences = nil
+      unless hash['contactPreferences'].nil?
+        contact_preferences = []
+        hash['contactPreferences'].each do |structure|
+          contact_preferences << (PaymentInitiationPartyContactMethodEntity.from_hash(structure) if structure)
+        end
+      end
+
+      contact_preferences = SKIP unless hash.key?('contactPreferences')
+
+      # 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.
+      PaymentInitiationPartyEntity.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,
+                                       party_groups: party_groups,
+                                       payment_initiation_party_name: payment_initiation_party_name,
+                                       government_issued_party_ids: government_issued_party_ids,
+                                       payment_methods: payment_methods,
+                                       locations: locations,
+                                       expires_timestamp: expires_timestamp,
+                                       status: status,
+                                       contact_preferences: contact_preferences,
+                                       additional_properties: additional_properties)
+    end
+
+    def to_custom_expires_timestamp
+      DateTimeHelper.to_rfc3339(expires_timestamp)
+    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}, party_groups: #{@party_groups},"\
+      " payment_initiation_party_name: #{@payment_initiation_party_name},"\
+      " government_issued_party_ids: #{@government_issued_party_ids}, payment_methods:"\
+      " #{@payment_methods}, locations: #{@locations}, expires_timestamp: #{@expires_timestamp},"\
+      " status: #{@status}, contact_preferences: #{@contact_preferences}, 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}, party_groups: #{@party_groups.inspect},"\
+      " payment_initiation_party_name: #{@payment_initiation_party_name.inspect},"\
+      " government_issued_party_ids: #{@government_issued_party_ids.inspect}, payment_methods:"\
+      " #{@payment_methods.inspect}, locations: #{@locations.inspect}, expires_timestamp:"\
+      " #{@expires_timestamp.inspect}, status: #{@status.inspect}, contact_preferences:"\
+      " #{@contact_preferences.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/fdx_api/models/payment_initiation_party_method_create_response_entity.rb

@@ -0,0 +1,78 @@
+# fdx_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxApi
+  # Registration between a payment initiation party and a Payment Method
+  class PaymentInitiationPartyMethodCreateResponseEntity < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Registration identifier between a payment initiation party and a payment
+    # method
+    # @return [String]
+    attr_accessor :registration_id
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['registration_id'] = 'registrationId'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        registration_id
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(registration_id: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @registration_id = registration_id unless registration_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.
+      registration_id =
+        hash.key?('registrationId') ? hash['registrationId'] : 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.
+      PaymentInitiationPartyMethodCreateResponseEntity.new(registration_id: registration_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} registration_id: #{@registration_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} registration_id: #{@registration_id.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/fdx_api/models/payment_initiation_party_name_entity.rb

@@ -0,0 +1,98 @@
+# fdx_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxApi
+  # Generic entity that stores various names associated with a payment
+  # initiation party
+  class PaymentInitiationPartyNameEntity < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Alias name
+    # @return [String]
+    attr_accessor :alias_name
+
+    # Details of the name
+    # @return [Object]
+    attr_accessor :detail
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['alias_name'] = 'aliasName'
+      @_hash['detail'] = 'detail'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        alias_name
+        detail
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(alias_name: SKIP, detail: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @alias_name = alias_name unless alias_name == SKIP
+      @detail = detail unless detail == 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.
+      alias_name = hash.key?('aliasName') ? hash['aliasName'] : SKIP
+      detail = hash.key?('detail') ? APIHelper.deserialize_union_type(
+        UnionTypeLookUp.get(:PaymentInitiationPartyNameEntityDetail), hash['detail']
+      ) : 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.
+      PaymentInitiationPartyNameEntity.new(alias_name: alias_name,
+                                           detail: detail,
+                                           additional_properties: additional_properties)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [PaymentInitiationPartyNameEntity | 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} alias_name: #{@alias_name}, detail: #{@detail}, 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} alias_name: #{@alias_name.inspect}, detail: #{@detail.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/fdx_api/models/payment_initiation_party_name_entity1.rb

@@ -0,0 +1,97 @@
+# fdx_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxApi
+  # Name entity associated with the payment initiation party
+  class PaymentInitiationPartyNameEntity1 < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Alias name
+    # @return [String]
+    attr_accessor :alias_name
+
+    # Details of the name
+    # @return [Object]
+    attr_accessor :detail
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['alias_name'] = 'aliasName'
+      @_hash['detail'] = 'detail'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        alias_name
+        detail
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(alias_name: SKIP, detail: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @alias_name = alias_name unless alias_name == SKIP
+      @detail = detail unless detail == 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.
+      alias_name = hash.key?('aliasName') ? hash['aliasName'] : SKIP
+      detail = hash.key?('detail') ? APIHelper.deserialize_union_type(
+        UnionTypeLookUp.get(:PaymentInitiationPartyNameEntity1Detail), hash['detail']
+      ) : 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.
+      PaymentInitiationPartyNameEntity1.new(alias_name: alias_name,
+                                            detail: detail,
+                                            additional_properties: additional_properties)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [PaymentInitiationPartyNameEntity1 | 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} alias_name: #{@alias_name}, detail: #{@detail}, 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} alias_name: #{@alias_name.inspect}, detail: #{@detail.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end