docspring 3.0.0 → 3.1.0

data/lib/docspring/models/template_publish_version_response.rb

@@ -0,0 +1,282 @@
+=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 TemplatePublishVersionResponse
+    attr_accessor :status
+
+    attr_accessor :result
+
+    attr_accessor :errors
+
+    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',
+        :'result' => :'result',
+        :'errors' => :'errors'
+      }
+    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',
+        :'result' => :'Object',
+        :'errors' => :'Array<String>'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+      ])
+    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::TemplatePublishVersionResponse` 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::TemplatePublishVersionResponse`. 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?(:'result')
+        self.result = attributes[:'result']
+      else
+        self.result = nil
+      end
+
+      if attributes.key?(:'errors')
+        if (value = attributes[:'errors']).is_a?(Array)
+          self.errors = 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
+
+      if @result.nil?
+        invalid_properties.push('invalid value for "result", result 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)
+      return false if @result.nil?
+      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 &&
+          result == o.result &&
+          errors == o.errors
+    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, result, errors].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/version.rb

@@ -11,5 +11,5 @@ Generator version: 7.11.0
 =end
 
 module DocSpring
-  VERSION = '3.0.0'
+  VERSION = '3.1.0'
 end

data/lib/docspring.rb

@@ -46,7 +46,9 @@ require 'docspring/models/list_submissions_response'
 require 'docspring/models/move_folder_data'
 require 'docspring/models/move_template_data'
 require 'docspring/models/multiple_errors_response'
+require 'docspring/models/publish_version_data'
 require 'docspring/models/rename_folder_data'
+require 'docspring/models/restore_version_data'
 require 'docspring/models/submission'
 require 'docspring/models/submission_action'
 require 'docspring/models/submission_batch'
@@ -61,7 +63,9 @@ require 'docspring/models/success_error_response'
 require 'docspring/models/success_multiple_errors_response'
 require 'docspring/models/template'
 require 'docspring/models/template_add_fields_response'
+require 'docspring/models/template_delete_response'
 require 'docspring/models/template_preview'
+require 'docspring/models/template_publish_version_response'
 require 'docspring/models/update_html_template'
 require 'docspring/models/update_submission_data_request_data'
 require 'docspring/models/upload_presign_response'

data/spec/api/pdf_api_spec.rb

@@ -189,7 +189,8 @@ describe 'PDFApi' do
   # Delete a template
   # @param template_id 
   # @param [Hash] opts the optional parameters
-  # @return [SuccessMultipleErrorsResponse]
+  # @option opts [String] :version 
+  # @return [TemplateDeleteResponse]
   describe 'delete_template test' do
     it 'should work' do
       # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
@@ -278,7 +279,7 @@ describe 'PDFApi' do
   end
 
   # unit tests for get_full_template
-  # Fetch the full template attributes
+  # Fetch the full attributes for a PDF template
   # @param template_id 
   # @param [Hash] opts the optional parameters
   # @return [Template]
@@ -438,6 +439,18 @@ describe 'PDFApi' do
     end
   end
 
+  # unit tests for publish_template_version
+  # Publish a template version
+  # @param template_id 
+  # @param data 
+  # @param [Hash] opts the optional parameters
+  # @return [TemplatePublishVersionResponse]
+  describe 'publish_template_version test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
   # unit tests for rename_folder
   # Rename a folder
   # @param folder_id 
@@ -450,6 +463,18 @@ describe 'PDFApi' do
     end
   end
 
+  # unit tests for restore_template_version
+  # Restore a template version
+  # @param template_id 
+  # @param data 
+  # @param [Hash] opts the optional parameters
+  # @return [SuccessErrorResponse]
+  describe 'restore_template_version test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
   # unit tests for test_authentication
   # Test Authentication
   # @param [Hash] opts the optional parameters

data/spec/models/create_html_submission_data_spec.rb

@@ -81,4 +81,10 @@ describe DocSpring::CreateHtmlSubmissionData do
     end
   end
 
+  describe 'test attribute "version"' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
 end

data/spec/models/create_pdf_submission_data_spec.rb

@@ -75,4 +75,10 @@ describe DocSpring::CreatePdfSubmissionData do
     end
   end
 
+  describe 'test attribute "version"' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
 end

data/spec/models/publish_version_data_spec.rb

@@ -0,0 +1,42 @@
+=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 'spec_helper'
+require 'json'
+require 'date'
+
+# Unit tests for DocSpring::PublishVersionData
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
+# Please update as you see appropriate
+describe DocSpring::PublishVersionData do
+  let(:instance) { DocSpring::PublishVersionData.new }
+
+  describe 'test an instance of PublishVersionData' do
+    it 'should create an instance of PublishVersionData' do
+      # uncomment below to test the instance creation
+      #expect(instance).to be_instance_of(DocSpring::PublishVersionData)
+    end
+  end
+
+  describe 'test attribute "description"' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  describe 'test attribute "version_type"' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+end

