docspring 3.5.0 → 4.1.0

data/lib/docspring/models/template_document.rb

@@ -0,0 +1,396 @@
+=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 PDF template's PDF.
+  class TemplateDocument < ApiModelBase
+    # The PDF's file name. Null until a `document_url` has been downloaded.
+    attr_accessor :filename
+
+    # The MD5 hash of the PDF.
+    attr_accessor :md5
+
+    # `pending` while DocSpring processes the PDF, then `processed`. `password_required`, `malformed_pdf` and `unknown_error` mean the PDF couldn't be processed, and `error_message` says why: upload it again or upload another one. `downloading` while DocSpring downloads a `document_url`, then as for an upload. `download_failed` means it couldn't be downloaded, and `error_message` says why. A template keeps its PDF while a new one is downloaded, and when it couldn't be.
+    attr_accessor :state
+
+    # Why the PDF couldn't be processed or downloaded, and how to fix it. Null unless `state` is an error.
+    attr_accessor :error_message
+
+    # Whether the fields are being re-imported from this PDF (`reimport_fields` when the PDF was replaced): `requested` while DocSpring processes the PDF, then `imported`, or `no_fields` when the PDF had no fillable fields and the template kept its fields. `none` when no re-import was asked for, or when it couldn't run (the PDF couldn't be processed, or the template was locked or published while it was).
+    attr_accessor :field_reimport_state
+
+    # 0 until the PDF has been processed.
+    attr_accessor :page_count
+
+    # Each page's width and height in PDF points. Null until the PDF has been processed.
+    attr_accessor :page_dimensions
+
+    # Whether the PDF has fillable form fields. Null until DocSpring has read the PDF.
+    attr_accessor :has_fillable_fields
+
+    # How processing is going on each page, in page order: its image, and its fields when DocSpring sets them up (`detect_fields` when the template was created). `state` becomes `processed` once every page is done. Empty until DocSpring has read the PDF, and for PDFs uploaded before DocSpring recorded page statuses.
+    attr_accessor :page_processing_statuses
+
+    # AI field setup's last step, which reads the whole form once every page is done and can still rename fields and add conditional logic and required fields: `pending` or `processing` until it finishes, then `processed`, `failed` or `skipped`. Null until every page is done, and when there's no logic step to run (`field_logic` is `none`, or the PDF has no fields).
+    attr_accessor :field_logic_status
+
+    # A temporary link to download the PDF.
+    attr_accessor :download_url
+
+    # A link to download the PDF that doesn't expire. Null until the PDF has been processed.
+    attr_accessor :permanent_url
+
+    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
+      {
+        :'filename' => :'filename',
+        :'md5' => :'md5',
+        :'state' => :'state',
+        :'error_message' => :'error_message',
+        :'field_reimport_state' => :'field_reimport_state',
+        :'page_count' => :'page_count',
+        :'page_dimensions' => :'page_dimensions',
+        :'has_fillable_fields' => :'has_fillable_fields',
+        :'page_processing_statuses' => :'page_processing_statuses',
+        :'field_logic_status' => :'field_logic_status',
+        :'download_url' => :'download_url',
+        :'permanent_url' => :'permanent_url'
+      }
+    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
+      {
+        :'filename' => :'String',
+        :'md5' => :'String',
+        :'state' => :'TemplateDocumentState',
+        :'error_message' => :'String',
+        :'field_reimport_state' => :'FieldReimportState',
+        :'page_count' => :'Integer',
+        :'page_dimensions' => :'Array<Array<Float>>',
+        :'has_fillable_fields' => :'Boolean',
+        :'page_processing_statuses' => :'Array<TemplatePageProcessingStatus>',
+        :'field_logic_status' => :'TemplateFieldLogicStatus',
+        :'download_url' => :'String',
+        :'permanent_url' => :'String'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'filename',
+        :'md5',
+        :'error_message',
+        :'page_dimensions',
+        :'has_fillable_fields',
+        :'field_logic_status',
+        :'download_url',
+        :'permanent_url'
+      ])
+    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::TemplateDocument` 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::TemplateDocument`. 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?(:'filename')
+        self.filename = attributes[:'filename']
+      else
+        self.filename = nil
+      end
+
+      if attributes.key?(:'md5')
+        self.md5 = attributes[:'md5']
+      else
+        self.md5 = nil
+      end
+
+      if attributes.key?(:'state')
+        self.state = attributes[:'state']
+      else
+        self.state = nil
+      end
+
+      if attributes.key?(:'error_message')
+        self.error_message = attributes[:'error_message']
+      else
+        self.error_message = nil
+      end
+
+      if attributes.key?(:'field_reimport_state')
+        self.field_reimport_state = attributes[:'field_reimport_state']
+      else
+        self.field_reimport_state = nil
+      end
+
+      if attributes.key?(:'page_count')
+        self.page_count = attributes[:'page_count']
+      else
+        self.page_count = nil
+      end
+
+      if attributes.key?(:'page_dimensions')
+        if (value = attributes[:'page_dimensions']).is_a?(Array) || value.nil?
+          self.page_dimensions = value
+        end
+      else
+        self.page_dimensions = nil
+      end
+
+      if attributes.key?(:'has_fillable_fields')
+        self.has_fillable_fields = attributes[:'has_fillable_fields']
+      else
+        self.has_fillable_fields = nil
+      end
+
+      if attributes.key?(:'page_processing_statuses')
+        if (value = attributes[:'page_processing_statuses']).is_a?(Array)
+          self.page_processing_statuses = value
+        end
+      else
+        self.page_processing_statuses = nil
+      end
+
+      if attributes.key?(:'field_logic_status')
+        self.field_logic_status = attributes[:'field_logic_status']
+      else
+        self.field_logic_status = nil
+      end
+
+      if attributes.key?(:'download_url')
+        self.download_url = attributes[:'download_url']
+      else
+        self.download_url = nil
+      end
+
+      if attributes.key?(:'permanent_url')
+        self.permanent_url = attributes[:'permanent_url']
+      else
+        self.permanent_url = 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 @state.nil?
+        invalid_properties.push('invalid value for "state", state cannot be nil.')
+      end
+
+      if @field_reimport_state.nil?
+        invalid_properties.push('invalid value for "field_reimport_state", field_reimport_state cannot be nil.')
+      end
+
+      if @page_count.nil?
+        invalid_properties.push('invalid value for "page_count", page_count cannot be nil.')
+      end
+
+      if @page_processing_statuses.nil?
+        invalid_properties.push('invalid value for "page_processing_statuses", page_processing_statuses 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 @state.nil?
+      return false if @field_reimport_state.nil?
+      return false if @page_count.nil?
+      return false if @page_processing_statuses.nil?
+      true
+    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] field_reimport_state Value to be assigned
+    def field_reimport_state=(field_reimport_state)
+      if field_reimport_state.nil?
+        fail ArgumentError, 'field_reimport_state cannot be nil'
+      end
+
+      @field_reimport_state = field_reimport_state
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] page_count Value to be assigned
+    def page_count=(page_count)
+      if page_count.nil?
+        fail ArgumentError, 'page_count cannot be nil'
+      end
+
+      @page_count = page_count
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] page_processing_statuses Value to be assigned
+    def page_processing_statuses=(page_processing_statuses)
+      if page_processing_statuses.nil?
+        fail ArgumentError, 'page_processing_statuses cannot be nil'
+      end
+
+      @page_processing_statuses = page_processing_statuses
+    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 &&
+          filename == o.filename &&
+          md5 == o.md5 &&
+          state == o.state &&
+          error_message == o.error_message &&
+          field_reimport_state == o.field_reimport_state &&
+          page_count == o.page_count &&
+          page_dimensions == o.page_dimensions &&
+          has_fillable_fields == o.has_fillable_fields &&
+          page_processing_statuses == o.page_processing_statuses &&
+          field_logic_status == o.field_logic_status &&
+          download_url == o.download_url &&
+          permanent_url == o.permanent_url
+    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
+      [filename, md5, state, error_message, field_reimport_state, page_count, page_dimensions, has_fillable_fields, page_processing_statuses, field_logic_status, download_url, permanent_url].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

