docspring 3.5.0 → 4.1.0

data/lib/docspring/models/{create_pdf_submission_data.rb → create_submission_request.rb}

@@ -1,12 +1,12 @@
 =begin
 #DocSpring API
 
-#Use DocSpring's API to programmatically fill out PDF forms, convert HTML to PDFs, merge PDFs, or request legally binding e-signatures. Requests are rate limited per account, and live PDFs use credits: a request over the limit returns 429 with a Retry-After header, and one your credits can't cover returns 402. See [Credits & Rate Limits](https://docspring.com/docs/api-guide/credits-and-rate-limits/).
+#Use DocSpring's API to programmatically fill out PDF forms, convert HTML to PDFs, merge PDFs, or request legally binding e-signatures.
 
-The version of the OpenAPI document: v1
+The version of the OpenAPI document: v2
 
 Generated by: https://openapi-generator.tech
-Generator version: 7.16.0-DOCSPRING
+Generator version: 7.26.0-DOCSPRING
 
 =end
 
@@ -14,38 +14,55 @@ require 'date'
 require 'time'
 
 module DocSpring
-  class CreatePdfSubmissionData
+  # The submission's data and settings.
+  class CreateSubmissionRequest < ApiModelBase
+    # Test PDFs have a watermark and are free. Live PDFs use credits. Submissions made with a test API token are always test submissions.
+    attr_accessor :test
+
+    # `true` keeps the PDF's text and check fields fillable, and `false` flattens every field. Left out, the template decides: its `editable_submissions` setting, or each field's own Editable option. A response shows the template's setting when the request left this out. Can't be `true` with `signature_requests`.
+    attr_accessor :editable
+
+    # The values of the template's fields, by field name. Required for a PDF template, unless `signature_requests` collects the values.
     attr_accessor :data
 
-    attr_accessor :data_requests
+    # Your own data about the submission, such as an ID from your app. It isn't printed on the PDF.
+    attr_accessor :metadata
+
+    # A password that the PDF needs to be opened with. It's never returned; `has_password` says if it's set.
+    attr_accessor :password
 
-    attr_accessor :editable
+    # What the submission makes: `pdf`, and `png` (an image of each page of the PDF, up to 100 pages) when you ask for it. Default `["pdf"]`. POST /submissions/{submission_id}/generate_files adds `png` to a processed submission.
+    attr_accessor :output_formats
 
+    # Seconds after the PDF is generated until the submission expires, up to 10 years (315360000). Default the template's expiration setting. A submission that isn't processed, such as one with invalid data, is kept for at least 48 hours.
     attr_accessor :expires_in
 
+    # Changes to field settings for this submission only, by field name, such as `{"name": {"required": false, "font_size": 9}}`. A setting that identifies the field (`id`, `name`, `type`), that only the template sets (such as `description`), or that doesn't apply to the field's type and display type (such as `check_character` on a field displayed as text) is a 422. With `signature_requests`, `editable: true` is a 422, and a `default` for a signature or initials field makes the submission `invalid_data`.
     attr_accessor :field_overrides
 
-    attr_accessor :metadata
-
-    attr_accessor :password
+    # For an HTML template, HTML to use instead of the template's.
+    attr_accessor :html
 
-    # Generate a watermarked test PDF. Test PDFs are free; live PDFs (the default) use credits.
-    attr_accessor :test
+    # For an HTML template, CSS to use instead of the template's.
+    attr_accessor :css
 
-    attr_accessor :version
+    # The people who sign the PDF, and fill in their fields first. The PDF is generated once every signature request is completed. PDF templates only. Without `role`s, the first signature request is `Signer 1`, the second `Signer 2`, and so on. To leave a signer out, give every signature request its `role` and leave that one's out. Only the signers sign: a value for a signature or initials field in `data` makes the submission `invalid_data`.
+    attr_accessor :signature_requests
 
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
-        :'data' => :'data',
-        :'data_requests' => :'data_requests',
+        :'test' => :'test',
         :'editable' => :'editable',
