docspring 1.3.0 → 1.4.1

data/lib/docspring/models/template1_defaults.rb

@@ -0,0 +1,201 @@
+=begin
+#API v1
+
+#DocSpring is a service that helps you fill out and sign PDF templates.
+
+OpenAPI spec version: v1
+
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 3.3.0
+
+=end
+
+require 'date'
+
+module DocSpring
+  class Template1Defaults
+    attr_accessor :color
+
+    attr_accessor :font_size
+
+    attr_accessor :typeface
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'color' => :'color',
+        :'font_size' => :'fontSize',
+        :'typeface' => :'typeface'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'color' => :'String',
+        :'font_size' => :'Float',
+        :'typeface' => :'String'
+      }
+    end
+
+    # Initializes the object
+    # @param [Hash] attributes Model attributes in the form of hash
+    def initialize(attributes = {})
+      return unless attributes.is_a?(Hash)
+
+      # convert string to symbol for hash key
+      attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }
+
+      if attributes.has_key?(:'color')
+        self.color = attributes[:'color']
+      end
+
+      if attributes.has_key?(:'fontSize')
+        self.font_size = attributes[:'fontSize']
+      end
+
+      if attributes.has_key?(:'typeface')
+        self.typeface = attributes[:'typeface']
+      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
+      invalid_properties = Array.new
+      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?
+      true
+    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 &&
+          color == o.color &&
+          font_size == o.font_size &&
+          typeface == o.typeface
+    end
+
+    # @see the `==` method
+    # @param [Object] Object to be compared
+    def eql?(o)
+      self == o
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Fixnum] Hash code
+    def hash
+      [color, font_size, typeface].hash
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def build_from_hash(attributes)
+      return nil unless attributes.is_a?(Hash)
+      self.class.openapi_types.each_pair do |key, type|
+        if type =~ /\AArray<(.*)>/i
+          # check to ensure the input is an array given that the the attribute
+          # is documented as an array but the input is not
+          if attributes[self.class.attribute_map[key]].is_a?(Array)
+            self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
+          end
+        elsif !attributes[self.class.attribute_map[key]].nil?
+          self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
+        end # or else data not found in attributes(hash), not an issue as the data can be optional
+      end
+
+      self
+    end
+
+    # Deserializes the data based on type
+    # @param string type Data type
+    # @param string value Value to be deserialized
+    # @return [Object] Deserialized data
+    def _deserialize(type, value)
+      case type.to_sym
+      when :DateTime
+        DateTime.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
+        temp_model = DocSpring.const_get(type).new
+        temp_model.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)
+        next if value.nil?
+        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 @@ OpenAPI Generator version: 3.3.0
 =end
 
 module DocSpring
-  VERSION = '1.3.0'
+  VERSION = '1.4.1'
 end

data/lib/docspring.rb

@@ -25,6 +25,7 @@ require 'docspring/models/combine_pdfs_data'
 require 'docspring/models/combined_submission'
 require 'docspring/models/combined_submission_action'
 require 'docspring/models/combined_submission_data'
+require 'docspring/models/copy_template_data'
 require 'docspring/models/create_combined_submission_response'
 require 'docspring/models/create_custom_file_data'
 require 'docspring/models/create_custom_file_response'
@@ -43,6 +44,7 @@ require 'docspring/models/folder'
 require 'docspring/models/folders_folder'
 require 'docspring/models/html_template_data'
 require 'docspring/models/invalid_request'
+require 'docspring/models/list_submissions_response'
 require 'docspring/models/move_folder_data'
 require 'docspring/models/move_template_data'
 require 'docspring/models/pending_template'
@@ -55,6 +57,8 @@ require 'docspring/models/submission_data'
 require 'docspring/models/submission_data_batch_request'
 require 'docspring/models/submission_data_request'
 require 'docspring/models/template'
+require 'docspring/models/template1'
+require 'docspring/models/template1_defaults'
 require 'docspring/models/template_data'
 require 'docspring/models/templatestemplate_idadd_fields_fields'
 require 'docspring/models/update_data_request_response'

data/spec/api/client_integration_spec.rb

