Skip to content

Commit bbd0bf7

Browse files
Add warning about sms_phone_number (#345)
1 parent 8f439a3 commit bbd0bf7

File tree

51 files changed

+88
-64
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

51 files changed

+88
-64
lines changed

openapi-sdk.yaml

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6735,6 +6735,8 @@ components:
67356735
- `pin`: the 4- to 12-character access code that will secure this signer's signature page (optional)
67366736
- `sms_phone_number`: An E.164 formatted phone number that will receive a code via SMS to access this signer's signature page. (optional)
67376737
6738+
By using the feature, you agree you are responsible for obtaining a signer's consent to receive text messages from Dropbox Sign related to this signature request and confirm you have obtained such consent from all signers prior to enabling SMS delivery for this signature request. [Learn more](https://faq.hellosign.com/hc/en-us/articles/15815316468877-Dropbox-Sign-SMS-tools-add-on).
6739+
67386740
**Note**: Not available in test mode and requires a Standard plan or higher.
67396741
- `*_field`: any column with a _field" suffix will be treated as a custom field (optional)
67406742
@@ -6822,6 +6824,8 @@ components:
68226824
- `pin`: the 4- to 12-character access code that will secure this signer's signature page (optional)
68236825
- `sms_phone_number`: An E.164 formatted phone number that will receive a code via SMS to access this signer's signature page. (optional)
68246826
6827+
By using the feature, you agree you are responsible for obtaining a signer's consent to receive text messages from Dropbox Sign related to this signature request and confirm you have obtained such consent from all signers prior to enabling SMS delivery for this signature request. [Learn more](https://faq.hellosign.com/hc/en-us/articles/15815316468877-Dropbox-Sign-SMS-tools-add-on).
6828+
68256829
**Note**: Not available in test mode and requires a Standard plan or higher.
68266830
- `*_field`: any column with a _field" suffix will be treated as a custom field (optional)
68276831
@@ -8534,6 +8538,8 @@ components:
85348538
description: |-
85358539
An E.164 formatted phone number.
85368540
8541+
By using the feature, you agree you are responsible for obtaining a signer's consent to receive text messages from Dropbox Sign related to this signature request and confirm you have obtained such consent from all signers prior to enabling SMS delivery for this signature request. [Learn more](https://faq.hellosign.com/hc/en-us/articles/15815316468877-Dropbox-Sign-SMS-tools-add-on).
8542+
85378543
**Note**: Not available in test mode and requires a Standard plan or higher.
85388544
type: string
85398545
sms_phone_number_type:
@@ -8573,6 +8579,8 @@ components:
85738579
description: |-
85748580
An E.164 formatted phone number.
85758581
8582+
By using the feature, you agree you are responsible for obtaining a signer's consent to receive text messages from Dropbox Sign related to this signature request and confirm you have obtained such consent from all signers prior to enabling SMS delivery for this signature request. [Learn more](https://faq.hellosign.com/hc/en-us/articles/15815316468877-Dropbox-Sign-SMS-tools-add-on).
8583+
85768584
**Note**: Not available in test mode and requires a Standard plan or higher.
85778585
type: string
85788586
sms_phone_number_type:

openapi.yaml

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6489,6 +6489,8 @@ components:
64896489
- `pin`: the 4- to 12-character access code that will secure this signer's signature page (optional)
64906490
- `sms_phone_number`: An E.164 formatted phone number that will receive a code via SMS to access this signer's signature page. (optional)
64916491
6492+
By using the feature, you agree you are responsible for obtaining a signer's consent to receive text messages from Dropbox Sign related to this signature request and confirm you have obtained such consent from all signers prior to enabling SMS delivery for this signature request. [Learn more](https://faq.hellosign.com/hc/en-us/articles/15815316468877-Dropbox-Sign-SMS-tools-add-on).
6493+
64926494
**Note**: Not available in test mode and requires a Standard plan or higher.
64936495
- `*_field`: any column with a _field" suffix will be treated as a custom field (optional)
64946496
@@ -6576,6 +6578,8 @@ components:
65766578
- `pin`: the 4- to 12-character access code that will secure this signer's signature page (optional)
65776579
- `sms_phone_number`: An E.164 formatted phone number that will receive a code via SMS to access this signer's signature page. (optional)
65786580
6581+
By using the feature, you agree you are responsible for obtaining a signer's consent to receive text messages from Dropbox Sign related to this signature request and confirm you have obtained such consent from all signers prior to enabling SMS delivery for this signature request. [Learn more](https://faq.hellosign.com/hc/en-us/articles/15815316468877-Dropbox-Sign-SMS-tools-add-on).
6582+
65796583
**Note**: Not available in test mode and requires a Standard plan or higher.
65806584
- `*_field`: any column with a _field" suffix will be treated as a custom field (optional)
65816585
@@ -8244,6 +8248,8 @@ components:
82448248
description: |-
82458249
An E.164 formatted phone number.
82468250
8251+
By using the feature, you agree you are responsible for obtaining a signer's consent to receive text messages from Dropbox Sign related to this signature request and confirm you have obtained such consent from all signers prior to enabling SMS delivery for this signature request. [Learn more](https://faq.hellosign.com/hc/en-us/articles/15815316468877-Dropbox-Sign-SMS-tools-add-on).
8252+
82478253
**Note**: Not available in test mode and requires a Standard plan or higher.
82488254
type: string
82498255
sms_phone_number_type:
@@ -8283,6 +8289,8 @@ components:
82838289
description: |-
82848290
An E.164 formatted phone number.
82858291
8292+
By using the feature, you agree you are responsible for obtaining a signer's consent to receive text messages from Dropbox Sign related to this signature request and confirm you have obtained such consent from all signers prior to enabling SMS delivery for this signature request. [Learn more](https://faq.hellosign.com/hc/en-us/articles/15815316468877-Dropbox-Sign-SMS-tools-add-on).
8293+
82868294
**Note**: Not available in test mode and requires a Standard plan or higher.
82878295
type: string
82888296
sms_phone_number_type:

sdks/dotnet/docs/SignatureRequestBulkCreateEmbeddedWithTemplateRequest.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ Name | Type | Description | Notes
66
------------ | ------------- | ------------- | -------------
77
**TemplateIds** | **List<string>** | Use `template_ids` to create a SignatureRequest from one or more templates, in the order in which the template will be used. |
88
**ClientId** | **string** | Client id of the app you're using to create this embedded signature request. Used for security purposes. |
9-
**SignerFile** | **System.IO.Stream** | `signer_file` is a CSV file defining values and options for signer fields. Required unless a `signer_list` is used, you may not use both. The CSV can have the following columns:<br><br>- `name`: the name of the signer filling the role of RoleName - `email_address`: email address of the signer filling the role of RoleName - `pin`: the 4- to 12-character access code that will secure this signer&#39;s signature page (optional) - `sms_phone_number`: An E.164 formatted phone number that will receive a code via SMS to access this signer&#39;s signature page. (optional)<br><br> **Note**: Not available in test mode and requires a Standard plan or higher. - `*_field`: any column with a _field&quot; suffix will be treated as a custom field (optional)<br><br> You may only specify field values here, any other options should be set in the custom_fields request parameter.<br><br>Example CSV:<br><br>``` name, email_address, pin, company_field George, [email protected], d79a3td, ABC Corp Mary, [email protected], gd9as5b, 123 LLC ``` | [optional]
9+
**SignerFile** | **System.IO.Stream** | `signer_file` is a CSV file defining values and options for signer fields. Required unless a `signer_list` is used, you may not use both. The CSV can have the following columns:<br><br>- `name`: the name of the signer filling the role of RoleName - `email_address`: email address of the signer filling the role of RoleName - `pin`: the 4- to 12-character access code that will secure this signer&#39;s signature page (optional) - `sms_phone_number`: An E.164 formatted phone number that will receive a code via SMS to access this signer&#39;s signature page. (optional)<br><br> By using the feature, you agree you are responsible for obtaining a signer&#39;s consent to receive text messages from Dropbox Sign related to this signature request and confirm you have obtained such consent from all signers prior to enabling SMS delivery for this signature request. [Learn more](https://faq.hellosign.com/hc/en-us/articles/15815316468877-Dropbox-Sign-SMS-tools-add-on).<br><br> **Note**: Not available in test mode and requires a Standard plan or higher. - `*_field`: any column with a _field&quot; suffix will be treated as a custom field (optional)<br><br> You may only specify field values here, any other options should be set in the custom_fields request parameter.<br><br>Example CSV:<br><br>``` name, email_address, pin, company_field George, [email protected], d79a3td, ABC Corp Mary, [email protected], gd9as5b, 123 LLC ``` | [optional]
1010
**SignerList** | [**List&lt;SubBulkSignerList&gt;**](SubBulkSignerList.md) | `signer_list` is an array defining values and options for signer fields. Required unless a `signer_file` is used, you may not use both. | [optional]
1111
**AllowDecline** | **bool** | Allows signers to decline to sign a document if `true`. Defaults to `false`. | [optional] [default to false]
1212
**Ccs** | [**List&lt;SubCC&gt;**](SubCC.md) | Add CC email recipients. Required when a CC role exists for the Template. | [optional]

sdks/dotnet/docs/SignatureRequestBulkSendWithTemplateRequest.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
Name | Type | Description | Notes
66
------------ | ------------- | ------------- | -------------
77
**TemplateIds** | **List&lt;string&gt;** | Use `template_ids` to create a SignatureRequest from one or more templates, in the order in which the template will be used. |
8-
**SignerFile** | **System.IO.Stream** | `signer_file` is a CSV file defining values and options for signer fields. Required unless a `signer_list` is used, you may not use both. The CSV can have the following columns:<br><br>- `name`: the name of the signer filling the role of RoleName - `email_address`: email address of the signer filling the role of RoleName - `pin`: the 4- to 12-character access code that will secure this signer&#39;s signature page (optional) - `sms_phone_number`: An E.164 formatted phone number that will receive a code via SMS to access this signer&#39;s signature page. (optional)<br><br> **Note**: Not available in test mode and requires a Standard plan or higher. - `*_field`: any column with a _field&quot; suffix will be treated as a custom field (optional)<br><br> You may only specify field values here, any other options should be set in the custom_fields request parameter.<br><br>Example CSV:<br><br>``` name, email_address, pin, company_field George, [email protected], d79a3td, ABC Corp Mary, [email protected], gd9as5b, 123 LLC ``` | [optional]
8+
**SignerFile** | **System.IO.Stream** | `signer_file` is a CSV file defining values and options for signer fields. Required unless a `signer_list` is used, you may not use both. The CSV can have the following columns:<br><br>- `name`: the name of the signer filling the role of RoleName - `email_address`: email address of the signer filling the role of RoleName - `pin`: the 4- to 12-character access code that will secure this signer&#39;s signature page (optional) - `sms_phone_number`: An E.164 formatted phone number that will receive a code via SMS to access this signer&#39;s signature page. (optional)<br><br> By using the feature, you agree you are responsible for obtaining a signer&#39;s consent to receive text messages from Dropbox Sign related to this signature request and confirm you have obtained such consent from all signers prior to enabling SMS delivery for this signature request. [Learn more](https://faq.hellosign.com/hc/en-us/articles/15815316468877-Dropbox-Sign-SMS-tools-add-on).<br><br> **Note**: Not available in test mode and requires a Standard plan or higher. - `*_field`: any column with a _field&quot; suffix will be treated as a custom field (optional)<br><br> You may only specify field values here, any other options should be set in the custom_fields request parameter.<br><br>Example CSV:<br><br>``` name, email_address, pin, company_field George, [email protected], d79a3td, ABC Corp Mary, [email protected], gd9as5b, 123 LLC ``` | [optional]
99
**SignerList** | [**List&lt;SubBulkSignerList&gt;**](SubBulkSignerList.md) | `signer_list` is an array defining values and options for signer fields. Required unless a `signer_file` is used, you may not use both. | [optional]
1010
**AllowDecline** | **bool** | Allows signers to decline to sign a document if `true`. Defaults to `false`. | [optional] [default to false]
1111
**Ccs** | [**List&lt;SubCC&gt;**](SubCC.md) | Add CC email recipients. Required when a CC role exists for the Template. | [optional]

sdks/dotnet/docs/SubSignatureRequestSigner.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ Name | Type | Description | Notes
88
**EmailAddress** | **string** | The email address of the signer. |
99
**Order** | **int?** | The order the signer is required to sign in. | [optional]
1010
**Pin** | **string** | The 4- to 12-character access code that will secure this signer&#39;s signature page. | [optional]
11-
**SmsPhoneNumber** | **string** | An E.164 formatted phone number.<br><br>**Note**: Not available in test mode and requires a Standard plan or higher. | [optional]
11+
**SmsPhoneNumber** | **string** | An E.164 formatted phone number.<br><br>By using the feature, you agree you are responsible for obtaining a signer&#39;s consent to receive text messages from Dropbox Sign related to this signature request and confirm you have obtained such consent from all signers prior to enabling SMS delivery for this signature request. [Learn more](https://faq.hellosign.com/hc/en-us/articles/15815316468877-Dropbox-Sign-SMS-tools-add-on).<br><br>**Note**: Not available in test mode and requires a Standard plan or higher. | [optional]
1212
**SmsPhoneNumberType** | **string** | Specifies the feature used with the `sms_phone_number`. Default `authentication`.<br><br>If `authentication`, signer is sent a verification code via SMS that is required to access the document.<br><br>If `delivery`, a link to complete the signature request is delivered via SMS (_and_ email). | [optional]
1313

1414
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

sdks/dotnet/docs/SubSignatureRequestTemplateSigner.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ Name | Type | Description | Notes
88
**Name** | **string** | The name of the signer. |
99
**EmailAddress** | **string** | The email address of the signer. |
1010
**Pin** | **string** | The 4- to 12-character access code that will secure this signer&#39;s signature page. | [optional]
11-
**SmsPhoneNumber** | **string** | An E.164 formatted phone number.<br><br>**Note**: Not available in test mode and requires a Standard plan or higher. | [optional]
11+
**SmsPhoneNumber** | **string** | An E.164 formatted phone number.<br><br>By using the feature, you agree you are responsible for obtaining a signer&#39;s consent to receive text messages from Dropbox Sign related to this signature request and confirm you have obtained such consent from all signers prior to enabling SMS delivery for this signature request. [Learn more](https://faq.hellosign.com/hc/en-us/articles/15815316468877-Dropbox-Sign-SMS-tools-add-on).<br><br>**Note**: Not available in test mode and requires a Standard plan or higher. | [optional]
1212
**SmsPhoneNumberType** | **string** | Specifies the feature used with the `sms_phone_number`. Default `authentication`.<br><br>If `authentication`, signer is sent a verification code via SMS that is required to access the document.<br><br>If `delivery`, a link to complete the signature request is delivered via SMS (_and_ email). | [optional]
1313

1414
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

0 commit comments

Comments
 (0)