payquicker-apimatic-sdk 1.0.0

data/lib/pay_quicker_sdk/models/languages.rb

@@ -0,0 +1,101 @@
+# pay_quicker_sdk
+#
+# This file was automatically generated for PayQuicker by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module PayQuickerSdk
+  # The [Language](#/rest/models/structures/language) type in IETF's BCP 47
+  # format
+  class Languages
+    LANGUAGES = [
+      # Czech
+      CSCZ = 'cs-CZ'.freeze,
+
+      # German
+      DEDE = 'de-DE'.freeze,
+
+      # English (UK)
+      ENGB = 'en-GB'.freeze,
+
+      # English (US)
+      ENUS = 'en-US'.freeze,
+
+      # Spanish (Spain)
+      ESES = 'es-ES'.freeze,
+
+      # Spanish (Mexico)
+      ESMX = 'es-MX'.freeze,
+
+      # French (Canadian)
+      FRCA = 'fr-CA'.freeze,
+
+      # French (France)
+      FRFR = 'fr-FR'.freeze,
+
+      # Italian
+      ITIT = 'it-IT'.freeze,
+
+      # I bet you already know
+      JAJP = 'ja-JP'.freeze,
+
+      # Korea
+      KOKR = 'ko-KR'.freeze,
+
+      # Dutch
+      NLNL = 'nl-NL'.freeze,
+
+      # Polish
+      PLPL = 'pl-PL'.freeze,
+
+      # Portuguese (Brazil)
+      PTBR = 'pt-BR'.freeze,
+
+      # Portuguese (Portugal)
+      PTPT = 'pt-PT'.freeze,
+
+      # Russian
+      RURU = 'ru-RU'.freeze,
+
+      # Chinese (Simplified)
+      ZHHANS = 'zh-Hans'.freeze,
+
+      # Chinese (Traditional)
+      ZHHANT = 'zh-Hant'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      LANGUAGES.include?(value)
+    end
+
+    def self.from_value(value, default_value = CSCZ)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'cscz' then CSCZ
+      when 'dede' then DEDE
+      when 'engb' then ENGB
+      when 'enus' then ENUS
+      when 'eses' then ESES
+      when 'esmx' then ESMX
+      when 'frca' then FRCA
+      when 'frfr' then FRFR
+      when 'itit' then ITIT
+      when 'jajp' then JAJP
+      when 'kokr' then KOKR
+      when 'nlnl' then NLNL
+      when 'plpl' then PLPL
+      when 'ptbr' then PTBR
+      when 'ptpt' then PTPT
+      when 'ruru' then RURU
+      when 'zhhans' then ZHHANS
+      when 'zhhant' then ZHHANT
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/pay_quicker_sdk/models/list_metadata.rb

@@ -0,0 +1,116 @@
+# pay_quicker_sdk
+#
+# This file was automatically generated for PayQuicker by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module PayQuickerSdk
+  # ListMetadata Model.
+  class ListMetadata < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :page_no
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :page_size
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :page_count
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :record_count
+
+    # Timezone of the datetime objects in the response
+    # @return [String]
+    attr_accessor :timezone
+
+    # Timezone of the datetime objects in the response
+    # @return [String]
+    attr_accessor :request_ref
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['page_no'] = 'pageNo'
+      @_hash['page_size'] = 'pageSize'
+      @_hash['page_count'] = 'pageCount'
+      @_hash['record_count'] = 'recordCount'
+      @_hash['timezone'] = 'timezone'
+      @_hash['request_ref'] = 'requestRef'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(page_no = '1', page_size = '10', page_count = '1',
+                   record_count = nil, timezone = nil, request_ref = nil,
+                   additional_properties = {})
+      # Add additional model properties to the instance.
+      additional_properties.each do |_name, _value|
+        instance_variable_set("@#{_name}", _value)
+      end
+
+      @page_no = page_no
+      @page_size = page_size
+      @page_count = page_count
+      @record_count = record_count
+      @timezone = timezone
+      @request_ref = request_ref
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      page_no = hash['pageNo'] ||= '1'
+      page_size = hash['pageSize'] ||= '10'
+      page_count = hash['pageCount'] ||= '1'
+      record_count = hash.key?('recordCount') ? hash['recordCount'] : nil
+      timezone = hash.key?('timezone') ? hash['timezone'] : nil
+      request_ref = hash.key?('requestRef') ? hash['requestRef'] : nil
+
+      # Clean out expected properties from Hash.
+      additional_properties = hash.reject { |k, _| names.value?(k) }
+
+      # Create object from extracted values.
+      ListMetadata.new(page_no,
+                       page_size,
+                       page_count,
+                       record_count,
+                       timezone,
+                       request_ref,
+                       additional_properties)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} page_no: #{@page_no}, page_size: #{@page_size}, page_count: #{@page_count},"\
+      " record_count: #{@record_count}, timezone: #{@timezone}, request_ref: #{@request_ref},"\
+      " 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} page_no: #{@page_no.inspect}, page_size: #{@page_size.inspect}, page_count:"\
+      " #{@page_count.inspect}, record_count: #{@record_count.inspect}, timezone:"\
+      " #{@timezone.inspect}, request_ref: #{@request_ref.inspect}, additional_properties:"\
+      " #{get_additional_properties}>"
+    end
+  end
+end

