docspring 3.0.0 → 3.1.0

data/lib/docspring/models/template.rb

@@ -83,10 +83,22 @@ module DocSpring
 
     attr_accessor :updated_at
 
+    attr_accessor :version_published_at
+
+    attr_accessor :version
+
     attr_accessor :webhook_url
 
     attr_accessor :demo
 
+    attr_accessor :latest_version
+
+    attr_accessor :last_changed_at
+
+    attr_accessor :last_changed_by_type
+
+    attr_accessor :last_changed_by_id
+
     attr_accessor :defaults
 
     attr_accessor :field_order
@@ -107,6 +119,8 @@ module DocSpring
 
     attr_accessor :shared_field_data
 
+    attr_accessor :versions
+
     class EnumAttributeValidator
       attr_reader :datatype
       attr_reader :allowable_values
@@ -166,8 +180,14 @@ module DocSpring
         :'slack_webhook_url' => :'slack_webhook_url',
         :'template_type' => :'template_type',
         :'updated_at' => :'updated_at',
+        :'version_published_at' => :'version_published_at',
+        :'version' => :'version',
         :'webhook_url' => :'webhook_url',
         :'demo' => :'demo',
+        :'latest_version' => :'latest_version',
+        :'last_changed_at' => :'last_changed_at',
+        :'last_changed_by_type' => :'last_changed_by_type',
+        :'last_changed_by_id' => :'last_changed_by_id',
         :'defaults' => :'defaults',
         :'field_order' => :'field_order',
         :'fields' => :'fields',
@@ -177,7 +197,8 @@ module DocSpring
         :'html' => :'html',
         :'predefined_fields' => :'predefined_fields',
         :'scss' => :'scss',
-        :'shared_field_data' => :'shared_field_data'
+        :'shared_field_data' => :'shared_field_data',
+        :'versions' => :'versions'
       }
     end
 
@@ -223,8 +244,14 @@ module DocSpring
         :'slack_webhook_url' => :'String',
         :'template_type' => :'String',
         :'updated_at' => :'String',
+        :'version_published_at' => :'String',
+        :'version' => :'String',
         :'webhook_url' => :'String',
         :'demo' => :'Boolean',
+        :'latest_version' => :'String',
+        :'last_changed_at' => :'String',
+        :'last_changed_by_type' => :'String',
+        :'last_changed_by_id' => :'String',
         :'defaults' => :'Object',
         :'field_order' => :'Array<Array<Float>>',
         :'fields' => :'Object',
@@ -234,7 +261,8 @@ module DocSpring
         :'html' => :'String',
         :'predefined_fields' => :'Array<Object>',
         :'scss' => :'String',
-        :'shared_field_data' => :'Object'
+        :'shared_field_data' => :'Object',
+        :'versions' => :'Array<Object>'
       }
     end
 
@@ -258,7 +286,13 @@ module DocSpring
         :'redirect_url',
         :'slack_webhook_url',
         :'updated_at',
+        :'version_published_at',
+        :'version',
         :'webhook_url',
+        :'latest_version',
+        :'last_changed_at',
+        :'last_changed_by_type',
+        :'last_changed_by_id',
         :'footer_html',
         :'header_html',
         :'html',
@@ -487,6 +521,18 @@ module DocSpring
         self.updated_at = nil
       end
 
+      if attributes.key?(:'version_published_at')
+        self.version_published_at = attributes[:'version_published_at']
+      else
+        self.version_published_at = nil
+      end
+
+      if attributes.key?(:'version')
+        self.version = attributes[:'version']
+      else
+        self.version = nil
+      end
+
       if attributes.key?(:'webhook_url')
         self.webhook_url = attributes[:'webhook_url']
       else
@@ -499,6 +545,30 @@ module DocSpring
         self.demo = nil
       end
 
+      if attributes.key?(:'latest_version')
+        self.latest_version = attributes[:'latest_version']
+      else
+        self.latest_version = nil
+      end
+
+      if attributes.key?(:'last_changed_at')
+        self.last_changed_at = attributes[:'last_changed_at']
+      else
+        self.last_changed_at = nil
+      end
+
+      if attributes.key?(:'last_changed_by_type')
+        self.last_changed_by_type = attributes[:'last_changed_by_type']
+      else
+        self.last_changed_by_type = nil
+      end
+
+      if attributes.key?(:'last_changed_by_id')
+        self.last_changed_by_id = attributes[:'last_changed_by_id']
+      else
+        self.last_changed_by_id = nil
+      end
+
       if attributes.key?(:'defaults')
         self.defaults = attributes[:'defaults']
       else
