docuseal 1.0.2 → 1.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 975f08418bdd57eb2f63777bb6f293254e26c9347e6b267854299d13f75eed05
-  data.tar.gz: 375137878087b2c284c63f180ab7283ed665c394eaf33553a58195901e73d7d9
+  metadata.gz: ca5c0906e609ef75ff0f131f22da63bb906bb46fc66081f221913fa4bef43d4d
+  data.tar.gz: 7c7bc5a38feb904100cbdd1178ddf96c20256d7f62fa181d53b9372cbceef6cb
 SHA512:
-  metadata.gz: fd5d3c2e3abec3fb5bb145dda6e02c4752ea8983a67b530bee684698f589c1ee51b6b4851088c4c70e8eae2e11e4935211c7492c0be240824f24829b19a7322a
-  data.tar.gz: 9a8b631e6af94e54caed11cfb064e8791f77d89b9830ca521a50b01338ff20b87cba16d680506fb04bddb4ce56b781df9ae8a48fc1aacc28ab3574c463bafddc
+  metadata.gz: 0c5e32bccefb205560e84c33670fad28eb03cc7fe3683158dd292ca4516bdbadd0b55ded527d9edb40af204ebcf32a076aacfc5a0f97464b56ebb2a1d26d765d
+  data.tar.gz: 7c7d65d7f00d11c4b9e8950d744296b98763699b060cada99e45bef76f2f485cd91473f0f5c473934e7bf979c53bb5ae6dfb6b836f6ef09156b4f495fc20fbf8

data/README.md

@@ -84,6 +84,17 @@ Provides the functionality to retrieve information about a submission.
 Docuseal.get_submission(1001)
 ```
 
+### get_submission_documents(id)
+
+[Documentation](https://www.docuseal.com/docs/api?lang=ruby#get-submission-documents)
+
+This endpoint returns a list of partially filled documents for a submission. If the submission has been completed, the final signed documents are returned.
+
+
+```ruby
+Docuseal.get_submission_documents(1001)
+```
+
 ### create_submission(data)
 
 [Documentation](https://www.docuseal.com/docs/api?lang=ruby#create-a-submission)
@@ -108,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"
+    }
+  ]
 })
 ```
 
@@ -148,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
@@ -199,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)
@@ -246,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)
@@ -263,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

@@ -4,7 +4,7 @@ module Docuseal
   class Api
     Error = Class.new(StandardError)
 
-    attr_reader :http
+    private attr_reader :http
 
     def initialize(config)
       @http = Http.new(config)
@@ -62,6 +62,10 @@ module Docuseal
       http.get("/submissions/#{id}", params)
     end
 
+    def get_submission_documents(id, params = {})
+      http.get("/submissions/#{id}/documents", params)
+    end
+
     def create_submission(data)
       http.post('/submissions/init', data)
     end
@@ -70,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.2'
+  VERSION = '1.0.4'
 end

data/lib/docuseal.rb

@@ -21,33 +21,11 @@ module Docuseal
 
     extend Forwardable
 
-    def_delegators :api,
-                   :list_templates,
-                   :get_template,
-                   :create_template_from_docx,
-                   :create_template_from_html,
-                   :create_template_from_pdf,
-                   :merge_templates,
-                   :clone_template,
-                   :update_template,
-                   :update_template_documents,
-                   :archive_template,
-                   :permanently_delete_template,
-                   :list_submissions,
-                   :get_submission,
-                   :create_submission,
-                   :create_submission_from_emails,
-                   :archive_submission,
-                   :permanently_delete_submission,
-                   :list_submitters,
-                   :get_submitter,
-                   :update_submitter
+    def_delegators :api, *Docuseal::Api.instance_methods(false)
 
     def_delegators :config,
-                   :key, :key=,
-                   :url, :url=,
-                   :open_timeout, :open_timeout=,
-                   :read_timeout, :read_timeout=
+                   *Docuseal::Configuration.members,
+                   *Docuseal::Configuration.members.map { |name| :"#{name}=" }
 
     def config
       @config ||= Configuration.new(DEFAULT_CONFIG)

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: docuseal
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.0.4
 platform: ruby
 authors:
 - DocuSeal
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-12-25 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.
@@ -32,7 +31,6 @@ metadata:
   source_code_uri: https://github.com/docusealco/docuseal-ruby
   documentation_uri: https://www.docuseal.com/docs/api?lang=ruby
   rubygems_mfa_required: 'true'
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -47,8 +45,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.11
-signing_key:
+rubygems_version: 3.6.2
 specification_version: 4
 summary: Ruby bindings for DocuSeal API
 test_files: []