pnz-payments-sdk 1.0.0

data/lib/account_and_transaction_api_specification/models/meta_data.rb

@@ -0,0 +1,112 @@
+# account_and_transaction_api_specification
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+require 'date'
+module AccountAndTransactionApiSpecification
+  # Meta Data relevant to the payload
+  class MetaData < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [Integer]
+    attr_accessor :total_pages
+
+    # 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_available_date_time
+
+    # 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 :last_available_date_time
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['total_pages'] = 'TotalPages'
+      @_hash['first_available_date_time'] = 'FirstAvailableDateTime'
+      @_hash['last_available_date_time'] = 'LastAvailableDateTime'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        total_pages
+        first_available_date_time
+        last_available_date_time
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(total_pages = SKIP, first_available_date_time = SKIP,
+                   last_available_date_time = SKIP)
+      @total_pages = total_pages unless total_pages == SKIP
+      unless first_available_date_time == SKIP
+        @first_available_date_time =
+          first_available_date_time
+      end
+      @last_available_date_time = last_available_date_time unless last_available_date_time == 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.
+      total_pages = hash.key?('TotalPages') ? hash['TotalPages'] : SKIP
+      first_available_date_time = if hash.key?('FirstAvailableDateTime')
+                                    (DateTimeHelper.from_rfc3339(hash['FirstAvailableDateTime']) if hash['FirstAvailableDateTime'])
+                                  else
+                                    SKIP
+                                  end
+      last_available_date_time = if hash.key?('LastAvailableDateTime')
+                                   (DateTimeHelper.from_rfc3339(hash['LastAvailableDateTime']) if hash['LastAvailableDateTime'])
+                                 else
+                                   SKIP
+                                 end
+
+      # Create object from extracted values.
+      MetaData.new(total_pages,
+                   first_available_date_time,
+                   last_available_date_time)
+    end
+
+    def to_custom_first_available_date_time
+      DateTimeHelper.to_rfc3339(first_available_date_time)
+    end
+
+    def to_custom_last_available_date_time
+      DateTimeHelper.to_rfc3339(last_available_date_time)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} total_pages: #{@total_pages}, first_available_date_time:"\
+      " #{@first_available_date_time}, last_available_date_time: #{@last_available_date_time}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} total_pages: #{@total_pages.inspect}, first_available_date_time:"\
+      " #{@first_available_date_time.inspect}, last_available_date_time:"\
+      " #{@last_available_date_time.inspect}>"
+    end
+  end
+end

data/lib/account_and_transaction_api_specification/models/next_payment_amount.rb

@@ -0,0 +1,71 @@
+# account_and_transaction_api_specification
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module AccountAndTransactionApiSpecification
+  # The amount of the next Standing Order
+  class NextPaymentAmount < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :amount
+
+    # A code allocated to a currency by a Maintenance Agency under an
+    # international identification scheme, as described in the latest edition of
+    # the international standard ISO 4217 'Codes for the representation of
+    # currencies and funds'
+    # @return [String]
+    attr_accessor :currency
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['amount'] = 'Amount'
+      @_hash['currency'] = 'Currency'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(amount = nil, currency = nil)
+      @amount = amount
+      @currency = currency
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      amount = hash.key?('Amount') ? hash['Amount'] : nil
+      currency = hash.key?('Currency') ? hash['Currency'] : nil
+
+      # Create object from extracted values.
+      NextPaymentAmount.new(amount,
+                            currency)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} amount: #{@amount}, currency: #{@currency}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} amount: #{@amount.inspect}, currency: #{@currency.inspect}>"
+    end
+  end
+end

data/lib/account_and_transaction_api_specification/models/offer_model.rb

