docspring 1.3.0 → 1.4.1

data/lib/docspring/api/pdf_api.rb

@@ -296,6 +296,65 @@ module DocSpring
       return data, status_code, headers
     end
 
+    # Copy a Template
+    # @param template_id 
+    # @param copy_template_data 
+    # @param [Hash] opts the optional parameters
+    # @return [Template]
+    def copy_template(template_id, copy_template_data, opts = {})
+      data, _status_code, _headers = copy_template_with_http_info(template_id, copy_template_data, opts)
+      data
+    end
+
+    # Copy a Template
+    # @param template_id 
+    # @param copy_template_data 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(Template, Fixnum, Hash)>] Template data, response status code and response headers
+    def copy_template_with_http_info(template_id, copy_template_data, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: PDFApi.copy_template ...'
+      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.copy_template"
+      end
+      # verify the required parameter 'copy_template_data' is set
+      if @api_client.config.client_side_validation && copy_template_data.nil?
+        fail ArgumentError, "Missing the required parameter 'copy_template_data' when calling PDFApi.copy_template"
+      end
+      # resource path
+      local_var_path = '/templates/{template_id}/copy'.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(copy_template_data)
+      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 => 'Template')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: PDFApi#copy_template\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Create a new custom file from a cached presign upload
     # @param create_custom_file_data 
     # @param [Hash] opts the optional parameters
@@ -937,6 +996,57 @@ module DocSpring
       return data, status_code, headers
     end
 
+    # Fetch the full template attributes
+    # @param template_id 
+    # @param [Hash] opts the optional parameters
+    # @return [Template1]
+    def get_full_template(template_id, opts = {})
+      data, _status_code, _headers = get_full_template_with_http_info(template_id, opts)
+      data
+    end
+
+    # Fetch the full template attributes
+    # @param template_id 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(Template1, Fixnum, Hash)>] Template1 data, response status code and response headers
+    def get_full_template_with_http_info(template_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: PDFApi.get_full_template ...'
+      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.get_full_template"
+      end
+      # resource path
+      local_var_path = '/templates/{template_id}?full=true'.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'])
+
+      # 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 => 'Template1')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: PDFApi#get_full_template\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # 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>]
@@ -1090,7 +1200,7 @@ module DocSpring
       return data, status_code, headers
     end
 
-    # Get a single template
+    # Check the status of an uploaded template
     # @param template_id 
     # @param [Hash] opts the optional parameters
     # @return [Template]
@@ -1099,7 +1209,7 @@ module DocSpring
       data
     end
 
-    # Get a single template
+    # Check the status of an uploaded template
     # @param template_id 
     # @param [Hash] opts the optional parameters
     # @return [Array<(Template, Fixnum, Hash)>] Template data, response status code and response headers
@@ -1240,6 +1350,138 @@ module DocSpring
       return data, status_code, headers
     end
 
+    # List all submissions
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :cursor 
+    # @option opts [Float] :limit 
+    # @option opts [String] :created_after 
+    # @option opts [String] :created_before 
+    # @option opts [String] :type 
+    # @option opts [BOOLEAN] :include_data 
+    # @return [ListSubmissionsResponse]
+    def list_submissions(opts = {})
+      data, _status_code, _headers = list_submissions_with_http_info(opts)
+      data
+    end
+
+    # List all submissions
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :cursor 
+    # @option opts [Float] :limit 
+    # @option opts [String] :created_after 
+    # @option opts [String] :created_before 
+    # @option opts [String] :type 
+    # @option opts [BOOLEAN] :include_data 
+    # @return [Array<(ListSubmissionsResponse, Fixnum, Hash)>] ListSubmissionsResponse data, response status code and response headers
+    def list_submissions_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: PDFApi.list_submissions ...'
+      end
+      # resource path
+      local_var_path = '/submissions'
+
+      # query parameters
+      query_params = {}
+      query_params[:'cursor'] = opts[:'cursor'] if !opts[:'cursor'].nil?
+      query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
+      query_params[:'created_after'] = opts[:'created_after'] if !opts[:'created_after'].nil?
+      query_params[:'created_before'] = opts[:'created_before'] if !opts[:'created_before'].nil?
+      query_params[:'type'] = opts[:'type'] if !opts[:'type'].nil?
+      query_params[:'include_data'] = opts[:'include_data'] if !opts[:'include_data'].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 => 'ListSubmissionsResponse')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: PDFApi#list_submissions\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # List all submissions for a given template
+    # @param template_id 
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :cursor 
+    # @option opts [Float] :limit 
+    # @option opts [String] :created_after 
+    # @option opts [String] :created_before 
+    # @option opts [String] :type 
+    # @option opts [BOOLEAN] :include_data 
+    # @return [ListSubmissionsResponse]
+    def list_submissions_0(template_id, opts = {})
+      data, _status_code, _headers = list_submissions_0_with_http_info(template_id, opts)
+      data
+    end
+
+    # List all submissions for a given template
+    # @param template_id 
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :cursor 
+    # @option opts [Float] :limit 
+    # @option opts [String] :created_after 
+    # @option opts [String] :created_before 
+    # @option opts [String] :type 
+    # @option opts [BOOLEAN] :include_data 
+    # @return [Array<(ListSubmissionsResponse, Fixnum, Hash)>] ListSubmissionsResponse data, response status code and response headers
+    def list_submissions_0_with_http_info(template_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: PDFApi.list_submissions_0 ...'
+      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.list_submissions_0"
+      end
+      # resource path
+      local_var_path = '/templates/{template_id}/submissions'.sub('{' + 'template_id' + '}', template_id.to_s)
+
+      # query parameters
+      query_params = {}
+      query_params[:'cursor'] = opts[:'cursor'] if !opts[:'cursor'].nil?
+      query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
+      query_params[:'created_after'] = opts[:'created_after'] if !opts[:'created_after'].nil?
+      query_params[:'created_before'] = opts[:'created_before'] if !opts[:'created_before'].nil?
+      query_params[:'type'] = opts[:'type'] if !opts[:'type'].nil?
+      query_params[:'include_data'] = opts[:'include_data'] if !opts[:'include_data'].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 => 'ListSubmissionsResponse')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: PDFApi#list_submissions_0\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 [String] :query Search By Name

