docspring 1.0.0 → 1.1.0

data/lib/docspring/version.rb

@@ -11,5 +11,5 @@ OpenAPI Generator version: 3.3.0-SNAPSHOT
 =end
 
 module DocSpring
-  VERSION = '1.0.0'
+  VERSION = '1.1.0'
 end

data/spec/api/client_integration_spec.rb

@@ -6,6 +6,8 @@ describe DocSpring::Client do
     DocSpring.configure do |c|
       c.api_token_id = 'api_token123'
       c.api_token_secret = 'testsecret123'
+    end
+    DocSpring.configure do |c|
       c.host = 'http://api.docspring.local:31337'
     end
   end
@@ -16,20 +18,25 @@ describe DocSpring::Client do
       template_id = 'tpl_000000000000000001'
 
       expect(client).to receive(:sleep).with(1).once
-
       response = client.generate_pdf(
         template_id: template_id,
         data: {
           title: 'Test PDF',
           description: 'This PDF is great!',
+        },
+        field_overrides: {
+          title: {
+            required: false
+          }
         }
       )
+      submission = response.submission
 
       expect(response.status).to eq 'success'
-      submission = response.submission
       expect(submission.id).to start_with 'sub_'
       expect(submission.expired).to eq false
       expect(submission.state).to eq 'processed'
+      expect(submission.pdf_hash).to eq 'TEST_SUBMISSION_SHA256_HASH'
       expect(submission.download_url).to include 'submissions/submission.pdf'
     end
 
@@ -98,6 +105,7 @@ describe DocSpring::Client do
       expect(submission1.id).to start_with 'sub_'
       expect(submission1.expired).to eq false
       expect(submission1.state).to eq 'processed'
+      expect(submission1.pdf_hash).to eq 'TEST_SUBMISSION_SHA256_HASH'
       expect(submission1.download_url).to include 'submissions/submission.pdf'
 
       submission_response2 = response.submissions[1]
@@ -105,6 +113,7 @@ describe DocSpring::Client do
       submission2 = submission_response2.submission
       expect(submission2.id).to start_with 'sub_'
       expect(submission2.expired).to eq false
+      expect(submission2.pdf_hash).to eq 'TEST_SUBMISSION_SHA256_HASH'
       expect(submission2.state).to eq 'processed'
     end
 
@@ -154,6 +163,7 @@ describe DocSpring::Client do
       submission2 = submission_response2.submission
       expect(submission2.id).to start_with 'sub_'
       expect(submission2.expired).to eq false
+      expect(submission2.pdf_hash).to eq nil
       expect(submission2.state).to eq 'invalid_data'
     end
   end
@@ -212,6 +222,7 @@ describe DocSpring::Client do
       )
       expect(combined_submission.download_url).to include(
         'combined_submissions/combined_submission.pdf')
+      expect(combined_submission.pdf_hash).to eq 'TEST_COMBINED_SUBMISSION_SHA256_HASH'
     end
   end
 
@@ -254,6 +265,7 @@ describe DocSpring::Client do
       end
       expect(combined_submission.download_url).to include(
         'combined_submissions/combined_submission.pdf')
+      expect(combined_submission.pdf_hash).to eq 'TEST_COMBINED_SUBMISSION_SHA256_HASH'
     end
   end
 end

data/spec/api/pdf_api_spec_original.skipped.rb

@@ -124,33 +124,45 @@ describe 'PDFApi' do
       expect(result).to_not be_nil
     end
   end
-  # integration tests for create_template
-  # Upload a new PDF template with a file upload
+  # integration tests for create_html_template
+  # Create a new HTML template
+  # @param create_template_data1 
+  # @param [Hash] opts the optional parameters
+  # @return [PendingTemplate]
+  describe 'create_html_template test' do
+    it 'should work' do
+      create_template_data1 = DocSpring::CreateTemplateData1.new # CreateTemplateData1 | 
+      result = api_instance.create_html_template(create_template_data1)
+      expect(result).to_not be_nil
+    end
+  end
+  # integration tests for create_pdf_template
+  # Create a new PDF template with a form POST file upload
   # @param template_document 
   # @param template_name 
   # @param [Hash] opts the optional parameters
   # @option opts [String] :template_parent_folder_id 
   # @return [PendingTemplate]