data/lib/pay_quicker_sdk/models/lock_side_types.rb

@@ -0,0 +1,37 @@
+# pay_quicker_sdk
+#
+# This file was automatically generated for PayQuicker by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module PayQuickerSdk
+  # Type of [lockside](page:additional-api-information/transfer-lockside-types)
+  # for transfers.
+  class LockSideTypes
+    LOCK_SIDE_TYPES = [
+      # TODO: Write general description for SOURCE
+      SOURCE = 'SOURCE'.freeze,
+
+      # TODO: Write general description for DESTINATION
+      DESTINATION = 'DESTINATION'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      LOCK_SIDE_TYPES.include?(value)
+    end
+
+    def self.from_value(value, default_value = SOURCE)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'source' then SOURCE
+      when 'destination' then DESTINATION
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/pay_quicker_sdk/models/metadata.rb

@@ -0,0 +1,72 @@
+# pay_quicker_sdk
+#
+# This file was automatically generated for PayQuicker by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module PayQuickerSdk
+  # Metadata Model.
+  class Metadata < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [MetadataItems]
+    attr_accessor :meta
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['meta'] = 'meta'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        meta
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(meta = SKIP, additional_properties = {})
+      # Add additional model properties to the instance.
+      additional_properties.each do |_name, _value|
+        instance_variable_set("@#{_name}", _value)
+      end
+
+      @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.
+      meta = MetadataItems.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.
+      Metadata.new(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} 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} meta: #{@meta.inspect}, additional_properties:"\
+      " #{get_additional_properties}>"
+    end
+  end
+end

data/lib/pay_quicker_sdk/models/metadata_items.rb

@@ -0,0 +1,80 @@
+# pay_quicker_sdk
+#
+# This file was automatically generated for PayQuicker by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module PayQuickerSdk
+  # MetadataItems Model.
+  class MetadataItems < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Timezone of the datetime objects in the response
+    # @return [String]
+    attr_accessor :timezone
+
+    # Timezone of the datetime objects in the response
+    # @return [String]
+    attr_accessor :request_ref
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['timezone'] = 'timezone'
+      @_hash['request_ref'] = 'requestRef'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(timezone = nil, request_ref = nil,
+                   additional_properties = {})
+      # Add additional model properties to the instance.
+      additional_properties.each do |_name, _value|
+        instance_variable_set("@#{_name}", _value)
+      end
+
+      @timezone = timezone
+      @request_ref = request_ref
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      timezone = hash.key?('timezone') ? hash['timezone'] : nil
+      request_ref = hash.key?('requestRef') ? hash['requestRef'] : nil
+
+      # Clean out expected properties from Hash.
+      additional_properties = hash.reject { |k, _| names.value?(k) }
+
+      # Create object from extracted values.
+      MetadataItems.new(timezone,
+                        request_ref,
+                        additional_properties)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} timezone: #{@timezone}, request_ref: #{@request_ref},"\
+      " 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} timezone: #{@timezone.inspect}, request_ref: #{@request_ref.inspect},"\
+      " additional_properties: #{get_additional_properties}>"
+    end
+  end
+end

data/lib/pay_quicker_sdk/models/o_auth_provider_error.rb