data/lib/docspring/api_client.rb

@@ -281,7 +281,7 @@ module DocSpring
     def build_request_url(path)
       # Add leading and trailing slashes to path
       path = "/#{path}".gsub(/\/+/, '/')
-      URI.encode(@config.base_url + path)
+      @config.base_url + path
     end
 
     # Builds the HTTP request body

data/lib/docspring/configuration.rb

@@ -195,8 +195,7 @@ module DocSpring
     end
 
     def base_url
-      url = "#{scheme}://#{[host, base_path].join('/').gsub(/\/+/, '/')}".sub(/\/+\z/, '')
-      URI.encode(url)
+      "#{scheme}://#{[host, base_path].join('/').gsub(/\/+/, '/')}".sub(/\/+\z/, '')
     end
 
     # Gets API key (with prefix if set).

data/lib/docspring/models/combine_pdfs_data.rb

@@ -20,6 +20,8 @@ module DocSpring
 
     attr_accessor :metadata
 
+    attr_accessor :password
+
     attr_accessor :source_pdfs
 
     attr_accessor :test
@@ -30,6 +32,7 @@ module DocSpring
         :'delete_custom_files' => :'delete_custom_files',
         :'expires_in' => :'expires_in',
         :'metadata' => :'metadata',
+        :'password' => :'password',
         :'source_pdfs' => :'source_pdfs',
         :'test' => :'test'
       }
@@ -41,6 +44,7 @@ module DocSpring
         :'delete_custom_files' => :'BOOLEAN',
         :'expires_in' => :'Integer',
         :'metadata' => :'Object',
+        :'password' => :'String',
         :'source_pdfs' => :'Array<Object>',
         :'test' => :'BOOLEAN'
       }
@@ -66,6 +70,10 @@ module DocSpring
         self.metadata = attributes[:'metadata']
       end
 
+      if attributes.has_key?(:'password')
+        self.password = attributes[:'password']
+      end
+
       if attributes.has_key?(:'source_pdfs')
         if (value = attributes[:'source_pdfs']).is_a?(Array)
           self.source_pdfs = value
@@ -103,6 +111,7 @@ module DocSpring
           delete_custom_files == o.delete_custom_files &&
           expires_in == o.expires_in &&
           metadata == o.metadata &&
+          password == o.password &&
           source_pdfs == o.source_pdfs &&
           test == o.test
     end
@@ -116,7 +125,7 @@ module DocSpring
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [delete_custom_files, expires_in, metadata, source_pdfs, test].hash
+      [delete_custom_files, expires_in, metadata, password, source_pdfs, test].hash
     end
 
     # Builds the object from hash

