docuseal 1.0.3 → 1.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a5616bb23965d6fed6cb2cb823b40307db764d914c06af6efa4c46a5881ba93a
-  data.tar.gz: 1a7bb67e5761eb187012fdd2f0084a708262a2589e3a73667c21af2db9dfdcb7
+  metadata.gz: ca5c0906e609ef75ff0f131f22da63bb906bb46fc66081f221913fa4bef43d4d
+  data.tar.gz: 7c7bc5a38feb904100cbdd1178ddf96c20256d7f62fa181d53b9372cbceef6cb
 SHA512:
-  metadata.gz: 8245e9657f887cb82b1aa08516889fed72f73ce3fcef1a65cd269eb9a2e7db51273c088184efc58a690b8e36a47bc704eb7d79d4f63e3a45bd63a5352c436294
-  data.tar.gz: 72d07dca090081fc2b60980f8224a47aa6109f85e4c551c241221389fe61dbcddd354c8d90f36c719283bd0ed646207d2c3f7a474554dd262d08d617803514fd
+  metadata.gz: 0c5e32bccefb205560e84c33670fad28eb03cc7fe3683158dd292ca4516bdbadd0b55ded527d9edb40af204ebcf32a076aacfc5a0f97464b56ebb2a1d26d765d
+  data.tar.gz: 7c7d65d7f00d11c4b9e8950d744296b98763699b060cada99e45bef76f2f485cd91473f0f5c473934e7bf979c53bb5ae6dfb6b836f6ef09156b4f495fc20fbf8

data/README.md

@@ -119,17 +119,81 @@ Docuseal.create_submission({
 })
 ```
 
-### create_submission_from_emails(data)
+### create_submission_from_pdf(data)
 
-[Documentation](https://www.docuseal.com/docs/api?lang=ruby#create-submissions-from-emails)
+[Documentation](https://www.docuseal.com/docs/api?lang=ruby#create-a-submission-from-pdf)
 
-This API endpoint allows you to create submissions for a document template and send them to the specified email addresses. This is a simplified version of the POST /submissions API to be used with Zapier or other automation tools.
+Provides the functionality to create one-off submission request from a PDF file. Use `{{Field Name;role=Signer1;type=date}}` text tags to define fillable fields in the document. See [https://www.docuseal.com/examples/fieldtags.pdf](https://www.docuseal.com/examples/fieldtags.pdf) for more text tag formats. Or specify the exact pixel coordinates of the document fields using `fields` param.
+
+**Related Guides:**<br>
+[Use embedded text field tags to create a fillable form](https://www.docuseal.com/guides/use-embedded-text-field-tags-in-the-pdf-to-create-a-fillable-form)
 
 
 ```ruby