@@ -55,7 +55,7 @@ describe DocSpring::Client do
         )
       }.to raise_error(
         DocSpring::ApiError,
-        'Unprocessable Entity: The root object did not contain a ' \
+        'Unprocessable Entity: Your submission data did not contain a ' \
           "required property of 'description'"
       )
     end

data/spec/api/pdf_api_spec_original.skipped.rb

@@ -102,6 +102,20 @@ describe 'PDFApi' do
       expect(result).to_not be_nil
     end
   end
+  # integration tests for copy_template
+  # Copy a Template
+  # @param template_id 
+  # @param copy_template_data 
+  # @param [Hash] opts the optional parameters
+  # @return [Template]
+  describe 'copy_template test' do
+    it 'should work' do
+      template_id = 'tpl_000000000000000001' # String | 
+      copy_template_data = DocSpring::CopyTemplateData.new # CopyTemplateData | 
+      result = api_instance.copy_template(template_id, copy_template_data)
+      expect(result).to_not be_nil
+    end
+  end
   # integration tests for create_custom_file_from_upload
   # Create a new custom file from a cached presign upload
   # @param create_custom_file_data 
@@ -254,6 +268,18 @@ describe 'PDFApi' do
       expect(result).to_not be_nil
     end
   end
+  # integration tests for get_full_template
+  # Fetch the full template attributes
+  # @param template_id 
+  # @param [Hash] opts the optional parameters
+  # @return [Template1]
+  describe 'get_full_template test' do
+    it 'should work' do
+      template_id = 'tpl_000000000000000001' # String | 
+      result = api_instance.get_full_template(template_id)
+      expect(result).to_not be_nil
+    end
+  end
   # integration tests for get_presign_url
   # Get a presigned URL so that you can upload a file to our AWS S3 bucket
   # @param [Hash] opts the optional parameters
@@ -297,13 +323,13 @@ describe 'PDFApi' do
     end
   end
   # integration tests for get_template
-  # Get a single template
+  # Check the status of an uploaded template
   # @param template_id 
   # @param [Hash] opts the optional parameters
   # @return [Template]
   describe 'get_template test' do
     it 'should work' do
-      template_id = 'tpl_000000000000000011' # String | 
+      template_id = 'tpl_000000000000000001' # String | 
       result = api_instance.get_template(template_id)
       expect(result).to_not be_nil
     end
@@ -334,6 +360,56 @@ describe 'PDFApi' do
       expect(result).to_not be_nil
     end
   end
+  # integration tests for list_submissions
+  # List all submissions
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :cursor 
+  # @option opts [Float] :limit 
+  # @option opts [String] :created_after 
+  # @option opts [String] :created_before 
+  # @option opts [String] :type 
+  # @option opts [BOOLEAN] :include_data 
+  # @return [ListSubmissionsResponse]
+  describe 'list_submissions test' do
+    it 'should work' do
+      opts = {
+        cursor: 'sub_list_000012', # String | 
+        limit: 3, # Float | 
+        created_after: '2019-01-01T09:00:00-05:00', # String | 
+        created_before: '2020-01-01T09:00:00-05:00', # String | 
+        type: 'test', # String | 
+        include_data: true # BOOLEAN | 
+      }
+      result = api_instance.list_submissions(opts)
+      expect(result).to_not be_nil
+    end
+  end
+  # integration tests for list_submissions_0
+  # List all submissions for a given template
+  # @param template_id 
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :cursor 
+  # @option opts [Float] :limit 
+  # @option opts [String] :created_after 
+  # @option opts [String] :created_before 
+  # @option opts [String] :type 
+  # @option opts [BOOLEAN] :include_data 
+  # @return [ListSubmissionsResponse]
+  describe 'list_submissions_0 test' do
+    it 'should work' do
+      template_id = 'tpl_000000000000000002' # String | 
+      opts = {
+        cursor: 'cursor_example', # String | 
+        limit: 3.4, # Float | 
+        created_after: 'created_after_example', # String | 
+        created_before: 'created_before_example', # String | 
+        type: 'type_example', # String | 
+        include_data: true # BOOLEAN | 
+      }
+      result = api_instance.list_submissions_0(template_id, opts)
+      expect(result).to_not be_nil
+    end
+  end
   # integration tests for list_templates
   # Get a list of all templates
   # @param [Hash] opts the optional parameters

