pq-api-matic-sdk 1.0.0

data/lib/pay_quicker_sdk/models/bank_account_required_fields.rb

@@ -0,0 +1,125 @@
+# pay_quicker_sdk
+#
+# This file was automatically generated for PayQuicker by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module PayQuickerSdk
+  # Classifies the required [bank account
+  # field](#/rest/models/structures/bank-account-required-fields) objects
+  class BankAccountRequiredFields < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Classifies the
+    # [format](#/rest/models/structures/bank-account-requirement-format) of the
+    # required information for a bank account
+    # @return [BankAccountRequirementFormat]
+    attr_accessor :format
+
+    # Classifies bank account [field
+    # types](#/rest/models/structures/bank-account-fields)
+    # @return [BankAccountFields]
+    attr_accessor :requirement
+
+    # Localized requirement description for display purposes
+    # @return [Array[Translation]]
+    attr_accessor :description
+
+    # Localized requirement description for display purposes
+    # @return [Array[BankAccountRequirementValidator]]
+    attr_accessor :validators
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['format'] = 'format'
+      @_hash['requirement'] = 'requirement'
+      @_hash['description'] = 'description'
+      @_hash['validators'] = 'validators'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        format
+        requirement
+        description
+        validators
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(format = SKIP, requirement = SKIP, description = SKIP,
+                   validators = SKIP, additional_properties = {})
+      # Add additional model properties to the instance.
+      additional_properties.each do |_name, _value|
+        instance_variable_set("@#{_name}", _value)
+      end
+
+      @format = format unless format == SKIP
+      @requirement = requirement unless requirement == SKIP
+      @description = description unless description == SKIP
+      @validators = validators unless validators == 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.
+      format = BankAccountRequirementFormat.from_hash(hash['format']) if hash['format']
+      requirement = hash.key?('requirement') ? hash['requirement'] : SKIP
+      # Parameter is an array, so we need to iterate through it
+      description = nil
+      unless hash['description'].nil?
+        description = []
+        hash['description'].each do |structure|
+          description << (Translation.from_hash(structure) if structure)
+        end
+      end
+
+      description = SKIP unless hash.key?('description')
+      # Parameter is an array, so we need to iterate through it
+      validators = nil
+      unless hash['validators'].nil?
+        validators = []
+        hash['validators'].each do |structure|
+          validators << (BankAccountRequirementValidator.from_hash(structure) if structure)
+        end
+      end
+
+      validators = SKIP unless hash.key?('validators')
+
+      # Clean out expected properties from Hash.
+      additional_properties = hash.reject { |k, _| names.value?(k) }
+
+      # Create object from extracted values.
+      BankAccountRequiredFields.new(format,
+                                    requirement,
+                                    description,
+                                    validators,
+                                    additional_properties)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} format: #{@format}, requirement: #{@requirement}, description:"\
+      " #{@description}, validators: #{@validators}, additional_properties:"\
+      " #{get_additional_properties}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} format: #{@format.inspect}, requirement: #{@requirement.inspect},"\
+      " description: #{@description.inspect}, validators: #{@validators.inspect},"\
+      " additional_properties: #{get_additional_properties}>"
+    end
+  end
+end

data/lib/pay_quicker_sdk/models/bank_account_requirement.rb

