dropbox-sign 1.0.1 → 1.1.1
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/Gemfile.lock +1 -1
- data/README.md +26 -9
- data/VERSION +1 -1
- data/docs/BulkSendJobApi.md +5 -3
- data/docs/SignatureRequestCreateEmbeddedRequest.md +1 -1
- data/docs/TeamResponse.md +1 -0
- data/docs/TemplateResponse.md +2 -2
- data/docs/TemplateResponseDocument.md +3 -3
- data/docs/{TemplateResponseCustomField.md → TemplateResponseDocumentCustomFieldBase.md} +5 -8
- data/docs/TemplateResponseDocumentCustomFieldCheckbox.md +10 -0
- data/docs/TemplateResponseDocumentCustomFieldText.md +14 -0
- data/docs/TemplateResponseDocumentFieldGroup.md +1 -1
- data/docs/TemplateResponseDocumentFieldGroupRule.md +11 -0
- data/docs/{TemplateResponseDocumentFormField.md → TemplateResponseDocumentFormFieldBase.md} +4 -8
- data/docs/TemplateResponseDocumentFormFieldCheckbox.md +10 -0
- data/docs/TemplateResponseDocumentFormFieldDateSigned.md +10 -0
- data/docs/TemplateResponseDocumentFormFieldDropdown.md +10 -0
- data/docs/TemplateResponseDocumentFormFieldHyperlink.md +14 -0
- data/docs/TemplateResponseDocumentFormFieldInitials.md +10 -0
- data/docs/TemplateResponseDocumentFormFieldRadio.md +10 -0
- data/docs/TemplateResponseDocumentFormFieldSignature.md +10 -0
- data/docs/TemplateResponseDocumentFormFieldText.md +15 -0
- data/docs/{TemplateResponseDocumentStaticField.md → TemplateResponseDocumentStaticFieldBase.md} +5 -5
- data/docs/TemplateResponseDocumentStaticFieldCheckbox.md +10 -0
- data/docs/TemplateResponseDocumentStaticFieldDateSigned.md +10 -0
- data/docs/TemplateResponseDocumentStaticFieldDropdown.md +10 -0
- data/docs/TemplateResponseDocumentStaticFieldHyperlink.md +10 -0
- data/docs/TemplateResponseDocumentStaticFieldInitials.md +10 -0
- data/docs/TemplateResponseDocumentStaticFieldRadio.md +10 -0
- data/docs/TemplateResponseDocumentStaticFieldSignature.md +10 -0
- data/docs/TemplateResponseDocumentStaticFieldText.md +10 -0
- data/docs/TemplateResponseFieldAvgTextLength.md +1 -1
- data/lib/dropbox-sign/api/bulk_send_job_api.rb +6 -0
- data/lib/dropbox-sign/models/signature_request_create_embedded_request.rb +1 -1
- data/lib/dropbox-sign/models/team_response.rb +17 -4
- data/lib/dropbox-sign/models/template_response.rb +5 -5
- data/lib/dropbox-sign/models/template_response_document.rb +9 -9
- data/lib/dropbox-sign/models/{template_response_document_static_field.rb → template_response_document_custom_field_base.rb} +60 -39
- data/lib/dropbox-sign/models/template_response_document_custom_field_checkbox.rb +263 -0
- data/lib/dropbox-sign/models/template_response_document_custom_field_text.rb +306 -0
- data/lib/dropbox-sign/models/template_response_document_field_group.rb +2 -3
- data/lib/dropbox-sign/models/template_response_document_field_group_rule.rb +263 -0
- data/lib/dropbox-sign/models/{template_response_named_form_field.rb → template_response_document_form_field_base.rb} +78 -86
- data/lib/dropbox-sign/models/template_response_document_form_field_checkbox.rb +263 -0
- data/lib/dropbox-sign/models/template_response_document_form_field_date_signed.rb +263 -0
- data/lib/dropbox-sign/models/template_response_document_form_field_dropdown.rb +263 -0
- data/lib/dropbox-sign/models/template_response_document_form_field_hyperlink.rb +306 -0
- data/lib/dropbox-sign/models/template_response_document_form_field_initials.rb +263 -0
- data/lib/dropbox-sign/models/template_response_document_form_field_radio.rb +263 -0
- data/lib/dropbox-sign/models/template_response_document_form_field_signature.rb +263 -0
- data/lib/dropbox-sign/models/{template_response_document_form_field.rb → template_response_document_form_field_text.rb} +53 -132
- data/lib/dropbox-sign/models/{template_response_custom_field.rb → template_response_document_static_field_base.rb} +90 -119
- data/lib/dropbox-sign/models/template_response_document_static_field_checkbox.rb +263 -0
- data/lib/dropbox-sign/models/template_response_document_static_field_date_signed.rb +263 -0
- data/lib/dropbox-sign/models/template_response_document_static_field_dropdown.rb +263 -0
- data/lib/dropbox-sign/models/template_response_document_static_field_hyperlink.rb +263 -0
- data/lib/dropbox-sign/models/template_response_document_static_field_initials.rb +263 -0
- data/lib/dropbox-sign/models/template_response_document_static_field_radio.rb +263 -0
- data/lib/dropbox-sign/models/template_response_document_static_field_signature.rb +263 -0
- data/lib/dropbox-sign/models/template_response_document_static_field_text.rb +263 -0
- data/lib/dropbox-sign/models/template_response_field_avg_text_length.rb +1 -1
- data/lib/dropbox-sign/version.rb +1 -1
- data/lib/dropbox-sign.rb +22 -5
- data/openapi-config.yaml +1 -1
- data/openapi-sdk.yaml +586 -182
- data/test_fixtures/AccountCreateResponse.json +1 -0
- data/test_fixtures/ApiAppGetResponse.json +1 -0
- data/test_fixtures/ApiAppListResponse.json +1 -0
- data/test_fixtures/BulkSendJobGetResponse.json +8 -3
- data/test_fixtures/SignatureRequestGetResponse.json +65 -65
- data/test_fixtures/SignatureRequestListResponse.json +11 -4
- data/test_fixtures/TemplateGetResponse.json +1002 -41
- data/test_fixtures/TemplateListResponse.json +483 -44
- metadata +52 -18
- data/docs/TemplateResponseDocumentCustomField.md +0 -25
- data/docs/TemplateResponseNamedFormField.md +0 -23
- data/lib/dropbox-sign/models/template_response_document_custom_field.rb +0 -454
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 29798e1f92fb71627efe66ceb0c342588d48a4f048052bac5284edfd6eb6d7ac
|
4
|
+
data.tar.gz: 6518ffcfde96478d57503c461284d2624fbcbe32e671e800f9497ab85b132961
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: eb8f2384aeb16f9e849b4a28dcc383bb00aad77888170bc6aea76591bba02da587ddf9e43c9964bce3118cd7dc072377ecb5b7302340638976e45023e243df53
|
7
|
+
data.tar.gz: b5e79413e4a14e2762da87320440f20a4b31f0969407259069ab40b5d6b3a7347ecc161f4d27a70ce0b6bf167f962b9fde64749c0f1f80c6f8740764417a1b70
|
data/Gemfile.lock
CHANGED
data/README.md
CHANGED
@@ -25,7 +25,7 @@ directory that corresponds to the file you want updated.
|
|
25
25
|
This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
|
26
26
|
|
27
27
|
- API version: 3.0.0
|
28
|
-
- Package version: 1.
|
28
|
+
- Package version: 1.1.1
|
29
29
|
- Build package: org.openapitools.codegen.languages.RubyClientCodegen
|
30
30
|
|
31
31
|
## Installation
|
@@ -46,14 +46,14 @@ gem build dropbox-sign.gemspec
|
|
46
46
|
Then install the gem locally:
|
47
47
|
|
48
48
|
```shell
|
49
|
-
gem install ./dropbox-sign-1.
|
49
|
+
gem install ./dropbox-sign-1.1.1.gem
|
50
50
|
```
|
51
51
|
|
52
|
-
(for development, run `gem install --dev ./dropbox-sign-1.
|
52
|
+
(for development, run `gem install --dev ./dropbox-sign-1.1.1.gem` to install the development dependencies)
|
53
53
|
|
54
54
|
Finally add this to the Gemfile:
|
55
55
|
|
56
|
-
gem 'dropbox-sign', '~> 1.
|
56
|
+
gem 'dropbox-sign', '~> 1.1.1'
|
57
57
|
|
58
58
|
### Install from Git
|
59
59
|
|
@@ -297,14 +297,31 @@ All URIs are relative to *https://api.hellosign.com/v3*
|
|
297
297
|
- [Dropbox::Sign::TemplateResponseAccount](docs/TemplateResponseAccount.md)
|
298
298
|
- [Dropbox::Sign::TemplateResponseAccountQuota](docs/TemplateResponseAccountQuota.md)
|
299
299
|
- [Dropbox::Sign::TemplateResponseCCRole](docs/TemplateResponseCCRole.md)
|
300
|
-
- [Dropbox::Sign::TemplateResponseCustomField](docs/TemplateResponseCustomField.md)
|
301
300
|
- [Dropbox::Sign::TemplateResponseDocument](docs/TemplateResponseDocument.md)
|
302
|
-
- [Dropbox::Sign::
|
301
|
+
- [Dropbox::Sign::TemplateResponseDocumentCustomFieldBase](docs/TemplateResponseDocumentCustomFieldBase.md)
|
302
|
+
- [Dropbox::Sign::TemplateResponseDocumentCustomFieldCheckbox](docs/TemplateResponseDocumentCustomFieldCheckbox.md)
|
303
|
+
- [Dropbox::Sign::TemplateResponseDocumentCustomFieldText](docs/TemplateResponseDocumentCustomFieldText.md)
|
303
304
|
- [Dropbox::Sign::TemplateResponseDocumentFieldGroup](docs/TemplateResponseDocumentFieldGroup.md)
|
304
|
-
- [Dropbox::Sign::
|
305
|
-
- [Dropbox::Sign::
|
305
|
+
- [Dropbox::Sign::TemplateResponseDocumentFieldGroupRule](docs/TemplateResponseDocumentFieldGroupRule.md)
|
306
|
+
- [Dropbox::Sign::TemplateResponseDocumentFormFieldBase](docs/TemplateResponseDocumentFormFieldBase.md)
|
307
|
+
- [Dropbox::Sign::TemplateResponseDocumentFormFieldCheckbox](docs/TemplateResponseDocumentFormFieldCheckbox.md)
|
308
|
+
- [Dropbox::Sign::TemplateResponseDocumentFormFieldDateSigned](docs/TemplateResponseDocumentFormFieldDateSigned.md)
|
309
|
+
- [Dropbox::Sign::TemplateResponseDocumentFormFieldDropdown](docs/TemplateResponseDocumentFormFieldDropdown.md)
|
310
|
+
- [Dropbox::Sign::TemplateResponseDocumentFormFieldHyperlink](docs/TemplateResponseDocumentFormFieldHyperlink.md)
|
311
|
+
- [Dropbox::Sign::TemplateResponseDocumentFormFieldInitials](docs/TemplateResponseDocumentFormFieldInitials.md)
|
312
|
+
- [Dropbox::Sign::TemplateResponseDocumentFormFieldRadio](docs/TemplateResponseDocumentFormFieldRadio.md)
|
313
|
+
- [Dropbox::Sign::TemplateResponseDocumentFormFieldSignature](docs/TemplateResponseDocumentFormFieldSignature.md)
|
314
|
+
- [Dropbox::Sign::TemplateResponseDocumentFormFieldText](docs/TemplateResponseDocumentFormFieldText.md)
|
315
|
+
- [Dropbox::Sign::TemplateResponseDocumentStaticFieldBase](docs/TemplateResponseDocumentStaticFieldBase.md)
|
316
|
+
- [Dropbox::Sign::TemplateResponseDocumentStaticFieldCheckbox](docs/TemplateResponseDocumentStaticFieldCheckbox.md)
|
317
|
+
- [Dropbox::Sign::TemplateResponseDocumentStaticFieldDateSigned](docs/TemplateResponseDocumentStaticFieldDateSigned.md)
|
318
|
+
- [Dropbox::Sign::TemplateResponseDocumentStaticFieldDropdown](docs/TemplateResponseDocumentStaticFieldDropdown.md)
|
319
|
+
- [Dropbox::Sign::TemplateResponseDocumentStaticFieldHyperlink](docs/TemplateResponseDocumentStaticFieldHyperlink.md)
|
320
|
+
- [Dropbox::Sign::TemplateResponseDocumentStaticFieldInitials](docs/TemplateResponseDocumentStaticFieldInitials.md)
|
321
|
+
- [Dropbox::Sign::TemplateResponseDocumentStaticFieldRadio](docs/TemplateResponseDocumentStaticFieldRadio.md)
|
322
|
+
- [Dropbox::Sign::TemplateResponseDocumentStaticFieldSignature](docs/TemplateResponseDocumentStaticFieldSignature.md)
|
323
|
+
- [Dropbox::Sign::TemplateResponseDocumentStaticFieldText](docs/TemplateResponseDocumentStaticFieldText.md)
|
306
324
|
- [Dropbox::Sign::TemplateResponseFieldAvgTextLength](docs/TemplateResponseFieldAvgTextLength.md)
|
307
|
-
- [Dropbox::Sign::TemplateResponseNamedFormField](docs/TemplateResponseNamedFormField.md)
|
308
325
|
- [Dropbox::Sign::TemplateResponseSignerRole](docs/TemplateResponseSignerRole.md)
|
309
326
|
- [Dropbox::Sign::TemplateUpdateFilesRequest](docs/TemplateUpdateFilesRequest.md)
|
310
327
|
- [Dropbox::Sign::TemplateUpdateFilesResponse](docs/TemplateUpdateFilesResponse.md)
|
data/VERSION
CHANGED
@@ -1 +1 @@
|
|
1
|
-
1.
|
1
|
+
1.1.1
|
data/docs/BulkSendJobApi.md
CHANGED
@@ -10,7 +10,7 @@ All URIs are relative to *https://api.hellosign.com/v3*
|
|
10
10
|
|
11
11
|
## `bulk_send_job_get`
|
12
12
|
|
13
|
-
> `<BulkSendJobGetResponse> bulk_send_job_get(bulk_send_job_id)`
|
13
|
+
> `<BulkSendJobGetResponse> bulk_send_job_get(bulk_send_job_id, opts)`
|
14
14
|
|
15
15
|
Get Bulk Send Job
|
16
16
|
|
@@ -46,12 +46,12 @@ end
|
|
46
46
|
|
47
47
|
This returns an Array which contains the response data, status code and headers.
|
48
48
|
|
49
|
-
> `<Array(<BulkSendJobGetResponse>, Integer, Hash)> bulk_send_job_get_with_http_info(bulk_send_job_id)`
|
49
|
+
> `<Array(<BulkSendJobGetResponse>, Integer, Hash)> bulk_send_job_get_with_http_info(bulk_send_job_id, opts)`
|
50
50
|
|
51
51
|
```ruby
|
52
52
|
begin
|
53
53
|
# Get Bulk Send Job
|
54
|
-
data, status_code, headers = api_instance.bulk_send_job_get_with_http_info(bulk_send_job_id)
|
54
|
+
data, status_code, headers = api_instance.bulk_send_job_get_with_http_info(bulk_send_job_id, opts)
|
55
55
|
p status_code # => 2xx
|
56
56
|
p headers # => { ... }
|
57
57
|
p data # => <BulkSendJobGetResponse>
|
@@ -65,6 +65,8 @@ end
|
|
65
65
|
| Name | Type | Description | Notes |
|
66
66
|
| ---- | ---- | ----------- | ----- |
|
67
67
|
| `bulk_send_job_id` | **String** | The id of the BulkSendJob to retrieve. | |
|
68
|
+
| `page` | **Integer** | Which page number of the BulkSendJob list to return. Defaults to `1`. | [optional][default to 1] |
|
69
|
+
| `page_size` | **Integer** | Number of objects to be returned per page. Must be between `1` and `100`. Default is 20. | [optional][default to 20] |
|
68
70
|
|
69
71
|
### Return type
|
70
72
|
|
@@ -29,5 +29,5 @@
|
|
29
29
|
| `title` | ```String``` | The title you want to assign to the SignatureRequest. | |
|
30
30
|
| `use_text_tags` | ```Boolean``` | Send with a value of `true` if you wish to enable [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) parsing in your document. Defaults to disabled, or `false`. | [default to false] |
|
31
31
|
| `populate_auto_fill_fields` | ```Boolean``` | Controls whether [auto fill fields](https://faq.hellosign.com/hc/en-us/articles/360051467511-Auto-Fill-Fields) can automatically populate a signer's information during signing.<br><br>⚠️ **Note** ⚠️: Keep your signer's information safe by ensuring that the _signer on your signature request is the intended party_ before using this feature. | [default to false] |
|
32
|
-
| `expires_at` | ```Integer``` | When the signature request will expire. Unsigned signatures will be moved to the expired status, and no longer signable. See [Signature Request Expiration Date](https://developers.hellosign.com/docs/signature-request/expiration/) for details
|
32
|
+
| `expires_at` | ```Integer``` | When the signature request will expire. Unsigned signatures will be moved to the expired status, and no longer signable. See [Signature Request Expiration Date](https://developers.hellosign.com/docs/signature-request/expiration/) for details. | |
|
33
33
|
|
data/docs/TeamResponse.md
CHANGED
@@ -9,4 +9,5 @@ Contains information about your team and its members
|
|
9
9
|
| `name` | ```String``` | The name of your Team | |
|
10
10
|
| `accounts` | [```Array<AccountResponse>```](AccountResponse.md) | | |
|
11
11
|
| `invited_accounts` | [```Array<AccountResponse>```](AccountResponse.md) | A list of all Accounts that have an outstanding invitation to join your Team. Note that this response is a subset of the response parameters found in `GET /account`. | |
|
12
|
+
| `invited_emails` | ```Array<String>``` | A list of email addresses that have an outstanding invitation to join your Team and do not yet have a Dropbox Sign account. | |
|
12
13
|
|
data/docs/TemplateResponse.md
CHANGED
@@ -18,7 +18,7 @@ Contains information about the templates you and your team have created.
|
|
18
18
|
| `signer_roles` | [```Array<TemplateResponseSignerRole>```](TemplateResponseSignerRole.md) | An array of the designated signer roles that must be specified when sending a SignatureRequest using this Template. | |
|
19
19
|
| `cc_roles` | [```Array<TemplateResponseCCRole>```](TemplateResponseCCRole.md) | An array of the designated CC roles that must be specified when sending a SignatureRequest using this Template. | |
|
20
20
|
| `documents` | [```Array<TemplateResponseDocument>```](TemplateResponseDocument.md) | An array describing each document associated with this Template. Includes form field data for each document. | |
|
21
|
-
| `custom_fields` | [```Array<
|
22
|
-
| `named_form_fields` | [```Array<
|
21
|
+
| `custom_fields` | [```Array<TemplateResponseDocumentCustomFieldBase>```](TemplateResponseDocumentCustomFieldBase.md) | Deprecated. Use `custom_fields` inside the [documents](https://developers.hellosign.com/api/reference/operation/templateGet/#!c=200&path=template/documents&t=response) array instead. | |
|
22
|
+
| `named_form_fields` | [```Array<TemplateResponseDocumentFormFieldBase>```](TemplateResponseDocumentFormFieldBase.md) | Deprecated. Use `form_fields` inside the [documents](https://developers.hellosign.com/api/reference/operation/templateGet/#!c=200&path=template/documents&t=response) array instead. | |
|
23
23
|
| `accounts` | [```Array<TemplateResponseAccount>```](TemplateResponseAccount.md) | An array of the Accounts that can use this Template. | |
|
24
24
|
|
@@ -9,7 +9,7 @@
|
|
9
9
|
| `name` | ```String``` | Name of the associated file. | |
|
10
10
|
| `index` | ```Integer``` | Document ordering, the lowest index is displayed first and the highest last (0-based indexing). | |
|
11
11
|
| `field_groups` | [```Array<TemplateResponseDocumentFieldGroup>```](TemplateResponseDocumentFieldGroup.md) | An array of Form Field Group objects. | |
|
12
|
-
| `form_fields` | [```Array<
|
13
|
-
| `custom_fields` | [```Array<
|
14
|
-
| `static_fields` | [```Array<
|
12
|
+
| `form_fields` | [```Array<TemplateResponseDocumentFormFieldBase>```](TemplateResponseDocumentFormFieldBase.md) | An array of Form Field objects containing the name and type of each named field. | |
|
13
|
+
| `custom_fields` | [```Array<TemplateResponseDocumentCustomFieldBase>```](TemplateResponseDocumentCustomFieldBase.md) | An array of Form Field objects containing the name and type of each named field. | |
|
14
|
+
| `static_fields` | [```Array<TemplateResponseDocumentStaticFieldBase>```](TemplateResponseDocumentStaticFieldBase.md) | An array describing static overlay fields. **Note** only available for certain subscriptions. | |
|
15
15
|
|
@@ -1,22 +1,19 @@
|
|
1
|
-
# Dropbox::Sign::
|
2
|
-
|
1
|
+
# Dropbox::Sign::TemplateResponseDocumentCustomFieldBase
|
3
2
|
|
3
|
+
An array of Form Field objects containing the name and type of each named field.
|
4
4
|
|
5
5
|
## Properties
|
6
6
|
|
7
7
|
| Name | Type | Description | Notes |
|
8
8
|
| ---- | ---- | ----------- | ----- |
|
9
|
+
| `type`<sup>*_required_</sup> | ```String``` | | |
|
10
|
+
| `api_id` | ```String``` | The unique ID for this field. | |
|
9
11
|
| `name` | ```String``` | The name of the Custom Field. | |
|
10
|
-
| `
|
12
|
+
| `signer` | ```String``` | The signer of the Custom Field. Can be `null` if field is a merge field (assigned to Sender). | |
|
11
13
|
| `x` | ```Integer``` | The horizontal offset in pixels for this form field. | |
|
12
14
|
| `y` | ```Integer``` | The vertical offset in pixels for this form field. | |
|
13
15
|
| `width` | ```Integer``` | The width in pixels of this form field. | |
|
14
16
|
| `height` | ```Integer``` | The height in pixels of this form field. | |
|
15
17
|
| `required` | ```Boolean``` | Boolean showing whether or not this field is required. | |
|
16
|
-
| `api_id` | ```String``` | The unique ID for this field. | |
|
17
18
|
| `group` | ```String``` | The name of the group this field is in. If this field is not a group, this defaults to `null`. | |
|
18
|
-
| `avg_text_length` | [```TemplateResponseFieldAvgTextLength```](TemplateResponseFieldAvgTextLength.md) | | |
|
19
|
-
| `is_multiline` | ```Boolean``` | Whether this form field is multiline text. | |
|
20
|
-
| `original_font_size` | ```Integer``` | Original font size used in this form field's text. | |
|
21
|
-
| `font_family` | ```String``` | Font family used in this form field's text. | |
|
22
19
|
|
@@ -0,0 +1,10 @@
|
|
1
|
+
# Dropbox::Sign::TemplateResponseDocumentCustomFieldCheckbox
|
2
|
+
|
3
|
+
This class extends `TemplateResponseDocumentCustomFieldBase`
|
4
|
+
|
5
|
+
## Properties
|
6
|
+
|
7
|
+
| Name | Type | Description | Notes |
|
8
|
+
| ---- | ---- | ----------- | ----- |
|
9
|
+
| `type`<sup>*_required_</sup> | ```String``` | The type of this Custom Field. Only `text` and `checkbox` are currently supported.<br><br>* Text uses `TemplateResponseDocumentCustomFieldText`<br>* Checkbox uses `TemplateResponseDocumentCustomFieldCheckbox` | [default to 'checkbox'] |
|
10
|
+
|
@@ -0,0 +1,14 @@
|
|
1
|
+
# Dropbox::Sign::TemplateResponseDocumentCustomFieldText
|
2
|
+
|
3
|
+
This class extends `TemplateResponseDocumentCustomFieldBase`
|
4
|
+
|
5
|
+
## Properties
|
6
|
+
|
7
|
+
| Name | Type | Description | Notes |
|
8
|
+
| ---- | ---- | ----------- | ----- |
|
9
|
+
| `type`<sup>*_required_</sup> | ```String``` | The type of this Custom Field. Only `text` and `checkbox` are currently supported.<br><br>* Text uses `TemplateResponseDocumentCustomFieldText`<br>* Checkbox uses `TemplateResponseDocumentCustomFieldCheckbox` | [default to 'text'] |
|
10
|
+
| `avg_text_length` | [```TemplateResponseFieldAvgTextLength```](TemplateResponseFieldAvgTextLength.md) | | |
|
11
|
+
| `is_multiline` | ```Boolean``` | Whether this form field is multiline text. | |
|
12
|
+
| `original_font_size` | ```Integer``` | Original font size used in this form field's text. | |
|
13
|
+
| `font_family` | ```String``` | Font family used in this form field's text. | |
|
14
|
+
|
@@ -7,5 +7,5 @@
|
|
7
7
|
| Name | Type | Description | Notes |
|
8
8
|
| ---- | ---- | ----------- | ----- |
|
9
9
|
| `name` | ```String``` | The name of the form field group. | |
|
10
|
-
| `rule` | ```
|
10
|
+
| `rule` | [```TemplateResponseDocumentFieldGroupRule```](TemplateResponseDocumentFieldGroupRule.md) | | |
|
11
11
|
|
@@ -0,0 +1,11 @@
|
|
1
|
+
# Dropbox::Sign::TemplateResponseDocumentFieldGroupRule
|
2
|
+
|
3
|
+
The rule used to validate checkboxes in the form field group. See [checkbox field grouping](/api/reference/constants/#checkbox-field-grouping).
|
4
|
+
|
5
|
+
## Properties
|
6
|
+
|
7
|
+
| Name | Type | Description | Notes |
|
8
|
+
| ---- | ---- | ----------- | ----- |
|
9
|
+
| `requirement` | ```String``` | Examples: `require_0-1` `require_1` `require_1-ormore`<br><br>- Check out the list of [acceptable `requirement` checkbox type values](/api/reference/constants/#checkbox-field-grouping). - Check out the list of [acceptable `requirement` radio type fields](/api/reference/constants/#radio-field-grouping). - Radio groups require **at least** two fields per group. | |
|
10
|
+
| `group_label` | ```String``` | Name of the group | |
|
11
|
+
|
@@ -1,23 +1,19 @@
|
|
1
|
-
# Dropbox::Sign::
|
2
|
-
|
1
|
+
# Dropbox::Sign::TemplateResponseDocumentFormFieldBase
|
3
2
|
|
3
|
+
An array of Form Field objects containing the name and type of each named field.
|
4
4
|
|
5
5
|
## Properties
|
6
6
|
|
7
7
|
| Name | Type | Description | Notes |
|
8
8
|
| ---- | ---- | ----------- | ----- |
|
9
|
+
| `type`<sup>*_required_</sup> | ```String``` | | |
|
9
10
|
| `api_id` | ```String``` | A unique id for the form field. | |
|
10
11
|
| `name` | ```String``` | The name of the form field. | |
|
11
|
-
| `type` | ```String``` | The type of this form field. See [field types](/api/reference/constants/#field-types). | |
|
12
12
|
| `signer` | ```String``` | The signer of the Form Field. | |
|
13
13
|
| `x` | ```Integer``` | The horizontal offset in pixels for this form field. | |
|
14
14
|
| `y` | ```Integer``` | The vertical offset in pixels for this form field. | |
|
15
15
|
| `width` | ```Integer``` | The width in pixels of this form field. | |
|
16
16
|
| `height` | ```Integer``` | The height in pixels of this form field. | |
|
17
17
|
| `required` | ```Boolean``` | Boolean showing whether or not this field is required. | |
|
18
|
-
| `group` | ```String``` | The name of the group this field is in. If this field is not a group, this defaults to `null
|
19
|
-
| `avg_text_length` | [```TemplateResponseFieldAvgTextLength```](TemplateResponseFieldAvgTextLength.md) | | |
|
20
|
-
| `is_multiline` | ```Boolean``` | Whether this form field is multiline text. | |
|
21
|
-
| `original_font_size` | ```Integer``` | Original font size used in this form field's text. | |
|
22
|
-
| `font_family` | ```String``` | Font family used in this form field's text. | |
|
18
|
+
| `group` | ```String``` | The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. | |
|
23
19
|
|
@@ -0,0 +1,10 @@
|
|
1
|
+
# Dropbox::Sign::TemplateResponseDocumentFormFieldCheckbox
|
2
|
+
|
3
|
+
This class extends `TemplateResponseDocumentFormFieldBase`
|
4
|
+
|
5
|
+
## Properties
|
6
|
+
|
7
|
+
| Name | Type | Description | Notes |
|
8
|
+
| ---- | ---- | ----------- | ----- |
|
9
|
+
| `type`<sup>*_required_</sup> | ```String``` | The type of this form field. See [field types](/api/reference/constants/#field-types).<br><br>* Text Field uses `TemplateResponseDocumentFormFieldText`<br>* Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown`<br>* Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink`<br>* Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox`<br>* Radio Field uses `TemplateResponseDocumentFormFieldRadio`<br>* Signature Field uses `TemplateResponseDocumentFormFieldSignature`<br>* Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned`<br>* Initials Field uses `TemplateResponseDocumentFormFieldInitials` | [default to 'checkbox'] |
|
10
|
+
|
@@ -0,0 +1,10 @@
|
|
1
|
+
# Dropbox::Sign::TemplateResponseDocumentFormFieldDateSigned
|
2
|
+
|
3
|
+
This class extends `TemplateResponseDocumentFormFieldBase`
|
4
|
+
|
5
|
+
## Properties
|
6
|
+
|
7
|
+
| Name | Type | Description | Notes |
|
8
|
+
| ---- | ---- | ----------- | ----- |
|
9
|
+
| `type`<sup>*_required_</sup> | ```String``` | The type of this form field. See [field types](/api/reference/constants/#field-types).<br><br>* Text Field uses `TemplateResponseDocumentFormFieldText`<br>* Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown`<br>* Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink`<br>* Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox`<br>* Radio Field uses `TemplateResponseDocumentFormFieldRadio`<br>* Signature Field uses `TemplateResponseDocumentFormFieldSignature`<br>* Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned`<br>* Initials Field uses `TemplateResponseDocumentFormFieldInitials` | [default to 'date_signed'] |
|
10
|
+
|
@@ -0,0 +1,10 @@
|
|
1
|
+
# Dropbox::Sign::TemplateResponseDocumentFormFieldDropdown
|
2
|
+
|
3
|
+
This class extends `TemplateResponseDocumentFormFieldBase`
|
4
|
+
|
5
|
+
## Properties
|
6
|
+
|
7
|
+
| Name | Type | Description | Notes |
|
8
|
+
| ---- | ---- | ----------- | ----- |
|
9
|
+
| `type`<sup>*_required_</sup> | ```String``` | The type of this form field. See [field types](/api/reference/constants/#field-types).<br><br>* Text Field uses `TemplateResponseDocumentFormFieldText`<br>* Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown`<br>* Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink`<br>* Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox`<br>* Radio Field uses `TemplateResponseDocumentFormFieldRadio`<br>* Signature Field uses `TemplateResponseDocumentFormFieldSignature`<br>* Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned`<br>* Initials Field uses `TemplateResponseDocumentFormFieldInitials` | [default to 'dropdown'] |
|
10
|
+
|
@@ -0,0 +1,14 @@
|
|
1
|
+
# Dropbox::Sign::TemplateResponseDocumentFormFieldHyperlink
|
2
|
+
|
3
|
+
This class extends `TemplateResponseDocumentFormFieldBase`
|
4
|
+
|
5
|
+
## Properties
|
6
|
+
|
7
|
+
| Name | Type | Description | Notes |
|
8
|
+
| ---- | ---- | ----------- | ----- |
|
9
|
+
| `type`<sup>*_required_</sup> | ```String``` | The type of this form field. See [field types](/api/reference/constants/#field-types).<br><br>* Text Field uses `TemplateResponseDocumentFormFieldText`<br>* Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown`<br>* Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink`<br>* Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox`<br>* Radio Field uses `TemplateResponseDocumentFormFieldRadio`<br>* Signature Field uses `TemplateResponseDocumentFormFieldSignature`<br>* Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned`<br>* Initials Field uses `TemplateResponseDocumentFormFieldInitials` | [default to 'hyperlink'] |
|
10
|
+
| `avg_text_length` | [```TemplateResponseFieldAvgTextLength```](TemplateResponseFieldAvgTextLength.md) | | |
|
11
|
+
| `is_multiline` | ```Boolean``` | Whether this form field is multiline text. | |
|
12
|
+
| `original_font_size` | ```Integer``` | Original font size used in this form field's text. | |
|
13
|
+
| `font_family` | ```String``` | Font family used in this form field's text. | |
|
14
|
+
|
@@ -0,0 +1,10 @@
|
|
1
|
+
# Dropbox::Sign::TemplateResponseDocumentFormFieldInitials
|
2
|
+
|
3
|
+
This class extends `TemplateResponseDocumentFormFieldBase`
|
4
|
+
|
5
|
+
## Properties
|
6
|
+
|
7
|
+
| Name | Type | Description | Notes |
|
8
|
+
| ---- | ---- | ----------- | ----- |
|
9
|
+
| `type`<sup>*_required_</sup> | ```String``` | The type of this form field. See [field types](/api/reference/constants/#field-types).<br><br>* Text Field uses `TemplateResponseDocumentFormFieldText`<br>* Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown`<br>* Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink`<br>* Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox`<br>* Radio Field uses `TemplateResponseDocumentFormFieldRadio`<br>* Signature Field uses `TemplateResponseDocumentFormFieldSignature`<br>* Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned`<br>* Initials Field uses `TemplateResponseDocumentFormFieldInitials` | [default to 'initials'] |
|
10
|
+
|
@@ -0,0 +1,10 @@
|
|
1
|
+
# Dropbox::Sign::TemplateResponseDocumentFormFieldRadio
|
2
|
+
|
3
|
+
This class extends `TemplateResponseDocumentFormFieldBase`
|
4
|
+
|
5
|
+
## Properties
|
6
|
+
|
7
|
+
| Name | Type | Description | Notes |
|
8
|
+
| ---- | ---- | ----------- | ----- |
|
9
|
+
| `type`<sup>*_required_</sup> | ```String``` | The type of this form field. See [field types](/api/reference/constants/#field-types).<br><br>* Text Field uses `TemplateResponseDocumentFormFieldText`<br>* Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown`<br>* Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink`<br>* Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox`<br>* Radio Field uses `TemplateResponseDocumentFormFieldRadio`<br>* Signature Field uses `TemplateResponseDocumentFormFieldSignature`<br>* Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned`<br>* Initials Field uses `TemplateResponseDocumentFormFieldInitials` | [default to 'radio'] |
|
10
|
+
|
@@ -0,0 +1,10 @@
|
|
1
|
+
# Dropbox::Sign::TemplateResponseDocumentFormFieldSignature
|
2
|
+
|
3
|
+
This class extends `TemplateResponseDocumentFormFieldBase`
|
4
|
+
|
5
|
+
## Properties
|
6
|
+
|
7
|
+
| Name | Type | Description | Notes |
|
8
|
+
| ---- | ---- | ----------- | ----- |
|
9
|
+
| `type`<sup>*_required_</sup> | ```String``` | The type of this form field. See [field types](/api/reference/constants/#field-types).<br><br>* Text Field uses `TemplateResponseDocumentFormFieldText`<br>* Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown`<br>* Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink`<br>* Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox`<br>* Radio Field uses `TemplateResponseDocumentFormFieldRadio`<br>* Signature Field uses `TemplateResponseDocumentFormFieldSignature`<br>* Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned`<br>* Initials Field uses `TemplateResponseDocumentFormFieldInitials` | [default to 'signature'] |
|
10
|
+
|
@@ -0,0 +1,15 @@
|
|
1
|
+
# Dropbox::Sign::TemplateResponseDocumentFormFieldText
|
2
|
+
|
3
|
+
This class extends `TemplateResponseDocumentFormFieldBase`
|
4
|
+
|
5
|
+
## Properties
|
6
|
+
|
7
|
+
| Name | Type | Description | Notes |
|
8
|
+
| ---- | ---- | ----------- | ----- |
|
9
|
+
| `type`<sup>*_required_</sup> | ```String``` | The type of this form field. See [field types](/api/reference/constants/#field-types).<br><br>* Text Field uses `TemplateResponseDocumentFormFieldText`<br>* Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown`<br>* Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink`<br>* Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox`<br>* Radio Field uses `TemplateResponseDocumentFormFieldRadio`<br>* Signature Field uses `TemplateResponseDocumentFormFieldSignature`<br>* Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned`<br>* Initials Field uses `TemplateResponseDocumentFormFieldInitials` | [default to 'text'] |
|
10
|
+
| `avg_text_length` | [```TemplateResponseFieldAvgTextLength```](TemplateResponseFieldAvgTextLength.md) | | |
|
11
|
+
| `is_multiline` | ```Boolean``` | Whether this form field is multiline text. | |
|
12
|
+
| `original_font_size` | ```Integer``` | Original font size used in this form field's text. | |
|
13
|
+
| `font_family` | ```String``` | Font family used in this form field's text. | |
|
14
|
+
| `validation_type` | ```String``` | Each text field may contain a `validation_type` parameter. Check out the list of [validation types](https://faq.hellosign.com/hc/en-us/articles/217115577) to learn more about the possible values. | |
|
15
|
+
|
data/docs/{TemplateResponseDocumentStaticField.md → TemplateResponseDocumentStaticFieldBase.md}
RENAMED
@@ -1,19 +1,19 @@
|
|
1
|
-
# Dropbox::Sign::
|
2
|
-
|
1
|
+
# Dropbox::Sign::TemplateResponseDocumentStaticFieldBase
|
3
2
|
|
3
|
+
An array describing static overlay fields. **Note** only available for certain subscriptions.
|
4
4
|
|
5
5
|
## Properties
|
6
6
|
|
7
7
|
| Name | Type | Description | Notes |
|
8
8
|
| ---- | ---- | ----------- | ----- |
|
9
|
+
| `type`<sup>*_required_</sup> | ```String``` | | |
|
10
|
+
| `api_id` | ```String``` | A unique id for the static field. | |
|
9
11
|
| `name` | ```String``` | The name of the static field. | |
|
10
|
-
| `
|
11
|
-
| `signer` | ```String``` | The signer of the Static Field. | |
|
12
|
+
| `signer` | ```String``` | The signer of the Static Field. | [default to 'me_now'] |
|
12
13
|
| `x` | ```Integer``` | The horizontal offset in pixels for this static field. | |
|
13
14
|
| `y` | ```Integer``` | The vertical offset in pixels for this static field. | |
|
14
15
|
| `width` | ```Integer``` | The width in pixels of this static field. | |
|
15
16
|
| `height` | ```Integer``` | The height in pixels of this static field. | |
|
16
17
|
| `required` | ```Boolean``` | Boolean showing whether or not this field is required. | |
|
17
|
-
| `api_id` | ```String``` | A unique id for the static field. | |
|
18
18
|
| `group` | ```String``` | The name of the group this field is in. If this field is not a group, this defaults to `null`. | |
|
19
19
|
|
@@ -0,0 +1,10 @@
|
|
1
|
+
# Dropbox::Sign::TemplateResponseDocumentStaticFieldCheckbox
|
2
|
+
|
3
|
+
This class extends `TemplateResponseDocumentStaticFieldBase`
|
4
|
+
|
5
|
+
## Properties
|
6
|
+
|
7
|
+
| Name | Type | Description | Notes |
|
8
|
+
| ---- | ---- | ----------- | ----- |
|
9
|
+
| `type`<sup>*_required_</sup> | ```String``` | The type of this static field. See [field types](/api/reference/constants/#field-types).<br><br>* Text Field uses `TemplateResponseDocumentStaticFieldText`<br>* Dropdown Field uses `TemplateResponseDocumentStaticFieldDropdown`<br>* Hyperlink Field uses `TemplateResponseDocumentStaticFieldHyperlink`<br>* Checkbox Field uses `TemplateResponseDocumentStaticFieldCheckbox`<br>* Radio Field uses `TemplateResponseDocumentStaticFieldRadio`<br>* Signature Field uses `TemplateResponseDocumentStaticFieldSignature`<br>* Date Signed Field uses `TemplateResponseDocumentStaticFieldDateSigned`<br>* Initials Field uses `TemplateResponseDocumentStaticFieldInitials` | [default to 'checkbox'] |
|
10
|
+
|
@@ -0,0 +1,10 @@
|
|
1
|
+
# Dropbox::Sign::TemplateResponseDocumentStaticFieldDateSigned
|
2
|
+
|
3
|
+
This class extends `TemplateResponseDocumentStaticFieldBase`
|
4
|
+
|
5
|
+
## Properties
|
6
|
+
|
7
|
+
| Name | Type | Description | Notes |
|
8
|
+
| ---- | ---- | ----------- | ----- |
|
9
|
+
| `type`<sup>*_required_</sup> | ```String``` | The type of this static field. See [field types](/api/reference/constants/#field-types).<br><br>* Text Field uses `TemplateResponseDocumentStaticFieldText`<br>* Dropdown Field uses `TemplateResponseDocumentStaticFieldDropdown`<br>* Hyperlink Field uses `TemplateResponseDocumentStaticFieldHyperlink`<br>* Checkbox Field uses `TemplateResponseDocumentStaticFieldCheckbox`<br>* Radio Field uses `TemplateResponseDocumentStaticFieldRadio`<br>* Signature Field uses `TemplateResponseDocumentStaticFieldSignature`<br>* Date Signed Field uses `TemplateResponseDocumentStaticFieldDateSigned`<br>* Initials Field uses `TemplateResponseDocumentStaticFieldInitials` | [default to 'date_signed'] |
|
10
|
+
|
@@ -0,0 +1,10 @@
|
|
1
|
+
# Dropbox::Sign::TemplateResponseDocumentStaticFieldDropdown
|
2
|
+
|
3
|
+
This class extends `TemplateResponseDocumentStaticFieldBase`
|
4
|
+
|
5
|
+
## Properties
|
6
|
+
|
7
|
+
| Name | Type | Description | Notes |
|
8
|
+
| ---- | ---- | ----------- | ----- |
|
9
|
+
| `type`<sup>*_required_</sup> | ```String``` | The type of this static field. See [field types](/api/reference/constants/#field-types).<br><br>* Text Field uses `TemplateResponseDocumentStaticFieldText`<br>* Dropdown Field uses `TemplateResponseDocumentStaticFieldDropdown`<br>* Hyperlink Field uses `TemplateResponseDocumentStaticFieldHyperlink`<br>* Checkbox Field uses `TemplateResponseDocumentStaticFieldCheckbox`<br>* Radio Field uses `TemplateResponseDocumentStaticFieldRadio`<br>* Signature Field uses `TemplateResponseDocumentStaticFieldSignature`<br>* Date Signed Field uses `TemplateResponseDocumentStaticFieldDateSigned`<br>* Initials Field uses `TemplateResponseDocumentStaticFieldInitials` | [default to 'dropdown'] |
|
10
|
+
|
@@ -0,0 +1,10 @@
|
|
1
|
+
# Dropbox::Sign::TemplateResponseDocumentStaticFieldHyperlink
|
2
|
+
|
3
|
+
This class extends `TemplateResponseDocumentStaticFieldBase`
|
4
|
+
|
5
|
+
## Properties
|
6
|
+
|
7
|
+
| Name | Type | Description | Notes |
|
8
|
+
| ---- | ---- | ----------- | ----- |
|
9
|
+
| `type`<sup>*_required_</sup> | ```String``` | The type of this static field. See [field types](/api/reference/constants/#field-types).<br><br>* Text Field uses `TemplateResponseDocumentStaticFieldText`<br>* Dropdown Field uses `TemplateResponseDocumentStaticFieldDropdown`<br>* Hyperlink Field uses `TemplateResponseDocumentStaticFieldHyperlink`<br>* Checkbox Field uses `TemplateResponseDocumentStaticFieldCheckbox`<br>* Radio Field uses `TemplateResponseDocumentStaticFieldRadio`<br>* Signature Field uses `TemplateResponseDocumentStaticFieldSignature`<br>* Date Signed Field uses `TemplateResponseDocumentStaticFieldDateSigned`<br>* Initials Field uses `TemplateResponseDocumentStaticFieldInitials` | [default to 'hyperlink'] |
|
10
|
+
|
@@ -0,0 +1,10 @@
|
|
1
|
+
# Dropbox::Sign::TemplateResponseDocumentStaticFieldInitials
|
2
|
+
|
3
|
+
This class extends `TemplateResponseDocumentStaticFieldBase`
|
4
|
+
|
5
|
+
## Properties
|
6
|
+
|
7
|
+
| Name | Type | Description | Notes |
|
8
|
+
| ---- | ---- | ----------- | ----- |
|
9
|
+
| `type`<sup>*_required_</sup> | ```String``` | The type of this static field. See [field types](/api/reference/constants/#field-types).<br><br>* Text Field uses `TemplateResponseDocumentStaticFieldText`<br>* Dropdown Field uses `TemplateResponseDocumentStaticFieldDropdown`<br>* Hyperlink Field uses `TemplateResponseDocumentStaticFieldHyperlink`<br>* Checkbox Field uses `TemplateResponseDocumentStaticFieldCheckbox`<br>* Radio Field uses `TemplateResponseDocumentStaticFieldRadio`<br>* Signature Field uses `TemplateResponseDocumentStaticFieldSignature`<br>* Date Signed Field uses `TemplateResponseDocumentStaticFieldDateSigned`<br>* Initials Field uses `TemplateResponseDocumentStaticFieldInitials` | [default to 'initials'] |
|
10
|
+
|
@@ -0,0 +1,10 @@
|
|
1
|
+
# Dropbox::Sign::TemplateResponseDocumentStaticFieldRadio
|
2
|
+
|
3
|
+
This class extends `TemplateResponseDocumentStaticFieldBase`
|
4
|
+
|
5
|
+
## Properties
|
6
|
+
|
7
|
+
| Name | Type | Description | Notes |
|
8
|
+
| ---- | ---- | ----------- | ----- |
|
9
|
+
| `type`<sup>*_required_</sup> | ```String``` | The type of this static field. See [field types](/api/reference/constants/#field-types).<br><br>* Text Field uses `TemplateResponseDocumentStaticFieldText`<br>* Dropdown Field uses `TemplateResponseDocumentStaticFieldDropdown`<br>* Hyperlink Field uses `TemplateResponseDocumentStaticFieldHyperlink`<br>* Checkbox Field uses `TemplateResponseDocumentStaticFieldCheckbox`<br>* Radio Field uses `TemplateResponseDocumentStaticFieldRadio`<br>* Signature Field uses `TemplateResponseDocumentStaticFieldSignature`<br>* Date Signed Field uses `TemplateResponseDocumentStaticFieldDateSigned`<br>* Initials Field uses `TemplateResponseDocumentStaticFieldInitials` | [default to 'radio'] |
|
10
|
+
|
@@ -0,0 +1,10 @@
|
|
1
|
+
# Dropbox::Sign::TemplateResponseDocumentStaticFieldSignature
|
2
|
+
|
3
|
+
This class extends `TemplateResponseDocumentStaticFieldBase`
|
4
|
+
|
5
|
+
## Properties
|
6
|
+
|
7
|
+
| Name | Type | Description | Notes |
|
8
|
+
| ---- | ---- | ----------- | ----- |
|
9
|
+
| `type`<sup>*_required_</sup> | ```String``` | The type of this static field. See [field types](/api/reference/constants/#field-types).<br><br>* Text Field uses `TemplateResponseDocumentStaticFieldText`<br>* Dropdown Field uses `TemplateResponseDocumentStaticFieldDropdown`<br>* Hyperlink Field uses `TemplateResponseDocumentStaticFieldHyperlink`<br>* Checkbox Field uses `TemplateResponseDocumentStaticFieldCheckbox`<br>* Radio Field uses `TemplateResponseDocumentStaticFieldRadio`<br>* Signature Field uses `TemplateResponseDocumentStaticFieldSignature`<br>* Date Signed Field uses `TemplateResponseDocumentStaticFieldDateSigned`<br>* Initials Field uses `TemplateResponseDocumentStaticFieldInitials` | [default to 'signature'] |
|
10
|
+
|
@@ -0,0 +1,10 @@
|
|
1
|
+
# Dropbox::Sign::TemplateResponseDocumentStaticFieldText
|
2
|
+
|
3
|
+
This class extends `TemplateResponseDocumentStaticFieldBase`
|
4
|
+
|
5
|
+
## Properties
|
6
|
+
|
7
|
+
| Name | Type | Description | Notes |
|
8
|
+
| ---- | ---- | ----------- | ----- |
|
9
|
+
| `type`<sup>*_required_</sup> | ```String``` | The type of this static field. See [field types](/api/reference/constants/#field-types).<br><br>* Text Field uses `TemplateResponseDocumentStaticFieldText`<br>* Dropdown Field uses `TemplateResponseDocumentStaticFieldDropdown`<br>* Hyperlink Field uses `TemplateResponseDocumentStaticFieldHyperlink`<br>* Checkbox Field uses `TemplateResponseDocumentStaticFieldCheckbox`<br>* Radio Field uses `TemplateResponseDocumentStaticFieldRadio`<br>* Signature Field uses `TemplateResponseDocumentStaticFieldSignature`<br>* Date Signed Field uses `TemplateResponseDocumentStaticFieldDateSigned`<br>* Initials Field uses `TemplateResponseDocumentStaticFieldInitials` | [default to 'text'] |
|
10
|
+
|
@@ -7,5 +7,5 @@ Average text length in this field.
|
|
7
7
|
| Name | Type | Description | Notes |
|
8
8
|
| ---- | ---- | ----------- | ----- |
|
9
9
|
| `num_lines` | ```Integer``` | Number of lines. | |
|
10
|
-
| `num_chars_per_line` | ```Integer``` | Number of
|
10
|
+
| `num_chars_per_line` | ```Integer``` | Number of characters per line. | |
|
11
11
|
|
@@ -26,6 +26,8 @@ module Dropbox::Sign
|
|
26
26
|
# Returns the status of the BulkSendJob and its SignatureRequests specified by the `bulk_send_job_id` parameter.
|
27
27
|
# @param bulk_send_job_id [String] The id of the BulkSendJob to retrieve.
|
28
28
|
# @param [Hash] opts the optional parameters
|
29
|
+
# @option opts [Integer] :page Which page number of the BulkSendJob list to return. Defaults to `1`. (default to 1)
|
30
|
+
# @option opts [Integer] :page_size Number of objects to be returned per page. Must be between `1` and `100`. Default is 20. (default to 20)
|
29
31
|
# @return [BulkSendJobGetResponse]
|
30
32
|
def bulk_send_job_get(bulk_send_job_id, opts = {})
|
31
33
|
data, _status_code, _headers = bulk_send_job_get_with_http_info(bulk_send_job_id, opts)
|
@@ -36,6 +38,8 @@ module Dropbox::Sign
|
|
36
38
|
# Returns the status of the BulkSendJob and its SignatureRequests specified by the `bulk_send_job_id` parameter.
|
37
39
|
# @param bulk_send_job_id [String] The id of the BulkSendJob to retrieve.
|
38
40
|
# @param [Hash] opts the optional parameters
|
41
|
+
# @option opts [Integer] :page Which page number of the BulkSendJob list to return. Defaults to `1`.
|
42
|
+
# @option opts [Integer] :page_size Number of objects to be returned per page. Must be between `1` and `100`. Default is 20.
|
39
43
|
# @return [Array<(BulkSendJobGetResponse, Integer, Hash)>] BulkSendJobGetResponse data, response status code and response headers
|
40
44
|
def bulk_send_job_get_with_http_info(bulk_send_job_id, opts = {})
|
41
45
|
if @api_client.config.debugging
|
@@ -50,6 +54,8 @@ module Dropbox::Sign
|
|
50
54
|
|
51
55
|
# query parameters
|
52
56
|
query_params = opts[:query_params] || {}
|
57
|
+
query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
|
58
|
+
query_params[:'page_size'] = opts[:'page_size'] if !opts[:'page_size'].nil?
|
53
59
|
|
54
60
|
# header parameters
|
55
61
|
header_params = opts[:header_params] || {}
|
@@ -108,7 +108,7 @@ module Dropbox::Sign
|
|
108
108
|
# @return [Boolean]
|
109
109
|
attr_accessor :populate_auto_fill_fields
|
110
110
|
|
111
|
-
# When the signature request will expire. Unsigned signatures will be moved to the expired status, and no longer signable. See [Signature Request Expiration Date](https://developers.hellosign.com/docs/signature-request/expiration/) for details.
|
111
|
+
# When the signature request will expire. Unsigned signatures will be moved to the expired status, and no longer signable. See [Signature Request Expiration Date](https://developers.hellosign.com/docs/signature-request/expiration/) for details.
|
112
112
|
# @return [Integer, nil]
|
113
113
|
attr_accessor :expires_at
|
114
114
|
|