docspring 4.1.0 → 4.3.0

data/lib/docspring/request_schemas.json

@@ -635,7 +635,7 @@
             "name": {
               "type": "string",
               "minLength": 1,
-              "maxLength": 255
+              "maxLength": 512
             },
             "parent_folder_id": {
               "type": [
@@ -905,6 +905,8 @@
                 "type": "string",
                 "enum": [
                   "pdf",
+                  "docx",
+                  "odt",
                   "png"
                 ]
               }
@@ -944,7 +946,7 @@
                       "string",
                       "null"
                     ],
-                    "maxLength": 255
+                    "maxLength": 254
                   },
                   "fields": {
                     "type": "array",
@@ -1078,6 +1080,8 @@
                 "type": "string",
                 "enum": [
                   "pdf",
+                  "docx",
+                  "odt",
                   "png"
                 ]
               }
@@ -1113,6 +1117,8 @@
                       "type": "string",
                       "enum": [
                         "pdf",
+                        "docx",
+                        "odt",
                         "png"
                       ]
                     }
@@ -1172,7 +1178,7 @@
             "name": {
               "type": "string",
               "minLength": 1,
-              "maxLength": 255
+              "maxLength": 512
             },
             "description": {
               "type": [
@@ -1184,7 +1190,16 @@
               "type": "string",
               "enum": [
                 "pdf",
-                "html"
+                "html",
+                "docx"
+              ]
+            },
+            "output_format": {
+              "type": "string",
+              "enum": [
+                "pdf",
+                "docx",
+                "odt"
               ]
             },
             "parent_folder_id": {
@@ -1711,6 +1726,9 @@
               },
               "additionalProperties": false
             },
+            "html_escape_data": {
+              "type": "boolean"
+            },
             "cache_id": {
               "type": "string",
               "minLength": 1,
@@ -1765,6 +1783,34 @@
         }
       }
     },
+    "createTemplatePreview": {
+      "query": {
+        "version": {
+          "required": false,
+          "schema": {
+            "type": "string",
+            "pattern": "^(\\d+(\\.\\d+(\\.\\d+)?)?|latest|draft)$",
+            "x-pattern-message": "must be a version like 1.2.3 or 1, or latest or draft"
+          }
+        }
+      },
+      "body": {
+        "mediaType": "application/json",
+        "required": true,
+        "schema": {
+          "type": "object",
+          "required": [
+            "data"
+          ],
+          "properties": {
+            "data": {
+              "type": "object"
+            }
+          },
+          "additionalProperties": false
+        }
+      }
+    },
     "createWebhook": {
       "body": {
         "mediaType": "application/json",
@@ -1777,7 +1823,7 @@
                 "string",
                 "null"
               ],
-              "maxLength": 255
+              "maxLength": 512
             },
             "url": {
               "type": "string",
@@ -1919,6 +1965,9 @@
               "items": {
                 "type": "string",
                 "enum": [
+                  "pdf",
+                  "docx",
+                  "odt",
                   "png"
                 ]
               }
@@ -1992,9 +2041,16 @@
               "java",
               "csharp",
               "elixir",
-              "go"
+              "go",
+              "rust"
             ]
           }
+        },
+        "just_types": {
+          "required": false,
+          "schema": {
+            "type": "boolean"
+          }
         }
       }
     },
@@ -2010,6 +2066,7 @@
         }
       }
     },
+    "getTemplatePreview": {},
     "getTemplateSchema": {
       "query": {
         "version": {
@@ -2130,6 +2187,33 @@
           "schema": {
             "type": "string"
           }
+        },
+        "state": {
+          "required": false,
+          "schema": {
+            "type": "string",
+            "enum": [
+              "pending",
+              "processed",
+              "invalid_data",
+              "error",
+              "image_download_failed",
+              "image_processing_failed",
+              "waiting_for_signature_requests",
+              "syntax_error",
+              "insufficient_credits",
+              "account_suspended",
+              "license_revoked",
+              "accidental",
+              "declined"
+            ]
+          }
+        },
+        "include_files": {
+          "required": false,
+          "schema": {
+            "type": "boolean"
+          }
         }
       }
     },
