pnz-payments-sdk 1.0.0

data/lib/account_and_transaction_api_specification/models/scheduled_type_enum.rb

@@ -0,0 +1,23 @@
+# account_and_transaction_api_specification
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module AccountAndTransactionApiSpecification
+  # Specifies the scheduled payment date type requested
+  class ScheduledTypeEnum
+    SCHEDULED_TYPE_ENUM = [
+      # TODO: Write general description for ARRIVAL
+      ARRIVAL = 'Arrival'.freeze,
+
+      # TODO: Write general description for EXECUTION
+      EXECUTION = 'Execution'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      SCHEDULED_TYPE_ENUM.include?(value)
+    end
+  end
+end

data/lib/account_and_transaction_api_specification/models/scheme_name_enum.rb

@@ -0,0 +1,21 @@
+# account_and_transaction_api_specification
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module AccountAndTransactionApiSpecification
+  # Name of the identification scheme, in a coded form as published in an
+  # external list.
+  class SchemeNameEnum
+    SCHEME_NAME_ENUM = [
+      # TODO: Write general description for BICFI
+      BICFI = 'BICFI'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      SCHEME_NAME_ENUM.include?(value)
+    end
+  end
+end

data/lib/account_and_transaction_api_specification/models/servicer.rb

@@ -0,0 +1,71 @@
+# account_and_transaction_api_specification
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module AccountAndTransactionApiSpecification
+  # Party that manages the account on behalf of the account owner, that is
+  # manages the registration and booking of entries on the account, calculates
+  # balances on the account and provides information about the account.
+  class Servicer < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Name of the identification scheme, in a coded form as published in an
+    # external list.
+    # @return [String]
+    attr_reader :scheme_name
+
+    # Unique and unambiguous identification of the servicing institution.
+    # @return [String]
+    attr_accessor :identification
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['scheme_name'] = 'SchemeName'
+      @_hash['identification'] = 'Identification'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(identification = nil)
+      @scheme_name = 'BICFI'
+      @identification = identification
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      identification =
+        hash.key?('Identification') ? hash['Identification'] : nil
+
+      # Create object from extracted values.
+      Servicer.new(identification)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} scheme_name: #{@scheme_name}, identification: #{@identification}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} scheme_name: #{@scheme_name.inspect}, identification:"\
+      " #{@identification.inspect}>"
+    end
+  end
+end

data/lib/account_and_transaction_api_specification/models/standing_order_model.rb

@@ -0,0 +1,289 @@
+# account_and_transaction_api_specification
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+require 'date'
+module AccountAndTransactionApiSpecification
+  # StandingOrderModel Model.
+  class StandingOrderModel < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # A unique and immutable identifier used to identify the account resource.
+    # This identifier has no meaning to the account owner.
+    # @return [String]
+    attr_accessor :account_id
+
+    # A unique and immutable identifier used to identify the standing order
+    # resource. This identifier has no meaning to the account owner.
+    # @return [String]
+    attr_accessor :standing_order_id
+
+    # EvryDay - Every day
+    # EvryWorkgDay - Every working day
+    # IntrvlWkDay - An interval specified in weeks (01 to 09), and the day
+    # within the week (01 to 07)
+    # WkInMnthDay - A monthly interval, specifying the week of the month (01 to
+    # 05) and day within the week (01 to 07)
+    # IntrvlMnthDay - An interval specified in months (between 01 to 06, 12,
+    # 24), specifying the day within the month (-5 to -1, 1 to 31)
+    # Patterns:
+    # EvryDay (ScheduleCode)
+    # EvryWorkgDay (ScheduleCode)
+    # IntrvlWkDay:IntervalInWeeks:DayInWeek (ScheduleCode + IntervalInWeeks +
+    # DayInWeek)
+    # WkInMnthDay:WeekInMonth:DayInWeek (ScheduleCode + WeekInMonth + DayInWeek)
+    # IntrvlMnthDay:IntervalInMonths:DayInMonth (ScheduleCode + IntervalInMonths
+    # + DayInMonth)
+    # The regular expression for this element combines five smaller versions for
+    # each permitted pattern. To aid legibility - the components are presented
+    # individually here:
+    # EvryDay
+    # EvryWorkgDay
+    # IntrvlWkDay:0[1-9]:0[1-7]
+    # WkInMnthDay:0[1-5]:0[1-7]
+    # IntrvlMnthDay:(0[1-6]|12|24):(-0[1-5]|0[1-9]|[12][0-9]|3[01])
+    # @return [String]
+    attr_accessor :frequency
+
+    # EvryDay - Every day
+    # EvryWorkgDay - Every working day
+    # IntrvlWkDay - An interval specified in weeks (01 to 09), and the day
+    # within the week (01 to 07)
+    # WkInMnthDay - A monthly interval, specifying the week of the month (01 to
+    # 05) and day within the week (01 to 07)
+    # IntrvlMnthDay - An interval specified in months (between 01 to 06, 12,
+    # 24), specifying the day within the month (-5 to -1, 1 to 31)
+    # Patterns:
+    # EvryDay (ScheduleCode)
+    # EvryWorkgDay (ScheduleCode)
+    # IntrvlWkDay:IntervalInWeeks:DayInWeek (ScheduleCode + IntervalInWeeks +
+    # DayInWeek)
+    # WkInMnthDay:WeekInMonth:DayInWeek (ScheduleCode + WeekInMonth + DayInWeek)
+    # IntrvlMnthDay:IntervalInMonths:DayInMonth (ScheduleCode + IntervalInMonths
+    # + DayInMonth)
+    # The regular expression for this element combines five smaller versions for
+    # each permitted pattern. To aid legibility - the components are presented
+    # individually here:
+    # EvryDay
+    # EvryWorkgDay
+    # IntrvlWkDay:0[1-9]:0[1-7]
+    # WkInMnthDay:0[1-5]:0[1-7]
+    # IntrvlMnthDay:(0[1-6]|12|24):(-0[1-5]|0[1-9]|[12][0-9]|3[01])
+    # @return [Reference]
+    attr_accessor :reference
+
+    # The date on which the first payment for a Standing Order schedule will be
+    # made.
+    # All dates in the JSON payloads are represented in ISO 8601 date-time
+    # format.
+    # All date-time fields in responses must include the timezone. An example is
+    # below:
+    # 2017-04-05T10:43:07+00:00
+    # @return [DateTime]
+    attr_accessor :first_payment_date_time
+
+    # The amount of the first Standing Order
+    # @return [FirstPaymentAmount]
+    attr_accessor :first_payment_amount
+
+    # The date on which the next payment for a Standing Order schedule will be
+    # made.
+    # All dates in the JSON payloads are represented in ISO 8601 date-time
+    # format.
+    # All date-time fields in responses must include the timezone. An example is
+    # below:
+    # 2017-04-05T10:43:07+00:00
+    # @return [DateTime]
+    attr_accessor :next_payment_date_time
+
+    # The amount of the next Standing Order
+    # @return [NextPaymentAmount]
+    attr_accessor :next_payment_amount
+
+    # The date on which the final payment for a Standing Order schedule will be
+    # made.
+    # All dates in the JSON payloads are represented in ISO 8601 date-time
+    # format.
+    # All date-time fields in responses must include the timezone. An example is
+    # below:
+    # 2017-04-05T10:43:07+00:00
+    # @return [DateTime]
+    attr_accessor :final_payment_date_time
+
+    # The amount of the final Standing Order
+    # @return [FinalPaymentAmount]
+    attr_accessor :final_payment_amount
+
+    # Specifies the status of the standing order in code form.
+    # @return [StandingOrderStatusCodeEnum]
+    attr_accessor :standing_order_status_code
+
+    # Party that manages the account on behalf of the account owner, that is
+    # manages the registration and booking of entries on the account, calculates
+    # balances on the account and provides information about the account.
+    # This is the servicer of the beneficiary account.
+    # @return [CreditorAgent]
+    attr_accessor :creditor_agent
+
+    # Unambiguous identification of the account of the creditor, in the case of
+    # a debit transaction.
+    # @return [CreditorAccount]
+    attr_accessor :creditor_account
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['account_id'] = 'AccountId'
+      @_hash['standing_order_id'] = 'StandingOrderId'
+      @_hash['frequency'] = 'Frequency'
+      @_hash['reference'] = 'Reference'
+      @_hash['first_payment_date_time'] = 'FirstPaymentDateTime'
+      @_hash['first_payment_amount'] = 'FirstPaymentAmount'
+      @_hash['next_payment_date_time'] = 'NextPaymentDateTime'
+      @_hash['next_payment_amount'] = 'NextPaymentAmount'
+      @_hash['final_payment_date_time'] = 'FinalPaymentDateTime'
+      @_hash['final_payment_amount'] = 'FinalPaymentAmount'
+      @_hash['standing_order_status_code'] = 'StandingOrderStatusCode'
+      @_hash['creditor_agent'] = 'CreditorAgent'
+      @_hash['creditor_account'] = 'CreditorAccount'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        standing_order_id
+        reference
+        first_payment_date_time
+        first_payment_amount
+        final_payment_date_time
+        final_payment_amount
+        standing_order_status_code
+        creditor_agent
+        creditor_account
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(account_id = nil, frequency = nil,
+                   next_payment_date_time = nil, next_payment_amount = nil,
+                   standing_order_id = SKIP, reference = SKIP,
+                   first_payment_date_time = SKIP, first_payment_amount = SKIP,
+                   final_payment_date_time = SKIP, final_payment_amount = SKIP,
+                   standing_order_status_code = SKIP, creditor_agent = SKIP,
+                   creditor_account = SKIP)
+      @account_id = account_id
+      @standing_order_id = standing_order_id unless standing_order_id == SKIP
+      @frequency = frequency
+      @reference = reference unless reference == SKIP
+      @first_payment_date_time = first_payment_date_time unless first_payment_date_time == SKIP
+      @first_payment_amount = first_payment_amount unless first_payment_amount == SKIP
+      @next_payment_date_time = next_payment_date_time
+      @next_payment_amount = next_payment_amount
+      @final_payment_date_time = final_payment_date_time unless final_payment_date_time == SKIP
+      @final_payment_amount = final_payment_amount unless final_payment_amount == SKIP
+      unless standing_order_status_code == SKIP
+        @standing_order_status_code =
+          standing_order_status_code
+      end
+      @creditor_agent = creditor_agent unless creditor_agent == SKIP
+      @creditor_account = creditor_account unless creditor_account == SKIP
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      account_id = hash.key?('AccountId') ? hash['AccountId'] : nil
+      frequency = hash.key?('Frequency') ? hash['Frequency'] : nil
+      next_payment_date_time = if hash.key?('NextPaymentDateTime')
+                                 (DateTimeHelper.from_rfc3339(hash['NextPaymentDateTime']) if hash['NextPaymentDateTime'])
+                               end
+      next_payment_amount = NextPaymentAmount.from_hash(hash['NextPaymentAmount']) if
+        hash['NextPaymentAmount']
+      standing_order_id =
+        hash.key?('StandingOrderId') ? hash['StandingOrderId'] : SKIP
+      reference = Reference.from_hash(hash['Reference']) if hash['Reference']
+      first_payment_date_time = if hash.key?('FirstPaymentDateTime')
+                                  (DateTimeHelper.from_rfc3339(hash['FirstPaymentDateTime']) if hash['FirstPaymentDateTime'])
+                                else
+                                  SKIP
+                                end
+      first_payment_amount = FirstPaymentAmount.from_hash(hash['FirstPaymentAmount']) if
+        hash['FirstPaymentAmount']
+      final_payment_date_time = if hash.key?('FinalPaymentDateTime')
+                                  (DateTimeHelper.from_rfc3339(hash['FinalPaymentDateTime']) if hash['FinalPaymentDateTime'])
+                                else
+                                  SKIP
+                                end
+      final_payment_amount = FinalPaymentAmount.from_hash(hash['FinalPaymentAmount']) if
+        hash['FinalPaymentAmount']
+      standing_order_status_code =
+        hash.key?('StandingOrderStatusCode') ? hash['StandingOrderStatusCode'] : SKIP
+      creditor_agent = CreditorAgent.from_hash(hash['CreditorAgent']) if hash['CreditorAgent']
+      creditor_account = CreditorAccount.from_hash(hash['CreditorAccount']) if
+        hash['CreditorAccount']
+
+      # Create object from extracted values.
+      StandingOrderModel.new(account_id,
+                             frequency,
+                             next_payment_date_time,
+                             next_payment_amount,
+                             standing_order_id,
+                             reference,
+                             first_payment_date_time,
+                             first_payment_amount,
+                             final_payment_date_time,
+                             final_payment_amount,
+                             standing_order_status_code,
+                             creditor_agent,
+                             creditor_account)
+    end
+
+    def to_custom_first_payment_date_time
+      DateTimeHelper.to_rfc3339(first_payment_date_time)
+    end
+
+    def to_custom_next_payment_date_time
+      DateTimeHelper.to_rfc3339(next_payment_date_time)
+    end
+
+    def to_custom_final_payment_date_time
+      DateTimeHelper.to_rfc3339(final_payment_date_time)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} account_id: #{@account_id}, standing_order_id: #{@standing_order_id},"\
+      " frequency: #{@frequency}, reference: #{@reference}, first_payment_date_time:"\
+      " #{@first_payment_date_time}, first_payment_amount: #{@first_payment_amount},"\
+      " next_payment_date_time: #{@next_payment_date_time}, next_payment_amount:"\
+      " #{@next_payment_amount}, final_payment_date_time: #{@final_payment_date_time},"\
+      " final_payment_amount: #{@final_payment_amount}, standing_order_status_code:"\
+      " #{@standing_order_status_code}, creditor_agent: #{@creditor_agent}, creditor_account:"\
+      " #{@creditor_account}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} account_id: #{@account_id.inspect}, standing_order_id:"\
+      " #{@standing_order_id.inspect}, frequency: #{@frequency.inspect}, reference:"\
+      " #{@reference.inspect}, first_payment_date_time: #{@first_payment_date_time.inspect},"\
+      " first_payment_amount: #{@first_payment_amount.inspect}, next_payment_date_time:"\
+      " #{@next_payment_date_time.inspect}, next_payment_amount: #{@next_payment_amount.inspect},"\
+      " final_payment_date_time: #{@final_payment_date_time.inspect}, final_payment_amount:"\
+      " #{@final_payment_amount.inspect}, standing_order_status_code:"\
+      " #{@standing_order_status_code.inspect}, creditor_agent: #{@creditor_agent.inspect},"\
+      " creditor_account: #{@creditor_account.inspect}>"
+    end
+  end
+end

