docspring 4.0.0 → 4.1.0

data/lib/docspring/models/template_diff.rb

@@ -0,0 +1,321 @@
+=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
+  # What changed in a version of a template since the version before it: the draft since the latest published version, or a published version since the one before it. Fields are compared with all their settings, so `y` is measured from the top of each field's page.
+  class TemplateDiff < ApiModelBase
+    # The template's ID.
+    attr_accessor :template_id
+
+    # The earlier version, such as `1.1.0`. Null when no version was published before `to_version`: it's compared with a new template, so all of its fields are added.
+    attr_accessor :from_version
+
+    # The later version, such as `1.2.0`. Null for the draft.
+    attr_accessor :to_version
+
+    # How many changes of each kind there are.
+    attr_accessor :summary
+
+    # The fields that changed.
+    attr_accessor :fields
+
+    # The names of the template's settings that changed, as they're named on the Template (`name`, `html`, `defaults`, `expire_after`, ...). Values aren't included, and secrets like `encrypt_pdfs_password` are named when they change.
+    attr_accessor :changed_settings
+
+    # The template's PDF was replaced (or added, when there's no `from_version`).
+    attr_accessor :document_changed
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'template_id' => :'template_id',
+        :'from_version' => :'from_version',
+        :'to_version' => :'to_version',
+        :'summary' => :'summary',
+        :'fields' => :'fields',
+        :'changed_settings' => :'changed_settings',
+        :'document_changed' => :'document_changed'
+      }
+    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
+      {
+        :'template_id' => :'String',
+        :'from_version' => :'String',
+        :'to_version' => :'String',
+        :'summary' => :'TemplateDiffSummary',
+        :'fields' => :'TemplateFieldChanges',
+        :'changed_settings' => :'Array<String>',
+        :'document_changed' => :'Boolean'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'from_version',
+        :'to_version',
+      ])
+    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::TemplateDiff` 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::TemplateDiff`. 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?(:'template_id')
+        self.template_id = attributes[:'template_id']
+      else
+        self.template_id = nil
+      end
+
+      if attributes.key?(:'from_version')
+        self.from_version = attributes[:'from_version']
+      else
+        self.from_version = nil
+      end
+
+      if attributes.key?(:'to_version')
+        self.to_version = attributes[:'to_version']
+      else
+        self.to_version = nil
+      end
+
+      if attributes.key?(:'summary')
+        self.summary = attributes[:'summary']
+      else
+        self.summary = nil
+      end
+
+      if attributes.key?(:'fields')
+        self.fields = attributes[:'fields']
+      else
+        self.fields = 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?(:'document_changed')
+        self.document_changed = attributes[:'document_changed']
+      else
+        self.document_changed = 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 @template_id.nil?
+        invalid_properties.push('invalid value for "template_id", template_id cannot be nil.')
+      end
+
+      if @summary.nil?
+        invalid_properties.push('invalid value for "summary", summary cannot be nil.')
+      end
+
+      if @fields.nil?
+        invalid_properties.push('invalid value for "fields", fields cannot be nil.')
+      end
+
+      if @changed_settings.nil?
+        invalid_properties.push('invalid value for "changed_settings", changed_settings cannot be nil.')
+      end
+
+      if @document_changed.nil?
+        invalid_properties.push('invalid value for "document_changed", document_changed 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 @template_id.nil?
+      return false if @summary.nil?
+      return false if @fields.nil?
+      return false if @changed_settings.nil?
+      return false if @document_changed.nil?
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] template_id Value to be assigned
+    def template_id=(template_id)
+      if template_id.nil?
+        fail ArgumentError, 'template_id cannot be nil'
+      end
+
+      @template_id = template_id
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] summary Value to be assigned
+    def summary=(summary)
+      if summary.nil?
+        fail ArgumentError, 'summary cannot be nil'
+      end
+
+      @summary = summary
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] fields Value to be assigned
+    def fields=(fields)
+      if fields.nil?
+        fail ArgumentError, 'fields cannot be nil'
+      end
+
+      @fields = fields
+    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] document_changed Value to be assigned
+    def document_changed=(document_changed)
+      if document_changed.nil?
+        fail ArgumentError, 'document_changed cannot be nil'
+      end
+
+      @document_changed = document_changed
+    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 &&
+          template_id == o.template_id &&
+          from_version == o.from_version &&
+          to_version == o.to_version &&
+          summary == o.summary &&
+          fields == o.fields &&
+          changed_settings == o.changed_settings &&
+          document_changed == o.document_changed
+    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
+      [template_id, from_version, to_version, summary, fields, changed_settings, document_changed].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_diff_summary.rb

