packageruby 1.1.1

data/lib/form3_public_api/models/query_response_status_code_enum.rb

@@ -0,0 +1,32 @@
+# form3_public_api
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Form3PublicApi
+  # QueryResponseStatusCode.
+  class QueryResponseStatusCodeEnum
+    QUERY_RESPONSE_STATUS_CODE_ENUM = [
+      # TODO: Write general description for IPAY
+      IPAY = 'IPAY'.freeze,
+
+      # TODO: Write general description for INFO
+      INFO = 'INFO'.freeze,
+
+      # TODO: Write general description for NINF
+      NINF = 'NINF'.freeze,
+
+      # TODO: Write general description for PDNG
+      PDNG = 'PDNG'.freeze,
+
+      # TODO: Write general description for IDUP
+      IDUP = 'IDUP'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      QUERY_RESPONSE_STATUS_CODE_ENUM.include?(value)
+    end
+  end
+end

data/lib/form3_public_api/models/query_response_submission.rb

@@ -0,0 +1,132 @@
+# form3_public_api
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+require 'date'
+module Form3PublicApi
+  # QueryResponseSubmission Model.
+  class QueryResponseSubmission < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [QueryResponseSubmissionAttributes]
+    attr_accessor :attributes
+
+    # TODO: Write general description for this method
+    # @return [DateTime]
+    attr_accessor :created_on
+
+    # TODO: Write general description for this method
+    # @return [UUID | String]
+    attr_accessor :id
+
+    # TODO: Write general description for this method
+    # @return [DateTime]
+    attr_accessor :modified_on
+
+    # TODO: Write general description for this method
+    # @return [UUID | String]
+    attr_accessor :organisation_id
+
+    # TODO: Write general description for this method
+    # @return [QueryResponseSubmissionRelationships]
+    attr_accessor :relationships
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_reader :type
+
+    # TODO: Write general description for this method
+    # @return [Integer]
+    attr_accessor :version
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['attributes'] = 'attributes'
+      @_hash['created_on'] = 'created_on'
+      @_hash['id'] = 'id'
+      @_hash['modified_on'] = 'modified_on'
+      @_hash['organisation_id'] = 'organisation_id'
+      @_hash['relationships'] = 'relationships'
+      @_hash['type'] = 'type'
+      @_hash['version'] = 'version'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        created_on
+        modified_on
+        relationships
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(attributes = nil,
+                   id = nil,
+                   organisation_id = nil,
+                   version = nil,
+                   created_on = SKIP,
+                   modified_on = SKIP,
+                   relationships = SKIP)
+      @attributes = attributes
+      @created_on = created_on unless created_on == SKIP
+      @id = id
+      @modified_on = modified_on unless modified_on == SKIP
+      @organisation_id = organisation_id
+      @relationships = relationships unless relationships == SKIP
+      @type = 'query_response_submissions'
+      @version = version
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      attributes = QueryResponseSubmissionAttributes.from_hash(hash['attributes']) if
+        hash['attributes']
+      id = hash.key?('id') ? hash['id'] : nil
+      organisation_id =
+        hash.key?('organisation_id') ? hash['organisation_id'] : nil
+      version = hash.key?('version') ? hash['version'] : nil
+      created_on = if hash.key?('created_on')
+                     (DateTimeHelper.from_rfc3339(hash['created_on']) if hash['created_on'])
+                   else
+                     SKIP
+                   end
+      modified_on = if hash.key?('modified_on')
+                      (DateTimeHelper.from_rfc3339(hash['modified_on']) if hash['modified_on'])
+                    else
+                      SKIP
+                    end
+      relationships = QueryResponseSubmissionRelationships.from_hash(hash['relationships']) if
+        hash['relationships']
+
+      # Create object from extracted values.
+      QueryResponseSubmission.new(attributes,
+                                  id,
+                                  organisation_id,
+                                  version,
+                                  created_on,
+                                  modified_on,
+                                  relationships)
+    end
+
+    def to_custom_created_on
+      DateTimeHelper.to_rfc3339(created_on)
+    end
+
+    def to_custom_modified_on
+      DateTimeHelper.to_rfc3339(modified_on)
+    end
+  end
+end

data/lib/form3_public_api/models/query_response_submission_attributes.rb

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

data/lib/form3_public_api/models/query_response_submission_creation.rb

@@ -0,0 +1,48 @@
+# form3_public_api
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Form3PublicApi
+  # QueryResponseSubmissionCreation Model.
+  class QueryResponseSubmissionCreation < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [NewQueryResponseSubmission]
+    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.
+      data = NewQueryResponseSubmission.from_hash(hash['data']) if hash['data']
+
+      # Create object from extracted values.
+      QueryResponseSubmissionCreation.new(data)
+    end
+  end
+end

data/lib/form3_public_api/models/query_response_submission_relationships.rb

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

data/lib/form3_public_api/models/query_response_submission_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
+  # QueryResponseSubmissionResourceType.
+  class QueryResponseSubmissionResourceTypeEnum
+    QUERY_RESPONSE_SUBMISSION_RESOURCE_TYPE_ENUM = [
+      # TODO: Write general description for QUERY_RESPONSE_SUBMISSIONS
+      QUERY_RESPONSE_SUBMISSIONS = 'query_response_submissions'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      QUERY_RESPONSE_SUBMISSION_RESOURCE_TYPE_ENUM.include?(value)
+    end
+  end
+end

data/lib/form3_public_api/models/query_response_submission_response.rb

@@ -0,0 +1,59 @@
+# form3_public_api
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Form3PublicApi
+  # QueryResponseSubmissionResponse Model.
+  class QueryResponseSubmissionResponse < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [QueryResponseSubmission]
+    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 = QueryResponseSubmission.from_hash(hash['data']) if hash['data']
+      links = Links.from_hash(hash['links']) if hash['links']
+
+      # Create object from extracted values.
+      QueryResponseSubmissionResponse.new(data,
+                                          links)
+    end
+  end
+end

data/lib/form3_public_api/models/query_response_submission_status_enum.rb

@@ -0,0 +1,38 @@
+# form3_public_api
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Form3PublicApi
+  # QueryResponseSubmissionStatus.
+  class QueryResponseSubmissionStatusEnum
+    QUERY_RESPONSE_SUBMISSION_STATUS_ENUM = [
+      # TODO: Write general description for ACCEPTED
+      ACCEPTED = 'accepted'.freeze,
+
+      # TODO: Write general description for VALIDATION_PENDING
+      VALIDATION_PENDING = 'validation_pending'.freeze,
+
+      # TODO: Write general description for RELEASED_TO_GATEWAY
+      RELEASED_TO_GATEWAY = 'released_to_gateway'.freeze,
+
+      # TODO: Write general description for QUEUED_FOR_DELIVERY
+      QUEUED_FOR_DELIVERY = 'queued_for_delivery'.freeze,
+
+      # TODO: Write general description for SUBMITTED
+      SUBMITTED = 'submitted'.freeze,
+
+      # TODO: Write general description for DELIVERY_CONFIRMED
+      DELIVERY_CONFIRMED = 'delivery_confirmed'.freeze,
+
+      # TODO: Write general description for DELIVERY_FAILED
+      DELIVERY_FAILED = 'delivery_failed'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      QUERY_RESPONSE_SUBMISSION_STATUS_ENUM.include?(value)
+    end
+  end
+end

data/lib/form3_public_api/models/query_submission.rb

@@ -0,0 +1,131 @@
+# form3_public_api
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+require 'date'
+module Form3PublicApi
+  # QuerySubmission Model.
+  class QuerySubmission < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [QuerySubmissionAttributes]
+    attr_accessor :attributes
+
+    # TODO: Write general description for this method
+    # @return [DateTime]
+    attr_accessor :created_on
+
+    # TODO: Write general description for this method
+    # @return [UUID | String]
+    attr_accessor :id
+
+    # TODO: Write general description for this method
+    # @return [DateTime]
+    attr_accessor :modified_on
+
+    # TODO: Write general description for this method
+    # @return [UUID | String]
+    attr_accessor :organisation_id
+
+    # TODO: Write general description for this method
+    # @return [QuerySubmissionRelationships]
+    attr_accessor :relationships
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_reader :type
+
+    # TODO: Write general description for this method
+    # @return [Integer]
+    attr_accessor :version
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['attributes'] = 'attributes'
+      @_hash['created_on'] = 'created_on'
+      @_hash['id'] = 'id'
+      @_hash['modified_on'] = 'modified_on'
+      @_hash['organisation_id'] = 'organisation_id'
+      @_hash['relationships'] = 'relationships'
+      @_hash['type'] = 'type'
+      @_hash['version'] = 'version'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        created_on
+        modified_on
+        relationships
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(attributes = nil,
+                   id = nil,
+                   organisation_id = nil,
+                   version = nil,
+                   created_on = SKIP,
+                   modified_on = SKIP,
+                   relationships = SKIP)
+      @attributes = attributes
+      @created_on = created_on unless created_on == SKIP
+      @id = id
+      @modified_on = modified_on unless modified_on == SKIP
+      @organisation_id = organisation_id
+      @relationships = relationships unless relationships == SKIP
+      @type = 'query_submissions'
+      @version = version
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      attributes = QuerySubmissionAttributes.from_hash(hash['attributes']) if hash['attributes']
+      id = hash.key?('id') ? hash['id'] : nil
+      organisation_id =
+        hash.key?('organisation_id') ? hash['organisation_id'] : nil
+      version = hash.key?('version') ? hash['version'] : nil
+      created_on = if hash.key?('created_on')
+                     (DateTimeHelper.from_rfc3339(hash['created_on']) if hash['created_on'])
+                   else
+                     SKIP
+                   end
+      modified_on = if hash.key?('modified_on')
+                      (DateTimeHelper.from_rfc3339(hash['modified_on']) if hash['modified_on'])
+                    else
+                      SKIP
+                    end
+      relationships = QuerySubmissionRelationships.from_hash(hash['relationships']) if
+        hash['relationships']
+
+      # Create object from extracted values.
+      QuerySubmission.new(attributes,
+                          id,
+                          organisation_id,
+                          version,
+                          created_on,
+                          modified_on,
+                          relationships)
+    end
+
+    def to_custom_created_on
+      DateTimeHelper.to_rfc3339(created_on)
+    end
+
+    def to_custom_modified_on
+      DateTimeHelper.to_rfc3339(modified_on)
+    end
+  end
+end

data/lib/form3_public_api/models/query_submission_attributes.rb

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

data/lib/form3_public_api/models/query_submission_creation.rb

@@ -0,0 +1,48 @@
+# form3_public_api
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Form3PublicApi
+  # QuerySubmissionCreation Model.
+  class QuerySubmissionCreation < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [NewQuerySubmission]
+    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.
+      data = NewQuerySubmission.from_hash(hash['data']) if hash['data']
+
+      # Create object from extracted values.
+      QuerySubmissionCreation.new(data)
+    end
+  end
+end