pq-api-matic-sdk 1.0.0

data/lib/pay_quicker_sdk/models/delivery_details.rb

@@ -0,0 +1,119 @@
+# pay_quicker_sdk
+#
+# This file was automatically generated for PayQuicker by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+require 'date'
+module PayQuickerSdk
+  # The delivery details of a Bank transfer with the minimum and maximum
+  # delivery in minutes or the expected delivery time.
+  class DeliveryDetails < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [Integer]
+    attr_accessor :minimum_delivery_minutes
+
+    # TODO: Write general description for this method
+    # @return [Integer]
+    attr_accessor :maximum_delivery_minutes
+
+    # Transfer expected delivery types
+    # @return [ExpectedDeliveryTypes]
+    attr_accessor :expected_delivery
+
+    # The time of the expected delivery. Does not include the date.
+    # @return [DateTime]
+    attr_accessor :expected_delivery_time
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['minimum_delivery_minutes'] = 'minimumDeliveryMinutes'
+      @_hash['maximum_delivery_minutes'] = 'maximumDeliveryMinutes'
+      @_hash['expected_delivery'] = 'expectedDelivery'
+      @_hash['expected_delivery_time'] = 'expectedDeliveryTime'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        minimum_delivery_minutes
+        maximum_delivery_minutes
+        expected_delivery
+        expected_delivery_time
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(minimum_delivery_minutes = SKIP,
+                   maximum_delivery_minutes = SKIP, expected_delivery = SKIP,
+                   expected_delivery_time = SKIP, additional_properties = {})
+      # Add additional model properties to the instance.
+      additional_properties.each do |_name, _value|
+        instance_variable_set("@#{_name}", _value)
+      end
+
+      @minimum_delivery_minutes = minimum_delivery_minutes unless minimum_delivery_minutes == SKIP
+      @maximum_delivery_minutes = maximum_delivery_minutes unless maximum_delivery_minutes == SKIP
+      @expected_delivery = expected_delivery unless expected_delivery == SKIP
+      @expected_delivery_time = expected_delivery_time unless expected_delivery_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.
+      minimum_delivery_minutes =
+        hash.key?('minimumDeliveryMinutes') ? hash['minimumDeliveryMinutes'] : SKIP
+      maximum_delivery_minutes =
+        hash.key?('maximumDeliveryMinutes') ? hash['maximumDeliveryMinutes'] : SKIP
+      expected_delivery =
+        hash.key?('expectedDelivery') ? hash['expectedDelivery'] : SKIP
+      expected_delivery_time = if hash.key?('expectedDeliveryTime')
+                                 (DateTimeHelper.from_rfc3339(hash['expectedDeliveryTime']) if hash['expectedDeliveryTime'])
+                               else
+                                 SKIP
+                               end
+
+      # Clean out expected properties from Hash.
+      additional_properties = hash.reject { |k, _| names.value?(k) }
+
+      # Create object from extracted values.
+      DeliveryDetails.new(minimum_delivery_minutes,
+                          maximum_delivery_minutes,
+                          expected_delivery,
+                          expected_delivery_time,
+                          additional_properties)
+    end
+
+    def to_custom_expected_delivery_time
+      DateTimeHelper.to_rfc3339(expected_delivery_time)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} minimum_delivery_minutes: #{@minimum_delivery_minutes},"\
+      " maximum_delivery_minutes: #{@maximum_delivery_minutes}, expected_delivery:"\
+      " #{@expected_delivery}, expected_delivery_time: #{@expected_delivery_time},"\
+      " 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} minimum_delivery_minutes: #{@minimum_delivery_minutes.inspect},"\
+      " maximum_delivery_minutes: #{@maximum_delivery_minutes.inspect}, expected_delivery:"\
+      " #{@expected_delivery.inspect}, expected_delivery_time: #{@expected_delivery_time.inspect},"\
+      " additional_properties: #{get_additional_properties}>"
+    end
+  end
+end

data/lib/pay_quicker_sdk/models/document_details.rb