data/spec/models/restore_version_data_spec.rb

@@ -0,0 +1,36 @@
+=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 'spec_helper'
+require 'json'
+require 'date'
+
+# Unit tests for DocSpring::RestoreVersionData
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
+# Please update as you see appropriate
+describe DocSpring::RestoreVersionData do
+  let(:instance) { DocSpring::RestoreVersionData.new }
+
+  describe 'test an instance of RestoreVersionData' do
+    it 'should create an instance of RestoreVersionData' do
+      # uncomment below to test the instance creation
+      #expect(instance).to be_instance_of(DocSpring::RestoreVersionData)
+    end
+  end
+
+  describe 'test attribute "version"' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+end

data/spec/models/submission_preview_spec.rb

@@ -103,6 +103,22 @@ describe DocSpring::SubmissionPreview do
     end
   end
 
+  describe 'test attribute "template_type"' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+      # validator = Petstore::EnumTest::EnumAttributeValidator.new('String', ["pdf", "html"])
+      # validator.allowable_values.each do |value|
+      #   expect { instance.template_type = value }.not_to raise_error
+      # end
+    end
+  end
+
+  describe 'test attribute "template_version"' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
   describe 'test attribute "test"' do
     it 'should work' do
       # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/

data/spec/models/submission_spec.rb

@@ -103,6 +103,22 @@ describe DocSpring::Submission do
     end
   end
 
+  describe 'test attribute "template_type"' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+      # validator = Petstore::EnumTest::EnumAttributeValidator.new('String', ["pdf", "html"])
+      # validator.allowable_values.each do |value|
+      #   expect { instance.template_type = value }.not_to raise_error
+      # end
+    end
+  end
+
+  describe 'test attribute "template_version"' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
   describe 'test attribute "test"' do
     it 'should work' do
       # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/

data/spec/models/template_delete_response_spec.rb

@@ -0,0 +1,58 @@
+=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 'spec_helper'
+require 'json'
+require 'date'
+
+# Unit tests for DocSpring::TemplateDeleteResponse
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
+# Please update as you see appropriate
+describe DocSpring::TemplateDeleteResponse do
+  let(:instance) { DocSpring::TemplateDeleteResponse.new }
+
+  describe 'test an instance of TemplateDeleteResponse' do
+    it 'should create an instance of TemplateDeleteResponse' do
+      # uncomment below to test the instance creation
+      #expect(instance).to be_instance_of(DocSpring::TemplateDeleteResponse)
+    end
+  end
+
+  describe 'test attribute "status"' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+      # validator = Petstore::EnumTest::EnumAttributeValidator.new('String', ["success", "error"])
+      # validator.allowable_values.each do |value|
+      #   expect { instance.status = value }.not_to raise_error
+      # end
+    end
+  end
+
+  describe 'test attribute "errors"' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  describe 'test attribute "latest_version"' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  describe 'test attribute "versions"' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+end

data/spec/models/template_preview_spec.rb

@@ -239,6 +239,18 @@ describe DocSpring::TemplatePreview do
     end
   end
 
+  describe 'test attribute "version_published_at"' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  describe 'test attribute "version"' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
   describe 'test attribute "webhook_url"' do
     it 'should work' do
       # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
@@ -251,4 +263,32 @@ describe DocSpring::TemplatePreview do
     end
   end
 
+  describe 'test attribute "latest_version"' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  describe 'test attribute "last_changed_at"' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  describe 'test attribute "last_changed_by_type"' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+      # validator = Petstore::EnumTest::EnumAttributeValidator.new('String', ["user", "api"])
+      # validator.allowable_values.each do |value|
+      #   expect { instance.last_changed_by_type = value }.not_to raise_error
+      # end
+    end
+  end
+
+  describe 'test attribute "last_changed_by_id"' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
 end

data/spec/models/template_publish_version_response_spec.rb

@@ -0,0 +1,52 @@
+=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 'spec_helper'
+require 'json'
+require 'date'
+
+# Unit tests for DocSpring::TemplatePublishVersionResponse
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
+# Please update as you see appropriate
+describe DocSpring::TemplatePublishVersionResponse do
+  let(:instance) { DocSpring::TemplatePublishVersionResponse.new }
+
+  describe 'test an instance of TemplatePublishVersionResponse' do
+    it 'should create an instance of TemplatePublishVersionResponse' do
+      # uncomment below to test the instance creation
+      #expect(instance).to be_instance_of(DocSpring::TemplatePublishVersionResponse)
+    end
+  end
+
+  describe 'test attribute "status"' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+      # validator = Petstore::EnumTest::EnumAttributeValidator.new('String', ["success", "error"])
+      # validator.allowable_values.each do |value|
+      #   expect { instance.status = value }.not_to raise_error
+      # end
+    end
+  end
+
+  describe 'test attribute "result"' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  describe 'test attribute "errors"' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+end