@@ -0,0 +1,142 @@
+# pay_quicker_sdk
+#
+# This file was automatically generated for PayQuicker by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module PayQuickerSdk
+  # Classifies the bank account
+  # [required](#/rest/models/structures/bank-account-requirement) information
+  class BankAccountRequirement < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Throughout the PayQuicker API, the usage of the 2-letter alpha code is
+    # used in place of the country name, e.g., for bank country or residential
+    # country.
+    # The 2-letter codes adhere to the ISO 3166-1 spec and are listed here for
+    # convenience.
+    # @return [Countries]
+    attr_accessor :bank_country
+
+    # [Currency code type](#/rest/models/structures/country) for the object
+    # @return [Currencies]
+    attr_accessor :bank_currency
+
+    # [Currency code type](#/rest/models/structures/country) for the object
+    # @return [FeeConfiguration]
+    attr_accessor :fee
+
+    # Throughout the PayQuicker API, the usage of the 2-letter alpha code is
+    # used in place of the country name, e.g., for bank country or residential
+    # country.
+    # The 2-letter codes adhere to the ISO 3166-1 spec and are listed here for
+    # convenience.
+    # @return [Countries]
+    attr_accessor :source_country
+
+    # [Currency code type](#/rest/models/structures/country) for the object
+    # @return [Currencies]
+    attr_accessor :source_currency
+
+    # [Currency code type](#/rest/models/structures/country) for the object
+    # @return [Array[BankAccountRequiredFields]]
+    attr_accessor :requirements
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['bank_country'] = 'bankCountry'
+      @_hash['bank_currency'] = 'bankCurrency'
+      @_hash['fee'] = 'fee'
+      @_hash['source_country'] = 'sourceCountry'
+      @_hash['source_currency'] = 'sourceCurrency'
+      @_hash['requirements'] = 'requirements'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        bank_country
+        bank_currency
+        fee
+        source_country
+        source_currency
+        requirements
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(bank_country = SKIP, bank_currency = Currencies::USD,
+                   fee = SKIP, source_country = SKIP,
+                   source_currency = Currencies::USD, requirements = SKIP,
+                   additional_properties = {})
+      # Add additional model properties to the instance.
+      additional_properties.each do |_name, _value|
+        instance_variable_set("@#{_name}", _value)
+      end
+
+      @bank_country = bank_country unless bank_country == SKIP
+      @bank_currency = bank_currency unless bank_currency == SKIP
+      @fee = fee unless fee == SKIP
+      @source_country = source_country unless source_country == SKIP
+      @source_currency = source_currency unless source_currency == SKIP
+      @requirements = requirements unless requirements == 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_country = hash.key?('bankCountry') ? hash['bankCountry'] : SKIP
+      bank_currency = hash['bankCurrency'] ||= Currencies::USD
+      fee = FeeConfiguration.from_hash(hash['fee']) if hash['fee']
+      source_country = hash.key?('sourceCountry') ? hash['sourceCountry'] : SKIP
+      source_currency = hash['sourceCurrency'] ||= Currencies::USD
+      # Parameter is an array, so we need to iterate through it
+      requirements = nil
+      unless hash['requirements'].nil?
+        requirements = []
+        hash['requirements'].each do |structure|
+          requirements << (BankAccountRequiredFields.from_hash(structure) if structure)
+        end
+      end
+
+      requirements = SKIP unless hash.key?('requirements')
+
+      # Clean out expected properties from Hash.
+      additional_properties = hash.reject { |k, _| names.value?(k) }
+
+      # Create object from extracted values.
+      BankAccountRequirement.new(bank_country,
+                                 bank_currency,
+                                 fee,
+                                 source_country,
+                                 source_currency,
+                                 requirements,
+                                 additional_properties)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} bank_country: #{@bank_country}, bank_currency: #{@bank_currency}, fee:"\
+      " #{@fee}, source_country: #{@source_country}, source_currency: #{@source_currency},"\
+      " requirements: #{@requirements}, additional_properties: #{get_additional_properties}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} bank_country: #{@bank_country.inspect}, bank_currency:"\
+      " #{@bank_currency.inspect}, fee: #{@fee.inspect}, source_country:"\
+      " #{@source_country.inspect}, source_currency: #{@source_currency.inspect}, requirements:"\
+      " #{@requirements.inspect}, additional_properties: #{get_additional_properties}>"
+    end
+  end
+end

data/lib/pay_quicker_sdk/models/bank_account_requirement_format.rb