@@ -2186,6 +2270,33 @@
           "schema": {
             "type": "string"
           }
+        },
+        "state": {
+          "required": false,
+          "schema": {
+            "type": "string",
+            "enum": [
+              "pending",
+              "processed",
+              "invalid_data",
+              "error",
+              "image_download_failed",
+              "image_processing_failed",
+              "waiting_for_signature_requests",
+              "syntax_error",
+              "insufficient_credits",
+              "account_suspended",
+              "license_revoked",
+              "accidental",
+              "declined"
+            ]
+          }
+        },
+        "include_files": {
+          "required": false,
+          "schema": {
+            "type": "boolean"
+          }
         }
       }
     },
@@ -2542,7 +2653,7 @@
             "name": {
               "type": "string",
               "minLength": 1,
-              "maxLength": 255
+              "maxLength": 512
             },
             "description": {
               "type": [
@@ -2550,6 +2661,14 @@
                 "null"
               ]
             },
+            "output_format": {
+              "type": "string",
+              "enum": [
+                "pdf",
+                "docx",
+                "odt"
+              ]
+            },
             "parent_folder_id": {
               "type": [
                 "string",
@@ -3115,6 +3234,9 @@
                 }
               },
               "additionalProperties": false
+            },
+            "html_escape_data": {
+              "type": "boolean"
             }
           },
           "additionalProperties": false
@@ -3802,7 +3924,7 @@
                 "string",
                 "null"
               ],
-              "maxLength": 255
+              "maxLength": 512
             },
             "url": {
               "type": "string",
@@ -3923,7 +4045,7 @@
             "name": {
               "type": "string",
               "minLength": 1,
-              "maxLength": 255
+              "maxLength": 512
             },
             "description": {
               "type": "string"
@@ -3964,6 +4086,14 @@
                 "ai",
                 "none"
               ]
+            },
+            "output_format": {
+              "type": "string",
+              "enum": [
+                "pdf",
+                "docx",
+                "odt"
+              ]
             }
           },
           "additionalProperties": false
@@ -4041,6 +4171,8 @@
                 "type": "string",
                 "enum": [
                   "pdf",
+                  "docx",
+                  "odt",
                   "png"
                 ]
               }
@@ -4080,7 +4212,7 @@
                       "string",
                       "null"
                     ],
