pq-api-matic-sdk 1.0.0

data/lib/pay_quicker_sdk/models/occupations.rb

@@ -0,0 +1,100 @@
+# pay_quicker_sdk
+#
+# This file was automatically generated for PayQuicker by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module PayQuickerSdk
+  # [Type of occupation](#/rest/models/structures/occupation) for the user
+  class Occupations
+    OCCUPATIONS = [
+      # TODO: Write general description for ARTS
+      ARTS = 'ARTS'.freeze,
+
+      # TODO: Write general description for DESIGN
+      DESIGN = 'DESIGN'.freeze,
+
+      # TODO: Write general description for EDUCATION
+      EDUCATION = 'EDUCATION'.freeze,
+
+      # TODO: Write general description for ENGINEERING
+      ENGINEERING = 'ENGINEERING'.freeze,
+
+      # TODO: Write general description for FINANCE
+      FINANCE = 'FINANCE'.freeze,
+
+      # TODO: Write general description for GOVERNMENT
+      GOVERNMENT = 'GOVERNMENT'.freeze,
+
+      # TODO: Write general description for HEALTHCARE
+      HEALTHCARE = 'HEALTHCARE'.freeze,
+
+      # TODO: Write general description for HOSPITALITY_AND_TOURISM
+      HOSPITALITY_AND_TOURISM = 'HOSPITALITY_AND_TOURISM'.freeze,
+
+      # TODO: Write general description for INDEPENDENT_BUSINESS_OWNER
+      INDEPENDENT_BUSINESS_OWNER = 'INDEPENDENT_BUSINESS_OWNER'.freeze,
+
+      # TODO: Write general description for LAW
+      LAW = 'LAW'.freeze,
+
+      # TODO: Write general description for MANUFACTURING
+      MANUFACTURING = 'MANUFACTURING'.freeze,
+
+      # TODO: Write general description for MATH
+      MATH = 'MATH'.freeze,
+
+      # TODO: Write general description for MEDIA
+      MEDIA = 'MEDIA'.freeze,
+
+      # TODO: Write general description for OFFICE_AND_ADMIN_SUPPORT
+      OFFICE_AND_ADMIN_SUPPORT = 'OFFICE_AND_ADMIN_SUPPORT'.freeze,
+
+      # TODO: Write general description for SCIENCE
+      SCIENCE = 'SCIENCE'.freeze,
+
+      # TODO: Write general description for SOCIAL_SERVICES
+      SOCIAL_SERVICES = 'SOCIAL_SERVICES'.freeze,
+
+      # TODO: Write general description for TECHNOLOGY
+      TECHNOLOGY = 'TECHNOLOGY'.freeze,
+
+      # TODO: Write general description for SALES
+      SALES = 'SALES'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      OCCUPATIONS.include?(value)
+    end
+
+    def self.from_value(value, default_value = ARTS)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'arts' then ARTS
+      when 'design' then DESIGN
+      when 'education' then EDUCATION
+      when 'engineering' then ENGINEERING
+      when 'finance' then FINANCE
+      when 'government' then GOVERNMENT
+      when 'healthcare' then HEALTHCARE
+      when 'hospitality_and_tourism' then HOSPITALITY_AND_TOURISM
+      when 'independent_business_owner' then INDEPENDENT_BUSINESS_OWNER
+      when 'law' then LAW
+      when 'manufacturing' then MANUFACTURING
+      when 'math' then MATH
+      when 'media' then MEDIA
+      when 'office_and_admin_support' then OFFICE_AND_ADMIN_SUPPORT
+      when 'science' then SCIENCE
+      when 'social_services' then SOCIAL_SERVICES
+      when 'technology' then TECHNOLOGY
+      when 'sales' then SALES
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/pay_quicker_sdk/models/operation_result.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
+  # OperationResult Model.
+  class OperationResult < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The result of the api operation
+    # @return [TrueClass | FalseClass]
+    attr_accessor :result
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['result'] = 'result'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        result
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(result = SKIP, additional_properties = {})
+      # Add additional model properties to the instance.
+      additional_properties.each do |_name, _value|
+        instance_variable_set("@#{_name}", _value)
+      end
+
+      @result = result unless result == 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.
+      result = hash.key?('result') ? hash['result'] : SKIP
+
+      # Clean out expected properties from Hash.
+      additional_properties = hash.reject { |k, _| names.value?(k) }
+
+      # Create object from extracted values.
+      OperationResult.new(result,
+                          additional_properties)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} result: #{@result}, 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} result: #{@result.inspect}, additional_properties:"\
+      " #{get_additional_properties}>"
+    end
+  end
+end

data/lib/pay_quicker_sdk/models/order_prepaid_card.rb