data/lib/docspring/models/template_document_state.rb

@@ -0,0 +1,46 @@
+=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
+  class TemplateDocumentState
+    PENDING = "pending".freeze
+    PROCESSED = "processed".freeze
+    PASSWORD_REQUIRED = "password_required".freeze
+    MALFORMED_PDF = "malformed_pdf".freeze
+    UNKNOWN_ERROR = "unknown_error".freeze
+    DOWNLOADING = "downloading".freeze
+    DOWNLOAD_FAILED = "download_failed".freeze
+
+    def self.all_vars
+      @all_vars ||= [PENDING, PROCESSED, PASSWORD_REQUIRED, MALFORMED_PDF, UNKNOWN_ERROR, DOWNLOADING, DOWNLOAD_FAILED].freeze
+    end
+
+    # Builds the enum from string
+    # @param [String] The enum value in the form of the string
+    # @return [String] The enum value
+    def self.build_from_hash(value)
+      new.build_from_hash(value)
+    end
+
+    # Builds the enum from string
+    # @param [String] The enum value in the form of the string
+    # @return [String] The enum value
+    def build_from_hash(value)
+      # Only responses are built from hashes, and a value added to the API after this client was released is kept as it
+      # is: the constants are the values this client knows
+      value
+    end
+  end
+end

