docspring 1.0.0 → 1.3.1

data/lib/docspring/models/{templatesv2_template_document.rb → upload_template_data_document.rb}

@@ -6,14 +6,14 @@
 OpenAPI spec version: v1
 
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 3.3.0-SNAPSHOT
+OpenAPI Generator version: 3.3.0
 
 =end
 
 require 'date'
 
 module DocSpring
-  class Templatesv2TemplateDocument
+  class UploadTemplateDataDocument
     attr_accessor :metadata
 
     attr_accessor :id
@@ -54,7 +54,7 @@ module DocSpring
     # Attribute type mapping.
     def self.openapi_types
       {
-        :'metadata' => :'Templatesv2TemplateDocumentMetadata',
+        :'metadata' => :'UploadTemplateDataDocumentMetadata',
         :'id' => :'String',
         :'storage' => :'String'
       }

data/lib/docspring/models/{templatesv2_template_document_metadata.rb → upload_template_data_document_metadata.rb}

@@ -6,14 +6,14 @@
 OpenAPI spec version: v1
 
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 3.3.0-SNAPSHOT
+OpenAPI Generator version: 3.3.0
 
 =end
 
 require 'date'
 
 module DocSpring
-  class Templatesv2TemplateDocumentMetadata
+  class UploadTemplateDataDocumentMetadata
     attr_accessor :filename
 
     attr_accessor :size

data/lib/docspring/version.rb

@@ -6,10 +6,10 @@
 OpenAPI spec version: v1
 
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 3.3.0-SNAPSHOT
+OpenAPI Generator version: 3.3.0
 
 =end
 
 module DocSpring
-  VERSION = '1.0.0'
+  VERSION = '1.3.1'
 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_integration_spec.rb

@@ -25,7 +25,7 @@ describe 'PDFApi' do
     end
   end
 
-  let(:api_instance) { DocSpring::PDFApi.new }
+  let(:client) { DocSpring::PDFApi.new }
 
   after do
     # run after each test
@@ -40,7 +40,7 @@ describe 'PDFApi' do
   describe 'batch_generate_pdf v1 test' do
     it 'should work' do
       template_id = 'tpl_000000000000000001'