@@ -0,0 +1,199 @@
+# account_and_transaction_api_specification
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+require 'date'
+module AccountAndTransactionApiSpecification
+  # OfferModel Model.
+  class OfferModel < 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 offer resource.
+    # This identifier has no meaning to the account owner.
+    # @return [String]
+    attr_accessor :offer_id
+
+    # Offer type, in a coded form.
+    # @return [OfferTypeEnum]
+    attr_accessor :offer_type
+
+    # Further details of the offer.
+    # @return [String]
+    attr_accessor :description
+
+    # Date and time at which the offer starts.
+    # 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 :start_date_time
+
+    # Date and time at which the offer ends.
+    # 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 :end_date_time
+
+    # Amount of money of the cash balance.
+    # @return [Amount]
+    attr_accessor :amount
+
+    # Fee associated with the offer type.
+    # @return [Fee]
+    attr_accessor :fee
+
+    # Rate associated with the offer type.
+    # @return [String]
+    attr_accessor :rate
+
+    # Value associated with the offer type.
+    # @return [Integer]
+    attr_accessor :value
+
+    # Further details of the term of the offer.
+    # @return [String]
+    attr_accessor :term
+
+    # URL (Uniform Resource Locator) where the document can be found
+    # @return [String]
+    attr_accessor :url
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['account_id'] = 'AccountId'
+      @_hash['offer_id'] = 'OfferId'
+      @_hash['offer_type'] = 'OfferType'
+      @_hash['description'] = 'Description'
+      @_hash['start_date_time'] = 'StartDateTime'
+      @_hash['end_date_time'] = 'EndDateTime'
+      @_hash['amount'] = 'Amount'
+      @_hash['fee'] = 'Fee'
+      @_hash['rate'] = 'Rate'
+      @_hash['value'] = 'Value'
+      @_hash['term'] = 'Term'
+      @_hash['url'] = 'URL'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        offer_id
+        offer_type
+        description
+        start_date_time
+        end_date_time
+        amount
+        fee
+        rate
+        value
+        term
+        url
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(account_id = nil, offer_id = SKIP, offer_type = SKIP,
+                   description = SKIP, start_date_time = SKIP,
+                   end_date_time = SKIP, amount = SKIP, fee = SKIP, rate = SKIP,
+                   value = SKIP, term = SKIP, url = SKIP)
+      @account_id = account_id
+      @offer_id = offer_id unless offer_id == SKIP
+      @offer_type = offer_type unless offer_type == SKIP
+      @description = description unless description == SKIP
+      @start_date_time = start_date_time unless start_date_time == SKIP
+      @end_date_time = end_date_time unless end_date_time == SKIP
+      @amount = amount unless amount == SKIP
+      @fee = fee unless fee == SKIP
+      @rate = rate unless rate == SKIP
+      @value = value unless value == SKIP
+      @term = term unless term == SKIP
+      @url = url unless url == 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
+      offer_id = hash.key?('OfferId') ? hash['OfferId'] : SKIP
+      offer_type = hash.key?('OfferType') ? hash['OfferType'] : SKIP
+      description = hash.key?('Description') ? hash['Description'] : SKIP
+      start_date_time = if hash.key?('StartDateTime')
+                          (DateTimeHelper.from_rfc3339(hash['StartDateTime']) if hash['StartDateTime'])
+                        else
+                          SKIP
+                        end
+      end_date_time = if hash.key?('EndDateTime')
+                        (DateTimeHelper.from_rfc3339(hash['EndDateTime']) if hash['EndDateTime'])
+                      else
+                        SKIP
+                      end
+      amount = Amount.from_hash(hash['Amount']) if hash['Amount']
+      fee = Fee.from_hash(hash['Fee']) if hash['Fee']
+      rate = hash.key?('Rate') ? hash['Rate'] : SKIP
+      value = hash.key?('Value') ? hash['Value'] : SKIP
+      term = hash.key?('Term') ? hash['Term'] : SKIP
+      url = hash.key?('URL') ? hash['URL'] : SKIP
+
+      # Create object from extracted values.
+      OfferModel.new(account_id,
+                     offer_id,
+                     offer_type,
+                     description,
+                     start_date_time,
+                     end_date_time,
+                     amount,
+                     fee,
+                     rate,
+                     value,
+                     term,
+                     url)
+    end
+
+    def to_custom_start_date_time
+      DateTimeHelper.to_rfc3339(start_date_time)
+    end
+
+    def to_custom_end_date_time
+      DateTimeHelper.to_rfc3339(end_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}, offer_id: #{@offer_id}, offer_type:"\
+      " #{@offer_type}, description: #{@description}, start_date_time: #{@start_date_time},"\
+      " end_date_time: #{@end_date_time}, amount: #{@amount}, fee: #{@fee}, rate: #{@rate}, value:"\
+      " #{@value}, term: #{@term}, url: #{@url}>"
+    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}, offer_id: #{@offer_id.inspect},"\
+      " offer_type: #{@offer_type.inspect}, description: #{@description.inspect}, start_date_time:"\
+      " #{@start_date_time.inspect}, end_date_time: #{@end_date_time.inspect}, amount:"\
+      " #{@amount.inspect}, fee: #{@fee.inspect}, rate: #{@rate.inspect}, value:"\
+      " #{@value.inspect}, term: #{@term.inspect}, url: #{@url.inspect}>"
+    end
+  end
+end

