docspring 4.3.0 → 4.4.0

data/lib/docspring/models/signature_request_input.rb

@@ -19,7 +19,7 @@ module DocSpring
     # The name of the person the request is for.
     attr_accessor :name
 
-    # Their email address.
+    # Their email address. Null when they have none.
     attr_accessor :email
 
     # The fields this person fills in. Each field can only be in one signature request, and a field that `data` fills in needs `prefilled_values_editable`.
@@ -61,6 +61,12 @@ module DocSpring
     # Let the person change the values that `data` already has for fields in `fields`. Without it, those fields are a 422.
     attr_accessor :prefilled_values_editable
 
+    # Whether DocSpring emails this person their signing link. Default: the submission's `send_email`. Set it to false for someone who signs in your app (embedded signing) or whose link you send yourself. When DocSpring emails them, `email` is required and `auth_type` is `email_link` (the default). Otherwise `auth_type` is required.
+    attr_accessor :send_email
+
+    # When this person signs, with `signing_order: sequential`: everyone in step 1 first, then step 2, and so on. People in the same step sign in any order. Only the order of the numbers matters. Either every signature request has a `signing_step` or none does; without them, each person is a step of their own, in the order of `signature_requests`.
+    attr_accessor :signing_step
+
     class EnumAttributeValidator
       attr_reader :datatype
       attr_reader :allowable_values
@@ -100,7 +106,9 @@ module DocSpring
         :'auth_username_hash' => :'auth_username_hash',
         :'auth_phone_number_hash' => :'auth_phone_number_hash',
         :'ignore_unknown_fields' => :'ignore_unknown_fields',
-        :'prefilled_values_editable' => :'prefilled_values_editable'
+        :'prefilled_values_editable' => :'prefilled_values_editable',
+        :'send_email' => :'send_email',
+        :'signing_step' => :'signing_step'
       }
     end
 
@@ -131,7 +139,9 @@ module DocSpring
         :'auth_username_hash' => :'String',
         :'auth_phone_number_hash' => :'String',
         :'ignore_unknown_fields' => :'Boolean',
-        :'prefilled_values_editable' => :'Boolean'
+        :'prefilled_values_editable' => :'Boolean',
+        :'send_email' => :'Boolean',
+        :'signing_step' => :'Integer'
       }
     end
 
@@ -203,8 +213,6 @@ module DocSpring
 
       if attributes.key?(:'auth_type')
         self.auth_type = attributes[:'auth_type']
-      else
-        self.auth_type = nil
       end
 
       if attributes.key?(:'auth_second_factor_type')
@@ -242,6 +250,14 @@ module DocSpring
       if attributes.key?(:'prefilled_values_editable')
         self.prefilled_values_editable = attributes[:'prefilled_values_editable']
       end
+
+      if attributes.key?(:'send_email')
+        self.send_email = attributes[:'send_email']
+      end
+
+      if attributes.key?(:'signing_step')
+        self.signing_step = attributes[:'signing_step']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -253,10 +269,6 @@ module DocSpring
         invalid_properties.push('invalid value for "fields", fields cannot be nil.')
       end
 
-      if @auth_type.nil?
-        invalid_properties.push('invalid value for "auth_type", auth_type cannot be nil.')
-      end
-
       invalid_properties
     end
 
@@ -265,7 +277,6 @@ module DocSpring
     def valid?
       warn '[DEPRECATED] the `valid?` method is obsolete'
       return false if @fields.nil?
-      return false if @auth_type.nil?
       true
     end
 
@@ -279,16 +290,6 @@ module DocSpring
       @fields = fields
     end
 
-    # Custom attribute writer method with validation
-    # @param [Object] auth_type Value to be assigned
-    def auth_type=(auth_type)
-      if auth_type.nil?
-        fail ArgumentError, 'auth_type cannot be nil'
-      end
-
-      @auth_type = auth_type
-    end
-
     # Checks equality by comparing each attribute.
     # @param [Object] Object to be compared
     def ==(o)
@@ -308,7 +309,9 @@ module DocSpring
           auth_username_hash == o.auth_username_hash &&
           auth_phone_number_hash == o.auth_phone_number_hash &&
           ignore_unknown_fields == o.ignore_unknown_fields &&
