docspring 1.1.0 → 1.2.0

data/docs/UploadTemplateData.md

@@ -0,0 +1,25 @@
+# DocSpring::UploadTemplateData
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**expiration_interval** | **String** |  | [optional] 
+**webhook_url** | **String** |  | [optional] 
+**scss** | **String** |  | [optional] 
+**expire_after** | **Float** |  | [optional] 
+**allow_additional_properties** | **BOOLEAN** |  | [optional] 
+**document** | [**UploadTemplateDataDocument**](UploadTemplateDataDocument.md) |  | [optional] 
+**description** | **String** |  | [optional] 
+**public_submissions** | **BOOLEAN** |  | [optional] 
+**slack_webhook_url** | **String** |  | [optional] 
+**header_html** | **String** |  | [optional] 
+**public_web_form** | **BOOLEAN** |  | [optional] 
+**editable_submissions** | **BOOLEAN** |  | [optional] 
+**expire_submissions** | **BOOLEAN** |  | [optional] 
+**name** | **String** |  | [optional] 
+**html** | **String** |  | [optional] 
+**footer_html** | **String** |  | [optional] 
+**template_type** | **String** |  | [optional] 
+**redirect_url** | **String** |  | [optional] 
+
+

data/docs/UploadTemplateDataDocument.md

@@ -0,0 +1,10 @@
+# DocSpring::UploadTemplateDataDocument
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**metadata** | [**UploadTemplateDataDocumentMetadata**](UploadTemplateDataDocumentMetadata.md) |  | [optional] 
+**id** | **String** |  | [optional] 
+**storage** | **String** |  | [optional] 
+
+

data/docs/{TemplatesdesccachedUploadTemplateDocumentMetadata.md → UploadTemplateDataDocumentMetadata.md}

@@ -1,4 +1,4 @@
-# DocSpring::TemplatesdesccachedUploadTemplateDocumentMetadata
+# DocSpring::UploadTemplateDataDocumentMetadata
 
 ## Properties
 Name | Type | Description | Notes

data/lib/docspring.rb

@@ -17,6 +17,8 @@ require 'docspring/version'
 require 'docspring/configuration'
 
 # Models
+require 'docspring/models/add_fields_data'
+require 'docspring/models/add_fields_template_response'
 require 'docspring/models/authentication_error'
 require 'docspring/models/authentication_success_response'
 require 'docspring/models/combine_pdfs_data'
@@ -27,18 +29,19 @@ require 'docspring/models/create_combined_submission_response'
 require 'docspring/models/create_custom_file_data'
 require 'docspring/models/create_custom_file_response'
 require 'docspring/models/create_folder_data'
+require 'docspring/models/create_html_template_data'
 require 'docspring/models/create_submission_batch_response'
 require 'docspring/models/create_submission_batch_submissions_response'
 require 'docspring/models/create_submission_data_request_data'
 require 'docspring/models/create_submission_data_request_token_response'
 require 'docspring/models/create_submission_data_request_token_response_token'
 require 'docspring/models/create_submission_response'
-require 'docspring/models/create_template_data'
-require 'docspring/models/create_template_data1'
+require 'docspring/models/create_template_from_upload_data'
 require 'docspring/models/custom_file'
 require 'docspring/models/error'
 require 'docspring/models/folder'
 require 'docspring/models/folders_folder'
+require 'docspring/models/html_template_data'
 require 'docspring/models/invalid_request'
 require 'docspring/models/move_folder_data'
 require 'docspring/models/move_template_data'
@@ -52,14 +55,15 @@ require 'docspring/models/submission_data'
 require 'docspring/models/submission_data_batch_request'
 require 'docspring/models/submission_data_request'
 require 'docspring/models/template'
-require 'docspring/models/templatesdesccached_upload_template'
-require 'docspring/models/templatesdesccached_upload_template_document'
-require 'docspring/models/templatesdesccached_upload_template_document_metadata'
-require 'docspring/models/templatestemplate_id_template'
+require 'docspring/models/template_data'
+require 'docspring/models/templatestemplate_idadd_fields_fields'
 require 'docspring/models/update_data_request_response'
 require 'docspring/models/update_submission_data_request_data'
 require 'docspring/models/update_template_data'
 require 'docspring/models/update_template_response'
+require 'docspring/models/upload_template_data'
+require 'docspring/models/upload_template_data_document'
+require 'docspring/models/upload_template_data_document_metadata'
 
 # APIs
 require 'docspring/api/pdf_api'

data/lib/docspring/api/pdf_api.rb

@@ -19,6 +19,65 @@ module DocSpring
     def initialize(api_client = ApiClient.default)
       @api_client = api_client
     end
+    # Add new fields to a Template
+    # @param template_id 
+    # @param add_fields_data 
+    # @param [Hash] opts the optional parameters
+    # @return [AddFieldsTemplateResponse]
+    def add_fields_to_template(template_id, add_fields_data, opts = {})
+      data, _status_code, _headers = add_fields_to_template_with_http_info(template_id, add_fields_data, opts)
+      data
+    end
+
+    # Add new fields to a Template
+    # @param template_id 
+    # @param add_fields_data 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(AddFieldsTemplateResponse, Fixnum, Hash)>] AddFieldsTemplateResponse data, response status code and response headers
+    def add_fields_to_template_with_http_info(template_id, add_fields_data, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: PDFApi.add_fields_to_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.add_fields_to_template"
+      end
+      # verify the required parameter 'add_fields_data' is set
+      if @api_client.config.client_side_validation && add_fields_data.nil?
+        fail ArgumentError, "Missing the required parameter 'add_fields_data' when calling PDFApi.add_fields_to_template"
+      end
+      # resource path
+      local_var_path = '/templates/{template_id}/add_fields'.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(add_fields_data)
+      auth_names = ['api_token_basic']
+      data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => 'AddFieldsTemplateResponse')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: PDFApi#add_fields_to_template\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Generates multiple PDFs
     # @param template_id 
     # @param request_body 