data/lib/account_and_transaction_api_specification/models/standing_order_status_code_enum.rb

@@ -0,0 +1,23 @@
+# account_and_transaction_api_specification
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module AccountAndTransactionApiSpecification
+  # Specifies the status of the standing order in code form.
+  class StandingOrderStatusCodeEnum
+    STANDING_ORDER_STATUS_CODE_ENUM = [
+      # TODO: Write general description for ACTIVE
+      ACTIVE = 'Active'.freeze,
+
+      # TODO: Write general description for INACTIVE
+      INACTIVE = 'Inactive'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      STANDING_ORDER_STATUS_CODE_ENUM.include?(value)
+    end
+  end
+end

data/lib/account_and_transaction_api_specification/models/standing_orders_response.rb

@@ -0,0 +1,76 @@
+# account_and_transaction_api_specification
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module AccountAndTransactionApiSpecification
+  # StandingOrdersResponse Model.
+  class StandingOrdersResponse < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [StandingOrdersResponseData]
+    attr_accessor :data
+
+    # Links relevant to the payload
+    # @return [Links]
+    attr_accessor :links
+
+    # Links relevant to the payload
+    # @return [Meta]
+    attr_accessor :meta
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['data'] = 'Data'
+      @_hash['links'] = 'Links'
+      @_hash['meta'] = 'Meta'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(data = nil, links = nil, meta = nil)
+      @data = data
+      @links = links
+      @meta = meta
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      data = StandingOrdersResponseData.from_hash(hash['Data']) if hash['Data']
+      links = Links.from_hash(hash['Links']) if hash['Links']
+      meta = Meta.from_hash(hash['Meta']) if hash['Meta']
+
+      # Create object from extracted values.
+      StandingOrdersResponse.new(data,
+                                 links,
+                                 meta)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} data: #{@data}, links: #{@links}, meta: #{@meta}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} data: #{@data.inspect}, links: #{@links.inspect}, meta: #{@meta.inspect}>"
+    end
+  end
+end

data/lib/account_and_transaction_api_specification/models/standing_orders_response_data.rb

@@ -0,0 +1,71 @@
+# account_and_transaction_api_specification
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module AccountAndTransactionApiSpecification
+  # StandingOrdersResponseData Model.
+  class StandingOrdersResponseData < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # StandingOrder
+    # @return [Array[StandingOrderModel]]
+    attr_accessor :standing_order
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['standing_order'] = 'StandingOrder'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        standing_order
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(standing_order = SKIP)
+      @standing_order = standing_order unless standing_order == SKIP
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      # Parameter is an array, so we need to iterate through it
+      standing_order = nil
+      unless hash['StandingOrder'].nil?
+        standing_order = []
+        hash['StandingOrder'].each do |structure|
+          standing_order << (StandingOrderModel.from_hash(structure) if structure)
+        end
+      end
+
+      standing_order = SKIP unless hash.key?('StandingOrder')
+
+      # Create object from extracted values.
+      StandingOrdersResponseData.new(standing_order)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} standing_order: #{@standing_order}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} standing_order: #{@standing_order.inspect}>"
+    end
+  end
+end