docuseal 1.0.4 → 1.0.6

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: ca5c0906e609ef75ff0f131f22da63bb906bb46fc66081f221913fa4bef43d4d
4
- data.tar.gz: 7c7bc5a38feb904100cbdd1178ddf96c20256d7f62fa181d53b9372cbceef6cb
3
+ metadata.gz: 2dedbd58fc159ccc549c9a8d4fbe313d9356bf83cb93018121a661ebdc947f01
4
+ data.tar.gz: c108ec2ef6fdb2975a9571f1c2613cc8a3040bd9c37e3b56a08e599118a31897
5
5
  SHA512:
6
- metadata.gz: 0c5e32bccefb205560e84c33670fad28eb03cc7fe3683158dd292ca4516bdbadd0b55ded527d9edb40af204ebcf32a076aacfc5a0f97464b56ebb2a1d26d765d
7
- data.tar.gz: 7c7d65d7f00d11c4b9e8950d744296b98763699b060cada99e45bef76f2f485cd91473f0f5c473934e7bf979c53bb5ae6dfb6b836f6ef09156b4f495fc20fbf8
6
+ metadata.gz: 79fb7957ae3c78b5188f2c0fdb8c64537b00c9150c9385741f874cbd402e059b2cfc462d1886fcf5c468ed8255a3ee5ec09dfc0540e814f2d37ee17398805d07
7
+ data.tar.gz: fba1e3338593f2f8b4e3632ec4d7cc649ed969a586ca23d044f540cbe74d0a87239b7be3e65d70d16b137c8d0b84e3c66722835c5998dc50376d05b6afc9232f
data/README.md CHANGED
@@ -123,7 +123,7 @@ Docuseal.create_submission({
123
123
 
124
124
  [Documentation](https://www.docuseal.com/docs/api?lang=ruby#create-a-submission-from-pdf)
125
125
 
126
- 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.
126
+ Provides the functionality to create one-off submission request from a PDF. 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.
127
127
 
128
128
  **Related Guides:**<br>
129
129
  [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)
@@ -131,7 +131,7 @@ Provides the functionality to create one-off submission request from a PDF file.
131
131
 
132
132
  ```ruby
133
133
  Docuseal.create_submission_from_pdf({
134
- name: "Test PDF",
134
+ name: "Test Submission Document",
135
135
  documents: [
136
136
  {
137
137
  name: "string",
@@ -161,6 +161,37 @@ Docuseal.create_submission_from_pdf({
161
161
  })
162
162
  ```
163
163
 
164
+ ### create_submission_from_docx(data)
165
+
166
+ [Documentation](https://www.docuseal.com/docs/api?lang=ruby#create-a-submission-from-docx)
167
+
168
+ Provides functionality to create a one-off submission request from a DOCX file with dynamic content variables. Use `[[variable_name]]` text tags to define dynamic content variables in the document. See [https://www.docuseal.com/examples/demo\_template.docx](https://www.docuseal.com/examples/demo_template.docx) for the specific text variable syntax, including dynamic content tables and lists. You can also use the `{{signature}}` field syntax to define fillable fields, as in a PDF.
169
+
170
+ **Related Guides:**<br>
171
+ [Use dynamic content variables in DOCX to create personalized documents](https://www.docuseal.com/guides/use-dynamic-content-variables-in-docx-to-create-personalized-documents)
172
+
173
+
174
+ ```ruby
175
+ Docuseal.create_submission_from_docx({
176
+ name: "Test Submission Document",
177
+ variables: {
178
+ variable_name: "value"
179
+ },
180
+ documents: [
181
+ {
182
+ name: "string",
183
+ file: "base64"
184
+ }
185
+ ],
186
+ submitters: [
187
+ {
188
+ role: "First Party",
189
+ email: "john.doe@example.com"
190
+ }
191
+ ]
192
+ })
193
+ ```
194
+
164
195
  ### create_submission_from_html(data)
165
196
 
166
197
  [Documentation](https://www.docuseal.com/docs/api?lang=ruby#create-a-submission-from-html)
@@ -173,7 +204,7 @@ This API endpoint allows you to create a one-off submission request document usi
173
204
 
174
205
  ```ruby
175
206
  Docuseal.create_submission_from_html({
176
- name: "Test PDF",
207
+ name: "Test Submission Document",
177
208
  documents: [
178
209
  {
179
210
  name: "Test Document",
@@ -197,6 +228,21 @@ and typesetting industry</p>
197
228
  })
198
229
  ```
199
230
 
231
+ ### update_submission(id, data)
232
+
233
+ [Documentation](https://www.docuseal.com/docs/api?lang=ruby#update-a-submission)
234
+
235
+ Allows you to update a submission: change its name, expiration date, and archive or unarchive it.
236
+
237
+
238
+ ```ruby
239
+ Docuseal.update_submission(1001, {
240
+ name: "New Submission Name",
241
+ expire_at: "2024-09-01 12:00:00 UTC",
242
+ archived: true
243
+ })
244
+ ```
245
+
200
246
  ### archive_submission(id)
201
247
 
202
248
  [Documentation](https://www.docuseal.com/docs/api?lang=ruby#archive-a-submission)
@@ -314,7 +360,7 @@ Docuseal.create_template_from_pdf({
314
360
 
315
361
  [Documentation](https://www.docuseal.com/docs/api?lang=ruby#create-a-template-from-word-docx)
316
362
 
317
- 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.
363
+ Provides the functionality to create a fillable document template for an 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.
318
364
 
319
365
  **Related Guides:**<br>
320
366
  [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)
@@ -361,7 +407,7 @@ and typesetting industry</p>
361
407
 
362
408
  [Documentation](https://www.docuseal.com/docs/api?lang=ruby#clone-a-template)
363
409
 
364
- Allows you to clone existing template into a new template.
410
+ Allows you to clone an existing template into a new template.
365
411
 
366
412
 
367
413
  ```ruby
data/lib/docuseal/api.rb CHANGED
@@ -82,6 +82,14 @@ module Docuseal
82
82
  http.post('/submissions/html', data)
83
83
  end
84
84
 
85
+ def create_submission_from_docx(data)
86
+ http.post('/submissions/docx', data)
87
+ end
88
+
89
+ def update_submission(id, data)
90
+ http.put("/submissions/#{id}", data)
91
+ end
92
+
85
93
  def archive_submission(id)
86
94
  http.delete("/submissions/#{id}")
87
95
  end
@@ -1,5 +1,5 @@
1
1
  # frozen_string_literal: true
2
2
 
3
3
  module Docuseal
4
- VERSION = '1.0.4'
4
+ VERSION = '1.0.6'
5
5
  end
metadata CHANGED
@@ -1,13 +1,13 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: docuseal
3
3
  version: !ruby/object:Gem::Version
4
- version: 1.0.4
4
+ version: 1.0.6
5
5
  platform: ruby
6
6
  authors:
7
7
  - DocuSeal
8
8
  bindir: bin
9
9
  cert_chain: []
10
- date: 2025-06-07 00:00:00.000000000 Z
10
+ date: 1980-01-02 00:00:00.000000000 Z
11
11
  dependencies: []
12
12
  description: DocuSeal is a document signing platform. This gem provides a Ruby interface
13
13
  to the DocuSeal API.
@@ -45,7 +45,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
45
45
  - !ruby/object:Gem::Version
46
46
  version: '0'
47
47
  requirements: []
48
- rubygems_version: 3.6.2
48
+ rubygems_version: 4.0.10
49
49
  specification_version: 4
50
50
  summary: Ruby bindings for DocuSeal API
51
51
  test_files: []