-          prefilled_values_editable == o.prefilled_values_editable
+          prefilled_values_editable == o.prefilled_values_editable &&
+          send_email == o.send_email &&
+          signing_step == o.signing_step
     end
 
     # @see the `==` method
@@ -320,7 +323,7 @@ module DocSpring
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [name, email, fields, metadata, role, auth_type, auth_second_factor_type, auth_provider, auth_session_started_at, auth_session_id_hash, auth_user_id_hash, auth_username_hash, auth_phone_number_hash, ignore_unknown_fields, prefilled_values_editable].hash
+      [name, email, fields, metadata, role, auth_type, auth_second_factor_type, auth_provider, auth_session_started_at, auth_session_id_hash, auth_user_id_hash, auth_username_hash, auth_phone_number_hash, ignore_unknown_fields, prefilled_values_editable, send_email, signing_step].hash
     end
 
     # Builds the object from hash

data/lib/docspring/models/signature_request_reminders.rb

@@ -0,0 +1,212 @@
+=begin
+#DocSpring API
+
+#Use DocSpring's API to fill PDF forms, generate PDFs and Word documents from HTML or Word templates, merge PDFs, and 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
+  # How often DocSpring reminds people who haven't signed.
+  class SignatureRequestReminders < ApiModelBase
+    # Days between reminders.
+    attr_accessor :interval_days
+
+    # The most reminders each person gets.
+    attr_accessor :max_count
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'interval_days' => :'interval_days',
+        :'max_count' => :'max_count'
+      }
+    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
+      {
+        :'interval_days' => :'Integer',
+        :'max_count' => :'Integer'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+      ])
+    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::SignatureRequestReminders` 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::SignatureRequestReminders`. 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?(:'interval_days')
+        self.interval_days = attributes[:'interval_days']
+      else
+        self.interval_days = nil
+      end
+
+      if attributes.key?(:'max_count')
+        self.max_count = attributes[:'max_count']
+      else
+        self.max_count = 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 @interval_days.nil?
+        invalid_properties.push('invalid value for "interval_days", interval_days cannot be nil.')
+      end
+
+      if @max_count.nil?
+        invalid_properties.push('invalid value for "max_count", max_count 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 @interval_days.nil?
+      return false if @max_count.nil?
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] interval_days Value to be assigned
+    def interval_days=(interval_days)
+      if interval_days.nil?
+        fail ArgumentError, 'interval_days cannot be nil'
+      end
+
+      @interval_days = interval_days
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] max_count Value to be assigned
+    def max_count=(max_count)
+      if max_count.nil?
+        fail ArgumentError, 'max_count cannot be nil'
+      end
+
+      @max_count = max_count
+    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 &&
+          interval_days == o.interval_days &&
+          max_count == o.max_count
+    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
+      [interval_days, max_count].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/signing_order.rb

@@ -0,0 +1,41 @@
+=begin
+#DocSpring API
+
+#Use DocSpring's API to fill PDF forms, generate PDFs and Word documents from HTML or Word templates, merge PDFs, and 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
+  class SigningOrder
+    PARALLEL = "parallel".freeze
+    SEQUENTIAL = "sequential".freeze
+
+    def self.all_vars
+      @all_vars ||= [PARALLEL, SEQUENTIAL].freeze
+    end
+
+    # Builds the enum from string
+    # @param [String] The enum value in the form of the string
+    # @return [String] The enum value
+    def self.build_from_hash(value)
+      new.build_from_hash(value)
+    end
+
+    # Builds the enum from string
+    # @param [String] The enum value in the form of the string
+    # @return [String] The enum value
+    def build_from_hash(value)
+      # Only responses are built from hashes, and a value added to the API after this client was released is kept as it
+      # is: the constants are the values this client knows
+      value
+    end
+  end
+end

data/lib/docspring/models/string_condition_type.rb

@@ -16,13 +16,20 @@ require 'time'
 module DocSpring
   class StringConditionType
     EQUALS = "equals".freeze
+    NOT_EQUALS = "not_equals".freeze
     CONTAINS = "contains".freeze
+    NOT_CONTAINS = "not_contains".freeze
     STARTS_WITH = "starts_with".freeze