-Docuseal.create_submission_from_emails({
-  template_id: 1000001,
-  emails: "hi@docuseal.com, example@docuseal.com"
+Docuseal.create_submission_from_pdf({
+  name: "Test PDF",
+  documents: [
+    {
+      name: "string",
+      file: "base64",
+      fields: [
+        {
+          name: "string",
+          areas: [
+            {
+              x: 0,
+              y: 0,
+              w: 0,
+              h: 0,
+              page: 1
+            }
+          ]
+        }
+      ]
+    }
+  ],
+  submitters: [
+    {
+      role: "First Party",
+      email: "john.doe@example.com"
+    }
+  ]
+})
+```
+
+### create_submission_from_html(data)
+
+[Documentation](https://www.docuseal.com/docs/api?lang=ruby#create-a-submission-from-html)
+
+This API endpoint allows you to create a one-off submission request document using the provided HTML content, with special field tags rendered as a fillable and signable form.
+
+**Related Guides:**<br>
+[Create PDF document fillable form with HTML](https://www.docuseal.com/guides/create-pdf-document-fillable-form-with-html-api)
+
+
+```ruby
+Docuseal.create_submission_from_html({
+  name: "Test PDF",
+  documents: [
+    {
+      name: "Test Document",
+      html: "<p>Lorem Ipsum is simply dummy text of the
+<text-field
+  name=\"Industry\"
+  role=\"First Party\"
+  required=\"false\"
+  style=\"width: 80px; height: 16px; display: inline-block; margin-bottom: -4px\">
+</text-field>
+and typesetting industry</p>
+"
+    }
+  ],
+  submitters: [
+    {
+      role: "First Party",
+      email: "john.doe@example.com"
+    }
+  ]
 })
 ```
 
@@ -159,7 +223,7 @@ Docuseal.list_submitters(limit: 10)
 
 [Documentation](https://www.docuseal.com/docs/api?lang=ruby#get-a-submitter)
 
-Provides the functionality to retrieve information about a submitter.
+Provides functionality to retrieve information about a submitter, along with the submitter documents and field values.
 
 
 ```ruby
@@ -210,6 +274,42 @@ Provides the functionality to retrieve information about a document template.
 Docuseal.get_template(1000001)
 ```
 
+### create_template_from_pdf(data)
+
+[Documentation](https://www.docuseal.com/docs/api?lang=ruby#create-a-template-from-pdf)
+
+Provides the functionality to create a fillable document template for a PDF file. Use `{{Field Name;role=Signer1;type=date}}` text tags to define fillable fields in the document. See [https://www.docuseal.com/examples/fieldtags.pdf](https://www.docuseal.com/examples/fieldtags.pdf) for more text tag formats. Or specify the exact pixel coordinates of the document fields using `fields` param.
+
+**Related Guides:**<br>
+[Use embedded text field tags to create a fillable form](https://www.docuseal.com/guides/use-embedded-text-field-tags-in-the-pdf-to-create-a-fillable-form)
+
+
+```ruby
+Docuseal.create_template_from_pdf({
+  name: "Test PDF",
+  documents: [
+    {
+      name: "string",
+      file: "base64",
+      fields: [
+        {
+          name: "string",
+          areas: [
+            {
+              x: 0,
+              y: 0,
+              w: 0,
+              h: 0,
+              page: 1
+            }
+          ]
+        }
+      ]
+    }
+  ]
+})
+```
+
 ### create_template_from_docx(data)
 
 [Documentation](https://www.docuseal.com/docs/api?lang=ruby#create-a-template-from-word-docx)
@@ -257,6 +357,19 @@ and typesetting industry</p>
 })
 ```
 
+### clone_template(id, data)
+
+[Documentation](https://www.docuseal.com/docs/api?lang=ruby#clone-a-template)
+
+Allows you to clone existing template into a new template.
+
+
+```ruby
+Docuseal.clone_template(1000001, {
+  name: "Cloned Template"
+})
+```
+
 ### merge_templates(data)
 
 [Documentation](https://www.docuseal.com/docs/api?lang=ruby#merge-templates)
@@ -274,55 +387,6 @@ Docuseal.merge_templates({
 })
 ```
 
-### create_template_from_pdf(data)
-
-[Documentation](https://www.docuseal.com/docs/api?lang=ruby#create-a-template-from-existing-pdf)
-
-Provides the functionality to create a fillable document template for existing PDF file. Use `{{Field Name;role=Signer1;type=date}}` text tags to define fillable fields in the document. See [https://www.docuseal.com/examples/fieldtags.pdf](https://www.docuseal.com/examples/fieldtags.pdf) for more text tag formats. Or specify the exact pixel coordinates of the document fields using `fields` param.
-
-**Related Guides:**<br>
-[Use embedded text field tags to create a fillable form](https://www.docuseal.com/guides/use-embedded-text-field-tags-in-the-pdf-to-create-a-fillable-form)
-
-
-```ruby
-Docuseal.create_template_from_pdf({
-  name: "Test PDF",
-  documents: [
-    {
-      name: "string",
-      file: "base64",
-      fields: [
-        {
-          name: "string",
-          areas: [
-            {
-              x: 0,
-              y: 0,
-              w: 0,
-              h: 0,
-              page: 1
-            }
-          ]
-        }
-      ]
-    }
-  ]
-})
-```
-
-### clone_template(id, data)
-
-[Documentation](https://www.docuseal.com/docs/api?lang=ruby#clone-a-template)
-
-Allows you to clone existing template into a new template.
-
-
-```ruby
-Docuseal.clone_template(1000001, {
-  name: "Cloned Template"
-})
-```
-
 ### update_template(id, data)
 
 [Documentation](https://www.docuseal.com/docs/api?lang=ruby#update-a-template)

data/lib/docuseal/api.rb

@@ -74,6 +74,14 @@ module Docuseal
       http.post('/submissions/emails', data)
     end
 
+    def create_submission_from_pdf(data)
+      http.post('/submissions/pdf', data)
+    end
+
+    def create_submission_from_html(data)
+      http.post('/submissions/html', data)
+    end
+
     def archive_submission(id)
       http.delete("/submissions/#{id}")
     end

data/lib/docuseal/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Docuseal
-  VERSION = '1.0.3'
+  VERSION = '1.0.4'
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: docuseal
 version: !ruby/object:Gem::Version
-  version: 1.0.3
+  version: 1.0.4
 platform: ruby
 authors:
 - DocuSeal
 bindir: bin
 cert_chain: []
-date: 2025-04-16 00:00:00.000000000 Z
+date: 2025-06-07 00:00:00.000000000 Z
 dependencies: []
 description: DocuSeal is a document signing platform. This gem provides a Ruby interface
   to the DocuSeal API.