@@ -0,0 +1,93 @@
+# pay_quicker_sdk
+#
+# This file was automatically generated for PayQuicker by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module PayQuickerSdk
+  # Classifies the
+  # [format](#/rest/models/structures/bank-account-requirement-format) of the
+  # required information for a bank account
+  class BankAccountRequirementFormat < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Example of a requirement generated from the validator(s)
+    # @return [String]
+    attr_accessor :example
+
+    # Example of a requirement generated from the validator(s)
+    # @return [Array[BankAccountRequirementFormatLegend]]
+    attr_accessor :legend
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['example'] = 'example'
+      @_hash['legend'] = 'legend'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        example
+        legend
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(example = SKIP, legend = SKIP, additional_properties = {})
+      # Add additional model properties to the instance.
+      additional_properties.each do |_name, _value|
+        instance_variable_set("@#{_name}", _value)
+      end
+
+      @example = example unless example == SKIP
+      @legend = legend unless legend == 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.
+      example = hash.key?('example') ? hash['example'] : SKIP
+      # Parameter is an array, so we need to iterate through it
+      legend = nil
+      unless hash['legend'].nil?
+        legend = []
+        hash['legend'].each do |structure|
+          legend << (BankAccountRequirementFormatLegend.from_hash(structure) if structure)
+        end
+      end
+
+      legend = SKIP unless hash.key?('legend')
+
+      # Clean out expected properties from Hash.
+      additional_properties = hash.reject { |k, _| names.value?(k) }
+
+      # Create object from extracted values.
+      BankAccountRequirementFormat.new(example,
+                                       legend,
+                                       additional_properties)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} example: #{@example}, legend: #{@legend}, additional_properties:"\
+      " #{get_additional_properties}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} example: #{@example.inspect}, legend: #{@legend.inspect},"\
+      " additional_properties: #{get_additional_properties}>"
+    end
+  end
+end

data/lib/pay_quicker_sdk/models/bank_account_requirement_format_legend.rb

@@ -0,0 +1,93 @@
+# pay_quicker_sdk
+#
+# This file was automatically generated for PayQuicker by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module PayQuickerSdk
+  # Classifies the [legend
+  # format](#/rest/models/structures/bank-account-requirement-format-legend) of
+  # the required information for a bank account
+  class BankAccountRequirementFormatLegend < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :key
+
+    # Localized requirement description for display purposes
+    # @return [Array[Translation]]
+    attr_accessor :descriptions
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['key'] = 'key'
+      @_hash['descriptions'] = 'descriptions'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        key
+        descriptions
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(key = SKIP, descriptions = SKIP, additional_properties = {})
+      # Add additional model properties to the instance.
+      additional_properties.each do |_name, _value|
+        instance_variable_set("@#{_name}", _value)
+      end
+
+      @key = key unless key == SKIP
+      @descriptions = descriptions unless descriptions == 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'] : SKIP
+      # Parameter is an array, so we need to iterate through it
+      descriptions = nil
+      unless hash['descriptions'].nil?
+        descriptions = []
+        hash['descriptions'].each do |structure|
+          descriptions << (Translation.from_hash(structure) if structure)
+        end
+      end
+
+      descriptions = SKIP unless hash.key?('descriptions')
+
+      # Clean out expected properties from Hash.
+      additional_properties = hash.reject { |k, _| names.value?(k) }
+
+      # Create object from extracted values.
+      BankAccountRequirementFormatLegend.new(key,
+                                             descriptions,
+                                             additional_properties)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} key: #{@key}, descriptions: #{@descriptions}, additional_properties:"\
+      " #{get_additional_properties}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} key: #{@key.inspect}, descriptions: #{@descriptions.inspect},"\
+      " additional_properties: #{get_additional_properties}>"
+    end
+  end
+end

data/lib/pay_quicker_sdk/models/bank_account_requirement_list_result.rb