@@ -395,25 +454,25 @@ module DocSpring
     end
 
     # Create a new HTML template
-    # @param create_template_data1 
+    # @param create_html_template_data 
     # @param [Hash] opts the optional parameters
     # @return [PendingTemplate]
-    def create_html_template(create_template_data1, opts = {})
-      data, _status_code, _headers = create_html_template_with_http_info(create_template_data1, opts)
+    def create_html_template(create_html_template_data, opts = {})
+      data, _status_code, _headers = create_html_template_with_http_info(create_html_template_data, opts)
       data
     end
 
     # Create a new HTML template
-    # @param create_template_data1 
+    # @param create_html_template_data 
     # @param [Hash] opts the optional parameters
     # @return [Array<(PendingTemplate, Fixnum, Hash)>] PendingTemplate data, response status code and response headers
-    def create_html_template_with_http_info(create_template_data1, opts = {})
+    def create_html_template_with_http_info(create_html_template_data, opts = {})
       if @api_client.config.debugging
         @api_client.config.logger.debug 'Calling API: PDFApi.create_html_template ...'
       end
-      # verify the required parameter 'create_template_data1' is set
-      if @api_client.config.client_side_validation && create_template_data1.nil?
-        fail ArgumentError, "Missing the required parameter 'create_template_data1' when calling PDFApi.create_html_template"
+      # verify the required parameter 'create_html_template_data' is set
+      if @api_client.config.client_side_validation && create_html_template_data.nil?
+        fail ArgumentError, "Missing the required parameter 'create_html_template_data' when calling PDFApi.create_html_template"
       end
       # resource path
       local_var_path = '/templates?desc=html'
@@ -432,7 +491,7 @@ module DocSpring
       form_params = {}
 
       # http body (model)
-      post_body = @api_client.object_to_http_body(create_template_data1)
+      post_body = @api_client.object_to_http_body(create_html_template_data)
       auth_names = ['api_token_basic']
       data, status_code, headers = @api_client.call_api(:POST, local_var_path,
         :header_params => header_params,
@@ -512,25 +571,25 @@ module DocSpring
     end
 
     # 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]
-    def create_pdf_template_from_upload(create_template_data, opts = {})
-      data, _status_code, _headers = create_pdf_template_from_upload_with_http_info(create_template_data, opts)
+    def create_pdf_template_from_upload(create_template_from_upload_data, opts = {})
+      data, _status_code, _headers = create_pdf_template_from_upload_with_http_info(create_template_from_upload_data, opts)
       data
     end
 
     # 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 [Array<(PendingTemplate, Fixnum, Hash)>] PendingTemplate data, response status code and response headers
-    def create_pdf_template_from_upload_with_http_info(create_template_data, opts = {})
+    def create_pdf_template_from_upload_with_http_info(create_template_from_upload_data, opts = {})
       if @api_client.config.debugging
         @api_client.config.logger.debug 'Calling API: PDFApi.create_pdf_template_from_upload ...'
       end
-      # verify the required parameter 'create_template_data' is set
-      if @api_client.config.client_side_validation && create_template_data.nil?
-        fail ArgumentError, "Missing the required parameter 'create_template_data' when calling PDFApi.create_pdf_template_from_upload"
+      # verify the required parameter 'create_template_from_upload_data' is set
+      if @api_client.config.client_side_validation && create_template_from_upload_data.nil?
+        fail ArgumentError, "Missing the required parameter 'create_template_from_upload_data' when calling PDFApi.create_pdf_template_from_upload"
       end
       # resource path
       local_var_path = '/templates?desc=cached_upload'
@@ -549,7 +608,7 @@ module DocSpring
       form_params = {}
 
       # http body (model)
-      post_body = @api_client.object_to_http_body(create_template_data)
+      post_body = @api_client.object_to_http_body(create_template_from_upload_data)
       auth_names = ['api_token_basic']
       data, status_code, headers = @api_client.call_api(:POST, local_var_path,
         :header_params => header_params,

data/lib/docspring/models/add_fields_data.rb

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

data/lib/docspring/models/add_fields_template_response.rb

@@ -0,0 +1,239 @@
+=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 'date'
+
+module DocSpring
+  class AddFieldsTemplateResponse
+    attr_accessor :new_field_ids
+
+    attr_accessor :errors
+
+    attr_accessor :status
+
+    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
+      {
+        :'new_field_ids' => :'new_field_ids',
+        :'errors' => :'errors',
+        :'status' => :'status'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'new_field_ids' => :'Array<Integer>',
+        :'errors' => :'Array<String>',
+        :'status' => :'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?(:'new_field_ids')
+        if (value = attributes[:'new_field_ids']).is_a?(Array)
+          self.new_field_ids = value
+        end
+      end
+
+      if attributes.has_key?(:'errors')
+        if (value = attributes[:'errors']).is_a?(Array)
+          self.errors = value
+        end
+      end
+
+      if attributes.has_key?(:'status')
+        self.status = attributes[:'status']
+      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?
+      status_validator = EnumAttributeValidator.new('String', ['success', 'error'])
+      return false unless status_validator.valid?(@status)
+      true
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] status Object to be assigned
+    def status=(status)
+      validator = EnumAttributeValidator.new('String', ['success', 'error'])
+      unless validator.valid?(status)
+        fail ArgumentError, 'invalid value for "status", must be one of #{validator.allowable_values}.'
+      end
+      @status = status
+    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 &&
+          new_field_ids == o.new_field_ids &&
+          errors == o.errors &&
+          status == o.status
+    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
+      [new_field_ids, errors, status].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