@@ -0,0 +1,62 @@
+# pay_quicker_sdk
+#
+# This file was automatically generated for PayQuicker by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module PayQuickerSdk
+  # OAuth 2 Authorization error codes
+  class OAuthProviderError
+    O_AUTH_PROVIDER_ERROR = [
+      # The request is missing a required parameter, includes an unsupported
+      # parameter value (other than grant type), repeats a parameter, includes
+      # multiple credentials, utilizes more than one mechanism for
+      # authenticating the client, or is otherwise malformed.
+      INVALID_REQUEST = 'invalid_request'.freeze,
+
+      # Client authentication failed (e.g., unknown client, no client
+      # authentication included, or unsupported authentication method).
+      INVALID_CLIENT = 'invalid_client'.freeze,
+
+      # The provided authorization grant (e.g., authorization code, resource
+      # owner credentials) or refresh token is invalid, expired, revoked, does
+      # not match the redirection URI used in the authorization request, or was
+      # issued to another client.
+      INVALID_GRANT = 'invalid_grant'.freeze,
+
+      # The authenticated client is not authorized to use this authorization
+      # grant type.
+      UNAUTHORIZED_CLIENT = 'unauthorized_client'.freeze,
+
+      # The authorization grant type is not supported by the authorization
+      # server.
+      UNSUPPORTED_GRANT_TYPE = 'unsupported_grant_type'.freeze,
+
+      # The requested scope is invalid, unknown, malformed, or exceeds the scope
+      # granted by the resource owner.
+      INVALID_SCOPE = 'invalid_scope'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      O_AUTH_PROVIDER_ERROR.include?(value)
+    end
+
+    def self.from_value(value, default_value = INVALID_REQUEST)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'invalid_request' then INVALID_REQUEST
+      when 'invalid_client' then INVALID_CLIENT
+      when 'invalid_grant' then INVALID_GRANT
+      when 'unauthorized_client' then UNAUTHORIZED_CLIENT
+      when 'unsupported_grant_type' then UNSUPPORTED_GRANT_TYPE
+      when 'invalid_scope' then INVALID_SCOPE
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/pay_quicker_sdk/models/o_auth_scope_server.rb

@@ -0,0 +1,36 @@
+# pay_quicker_sdk
+#
+# This file was automatically generated for PayQuicker by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module PayQuickerSdk
+  # OAuth 2 scopes supported by the API
+  class OAuthScopeServer
+    O_AUTH_SCOPE_SERVER = [
+      # readonly scope
+      READONLY = 'readonly'.freeze,
+
+      # modify scope
+      MODIFY = 'modify'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      O_AUTH_SCOPE_SERVER.include?(value)
+    end
+
+    def self.from_value(value, default_value = READONLY)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'readonly' then READONLY
+      when 'modify' then MODIFY
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/pay_quicker_sdk/models/o_auth_token.rb

@@ -0,0 +1,106 @@
+# pay_quicker_sdk
+#
+# This file was automatically generated for PayQuicker by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module PayQuickerSdk
+  # OAuth 2 Authorization endpoint response
+  class OAuthToken < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Access token
+    # @return [String]
+    attr_accessor :access_token
+
+    # Type of access token
+    # @return [String]
+    attr_accessor :token_type
+
+    # Time in seconds before the access token expires
+    # @return [Integer]
+    attr_accessor :expires_in
+
+    # List of scopes granted
+    # This is a space-delimited list of strings.
+    # @return [String]
+    attr_accessor :scope
+
+    # Time of token expiry as unix timestamp (UTC)
+    # @return [Integer]
+    attr_accessor :expiry
+
+    # Refresh token
+    # Used to get a new access token when it expires.
+    # @return [String]
+    attr_accessor :refresh_token
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['access_token'] = 'access_token'
+      @_hash['token_type'] = 'token_type'
+      @_hash['expires_in'] = 'expires_in'
+      @_hash['scope'] = 'scope'
+      @_hash['expiry'] = 'expiry'
+      @_hash['refresh_token'] = 'refresh_token'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        expires_in
+        scope
+        expiry
+        refresh_token
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(access_token = nil, token_type = nil, expires_in = SKIP,
+                   scope = SKIP, expiry = SKIP, refresh_token = SKIP,
+                   additional_properties = {})
+      # Add additional model properties to the instance.
+      additional_properties.each do |_name, _value|
+        instance_variable_set("@#{_name}", _value)
+      end
+
+      @access_token = access_token
+      @token_type = token_type
+      @expires_in = expires_in unless expires_in == SKIP
+      @scope = scope unless scope == SKIP
+      @expiry = expiry unless expiry == SKIP
+      @refresh_token = refresh_token unless refresh_token == 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.
+      access_token = hash.key?('access_token') ? hash['access_token'] : nil
+      token_type = hash.key?('token_type') ? hash['token_type'] : nil
+      expires_in = hash.key?('expires_in') ? hash['expires_in'] : SKIP
+      scope = hash.key?('scope') ? hash['scope'] : SKIP
+      expiry = hash.key?('expiry') ? hash['expiry'] : SKIP
+      refresh_token = hash.key?('refresh_token') ? hash['refresh_token'] : SKIP
+
+      # Clean out expected properties from Hash.
+      additional_properties = hash.reject { |k, _| names.value?(k) }
+
+      # Create object from extracted values.
+      OAuthToken.new(access_token,
+                     token_type,
+                     expires_in,
+                     scope,
+                     expiry,
+                     refresh_token,
+                     additional_properties)
+    end
+  end
+end