@@ -0,0 +1,320 @@
+=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
+  # How many changes of each kind a template diff has.
+  class TemplateDiffSummary < ApiModelBase
+    # How many fields were added.
+    attr_accessor :fields_added
+
+    # How many fields were removed.
+    attr_accessor :fields_removed
+
+    # How many fields have changed settings.
+    attr_accessor :fields_changed
+
+    # How many fields moved in the template's field order.
+    attr_accessor :fields_reordered
+
+    # How many of the template's settings changed.
+    attr_accessor :settings_changed
+
+    # All the changes, counting a new document as one. Zero when the versions are the same.
+    attr_accessor :total_changes
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'fields_added' => :'fields_added',
+        :'fields_removed' => :'fields_removed',
+        :'fields_changed' => :'fields_changed',
+        :'fields_reordered' => :'fields_reordered',
+        :'settings_changed' => :'settings_changed',
+        :'total_changes' => :'total_changes'
+      }
+    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
+      {
+        :'fields_added' => :'Integer',
+        :'fields_removed' => :'Integer',
+        :'fields_changed' => :'Integer',
+        :'fields_reordered' => :'Integer',
+        :'settings_changed' => :'Integer',
+        :'total_changes' => :'Integer'
+      }
+    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::TemplateDiffSummary` 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::TemplateDiffSummary`. 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?(:'fields_added')
+        self.fields_added = attributes[:'fields_added']
+      else
+        self.fields_added = nil
+      end
+
+      if attributes.key?(:'fields_removed')
+        self.fields_removed = attributes[:'fields_removed']
+      else
+        self.fields_removed = nil
+      end
+
+      if attributes.key?(:'fields_changed')
+        self.fields_changed = attributes[:'fields_changed']
+      else
+        self.fields_changed = nil
+      end
+
+      if attributes.key?(:'fields_reordered')
+        self.fields_reordered = attributes[:'fields_reordered']
+      else
+        self.fields_reordered = nil
+      end
+
+      if attributes.key?(:'settings_changed')
+        self.settings_changed = attributes[:'settings_changed']
+      else
+        self.settings_changed = nil
+      end
+
+      if attributes.key?(:'total_changes')
+        self.total_changes = attributes[:'total_changes']
+      else
+        self.total_changes = 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 @fields_added.nil?
+        invalid_properties.push('invalid value for "fields_added", fields_added cannot be nil.')
+      end
+
+      if @fields_removed.nil?
+        invalid_properties.push('invalid value for "fields_removed", fields_removed cannot be nil.')
+      end
+
+      if @fields_changed.nil?
+        invalid_properties.push('invalid value for "fields_changed", fields_changed cannot be nil.')
+      end
+
+      if @fields_reordered.nil?
+        invalid_properties.push('invalid value for "fields_reordered", fields_reordered cannot be nil.')
+      end
+
+      if @settings_changed.nil?
+        invalid_properties.push('invalid value for "settings_changed", settings_changed cannot be nil.')
+      end
+
+      if @total_changes.nil?
+        invalid_properties.push('invalid value for "total_changes", total_changes 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 @fields_added.nil?
+      return false if @fields_removed.nil?
+      return false if @fields_changed.nil?
+      return false if @fields_reordered.nil?
+      return false if @settings_changed.nil?
+      return false if @total_changes.nil?
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] fields_added Value to be assigned
+    def fields_added=(fields_added)
+      if fields_added.nil?
+        fail ArgumentError, 'fields_added cannot be nil'
+      end
+
+      @fields_added = fields_added
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] fields_removed Value to be assigned
+    def fields_removed=(fields_removed)
+      if fields_removed.nil?
+        fail ArgumentError, 'fields_removed cannot be nil'
+      end
+
+      @fields_removed = fields_removed
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] fields_changed Value to be assigned
+    def fields_changed=(fields_changed)
+      if fields_changed.nil?
+        fail ArgumentError, 'fields_changed cannot be nil'
+      end
+
+      @fields_changed = fields_changed
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] fields_reordered Value to be assigned
+    def fields_reordered=(fields_reordered)
+      if fields_reordered.nil?
+        fail ArgumentError, 'fields_reordered cannot be nil'
+      end
+
+      @fields_reordered = fields_reordered
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] settings_changed Value to be assigned
+    def settings_changed=(settings_changed)
+      if settings_changed.nil?
+        fail ArgumentError, 'settings_changed cannot be nil'
+      end
+
+      @settings_changed = settings_changed
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] total_changes Value to be assigned
+    def total_changes=(total_changes)
+      if total_changes.nil?
+        fail ArgumentError, 'total_changes cannot be nil'
+      end
+
+      @total_changes = total_changes
+    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 &&
+          fields_added == o.fields_added &&
+          fields_removed == o.fields_removed &&
+          fields_changed == o.fields_changed &&
+          fields_reordered == o.fields_reordered &&
+          settings_changed == o.settings_changed &&
+          total_changes == o.total_changes
+    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
+      [fields_added, fields_removed, fields_changed, fields_reordered, settings_changed, total_changes].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.rb

@@ -16,16 +16,16 @@ require 'time'
 module DocSpring
   # A PDF template's PDF.
   class TemplateDocument < ApiModelBase
-    # The PDF's file name.
+    # 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.
+    # `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, and how to fix it. Null unless `state` is an error.
+    # 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).

data/lib/docspring/models/template_document_state.rb

@@ -20,9 +20,11 @@ module DocSpring
     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].freeze
+      @all_vars ||= [PENDING, PROCESSED, PASSWORD_REQUIRED, MALFORMED_PDF, UNKNOWN_ERROR, DOWNLOADING, DOWNLOAD_FAILED].freeze
     end
 
     # Builds the enum from string