docspring 4.0.0 → 4.1.0

data/lib/docspring/models/submission.rb

@@ -67,7 +67,10 @@ module DocSpring
     # The text of each field that didn't fit in it, by field name. Left out (null) with `data`, and empty once the submission has expired.
     attr_accessor :truncated_text
 
-    # The generated files: `pdf` once the submission has been processed, `audit_trail` once its signature requests are completed, and `preview` once a preview PDF has been generated. Empty once the submission has expired.
+    # 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
+
+    # The generated files: `pdf` once the submission has been processed, `png` (the images of the PDF's pages, when `output_formats` has it: `files.png.pages[0]` is page 1), `audit_trail` once its signature requests are completed, and `preview` once a preview PDF has been generated. Empty once the submission has expired.
     attr_accessor :files
 
     # When the preview PDF was generated. Null if there is no preview.
@@ -130,6 +133,7 @@ module DocSpring
         :'signature_requests' => :'signature_requests',
         :'actions' => :'actions',
         :'truncated_text' => :'truncated_text',
+        :'output_formats' => :'output_formats',
         :'files' => :'files',
         :'preview_generated_at' => :'preview_generated_at',
         :'expired' => :'expired',
@@ -170,6 +174,7 @@ module DocSpring
         :'signature_requests' => :'Array<SignatureRequest>',
         :'actions' => :'Array<SubmissionAction>',
         :'truncated_text' => :'Hash<String, Array<String>>',
+        :'output_formats' => :'Array<OutputFormat>',
         :'files' => :'SubmissionFiles',
         :'preview_generated_at' => :'Time',
         :'expired' => :'Boolean',
@@ -335,6 +340,14 @@ module DocSpring
         self.truncated_text = nil
       end
 
+      if attributes.key?(:'output_formats')
+        if (value = attributes[:'output_formats']).is_a?(Array)
+          self.output_formats = value
+        end
+      else
+        self.output_formats = nil
+      end
+
       if attributes.key?(:'files')
         self.files = attributes[:'files']
       else
@@ -427,6 +440,10 @@ module DocSpring
         invalid_properties.push('invalid value for "actions", actions cannot be nil.')
       end
 
+      if @output_formats.nil?
+        invalid_properties.push('invalid value for "output_formats", output_formats cannot be nil.')
+      end
+
       if @files.nil?
         invalid_properties.push('invalid value for "files", files cannot be nil.')
       end
@@ -461,6 +478,7 @@ module DocSpring
       return false if @has_password.nil?
       return false if @signature_requests.nil?
       return false if @actions.nil?
+      return false if @output_formats.nil?
       return false if @files.nil?
       return false if @expired.nil?
       return false if @created_at.nil?
@@ -578,6 +596,16 @@ module DocSpring
       @actions = actions
     end
 
+    # Custom attribute writer method with validation
+    # @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
+
+      @output_formats = output_formats
+    end
+
     # Custom attribute writer method with validation
     # @param [Object] files Value to be assigned
     def files=(files)
@@ -640,6 +668,7 @@ module DocSpring
           signature_requests == o.signature_requests &&
           actions == o.actions &&
           truncated_text == o.truncated_text &&
+          output_formats == o.output_formats &&
           files == o.files &&
           preview_generated_at == o.preview_generated_at &&
           expired == o.expired &&
@@ -658,7 +687,7 @@ module DocSpring
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [id, template_id, template_type, template_version, batch_id, source, state, test, editable, data, data_errors, error_message, metadata, has_password, signature_requests, actions, truncated_text, files, preview_generated_at, expired, expires_at, processed_at, created_at, updated_at].hash
+      [id, template_id, template_type, template_version, batch_id, source, state, test, editable, data, data_errors, error_message, metadata, has_password, signature_requests, actions, truncated_text, output_formats, files, preview_generated_at, expired, expires_at, processed_at, created_at, updated_at].hash
     end
 
     # Builds the object from hash

data/lib/docspring/models/submission_files.rb

@@ -25,12 +25,15 @@ module DocSpring
     # The preview PDF from POST /submissions/{submission_id}/generate_preview, such as for a submission still waiting for its signature requests.
     attr_accessor :preview
 
+    attr_accessor :png
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
         :'pdf' => :'pdf',
         :'audit_trail' => :'audit_trail',
-        :'preview' => :'preview'
+        :'preview' => :'preview',
+        :'png' => :'png'
       }
     end
 
@@ -49,7 +52,8 @@ module DocSpring
       {
         :'pdf' => :'GeneratedFile',
         :'audit_trail' => :'GeneratedFile',
-        :'preview' => :'GeneratedFile'
+        :'preview' => :'GeneratedFile',
+        :'png' => :'PageImages'
       }
     end
 
