packageruby 1.1.1

data/lib/form3_public_api/models/scheme_message_details_list_response.rb

@@ -0,0 +1,68 @@
+# form3_public_api
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Form3PublicApi
+  # SchemeMessageDetailsListResponse Model.
+  class SchemeMessageDetailsListResponse < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [Array[SchemeMessage]]
+    attr_accessor :data
+
+    # TODO: Write general description for this method
+    # @return [Links]
+    attr_accessor :links
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['data'] = 'data'
+      @_hash['links'] = 'links'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        links
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(data = nil,
+                   links = SKIP)
+      @data = data
+      @links = links unless links == 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
+      data = nil
+      unless hash['data'].nil?
+        data = []
+        hash['data'].each do |structure|
+          data << (SchemeMessage.from_hash(structure) if structure)
+        end
+      end
+
+      data = nil unless hash.key?('data')
+      links = Links.from_hash(hash['links']) if hash['links']
+
+      # Create object from extracted values.
+      SchemeMessageDetailsListResponse.new(data,
+                                           links)
+    end
+  end
+end

data/lib/form3_public_api/models/scheme_message_details_response.rb

@@ -0,0 +1,59 @@
+# form3_public_api
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Form3PublicApi
+  # SchemeMessageDetailsResponse Model.
+  class SchemeMessageDetailsResponse < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [SchemeMessage]
+    attr_accessor :data
+
+    # TODO: Write general description for this method
+    # @return [Links]
+    attr_accessor :links
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['data'] = 'data'
+      @_hash['links'] = 'links'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        links
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(data = nil,
+                   links = SKIP)
+      @data = data
+      @links = links unless links == 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.
+      data = SchemeMessage.from_hash(hash['data']) if hash['data']
+      links = Links.from_hash(hash['links']) if hash['links']
+
+      # Create object from extracted values.
+      SchemeMessageDetailsResponse.new(data,
+                                       links)
+    end
+  end
+end

data/lib/form3_public_api/models/scheme_message_entry_item.rb

@@ -0,0 +1,59 @@
+# form3_public_api
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Form3PublicApi
+  # SchemeMessageEntryItem Model.
+  class SchemeMessageEntryItem < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :key
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :value
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['key'] = 'key'
+      @_hash['value'] = 'value'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        value
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(key = nil,
+                   value = SKIP)
+      @key = key
+      @value = value unless value == 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.
+      key = hash.key?('key') ? hash['key'] : nil
+      value = hash.key?('value') ? hash['value'] : SKIP
+
+      # Create object from extracted values.
+      SchemeMessageEntryItem.new(key,
+                                 value)
+    end
+  end
+end

data/lib/form3_public_api/models/scheme_message_relationships.rb

@@ -0,0 +1,52 @@
+# form3_public_api
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Form3PublicApi
+  # SchemeMessageRelationships Model.
+  class SchemeMessageRelationships < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [SchemeMessageAdmission2]
+    attr_accessor :scheme_message_admission
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['scheme_message_admission'] = 'scheme_message_admission'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        scheme_message_admission
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(scheme_message_admission = SKIP)
+      @scheme_message_admission = scheme_message_admission unless scheme_message_admission == 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.
+      if hash['scheme_message_admission']
+        scheme_message_admission = SchemeMessageAdmission2.from_hash(hash['scheme_message_admission'])
+      end
+
+      # Create object from extracted values.
+      SchemeMessageRelationships.new(scheme_message_admission)
+    end
+  end
+end

data/lib/form3_public_api/models/scheme_status_enum.rb

