form_api 1.6.0 → 1.7.0

data/lib/form_api/models/templatesv2_template_document_metadata.rb

@@ -0,0 +1,235 @@
+=begin
+#API v1
+
+#FormAPI 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 'date'
+
+module FormAPI
+  class Templatesv2TemplateDocumentMetadata
+    attr_accessor :filename
+
+    attr_accessor :size
+
+    attr_accessor :mime_type
+
+    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
+      {
+        :'filename' => :'filename',
+        :'size' => :'size',
+        :'mime_type' => :'mime_type'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'filename' => :'String',
+        :'size' => :'Integer',
+        :'mime_type' => :'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?(:'filename')
+        self.filename = attributes[:'filename']
+      end
+
+      if attributes.has_key?(:'size')
+        self.size = attributes[:'size']
+      end
+
+      if attributes.has_key?(:'mime_type')
+        self.mime_type = attributes[:'mime_type']
+      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?
+      mime_type_validator = EnumAttributeValidator.new('String', ['application/pdf'])
+      return false unless mime_type_validator.valid?(@mime_type)
+      true
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] mime_type Object to be assigned
+    def mime_type=(mime_type)
+      validator = EnumAttributeValidator.new('String', ['application/pdf'])
+      unless validator.valid?(mime_type)
+        fail ArgumentError, 'invalid value for "mime_type", must be one of #{validator.allowable_values}.'
+      end
+      @mime_type = mime_type
+    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 &&
+          filename == o.filename &&
+          size == o.size &&
+          mime_type == o.mime_type
+    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
+      [filename, size, mime_type].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 = FormAPI.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/form_api/version.rb

@@ -11,5 +11,5 @@ OpenAPI Generator version: 3.3.0-SNAPSHOT
 =end
 
 module FormAPI
-  VERSION = '1.6.0'
+  VERSION = '1.7.0'
 end

data/spec/api/client_integration_spec.rb

@@ -6,7 +6,7 @@ describe FormAPI::Client do
     FormAPI.configure do |c|
       c.api_token_id = 'api_token123'
       c.api_token_secret = 'testsecret123'
-      c.host = 'http://localhost:31337'
+      c.host = 'http://api.formapi.local:31337'
     end
   end
 
@@ -84,7 +84,7 @@ describe FormAPI::Client do
 
       expect(response.status).to eq 'success'
       batch = response.submission_batch
-      expect(batch.id).to start_with 'sba_'
+      expect(batch.id).to start_with 'sbb_'
       expect(batch.state).to eq 'processed'
       expect(batch.total_count).to eq 2
       expect(batch.pending_count).to eq 0
@@ -137,7 +137,7 @@ describe FormAPI::Client do
 
       expect(response.status).to eq 'error'
       batch = response.submission_batch
-      expect(batch.id).to start_with 'sba_'
+      expect(batch.id).to start_with 'sbb_'
       expect(batch.state).to eq 'error'
       expect(batch.total_count).to eq 2
       expect(batch.pending_count).to eq 0
@@ -158,7 +158,7 @@ describe FormAPI::Client do
     end
   end
 
-  describe '#combine_submissions' do
+  describe '#combine_submissions with submission_ids' do
     it 'should merge multiple PDFs and wait for the job to be processed' do
       client = FormAPI::Client.new
       expect(client).to receive(:sleep).with(1).once
@@ -171,6 +171,13 @@ describe FormAPI::Client do
       expect(combined_submission.id).to start_with 'com_'
       expect(combined_submission.expired).to eq false
       expect(combined_submission.state).to eq 'processed'
