docspring 3.0.0 → 3.1.0

data/lib/docspring/api/pdf_api.rb

@@ -914,7 +914,8 @@ module DocSpring
     # Delete a template
     # @param template_id [String] 
     # @param [Hash] opts the optional parameters
-    # @return [SuccessMultipleErrorsResponse]
+    # @option opts [String] :version 
+    # @return [TemplateDeleteResponse]
     def delete_template(template_id, opts = {})
       data, _status_code, _headers = delete_template_with_http_info(template_id, opts)
       data
@@ -923,7 +924,8 @@ module DocSpring
     # Delete a template
     # @param template_id [String] 
     # @param [Hash] opts the optional parameters
-    # @return [Array<(SuccessMultipleErrorsResponse, Integer, Hash)>] SuccessMultipleErrorsResponse data, response status code and response headers
+    # @option opts [String] :version 
+    # @return [Array<(TemplateDeleteResponse, Integer, Hash)>] TemplateDeleteResponse data, response status code and response headers
     def delete_template_with_http_info(template_id, opts = {})
       if @api_client.config.debugging
         @api_client.config.logger.debug 'Calling API: PDFApi.delete_template ...'
@@ -937,6 +939,7 @@ module DocSpring
 
       # query parameters
       query_params = opts[:query_params] || {}
+      query_params[:'version'] = opts[:'version'] if !opts[:'version'].nil?
 
       # header parameters
       header_params = opts[:header_params] || {}
@@ -950,7 +953,7 @@ module DocSpring
       post_body = opts[:debug_body]
 
       # return_type
-      return_type = opts[:debug_return_type] || 'SuccessMultipleErrorsResponse'
+      return_type = opts[:debug_return_type] || 'TemplateDeleteResponse'
 
       # auth_names
       auth_names = opts[:debug_auth_names] || ['api_token_basic']
@@ -1427,7 +1430,7 @@ module DocSpring
       return data, status_code, headers
     end
 
-    # Fetch the full template attributes
+    # Fetch the full attributes for a PDF template
     # @param template_id [String] 
     # @param [Hash] opts the optional parameters
     # @return [Template]
@@ -1436,7 +1439,7 @@ module DocSpring
       data
     end
 
-    # Fetch the full template attributes
+    # Fetch the full attributes for a PDF template
     # @param template_id [String] 
     # @param [Hash] opts the optional parameters
     # @return [Array<(Template, Integer, Hash)>] Template data, response status code and response headers
@@ -2299,6 +2302,78 @@ module DocSpring
       return data, status_code, headers
     end
 
