docspring 4.0.0 → 4.1.0

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

data/lib/docspring/models/template_field_changes.rb

@@ -0,0 +1,274 @@
+=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
+  # The fields that changed between two versions of a template.
+  class TemplateFieldChanges < ApiModelBase
+    # The fields that `to_version` has and `from_version` doesn't.
+    attr_accessor :added
+
+    # The fields that `from_version` has and `to_version` doesn't, as they were.
+    attr_accessor :removed
+
+    # The fields with changed settings.
+    attr_accessor :changed
+
+    # The fields that moved in the template's field order (the order of its fields across all its pages, as the fields endpoint lists them): fields that swapped places, or the field that moved the furthest. The fields that a move pushed along aren't listed.
+    attr_accessor :reordered
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'added' => :'added',
+        :'removed' => :'removed',
+        :'changed' => :'changed',
+        :'reordered' => :'reordered'
+      }
+    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
+      {
+        :'added' => :'Array<Field>',
+        :'removed' => :'Array<Field>',
+        :'changed' => :'Array<TemplateFieldChange>',
+        :'reordered' => :'Array<TemplateFieldMove>'
+      }
+    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::TemplateFieldChanges` 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::TemplateFieldChanges`. 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?(:'added')
+        if (value = attributes[:'added']).is_a?(Array)
+          self.added = value
+        end
+      else
+        self.added = nil
+      end
+
+      if attributes.key?(:'removed')
+        if (value = attributes[:'removed']).is_a?(Array)
+          self.removed = value
+        end
+      else
+        self.removed = nil
+      end
+
+      if attributes.key?(:'changed')
+        if (value = attributes[:'changed']).is_a?(Array)
+          self.changed = value
+        end
+      else
+        self.changed = nil
+      end
+
+      if attributes.key?(:'reordered')
+        if (value = attributes[:'reordered']).is_a?(Array)
+          self.reordered = value
+        end
+      else
+        self.reordered = 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 @added.nil?
+        invalid_properties.push('invalid value for "added", added cannot be nil.')
+      end
+
+      if @removed.nil?
+        invalid_properties.push('invalid value for "removed", removed cannot be nil.')
+      end
+
+      if @changed.nil?
+        invalid_properties.push('invalid value for "changed", changed cannot be nil.')
+      end
+
+      if @reordered.nil?
+        invalid_properties.push('invalid value for "reordered", reordered 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 @added.nil?
+      return false if @removed.nil?
+      return false if @changed.nil?
+      return false if @reordered.nil?
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] added Value to be assigned
+    def added=(added)
+      if added.nil?
+        fail ArgumentError, 'added cannot be nil'
+      end
+
+      @added = added
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] removed Value to be assigned
+    def removed=(removed)
+      if removed.nil?
+        fail ArgumentError, 'removed cannot be nil'
+      end
+
+      @removed = removed
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] changed Value to be assigned
+    def changed=(changed)
+      if changed.nil?
+        fail ArgumentError, 'changed cannot be nil'
+      end
+
+      @changed = changed
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] reordered Value to be assigned
+    def reordered=(reordered)
+      if reordered.nil?
+        fail ArgumentError, 'reordered cannot be nil'
+      end
+
+      @reordered = reordered
+    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 &&
+          added == o.added &&
+          removed == o.removed &&
+          changed == o.changed &&
+          reordered == o.reordered
+    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
+      [added, removed, changed, reordered].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_field_dependency.rb

@@ -16,7 +16,7 @@ require 'time'
 module DocSpring
   # A conditional logic rule: when other fields' values meet its conditions, it shows its target fields, makes them required, or both.
   class TemplateFieldDependency < ApiModelBase
-    # What the rule does to its targets when its conditions are met.
+    # What the rule does to the fields it applies to when its conditions are met.
     attr_accessor :action
 
     # Whether all of the conditions (the default) or any of them must be met.

data/lib/docspring/models/template_field_dependency_input.rb

@@ -16,7 +16,7 @@ require 'time'
 module DocSpring
   # A conditional logic rule: when other fields' values meet its conditions, it shows its target fields, makes them required, or both.
   class TemplateFieldDependencyInput < ApiModelBase
-    # What the rule does to its targets when its conditions are met.
+    # What the rule does to the fields it applies to when its conditions are met.
     attr_accessor :action
 
     # Whether all of the conditions (the default) or any of them must be met.