@@ -96,6 +100,10 @@ module DocSpring
       if attributes.key?(:'preview')
         self.preview = attributes[:'preview']
       end
+
+      if attributes.key?(:'png')
+        self.png = attributes[:'png']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -120,7 +128,8 @@ module DocSpring
       self.class == o.class &&
           pdf == o.pdf &&
           audit_trail == o.audit_trail &&
-          preview == o.preview
+          preview == o.preview &&
+          png == o.png
     end
 
     # @see the `==` method
@@ -132,7 +141,7 @@ module DocSpring
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [pdf, audit_trail, preview].hash
+      [pdf, audit_trail, preview, png].hash
     end
 
     # Builds the object from hash

data/lib/docspring/models/submission_input.rb

@@ -31,6 +31,9 @@ module DocSpring
     # A password that the PDF needs to be opened with. It's never returned; `has_password` says if it's set.
     attr_accessor :password
 
+    # 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
 
@@ -57,6 +60,7 @@ module DocSpring
         :'data' => :'data',
         :'metadata' => :'metadata',
         :'password' => :'password',
+        :'output_formats' => :'output_formats',
         :'expires_in' => :'expires_in',
         :'field_overrides' => :'field_overrides',
         :'html' => :'html',
@@ -84,6 +88,7 @@ module DocSpring
         :'data' => :'Hash<String, Object>',
         :'metadata' => :'Hash<String, Object>',
         :'password' => :'String',
+        :'output_formats' => :'Array<OutputFormat>',
         :'expires_in' => :'Integer',
         :'field_overrides' => :'Hash<String, FieldOverride>',
         :'html' => :'String',
@@ -149,6 +154,12 @@ module DocSpring
         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')
         self.expires_in = attributes[:'expires_in']
       end
@@ -191,6 +202,16 @@ module DocSpring
       true
     end
 
+    # Custom attribute writer method with validation
+    # @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
+
+      @output_formats = output_formats
+    end
+
     # Checks equality by comparing each attribute.
     # @param [Object] Object to be compared
     def ==(o)
@@ -201,6 +222,7 @@ module DocSpring
           data == o.data &&
           metadata == o.metadata &&
           password == o.password &&
+          output_formats == o.output_formats &&
           expires_in == o.expires_in &&
           field_overrides == o.field_overrides &&
           html == o.html &&
@@ -218,7 +240,7 @@ module DocSpring
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [test, editable, data, metadata, password, expires_in, field_overrides, html, css, template_id, template_version].hash
+      [test, editable, data, metadata, password, output_formats, expires_in, field_overrides, html, css, template_id, template_version].hash
     end
 
     # Builds the object from hash

data/lib/docspring/models/submission_validation.rb