+    NOT_STARTS_WITH = "not_starts_with".freeze
     ENDS_WITH = "ends_with".freeze
+    NOT_ENDS_WITH = "not_ends_with".freeze
     REGEX = "regex".freeze
+    NOT_REGEX = "not_regex".freeze
+    BLANK = "blank".freeze
+    NOT_BLANK = "not_blank".freeze
 
     def self.all_vars
-      @all_vars ||= [EQUALS, CONTAINS, STARTS_WITH, ENDS_WITH, REGEX].freeze
+      @all_vars ||= [EQUALS, NOT_EQUALS, CONTAINS, NOT_CONTAINS, STARTS_WITH, NOT_STARTS_WITH, ENDS_WITH, NOT_ENDS_WITH, REGEX, NOT_REGEX, BLANK, NOT_BLANK].freeze
     end
 
     # Builds the enum from string

data/lib/docspring/models/submission.rb

@@ -37,7 +37,7 @@ module DocSpring
     # `pending` until the files have been generated, then `processed`. `waiting_for_signature_requests` until every signature request is completed. `insufficient_credits`: waiting for credits; `error_message` says whether the files are generated once you add them. `account_suspended`: waiting for the account to be reactivated, for up to 30 days. Waiting ends in `error` if it's discarded or takes over 30 days. Every other state is final, with no files: `invalid_data` (the data doesn't match the template's fields: see `data_errors`), `declined` (a signature request was declined), and the states where generating the files failed, which have an `error_message`: `syntax_error` (a mistake in an HTML template's Liquid or SCSS, or in a Word template's tags), `image_download_failed` or `image_processing_failed` (an image in the data or the template couldn't be downloaded or read) and `error` (anything else). Older submissions can also be `license_revoked` or `accidental`.
     attr_accessor :state
 
