docuseal 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a42565a2583a622dcfef3e7d2c145b4ea79a5b57972791c00b3c8d80f03c2bf4
-  data.tar.gz: 10bdcee2c2f97e43b746773836ac548646156e3f2825bf4bc563533cf9430d61
+  metadata.gz: df6cd59df11dcce0c5c2197072bbe147fd5547452f9cd8f4843adc70acfd3ab2
+  data.tar.gz: 23fe9247d7d9b90c170fdcdd6305cd66c990644674d22cf54cbf437c8444777d
 SHA512:
-  metadata.gz: 4969ccfcdca73d84d274ff3d31c79ed5beab209179efbe9c8a561477366b4503082497af7cf74e523fce008adc7c88fe553947c042714fb303959ab2473c5ff6
-  data.tar.gz: a3ca3f193ed03196c1eef26dcd2cc768aa73cd5f2ead6294656928d4333f2dea06f7c9b92a549c928a6980cd122fba7e08064f785a6c751f15dd80cf13cb50f3
+  metadata.gz: b3ac3d6203f31ec7c954aee6eef92d0d07bbf6c2c4b56dfee31cb93f365c4c17289484d2efd832868051b099eeae0124ca343057da2ba95fc226437a36eec290
+  data.tar.gz: d0444f297d866a07be0c104058eda775f05af1c0eb80159b8759390240c33efe1cf4b22d4b815b6f68d1f2dd478390b8512c68efc3a51e98fc025496901f671e

data/README.md

@@ -1,4 +1,4 @@
-# DocuSeal Ruby Library
+# DocuSeal Ruby
 
 The DocuSeal Ruby library provides seamless integration with the DocuSeal API, allowing developers to interact with DocuSeal's electronic signature and document management features directly within Ruby applications. This library is designed to simplify API interactions and provide tools for efficient implementation.
 
@@ -14,23 +14,11 @@ To install the library, run:
 gem install docuseal
 ```
 
-If you want to build the gem from source:
-
-```sh
-gem build docuseal.gemspec
-```
-
-### Requirements
-
-- Ruby 2.5+.
-
 ### Bundler
 
 Add the library to your Gemfile for projects using Bundler:
 
 ```ruby
-source 'https://rubygems.org'
-
 gem 'docuseal'
 ```
 
@@ -72,16 +60,298 @@ Docuseal.key = 'your_api_key_here'
 Docuseal.url = 'https://yourdocusealapp.com/api'
 ```
 
