fdx-api-sdk-ruby 1.0.0

data/lib/fdx_api/models/recipient_request.rb

@@ -0,0 +1,214 @@
+# fdx_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxApi
+  # Used to request a recipient registration. Properties in this structure use
+  # 'snake_case' names to match the properties in [IETF RFC
+  # 7591](https://datatracker.ietf.org/doc/rfc7591/)
+  class RecipientRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The Data Recipient or Data Recipient Application name displayed by Data
+    # Provider during the consent Flow as well as in the Consent Dashboard
+    # @return [String]
+    attr_accessor :client_name
+
+    # A short description of the Data Recipient application
+    # @return [String]
+    attr_accessor :description
+
+    # An array of eligible Redirect URI targets
+    # @return [Array[String]]
+    attr_accessor :redirect_uris
+
+    # Data Recipient Logo URL location
+    # @return [String]
+    attr_accessor :logo_uri
+
+    # The URI which provides additional information about the Data Recipient
+    # @return [String]
+    attr_accessor :client_uri
+
+    # Array of strings representing ways to contact individuals responsible for
+    # the Data Recipient application
+    # @return [Array[String]]
+    attr_accessor :contacts
+
+    # String form field with a list of data clusters
+    # @return [String]
+    attr_accessor :scope
+
+    # The duration of consent for the Data Recipient consumers
+    # @return [Array[ConsentDurationType]]
+    attr_accessor :duration_type
+
+    # The maximum consent duration in days for duration_type TIME_BOUND for the
+    # Data Recipient, effective from the date of consent
+    # @return [Integer]
+    attr_accessor :duration_period
+
+    # The maximum number of days allowed for Data Recipient to obtain in
+    # transaction history, effective from the current date
+    # @return [Integer]
+    attr_accessor :lookback_period
+
+    # An array of external registries containing registered entity name,
+    # registered entity id and registry fields for the registries where the data
+    # recipient is registered
+    # @return [Array[RegistryReference]]
+    attr_accessor :registry_references
+
+    # An array of the intermediaries for this data recipient
+    # @return [Array[Intermediary]]
+    attr_accessor :intermediaries
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['client_name'] = 'client_name'
+      @_hash['description'] = 'description'
+      @_hash['redirect_uris'] = 'redirect_uris'
+      @_hash['logo_uri'] = 'logo_uri'
+      @_hash['client_uri'] = 'client_uri'
+      @_hash['contacts'] = 'contacts'
+      @_hash['scope'] = 'scope'
+      @_hash['duration_type'] = 'duration_type'
+      @_hash['duration_period'] = 'duration_period'
+      @_hash['lookback_period'] = 'lookback_period'
+      @_hash['registry_references'] = 'registry_references'
+      @_hash['intermediaries'] = 'intermediaries'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        description
+        logo_uri
+        client_uri
+        contacts
+        scope
+        duration_type
+        duration_period
+        lookback_period
+        registry_references
+        intermediaries
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(client_name:, redirect_uris:, description: SKIP,
+                   logo_uri: SKIP, client_uri: SKIP, contacts: SKIP,
+                   scope: SKIP, duration_type: SKIP, duration_period: SKIP,
+                   lookback_period: SKIP, registry_references: SKIP,
+                   intermediaries: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @client_name = client_name
+      @description = description unless description == SKIP
+      @redirect_uris = redirect_uris
+      @logo_uri = logo_uri unless logo_uri == SKIP
+      @client_uri = client_uri unless client_uri == SKIP
+      @contacts = contacts unless contacts == SKIP
+      @scope = scope unless scope == SKIP
+      @duration_type = duration_type unless duration_type == SKIP
+      @duration_period = duration_period unless duration_period == SKIP
+      @lookback_period = lookback_period unless lookback_period == SKIP
+      @registry_references = registry_references unless registry_references == SKIP
+      @intermediaries = intermediaries unless intermediaries == 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.
+      client_name = hash.key?('client_name') ? hash['client_name'] : nil
+      redirect_uris = hash.key?('redirect_uris') ? hash['redirect_uris'] : nil
+      description = hash.key?('description') ? hash['description'] : SKIP
+      logo_uri = hash.key?('logo_uri') ? hash['logo_uri'] : SKIP
+      client_uri = hash.key?('client_uri') ? hash['client_uri'] : SKIP
+      contacts = hash.key?('contacts') ? hash['contacts'] : SKIP
+      scope = hash.key?('scope') ? hash['scope'] : SKIP
+      duration_type = hash.key?('duration_type') ? hash['duration_type'] : SKIP
+      duration_period =
+        hash.key?('duration_period') ? hash['duration_period'] : SKIP
+      lookback_period =
+        hash.key?('lookback_period') ? hash['lookback_period'] : SKIP
+      # Parameter is an array, so we need to iterate through it
+      registry_references = nil
+      unless hash['registry_references'].nil?
+        registry_references = []
+        hash['registry_references'].each do |structure|
+          registry_references << (RegistryReference.from_hash(structure) if structure)
+        end
+      end
+
+      registry_references = SKIP unless hash.key?('registry_references')
+      # Parameter is an array, so we need to iterate through it
+      intermediaries = nil
+      unless hash['intermediaries'].nil?
+        intermediaries = []
+        hash['intermediaries'].each do |structure|
+          intermediaries << (Intermediary.from_hash(structure) if structure)
+        end
+      end
+
+      intermediaries = SKIP unless hash.key?('intermediaries')
+
+      # 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.
+      RecipientRequest.new(client_name: client_name,
+                           redirect_uris: redirect_uris,
+                           description: description,
+                           logo_uri: logo_uri,
+                           client_uri: client_uri,
+                           contacts: contacts,
+                           scope: scope,
+                           duration_type: duration_type,
+                           duration_period: duration_period,
+                           lookback_period: lookback_period,
+                           registry_references: registry_references,
+                           intermediaries: intermediaries,
+                           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} client_name: #{@client_name}, description: #{@description}, redirect_uris:"\
+      " #{@redirect_uris}, logo_uri: #{@logo_uri}, client_uri: #{@client_uri}, contacts:"\
+      " #{@contacts}, scope: #{@scope}, duration_type: #{@duration_type}, duration_period:"\
+      " #{@duration_period}, lookback_period: #{@lookback_period}, registry_references:"\
+      " #{@registry_references}, intermediaries: #{@intermediaries}, 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} client_name: #{@client_name.inspect}, description: #{@description.inspect},"\
+      " redirect_uris: #{@redirect_uris.inspect}, logo_uri: #{@logo_uri.inspect}, client_uri:"\
+      " #{@client_uri.inspect}, contacts: #{@contacts.inspect}, scope: #{@scope.inspect},"\
+      " duration_type: #{@duration_type.inspect}, duration_period: #{@duration_period.inspect},"\
+      " lookback_period: #{@lookback_period.inspect}, registry_references:"\
+      " #{@registry_references.inspect}, intermediaries: #{@intermediaries.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/fdx_api/models/recurring_payment_duration_entity.rb

@@ -0,0 +1,86 @@
+# fdx_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxApi
+  # Describes a payment's duration
+  class RecurringPaymentDurationEntity < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Type of duration
+    # @return [RecurringPaymentDurationType2]
+    attr_accessor :type
+
+    # Maximum number of times a payment is to be sent. Required if type is set
+    # to NUMBEROFTIMES
+    # @return [Float]
+    attr_accessor :number_of_times
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['type'] = 'type'
+      @_hash['number_of_times'] = 'numberOfTimes'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        number_of_times
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(type:, number_of_times: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @type = type
+      @number_of_times = number_of_times unless number_of_times == 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.
+      type = hash.key?('type') ? hash['type'] : nil
+      number_of_times =
+        hash.key?('numberOfTimes') ? hash['numberOfTimes'] : 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.
+      RecurringPaymentDurationEntity.new(type: type,
+                                         number_of_times: number_of_times,
+                                         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} type: #{@type}, number_of_times: #{@number_of_times},"\
+      " 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} type: #{@type.inspect}, number_of_times: #{@number_of_times.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/fdx_api/models/recurring_payment_duration_entity2.rb

@@ -0,0 +1,86 @@
+# fdx_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxApi
+  # Defines how long the payment repeats for
+  class RecurringPaymentDurationEntity2 < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Type of duration
+    # @return [RecurringPaymentDurationType2]
+    attr_accessor :type
+
+    # Maximum number of times a payment is to be sent. Required if type is set
+    # to NUMBEROFTIMES
+    # @return [Float]
+    attr_accessor :number_of_times
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['type'] = 'type'
+      @_hash['number_of_times'] = 'numberOfTimes'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        number_of_times
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(type:, number_of_times: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @type = type
+      @number_of_times = number_of_times unless number_of_times == 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.
+      type = hash.key?('type') ? hash['type'] : nil
+      number_of_times =
+        hash.key?('numberOfTimes') ? hash['numberOfTimes'] : 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.
+      RecurringPaymentDurationEntity2.new(type: type,
+                                          number_of_times: number_of_times,
+                                          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} type: #{@type}, number_of_times: #{@number_of_times},"\
+      " 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} type: #{@type.inspect}, number_of_times: #{@number_of_times.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/fdx_api/models/recurring_payment_duration_type.rb

@@ -0,0 +1,24 @@
+# fdx_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxApi
+  # Describes if the recurring payment has an end or will occur a fixed number
+  # of times
+  class RecurringPaymentDurationType
+    RECURRING_PAYMENT_DURATION_TYPE = [
+      # TODO: Write general description for NOEND
+      NOEND = 'NOEND'.freeze,
+
+      # TODO: Write general description for NUMBEROFTIMES
+      NUMBEROFTIMES = 'NUMBEROFTIMES'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+  end
+end

data/lib/fdx_api/models/recurring_payment_duration_type2.rb

@@ -0,0 +1,23 @@
+# fdx_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxApi
+  # Type of duration
+  class RecurringPaymentDurationType2
+    RECURRING_PAYMENT_DURATION_TYPE2 = [
+      # TODO: Write general description for NOEND
+      NOEND = 'NOEND'.freeze,
+
+      # TODO: Write general description for NUMBEROFTIMES
+      NUMBEROFTIMES = 'NUMBEROFTIMES'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+  end
+end

data/lib/fdx_api/models/recurring_payment_entity.rb

@@ -0,0 +1,231 @@
+# fdx_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+require 'date'
+module FdxApi
+  # A recurring payment. Financial institution is free to adjust the payment
+  # date to accommodate weekends and holidays
+  class RecurringPaymentEntity < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Defines how often the payment repeats
+    # @return [RecurringPaymentFrequency2]
+    attr_accessor :frequency
+
+    # Defines how long the payment repeats for
+    # @return [RecurringPaymentDurationEntity2]
+    attr_accessor :duration
+
+    # ID of the account used to source funds for payment
+    # @return [String]
+    attr_accessor :from_account_id
+
+    # ID of the payee to receive funds for the payment
+    # @return [String]
+    attr_accessor :to_payee_id
+
+    # Amount for the payment. Must be positive
+    # @return [Float]
+    attr_accessor :amount
+
+    # User's account identifier with the merchant
+    # @return [String]
+    attr_accessor :merchant_account_id
+
+    # Date that the funds are scheduled to be delivered
+    # @return [Date]
+    attr_accessor :due_date
+
+    # Uniquely identifies a recurring payment. Used within the API to reference
+    # a recurring payment
+    # @return [String]
+    attr_accessor :recurring_payment_id
+
+    # When the recurring payment was scheduled
+    # @return [DateTime]
+    attr_accessor :scheduled_timestamp
+
+    # When the recurring payment was cancelled
+    # @return [DateTime]
+    attr_accessor :cancelled_timestamp
+
+    # When the last payment executed
+    # @return [DateTime]
+    attr_accessor :processed_timestamp
+
+    # When the recurring payment failed
+    # @return [DateTime]
+    attr_accessor :failed_timestamp
+
+    # Defines the status of the recurring payment
+    # @return [RecurringPaymentStatus2]
+    attr_accessor :status
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['frequency'] = 'frequency'
+      @_hash['duration'] = 'duration'
+      @_hash['from_account_id'] = 'fromAccountId'
+      @_hash['to_payee_id'] = 'toPayeeId'
+      @_hash['amount'] = 'amount'
+      @_hash['merchant_account_id'] = 'merchantAccountId'
+      @_hash['due_date'] = 'dueDate'
+      @_hash['recurring_payment_id'] = 'recurringPaymentId'
+      @_hash['scheduled_timestamp'] = 'scheduledTimestamp'
+      @_hash['cancelled_timestamp'] = 'cancelledTimestamp'
+      @_hash['processed_timestamp'] = 'processedTimestamp'
+      @_hash['failed_timestamp'] = 'failedTimestamp'
+      @_hash['status'] = 'status'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        duration
+        merchant_account_id
+        recurring_payment_id
+        scheduled_timestamp
+        cancelled_timestamp
+        processed_timestamp
+        failed_timestamp
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(frequency:, from_account_id:, to_payee_id:, amount:,
+                   due_date:, status:, duration: SKIP,
+                   merchant_account_id: SKIP, recurring_payment_id: SKIP,
+                   scheduled_timestamp: SKIP, cancelled_timestamp: SKIP,
+                   processed_timestamp: SKIP, failed_timestamp: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @frequency = frequency
+      @duration = duration unless duration == SKIP
+      @from_account_id = from_account_id
+      @to_payee_id = to_payee_id
+      @amount = amount
+      @merchant_account_id = merchant_account_id unless merchant_account_id == SKIP
+      @due_date = due_date
+      @recurring_payment_id = recurring_payment_id unless recurring_payment_id == SKIP
+      @scheduled_timestamp = scheduled_timestamp unless scheduled_timestamp == SKIP
+      @cancelled_timestamp = cancelled_timestamp unless cancelled_timestamp == SKIP
+      @processed_timestamp = processed_timestamp unless processed_timestamp == SKIP
+      @failed_timestamp = failed_timestamp unless failed_timestamp == SKIP
+      @status = status
+      @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.
+      frequency = hash.key?('frequency') ? hash['frequency'] : nil
+      from_account_id = hash.key?('fromAccountId') ? hash['fromAccountId'] : nil
+      to_payee_id = hash.key?('toPayeeId') ? hash['toPayeeId'] : nil
+      amount = hash.key?('amount') ? hash['amount'] : nil
+      due_date = hash.key?('dueDate') ? hash['dueDate'] : nil
+      status = hash.key?('status') ? hash['status'] : nil
+      duration = RecurringPaymentDurationEntity2.from_hash(hash['duration']) if hash['duration']
+      merchant_account_id =
+        hash.key?('merchantAccountId') ? hash['merchantAccountId'] : SKIP
+      recurring_payment_id =
+        hash.key?('recurringPaymentId') ? hash['recurringPaymentId'] : SKIP
+      scheduled_timestamp = if hash.key?('scheduledTimestamp')
+                              (DateTimeHelper.from_rfc3339(hash['scheduledTimestamp']) if hash['scheduledTimestamp'])
+                            else
+                              SKIP
+                            end
+      cancelled_timestamp = if hash.key?('cancelledTimestamp')
+                              (DateTimeHelper.from_rfc3339(hash['cancelledTimestamp']) if hash['cancelledTimestamp'])
+                            else
+                              SKIP
+                            end
+      processed_timestamp = if hash.key?('processedTimestamp')
+                              (DateTimeHelper.from_rfc3339(hash['processedTimestamp']) if hash['processedTimestamp'])
+                            else
+                              SKIP
+                            end
+      failed_timestamp = if hash.key?('failedTimestamp')
+                           (DateTimeHelper.from_rfc3339(hash['failedTimestamp']) if hash['failedTimestamp'])
+                         else
+                           SKIP
+                         end
+
+      # 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.
+      RecurringPaymentEntity.new(frequency: frequency,
+                                 from_account_id: from_account_id,
+                                 to_payee_id: to_payee_id,
+                                 amount: amount,
+                                 due_date: due_date,
+                                 status: status,
+                                 duration: duration,
+                                 merchant_account_id: merchant_account_id,
+                                 recurring_payment_id: recurring_payment_id,
+                                 scheduled_timestamp: scheduled_timestamp,
+                                 cancelled_timestamp: cancelled_timestamp,
+                                 processed_timestamp: processed_timestamp,
+                                 failed_timestamp: failed_timestamp,
+                                 additional_properties: additional_properties)
+    end
+
+    def to_custom_scheduled_timestamp
+      DateTimeHelper.to_rfc3339(scheduled_timestamp)
+    end
+
+    def to_custom_cancelled_timestamp
+      DateTimeHelper.to_rfc3339(cancelled_timestamp)
+    end
+
+    def to_custom_processed_timestamp
+      DateTimeHelper.to_rfc3339(processed_timestamp)
+    end
+
+    def to_custom_failed_timestamp
+      DateTimeHelper.to_rfc3339(failed_timestamp)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} frequency: #{@frequency}, duration: #{@duration}, from_account_id:"\
+      " #{@from_account_id}, to_payee_id: #{@to_payee_id}, amount: #{@amount},"\
+      " merchant_account_id: #{@merchant_account_id}, due_date: #{@due_date},"\
+      " recurring_payment_id: #{@recurring_payment_id}, scheduled_timestamp:"\
+      " #{@scheduled_timestamp}, cancelled_timestamp: #{@cancelled_timestamp},"\
+      " processed_timestamp: #{@processed_timestamp}, failed_timestamp: #{@failed_timestamp},"\
+      " status: #{@status}, 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} frequency: #{@frequency.inspect}, duration: #{@duration.inspect},"\
+      " from_account_id: #{@from_account_id.inspect}, to_payee_id: #{@to_payee_id.inspect},"\
+      " amount: #{@amount.inspect}, merchant_account_id: #{@merchant_account_id.inspect},"\
+      " due_date: #{@due_date.inspect}, recurring_payment_id: #{@recurring_payment_id.inspect},"\
+      " scheduled_timestamp: #{@scheduled_timestamp.inspect}, cancelled_timestamp:"\
+      " #{@cancelled_timestamp.inspect}, processed_timestamp: #{@processed_timestamp.inspect},"\
+      " failed_timestamp: #{@failed_timestamp.inspect}, status: #{@status.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end