@@ -0,0 +1,234 @@
+=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.
+
+The version of the OpenAPI document: v2
+
+Generated by: https://openapi-generator.tech
+Generator version: 7.26.0-DOCSPRING
+
+=end
+
+require 'date'
+require 'time'
+
+module DocSpring
+  # Whether creating the submission would succeed, checked without saving it or making any files. `error` is the error that creating it would return (`validation_failed`, or `invalid_data` for data that doesn't match the template's fields), and is left out when `valid` is true.
+  class SubmissionValidation < ApiModelBase
+    # True when creating the submission would succeed.
+    attr_accessor :valid
+
+    # The template's ID.
+    attr_accessor :template_id
+
+    # The published version the request was checked against, such as `1.2.0`. Null for the draft.
+    attr_accessor :template_version
+
+    attr_accessor :error
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'valid' => :'valid',
+        :'template_id' => :'template_id',
+        :'template_version' => :'template_version',
+        :'error' => :'error'
+      }
+    end
+
+    # Returns attribute mapping this model knows about
+    def self.acceptable_attribute_map
+      attribute_map
+    end
+
+    # Returns all the JSON keys this model knows about
+    def self.acceptable_attributes
+      acceptable_attribute_map.values
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'valid' => :'Boolean',
+        :'template_id' => :'String',
+        :'template_version' => :'String',
+        :'error' => :'ErrorInfo'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'template_version',
+      ])
+    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::SubmissionValidation` 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::SubmissionValidation`. 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?(:'valid')
+        self.valid = attributes[:'valid']
+      else
+        self.valid = nil
+      end
+
+      if attributes.key?(:'template_id')
+        self.template_id = attributes[:'template_id']
+      else
+        self.template_id = nil
+      end
+
+      if attributes.key?(:'template_version')
+        self.template_version = attributes[:'template_version']
+      else
+        self.template_version = nil
+      end
+
+      if attributes.key?(:'error')
+        self.error = attributes[:'error']
+      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 @valid.nil?
+        invalid_properties.push('invalid value for "valid", valid cannot be nil.')
+      end
+
+      if @template_id.nil?
+        invalid_properties.push('invalid value for "template_id", template_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?
+      warn '[DEPRECATED] the `valid?` method is obsolete'
+      return false if @valid.nil?
+      return false if @template_id.nil?
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] valid Value to be assigned
+    def valid=(valid)
+      if valid.nil?
+        fail ArgumentError, 'valid cannot be nil'
+      end
+
+      @valid = valid
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] template_id Value to be assigned
+    def template_id=(template_id)
+      if template_id.nil?
+        fail ArgumentError, 'template_id cannot be nil'
+      end
+
+      @template_id = template_id
+    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 &&
+          valid == o.valid &&
+          template_id == o.template_id &&
+          template_version == o.template_version &&
+          error == o.error
+    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
+      [valid, template_id, template_version, error].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)
+      # include attributes inherited from allOf parents (the nearest declaration wins)
+      map = acceptable_attribute_map
+      transformed_hash = {}
+      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[map[key]].is_a?(Array)
+            transformed_hash["#{key}"] = attributes[map[key]].map { |v| _deserialize($1, v) }
+          end
+        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
+      # accept any value while the model is built from a response
+      allocate.tap do |model|
+        model.instance_variable_set(:@_skip_enum_validation, true)
+        model.send(:initialize, transformed_hash)
+        model.remove_instance_variable(:@_skip_enum_validation)
+      end
+    end
+
+    # Returns the object in the form of hash
+    # @return [Hash] Returns the object in the form of hash
+    def to_hash
+      hash = {}
+      # 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.acceptable_openapi_nullable.include?(attr)
+          next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
+        end
+
+        hash[param] = _to_hash(value)
+      end
+      hash
+    end
+
+  end
+
+end

data/lib/docspring/models/template.rb

@@ -132,6 +132,15 @@ module DocSpring
     # Conditional logic: each rule shows or hides its target fields, or makes them required, depending on the values of other fields.
     attr_accessor :field_dependencies
 
+    # The groups of the template's fields, with their settings. A field's name puts it in groups: `address/city` is in the group `address`, and `items/0/price` is in the list `items` and its items' group `items/~`.
+    attr_accessor :field_groups
+
+    # The field names that people using the embedded template editor choose from, each with the data type and settings a field gets when it's given that name. Setting it replaces the whole list; an empty list turns them off.
+    attr_accessor :predefined_fields
+
+    # Sample submission data that sets `predefined_fields`: each value becomes a predefined field, with a type that fits it (`string`, `number`, `boolean`, `date`, `email` or `url`) and `required_in_template` true. Nested objects and arrays become names with `/`, such as `customer/email`. Without `predefined_fields` in the same request, it replaces them; with them, it adds to them and sets the types of the ones it has values for.
+    attr_accessor :predefined_fields_sample_data
+
     # The HTML of an HTML template, as a Liquid template. Null for PDF templates.
     attr_accessor :html
 
@@ -217,6 +226,9 @@ module DocSpring
         :'updated_at' => :'updated_at',
         :'defaults' => :'defaults',
         :'field_dependencies' => :'field_dependencies',
+        :'field_groups' => :'field_groups',
+        :'predefined_fields' => :'predefined_fields',
+        :'predefined_fields_sample_data' => :'predefined_fields_sample_data',
         :'html' => :'html',
         :'scss' => :'scss',
         :'header_html' => :'header_html',
@@ -279,6 +291,9 @@ module DocSpring
         :'updated_at' => :'Time',
         :'defaults' => :'TemplateDefaults',
         :'field_dependencies' => :'Array<TemplateFieldDependency>',
+        :'field_groups' => :'Array<FieldGroup>',
+        :'predefined_fields' => :'Array<PredefinedField>',
+        :'predefined_fields_sample_data' => :'Hash<String, Object>',
         :'html' => :'String',
         :'scss' => :'String',
         :'header_html' => :'String',
@@ -303,6 +318,7 @@ module DocSpring
         :'redirect_url',
         :'last_changed_at',
         :'last_changed_by',
+        :'predefined_fields_sample_data',
         :'html',
         :'scss',
         :'header_html',
@@ -576,6 +592,30 @@ module DocSpring
         self.field_dependencies = nil
       end
 