-### Basic Examples
+## API Methods
+
+### list_submissions(params)
+
+[Documentation](https://www.docuseal.com/docs/api?lang=ruby#list-all-submissions)
+
+Provides the ability to retrieve a list of available submissions.
+
+
+```ruby
+Docuseal.list_submissions(limit: 10)
+```
+
+### get_submission(id)
+
+[Documentation](https://www.docuseal.com/docs/api?lang=ruby#get-a-submission)
+
+Provides the functionality to retrieve information about a submission.
+
+
+```ruby
+Docuseal.get_submission(1001)
+```
+
+### create_submission(data)
+
+[Documentation](https://www.docuseal.com/docs/api?lang=ruby#create-a-submission)
+
+This API endpoint allows you to create signature requests (submissions) for a document template and send them to the specified submitters (signers).
+
+**Related Guides:**<br>
+[Send documents for signature via API](https://www.docuseal.com/guides/send-documents-for-signature-via-api)
+[Pre-fill PDF document form fields with API](https://www.docuseal.com/guides/pre-fill-pdf-document-form-fields-with-api)
 
-#### List Templates
 
 ```ruby
-# list templates
-Docuseal.list_templates
+Docuseal.create_submission({
+  template_id: 1000001,
+  send_email: true,
+  submitters: [
+    {
+      role: "First Party",
+      email: "john.doe@example.com"
+    }
+  ]
+})
+```
+
+### create_submission_from_emails(data)
+
+[Documentation](https://www.docuseal.com/docs/api?lang=ruby#create-submissions-from-emails)
+
+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.
+
+
+```ruby
+Docuseal.create_submission_from_emails({
+  template_id: 1000001,
+  emails: "hi@docuseal.com, example@docuseal.com"
+})
+```
+
+### archive_submission(id)
 
-# retrieve single template
-Docuseal.get_template(1)
+[Documentation](https://www.docuseal.com/docs/api?lang=ruby#archive-a-submission)
+
+Allows you to archive a submission.
+
+
+```ruby
+Docuseal.archive_submission(1001)
+```
+
+### list_submitters(params)
+
+[Documentation](https://www.docuseal.com/docs/api?lang=ruby#list-all-submitters)
+
+Provides the ability to retrieve a list of submitters.
+
+
+```ruby
+Docuseal.list_submitters(limit: 10)
+```
+
+### get_submitter(id)
+
+[Documentation](https://www.docuseal.com/docs/api?lang=ruby#get-a-submitter)
+
+Provides the functionality to retrieve information about a submitter.
+
+
+```ruby
+Docuseal.get_submitter(500001)
+```
+
+### update_submitter(id, data)
+
+[Documentation](https://www.docuseal.com/docs/api?lang=ruby#update-a-submitter)
+
+Provides allows you to update submitter details, pre-fill or update field values and re-send emails.
+
+**Related Guides:**<br>
+[Automatically sign documents via API](https://www.docuseal.com/guides/pre-fill-pdf-document-form-fields-with-api#automatically_sign_documents_via_api)
+
+
+```ruby
+Docuseal.update_submitter(500001, {
+  email: "john.doe@example.com",
+  fields: [
+    {
+      name: "First Name",
+      default_value: "Acme"
+    }
+  ]
+})
+```
+
+### list_templates(params)
+
+[Documentation](https://www.docuseal.com/docs/api?lang=ruby#list-all-templates)
+
+Provides the ability to retrieve a list of available document templates.
+
+
+```ruby
+Docuseal.list_templates(limit: 10)
+```
+
+### get_template(id)
+
+[Documentation](https://www.docuseal.com/docs/api?lang=ruby#get-a-template)
+
+Provides the functionality to retrieve information about a document template.
+
+
+```ruby
+Docuseal.get_template(1000001)
+```
+
+### create_template_from_docx(data)
+
+[Documentation](https://www.docuseal.com/docs/api?lang=ruby#create-a-template-from-word-docx)
+
+Provides the functionality to create a fillable document template for existing Microsoft Word document. Use `{{Field Name;role=Signer1;type=date}}` text tags to define fillable fields in the document. See [https://www.docuseal.com/examples/fieldtags.docx](https://www.docuseal.com/examples/fieldtags.docx) 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_docx({
+  name: "Test DOCX",
+  documents: [
+    {
+      name: "string",
+      file: "base64"
+    }
+  ]
+})
+```
+
+### create_template_from_html(data)
+
+[Documentation](https://www.docuseal.com/docs/api?lang=ruby#create-a-template-from-html)
+
+Provides the functionality to seamlessly generate a PDF document template by utilizing the provided HTML content while incorporating pre-defined fields.
+
+**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_template_from_html({
+  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>
+",
+  name: "Test Template"
+})
+```
+
+### merge_templates(data)
+
+[Documentation](https://www.docuseal.com/docs/api?lang=ruby#merge-templates)
+
+Allows you to merge multiple templates with documents and fields into a new combined template.
+
+
+```ruby
+Docuseal.merge_templates({
+  template_ids: [
+    321,
+    432
+  ],
+  name: "Merged Template"
+})
+```
+
+### 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)
+
+Provides the functionality to move a document template to a different folder and update the name of the template.
+
+
+```ruby
+Docuseal.update_template(1000001, {
+  name: "New Document Name",
+  folder_name: "New Folder"
+})
+```
+
+### update_template_documents(id, data)
+
+[Documentation](https://www.docuseal.com/docs/api?lang=ruby#update-template-documents)
+
+Allows you to add, remove or replace documents in the template with provided PDF/DOCX file or HTML content.
+
+
+```ruby
+Docuseal.update_template_documents(1000001, {
+  documents: [
+    {
+      file: "string"
+    }
+  ]
+})
+```
+
+### archive_template(id)
+
+[Documentation](https://www.docuseal.com/docs/api?lang=ruby#archive-a-template)
+
+Allows you to archive a document template.
+
+
+```ruby
+Docuseal.archive_template(1000001)
 ```
 
 ### Configuring Timeouts

data/lib/docuseal/api.rb

@@ -14,8 +14,8 @@ module Docuseal
       http.get('/templates', params)
     end
 
-    def get_template(id)
-      http.get("/templates/#{id}")
+    def get_template(id, params = {})
+      http.get("/templates/#{id}", params)
     end
 
     def create_template_from_docx(data)
@@ -58,8 +58,8 @@ module Docuseal
       http.get('/submissions', params)
     end
 
-    def get_submission(id)
-      http.get("/submissions/#{id}")
+    def get_submission(id, params = {})
+      http.get("/submissions/#{id}", params)
     end
 
     def create_submission(data)
@@ -82,8 +82,8 @@ module Docuseal
       http.get('/submitters', params)
     end
 
-    def get_submitter(id)
-      http.get("/submitters/#{id}")
+    def get_submitter(id, params = {})
+      http.get("/submitters/#{id}", params)
     end
 
     def update_submitter(id, data)

data/lib/docuseal/version.rb

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

metadata

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