form_api 0.1.5 → 0.2.0

data/lib/form_api/api/pdf_api.rb

@@ -20,10 +20,67 @@ module FormAPI
       @api_client = api_client
     end
 
+    # Generates multiple PDFs
+    #
+    # @param template_id
+    # @param [Hash] opts the optional parameters
+    # @option opts [Array<CreateSubmissionBatchBody>] :create_submission_batch_body
+    # @return [Array<InlineResponse2011>]
+    def batch_generate_pdf(template_id, opts = {})
+      data, _status_code, _headers = batch_generate_pdf_with_http_info(template_id, opts)
+      return data
+    end
+
+    # Generates multiple PDFs
+    #
+    # @param template_id
+    # @param [Hash] opts the optional parameters
+    # @option opts [Array<CreateSubmissionBatchBody>] :create_submission_batch_body
+    # @return [Array<(Array<InlineResponse2011>, Fixnum, Hash)>] Array<InlineResponse2011> data, response status code and response headers
+    def batch_generate_pdf_with_http_info(template_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "Calling API: PDFApi.batch_generate_pdf ..."
+      end
+      # verify the required parameter 'template_id' is set
+      if @api_client.config.client_side_validation && template_id.nil?
+        fail ArgumentError, "Missing the required parameter 'template_id' when calling PDFApi.batch_generate_pdf"
+      end
+      # resource path
+      local_var_path = "/templates/{template_id}/submissions/batch".sub('{' + 'template_id' + '}', template_id.to_s)
+
+      # query parameters
+      query_params = {}
+
+      # header parameters
+      header_params = {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+      # HTTP header 'Content-Type'
+      header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = @api_client.object_to_http_body(opts[:'create_submission_batch_body'])
+      auth_names = ['api_token_basic']
+      data, status_code, headers = @api_client.call_api(:POST, local_var_path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => 'Array<InlineResponse2011>')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: PDFApi#batch_generate_pdf\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Merge generated PDFs together
     #
     # @param [Hash] opts the optional parameters
-    # @option opts [Data] :data
+    # @option opts [CreateCombinedSubmissionBody] :create_combined_submission_body
     # @return [InlineResponse201]
     def combine_submissions(opts = {})
       data, _status_code, _headers = combine_submissions_with_http_info(opts)
@@ -33,7 +90,7 @@ module FormAPI
     # Merge generated PDFs together
     #
     # @param [Hash] opts the optional parameters
-    # @option opts [Data] :data
+    # @option opts [CreateCombinedSubmissionBody] :create_combined_submission_body
     # @return [Array<(InlineResponse201, Fixnum, Hash)>] InlineResponse201 data, response status code and response headers
     def combine_submissions_with_http_info(opts = {})
       if @api_client.config.debugging
@@ -56,8 +113,8 @@ module FormAPI
       form_params = {}
 
       # http body (model)
-      post_body = @api_client.object_to_http_body(opts[:'data'])
-      auth_names = ['basic']
+      post_body = @api_client.object_to_http_body(opts[:'create_combined_submission_body'])
+      auth_names = ['api_token_basic']
       data, status_code, headers = @api_client.call_api(:POST, local_var_path,
         :header_params => header_params,
         :query_params => query_params,
@@ -110,7 +167,7 @@ module FormAPI
 
       # http body (model)
       post_body = nil
-      auth_names = ['basic']
+      auth_names = ['api_token_basic']
       data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
         :header_params => header_params,
         :query_params => query_params,
@@ -128,7 +185,7 @@ module FormAPI
     #
     # @param submission_id
     # @param [Hash] opts the optional parameters
-    # @return [InlineResponse2011Submission]
+    # @return [TemplatestemplateIdsubmissionsbatchSubmission]
     def expire_submission(submission_id, opts = {})
       data, _status_code, _headers = expire_submission_with_http_info(submission_id, opts)
       return data
@@ -138,7 +195,7 @@ module FormAPI
     #
     # @param submission_id
     # @param [Hash] opts the optional parameters
-    # @return [Array<(InlineResponse2011Submission, Fixnum, Hash)>] InlineResponse2011Submission data, response status code and response headers
+    # @return [Array<(TemplatestemplateIdsubmissionsbatchSubmission, Fixnum, Hash)>] TemplatestemplateIdsubmissionsbatchSubmission data, response status code and response headers
     def expire_submission_with_http_info(submission_id, opts = {})
       if @api_client.config.debugging
         @api_client.config.logger.debug "Calling API: PDFApi.expire_submission ..."
@@ -163,14 +220,14 @@ module FormAPI
 
       # http body (model)
       post_body = nil
-      auth_names = ['basic']
+      auth_names = ['api_token_basic']
       data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
         :header_params => header_params,
         :query_params => query_params,
         :form_params => form_params,
         :body => post_body,
         :auth_names => auth_names,
-        :return_type => 'InlineResponse2011Submission')
+        :return_type => 'TemplatestemplateIdsubmissionsbatchSubmission')
       if @api_client.config.debugging
         @api_client.config.logger.debug "API called: PDFApi#expire_submission\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
       end
@@ -181,7 +238,7 @@ module FormAPI
     #
     # @param template_id
     # @param [Hash] opts the optional parameters
-    # @option opts [Data1] :data
+    # @option opts [CreateSubmissionBody] :create_submission_body
     # @return [InlineResponse2011]
     def generate_pdf(template_id, opts = {})
       data, _status_code, _headers = generate_pdf_with_http_info(template_id, opts)
@@ -192,7 +249,7 @@ module FormAPI
     #
     # @param template_id
     # @param [Hash] opts the optional parameters
-    # @option opts [Data1] :data
+    # @option opts [CreateSubmissionBody] :create_submission_body
     # @return [Array<(InlineResponse2011, Fixnum, Hash)>] InlineResponse2011 data, response status code and response headers
     def generate_pdf_with_http_info(template_id, opts = {})
       if @api_client.config.debugging
@@ -219,8 +276,8 @@ module FormAPI
       form_params = {}
 
       # http body (model)
-      post_body = @api_client.object_to_http_body(opts[:'data'])
-      auth_names = ['basic']
+      post_body = @api_client.object_to_http_body(opts[:'create_submission_body'])
+      auth_names = ['api_token_basic']
       data, status_code, headers = @api_client.call_api(:POST, local_var_path,
         :header_params => header_params,
         :query_params => query_params,
@@ -273,7 +330,7 @@ module FormAPI
 
       # http body (model)
       post_body = nil
-      auth_names = ['basic']
+      auth_names = ['api_token_basic']
       data, status_code, headers = @api_client.call_api(:GET, local_var_path,
         :header_params => header_params,
         :query_params => query_params,
@@ -291,7 +348,7 @@ module FormAPI
     #
     # @param submission_id
     # @param [Hash] opts the optional parameters
-    # @return [InlineResponse2011Submission]
+    # @return [TemplatestemplateIdsubmissionsbatchSubmission]
     def get_submission(submission_id, opts = {})
       data, _status_code, _headers = get_submission_with_http_info(submission_id, opts)
       return data
@@ -301,7 +358,7 @@ module FormAPI
     #
     # @param submission_id
     # @param [Hash] opts the optional parameters
-    # @return [Array<(InlineResponse2011Submission, Fixnum, Hash)>] InlineResponse2011Submission data, response status code and response headers
+    # @return [Array<(TemplatestemplateIdsubmissionsbatchSubmission, Fixnum, Hash)>] TemplatestemplateIdsubmissionsbatchSubmission data, response status code and response headers
     def get_submission_with_http_info(submission_id, opts = {})
       if @api_client.config.debugging
         @api_client.config.logger.debug "Calling API: PDFApi.get_submission ..."
@@ -326,20 +383,73 @@ module FormAPI
 
       # http body (model)
       post_body = nil
-      auth_names = ['basic']
+      auth_names = ['api_token_basic']
       data, status_code, headers = @api_client.call_api(:GET, local_var_path,
         :header_params => header_params,
         :query_params => query_params,
         :form_params => form_params,
         :body => post_body,
         :auth_names => auth_names,
-        :return_type => 'InlineResponse2011Submission')
+        :return_type => 'TemplatestemplateIdsubmissionsbatchSubmission')
       if @api_client.config.debugging
         @api_client.config.logger.debug "API called: PDFApi#get_submission\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
       end
       return data, status_code, headers
     end
 
+    # Get a list of all templates
+    #
+    # @param [Hash] opts the optional parameters
+    # @option opts [Integer] :page Default: 1
+    # @option opts [Integer] :per_page Default: 50
+    # @return [Array<InlineResponse2001>]
+    def get_templates(opts = {})
+      data, _status_code, _headers = get_templates_with_http_info(opts)
+      return data
+    end
+
+    # Get a list of all templates
+    #
+    # @param [Hash] opts the optional parameters
+    # @option opts [Integer] :page Default: 1
+    # @option opts [Integer] :per_page Default: 50
+    # @return [Array<(Array<InlineResponse2001>, Fixnum, Hash)>] Array<InlineResponse2001> data, response status code and response headers
+    def get_templates_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "Calling API: PDFApi.get_templates ..."
+      end
+      # resource path
+      local_var_path = "/templates"
+
+      # query parameters
+      query_params = {}
+      query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
+      query_params[:'per_page'] = opts[:'per_page'] if !opts[:'per_page'].nil?
+
+      # header parameters
+      header_params = {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = nil
+      auth_names = ['api_token_basic']
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => 'Array<InlineResponse2001>')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: PDFApi#get_templates\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Test Authentication
     #
     # @param [Hash] opts the optional parameters
@@ -373,7 +483,7 @@ module FormAPI
 
       # http body (model)
       post_body = nil
-      auth_names = ['basic']
+      auth_names = ['api_token_basic']
       data, status_code, headers = @api_client.call_api(:GET, local_var_path,
         :header_params => header_params,
         :query_params => query_params,

data/lib/form_api/configuration.rb

@@ -196,7 +196,7 @@ module FormAPI
     # Returns Auth Settings hash for api client.
     def auth_settings
       {
-        'basic' =>
+        'api_token_basic' =>
           {
             type: 'basic',
             in: 'header',

data/lib/form_api/models/{data.rb → create_combined_submission_body.rb}

@@ -14,7 +14,7 @@ require 'date'
 
 module FormAPI
 
-  class Data
+  class CreateCombinedSubmissionBody
     attr_accessor :test
 
     attr_accessor :submission_ids

data/lib/form_api/models/create_submission_batch_body.rb

@@ -0,0 +1,211 @@
+=begin
+#API V1
+
+#No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
+
+OpenAPI spec version: v1
+
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+Swagger Codegen version: 2.3.0-SNAPSHOT
+
+=end
+
+require 'date'
+
+module FormAPI
+
+  class CreateSubmissionBatchBody
+    attr_accessor :test
+
+    attr_accessor :data
+
+    attr_accessor :metadata
+
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'test' => :'test',
+        :'data' => :'data',
+        :'metadata' => :'metadata'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        :'test' => :'BOOLEAN',
+        :'data' => :'Object',
+        :'metadata' => :'Object'
+      }
+    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?(:'test')
+        self.test = attributes[:'test']
+      end
+
+      if attributes.has_key?(:'data')
+        self.data = attributes[:'data']
+      end
+
+      if attributes.has_key?(:'metadata')
+        self.metadata = attributes[:'metadata']
+      end
+
+    end
+
+    # Show invalid properties with the reasons. Usually used together with valid?
+    # @return Array for valid properies with the reasons
+    def list_invalid_properties
+      invalid_properties = Array.new
+      if @data.nil?
+        invalid_properties.push("invalid value for 'data', data cannot be nil.")
+      end
+
+      return 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?
+      return false if @data.nil?
+      return 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 &&
+          test == o.test &&
+          data == o.data &&
+          metadata == o.metadata
+    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
+      [test, data, metadata].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.swagger_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/models/{data_1.rb → create_submission_body.rb}

@@ -14,7 +14,7 @@ require 'date'
 
 module FormAPI
 
-  class Data1
+  class CreateSubmissionBody
     attr_accessor :test
 
     attr_accessor :data