+      expect(combined_submission.source_pdfs).to eq(
+        [
+          { type: 'submission', id: 'sub_000000000000000001' },
+          { type: 'submission', id: 'sub_000000000000000002' }
+        ]
+      )
+      # Backwards compatibility - We still set submission_ids
       expect(combined_submission.submission_ids).to eq(
         %w[sub_000000000000000001 sub_000000000000000002])
       expect(combined_submission.download_url).to include(
@@ -178,6 +185,36 @@ describe FormAPI::Client do
     end
   end
 
+  describe '#combine_pdfs with source_pdfs' do
+    it 'should merge multiple PDFs and wait for the job to be processed' do
+      client = FormAPI::Client.new
+      expect(client).to receive(:sleep).with(1).once
+
+      response = client.combine_pdfs(
+        source_pdfs: [
+          { type: 'submission', id: 'sub_000000000000000001' },
+          { type: 'template',   id: 'tpl_000000000000000001' },
+          { type: 'submission', id: 'sub_000000000000000002' }
+        ]
+      )
+
+      expect(response.status).to eq 'success'
+      combined_submission = response.combined_submission
+      expect(combined_submission.id).to start_with 'com_'
+      expect(combined_submission.expired).to eq false
+      expect(combined_submission.state).to eq 'processed'
+      expect(combined_submission.source_pdfs).to eq(
+        [
+          { type: 'submission', id: 'sub_000000000000000001' },
+          { type: 'template',   id: 'tpl_000000000000000001' },
+          { type: 'submission', id: 'sub_000000000000000002' }
+        ]
+      )
+      expect(combined_submission.download_url).to include(
+        'combined_submissions/combined_submission.pdf')
+    end
+  end
+
   describe '#batch_generate_and_combine_pdfs' do
     it 'should submit a batch job and combine the PDFs into a single PDF' do
       client = FormAPI::Client.new

data/spec/api/pdf_api_integration_spec.rb

@@ -21,7 +21,7 @@ describe 'PDFApi' do
     FormAPI.configure do |c|
       c.api_token_id = 'api_token123'
       c.api_token_secret = 'testsecret123'
-      c.host = 'http://localhost:31337'
+      c.host = 'http://api.formapi.local:31337'
     end
   end
 
@@ -89,7 +89,7 @@ describe 'PDFApi' do
       )
       expect(response.status).to eq 'success'
       batch = response.submission_batch
-      expect(batch.id).to start_with 'sba_'
+      expect(batch.id).to start_with 'sbb_'
       expect(batch.state).to eq 'pending'
       expect(batch.total_count).to eq 2
       expect(batch.pending_count).to eq 2
@@ -108,9 +108,9 @@ describe 'PDFApi' do
 
   describe 'get_submission_batch test' do
     it 'should get the batch including submissions' do
-      submission_batch_id = 'sba_000000000000000001'
+      submission_batch_id = 'sbb_000000000000000001'
       batch = api_instance.get_submission_batch(submission_batch_id, include_submissions: true)
-      expect(batch.id).to eq 'sba_000000000000000001'
+      expect(batch.id).to eq 'sbb_000000000000000001'
       expect(batch.total_count).to eq 2
       expect(batch.pending_count).to eq 0
       expect(batch.completion_percentage).to eq 100
@@ -119,9 +119,9 @@ describe 'PDFApi' do
     end
 
     it 'should get the batch without submissions' do
-      submission_batch_id = 'sba_000000000000000001'
+      submission_batch_id = 'sbb_000000000000000001'
       batch = api_instance.get_submission_batch(submission_batch_id)
-      expect(batch.id).to eq 'sba_000000000000000001'
+      expect(batch.id).to eq 'sbb_000000000000000001'
       expect(batch.submissions).to be_nil
     end
   end
@@ -153,7 +153,7 @@ describe 'PDFApi' do
       expect(response.token.id).to_not be_nil
       expect(response.token.secret).to_not be_nil
       expect(response.token.data_request_url).to start_with \
-        'http://localhost/data_requests/drq_000000000000000001?token_id='
+        'http://app.formapi.local/data_requests/drq_000000000000000001?token_id='
       expect(response.token.data_request_url).to include \
         "?token_id=#{response.token.id}" \
         "&token_secret=#{response.token.secret}"

data/spec/api/pdf_api_spec_original.skipped.rb

@@ -21,7 +21,7 @@ describe 'PDFApi' do
     FormAPI.configure do |c|
       c.username  = 'api_token123'
       c.password  = 'testsecret123'
-      c.host = 'localhost:31337'
+      c.host = 'api.formapi.local:31337'
       c.scheme = 'http'
     end
   end
@@ -41,14 +41,14 @@ describe 'PDFApi' do
   # integration tests for batch_generate_pdf_v1
   # Generates multiple PDFs
   # @param template_id 