@@ -0,0 +1,81 @@
+# pay_quicker_sdk
+#
+# This file was automatically generated for PayQuicker by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module PayQuickerSdk
+  # 1...N required
+  # [fields](#/rest/models/structures/key-value-pair-upload-field-types-string)
+  # as determined by call to get requirements
+  class DocumentDetails < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [UploadFields]
+    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
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(key = nil, value = nil, additional_properties = {})
+      # Add additional model properties to the instance.
+      additional_properties.each do |_name, _value|
+        instance_variable_set("@#{_name}", _value)
+      end
+
+      @key = key
+      @value = value
+    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'] : nil
+
+      # Clean out expected properties from Hash.
+      additional_properties = hash.reject { |k, _| names.value?(k) }
+
+      # Create object from extracted values.
+      DocumentDetails.new(key,
+                          value,
+                          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}, value: #{@value}, 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}, value: #{@value.inspect}, additional_properties:"\
+      " #{get_additional_properties}>"
+    end
+  end
+end

data/lib/pay_quicker_sdk/models/document_list_result.rb

@@ -0,0 +1,108 @@
+# pay_quicker_sdk
+#
+# This file was automatically generated for PayQuicker by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module PayQuickerSdk
+  # DocumentListResult Model.
+  class DocumentListResult < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [Array[DocumentObject]]
+    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
+      %w[
+        meta
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(payload = nil, links = nil, 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
+      @meta = meta unless meta == SKIP
+      @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 << (DocumentObject.from_hash(structure) if structure)
+        end
+      end
+
+      payload = nil 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 = nil 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.
+      DocumentListResult.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}, 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/document_object.rb

@@ -0,0 +1,147 @@
+# pay_quicker_sdk
+#
+# This file was automatically generated for PayQuicker by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+require 'date'
+module PayQuickerSdk
+  # DocumentObject Model.
+  class DocumentObject < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Time object was [created](#/rest/models/structures/created-on)
+    # @return [DateTime]
+    attr_accessor :create_date
+
+    # Time object was [created](#/rest/models/structures/created-on)
+    # @return [Array[DocumentDetails]]
+    attr_accessor :fields
+
+    # The name given to a computer file in order to distinguish it from other
+    # files
+    # @return [String]
+    attr_accessor :filename
+
+    # A label used to identify a type of data.  Acts like a file extension on
+    # the internet.
+    # @return [String]
+    attr_accessor :mime_type
+
+    # [Token](#/rest/models/structures/token) representing the document
+    # @return [String]
+    attr_accessor :token
+
+    # [Token](#/rest/models/structures/token) representing the document
+    # @return [Array[HateoasSelfRef]]
+    attr_accessor :links
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['create_date'] = 'createDate'
+      @_hash['fields'] = 'fields'
+      @_hash['filename'] = 'filename'
+      @_hash['mime_type'] = 'mimeType'
+      @_hash['token'] = 'token'
+      @_hash['links'] = 'links'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        fields
+        filename
+        mime_type
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(create_date = nil,
+                   token = 'docu-2053aaad-c1a5-45e2-a2da-f71287f32800',
+                   links = nil, fields = SKIP, filename = SKIP,
+                   mime_type = SKIP, additional_properties = {})
+      # Add additional model properties to the instance.
+      additional_properties.each do |_name, _value|
+        instance_variable_set("@#{_name}", _value)
+      end
+
+      @create_date = create_date
+      @fields = fields unless fields == SKIP
+      @filename = filename unless filename == SKIP
+      @mime_type = mime_type unless mime_type == SKIP
+      @token = token
+      @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.
+      create_date = if hash.key?('createDate')
+                      (DateTimeHelper.from_rfc3339(hash['createDate']) if hash['createDate'])
+                    end
+      token = hash['token'] ||= 'docu-2053aaad-c1a5-45e2-a2da-f71287f32800'
+      # 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')
+      # Parameter is an array, so we need to iterate through it
+      fields = nil
+      unless hash['fields'].nil?
+        fields = []
+        hash['fields'].each do |structure|
+          fields << (DocumentDetails.from_hash(structure) if structure)
+        end
+      end
+
+      fields = SKIP unless hash.key?('fields')
+      filename = hash.key?('filename') ? hash['filename'] : SKIP
+      mime_type = hash.key?('mimeType') ? hash['mimeType'] : SKIP
+
+      # Clean out expected properties from Hash.
+      additional_properties = hash.reject { |k, _| names.value?(k) }
+
+      # Create object from extracted values.
+      DocumentObject.new(create_date,
+                         token,
+                         links,
+                         fields,
+                         filename,
+                         mime_type,
+                         additional_properties)
+    end
+
+    def to_custom_create_date
+      DateTimeHelper.to_rfc3339(create_date)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} create_date: #{@create_date}, fields: #{@fields}, filename: #{@filename},"\
+      " mime_type: #{@mime_type}, token: #{@token}, 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} create_date: #{@create_date.inspect}, fields: #{@fields.inspect}, filename:"\
+      " #{@filename.inspect}, mime_type: #{@mime_type.inspect}, token: #{@token.inspect}, links:"\
+      " #{@links.inspect}, additional_properties: #{get_additional_properties}>"
+    end
+  end
+end

data/lib/pay_quicker_sdk/models/document_requirements_list_result.rb

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

data/lib/pay_quicker_sdk/models/document_result.rb

@@ -0,0 +1,157 @@
+# pay_quicker_sdk
+#
+# This file was automatically generated for PayQuicker by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+require 'date'
+module PayQuickerSdk
+  # DocumentResult Model.
+  class DocumentResult < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Time object was [created](#/rest/models/structures/created-on)
+    # @return [DateTime]
+    attr_accessor :create_date
+
+    # Time object was [created](#/rest/models/structures/created-on)
+    # @return [Array[DocumentDetails]]
+    attr_accessor :fields
+
+    # The name given to a computer file in order to distinguish it from other
+    # files
+    # @return [String]
+    attr_accessor :filename
+
+    # A label used to identify a type of data.  Acts like a file extension on
+    # the internet.
+    # @return [String]
+    attr_accessor :mime_type
+
+    # [Token](#/rest/models/structures/token) representing the document
+    # @return [String]
+    attr_accessor :token
+
+    # [Token](#/rest/models/structures/token) representing the document
+    # @return [Array[HateoasSelfRef]]
+    attr_accessor :links
+
+    # [Token](#/rest/models/structures/token) representing the document
+    # @return [MetadataItems]
+    attr_accessor :meta
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['create_date'] = 'createDate'
+      @_hash['fields'] = 'fields'
+      @_hash['filename'] = 'filename'
+      @_hash['mime_type'] = 'mimeType'
+      @_hash['token'] = 'token'
+      @_hash['links'] = 'links'
+      @_hash['meta'] = 'meta'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        fields
+        filename
+        mime_type
+        meta
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(create_date = nil,
+                   token = 'docu-2053aaad-c1a5-45e2-a2da-f71287f32800',
+                   links = nil, fields = SKIP, filename = SKIP,
+                   mime_type = SKIP, meta = SKIP, additional_properties = {})
+      # Add additional model properties to the instance.
+      additional_properties.each do |_name, _value|
+        instance_variable_set("@#{_name}", _value)
+      end
+
+      @create_date = create_date
+      @fields = fields unless fields == SKIP
+      @filename = filename unless filename == SKIP
+      @mime_type = mime_type unless mime_type == SKIP
+      @token = token
+      @links = links
+      @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.
+      create_date = if hash.key?('createDate')
+                      (DateTimeHelper.from_rfc3339(hash['createDate']) if hash['createDate'])
+                    end
+      token = hash['token'] ||= 'docu-2053aaad-c1a5-45e2-a2da-f71287f32800'
+      # 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')
+      # Parameter is an array, so we need to iterate through it
+      fields = nil
+      unless hash['fields'].nil?
+        fields = []
+        hash['fields'].each do |structure|
+          fields << (DocumentDetails.from_hash(structure) if structure)
+        end
+      end
+
+      fields = SKIP unless hash.key?('fields')
+      filename = hash.key?('filename') ? hash['filename'] : SKIP
+      mime_type = hash.key?('mimeType') ? hash['mimeType'] : SKIP
+      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.
+      DocumentResult.new(create_date,
+                         token,
+                         links,
+                         fields,
+                         filename,
+                         mime_type,
+                         meta,
+                         additional_properties)
+    end
+
+    def to_custom_create_date
+      DateTimeHelper.to_rfc3339(create_date)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} create_date: #{@create_date}, fields: #{@fields}, filename: #{@filename},"\
+      " mime_type: #{@mime_type}, token: #{@token}, 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} create_date: #{@create_date.inspect}, fields: #{@fields.inspect}, filename:"\
+      " #{@filename.inspect}, mime_type: #{@mime_type.inspect}, token: #{@token.inspect}, links:"\
+      " #{@links.inspect}, meta: #{@meta.inspect}, additional_properties:"\
+      " #{get_additional_properties}>"
+    end
+  end
+end