data/lib/account_and_transaction_api_specification/models/offer_type_enum.rb

@@ -0,0 +1,32 @@
+# account_and_transaction_api_specification
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module AccountAndTransactionApiSpecification
+  # Offer type, in a coded form.
+  class OfferTypeEnum
+    OFFER_TYPE_ENUM = [
+      # TODO: Write general description for BALANCETRANSFER
+      BALANCETRANSFER = 'BalanceTransfer'.freeze,
+
+      # TODO: Write general description for LIMITINCREASE
+      LIMITINCREASE = 'LimitIncrease'.freeze,
+
+      # TODO: Write general description for MONEYTRANSFER
+      MONEYTRANSFER = 'MoneyTransfer'.freeze,
+
+      # TODO: Write general description for OTHER
+      OTHER = 'Other'.freeze,
+
+      # TODO: Write general description for PROMOTIONALRATE
+      PROMOTIONALRATE = 'PromotionalRate'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      OFFER_TYPE_ENUM.include?(value)
+    end
+  end
+end

data/lib/account_and_transaction_api_specification/models/party_model.rb

@@ -0,0 +1,144 @@
+# account_and_transaction_api_specification
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module AccountAndTransactionApiSpecification
+  # PartyModel Model.
+  class PartyModel < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # A unique and immutable identifier used to identify the customer resource.
+    # This identifier has no meaning to the account owner.
+    # @return [String]
+    attr_accessor :party_id
+
+    # Number assigned by an agent to identify its customer.
+    # @return [String]
+    attr_accessor :party_number
+
+    # Party type, in a coded form.
+    # @return [PartyTypeEnum]
+    attr_accessor :party_type
+
+    # Name by which a party is known and which is usually used to identify that
+    # party.
+    # @return [String]
+    attr_accessor :name
+
+    # Address for electronic mail (e-mail).
+    # @return [String]
+    attr_accessor :email_address
+
+    # Collection of information that identifies a phone number, as defined by
+    # telecom services.
+    # @return [String]
+    attr_accessor :phone
+
+    # Collection of information that identifies a mobile phone number, as
+    # defined by telecom services.
+    # @return [String]
+    attr_accessor :mobile
+
+    # Postal address of a party.
+    # @return [Array[Address]]
+    attr_accessor :address
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['party_id'] = 'PartyId'
+      @_hash['party_number'] = 'PartyNumber'
+      @_hash['party_type'] = 'PartyType'
+      @_hash['name'] = 'Name'
+      @_hash['email_address'] = 'EmailAddress'
+      @_hash['phone'] = 'Phone'
+      @_hash['mobile'] = 'Mobile'
+      @_hash['address'] = 'Address'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        party_number
+        party_type
+        name
+        email_address
+        phone
+        mobile
+        address
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(party_id = nil, party_number = SKIP, party_type = SKIP,
+                   name = SKIP, email_address = SKIP, phone = SKIP,
+                   mobile = SKIP, address = SKIP)
+      @party_id = party_id
+      @party_number = party_number unless party_number == SKIP
+      @party_type = party_type unless party_type == SKIP
+      @name = name unless name == SKIP
+      @email_address = email_address unless email_address == SKIP
+      @phone = phone unless phone == SKIP
+      @mobile = mobile unless mobile == SKIP
+      @address = address unless address == 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.
+      party_id = hash.key?('PartyId') ? hash['PartyId'] : nil
+      party_number = hash.key?('PartyNumber') ? hash['PartyNumber'] : SKIP
+      party_type = hash.key?('PartyType') ? hash['PartyType'] : SKIP
+      name = hash.key?('Name') ? hash['Name'] : SKIP
+      email_address = hash.key?('EmailAddress') ? hash['EmailAddress'] : SKIP
+      phone = hash.key?('Phone') ? hash['Phone'] : SKIP
+      mobile = hash.key?('Mobile') ? hash['Mobile'] : SKIP
+      # Parameter is an array, so we need to iterate through it
+      address = nil
+      unless hash['Address'].nil?
+        address = []
+        hash['Address'].each do |structure|
+          address << (Address.from_hash(structure) if structure)
+        end
+      end
+
+      address = SKIP unless hash.key?('Address')
+
+      # Create object from extracted values.
+      PartyModel.new(party_id,
+                     party_number,
+                     party_type,
+                     name,
+                     email_address,
+                     phone,
+                     mobile,
+                     address)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} party_id: #{@party_id}, party_number: #{@party_number}, party_type:"\
+      " #{@party_type}, name: #{@name}, email_address: #{@email_address}, phone: #{@phone},"\
+      " mobile: #{@mobile}, address: #{@address}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} party_id: #{@party_id.inspect}, party_number: #{@party_number.inspect},"\
+      " party_type: #{@party_type.inspect}, name: #{@name.inspect}, email_address:"\
+      " #{@email_address.inspect}, phone: #{@phone.inspect}, mobile: #{@mobile.inspect}, address:"\
+      " #{@address.inspect}>"
+    end
+  end
+end