@@ -562,6 +632,14 @@ module DocSpring
       else
         self.shared_field_data = nil
       end
+
+      if attributes.key?(:'versions')
+        if (value = attributes[:'versions']).is_a?(Array)
+          self.versions = value
+        end
+      else
+        self.versions = nil
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -665,6 +743,10 @@ module DocSpring
         invalid_properties.push('invalid value for "shared_field_data", shared_field_data cannot be nil.')
       end
 
+      if @versions.nil?
+        invalid_properties.push('invalid value for "versions", versions cannot be nil.')
+      end
+
       invalid_properties
     end
 
@@ -694,12 +776,15 @@ module DocSpring
       template_type_validator = EnumAttributeValidator.new('String', ["pdf", "html"])
       return false unless template_type_validator.valid?(@template_type)
       return false if @demo.nil?
+      last_changed_by_type_validator = EnumAttributeValidator.new('String', ["user", "api"])
+      return false unless last_changed_by_type_validator.valid?(@last_changed_by_type)
       return false if @defaults.nil?
       return false if @field_order.nil?
       return false if @fields.nil?
       return false if @html_engine_options.nil?
       return false if @predefined_fields.nil?
       return false if @shared_field_data.nil?
+      return false if @versions.nil?
       true
     end
 
@@ -723,6 +808,16 @@ module DocSpring
       @template_type = template_type
     end
 
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] last_changed_by_type Object to be assigned
+    def last_changed_by_type=(last_changed_by_type)
+      validator = EnumAttributeValidator.new('String', ["user", "api"])
+      unless validator.valid?(last_changed_by_type)
+        fail ArgumentError, "invalid value for \"last_changed_by_type\", must be one of #{validator.allowable_values}."
+      end
+      @last_changed_by_type = last_changed_by_type
+    end
+
     # Checks equality by comparing each attribute.
     # @param [Object] Object to be compared
     def ==(o)
@@ -762,8 +857,14 @@ module DocSpring
           slack_webhook_url == o.slack_webhook_url &&
           template_type == o.template_type &&
           updated_at == o.updated_at &&
+          version_published_at == o.version_published_at &&
+          version == o.version &&
           webhook_url == o.webhook_url &&
           demo == o.demo &&
+          latest_version == o.latest_version &&
+          last_changed_at == o.last_changed_at &&
+          last_changed_by_type == o.last_changed_by_type &&
+          last_changed_by_id == o.last_changed_by_id &&
           defaults == o.defaults &&
           field_order == o.field_order &&
           fields == o.fields &&
@@ -773,7 +874,8 @@ module DocSpring
           html == o.html &&
           predefined_fields == o.predefined_fields &&
           scss == o.scss &&
-          shared_field_data == o.shared_field_data
+          shared_field_data == o.shared_field_data &&
+          versions == o.versions
     end
 
     # @see the `==` method
@@ -785,7 +887,7 @@ module DocSpring
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [add_data_request_submission_id_footers, allow_additional_properties, description, document_filename, document_md5, document_parse_error, document_processed, document_state, document_url, editable_submissions, embed_domains, encrypt_pdfs_password, encrypt_pdfs, expiration_interval, expire_after, expire_submissions, external_predefined_fields_template_id, external_predefined_fields_template_name, first_template, id, locked, merge_audit_trail_pdf, name, page_count, page_dimensions, parent_folder_id, path, permanent_document_url, public_submissions, public_web_form, redirect_url, slack_webhook_url, template_type, updated_at, webhook_url, demo, defaults, field_order, fields, footer_html, header_html, html_engine_options, html, predefined_fields, scss, shared_field_data].hash
+      [add_data_request_submission_id_footers, allow_additional_properties, description, document_filename, document_md5, document_parse_error, document_processed, document_state, document_url, editable_submissions, embed_domains, encrypt_pdfs_password, encrypt_pdfs, expiration_interval, expire_after, expire_submissions, external_predefined_fields_template_id, external_predefined_fields_template_name, first_template, id, locked, merge_audit_trail_pdf, name, page_count, page_dimensions, parent_folder_id, path, permanent_document_url, public_submissions, public_web_form, redirect_url, slack_webhook_url, template_type, updated_at, version_published_at, version, webhook_url, demo, latest_version, last_changed_at, last_changed_by_type, last_changed_by_id, defaults, field_order, fields, footer_html, header_html, html_engine_options, html, predefined_fields, scss, shared_field_data, versions].hash
     end
 
     # Builds the object from hash