+      if attributes.key?(:'field_groups')
+        if (value = attributes[:'field_groups']).is_a?(Array)
+          self.field_groups = value
+        end
+      else
+        self.field_groups = nil
+      end
+
+      if attributes.key?(:'predefined_fields')
+        if (value = attributes[:'predefined_fields']).is_a?(Array)
+          self.predefined_fields = value
+        end
+      else
+        self.predefined_fields = nil
+      end
+
+      if attributes.key?(:'predefined_fields_sample_data')
+        if (value = attributes[:'predefined_fields_sample_data']).is_a?(Hash) || value.nil?
+          self.predefined_fields_sample_data = value
+        end
+      else
+        self.predefined_fields_sample_data = nil
+      end
+
       if attributes.key?(:'html')
         self.html = attributes[:'html']
       else
@@ -738,6 +778,14 @@ module DocSpring
         invalid_properties.push('invalid value for "field_dependencies", field_dependencies cannot be nil.')
       end
 
+      if @field_groups.nil?
+        invalid_properties.push('invalid value for "field_groups", field_groups cannot be nil.')
+      end
+
+      if @predefined_fields.nil?
+        invalid_properties.push('invalid value for "predefined_fields", predefined_fields cannot be nil.')
+      end
+
       if @versions.nil?
         invalid_properties.push('invalid value for "versions", versions cannot be nil.')
       end
@@ -777,6 +825,8 @@ module DocSpring
       return false if @updated_at.nil?
       return false if @defaults.nil?
       return false if @field_dependencies.nil?
+      return false if @field_groups.nil?
+      return false if @predefined_fields.nil?
       return false if @versions.nil?
       true
     end
@@ -1061,6 +1111,26 @@ module DocSpring
       @field_dependencies = field_dependencies
     end
 
+    # Custom attribute writer method with validation
+    # @param [Object] field_groups Value to be assigned
+    def field_groups=(field_groups)
+      if field_groups.nil?
+        fail ArgumentError, 'field_groups cannot be nil'
+      end
+
+      @field_groups = field_groups
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] predefined_fields Value to be assigned
+    def predefined_fields=(predefined_fields)
+      if predefined_fields.nil?
+        fail ArgumentError, 'predefined_fields cannot be nil'
+      end
+
+      @predefined_fields = predefined_fields
+    end
+
     # Custom attribute writer method with validation
     # @param [Object] versions Value to be assigned
     def versions=(versions)
@@ -1115,6 +1185,9 @@ module DocSpring
           updated_at == o.updated_at &&
           defaults == o.defaults &&
           field_dependencies == o.field_dependencies &&
+          field_groups == o.field_groups &&
+          predefined_fields == o.predefined_fields &&
+          predefined_fields_sample_data == o.predefined_fields_sample_data &&
           html == o.html &&
           scss == o.scss &&
           header_html == o.header_html &&
@@ -1133,7 +1206,7 @@ module DocSpring
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [id, name, description, template_type, ready, document, parent_folder_id, path, version, latest_version, version_published_at, locked, add_signature_request_submission_id_footers, ai_field_naming_language, allow_additional_properties, allow_skipping_optional_fields, default_form_mode, editable_submissions, embed_domains, embed_edit_allow_settings, embed_edit_allow_versioning, embed_edit_allow_document_replacement, encrypt_pdfs, has_encrypt_pdfs_password, expire_submissions, expire_after, expiration_interval, merge_audit_trail_pdf, parse_dates_using_template_date_format, public_submissions, public_web_form, redirect_url, has_slack_webhook_url, last_changed_at, last_changed_by, created_at, updated_at, defaults, field_dependencies, html, scss, header_html, footer_html, html_engine_options, embed_edit_token, versions].hash
+      [id, name, description, template_type, ready, document, parent_folder_id, path, version, latest_version, version_published_at, locked, add_signature_request_submission_id_footers, ai_field_naming_language, allow_additional_properties, allow_skipping_optional_fields, default_form_mode, editable_submissions, embed_domains, embed_edit_allow_settings, embed_edit_allow_versioning, embed_edit_allow_document_replacement, encrypt_pdfs, has_encrypt_pdfs_password, expire_submissions, expire_after, expiration_interval, merge_audit_trail_pdf, parse_dates_using_template_date_format, public_submissions, public_web_form, redirect_url, has_slack_webhook_url, last_changed_at, last_changed_by, created_at, updated_at, defaults, field_dependencies, field_groups, predefined_fields, predefined_fields_sample_data, html, scss, header_html, footer_html, html_engine_options, embed_edit_token, versions].hash
     end
 
     # Builds the object from hash