-  # @param create_submission_data_batch_v1 
+  # @param request_body 
   # @param [Hash] opts the optional parameters
   # @return [Array<CreateSubmissionResponse>]
   describe 'batch_generate_pdf_v1 test' do
     it 'should work' do
       template_id = 'tpl_000000000000000001' # String | 
-      create_submission_data_batch_v1 = nil # Array<CreateSubmissionDataBatchV1> | 
-      result = api_instance.batch_generate_pdf_v1(template_id, create_submission_data_batch_v1)
+      request_body = nil # Array<Object> | 
+      result = api_instance.batch_generate_pdf_v1(template_id, request_body)
       expect(result).to_not be_nil
     end
   end
@@ -64,6 +64,18 @@ describe 'PDFApi' do
       expect(result).to_not be_nil
     end
   end
+  # integration tests for combine_pdfs
+  # Merge submission PDFs, template PDFs, or custom files
+  # @param combine_pdfs_data 
+  # @param [Hash] opts the optional parameters
+  # @return [CreateCombinedSubmissionResponse]
+  describe 'combine_pdfs test' do
+    it 'should work' do
+      combine_pdfs_data = FormAPI::CombinePdfsData.new # CombinePdfsData | 
+      result = api_instance.combine_pdfs(combine_pdfs_data)
+      expect(result).to_not be_nil
+    end
+  end
   # integration tests for combine_submissions
   # Merge generated PDFs together
   # @param combined_submission_data 
@@ -76,6 +88,18 @@ describe 'PDFApi' do
       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 
+  # @param [Hash] opts the optional parameters
+  # @return [CreateCustomFileResponse]
+  describe 'create_custom_file_from_upload test' do
+    it 'should work' do
+      create_custom_file_data = FormAPI::CreateCustomFileData.new # CreateCustomFileData | 
+      result = api_instance.create_custom_file_from_upload(create_custom_file_data)
+      expect(result).to_not be_nil
+    end
+  end
   # integration tests for create_data_request_token
   # Creates a new data request token for form authentication
   # @param data_request_id 
@@ -89,7 +113,7 @@ describe 'PDFApi' do
     end
   end
   # integration tests for create_template
-  # Upload a new PDF template
+  # Upload a new PDF template with a file upload
   # @param template_document 
   # @param template_name 
   # @param [Hash] opts the optional parameters
@@ -102,6 +126,18 @@ describe 'PDFApi' do
       expect(result).to_not be_nil
     end
   end
+  # integration tests for create_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
+    it 'should work' do
+      create_template_data = FormAPI::CreateTemplateData.new # CreateTemplateData | 
+      result = api_instance.create_template_from_upload(create_template_data)
+      expect(result).to_not be_nil
+    end
+  end
   # integration tests for expire_combined_submission
   # Expire a combined submission
   # @param combined_submission_id 
@@ -129,14 +165,14 @@ describe 'PDFApi' do
   # integration tests for generate_pdf
   # Generates a new PDF
   # @param template_id 
-  # @param create_submission_data 
+  # @param submission_data 
   # @param [Hash] opts the optional parameters
   # @return [CreateSubmissionResponse]
   describe 'generate_pdf test' do
     it 'should work' do
       template_id = 'tpl_000000000000000001' # String | 
-      create_submission_data = FormAPI::CreateSubmissionData.new # CreateSubmissionData | 
-      result = api_instance.generate_pdf(template_id, create_submission_data)
+      submission_data = FormAPI::SubmissionData.new # SubmissionData | 
+      result = api_instance.generate_pdf(template_id, submission_data)
       expect(result).to_not be_nil
     end
   end
@@ -164,6 +200,16 @@ describe 'PDFApi' do
       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
+  # @return [Hash<String, Object>]
+  describe 'get_presign_url test' do
+    it 'should work' do
+      result = api_instance.get_presign_url
+      expect(result).to_not be_nil
+    end
+  end
   # integration tests for get_submission
   # Check the status of a PDF
   # @param submission_id 
@@ -184,7 +230,7 @@ describe 'PDFApi' do
   # @return [SubmissionBatch]
   describe 'get_submission_batch test' do
     it 'should work' do
-      submission_batch_id = 'sba_000000000000000001' # String | 
+      submission_batch_id = 'sbb_000000000000000001' # String | 
       opts = {
         include_submissions: true # BOOLEAN | 
       }