data/lib/docspring/models/template_delete_response.rb

@@ -0,0 +1,287 @@
+=begin
+#DocSpring API
+
+#DocSpring provides an API that helps you fill out and sign PDF templates.
+
+The version of the OpenAPI document: v1
+
+Generated by: https://openapi-generator.tech
+Generator version: 7.11.0
+
+=end
+
+require 'date'
+require 'time'
+
+module DocSpring
+  class TemplateDeleteResponse
+    attr_accessor :status
+
+    attr_accessor :errors
+
+    attr_accessor :latest_version
+
+    attr_accessor :versions
+
+    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
+      {
+        :'status' => :'status',
+        :'errors' => :'errors',
+        :'latest_version' => :'latest_version',
+        :'versions' => :'versions'
+      }
+    end
+
+    # Returns all the JSON keys this model knows about
+    def self.acceptable_attributes
+      attribute_map.values
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'status' => :'String',
+        :'errors' => :'Array<String>',
+        :'latest_version' => :'String',
+        :'versions' => :'Array<Object>'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'latest_version',
+      ])
+    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::TemplateDeleteResponse` initialize method"
+      end
+
+      # check to see if the attribute exists and convert string to symbol for hash key
+      attributes = attributes.each_with_object({}) { |(k, v), h|
+        if (!self.class.attribute_map.key?(k.to_sym))
+          fail ArgumentError, "`#{k}` is not a valid attribute in `DocSpring::TemplateDeleteResponse`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
+        end
+        h[k.to_sym] = v
+      }
+
+      if attributes.key?(:'status')
+        self.status = attributes[:'status']
+      else
+        self.status = nil
+      end
+
+      if attributes.key?(:'errors')
+        if (value = attributes[:'errors']).is_a?(Array)
+          self.errors = value
+        end
+      end
+
+      if attributes.key?(:'latest_version')
+        self.latest_version = attributes[:'latest_version']
+      end
+
+      if attributes.key?(:'versions')
+        if (value = attributes[:'versions']).is_a?(Array)
+          self.versions = value
+        end
+      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 @status.nil?
+        invalid_properties.push('invalid value for "status", status 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 @status.nil?
+      status_validator = EnumAttributeValidator.new('String', ["success", "error"])
+      return false unless status_validator.valid?(@status)
+      true
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] status Object to be assigned
+    def status=(status)
+      validator = EnumAttributeValidator.new('String', ["success", "error"])
+      unless validator.valid?(status)
+        fail ArgumentError, "invalid value for \"status\", must be one of #{validator.allowable_values}."
+      end
+      @status = status
+    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 &&
+          status == o.status &&
+          errors == o.errors &&
+          latest_version == o.latest_version &&
+          versions == o.versions
+    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
+      [status, errors, latest_version, versions].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)
+      transformed_hash = {}
+      openapi_types.each_pair do |key, type|
+        if attributes.key?(attribute_map[key]) && attributes[attribute_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[attribute_map[key]].is_a?(Array)
+            transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
+          end
+        elsif !attributes[attribute_map[key]].nil?
+          transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
+        end
+      end
+      new(transformed_hash)
+    end
+
+    # Deserializes the data based on type
+    # @param string type Data type
+    # @param string value Value to be deserialized
+    # @return [Object] Deserialized data
+    def self._deserialize(type, value)
+      case type.to_sym
+      when :Time
+        Time.parse(value)
+      when :Date
+        Date.parse(value)
+      when :String
+        value.to_s
+      when :Integer
+        value.to_i
+      when :Float
+        value.to_f
+      when :Boolean
+        if value.to_s =~ /\A(true|t|yes|y|1)\z/i
+          true
+        else
+          false
+        end
+      when :Object
+        # generic object (usually a Hash), return directly
+        value
+      when /\AArray<(?<inner_type>.+)>\z/
+        inner_type = Regexp.last_match[:inner_type]
+        value.map { |v| _deserialize(inner_type, v) }
+      when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
+        k_type = Regexp.last_match[:k_type]
+        v_type = Regexp.last_match[:v_type]
+        {}.tap do |hash|
+          value.each do |k, v|
+            hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
+          end
+        end
+      else # model
+        # models (e.g. Pet) or oneOf
+        klass = DocSpring.const_get(type)
+        klass.respond_to?(:openapi_any_of) || klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
+      end
+    end
+
+    # Returns the string representation of the object
+    # @return [String] String presentation of the object
+    def to_s
+      to_hash.to_s
+    end
+
+    # to_body is an alias to to_hash (backward compatibility)
+    # @return [Hash] Returns the object in the form of hash
+    def to_body
+      to_hash
+    end
+
+    # Returns the object in the form of hash
+    # @return [Hash] Returns the object in the form of hash
+    def to_hash
+      hash = {}
+      self.class.attribute_map.each_pair do |attr, param|
+        value = self.send(attr)
+        if value.nil?
+          is_nullable = self.class.openapi_nullable.include?(attr)
+          next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
+        end
+
+        hash[param] = _to_hash(value)
+      end
+      hash
+    end
+
+    # Outputs non-array value in the form of hash
+    # For object, use to_hash. Otherwise, just return the value
+    # @param [Object] value Any valid value
+    # @return [Hash] Returns the value in the form of hash
+    def _to_hash(value)
+      if value.is_a?(Array)
+        value.compact.map { |v| _to_hash(v) }
+      elsif value.is_a?(Hash)
+        {}.tap do |hash|
+          value.each { |k, v| hash[k] = _to_hash(v) }
+        end
+      elsif value.respond_to? :to_hash
+        value.to_hash
+      else
+        value
+      end
+    end
+
+  end
+
+end

data/lib/docspring/models/template_preview.rb

@@ -83,10 +83,22 @@ module DocSpring
 
     attr_accessor :updated_at
 
+    attr_accessor :version_published_at
+
+    attr_accessor :version
+
     attr_accessor :webhook_url
 
     attr_accessor :demo
 
+    attr_accessor :latest_version
+
+    attr_accessor :last_changed_at
+
+    attr_accessor :last_changed_by_type
+
+    attr_accessor :last_changed_by_id
+
     class EnumAttributeValidator
       attr_reader :datatype
       attr_reader :allowable_values
@@ -146,8 +158,14 @@ module DocSpring
         :'slack_webhook_url' => :'slack_webhook_url',
         :'template_type' => :'template_type',
         :'updated_at' => :'updated_at',
+        :'version_published_at' => :'version_published_at',
+        :'version' => :'version',
         :'webhook_url' => :'webhook_url',
-        :'demo' => :'demo'
+        :'demo' => :'demo',
+        :'latest_version' => :'latest_version',
+        :'last_changed_at' => :'last_changed_at',
+        :'last_changed_by_type' => :'last_changed_by_type',
+        :'last_changed_by_id' => :'last_changed_by_id'
       }
     end
 