-        :'expires_in' => :'expires_in',
-        :'field_overrides' => :'field_overrides',
+        :'data' => :'data',
         :'metadata' => :'metadata',
         :'password' => :'password',
-        :'test' => :'test',
-        :'version' => :'version'
+        :'output_formats' => :'output_formats',
+        :'expires_in' => :'expires_in',
+        :'field_overrides' => :'field_overrides',
+        :'html' => :'html',
+        :'css' => :'css',
+        :'signature_requests' => :'signature_requests'
       }
     end
 
@@ -62,15 +79,17 @@ module DocSpring
     # Attribute type mapping.
     def self.openapi_types
       {
-        :'data' => :'Object',
-        :'data_requests' => :'Array<CreateSubmissionDataRequestData>',
+        :'test' => :'Boolean',
         :'editable' => :'Boolean',
-        :'expires_in' => :'Integer',
-        :'field_overrides' => :'Object',
-        :'metadata' => :'Object',
+        :'data' => :'Hash<String, Object>',
+        :'metadata' => :'Hash<String, Object>',
         :'password' => :'String',
-        :'test' => :'Boolean',
-        :'version' => :'String'
+        :'output_formats' => :'Array<OutputFormat>',
+        :'expires_in' => :'Integer',
+        :'field_overrides' => :'Hash<String, FieldOverride>',
+        :'html' => :'String',
+        :'css' => :'String',
+        :'signature_requests' => :'Array<SignatureRequestInput>'
       }
     end
 
@@ -80,36 +99,60 @@ module DocSpring
       ])
     end
 
+    # Returns attribute type mapping
+    def self.acceptable_openapi_types
+      openapi_types
+    end
+
+    # Returns the nullable attributes
+    def self.acceptable_openapi_nullable
+      openapi_nullable
+    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::CreatePdfSubmissionData` initialize method"
+        fail ArgumentError, "The input argument (attributes) must be a hash in `DocSpring::CreateSubmissionRequest` initialize method"
       end
 
       # check to see if the attribute exists and convert string to symbol for hash key
       acceptable_attribute_map = self.class.acceptable_attribute_map
       attributes = attributes.each_with_object({}) { |(k, v), h|
         if (!acceptable_attribute_map.key?(k.to_sym))
-          fail ArgumentError, "`#{k}` is not a valid attribute in `DocSpring::CreatePdfSubmissionData`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
+          fail ArgumentError, "`#{k}` is not a valid attribute in `DocSpring::CreateSubmissionRequest`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
         end
         h[k.to_sym] = v
       }
 
+      if attributes.key?(:'test')
+        self.test = attributes[:'test']
+      end
+
+      if attributes.key?(:'editable')
+        self.editable = attributes[:'editable']
+      end
+
       if attributes.key?(:'data')
-        self.data = attributes[:'data']
-      else
-        self.data = nil
+        if (value = attributes[:'data']).is_a?(Hash)
+          self.data = value
+        end
       end
 
-      if attributes.key?(:'data_requests')
-        if (value = attributes[:'data_requests']).is_a?(Array)
-          self.data_requests = value
+      if attributes.key?(:'metadata')
+        if (value = attributes[:'metadata']).is_a?(Hash)
+          self.metadata = value
         end
       end
 
-      if attributes.key?(:'editable')
-        self.editable = attributes[:'editable']
+      if attributes.key?(:'password')
+        self.password = attributes[:'password']
+      end
+
+      if attributes.key?(:'output_formats')
+        if (value = attributes[:'output_formats']).is_a?(Array)
+          self.output_formats = value
+        end
       end
 
       if attributes.key?(:'expires_in')
@@ -117,23 +160,23 @@ module DocSpring
       end
 
       if attributes.key?(:'field_overrides')
-        self.field_overrides = attributes[:'field_overrides']
-      end
-
-      if attributes.key?(:'metadata')
-        self.metadata = attributes[:'metadata']
+        if (value = attributes[:'field_overrides']).is_a?(Hash)
+          self.field_overrides = value
+        end
       end
 