-  describe 'create_template test' do
+  describe 'create_pdf_template test' do
     it 'should work' do
       template_document = File.new('/path/to/file') # File | 
       template_name = 'template_name_example' # String | 
       opts = {
         template_parent_folder_id: 'template_parent_folder_id_example' # String | 
       }
-      result = api_instance.create_template(template_document, template_name, opts)
+      result = api_instance.create_pdf_template(template_document, template_name, opts)
       expect(result).to_not be_nil
     end
   end
-  # integration tests for create_template_from_upload
+  # integration tests for create_pdf_template_from_upload
   # Create a new PDF template from a cached presign upload
   # @param create_template_data 
   # @param [Hash] opts the optional parameters
   # @return [PendingTemplate]
-  describe 'create_template_from_upload test' do
+  describe 'create_pdf_template_from_upload test' do
     it 'should work' do
       create_template_data = DocSpring::CreateTemplateData.new # CreateTemplateData | 
-      result = api_instance.create_template_from_upload(create_template_data)
+      result = api_instance.create_pdf_template_from_upload(create_template_data)
       expect(result).to_not be_nil
     end
   end
@@ -394,4 +406,18 @@ describe 'PDFApi' do
       expect(result).to_not be_nil
     end
   end
+  # integration tests for update_template
+  # Update a Template
+  # @param template_id 
+  # @param update_template_data 
+  # @param [Hash] opts the optional parameters
+  # @return [UpdateTemplateResponse]
+  describe 'update_template test' do
+    it 'should work' do
+      template_id = 'tpl_000000000000000003' # String | 
+      update_template_data = DocSpring::UpdateTemplateData.new # UpdateTemplateData | 
+      result = api_instance.update_template(template_id, update_template_data)
+      expect(result).to_not be_nil
+    end
+  end
 end

data/spec/models/combined_submission_spec.rb

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

data/spec/models/create_template_data1_spec.rb

@@ -0,0 +1,41 @@
+=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-SNAPSHOT
+
+=end
+
+require 'spec_helper'
+require 'json'
+require 'date'
+
+# Unit tests for DocSpring::CreateTemplateData1
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
+# Please update as you see appropriate
+describe 'CreateTemplateData1' do
+  before do
+    # run before each test
+    @instance = DocSpring::CreateTemplateData1.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of CreateTemplateData1' do
+    it 'should create an instance of CreateTemplateData1' do
+      expect(@instance).to be_instance_of(DocSpring::CreateTemplateData1)
+    end
+  end
+  describe 'test attribute "template"' 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/pending_template_spec.rb

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

data/spec/models/submission_data_request_spec.rb

@@ -146,4 +146,16 @@ describe 'SubmissionDataRequest' do
     end
   end
 
+  describe 'test attribute "ip_address"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  describe 'test attribute "user_agent"' 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_spec.rb

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

data/spec/models/submission_spec.rb

@@ -77,7 +77,7 @@ describe 'Submission' do
   describe 'test attribute "state"' do
     it 'should work' do
       # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
-      # validator = Petstore::EnumTest::EnumAttributeValidator.new('String', ["pending", "processed", "invalid_data", "error", "image_download_failed", "image_processing_failed", "waiting_for_data_requests", "syntax_error", "account_suspended", "license_revoked"])
+      # validator = Petstore::EnumTest::EnumAttributeValidator.new('String', ["pending", "processed", "invalid_data", "error", "image_download_failed", "image_processing_failed", "waiting_for_data_requests", "syntax_error", "account_suspended", "license_revoked", "accidental"])
       # validator.allowable_values.each do |value|
       #   expect { @instance.state = value }.not_to raise_error
       # end
@@ -90,6 +90,12 @@ describe 'Submission' do
     end
   end
 
+  describe 'test attribute "pdf_hash"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
   describe 'test attribute "download_url"' do
     it 'should work' do
       # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers

data/spec/models/template_spec.rb

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

data/spec/models/{templatesv2_template_document_metadata_spec.rb → templatesdesccached_upload_template_document_metadata_spec.rb}

@@ -14,22 +14,22 @@ require 'spec_helper'
 require 'json'
 require 'date'
 
-# Unit tests for DocSpring::Templatesv2TemplateDocumentMetadata
+# Unit tests for DocSpring::TemplatesdesccachedUploadTemplateDocumentMetadata
 # Automatically generated by openapi-generator (https://openapi-generator.tech)
 # Please update as you see appropriate