@@ -193,8 +211,14 @@ module DocSpring
         :'slack_webhook_url' => :'String',
         :'template_type' => :'String',
         :'updated_at' => :'String',
+        :'version_published_at' => :'String',
+        :'version' => :'String',
         :'webhook_url' => :'String',
-        :'demo' => :'Boolean'
+        :'demo' => :'Boolean',
+        :'latest_version' => :'String',
+        :'last_changed_at' => :'String',
+        :'last_changed_by_type' => :'String',
+        :'last_changed_by_id' => :'String'
       }
     end
 
@@ -218,7 +242,13 @@ module DocSpring
         :'redirect_url',
         :'slack_webhook_url',
         :'updated_at',
+        :'version_published_at',
+        :'version',
         :'webhook_url',
+        :'latest_version',
+        :'last_changed_at',
+        :'last_changed_by_type',
+        :'last_changed_by_id'
       ])
     end
 
@@ -443,6 +473,18 @@ module DocSpring
         self.updated_at = nil
       end
 
+      if attributes.key?(:'version_published_at')
+        self.version_published_at = attributes[:'version_published_at']
+      else
+        self.version_published_at = nil
+      end
+
+      if attributes.key?(:'version')
+        self.version = attributes[:'version']
+      else
+        self.version = nil
+      end
+
       if attributes.key?(:'webhook_url')
         self.webhook_url = attributes[:'webhook_url']
       else
