docspring 4.2.0 → 4.4.0

data/lib/docspring/models/submission_action.rb

@@ -1,7 +1,7 @@
 =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.
+#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
 
@@ -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_action_state.rb

@@ -1,7 +1,7 @@
 =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.
+#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
 

data/lib/docspring/models/submission_action_type.rb

@@ -1,7 +1,7 @@
 =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.
+#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
 

data/lib/docspring/models/submission_batch.rb

@@ -1,7 +1,7 @@
 =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.
+#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
 
@@ -14,12 +14,12 @@ require 'date'
 require 'time'
 
 module DocSpring
-  # Submissions created together in one request. Their PDFs are only generated when every submission in the batch is valid.
+  # Submissions created together in one request. Their files are only generated when every submission in the batch is valid.
   class SubmissionBatch < ApiModelBase
     # The batch's ID.
     attr_accessor :id
 
-    # `pending` while the PDFs are being generated, then `processed`. `error` as soon as a submission fails, while the others can still be pending: the batch has finished once `processed_at` is set.
+    # `pending` while the files are being generated, then `processed`. `error` as soon as a submission fails, while the others can still be pending: the batch has finished once `processed_at` is set.
     attr_accessor :state
 
     # Your own data about the batch, such as an ID from your app.
@@ -28,10 +28,10 @@ module DocSpring
     # The number of submissions in the request.
     attr_accessor :total_count
 
-    # The submissions whose PDFs haven't been generated yet.
+    # The submissions whose files haven't been generated yet.
     attr_accessor :pending_count
 
-    # The submissions that were invalid or whose PDFs couldn't be generated.
+    # The submissions that were invalid or whose files couldn't be generated.
     attr_accessor :error_count
 
     # The percentage of the batch's submissions that have finished, from 0 to 100.

data/lib/docspring/models/submission_batch_state.rb

@@ -1,7 +1,7 @@
 =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.
+#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
 

data/lib/docspring/models/submission_files.rb

@@ -1,7 +1,7 @@
 =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.
+#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
 
@@ -25,6 +25,12 @@ 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
 
+    # The Word document of a Word template's submission, when the submission makes one (`output_formats`).
+    attr_accessor :docx
+
+    # The OpenDocument file (.odt, the format LibreOffice uses) of a Word template's submission, converted from its Word document, when the submission makes one (`output_formats`).
+    attr_accessor :odt
+
     attr_accessor :png
 
     # Attribute mapping from ruby-style variable name to JSON key.
@@ -33,6 +39,8 @@ module DocSpring
         :'pdf' => :'pdf',
         :'audit_trail' => :'audit_trail',
         :'preview' => :'preview',
+        :'docx' => :'docx',
+        :'odt' => :'odt',
         :'png' => :'png'
       }
     end
@@ -53,6 +61,8 @@ module DocSpring
         :'pdf' => :'GeneratedFile',
         :'audit_trail' => :'GeneratedFile',
         :'preview' => :'GeneratedFile',
+        :'docx' => :'GeneratedFile',
+        :'odt' => :'GeneratedFile',
         :'png' => :'PageImages'
       }
     end
@@ -101,6 +111,14 @@ module DocSpring
         self.preview = attributes[:'preview']
       end
 
+      if attributes.key?(:'docx')
+        self.docx = attributes[:'docx']
+      end
+
+      if attributes.key?(:'odt')
+        self.odt = attributes[:'odt']
+      end
+
       if attributes.key?(:'png')
         self.png = attributes[:'png']
       end
@@ -129,6 +147,8 @@ module DocSpring
           pdf == o.pdf &&
           audit_trail == o.audit_trail &&
           preview == o.preview &&
+          docx == o.docx &&
+          odt == o.odt &&
           png == o.png
     end
 
@@ -141,7 +161,7 @@ module DocSpring
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [pdf, audit_trail, preview, png].hash
+      [pdf, audit_trail, preview, docx, odt, png].hash
     end
 
     # Builds the object from hash

data/lib/docspring/models/submission_input.rb

@@ -1,7 +1,7 @@
 =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.
+#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
 
@@ -16,25 +16,25 @@ 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 a PDF template.
+    # 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`).
     attr_accessor :metadata
 
-    # A password that the PDF needs to be opened with. It's never returned; `has_password` says if it's set.
+    # A password that the PDF needs to be opened with. It's never returned; `has_password` says if it's set. Word documents and OpenDocument files can't be password-protected, so a submission with a password can't make them.
     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.
+    # 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_list.rb

@@ -1,7 +1,7 @@
 =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.
+#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
 

data/lib/docspring/models/submission_source.rb

@@ -1,7 +1,7 @@
 =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.
+#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
 

data/lib/docspring/models/submission_source_pdf.rb

@@ -1,7 +1,7 @@
 =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.
+#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
 

data/lib/docspring/models/submission_state.rb

@@ -1,7 +1,7 @@
 =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.
+#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
 

data/lib/docspring/models/submission_summary.rb

@@ -1,7 +1,7 @@
 =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.
+#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
 
@@ -22,7 +22,7 @@ module DocSpring
     # Null once the template has been permanently deleted.
     attr_accessor :template_id
 
-    # The template's type: `pdf` or `html`.
+    # The template's type: `pdf`, `html` or `docx`.
     attr_accessor :template_type
 
     # The published version of the template the submission used. Null for the draft.
@@ -34,10 +34,10 @@ module DocSpring
     # `api`: created with the API. `web`: a web form. `reprocess`: a copy of another submission, made to generate its PDF again.
     attr_accessor :source
 
-    # `pending` until the PDF has been generated, then `processed`. `waiting_for_signature_requests` until every signature request is completed. `insufficient_credits`: waiting for credits; `error_message` says whether the PDF is 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 PDF: `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 PDF failed, which have an `error_message`: `syntax_error` (a mistake in an HTML template's Liquid or SCSS), `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`.
+    # `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`.

data/lib/docspring/models/submission_validation.rb

@@ -1,7 +1,7 @@
 =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.
+#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