packageruby 1.1.1

data/lib/form3_public_api/models/recall_decision_admission_details_response.rb

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

data/lib/form3_public_api/models/recall_decision_admission_relationships.rb

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

data/lib/form3_public_api/models/recall_decision_admission_status_enum.rb

@@ -0,0 +1,24 @@
+# form3_public_api
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Form3PublicApi
+  # [Status](http://draft-api-docs.form3.tech/api.html#enumerations-payment-admi
+  # ssion-status) of the admission
+  class RecallDecisionAdmissionStatusEnum
+    RECALL_DECISION_ADMISSION_STATUS_ENUM = [
+      # TODO: Write general description for CONFIRMED
+      CONFIRMED = 'confirmed'.freeze,
+
+      # TODO: Write general description for FAILED
+      FAILED = 'failed'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      RECALL_DECISION_ADMISSION_STATUS_ENUM.include?(value)
+    end
+  end
+end

data/lib/form3_public_api/models/recall_decision_answer_enum.rb

@@ -0,0 +1,26 @@
+# form3_public_api
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Form3PublicApi
+  # Answer to the recall request. Can either be `accepted` or `rejected`.
+  class RecallDecisionAnswerEnum
+    RECALL_DECISION_ANSWER_ENUM = [
+      # TODO: Write general description for ACCEPTED
+      ACCEPTED = 'accepted'.freeze,
+
+      # TODO: Write general description for REJECTED
+      REJECTED = 'rejected'.freeze,
+
+      # TODO: Write general description for PENDING
+      PENDING = 'pending'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      RECALL_DECISION_ANSWER_ENUM.include?(value)
+    end
+  end
+end

data/lib/form3_public_api/models/recall_decision_creation.rb

@@ -0,0 +1,50 @@
+# form3_public_api
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Form3PublicApi
+  # RecallDecisionCreation Model.
+  class RecallDecisionCreation < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [RecallDecision]
+    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
+      %w[
+        data
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(data = SKIP)
+      @data = data unless data == 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 = RecallDecision.from_hash(hash['data']) if hash['data']
+
+      # Create object from extracted values.
+      RecallDecisionCreation.new(data)
+    end
+  end
+end

data/lib/form3_public_api/models/recall_decision_creation_response.rb

@@ -0,0 +1,50 @@
+# form3_public_api
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Form3PublicApi
+  # RecallDecisionCreationResponse Model.
+  class RecallDecisionCreationResponse < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [RecallDecision]
+    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
+      %w[
+        data
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(data = SKIP)
+      @data = data unless data == 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 = RecallDecision.from_hash(hash['data']) if hash['data']
+
+      # Create object from extracted values.
+      RecallDecisionCreationResponse.new(data)
+    end
+  end
+end

data/lib/form3_public_api/models/recall_decision_details_response.rb

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

data/lib/form3_public_api/models/recall_decision_submission.rb

@@ -0,0 +1,138 @@
+# form3_public_api
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+require 'date'
+module Form3PublicApi
+  # RecallDecisionSubmission Model.
+  class RecallDecisionSubmission < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [RecallDecisionSubmissionAttributes]
+    attr_accessor :attributes
+
+    # TODO: Write general description for this method
+    # @return [DateTime]
+    attr_accessor :created_on
+
+    # Unique resource ID
+    # @return [UUID | String]
+    attr_accessor :id
+
+    # Unique resource ID
+    # @return [DateTime]
+    attr_accessor :modified_on
+
+    # Unique ID of the organisation this resource is created by
+    # @return [UUID | String]
+    attr_accessor :organisation_id
+
+    # Unique ID of the organisation this resource is created by
+    # @return [RecallDecisionSubmissionRelationships]
+    attr_accessor :relationships
+
+    # Name of the resource type
+    # @return [String]
+    attr_accessor :type
+
+    # Version number
+    # @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[
+        attributes
+        created_on
+        modified_on
+        relationships
+        type
+        version
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(id = nil,
+                   organisation_id = nil,
+                   attributes = SKIP,
+                   created_on = SKIP,
+                   modified_on = SKIP,
+                   relationships = SKIP,
+                   type = SKIP,
+                   version = SKIP)
+      @attributes = attributes unless attributes == SKIP
+      @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 = type unless type == SKIP
+      @version = version unless version == 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.
+      id = hash.key?('id') ? hash['id'] : nil
+      organisation_id =
+        hash.key?('organisation_id') ? hash['organisation_id'] : nil
+      attributes = RecallDecisionSubmissionAttributes.from_hash(hash['attributes']) if
+        hash['attributes']
+      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 = RecallDecisionSubmissionRelationships.from_hash(hash['relationships']) if
+        hash['relationships']
+      type = hash.key?('type') ? hash['type'] : SKIP
+      version = hash.key?('version') ? hash['version'] : SKIP
+
+      # Create object from extracted values.
+      RecallDecisionSubmission.new(id,
+                                   organisation_id,
+                                   attributes,
+                                   created_on,
+                                   modified_on,
+                                   relationships,
+                                   type,
+                                   version)
+    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/recall_decision_submission_attributes.rb

@@ -0,0 +1,91 @@
+# form3_public_api
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+require 'date'
+module Form3PublicApi
+  # RecallDecisionSubmissionAttributes Model.
+  class RecallDecisionSubmissionAttributes < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Indicates if the submission was created automatically by the system
+    # (`true`) or manually (`false`).
+    # @return [TrueClass | FalseClass]
+    attr_accessor :auto
+
+    # [Status](http://draft-api-docs.form3.tech/api.html#enumerations-payment-st
+    # atus-codes-payment-submission-status) of the submission
+    # @return [RecallDecisionSubmissionStatusEnum]
+    attr_accessor :status
+
+    # Reason for submission failure if status is `delivery_failed`
+    # @return [String]
+    attr_accessor :status_reason
+
+    # Date and time of the submission
+    # @return [DateTime]
+    attr_accessor :submission_datetime
+
+    # 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['submission_datetime'] = 'submission_datetime'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        auto
+        status
+        status_reason
+        submission_datetime
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(auto = false,
+                   status = SKIP,
+                   status_reason = SKIP,
+                   submission_datetime = SKIP)
+      @auto = auto unless auto == SKIP
+      @status = status unless status == SKIP
+      @status_reason = status_reason unless status_reason == SKIP
+      @submission_datetime = submission_datetime unless submission_datetime == 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['auto'] ||= false
+      status = hash.key?('status') ? hash['status'] : SKIP
+      status_reason = hash.key?('status_reason') ? hash['status_reason'] : SKIP
+      submission_datetime = if hash.key?('submission_datetime')
+                              (DateTimeHelper.from_rfc3339(hash['submission_datetime']) if hash['submission_datetime'])
+                            else
+                              SKIP
+                            end
+
+      # Create object from extracted values.
+      RecallDecisionSubmissionAttributes.new(auto,
+                                             status,
+                                             status_reason,
+                                             submission_datetime)
+    end
+
+    def to_custom_submission_datetime
+      DateTimeHelper.to_rfc3339(submission_datetime)
+    end
+  end
+end

data/lib/form3_public_api/models/recall_decision_submission_creation.rb

@@ -0,0 +1,50 @@
+# form3_public_api
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Form3PublicApi
+  # RecallDecisionSubmissionCreation Model.
+  class RecallDecisionSubmissionCreation < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [NewRecallDecisionSubmission]
+    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
+      %w[
+        data
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(data = SKIP)
+      @data = data unless data == 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 = NewRecallDecisionSubmission.from_hash(hash['data']) if hash['data']
+
+      # Create object from extracted values.
+      RecallDecisionSubmissionCreation.new(data)
+    end
+  end
+end

data/lib/form3_public_api/models/recall_decision_submission_creation_response.rb

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