@@ -454,6 +496,30 @@ module DocSpring
       else
         self.demo = nil
       end
+
+      if attributes.key?(:'latest_version')
+        self.latest_version = attributes[:'latest_version']
+      else
+        self.latest_version = nil
+      end
+
+      if attributes.key?(:'last_changed_at')
+        self.last_changed_at = attributes[:'last_changed_at']
+      else
+        self.last_changed_at = nil
+      end
+
+      if attributes.key?(:'last_changed_by_type')
+        self.last_changed_by_type = attributes[:'last_changed_by_type']
+      else
+        self.last_changed_by_type = nil
+      end
+
+      if attributes.key?(:'last_changed_by_id')
+        self.last_changed_by_id = attributes[:'last_changed_by_id']
+      else
+        self.last_changed_by_id = nil
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -562,6 +628,8 @@ module DocSpring
       template_type_validator = EnumAttributeValidator.new('String', ["pdf", "html"])
       return false unless template_type_validator.valid?(@template_type)
       return false if @demo.nil?
+      last_changed_by_type_validator = EnumAttributeValidator.new('String', ["user", "api"])
+      return false unless last_changed_by_type_validator.valid?(@last_changed_by_type)
       true
     end
 
@@ -585,6 +653,16 @@ module DocSpring
       @template_type = template_type
     end
 
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] last_changed_by_type Object to be assigned
+    def last_changed_by_type=(last_changed_by_type)
+      validator = EnumAttributeValidator.new('String', ["user", "api"])
+      unless validator.valid?(last_changed_by_type)
+        fail ArgumentError, "invalid value for \"last_changed_by_type\", must be one of #{validator.allowable_values}."
+      end
+      @last_changed_by_type = last_changed_by_type
+    end
+
     # Checks equality by comparing each attribute.
     # @param [Object] Object to be compared
     def ==(o)
@@ -624,8 +702,14 @@ module DocSpring
           slack_webhook_url == o.slack_webhook_url &&
           template_type == o.template_type &&
           updated_at == o.updated_at &&
+          version_published_at == o.version_published_at &&
+          version == o.version &&
           webhook_url == o.webhook_url &&
-          demo == o.demo
+          demo == o.demo &&
+          latest_version == o.latest_version &&
+          last_changed_at == o.last_changed_at &&
+          last_changed_by_type == o.last_changed_by_type &&
+          last_changed_by_id == o.last_changed_by_id
     end
 
     # @see the `==` method
@@ -637,7 +721,7 @@ module DocSpring
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [add_data_request_submission_id_footers, allow_additional_properties, description, document_filename, document_md5, document_parse_error, document_processed, document_state, document_url, editable_submissions, embed_domains, encrypt_pdfs_password, encrypt_pdfs, expiration_interval, expire_after, expire_submissions, external_predefined_fields_template_id, external_predefined_fields_template_name, first_template, id, locked, merge_audit_trail_pdf, name, page_count, page_dimensions, parent_folder_id, path, permanent_document_url, public_submissions, public_web_form, redirect_url, slack_webhook_url, template_type, updated_at, webhook_url, demo].hash
+      [add_data_request_submission_id_footers, allow_additional_properties, description, document_filename, document_md5, document_parse_error, document_processed, document_state, document_url, editable_submissions, embed_domains, encrypt_pdfs_password, encrypt_pdfs, expiration_interval, expire_after, expire_submissions, external_predefined_fields_template_id, external_predefined_fields_template_name, first_template, id, locked, merge_audit_trail_pdf, name, page_count, page_dimensions, parent_folder_id, path, permanent_document_url, public_submissions, public_web_form, redirect_url, slack_webhook_url, template_type, updated_at, version_published_at, version, webhook_url, demo, latest_version, last_changed_at, last_changed_by_type, last_changed_by_id].hash
     end
 
     # Builds the object from hash