data/lib/docspring/models/combined_submission.rb

@@ -16,6 +16,8 @@ module DocSpring
   class CombinedSubmission
     attr_accessor :metadata
 
+    attr_accessor :password
+
     attr_accessor :expired
 
     attr_accessor :expires_at
@@ -60,6 +62,7 @@ module DocSpring
     def self.attribute_map
       {
         :'metadata' => :'metadata',
+        :'password' => :'password',
         :'expired' => :'expired',
         :'expires_at' => :'expires_at',
         :'source_pdfs' => :'source_pdfs',
@@ -76,6 +79,7 @@ module DocSpring
     def self.openapi_types
       {
         :'metadata' => :'Object',
+        :'password' => :'String',
         :'expired' => :'BOOLEAN',
         :'expires_at' => :'String',
         :'source_pdfs' => :'Array<Object>',
@@ -100,6 +104,10 @@ module DocSpring
         self.metadata = attributes[:'metadata']
       end
 
+      if attributes.has_key?(:'password')
+        self.password = attributes[:'password']
+      end
+
       if attributes.has_key?(:'expired')
         self.expired = attributes[:'expired']
       end
@@ -174,6 +182,7 @@ module DocSpring
       return true if self.equal?(o)
       self.class == o.class &&
           metadata == o.metadata &&
+          password == o.password &&
           expired == o.expired &&
           expires_at == o.expires_at &&
           source_pdfs == o.source_pdfs &&
@@ -194,7 +203,7 @@ module DocSpring
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [metadata, expired, expires_at, source_pdfs, pdf_hash, download_url, submission_ids, id, state, actions].hash
+      [metadata, password, expired, expires_at, source_pdfs, pdf_hash, download_url, submission_ids, id, state, actions].hash
     end
 
     # Builds the object from hash

data/lib/docspring/models/combined_submission_data.rb

@@ -18,6 +18,8 @@ module DocSpring
 
     attr_accessor :metadata
 
+    attr_accessor :password
+
     attr_accessor :submission_ids
 
     attr_accessor :test
@@ -27,6 +29,7 @@ module DocSpring
       {
         :'expires_in' => :'expires_in',
         :'metadata' => :'metadata',
+        :'password' => :'password',
         :'submission_ids' => :'submission_ids',
         :'test' => :'test'
       }
@@ -37,6 +40,7 @@ module DocSpring
       {
         :'expires_in' => :'Integer',
         :'metadata' => :'Object',
+        :'password' => :'String',
         :'submission_ids' => :'Array<String>',
         :'test' => :'BOOLEAN'
       }
@@ -58,6 +62,10 @@ module DocSpring
         self.metadata = attributes[:'metadata']
       end
 
+      if attributes.has_key?(:'password')
+        self.password = attributes[:'password']
+      end
+
       if attributes.has_key?(:'submission_ids')
         if (value = attributes[:'submission_ids']).is_a?(Array)
           self.submission_ids = value
@@ -94,6 +102,7 @@ module DocSpring
       self.class == o.class &&
           expires_in == o.expires_in &&
           metadata == o.metadata &&
+          password == o.password &&
           submission_ids == o.submission_ids &&
           test == o.test
     end
@@ -107,7 +116,7 @@ module DocSpring
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [expires_in, metadata, submission_ids, test].hash
+      [expires_in, metadata, password, submission_ids, test].hash
     end
 
     # Builds the object from hash

data/lib/docspring/models/copy_template_data.rb

@@ -0,0 +1,197 @@
+=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
+
+=end
+
+require 'date'
+
+module DocSpring
+  class CopyTemplateData
+    attr_accessor :name
+
+    attr_accessor :parent_folder_id
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'name' => :'name',
+        :'parent_folder_id' => :'parent_folder_id'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'name' => :'String',
+        :'parent_folder_id' => :'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?(:'name')
+        self.name = attributes[:'name']
+      end
+
+      if attributes.has_key?(:'parent_folder_id')
+        self.parent_folder_id = attributes[:'parent_folder_id']
+      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
+      if @parent_folder_id.nil?
+        invalid_properties.push('invalid value for "parent_folder_id", parent_folder_id cannot be nil.')
+      end
+
+      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 @parent_folder_id.nil?
+      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 &&
+          name == o.name &&
+          parent_folder_id == o.parent_folder_id
+    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
+      [name, parent_folder_id].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 = DocSpring.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