docspring 4.1.0 → 4.2.0

data/lib/docspring/models/submission_summary.rb

@@ -0,0 +1,601 @@
+=begin
+#DocSpring API
+
+#Use DocSpring's API to programmatically fill out PDF forms, convert HTML to PDFs, merge PDFs, or request legally binding e-signatures.
+
+The version of the OpenAPI document: v2
+
+Generated by: https://openapi-generator.tech
+Generator version: 7.26.0-DOCSPRING
+
+=end
+
+require 'date'
+require 'time'
+
+module DocSpring
+  # A submission in a list: its template, state, test or live, metadata and timestamps, with its data and files when you ask for them. Get a submission by its ID for its signature requests, uploads and page images.
+  class SubmissionSummary < ApiModelBase
+    # The submission's ID.
+    attr_accessor :id
+
+    # Null once the template has been permanently deleted.
+    attr_accessor :template_id
+
+    # The template's type: `pdf` or `html`.
+    attr_accessor :template_type
+
+    # The published version of the template the submission used. Null for the draft.
+    attr_accessor :template_version
+
+    # The ID of the batch the submission was created in.
+    attr_accessor :batch_id
+
+    # `api`: created with the API. `web`: a web form. `reprocess`: a copy of another submission, made to generate its PDF again.
+    attr_accessor :source
+
+    # `pending` until the PDF has been generated, then `processed`. `waiting_for_signature_requests` until every signature request is completed. `insufficient_credits`: waiting for credits; `error_message` says whether the PDF is generated once you add them. `account_suspended`: waiting for the account to be reactivated, for up to 30 days. Waiting ends in `error` if it's discarded or takes over 30 days. Every other state is final, with no PDF: `invalid_data` (the data doesn't match the template's fields: see `data_errors`), `declined` (a signature request was declined), and the states where generating the PDF failed, which have an `error_message`: `syntax_error` (a mistake in an HTML template's Liquid or SCSS), `image_download_failed` or `image_processing_failed` (an image in the data or the template couldn't be downloaded or read) and `error` (anything else). Older submissions can also be `license_revoked` or `accidental`.
+    attr_accessor :state
+
+    # Test PDFs have a watermark and are free. Live PDFs use credits. Submissions made with a test API token are always test submissions.
+    attr_accessor :test
+
+    # `true` keeps the PDF's text and check fields fillable, and `false` flattens every field. Left out, the template decides: its `editable_submissions` setting, or each field's own Editable option. A response shows the template's setting when the request left this out. Can't be `true` with `signature_requests`.
+    attr_accessor :editable
+
+    # The submission's data, with the values entered in completed signature requests. Null unless you pass `include_data=true`. Empty once the submission has expired.
+    attr_accessor :data
+
+    # Why the data doesn't match the template's fields, when `state` is `invalid_data`: the same details as the 422 response that recorded it, with pointers into the request that created the submission (`/data/name`). Cleared once the submission has expired.
+    attr_accessor :data_errors
+
+    # Why the PDF couldn't be generated, when `state` is `error`.
+    attr_accessor :error_message
+
+    # Your own data about the submission, such as an ID from your app. It isn't printed on the PDF. Two keys also change the PDF: `pdf_filename` names its file (`files.pdf.filename`, and its download), and `pdf_title` is its title in the PDF's document properties (and an HTML template's `<title>`, unless its HTML has one). Without `pdf_title`, the title is the template's name. In `pdf_filename`, a `.pdf` ending is removed, each run of characters other than letters, digits, `-`, `_` and `.` becomes one `_`, and the first 128 characters are kept, then `.pdf` is added. Without it, the file is named after the submission's ID (`sub_1234567890abcdef01.pdf`).
+    attr_accessor :metadata
+
+    # Empty unless you pass `include_files=true`: then the generated files, as when you get the submission, without the `png` pages' links (`files.png.pages` is null). Get the submission for its page images.
+    attr_accessor :files
+
+    # An expired submission's data, metadata, password and PDF have been deleted.
+    attr_accessor :expired
+
+    # When the submission expires. Null if it's kept until you delete it.
+    attr_accessor :expires_at
+
+    # When the PDF was generated. Null until then.
+    attr_accessor :processed_at
+
+    # When the submission was created.
+    attr_accessor :created_at
+
+    # When the submission was last updated.
+    attr_accessor :updated_at
+
+    class EnumAttributeValidator
+      attr_reader :datatype
+      attr_reader :allowable_values
+
+      def initialize(datatype, allowable_values)
+        @allowable_values = allowable_values.map do |value|
+          case datatype.to_s
+          when /Integer/i
+            value.to_i
+          when /Float/i
+            value.to_f
+          else
+            value
+          end
+        end
+      end
+
+      def valid?(value)
+        !value || allowable_values.include?(value)
+      end
+    end
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'id' => :'id',
+        :'template_id' => :'template_id',
+        :'template_type' => :'template_type',
+        :'template_version' => :'template_version',
+        :'batch_id' => :'batch_id',
+        :'source' => :'source',
+        :'state' => :'state',
+        :'test' => :'test',
+        :'editable' => :'editable',
+        :'data' => :'data',
+        :'data_errors' => :'data_errors',
+        :'error_message' => :'error_message',
+        :'metadata' => :'metadata',
+        :'files' => :'files',
+        :'expired' => :'expired',
+        :'expires_at' => :'expires_at',
+        :'processed_at' => :'processed_at',
+        :'created_at' => :'created_at',
+        :'updated_at' => :'updated_at'
+      }
+    end
+
+    # Returns attribute mapping this model knows about
+    def self.acceptable_attribute_map
+      attribute_map
+    end
+
+    # Returns all the JSON keys this model knows about
+    def self.acceptable_attributes
+      acceptable_attribute_map.values
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'id' => :'String',
+        :'template_id' => :'String',
+        :'template_type' => :'TemplateType',
+        :'template_version' => :'String',
+        :'batch_id' => :'String',
+        :'source' => :'SubmissionSource',
+        :'state' => :'SubmissionState',
+        :'test' => :'Boolean',
+        :'editable' => :'Boolean',
+        :'data' => :'Hash<String, Object>',
+        :'data_errors' => :'Array<ErrorDetail>',
+        :'error_message' => :'String',
+        :'metadata' => :'Hash<String, Object>',
+        :'files' => :'SubmissionFiles',
+        :'expired' => :'Boolean',
+        :'expires_at' => :'Time',
+        :'processed_at' => :'Time',
+        :'created_at' => :'Time',
+        :'updated_at' => :'Time'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'template_id',
+        :'template_version',
+        :'batch_id',
+        :'data',
+        :'error_message',
+        :'expires_at',
+        :'processed_at',
+      ])
+    end
+
+    # Returns attribute type mapping
+    def self.acceptable_openapi_types
+      openapi_types
+    end
+
+    # Returns the nullable attributes
+    def self.acceptable_openapi_nullable
+      openapi_nullable
+    end
+
+    # Initializes the object
+    # @param [Hash] attributes Model attributes in the form of hash
+    def initialize(attributes = {})
+      if (!attributes.is_a?(Hash))
+        fail ArgumentError, "The input argument (attributes) must be a hash in `DocSpring::SubmissionSummary` initialize method"
+      end
+
+      # check to see if the attribute exists and convert string to symbol for hash key
+      acceptable_attribute_map = self.class.acceptable_attribute_map
+      attributes = attributes.each_with_object({}) { |(k, v), h|
+        if (!acceptable_attribute_map.key?(k.to_sym))
+          fail ArgumentError, "`#{k}` is not a valid attribute in `DocSpring::SubmissionSummary`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
+        end
+        h[k.to_sym] = v
+      }
+
+      if attributes.key?(:'id')
+        self.id = attributes[:'id']
+      else
+        self.id = nil
+      end
+
+      if attributes.key?(:'template_id')
+        self.template_id = attributes[:'template_id']
+      else
+        self.template_id = nil
+      end
+
+      if attributes.key?(:'template_type')
+        self.template_type = attributes[:'template_type']
+      else
+        self.template_type = nil
+      end
+
+      if attributes.key?(:'template_version')
+        self.template_version = attributes[:'template_version']
+      else
+        self.template_version = nil
+      end
+
+      if attributes.key?(:'batch_id')
+        self.batch_id = attributes[:'batch_id']
+      else
+        self.batch_id = nil
+      end
+
+      if attributes.key?(:'source')
+        self.source = attributes[:'source']
+      else
+        self.source = nil
+      end
+
+      if attributes.key?(:'state')
+        self.state = attributes[:'state']
+      else
+        self.state = nil
+      end
+
+      if attributes.key?(:'test')
+        self.test = attributes[:'test']
+      else
+        self.test = nil
+      end
+
+      if attributes.key?(:'editable')
+        self.editable = attributes[:'editable']
+      else
+        self.editable = nil
+      end
+
+      if attributes.key?(:'data')
+        if (value = attributes[:'data']).is_a?(Hash) || value.nil?
+          self.data = value
+        end
+      else
+        self.data = nil
+      end
+
+      if attributes.key?(:'data_errors')
+        if (value = attributes[:'data_errors']).is_a?(Array)
+          self.data_errors = value
+        end
+      else
+        self.data_errors = nil
+      end
+
+      if attributes.key?(:'error_message')
+        self.error_message = attributes[:'error_message']
+      else
+        self.error_message = nil
+      end
+
+      if attributes.key?(:'metadata')
+        if (value = attributes[:'metadata']).is_a?(Hash)
+          self.metadata = value
+        end
+      else
+        self.metadata = nil
+      end
+
+      if attributes.key?(:'files')
+        self.files = attributes[:'files']
+      else
+        self.files = nil
+      end
+
+      if attributes.key?(:'expired')
+        self.expired = attributes[:'expired']
+      else
+        self.expired = nil
+      end
+
+      if attributes.key?(:'expires_at')
+        self.expires_at = attributes[:'expires_at']
+      else
+        self.expires_at = nil
+      end
+
+      if attributes.key?(:'processed_at')
+        self.processed_at = attributes[:'processed_at']
+      else
+        self.processed_at = nil
+      end
+
+      if attributes.key?(:'created_at')
+        self.created_at = attributes[:'created_at']
+      else
+        self.created_at = nil
+      end
+
+      if attributes.key?(:'updated_at')
+        self.updated_at = attributes[:'updated_at']
+      else
+        self.updated_at = nil
+      end
+    end
+
+    # Show invalid properties with the reasons. Usually used together with valid?
+    # @return Array for valid properties with the reasons
+    def list_invalid_properties
+      warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
+      invalid_properties = Array.new
+      if @id.nil?
+        invalid_properties.push('invalid value for "id", id cannot be nil.')
+      end
+
+      if @template_type.nil?
+        invalid_properties.push('invalid value for "template_type", template_type cannot be nil.')
+      end
+
+      if @source.nil?
+        invalid_properties.push('invalid value for "source", source cannot be nil.')
+      end
+
+      if @state.nil?
+        invalid_properties.push('invalid value for "state", state cannot be nil.')
+      end
+
+      if @test.nil?
+        invalid_properties.push('invalid value for "test", test cannot be nil.')
+      end
+
+      if @editable.nil?
+        invalid_properties.push('invalid value for "editable", editable cannot be nil.')
+      end
+
+      if @data_errors.nil?
+        invalid_properties.push('invalid value for "data_errors", data_errors cannot be nil.')
+      end
+
+      if @metadata.nil?
+        invalid_properties.push('invalid value for "metadata", metadata cannot be nil.')
+      end
+
+      if @files.nil?
+        invalid_properties.push('invalid value for "files", files cannot be nil.')
+      end
+
+      if @expired.nil?
+        invalid_properties.push('invalid value for "expired", expired cannot be nil.')
+      end
+
+      if @created_at.nil?
+        invalid_properties.push('invalid value for "created_at", created_at cannot be nil.')
+      end
+
+      if @updated_at.nil?
+        invalid_properties.push('invalid value for "updated_at", updated_at cannot be nil.')
+      end
+
+      invalid_properties
+    end
+
+    # Check to see if the all the properties in the model are valid
+    # @return true if the model is valid
+    def valid?
+      warn '[DEPRECATED] the `valid?` method is obsolete'
+      return false if @id.nil?
+      return false if @template_type.nil?
+      return false if @source.nil?
+      return false if @state.nil?
+      return false if @test.nil?
+      return false if @editable.nil?
+      return false if @data_errors.nil?
+      return false if @metadata.nil?
+      return false if @files.nil?
+      return false if @expired.nil?
+      return false if @created_at.nil?
+      return false if @updated_at.nil?
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] id Value to be assigned
+    def id=(id)
+      if id.nil?
+        fail ArgumentError, 'id cannot be nil'
+      end
+
+      @id = id
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] template_type Value to be assigned
+    def template_type=(template_type)
+      if template_type.nil?
+        fail ArgumentError, 'template_type cannot be nil'
+      end
+
+      @template_type = template_type
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] source Value to be assigned
+    def source=(source)
+      if source.nil?
+        fail ArgumentError, 'source cannot be nil'
+      end
+
+      @source = source
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] state Value to be assigned
+    def state=(state)
+      if state.nil?
+        fail ArgumentError, 'state cannot be nil'
+      end
+
+      @state = state
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] test Value to be assigned
+    def test=(test)
+      if test.nil?
+        fail ArgumentError, 'test cannot be nil'
+      end
+
+      @test = test
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] editable Value to be assigned
+    def editable=(editable)
+      if editable.nil?
+        fail ArgumentError, 'editable cannot be nil'
+      end
+
+      @editable = editable
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] data_errors Value to be assigned
+    def data_errors=(data_errors)
+      if data_errors.nil?
+        fail ArgumentError, 'data_errors cannot be nil'
+      end
+
+      @data_errors = data_errors
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] metadata Value to be assigned
+    def metadata=(metadata)
+      if metadata.nil?
+        fail ArgumentError, 'metadata cannot be nil'
+      end
+
+      @metadata = metadata
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] files Value to be assigned
+    def files=(files)
+      if files.nil?
+        fail ArgumentError, 'files cannot be nil'
+      end
+
+      @files = files
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] expired Value to be assigned
+    def expired=(expired)
+      if expired.nil?
+        fail ArgumentError, 'expired cannot be nil'
+      end
+
+      @expired = expired
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] created_at Value to be assigned
+    def created_at=(created_at)
+      if created_at.nil?
+        fail ArgumentError, 'created_at cannot be nil'
+      end
+
+      @created_at = created_at
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] updated_at Value to be assigned
+    def updated_at=(updated_at)
+      if updated_at.nil?
+        fail ArgumentError, 'updated_at cannot be nil'
+      end
+
+      @updated_at = updated_at
+    end
+
+    # Checks equality by comparing each attribute.
+    # @param [Object] Object to be compared
+    def ==(o)
+      return true if self.equal?(o)
+      self.class == o.class &&
+          id == o.id &&
+          template_id == o.template_id &&
+          template_type == o.template_type &&
+          template_version == o.template_version &&
+          batch_id == o.batch_id &&
+          source == o.source &&
+          state == o.state &&
+          test == o.test &&
+          editable == o.editable &&
+          data == o.data &&
+          data_errors == o.data_errors &&
+          error_message == o.error_message &&
+          metadata == o.metadata &&
+          files == o.files &&
+          expired == o.expired &&
+          expires_at == o.expires_at &&
+          processed_at == o.processed_at &&
+          created_at == o.created_at &&
+          updated_at == o.updated_at
+    end
+
+    # @see the `==` method
+    # @param [Object] Object to be compared
+    def eql?(o)
+      self == o
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Integer] Hash code
+    def hash
+      [id, template_id, template_type, template_version, batch_id, source, state, test, editable, data, data_errors, error_message, metadata, files, expired, expires_at, processed_at, created_at, updated_at].hash
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def self.build_from_hash(attributes)
+      return nil unless attributes.is_a?(Hash)
+      attributes = attributes.transform_keys(&:to_sym)
+      # include attributes inherited from allOf parents (the nearest declaration wins)
+      map = acceptable_attribute_map
+      transformed_hash = {}
+      acceptable_openapi_types.each_pair do |key, type|
+        if attributes.key?(map[key]) && attributes[map[key]].nil?
+          transformed_hash["#{key}"] = nil
+        elsif type =~ /\AArray<(.*)>/i
+          # check to ensure the input is an array given that the attribute
+          # is documented as an array but the input is not
+          if attributes[map[key]].is_a?(Array)
+            transformed_hash["#{key}"] = attributes[map[key]].map { |v| _deserialize($1, v) }
+          end
+        elsif !attributes[map[key]].nil?
+          transformed_hash["#{key}"] = _deserialize(type, attributes[map[key]])
+        end
+      end
+      # Responses can include enum values added after this client was released, so the enum setters
+      # accept any value while the model is built from a response
+      allocate.tap do |model|
+        model.instance_variable_set(:@_skip_enum_validation, true)
+        model.send(:initialize, transformed_hash)
+        model.remove_instance_variable(:@_skip_enum_validation)
+      end
+    end
+
+    # Returns the object in the form of hash
+    # @return [Hash] Returns the object in the form of hash
+    def to_hash
+      hash = {}
+      # include attributes inherited from allOf parents (the nearest declaration wins)
+      self.class.acceptable_attribute_map.each_pair do |attr, param|
+        value = self.send(attr)
+        if value.nil?
+          is_nullable = self.class.acceptable_openapi_nullable.include?(attr)
+          next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
+        end
+
+        hash[param] = _to_hash(value)
+      end
+      hash
+    end
+
+  end
+
+end