@@ -0,0 +1,97 @@
+# pay_quicker_sdk
+#
+# This file was automatically generated for PayQuicker by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module PayQuickerSdk
+  # OrderPrepaidCard Model.
+  class OrderPrepaidCard < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # [Package](#/rest/models/structures/prepaid-card-package) for the card
+    # being displayed, including artwork, packaging, and delivery method
+    # @return [String]
+    attr_accessor :card_package
+
+    # Auto-generated unique identifier representing a program, prefixed with
+    # prog-
+    # @return [String]
+    attr_accessor :program_token
+
+    # Number that is printed on the back of a plastic card.
+    # @return [String]
+    attr_accessor :card_reference_number
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['card_package'] = 'cardPackage'
+      @_hash['program_token'] = 'programToken'
+      @_hash['card_reference_number'] = 'cardReferenceNumber'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        card_package
+        program_token
+        card_reference_number
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(card_package = SKIP, program_token = SKIP,
+                   card_reference_number = SKIP, additional_properties = {})
+      # Add additional model properties to the instance.
+      additional_properties.each do |_name, _value|
+        instance_variable_set("@#{_name}", _value)
+      end
+
+      @card_package = card_package unless card_package == SKIP
+      @program_token = program_token unless program_token == SKIP
+      @card_reference_number = card_reference_number unless card_reference_number == 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.
+      card_package = hash.key?('cardPackage') ? hash['cardPackage'] : SKIP
+      program_token = hash.key?('programToken') ? hash['programToken'] : SKIP
+      card_reference_number =
+        hash.key?('cardReferenceNumber') ? hash['cardReferenceNumber'] : SKIP
+
+      # Clean out expected properties from Hash.
+      additional_properties = hash.reject { |k, _| names.value?(k) }
+
+      # Create object from extracted values.
+      OrderPrepaidCard.new(card_package,
+                           program_token,
+                           card_reference_number,
+                           additional_properties)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} card_package: #{@card_package}, program_token: #{@program_token},"\
+      " card_reference_number: #{@card_reference_number}, 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} card_package: #{@card_package.inspect}, program_token:"\
+      " #{@program_token.inspect}, card_reference_number: #{@card_reference_number.inspect},"\
+      " additional_properties: #{get_additional_properties}>"
+    end
+  end
+end

data/lib/pay_quicker_sdk/models/payment_job_list_result.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
+  # PaymentJobListResult Model.
+  class PaymentJobListResult < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [Array[PaymentJobObject]]
+    attr_accessor :payload
+
+    # TODO: Write general description for this method
+    # @return [ListMetadata]
+    attr_accessor :meta
+
+    # TODO: Write general description for this method
+    # @return [Array[HateoasSelfRef]]
+    attr_accessor :links
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['payload'] = 'payload'
+      @_hash['meta'] = 'meta'
+      @_hash['links'] = 'links'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(payload = nil, meta = nil, links = nil,
+                   additional_properties = {})
+      # Add additional model properties to the instance.
+      additional_properties.each do |_name, _value|
+        instance_variable_set("@#{_name}", _value)
+      end
+
+      @payload = payload
+      @meta = meta
+      @links = links
+    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 << (PaymentJobObject.from_hash(structure) if structure)
+        end
+      end
+
+      payload = nil unless hash.key?('payload')
+      meta = ListMetadata.from_hash(hash['meta']) if hash['meta']
+      # 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 = nil unless hash.key?('links')
+
+      # Clean out expected properties from Hash.
+      additional_properties = hash.reject { |k, _| names.value?(k) }
+
+      # Create object from extracted values.
+      PaymentJobListResult.new(payload,
+                               meta,
+                               links,
+                               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}, meta: #{@meta}, links: #{@links},"\
+      " 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}, meta: #{@meta.inspect}, links:"\
+      " #{@links.inspect}, additional_properties: #{get_additional_properties}>"
+    end
+  end
+end

data/lib/pay_quicker_sdk/models/payment_job_object.rb