+    # Publish a template version
+    # @param template_id [String] 
+    # @param data [PublishVersionData] 
+    # @param [Hash] opts the optional parameters
+    # @return [TemplatePublishVersionResponse]
+    def publish_template_version(template_id, data, opts = {})
+      data, _status_code, _headers = publish_template_version_with_http_info(template_id, data, opts)
+      data
+    end
+
+    # Publish a template version
+    # @param template_id [String] 
+    # @param data [PublishVersionData] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(TemplatePublishVersionResponse, Integer, Hash)>] TemplatePublishVersionResponse data, response status code and response headers
+    def publish_template_version_with_http_info(template_id, data, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: PDFApi.publish_template_version ...'
+      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.publish_template_version"
+      end
+      # verify the required parameter 'data' is set
+      if @api_client.config.client_side_validation && data.nil?
+        fail ArgumentError, "Missing the required parameter 'data' when calling PDFApi.publish_template_version"
+      end
+      # resource path
+      local_var_path = '/templates/{template_id}/publish_version'.sub('{' + 'template_id' + '}', CGI.escape(template_id.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
+      # HTTP header 'Content-Type'
+      content_type = @api_client.select_header_content_type(['application/json'])
+      if !content_type.nil?
+          header_params['Content-Type'] = content_type
+      end
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body] || @api_client.object_to_http_body(data)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'TemplatePublishVersionResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['api_token_basic']
+
+      new_options = opts.merge(
+        :operation => :"PDFApi.publish_template_version",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: PDFApi#publish_template_version\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Rename a folder
     # @param folder_id [String] 
     # @param data [RenameFolderData] 
@@ -2371,6 +2446,78 @@ module DocSpring
       return data, status_code, headers
     end
 
+    # Restore a template version
+    # @param template_id [String] 
+    # @param data [RestoreVersionData] 
+    # @param [Hash] opts the optional parameters
+    # @return [SuccessErrorResponse]
+    def restore_template_version(template_id, data, opts = {})
+      data, _status_code, _headers = restore_template_version_with_http_info(template_id, data, opts)
+      data
+    end
+
+    # Restore a template version
+    # @param template_id [String] 
+    # @param data [RestoreVersionData] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(SuccessErrorResponse, Integer, Hash)>] SuccessErrorResponse data, response status code and response headers
+    def restore_template_version_with_http_info(template_id, data, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: PDFApi.restore_template_version ...'
+      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.restore_template_version"
+      end
+      # verify the required parameter 'data' is set
+      if @api_client.config.client_side_validation && data.nil?
+        fail ArgumentError, "Missing the required parameter 'data' when calling PDFApi.restore_template_version"
+      end
+      # resource path
+      local_var_path = '/templates/{template_id}/restore_version'.sub('{' + 'template_id' + '}', CGI.escape(template_id.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
+      # HTTP header 'Content-Type'
+      content_type = @api_client.select_header_content_type(['application/json'])
+      if !content_type.nil?
+          header_params['Content-Type'] = content_type
+      end
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body] || @api_client.object_to_http_body(data)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'SuccessErrorResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['api_token_basic']
+
+      new_options = opts.merge(
+        :operation => :"PDFApi.restore_template_version",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: PDFApi#restore_template_version\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Test Authentication
     # @param [Hash] opts the optional parameters
     # @return [SuccessErrorResponse]

data/lib/docspring/api_client.rb

@@ -32,7 +32,7 @@ module DocSpring
     # @option config [Configuration] Configuration for initializing the object, default to Configuration.default
     def initialize(config = Configuration.default)
       @config = config
-      @user_agent = "docspring-ruby-3.0.0"
+      @user_agent = "docspring-ruby-3.1.0"
       @default_headers = {
         'Content-Type' => 'application/json',
         'User-Agent' => @user_agent

data/lib/docspring/models/combined_submission_action.rb

@@ -83,6 +83,7 @@ module DocSpring
       Set.new([
         :'id',
         :'integration_id',
+        :'action_type',
       ])
     end
 
@@ -147,10 +148,6 @@ module DocSpring
         invalid_properties.push('invalid value for "state", state cannot be nil.')
       end
 
-      if @action_type.nil?
-        invalid_properties.push('invalid value for "action_type", action_type cannot be nil.')
-      end
-
       if @action_category.nil?
         invalid_properties.push('invalid value for "action_category", action_category cannot be nil.')
       end
@@ -169,7 +166,6 @@ module DocSpring
       return false if @state.nil?
       state_validator = EnumAttributeValidator.new('String', ["pending", "processed", "failed", "error"])
       return false unless state_validator.valid?(@state)
-      return false if @action_type.nil?
       action_type_validator = EnumAttributeValidator.new('String', ["webhook", "slack_webhook", "email", "aws_s3_upload"])
       return false unless action_type_validator.valid?(@action_type)
       return false if @action_category.nil?

data/lib/docspring/models/create_html_submission_data.rb

@@ -33,6 +33,8 @@ module DocSpring
 
     attr_accessor :test
 
+    attr_accessor :version
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
@@ -44,7 +46,8 @@ module DocSpring
         :'html' => :'html',
         :'metadata' => :'metadata',
         :'password' => :'password',
-        :'test' => :'test'
+        :'test' => :'test',
+        :'version' => :'version'
       }
     end
 
@@ -64,7 +67,8 @@ module DocSpring
         :'html' => :'String',
         :'metadata' => :'Object',
         :'password' => :'String',
-        :'test' => :'Boolean'
+        :'test' => :'Boolean',
+        :'version' => :'String'
       }
     end
 
@@ -124,6 +128,10 @@ module DocSpring
       if attributes.key?(:'test')
         self.test = attributes[:'test']
       end
+
+      if attributes.key?(:'version')
+        self.version = attributes[:'version']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -154,7 +162,8 @@ module DocSpring
           html == o.html &&
           metadata == o.metadata &&
           password == o.password &&
-          test == o.test
+          test == o.test &&
+          version == o.version
     end
 
     # @see the `==` method
@@ -166,7 +175,7 @@ module DocSpring
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [css, data, editable, expires_in, field_overrides, html, metadata, password, test].hash
+      [css, data, editable, expires_in, field_overrides, html, metadata, password, test, version].hash
     end
 
     # Builds the object from hash

data/lib/docspring/models/create_pdf_submission_data.rb

@@ -31,6 +31,8 @@ module DocSpring
 
     attr_accessor :test
 
+    attr_accessor :version
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
@@ -41,7 +43,8 @@ module DocSpring
         :'field_overrides' => :'field_overrides',
         :'metadata' => :'metadata',
         :'password' => :'password',
-        :'test' => :'test'
+        :'test' => :'test',
+        :'version' => :'version'
       }
     end
 
@@ -60,7 +63,8 @@ module DocSpring
         :'field_overrides' => :'Object',
         :'metadata' => :'Object',
         :'password' => :'String',
-        :'test' => :'Boolean'
+        :'test' => :'Boolean',
+        :'version' => :'String'
       }
     end
 
@@ -120,6 +124,10 @@ module DocSpring
       if attributes.key?(:'test')
         self.test = attributes[:'test']
       end
+
+      if attributes.key?(:'version')
+        self.version = attributes[:'version']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -154,7 +162,8 @@ module DocSpring
           field_overrides == o.field_overrides &&
           metadata == o.metadata &&
           password == o.password &&
-          test == o.test
+          test == o.test &&
+          version == o.version
     end
 
     # @see the `==` method
@@ -166,7 +175,7 @@ module DocSpring
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [data, data_requests, editable, expires_in, field_overrides, metadata, password, test].hash
+      [data, data_requests, editable, expires_in, field_overrides, metadata, password, test, version].hash
     end
 
     # Builds the object from hash

data/lib/docspring/models/publish_version_data.rb

@@ -0,0 +1,230 @@
+=begin
+#DocSpring API
+
+#DocSpring provides an API that helps you fill out and sign PDF templates.
+
+The version of the OpenAPI document: v1
+
+Generated by: https://openapi-generator.tech
+Generator version: 7.11.0
+
+=end
+
+require 'date'
+require 'time'
+
+module DocSpring
+  class PublishVersionData
+    attr_accessor :description
+
+    attr_accessor :version_type
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'description' => :'description',
+        :'version_type' => :'version_type'
+      }
+    end
+
+    # Returns all the JSON keys this model knows about
+    def self.acceptable_attributes
+      attribute_map.values
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'description' => :'String',
+        :'version_type' => :'String'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+      ])
+    end
+
+    # Initializes the object
+    # @param [Hash] attributes Model attributes in the form of hash
+    def initialize(attributes = {})
+      if (!attributes.is_a?(Hash))
+        fail ArgumentError, "The input argument (attributes) must be a hash in `DocSpring::PublishVersionData` initialize method"
+      end
+
+      # check to see if the attribute exists and convert string to symbol for hash key
+      attributes = attributes.each_with_object({}) { |(k, v), h|
+        if (!self.class.attribute_map.key?(k.to_sym))
+          fail ArgumentError, "`#{k}` is not a valid attribute in `DocSpring::PublishVersionData`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
+        end
+        h[k.to_sym] = v
+      }
+
+      if attributes.key?(:'description')
+        self.description = attributes[:'description']
+      end
+
+      if attributes.key?(:'version_type')
+        self.version_type = attributes[:'version_type']
+      else
+        self.version_type = nil
+      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
+      warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
+      invalid_properties = Array.new
+      if @version_type.nil?
+        invalid_properties.push('invalid value for "version_type", version_type 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?
+      warn '[DEPRECATED] the `valid?` method is obsolete'
+      return false if @version_type.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 &&
+          description == o.description &&
+          version_type == o.version_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 [Integer] Hash code
+    def hash
+      [description, version_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 self.build_from_hash(attributes)
+      return nil unless attributes.is_a?(Hash)
+      attributes = attributes.transform_keys(&:to_sym)
+      transformed_hash = {}
+      openapi_types.each_pair do |key, type|
+        if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
+          transformed_hash["#{key}"] = nil
+        elsif type =~ /\AArray<(.*)>/i
+          # check to ensure the input is an array given that the attribute
+          # is documented as an array but the input is not
+          if attributes[attribute_map[key]].is_a?(Array)
+            transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
+          end
+        elsif !attributes[attribute_map[key]].nil?
+          transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
+        end
+      end
+      new(transformed_hash)
+    end
+
+    # Deserializes the data based on type
+    # @param string type Data type
+    # @param string value Value to be deserialized
+    # @return [Object] Deserialized data
+    def self._deserialize(type, value)
+      case type.to_sym
+      when :Time
+        Time.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
+        # models (e.g. Pet) or oneOf
+        klass = DocSpring.const_get(type)
+        klass.respond_to?(:openapi_any_of) || klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.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)
+        if value.nil?
+          is_nullable = self.class.openapi_nullable.include?(attr)
+          next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
+        end
+
+        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