@@ -0,0 +1,110 @@
+# pay_quicker_sdk
+#
+# This file was automatically generated for PayQuicker by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module PayQuickerSdk
+  # BankAccountRequirementListResult Model.
+  class BankAccountRequirementListResult < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [Array[BankAccountRequirement]]
+    attr_accessor :payload
+
+    # TODO: Write general description for this method
+    # @return [Array[HateoasSelfRef]]
+    attr_accessor :links
+
+    # TODO: Write general description for this method
+    # @return [ListMetadata]
+    attr_accessor :meta
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['payload'] = 'payload'
+      @_hash['links'] = 'links'
+      @_hash['meta'] = 'meta'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        payload
+        links
+        meta
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(payload = SKIP, links = SKIP, meta = SKIP,
+                   additional_properties = {})
+      # Add additional model properties to the instance.
+      additional_properties.each do |_name, _value|
+        instance_variable_set("@#{_name}", _value)
+      end
+
+      @payload = payload unless payload == SKIP
+      @links = links unless links == SKIP
+      @meta = meta unless meta == 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
+      payload = nil
+      unless hash['payload'].nil?
+        payload = []
+        hash['payload'].each do |structure|
+          payload << (BankAccountRequirement.from_hash(structure) if structure)
+        end
+      end
+
+      payload = SKIP unless hash.key?('payload')
+      # Parameter is an array, so we need to iterate through it
+      links = nil
+      unless hash['links'].nil?
+        links = []
+        hash['links'].each do |structure|
+          links << (HateoasSelfRef.from_hash(structure) if structure)
+        end
+      end
+
+      links = SKIP unless hash.key?('links')
+      meta = ListMetadata.from_hash(hash['meta']) if hash['meta']
+
+      # Clean out expected properties from Hash.
+      additional_properties = hash.reject { |k, _| names.value?(k) }
+
+      # Create object from extracted values.
+      BankAccountRequirementListResult.new(payload,
+                                           links,
+                                           meta,
+                                           additional_properties)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} payload: #{@payload}, links: #{@links}, meta: #{@meta},"\
+      " additional_properties: #{get_additional_properties}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} payload: #{@payload.inspect}, links: #{@links.inspect}, meta:"\
+      " #{@meta.inspect}, additional_properties: #{get_additional_properties}>"
+    end
+  end
+end

data/lib/pay_quicker_sdk/models/bank_account_requirement_validator.rb

@@ -0,0 +1,86 @@
+# pay_quicker_sdk
+#
+# This file was automatically generated for PayQuicker by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module PayQuickerSdk
+  # [Validator
+  # type](#/rest/models/structures/bank-account-requirement-validator) that for
+  # the required bank account information.
+  class BankAccountRequirementValidator < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # [Validator
+    # types](#/rest/models/structures/bank-account-requirement-validator) for
+    # the required bank account information.
+    # @return [ValidatorTypes]
+    attr_accessor :validator_type
+
+    # Validation regular expression
+    # @return [String]
+    attr_accessor :expression
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['validator_type'] = 'validatorType'
+      @_hash['expression'] = 'expression'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        validator_type
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(expression = nil, validator_type = SKIP,
+                   additional_properties = {})
+      # Add additional model properties to the instance.
+      additional_properties.each do |_name, _value|
+        instance_variable_set("@#{_name}", _value)
+      end
+
+      @validator_type = validator_type unless validator_type == SKIP
+      @expression = expression
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      expression = hash.key?('expression') ? hash['expression'] : nil
+      validator_type = hash.key?('validatorType') ? hash['validatorType'] : SKIP
+
+      # Clean out expected properties from Hash.
+      additional_properties = hash.reject { |k, _| names.value?(k) }
+
+      # Create object from extracted values.
+      BankAccountRequirementValidator.new(expression,
+                                          validator_type,
+                                          additional_properties)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} validator_type: #{@validator_type}, expression: #{@expression},"\
+      " additional_properties: #{get_additional_properties}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} validator_type: #{@validator_type.inspect}, expression:"\
+      " #{@expression.inspect}, additional_properties: #{get_additional_properties}>"
+    end
+  end
+end