@@ -0,0 +1,211 @@
+# pay_quicker_sdk
+#
+# This file was automatically generated for PayQuicker by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+require 'date'
+module PayQuickerSdk
+  # Response from a payment job request
+  class PaymentJobObject < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # [Token](#/rest/models/structures/token) representing the resource
+    # @return [String]
+    attr_accessor :token
+
+    # Reference ID in the PayQuicker Hosted Portal, if applicable.
+    # @return [String]
+    attr_accessor :portal_id
+
+    # The name given to a computer file in order to distinguish it from other
+    # files
+    # @return [String]
+    attr_accessor :filename
+
+    # [Token](#/rest/models/structures/token) representing the document
+    # @return [String]
+    attr_accessor :file_token
+
+    # Time object was [created](#/rest/models/structures/created-on)
+    # @return [DateTime]
+    attr_accessor :created
+
+    # [Transfer](#/rest/models/structures/not-before-or-after) is scheduled and
+    # will not process before this time.
+    # @return [DateTime]
+    attr_accessor :not_before
+
+    # [Transfer](#/rest/models/structures/not-before-or-after) is scheduled and
+    # will not process before this time.
+    # @return [Integer]
+    attr_accessor :count
+
+    # Job Types
+    # @return [JobTypes]
+    attr_accessor :type
+
+    # Job Status Types
+    # @return [JobStatusTypes]
+    attr_accessor :status
+
+    # Job Status Types
+    # @return [Array[PaymentObject]]
+    attr_accessor :items
+
+    # Job Status Types
+    # @return [Array[HateoasSelfRef]]
+    attr_accessor :links
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['token'] = 'token'
+      @_hash['portal_id'] = 'portalId'
+      @_hash['filename'] = 'filename'
+      @_hash['file_token'] = 'fileToken'
+      @_hash['created'] = 'created'
+      @_hash['not_before'] = 'notBefore'
+      @_hash['count'] = 'count'
+      @_hash['type'] = 'type'
+      @_hash['status'] = 'status'
+      @_hash['items'] = 'items'
+      @_hash['links'] = 'links'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        token
+        portal_id
+        filename
+        file_token
+        created
+        not_before
+        count
+        type
+        status
+        items
+        links
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(token = SKIP, portal_id = SKIP, filename = SKIP,
+                   file_token = 'docu-2053aaad-c1a5-45e2-a2da-f71287f32800',
+                   created = SKIP, not_before = SKIP, count = SKIP, type = SKIP,
+                   status = SKIP, items = SKIP, links = SKIP,
+                   additional_properties = {})
+      # Add additional model properties to the instance.
+      additional_properties.each do |_name, _value|
+        instance_variable_set("@#{_name}", _value)
+      end
+
+      @token = token unless token == SKIP
+      @portal_id = portal_id unless portal_id == SKIP
+      @filename = filename unless filename == SKIP
+      @file_token = file_token unless file_token == SKIP
+      @created = created unless created == SKIP
+      @not_before = not_before unless not_before == SKIP
+      @count = count unless count == SKIP
+      @type = type unless type == SKIP
+      @status = status unless status == SKIP
+      @items = items unless items == SKIP
+      @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.
+      token = hash.key?('token') ? hash['token'] : SKIP
+      portal_id = hash.key?('portalId') ? hash['portalId'] : SKIP
+      filename = hash.key?('filename') ? hash['filename'] : SKIP
+      file_token =
+        hash['fileToken'] ||= 'docu-2053aaad-c1a5-45e2-a2da-f71287f32800'
+      created = if hash.key?('created')
+                  (DateTimeHelper.from_rfc3339(hash['created']) if hash['created'])
+                else
+                  SKIP
+                end
+      not_before = if hash.key?('notBefore')
+                     (DateTimeHelper.from_rfc3339(hash['notBefore']) if hash['notBefore'])
+                   else
+                     SKIP
+                   end
+      count = hash.key?('count') ? hash['count'] : SKIP
+      type = hash.key?('type') ? hash['type'] : SKIP
+      status = hash.key?('status') ? hash['status'] : SKIP
+      # Parameter is an array, so we need to iterate through it
+      items = nil
+      unless hash['items'].nil?
+        items = []
+        hash['items'].each do |structure|
+          items << (PaymentObject.from_hash(structure) if structure)
+        end
+      end
+
+      items = SKIP unless hash.key?('items')
+      # 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')
+
+      # Clean out expected properties from Hash.
+      additional_properties = hash.reject { |k, _| names.value?(k) }
+
+      # Create object from extracted values.
+      PaymentJobObject.new(token,
+                           portal_id,
+                           filename,
+                           file_token,
+                           created,
+                           not_before,
+                           count,
+                           type,
+                           status,
+                           items,
+                           links,
+                           additional_properties)
+    end
+
+    def to_custom_created
+      DateTimeHelper.to_rfc3339(created)
+    end
+
+    def to_custom_not_before
+      DateTimeHelper.to_rfc3339(not_before)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} token: #{@token}, portal_id: #{@portal_id}, filename: #{@filename},"\
+      " file_token: #{@file_token}, created: #{@created}, not_before: #{@not_before}, count:"\
+      " #{@count}, type: #{@type}, status: #{@status}, items: #{@items}, links: #{@links},"\
+      " 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} token: #{@token.inspect}, portal_id: #{@portal_id.inspect}, filename:"\
+      " #{@filename.inspect}, file_token: #{@file_token.inspect}, created: #{@created.inspect},"\
+      " not_before: #{@not_before.inspect}, count: #{@count.inspect}, type: #{@type.inspect},"\
+      " status: #{@status.inspect}, items: #{@items.inspect}, links: #{@links.inspect},"\
+      " additional_properties: #{get_additional_properties}>"
+    end
+  end
+end