-      if attributes.key?(:'password')
-        self.password = attributes[:'password']
+      if attributes.key?(:'html')
+        self.html = attributes[:'html']
       end
 
-      if attributes.key?(:'test')
-        self.test = attributes[:'test']
+      if attributes.key?(:'css')
+        self.css = attributes[:'css']
       end
 
-      if attributes.key?(:'version')
-        self.version = attributes[:'version']
+      if attributes.key?(:'signature_requests')
+        if (value = attributes[:'signature_requests']).is_a?(Array)
+          self.signature_requests = value
+        end
       end
     end
 
@@ -142,10 +185,6 @@ module DocSpring
     def list_invalid_properties
       warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
       invalid_properties = Array.new
-      if @data.nil?
-        invalid_properties.push('invalid value for "data", data cannot be nil.')
-      end
-
       invalid_properties
     end
 
@@ -153,18 +192,17 @@ module DocSpring
     # @return true if the model is valid
     def valid?
       warn '[DEPRECATED] the `valid?` method is obsolete'
-      return false if @data.nil?
       true
     end
 
     # Custom attribute writer method with validation
-    # @param [Object] data Value to be assigned
-    def data=(data)
-      if data.nil?
-        fail ArgumentError, 'data cannot be nil'
+    # @param [Object] output_formats Value to be assigned
+    def output_formats=(output_formats)
+      if output_formats.nil?
+        fail ArgumentError, 'output_formats cannot be nil'
       end
 
-      @data = data
+      @output_formats = output_formats
     end
 
     # Checks equality by comparing each attribute.
@@ -172,15 +210,17 @@ module DocSpring
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
-          data == o.data &&
-          data_requests == o.data_requests &&
+          test == o.test &&
           editable == o.editable &&
-          expires_in == o.expires_in &&
-          field_overrides == o.field_overrides &&
+          data == o.data &&
           metadata == o.metadata &&
           password == o.password &&
-          test == o.test &&
-          version == o.version
+          output_formats == o.output_formats &&
+          expires_in == o.expires_in &&
+          field_overrides == o.field_overrides &&
+          html == o.html &&
+          css == o.css &&
+          signature_requests == o.signature_requests
     end
 
     # @see the `==` method
@@ -192,7 +232,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, version].hash
+      [test, editable, data, metadata, password, output_formats, expires_in, field_overrides, html, css, signature_requests].hash
     end
 
     # Builds the object from hash
@@ -201,18 +241,20 @@ module DocSpring
     def self.build_from_hash(attributes)
       return nil unless attributes.is_a?(Hash)
       attributes = attributes.transform_keys(&:to_sym)
+      # include attributes inherited from allOf parents (the nearest declaration wins)
+      map = acceptable_attribute_map
       transformed_hash = {}
-      openapi_types.each_pair do |key, type|
-        if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
+      acceptable_openapi_types.each_pair do |key, type|
+        if attributes.key?(map[key]) && attributes[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) }
+          if attributes[map[key]].is_a?(Array)
+            transformed_hash["#{key}"] = attributes[map[key]].map { |v| _deserialize($1, v) }
           end
-        elsif !attributes[attribute_map[key]].nil?
-          transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
+        elsif !attributes[map[key]].nil?
+          transformed_hash["#{key}"] = _deserialize(type, attributes[map[key]])
         end
       end
       # Responses can include enum values added after this client was released, so the enum setters
@@ -224,69 +266,15 @@ module DocSpring
       end
     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|
+      # include attributes inherited from allOf parents (the nearest declaration wins)
+      self.class.acceptable_attribute_map.each_pair do |attr, param|
         value = self.send(attr)
         if value.nil?
-          is_nullable = self.class.openapi_nullable.include?(attr)
+          is_nullable = self.class.acceptable_openapi_nullable.include?(attr)
           next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
         end
 
@@ -295,24 +283,6 @@ module DocSpring
       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