data/lib/account_and_transaction_api_specification/models/party_type_enum.rb

@@ -0,0 +1,26 @@
+# account_and_transaction_api_specification
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module AccountAndTransactionApiSpecification
+  # Party type, in a coded form.
+  class PartyTypeEnum
+    PARTY_TYPE_ENUM = [
+      # TODO: Write general description for DELEGATE
+      DELEGATE = 'Delegate'.freeze,
+
+      # TODO: Write general description for JOINT
+      JOINT = 'Joint'.freeze,
+
+      # TODO: Write general description for SOLE
+      SOLE = 'Sole'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      PARTY_TYPE_ENUM.include?(value)
+    end
+  end
+end

data/lib/account_and_transaction_api_specification/models/payment_context_code_enum.rb

@@ -0,0 +1,32 @@
+# account_and_transaction_api_specification
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module AccountAndTransactionApiSpecification
+  # Specifies the payment context
+  class PaymentContextCodeEnum
+    PAYMENT_CONTEXT_CODE_ENUM = [
+      # TODO: Write general description for BILLPAYMENT
+      BILLPAYMENT = 'BillPayment'.freeze,
+
+      # TODO: Write general description for ECOMMERCEGOODS
+      ECOMMERCEGOODS = 'EcommerceGoods'.freeze,
+
+      # TODO: Write general description for ECOMMERCESERVICES
+      ECOMMERCESERVICES = 'EcommerceServices'.freeze,
+
+      # TODO: Write general description for OTHER
+      OTHER = 'Other'.freeze,
+
+      # TODO: Write general description for PERSONTOPERSON
+      PERSONTOPERSON = 'PersonToPerson'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      PAYMENT_CONTEXT_CODE_ENUM.include?(value)
+    end
+  end
+end

data/lib/account_and_transaction_api_specification/models/permission_enum.rb

@@ -0,0 +1,76 @@
+# account_and_transaction_api_specification
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module AccountAndTransactionApiSpecification
+  # Specifies the Open Banking account access consent types. This is a list of
+  # the data clusters being consented by the Customer, and requested for
+  # authorisation with the API Provider.
+  class PermissionEnum
+    PERMISSION_ENUM = [
+      # TODO: Write general description for READACCOUNTSBASIC
+      READACCOUNTSBASIC = 'ReadAccountsBasic'.freeze,
+
+      # TODO: Write general description for READACCOUNTSDETAIL
+      READACCOUNTSDETAIL = 'ReadAccountsDetail'.freeze,
+
+      # TODO: Write general description for READBALANCES
+      READBALANCES = 'ReadBalances'.freeze,
+
+      # TODO: Write general description for READBENEFICIARIESBASIC
+      READBENEFICIARIESBASIC = 'ReadBeneficiariesBasic'.freeze,
+
+      # TODO: Write general description for READBENEFICIARIESDETAIL
+      READBENEFICIARIESDETAIL = 'ReadBeneficiariesDetail'.freeze,
+
+      # TODO: Write general description for READDIRECTDEBITS
+      READDIRECTDEBITS = 'ReadDirectDebits'.freeze,
+
+      # TODO: Write general description for READOFFERS
+      READOFFERS = 'ReadOffers'.freeze,
+
+      # TODO: Write general description for READPARTY
+      READPARTY = 'ReadParty'.freeze,
+
+      # TODO: Write general description for READPARTYAUTHUSER
+      READPARTYAUTHUSER = 'ReadPartyAuthUser'.freeze,
+
+      # TODO: Write general description for READSCHEDULEDPAYMENTSBASIC
+      READSCHEDULEDPAYMENTSBASIC = 'ReadScheduledPaymentsBasic'.freeze,
+
+      # TODO: Write general description for READSCHEDULEDPAYMENTSDETAIL
+      READSCHEDULEDPAYMENTSDETAIL = 'ReadScheduledPaymentsDetail'.freeze,
+
+      # TODO: Write general description for READSTANDINGORDERSBASIC
+      READSTANDINGORDERSBASIC = 'ReadStandingOrdersBasic'.freeze,
+
+      # TODO: Write general description for READSTANDINGORDERSDETAIL
+      READSTANDINGORDERSDETAIL = 'ReadStandingOrdersDetail'.freeze,
+
+      # TODO: Write general description for READSTATEMENTSBASIC
+      READSTATEMENTSBASIC = 'ReadStatementsBasic'.freeze,
+
+      # TODO: Write general description for READSTATEMENTSDETAIL
+      READSTATEMENTSDETAIL = 'ReadStatementsDetail'.freeze,
+
+      # TODO: Write general description for READTRANSACTIONSBASIC
+      READTRANSACTIONSBASIC = 'ReadTransactionsBasic'.freeze,
+
+      # TODO: Write general description for READTRANSACTIONSCREDITS
+      READTRANSACTIONSCREDITS = 'ReadTransactionsCredits'.freeze,
+
+      # TODO: Write general description for READTRANSACTIONSDEBITS
+      READTRANSACTIONSDEBITS = 'ReadTransactionsDebits'.freeze,
+
+      # TODO: Write general description for READTRANSACTIONSDETAIL
+      READTRANSACTIONSDETAIL = 'ReadTransactionsDetail'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      PERMISSION_ENUM.include?(value)
+    end
+  end
+end