-    # Test PDFs have a watermark and are free. Live PDFs use credits. Submissions made with a test API token are always test submissions.
+    # Test PDFs have a watermark and are free. Live PDFs use credits. Submissions made with a test API token are always test submissions, and the demo API token's are always live.
     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`.
@@ -79,7 +79,10 @@ module DocSpring
     # The people asked to sign the submission (and fill in their fields), in order.
     attr_accessor :signature_requests
 
-    # The uploads of the submission's PDF to your storage (account integrations).
+    # `parallel`: everyone can sign at once. `sequential`: people sign one step at a time (each signature request's `signing_step`).
+    attr_accessor :signing_order
+
+    # The uploads of the submission's PDF to your storage (account integrations), and the emails its template's email actions sent.
     attr_accessor :actions
 
     # 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.
@@ -137,6 +140,7 @@ module DocSpring
         :'updated_at' => :'updated_at',
         :'has_password' => :'has_password',
         :'signature_requests' => :'signature_requests',
+        :'signing_order' => :'signing_order',
         :'actions' => :'actions',
         :'truncated_text' => :'truncated_text',
         :'output_formats' => :'output_formats',
@@ -178,6 +182,7 @@ module DocSpring
         :'updated_at' => :'Time',
         :'has_password' => :'Boolean',
         :'signature_requests' => :'Array<SignatureRequest>',
+        :'signing_order' => :'SigningOrder',
         :'actions' => :'Array<SubmissionAction>',
         :'truncated_text' => :'Hash<String, Array<String>>',
         :'output_formats' => :'Array<OutputFormat>',
@@ -360,6 +365,12 @@ module DocSpring
         self.signature_requests = nil
       end
 
+      if attributes.key?(:'signing_order')
+        self.signing_order = attributes[:'signing_order']
+      else
+        self.signing_order = nil
+      end
+
       if attributes.key?(:'actions')
         if (value = attributes[:'actions']).is_a?(Array)
           self.actions = value
@@ -452,6 +463,10 @@ module DocSpring
         invalid_properties.push('invalid value for "signature_requests", signature_requests cannot be nil.')
       end
 
+      if @signing_order.nil?
+        invalid_properties.push('invalid value for "signing_order", signing_order cannot be nil.')
+      end
+
       if @actions.nil?
         invalid_properties.push('invalid value for "actions", actions cannot be nil.')
       end
@@ -481,6 +496,7 @@ module DocSpring
       return false if @updated_at.nil?
       return false if @has_password.nil?
       return false if @signature_requests.nil?
+      return false if @signing_order.nil?
       return false if @actions.nil?
       return false if @output_formats.nil?
       true
@@ -626,6 +642,16 @@ module DocSpring
       @signature_requests = signature_requests
     end
 
+    # Custom attribute writer method with validation
+    # @param [Object] signing_order Value to be assigned
+    def signing_order=(signing_order)
+      if signing_order.nil?
+        fail ArgumentError, 'signing_order cannot be nil'
+      end
+
+      @signing_order = signing_order
+    end
+
     # Custom attribute writer method with validation
     # @param [Object] actions Value to be assigned
     def actions=(actions)
@@ -672,6 +698,7 @@ module DocSpring
           updated_at == o.updated_at &&
           has_password == o.has_password &&
           signature_requests == o.signature_requests &&
+          signing_order == o.signing_order &&
           actions == o.actions &&
           truncated_text == o.truncated_text &&
           output_formats == o.output_formats &&
@@ -687,7 +714,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, files, expired, expires_at, processed_at, created_at, updated_at, has_password, signature_requests, actions, truncated_text, output_formats, preview_generated_at].hash
+      [id, template_id, template_type, template_version, batch_id, source, state, test, editable, data, data_errors, error_message, metadata, files, expired, expires_at, processed_at, created_at, updated_at, has_password, signature_requests, signing_order, actions, truncated_text, output_formats, preview_generated_at].hash
     end
 
     # Builds the object from hash

data/lib/docspring/models/submission_action.rb

@@ -14,7 +14,7 @@ require 'date'
 require 'time'
 
 module DocSpring
-  # An upload of a PDF to your storage, such as an S3 bucket.
+  # An upload of a PDF to your storage, such as an S3 bucket, or an email action's email.
   class SubmissionAction < ApiModelBase
     # The upload's ID.
     attr_accessor :id
@@ -22,13 +22,16 @@ module DocSpring
     # The ID of the account integration it used.
     attr_accessor :integration_id
 
-    # `pending` until the upload has run, then `processed`. `failed`: your storage rejected it. `error`: it failed in DocSpring.
+    # The ID of the email action that sent the email. Null for an upload, or once the email action is deleted.
+    attr_accessor :email_action_id
+
+    # `pending` until the upload or email has run, then `processed`. `failed`: your storage or the email service rejected it. `error`: it failed in DocSpring.
     attr_accessor :state
 
-    # The kind of storage, such as `aws_s3_upload` for an S3 bucket.
+    # The kind of storage, such as `aws_s3_upload` for an S3 bucket, or `email` for an email action's email.
     attr_accessor :action_type
 
-    # Where the PDF was uploaded, such as the S3 bucket and key.
+    # Where the PDF was uploaded, such as the S3 bucket and key. For an email: its `subject`, `recipients`, each with its `address`, `kind` (`to`, `cc` or `bcc`), `source`, `field` or `metadata` when the address came from one, and `status` (`sent`, `delivered`, `bounced`, `complained`, `skipped` and others), `sent_at`, `delivery`, and `files` (the files it sent: `pdf`, `docx`, `odt`). An email whose submission didn't meet the email action's `send_when` conditions has only `skipped`, `conditions_not_met`, and its state is `processed`. An email whose submission made none of the files the email action sends has `skipped`, `no_files` and the action's `file_formats`, and its state is `processed` too. When the submission's data is left out (a batch, or a webhook without submission data), the subject and the addresses that came from fields or metadata are null.
     attr_accessor :result_data
 
     # Why the upload failed, when `state` is `failed` or `error`.
@@ -61,6 +64,7 @@ module DocSpring
       {
         :'id' => :'id',
         :'integration_id' => :'integration_id',
+        :'email_action_id' => :'email_action_id',
         :'state' => :'state',
         :'action_type' => :'action_type',
         :'result_data' => :'result_data',
@@ -83,6 +87,7 @@ module DocSpring
       {
         :'id' => :'String',
         :'integration_id' => :'String',
+        :'email_action_id' => :'String',
         :'state' => :'SubmissionActionState',
         :'action_type' => :'SubmissionActionType',
         :'result_data' => :'Hash<String, Object>',
@@ -94,6 +99,7 @@ module DocSpring
     def self.openapi_nullable
       Set.new([
         :'integration_id',
+        :'email_action_id',
         :'error_message'
       ])
     end
@@ -136,6 +142,12 @@ module DocSpring
         self.integration_id = nil
       end
 
+      if attributes.key?(:'email_action_id')
+        self.email_action_id = attributes[:'email_action_id']
+      else
+        self.email_action_id = nil
+      end
+
       if attributes.key?(:'state')
         self.state = attributes[:'state']
       else
@@ -245,6 +257,7 @@ module DocSpring
       self.class == o.class &&
           id == o.id &&
           integration_id == o.integration_id &&
+          email_action_id == o.email_action_id &&
           state == o.state &&
           action_type == o.action_type &&
           result_data == o.result_data &&
@@ -260,7 +273,7 @@ module DocSpring
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [id, integration_id, state, action_type, result_data, error_message].hash
+      [id, integration_id, email_action_id, state, action_type, result_data, error_message].hash
     end
 
     # Builds the object from hash

data/lib/docspring/models/submission_input.rb

@@ -16,13 +16,13 @@ require 'time'
 module DocSpring
   # A submission to create in a batch, with its own template when it doesn't use the batch's.
   class SubmissionInput < ApiModelBase
-    # Test PDFs have a watermark and are free. Live PDFs use credits. Submissions made with a test API token are always test submissions.
+    # Test PDFs have a watermark and are free. Live PDFs use credits. Submissions made with a test API token are always test submissions, and the demo API token's are always live.
     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 PDF and Word templates.
+    # The values of the template's fields, by field name. Required for PDF templates, Word templates and page designs.
     attr_accessor :data
 
     # Your own data about the submission, such as an ID from your app. It isn't printed on the PDF. Two keys also change the PDF: `pdf_filename` names its file (`files.pdf.filename`, and its download), and `pdf_title` is its title in the PDF's document properties (and an HTML template's `<title>`, unless its HTML has one). Without `pdf_title`, the title is the template's name. In `pdf_filename`, a `.pdf` ending is removed, each run of characters other than letters, digits, `-`, `_` and `.` becomes one `_`, and the first 128 characters are kept, then `.pdf` is added. Without it, the file is named after the submission's ID (`sub_1234567890abcdef01.pdf`).
@@ -34,7 +34,7 @@ module DocSpring
     # What the submission makes: `pdf`, `docx` (a Word document, from a Word template), `odt` (an OpenDocument file, the format LibreOffice uses, converted from a Word template's Word document), and `png` (an image of each page of the PDF, up to 100 pages, which adds `pdf`) when you ask for it. Default `["pdf"]`, or a Word template's `output_format`. POST /submissions/{submission_id}/generate_files adds `png`, and a Word template's submission's `pdf`, `docx` or `odt`, 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.
+    # 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. The demo API token's submissions expire within an hour: up to 3600, and that's their default.
     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`.

data/lib/docspring/models/submission_summary.rb

@@ -37,7 +37,7 @@ module DocSpring
     # `pending` until the files have been generated, then `processed`. `waiting_for_signature_requests` until every signature request is completed. `insufficient_credits`: waiting for credits; `error_message` says whether the files are generated once you add them. `account_suspended`: waiting for the account to be reactivated, for up to 30 days. Waiting ends in `error` if it's discarded or takes over 30 days. Every other state is final, with no files: `invalid_data` (the data doesn't match the template's fields: see `data_errors`), `declined` (a signature request was declined), and the states where generating the files failed, which have an `error_message`: `syntax_error` (a mistake in an HTML template's Liquid or SCSS, or in a Word template's tags), `image_download_failed` or `image_processing_failed` (an image in the data or the template couldn't be downloaded or read) and `error` (anything else). Older submissions can also be `license_revoked` or `accidental`.
     attr_accessor :state
 
-    # Test PDFs have a watermark and are free. Live PDFs use credits. Submissions made with a test API token are always test submissions.
+    # Test PDFs have a watermark and are free. Live PDFs use credits. Submissions made with a test API token are always test submissions, and the demo API token's are always live.
     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`.