-                    "maxLength": 255
+                    "maxLength": 254
                   },
                   "fields": {
                     "type": "array",
@@ -4202,6 +4334,7 @@
     "GET /templates/{template_id}/fields": "listTemplateFields",
     "GET /templates/{template_id}/model_code": "getTemplateModelCode",
     "GET /templates/{template_id}/page_images": "getTemplatePageImages",
+    "GET /templates/{template_id}/previews/{preview_id}": "getTemplatePreview",
     "GET /templates/{template_id}/schema": "getTemplateSchema",
     "GET /templates/{template_id}/submissions": "listTemplateSubmissions",
     "GET /uploads/presign": "getPresignUrl",
@@ -4224,6 +4357,7 @@
     "POST /templates/{template_id}/fields/remove": "removeTemplateFields",
     "POST /templates/{template_id}/fields/reorder": "reorderTemplateFields",
     "POST /templates/{template_id}/move": "moveTemplate",
+    "POST /templates/{template_id}/previews": "createTemplatePreview",
     "POST /templates/{template_id}/publish_version": "publishTemplateVersion",
     "POST /templates/{template_id}/restore_version": "restoreTemplateVersion",
     "POST /templates/{template_id}/submissions": "createSubmission",

data/lib/docspring/version.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
 
@@ -11,5 +11,5 @@ Generator version: 7.26.0-DOCSPRING
 =end
 
 module DocSpring
-  VERSION = '4.1.0'
+  VERSION = '4.3.0'
 end

data/lib/docspring/webhook_signature.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+require 'openssl'
+
+module DocSpring
+  # The number of seconds a webhook request's signature stays valid (verify_webhook_signature)
+  WEBHOOK_SIGNATURE_TOLERANCE = 300
+
+  # Checks a webhook request's X-DocSpring-Signature header (https://docspring.com/docs/webhooks/verifying-signatures/).
+  # Returns true when one of its v1 signatures is the HMAC-SHA256 of "{t}.{payload}" with the webhook's secret, and its
+  # timestamp t is at most `tolerance` seconds from `now`. Returns false for anything else, including a missing or
+  # malformed header.
+  #
+  # payload: the request body exactly as it was received (Rails: request.raw_post), not parsed JSON.
+  # signature_header: the X-DocSpring-Signature header.
+  # secret: the webhook's signing secret.
+  # tolerance: how many seconds old (or early) the timestamp can be. 5 minutes by default.
+  # now: the current Unix time in seconds, for tests. The system clock by default.
+  def self.verify_webhook_signature(payload, signature_header, secret, tolerance: WEBHOOK_SIGNATURE_TOLERANCE, now: nil)
+    return false unless payload.is_a?(String) && signature_header.is_a?(String) && secret.is_a?(String) && !secret.empty?
+
+    parts = signature_header.split(',').map { |part| part.strip.split('=', 2) }
+    timestamp = parts.find { |key, _value| key == 't' }&.last
+    signatures = parts.filter_map { |key, value| value if key == 'v1' && value && !value.empty? }
+    return false unless timestamp&.match?(/\A\d+\z/) && !signatures.empty?
+
+    now = Time.now.to_i if now.nil?
+    return false if (now.to_i - timestamp.to_i).abs > tolerance
+
+    expected = OpenSSL::HMAC.hexdigest('SHA256', secret, "#{timestamp}.#{payload}")
+    signatures.any? { |signature| webhook_signature_equal?(signature, expected) }
+  end
+
+  # Compares two signatures in constant time, so a timing attack can't find a valid one byte by byte
+  def self.webhook_signature_equal?(signature, expected)
+    return false unless signature.bytesize == expected.bytesize
+    # OpenSSL 2.2 (Ruby 3.0) and later
+    return OpenSSL.fixed_length_secure_compare(signature, expected) if OpenSSL.respond_to?(:fixed_length_secure_compare)
+
+    difference = 0
+    signature.bytes.zip(expected.bytes) { |a, b| difference |= a ^ b }
+    difference == 0
+  end
+  private_class_method :webhook_signature_equal?
+end

data/lib/docspring.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,6 +14,7 @@ Generator version: 7.26.0-DOCSPRING
 require 'docspring/api_client'
 require 'docspring/api_error'
 require 'docspring/request_validator'
+require 'docspring/webhook_signature'
 require 'docspring/api_model_base'
 require 'docspring/version'
 require 'docspring/configuration'
@@ -41,6 +42,7 @@ require 'docspring/models/create_signature_request_event_request'
 require 'docspring/models/create_signature_request_token_request'
 require 'docspring/models/create_submission_batch_request'
 require 'docspring/models/create_submission_request'
+require 'docspring/models/create_template_preview_request'
 require 'docspring/models/create_template_request'
 require 'docspring/models/create_webhook_request'
 require 'docspring/models/custom_file'
@@ -122,6 +124,7 @@ require 'docspring/models/submission_list'
 require 'docspring/models/submission_source'
 require 'docspring/models/submission_source_pdf'
 require 'docspring/models/submission_state'
+require 'docspring/models/submission_summary'
 require 'docspring/models/submission_validation'
 require 'docspring/models/template'
 require 'docspring/models/template_actor'
@@ -132,6 +135,7 @@ require 'docspring/models/template_diff'
 require 'docspring/models/template_diff_summary'
 require 'docspring/models/template_document'
 require 'docspring/models/template_document_state'
+require 'docspring/models/template_document_summary'
 require 'docspring/models/template_field_change'
 require 'docspring/models/template_field_changes'
 require 'docspring/models/template_field_dependency'
@@ -152,6 +156,8 @@ require 'docspring/models/template_page_fields_status'
 require 'docspring/models/template_page_image_status'
 require 'docspring/models/template_page_images'
 require 'docspring/models/template_page_processing_status'
+require 'docspring/models/template_preview'
+require 'docspring/models/template_preview_state'
 require 'docspring/models/template_source_pdf'
 require 'docspring/models/template_summary'
 require 'docspring/models/template_summary_list'