-describe 'Templatesv2TemplateDocumentMetadata' do
+describe 'TemplatesdesccachedUploadTemplateDocumentMetadata' do
   before do
     # run before each test
-    @instance = DocSpring::Templatesv2TemplateDocumentMetadata.new
+    @instance = DocSpring::TemplatesdesccachedUploadTemplateDocumentMetadata.new
   end
 
   after do
     # run after each test
   end
 
-  describe 'test an instance of Templatesv2TemplateDocumentMetadata' do
-    it 'should create an instance of Templatesv2TemplateDocumentMetadata' do
-      expect(@instance).to be_instance_of(DocSpring::Templatesv2TemplateDocumentMetadata)
+  describe 'test an instance of TemplatesdesccachedUploadTemplateDocumentMetadata' do
+    it 'should create an instance of TemplatesdesccachedUploadTemplateDocumentMetadata' do
+      expect(@instance).to be_instance_of(DocSpring::TemplatesdesccachedUploadTemplateDocumentMetadata)
     end
   end
   describe 'test attribute "filename"' do

data/spec/models/{templatesv2_template_document_spec.rb → templatesdesccached_upload_template_document_spec.rb}

@@ -14,22 +14,22 @@ require 'spec_helper'
 require 'json'
 require 'date'
 
-# Unit tests for DocSpring::Templatesv2TemplateDocument
+# Unit tests for DocSpring::TemplatesdesccachedUploadTemplateDocument
 # Automatically generated by openapi-generator (https://openapi-generator.tech)
 # Please update as you see appropriate
-describe 'Templatesv2TemplateDocument' do
+describe 'TemplatesdesccachedUploadTemplateDocument' do
   before do
     # run before each test
-    @instance = DocSpring::Templatesv2TemplateDocument.new
+    @instance = DocSpring::TemplatesdesccachedUploadTemplateDocument.new
   end
 
   after do
     # run after each test
   end
 
-  describe 'test an instance of Templatesv2TemplateDocument' do
-    it 'should create an instance of Templatesv2TemplateDocument' do
-      expect(@instance).to be_instance_of(DocSpring::Templatesv2TemplateDocument)
+  describe 'test an instance of TemplatesdesccachedUploadTemplateDocument' do
+    it 'should create an instance of TemplatesdesccachedUploadTemplateDocument' do
+      expect(@instance).to be_instance_of(DocSpring::TemplatesdesccachedUploadTemplateDocument)
     end
   end
   describe 'test attribute "metadata"' do

data/spec/models/templatesdesccached_upload_template_spec.rb

@@ -0,0 +1,151 @@
+=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-SNAPSHOT
+
+=end
+
+require 'spec_helper'
+require 'json'
+require 'date'
+
+# Unit tests for DocSpring::TemplatesdesccachedUploadTemplate
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
+# Please update as you see appropriate
+describe 'TemplatesdesccachedUploadTemplate' do
+  before do
+    # run before each test
+    @instance = DocSpring::TemplatesdesccachedUploadTemplate.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of TemplatesdesccachedUploadTemplate' do
+    it 'should create an instance of TemplatesdesccachedUploadTemplate' do
+      expect(@instance).to be_instance_of(DocSpring::TemplatesdesccachedUploadTemplate)
+    end
+  end
+  describe 'test attribute "expiration_interval"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+      # validator = Petstore::EnumTest::EnumAttributeValidator.new('String', ["minutes", "hours", "days"])
+      # validator.allowable_values.each do |value|
+      #   expect { @instance.expiration_interval = value }.not_to raise_error
+      # end
+    end
+  end
+
+  describe 'test attribute "webhook_url"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  describe 'test attribute "scss"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  describe 'test attribute "expire_after"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  describe 'test attribute "allow_additional_properties"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  describe 'test attribute "document"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  describe 'test attribute "description"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  describe 'test attribute "public_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 "slack_webhook_url"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  describe 'test attribute "header_html"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  describe 'test attribute "public_web_form"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  describe 'test attribute "editable_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 "expire_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 "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 "html"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  describe 'test attribute "footer_html"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  describe 'test attribute "template_type"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/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 "redirect_url"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+end