@@ -0,0 +1,24 @@
+# form3_public_api
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Form3PublicApi
+  # This reference is used by the receiving party to identify whether the
+  # related DDI would have been electronic (AUDDIS) or paper‐based.
+  class SchemeStatusEnum
+    SCHEME_STATUS_ENUM = [
+      # TODO: Write general description for AUDDIS
+      AUDDIS = 'AUDDIS'.freeze,
+
+      # TODO: Write general description for MIGRATING
+      MIGRATING = 'MIGRATING'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      SCHEME_STATUS_ENUM.include?(value)
+    end
+  end
+end

data/lib/form3_public_api/models/sender_charge.rb

@@ -0,0 +1,62 @@
+# form3_public_api
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Form3PublicApi
+  # List of transaction charges due to the sender of the transaction
+  class SenderCharge < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Amount of each transaction charge due to the sender of the transaction.
+    # Requires 1 to 2 decimal places. Must be > 0.
+    # @return [String]
+    attr_accessor :amount
+
+    # Currency of `amount`. Currency code as defined in [ISO
+    # 4217](http://www.iso.org/iso/home/standards/currency_codes.htm).
+    # @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
+      %w[
+        amount
+        currency
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(amount = SKIP,
+                   currency = SKIP)
+      @amount = amount unless amount == SKIP
+      @currency = currency unless currency == 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.
+      amount = hash.key?('amount') ? hash['amount'] : SKIP
+      currency = hash.key?('currency') ? hash['currency'] : SKIP
+
+      # Create object from extracted values.
+      SenderCharge.new(amount,
+                       currency)
+    end
+  end
+end

data/lib/form3_public_api/models/senders_correspondent_account_holding_entity.rb

@@ -0,0 +1,92 @@
+# form3_public_api
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Form3PublicApi
+  # SendersCorrespondentAccountHoldingEntity Model.
+  class SendersCorrespondentAccountHoldingEntity < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Sender's correspondent's address
+    # @return [Array[String]]
+    attr_accessor :bank_address
+
+    # SWIFT BIC for sender's correspondent
+    # @return [String]
+    attr_accessor :bank_id
+
+    # The type of identification provided at `bank_id` attribute. Must be ISO
+    # code as listed in the [External Code Sets
+    # spreadsheet](https://www.iso20022.org/external_code_list.page)
+    # @return [String]
+    attr_accessor :bank_id_code
+
+    # Sender's correspondent's name
+    # @return [String]
+    attr_accessor :bank_name
+
+    # Identifier of the financial institution which services the account
+    # @return [String]
+    attr_accessor :bank_party_id
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['bank_address'] = 'bank_address'
+      @_hash['bank_id'] = 'bank_id'
+      @_hash['bank_id_code'] = 'bank_id_code'
+      @_hash['bank_name'] = 'bank_name'
+      @_hash['bank_party_id'] = 'bank_party_id'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        bank_address
+        bank_id
+        bank_id_code
+        bank_name
+        bank_party_id
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(bank_address = SKIP,
+                   bank_id = SKIP,
+                   bank_id_code = SKIP,
+                   bank_name = SKIP,
+                   bank_party_id = SKIP)
+      @bank_address = bank_address unless bank_address == SKIP
+      @bank_id = bank_id unless bank_id == SKIP
+      @bank_id_code = bank_id_code unless bank_id_code == SKIP
+      @bank_name = bank_name unless bank_name == SKIP
+      @bank_party_id = bank_party_id unless bank_party_id == 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.
+      bank_address = hash.key?('bank_address') ? hash['bank_address'] : SKIP
+      bank_id = hash.key?('bank_id') ? hash['bank_id'] : SKIP
+      bank_id_code = hash.key?('bank_id_code') ? hash['bank_id_code'] : SKIP
+      bank_name = hash.key?('bank_name') ? hash['bank_name'] : SKIP
+      bank_party_id = hash.key?('bank_party_id') ? hash['bank_party_id'] : SKIP
+
+      # Create object from extracted values.
+      SendersCorrespondentAccountHoldingEntity.new(bank_address,
+                                                   bank_id,
+                                                   bank_id_code,
+                                                   bank_name,
+                                                   bank_party_id)
+    end
+  end
+end

data/lib/form3_public_api/models/settlement.rb

@@ -0,0 +1,95 @@
+# form3_public_api
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Form3PublicApi
+  # Specifies the details on how the settlement of the transaction between the
+  # instructing agent and the instructed agent is completed
+  class Settlement < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :account_number
+
+    # The type of identification given at `account_number` attribute
+    # @return [AccountNumberCodeEnum]
+    attr_accessor :account_number_code
+
+    # The type of identification given at `account_number` attribute
+    # @return [String]
+    attr_accessor :bank_id
+
+    # The type of identification given at `account_number` attribute
+    # @return [BankIdCodeEnum]
+    attr_accessor :bank_id_code
+
+    # Method used to settle the payment instruction. Acceptable Values for SEPA:
+    # CLRG. Acceptable Values for SWIFT: INDA (settled by Instructed Agent),
+    # INGA (Settled by Instructing Agent), COVE (Cover Payment)
+    # @return [MethodEnum]
+    attr_accessor :method
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['account_number'] = 'account_number'
+      @_hash['account_number_code'] = 'account_number_code'
+      @_hash['bank_id'] = 'bank_id'
+      @_hash['bank_id_code'] = 'bank_id_code'
+      @_hash['method'] = 'method'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        account_number
+        account_number_code
+        bank_id
+        bank_id_code
+        method
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(account_number = SKIP,
+                   account_number_code = SKIP,
+                   bank_id = SKIP,
+                   bank_id_code = SKIP,
+                   method = SKIP)
+      @account_number = account_number unless account_number == SKIP
+      @account_number_code = account_number_code unless account_number_code == SKIP
+      @bank_id = bank_id unless bank_id == SKIP
+      @bank_id_code = bank_id_code unless bank_id_code == SKIP
+      @method = method unless method == 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_number =
+        hash.key?('account_number') ? hash['account_number'] : SKIP
+      account_number_code =
+        hash.key?('account_number_code') ? hash['account_number_code'] : SKIP
+      bank_id = hash.key?('bank_id') ? hash['bank_id'] : SKIP
+      bank_id_code = hash.key?('bank_id_code') ? hash['bank_id_code'] : SKIP
+      method = hash.key?('method') ? hash['method'] : SKIP
+
+      # Create object from extracted values.
+      Settlement.new(account_number,
+                     account_number_code,
+                     bank_id,
+                     bank_id_code,
+                     method)
+    end
+  end
+end

data/lib/form3_public_api/models/signing_keys_attributes.rb

@@ -0,0 +1,106 @@
+# form3_public_api
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+require 'date'
+module Form3PublicApi
+  # SigningKeysAttributes Model.
+  class SigningKeysAttributes < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :certificate
+
+    # TODO: Write general description for this method
+    # @return [DateTime]
+    attr_accessor :expiration_datetime
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :public_key
+
+    # TODO: Write general description for this method
+    # @return [DateTime]
+    attr_accessor :revocation_datetime
+
+    # TODO: Write general description for this method
+    # @return [Status5Enum]
+    attr_accessor :status
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['certificate'] = 'certificate'
+      @_hash['expiration_datetime'] = 'expiration_datetime'
+      @_hash['public_key'] = 'public_key'
+      @_hash['revocation_datetime'] = 'revocation_datetime'
+      @_hash['status'] = 'status'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        certificate
+        expiration_datetime
+        revocation_datetime
+        status
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(public_key = nil,
+                   certificate = SKIP,
+                   expiration_datetime = SKIP,
+                   revocation_datetime = SKIP,
+                   status = SKIP)
+      @certificate = certificate unless certificate == SKIP
+      @expiration_datetime = expiration_datetime unless expiration_datetime == SKIP
+      @public_key = public_key
+      @revocation_datetime = revocation_datetime unless revocation_datetime == SKIP
+      @status = status unless status == 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.
+      public_key = hash.key?('public_key') ? hash['public_key'] : nil
+      certificate = hash.key?('certificate') ? hash['certificate'] : SKIP
+      expiration_datetime = if hash.key?('expiration_datetime')
+                              (DateTimeHelper.from_rfc3339(hash['expiration_datetime']) if hash['expiration_datetime'])
+                            else
+                              SKIP
+                            end
+      revocation_datetime = if hash.key?('revocation_datetime')
+                              (DateTimeHelper.from_rfc3339(hash['revocation_datetime']) if hash['revocation_datetime'])
+                            else
+                              SKIP
+                            end
+      status = hash.key?('status') ? hash['status'] : SKIP
+
+      # Create object from extracted values.
+      SigningKeysAttributes.new(public_key,
+                                certificate,
+                                expiration_datetime,
+                                revocation_datetime,
+                                status)
+    end
+
+    def to_custom_expiration_datetime
+      DateTimeHelper.to_rfc3339(expiration_datetime)
+    end
+
+    def to_custom_revocation_datetime
+      DateTimeHelper.to_rfc3339(revocation_datetime)
+    end
+  end
+end

data/lib/form3_public_api/models/signing_keys_list_response.rb

@@ -0,0 +1,57 @@
+# form3_public_api
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Form3PublicApi
+  # SigningKeysListResponse Model.
+  class SigningKeysListResponse < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [Array[SigningKeysResponseData]]
+    attr_accessor :data
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['data'] = 'data'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(data = nil)
+      @data = data
+    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
+      data = nil
+      unless hash['data'].nil?
+        data = []
+        hash['data'].each do |structure|
+          data << (SigningKeysResponseData.from_hash(structure) if structure)
+        end
+      end
+
+      data = nil unless hash.key?('data')
+
+      # Create object from extracted values.
+      SigningKeysListResponse.new(data)
+    end
+  end
+end

data/lib/form3_public_api/models/signing_keys_resource_type_enum.rb

@@ -0,0 +1,20 @@
+# form3_public_api
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Form3PublicApi
+  # SigningKeysResourceType.
+  class SigningKeysResourceTypeEnum
+    SIGNING_KEYS_RESOURCE_TYPE_ENUM = [
+      # TODO: Write general description for SIGNING_KEYS
+      SIGNING_KEYS = 'signing_keys'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      SIGNING_KEYS_RESOURCE_TYPE_ENUM.include?(value)
+    end
+  end
+end