data/spec/models/combine_pdfs_data_spec.rb

@@ -50,6 +50,12 @@ describe 'CombinePdfsData' do
     end
   end
 
+  describe 'test attribute "password"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
   describe 'test attribute "source_pdfs"' do
     it 'should work' do
       # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers

data/spec/models/combined_submission_data_spec.rb

@@ -44,6 +44,12 @@ describe 'CombinedSubmissionData' do
     end
   end
 
+  describe 'test attribute "password"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
   describe 'test attribute "submission_ids"' do
     it 'should work' do
       # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers

data/spec/models/combined_submission_spec.rb

@@ -38,6 +38,12 @@ describe 'CombinedSubmission' do
     end
   end
 
+  describe 'test attribute "password"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
   describe 'test attribute "expired"' do
     it 'should work' do
       # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers

data/spec/models/copy_template_data_spec.rb

@@ -0,0 +1,47 @@
+=begin
+#API v1
+
+#DocSpring is a service that helps you fill out and sign PDF templates.
+
+OpenAPI spec version: v1
+
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 3.3.0
+
+=end
+
+require 'spec_helper'
+require 'json'
+require 'date'
+
+# Unit tests for DocSpring::CopyTemplateData
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
+# Please update as you see appropriate
+describe 'CopyTemplateData' do
+  before do
+    # run before each test
+    @instance = DocSpring::CopyTemplateData.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of CopyTemplateData' do
+    it 'should create an instance of CopyTemplateData' do
+      expect(@instance).to be_instance_of(DocSpring::CopyTemplateData)
+    end
+  end
+  describe 'test attribute "name"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  describe 'test attribute "parent_folder_id"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+end

data/spec/models/list_submissions_response_spec.rb

@@ -0,0 +1,53 @@
+=begin
+#API v1
+
+#DocSpring is a service that helps you fill out and sign PDF templates.
+
+OpenAPI spec version: v1
+
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 3.3.0
+
+=end
+
+require 'spec_helper'
+require 'json'
+require 'date'
+
+# Unit tests for DocSpring::ListSubmissionsResponse
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
+# Please update as you see appropriate
+describe 'ListSubmissionsResponse' do
+  before do
+    # run before each test
+    @instance = DocSpring::ListSubmissionsResponse.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of ListSubmissionsResponse' do
+    it 'should create an instance of ListSubmissionsResponse' do
+      expect(@instance).to be_instance_of(DocSpring::ListSubmissionsResponse)
+    end
+  end
+  describe 'test attribute "next_cursor"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  describe 'test attribute "submissions"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  describe 'test attribute "limit"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+end

data/spec/models/submission_data_request_spec.rb

@@ -56,6 +56,12 @@ describe 'SubmissionDataRequest' do
     end
   end
 
+  describe 'test attribute "sort_order"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
   describe 'test attribute "fields"' do
     it 'should work' do
       # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers

data/spec/models/submission_data_spec.rb

@@ -68,6 +68,12 @@ describe 'SubmissionData' do
     end
   end
 
+  describe 'test attribute "password"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
   describe 'test attribute "test"' do
     it 'should work' do
       # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers

data/spec/models/template1_defaults_spec.rb

@@ -0,0 +1,53 @@
+=begin
+#API v1
+
+#DocSpring is a service that helps you fill out and sign PDF templates.
+
+OpenAPI spec version: v1
+
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 3.3.0
+
+=end
+
+require 'spec_helper'
+require 'json'
+require 'date'
+
+# Unit tests for DocSpring::Template1Defaults
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
+# Please update as you see appropriate
+describe 'Template1Defaults' do
+  before do
+    # run before each test
+    @instance = DocSpring::Template1Defaults.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of Template1Defaults' do
+    it 'should create an instance of Template1Defaults' do
+      expect(@instance).to be_instance_of(DocSpring::Template1Defaults)
+    end
+  end
+  describe 'test attribute "color"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  describe 'test attribute "font_size"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  describe 'test attribute "typeface"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+end