data/lib/docspring/models/template_field_change.rb

@@ -0,0 +1,266 @@
+=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 field whose settings changed between two versions of a template.
+  class TemplateFieldChange < ApiModelBase
+    # The field's ID.
+    attr_accessor :id
+
+    # The names of the settings that changed, such as `x` or `required`.
+    attr_accessor :changed_settings
+
+    attr_accessor :old
+
+    attr_accessor :new
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'id' => :'id',
+        :'changed_settings' => :'changed_settings',
+        :'old' => :'old',
+        :'new' => :'new'
+      }
+    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' => :'Integer',
+        :'changed_settings' => :'Array<String>',
+        :'old' => :'Field',
+        :'new' => :'Field'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+      ])
+    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::TemplateFieldChange` 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::TemplateFieldChange`. 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?(:'changed_settings')
+        if (value = attributes[:'changed_settings']).is_a?(Array)
+          self.changed_settings = value
+        end
+      else
+        self.changed_settings = nil
+      end
+
+      if attributes.key?(:'old')
+        self.old = attributes[:'old']
+      else
+        self.old = nil
+      end
+
+      if attributes.key?(:'new')
+        self.new = attributes[:'new']
+      else
+        self.new = 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 @changed_settings.nil?
+        invalid_properties.push('invalid value for "changed_settings", changed_settings cannot be nil.')
+      end
+
+      if @old.nil?
+        invalid_properties.push('invalid value for "old", old cannot be nil.')
+      end
+
+      if @new.nil?
+        invalid_properties.push('invalid value for "new", new 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 @changed_settings.nil?
+      return false if @old.nil?
+      return false if @new.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] changed_settings Value to be assigned
+    def changed_settings=(changed_settings)
+      if changed_settings.nil?
+        fail ArgumentError, 'changed_settings cannot be nil'
+      end
+
+      @changed_settings = changed_settings
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] old Value to be assigned
+    def old=(old)
+      if old.nil?
+        fail ArgumentError, 'old cannot be nil'
+      end
+
+      @old = old
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] new Value to be assigned
+    def new=(new)
+      if new.nil?
+        fail ArgumentError, 'new cannot be nil'
+      end
+
+      @new = new
+    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 &&
+          changed_settings == o.changed_settings &&
+          old == o.old &&
+          new == o.new
+    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, changed_settings, old, new].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