docspring 1.1.0 → 1.2.0

data/lib/docspring/models/update_template_data.rb

@@ -26,7 +26,7 @@ module DocSpring
     # Attribute type mapping.
     def self.openapi_types
       {
-        :'template' => :'TemplatestemplateIdTemplate'
+        :'template' => :'TemplateData'
       }
     end
 

data/lib/docspring/models/{templatesdesccached_upload_template.rb → upload_template_data.rb}

@@ -13,7 +13,7 @@ OpenAPI Generator version: 3.3.0-SNAPSHOT
 require 'date'
 
 module DocSpring
-  class TemplatesdesccachedUploadTemplate
+  class UploadTemplateData
     attr_accessor :expiration_interval
 
     attr_accessor :webhook_url
@@ -104,7 +104,7 @@ module DocSpring
         :'scss' => :'String',
         :'expire_after' => :'Float',
         :'allow_additional_properties' => :'BOOLEAN',
-        :'document' => :'TemplatesdesccachedUploadTemplateDocument',
+        :'document' => :'UploadTemplateDataDocument',
         :'description' => :'String',
         :'public_submissions' => :'BOOLEAN',
         :'slack_webhook_url' => :'String',

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

@@ -13,7 +13,7 @@ OpenAPI Generator version: 3.3.0-SNAPSHOT
 require 'date'
 
 module DocSpring
-  class TemplatesdesccachedUploadTemplateDocument
+  class UploadTemplateDataDocument
     attr_accessor :metadata
 
     attr_accessor :id
@@ -54,7 +54,7 @@ module DocSpring
     # Attribute type mapping.
     def self.openapi_types
       {
-        :'metadata' => :'TemplatesdesccachedUploadTemplateDocumentMetadata',
+        :'metadata' => :'UploadTemplateDataDocumentMetadata',
         :'id' => :'String',
         :'storage' => :'String'
       }

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

@@ -13,7 +13,7 @@ OpenAPI Generator version: 3.3.0-SNAPSHOT
 require 'date'
 
 module DocSpring
-  class TemplatesdesccachedUploadTemplateDocumentMetadata
+  class UploadTemplateDataDocumentMetadata
     attr_accessor :filename
 
     attr_accessor :size

data/lib/docspring/version.rb

@@ -11,5 +11,5 @@ OpenAPI Generator version: 3.3.0-SNAPSHOT
 =end
 
 module DocSpring
-  VERSION = '1.1.0'
+  VERSION = '1.2.0'
 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

@@ -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 
@@ -126,13 +140,13 @@ describe 'PDFApi' do
   end
   # integration tests for create_html_template
   # Create a new HTML template
-  # @param create_template_data1 
+  # @param create_html_template_data 
   # @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)
+      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
@@ -156,13 +170,13 @@ describe 'PDFApi' do
   end
   # 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_pdf_template_from_upload test' do
     it 'should work' do
-      create_template_data = DocSpring::CreateTemplateData.new # CreateTemplateData | 
-      result = api_instance.create_pdf_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

data/spec/models/add_fields_data_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::AddFieldsData
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
+# Please update as you see appropriate
+describe 'AddFieldsData' do
+  before do
+    # run before each test
+    @instance = DocSpring::AddFieldsData.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of AddFieldsData' do
+    it 'should create an instance of AddFieldsData' do
+      expect(@instance).to be_instance_of(DocSpring::AddFieldsData)
+    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
+    end
+  end
+
+end

data/spec/models/add_fields_template_response_spec.rb

@@ -0,0 +1,57 @@
+=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::AddFieldsTemplateResponse
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
+# Please update as you see appropriate
+describe 'AddFieldsTemplateResponse' do
+  before do
+    # run before each test
+    @instance = DocSpring::AddFieldsTemplateResponse.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of AddFieldsTemplateResponse' do
+    it 'should create an instance of AddFieldsTemplateResponse' do
+      expect(@instance).to be_instance_of(DocSpring::AddFieldsTemplateResponse)
+    end
+  end
+  describe 'test attribute "new_field_ids"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  describe 'test attribute "errors"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  describe 'test attribute "status"' 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', ["success", "error"])
+      # validator.allowable_values.each do |value|
+      #   expect { @instance.status = value }.not_to raise_error
+      # end
+    end
+  end
+
+end

data/spec/models/{create_template_data_spec.rb → create_html_template_data_spec.rb}

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

data/spec/models/{create_template_data1_spec.rb → create_template_from_upload_data_spec.rb}

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