-      responses = api_instance.batch_generate_pdf_v1(template_id, [
+      responses = client.batch_generate_pdf_v1(template_id, [
         {
           data: {
             title: 'Test PDF',
@@ -67,7 +67,7 @@ describe 'PDFApi' do
   describe 'batch_generate_pdfs v2 test' do
     it 'should work' do
       template_id = 'tpl_000000000000000001'
-      response = api_instance.batch_generate_pdfs(
+      response = client.batch_generate_pdfs(
         metadata: { user_id: 123 },
         test: true,
         submissions: [
@@ -109,7 +109,7 @@ describe 'PDFApi' do
   describe 'get_submission_batch test' do
     it 'should get the batch including submissions' do
       submission_batch_id = 'sbb_000000000000000001'
-      batch = api_instance.get_submission_batch(submission_batch_id, include_submissions: true)
+      batch = client.get_submission_batch(submission_batch_id, include_submissions: true)
       expect(batch.id).to eq 'sbb_000000000000000001'
       expect(batch.total_count).to eq 2
       expect(batch.pending_count).to eq 0
@@ -120,12 +120,43 @@ describe 'PDFApi' do
 
     it 'should get the batch without submissions' do
       submission_batch_id = 'sbb_000000000000000001'
-      batch = api_instance.get_submission_batch(submission_batch_id)
+      batch = client.get_submission_batch(submission_batch_id)
       expect(batch.id).to eq 'sbb_000000000000000001'
       expect(batch.submissions).to be_nil
     end
   end
 
+  it 'should add fields to a template' do
+    template_id = 'tpl_000000000000000001'
+
+    response = client.add_fields_to_template(
+      template_id,
+      fields: [
+        {
+          name: 'new_field1',
+          page: 1,
+          required: false,
+        },
+        {
+          name: 'new_field2',
+          type: 'number',
+          page: 1,
+          required: false,
+        },
+        {
+          name: 'new_field3',
+          type: 'date',
+          page: 1,
+          required: false,
+          x: 300,
+        },
+      ]
+    )
+    expect(response.status).to eq 'success'
+    expect(response.new_field_ids).to eq [3, 4, 5]
+    expect(response.new_field_ids[0].class).to eq Integer
+  end
+
   # integration tests for combine_submissions
   # Merge generated PDFs together
   # @param [Hash] opts the optional parameters
@@ -133,7 +164,7 @@ describe 'PDFApi' do
   # @return [CreateCombinedSubmissionResponse]
   describe 'combine_submissions test' do
     it 'should work' do
-      response = api_instance.combine_submissions(
+      response = client.combine_submissions(
         submission_ids: %w[sub_000000000000000001 sub_000000000000000002])
       expect(response.status).to eq 'success'
       expect(response.combined_submission.id).to start_with 'com_'
@@ -148,7 +179,7 @@ describe 'PDFApi' do
   describe 'create_data_request_token test' do
     it 'should work' do
       data_request_id = 'drq_000000000000000001' # String |
-      response = api_instance.create_data_request_token(data_request_id)
+      response = client.create_data_request_token(data_request_id)
       expect(response.status).to eq 'success'
       expect(response.token.id).to_not be_nil
       expect(response.token.secret).to_not be_nil
@@ -167,7 +198,7 @@ describe 'PDFApi' do
   describe 'expire_combined_submission test' do
     it 'should work' do
       combined_submission_id = 'com_000000000000000001'
-      combined_submission = api_instance.expire_combined_submission(combined_submission_id)
+      combined_submission = client.expire_combined_submission(combined_submission_id)
       expect(combined_submission.expired).to eq true
     end
   end
@@ -179,7 +210,7 @@ describe 'PDFApi' do
   describe 'expire_submission test' do
     it 'should work' do
       submission_id = 'sub_000000000000000001'
-      submission = api_instance.expire_submission(submission_id)
+      submission = client.expire_submission(submission_id)
       expect(submission.expired).to eq true
     end
   end
@@ -192,7 +223,7 @@ describe 'PDFApi' do
   describe 'generate_pdf test' do
     it 'should work' do
       template_id = 'tpl_000000000000000001'
-      response = api_instance.generate_pdf(template_id,
+      response = client.generate_pdf(template_id,
         data: {
           title: 'Test PDF',
           description: 'This PDF is great!',
@@ -213,7 +244,7 @@ describe 'PDFApi' do
   describe 'generate_pdf test with data_requests' do
     it 'should work' do
       template_id = 'tpl_000000000000000001'
-      response = api_instance.generate_pdf(template_id,
+      response = client.generate_pdf(template_id,
         data: {
           title: 'Test PDF',
         },
@@ -254,7 +285,7 @@ describe 'PDFApi' do
   describe 'get_combined_submission test' do
     it 'should work' do
       combined_submission_id = 'com_000000000000000001'
-      combined_submission = api_instance.get_combined_submission(combined_submission_id)
+      combined_submission = client.get_combined_submission(combined_submission_id)
       expect(combined_submission.id).to start_with 'com_'
     end
   end
@@ -266,7 +297,7 @@ describe 'PDFApi' do
   describe 'get_data_request test' do
     it 'should work' do
       data_request_id = 'drq_000000000000000001' # String |
-      data_request = api_instance.get_data_request(data_request_id)
+      data_request = client.get_data_request(data_request_id)
       expect(data_request.id).to start_with 'drq_'
       expect(data_request.order).to eq 1
       expect(data_request.name).to eq 'John Doe'
@@ -287,7 +318,7 @@ describe 'PDFApi' do
   describe 'update_data_request test' do
     it 'should work' do
       data_request_id = 'drq_000000000000000001' # String |
-      response = api_instance.update_data_request(
+      response = client.update_data_request(
         data_request_id,
         name: 'Harry Smith',
         email: 'hsmith@example.com',
@@ -323,7 +354,7 @@ describe 'PDFApi' do
   describe 'get_submission test' do
     it 'should work' do
       submission_id = 'sub_000000000000000001'
-      submission = api_instance.get_submission(submission_id)
+      submission = client.get_submission(submission_id)
       expect(submission.id).to start_with 'sub_'
     end
   end
@@ -340,7 +371,7 @@ describe 'PDFApi' do
         page: 1, # Integer | Default: 1
         per_page: 10 # Integer | Default: 50
       }
-      templates = api_instance.list_templates(opts)
+      templates = client.list_templates(opts)
       expect(templates.size).to eq 1
       expect(templates.first.id).to eq 'tpl_000000000000000002'
     end
@@ -359,7 +390,7 @@ describe 'PDFApi' do
         page: 2, # Integer | Default: 1
         per_page: 1 # Integer | Default: 50
       }
-      result = api_instance.list_templates(opts)
+      result = client.list_templates(opts)
       expect(result).to_not be_nil
     end
   end
@@ -370,7 +401,7 @@ describe 'PDFApi' do
   # @return [AuthenticationSuccessResponse]
   describe 'test_authentication test' do
     it 'should work' do
-      response = api_instance.test_authentication
+      response = client.test_authentication
       expect(response.status).to eq 'success'
     end
   end

data/spec/api/pdf_api_spec_original.skipped.rb

@@ -6,7 +6,7 @@
 OpenAPI spec version: v1
 
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 3.3.0-SNAPSHOT
+OpenAPI Generator version: 3.3.0
 
 =end
 
@@ -38,6 +38,20 @@ describe 'PDFApi' do
     end
   end
 
+  # integration tests for add_fields_to_template
+  # Add new fields to a Template
+  # @param template_id 
+  # @param add_fields_data 
+  # @param [Hash] opts the optional parameters
+  # @return [AddFieldsTemplateResponse]
+  describe 'add_fields_to_template test' do
+    it 'should work' do
+      template_id = 'tpl_000000000000000002' # String | 
+      add_fields_data = DocSpring::AddFieldsData.new # AddFieldsData | 
+      result = api_instance.add_fields_to_template(template_id, add_fields_data)
+      expect(result).to_not be_nil
+    end
+  end
   # integration tests for batch_generate_pdf_v1
   # Generates multiple PDFs
   # @param template_id 
@@ -124,33 +138,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_html_template_data 
+  # @param [Hash] opts the optional parameters
+  # @return [PendingTemplate]
+  describe 'create_html_template test' do
+    it 'should work' do
+      create_html_template_data = DocSpring::CreateHtmlTemplateData.new # CreateHtmlTemplateData | 
+      result = api_instance.create_html_template(create_html_template_data)
+      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 create_template_from_upload_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)
+      create_template_from_upload_data = DocSpring::CreateTemplateFromUploadData.new # CreateTemplateFromUploadData | 
+      result = api_instance.create_pdf_template_from_upload(create_template_from_upload_data)
       expect(result).to_not be_nil
     end
   end
@@ -248,7 +274,7 @@ describe 'PDFApi' do
     it 'should work' do
       submission_id = 'sub_000000000000000001' # String | 
       opts = {
-        include_data: false # BOOLEAN | 
+        include_data: true # BOOLEAN | 
       }
       result = api_instance.get_submission(submission_id, opts)
       expect(result).to_not be_nil
@@ -394,4 +420,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/api_client_spec.rb

@@ -6,7 +6,7 @@
 OpenAPI spec version: v1
 
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 3.3.0-SNAPSHOT
+OpenAPI Generator version: 3.3.0
 
 =end
 

data/spec/configuration_spec.rb

@@ -6,7 +6,7 @@
 OpenAPI spec version: v1
 
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 3.3.0-SNAPSHOT
+OpenAPI Generator version: 3.3.0
 
 =end