Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 13 additions & 2 deletions openapi-raw.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -9986,6 +9986,7 @@ components:
- enabled
- enabled_by_default
- forced
x-hideOn: sdk
type: object
x-hideOn: sdk
SubTemplateRole:
Expand Down Expand Up @@ -11682,7 +11683,11 @@ components:
type: string
nullable: true
signer_experience:
$ref: '#/components/schemas/SignatureRequestSignerExperience'
description: '_t__SignatureRequestSignerExperience::DESCRIPTION'
allOf:
-
$ref: '#/components/schemas/SignatureRequestSignerExperience'
x-hideOn: sdk
type: object
x-internal-class: true
SignatureRequestResponseAttachment:
Expand Down Expand Up @@ -12053,8 +12058,10 @@ components:
- enabled
- enabled_by_default
- forced
x-hideOn: sdk
type: object
x-internal-class: true
x-hideOn: sdk
TeamResponse:
description: '_t__TeamResponse::DESCRIPTION'
properties:
Expand Down Expand Up @@ -12224,7 +12231,11 @@ components:
items:
$ref: '#/components/schemas/SignatureRequestResponseAttachment'
signer_experience:
$ref: '#/components/schemas/SignatureRequestSignerExperience'
description: '_t__SignatureRequestSignerExperience::DESCRIPTION'
allOf:
-
$ref: '#/components/schemas/SignatureRequestSignerExperience'
x-hideOn: sdk
type: object
x-internal-class: true
TemplateResponseAccount:
Expand Down
24 changes: 0 additions & 24 deletions openapi-sdk.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -12341,8 +12341,6 @@ components:
description: 'The ID of the Bulk Send job which sent the signature request, if applicable.'
type: string
nullable: true
signer_experience:
$ref: '#/components/schemas/SignatureRequestSignerExperience'
type: object
x-internal-class: true
SignatureRequestResponseAttachment:
Expand Down Expand Up @@ -12704,26 +12702,6 @@ components:
nullable: true
type: object
x-internal-class: true
SignatureRequestSignerExperience:
description: 'Configuration options for modifying the settings of the signer application. Supports changing the form view behavior.'
required:
- form_view
properties:
form_view:
description: |-
Changes the form view setting experienced by the signer. Supported versions are:
- `disabled` - Form view is disabled, and the signer cannot change it
- `enabled` - Form view is disabled initially, the signer can turn it on using a toggle
- `enabled_by_default` - Form view is enabled initially. The signer car turn it off using a toggle
- `forced` - Form view is enabled initially. The signer cannot change it, the toggle is hidden.
type: string
enum:
- disabled
- enabled
- enabled_by_default
- forced
type: object
x-internal-class: true
TeamResponse:
description: 'Contains information about your team and its members'
properties:
Expand Down Expand Up @@ -12895,8 +12873,6 @@ components:
type: array
items:
$ref: '#/components/schemas/SignatureRequestResponseAttachment'
signer_experience:
$ref: '#/components/schemas/SignatureRequestSignerExperience'
type: object
x-internal-class: true
TemplateResponseAccount:
Expand Down
41 changes: 26 additions & 15 deletions openapi.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -7974,7 +7974,7 @@ components:
type: boolean
default: false
signer_experience:
description: 'TBD Form View'
description: 'Configuration options for modifying the settings of the signer application. Supports changing the form view behavior.'
allOf:
-
$ref: '#/components/schemas/SubSignerExperience'
Expand Down Expand Up @@ -8567,7 +8567,7 @@ components:
type: boolean
default: false
signer_experience:
description: 'TBD Form View'
description: 'Configuration options for modifying the settings of the signer application. Supports changing the form view behavior.'
allOf:
-
$ref: '#/components/schemas/SubSignerExperience'
Expand Down Expand Up @@ -8661,7 +8661,7 @@ components:
type: boolean
default: false
signer_experience:
description: 'TBD Form View'
description: 'Configuration options for modifying the settings of the signer application. Supports changing the form view behavior.'
allOf:
-
$ref: '#/components/schemas/SubSignerExperience'
Expand Down Expand Up @@ -8821,7 +8821,7 @@ components:
type: integer
nullable: true
signer_experience:
description: 'TBD Form View'
description: 'Configuration options for modifying the settings of the signer application. Supports changing the form view behavior.'
allOf:
-
$ref: '#/components/schemas/SubSignerExperience'
Expand Down Expand Up @@ -8979,7 +8979,7 @@ components:
type: integer
nullable: true
signer_experience:
description: 'TBD Form View'
description: 'Configuration options for modifying the settings of the signer application. Supports changing the form view behavior.'
allOf:
-
$ref: '#/components/schemas/SubSignerExperience'
Expand Down Expand Up @@ -9069,7 +9069,7 @@ components:
type: boolean
default: false
signer_experience:
description: 'TBD Form View'
description: 'Configuration options for modifying the settings of the signer application. Supports changing the form view behavior.'
allOf:
-
$ref: '#/components/schemas/SubSignerExperience'
Expand Down Expand Up @@ -9163,7 +9163,7 @@ components:
type: string
maxLength: 255
signer_experience:
description: 'TBD Form View'
description: 'Configuration options for modifying the settings of the signer application. Supports changing the form view behavior.'
allOf:
-
$ref: '#/components/schemas/SubSignerExperience'
Expand Down Expand Up @@ -9335,7 +9335,7 @@ components:
type: integer
nullable: true
signer_experience:
description: 'TBD Form View'
description: 'Configuration options for modifying the settings of the signer application. Supports changing the form view behavior.'
allOf:
-
$ref: '#/components/schemas/SubSignerExperience'
Expand Down Expand Up @@ -9429,7 +9429,7 @@ components:
type: string
maxLength: 255
signer_experience:
description: 'TBD Form View'
description: 'Configuration options for modifying the settings of the signer application. Supports changing the form view behavior.'
allOf:
-
$ref: '#/components/schemas/SubSignerExperience'
Expand Down Expand Up @@ -10405,6 +10405,7 @@ components:
- enabled
- enabled_by_default
- forced
x-hideOn: sdk
type: object
x-hideOn: sdk
SubTemplateRole:
Expand Down Expand Up @@ -10719,7 +10720,7 @@ components:
type: boolean
default: false
signer_experience:
description: 'TBD Form View'
description: 'Configuration options for modifying the settings of the signer application. Supports changing the form view behavior.'
allOf:
-
$ref: '#/components/schemas/SubSignerExperience'
Expand Down Expand Up @@ -10867,7 +10868,7 @@ components:
type: boolean
default: false
signer_experience:
description: 'TBD Form View'
description: 'Configuration options for modifying the settings of the signer application. Supports changing the form view behavior.'
allOf:
-
$ref: '#/components/schemas/SubSignerExperience'
Expand Down Expand Up @@ -10907,7 +10908,7 @@ components:
items:
$ref: '#/components/schemas/SubUpdateFormField'
signer_experience:
description: 'TBD Form View'
description: 'Configuration options for modifying the settings of the signer application. Supports changing the form view behavior.'
allOf:
-
$ref: '#/components/schemas/SubSignerExperience'
Expand Down Expand Up @@ -11089,7 +11090,7 @@ components:
type: integer
nullable: true
signer_experience:
description: 'TBD Form View'
description: 'Configuration options for modifying the settings of the signer application. Supports changing the form view behavior.'
allOf:
-
$ref: '#/components/schemas/SubSignerExperience'
Expand Down Expand Up @@ -12301,7 +12302,11 @@ components:
type: string
nullable: true
signer_experience:
$ref: '#/components/schemas/SignatureRequestSignerExperience'
description: 'Configuration options for modifying the settings of the signer application. Supports changing the form view behavior.'
allOf:
-
$ref: '#/components/schemas/SignatureRequestSignerExperience'
x-hideOn: sdk
type: object
x-internal-class: true
SignatureRequestResponseAttachment:
Expand Down Expand Up @@ -12681,8 +12686,10 @@ components:
- enabled
- enabled_by_default
- forced
x-hideOn: sdk
type: object
x-internal-class: true
x-hideOn: sdk
TeamResponse:
description: 'Contains information about your team and its members'
properties:
Expand Down Expand Up @@ -12855,7 +12862,11 @@ components:
items:
$ref: '#/components/schemas/SignatureRequestResponseAttachment'
signer_experience:
$ref: '#/components/schemas/SignatureRequestSignerExperience'
description: 'Configuration options for modifying the settings of the signer application. Supports changing the form view behavior.'
allOf:
-
$ref: '#/components/schemas/SignatureRequestSignerExperience'
x-hideOn: sdk
type: object
x-internal-class: true
TemplateResponseAccount:
Expand Down
1 change: 0 additions & 1 deletion sdks/dotnet/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -301,7 +301,6 @@ Class | Method | HTTP request | Description
- [Model.SignatureRequestResponseSignatures](docs/SignatureRequestResponseSignatures.md)
- [Model.SignatureRequestSendRequest](docs/SignatureRequestSendRequest.md)
- [Model.SignatureRequestSendWithTemplateRequest](docs/SignatureRequestSendWithTemplateRequest.md)
- [Model.SignatureRequestSignerExperience](docs/SignatureRequestSignerExperience.md)
- [Model.SignatureRequestUpdateRequest](docs/SignatureRequestUpdateRequest.md)
- [Model.SubAttachment](docs/SubAttachment.md)
- [Model.SubBulkSignerList](docs/SubBulkSignerList.md)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**TestMode** | **bool** | Whether this is a test signature request. Test requests have no legal value. Defaults to `false`. | [optional] [default to false]**SignatureRequestId** | **string** | The id of the SignatureRequest. | [optional] **RequesterEmailAddress** | **string** | The email address of the initiator of the SignatureRequest. | [optional] **Title** | **string** | The title the specified Account uses for the SignatureRequest. | [optional] **OriginalTitle** | **string** | Default Label for account. | [optional] **Subject** | **string** | The subject in the email that was initially sent to the signers. | [optional] **Message** | **string** | The custom message in the email that was initially sent to the signers. | [optional] **Metadata** | **Dictionary&lt;string, Object&gt;** | The metadata attached to the signature request. | [optional] **CreatedAt** | **int** | Time the signature request was created. | [optional] **ExpiresAt** | **int?** | The time when the signature request will expire unsigned signatures. See [Signature Request Expiration Date](https://developers.hellosign.com/docs/signature-request/expiration/) for details. | [optional] **IsComplete** | **bool** | Whether or not the SignatureRequest has been fully executed by all signers. | [optional] **IsDeclined** | **bool** | Whether or not the SignatureRequest has been declined by a signer. | [optional] **HasError** | **bool** | Whether or not an error occurred (either during the creation of the SignatureRequest or during one of the signings). | [optional] **FilesUrl** | **string** | The URL where a copy of the request&#39;s documents can be downloaded. | [optional] **SigningUrl** | **string** | The URL where a signer, after authenticating, can sign the documents. This should only be used by users with existing Dropbox Sign accounts as they will be required to log in before signing. | [optional] **DetailsUrl** | **string** | The URL where the requester and the signers can view the current status of the SignatureRequest. | [optional] **CcEmailAddresses** | **List&lt;string&gt;** | A list of email addresses that were CCed on the SignatureRequest. They will receive a copy of the final PDF once all the signers have signed. | [optional] **SigningRedirectUrl** | **string** | The URL you want the signer redirected to after they successfully sign. | [optional] **FinalCopyUri** | **string** | The path where the completed document can be downloaded | [optional] **TemplateIds** | **List&lt;string&gt;** | Templates IDs used in this SignatureRequest (if any). | [optional] **CustomFields** | [**List&lt;SignatureRequestResponseCustomFieldBase&gt;**](SignatureRequestResponseCustomFieldBase.md) | An array of Custom Field objects containing the name and type of each custom field.<br><br>* Text Field uses `SignatureRequestResponseCustomFieldText`<br>* Checkbox Field uses `SignatureRequestResponseCustomFieldCheckbox` | [optional] **Attachments** | [**List&lt;SignatureRequestResponseAttachment&gt;**](SignatureRequestResponseAttachment.md) | Signer attachments. | [optional] **ResponseData** | [**List&lt;SignatureRequestResponseDataBase&gt;**](SignatureRequestResponseDataBase.md) | An array of form field objects containing the name, value, and type of each textbox or checkmark field filled in by the signers. | [optional] **Signatures** | [**List&lt;SignatureRequestResponseSignatures&gt;**](SignatureRequestResponseSignatures.md) | An array of signature objects, 1 for each signer. | [optional] **BulkSendJobId** | **string** | The id of the BulkSendJob. | [optional] **SignerExperience** | [**SignatureRequestSignerExperience**](SignatureRequestSignerExperience.md) | | [optional]
**TestMode** | **bool** | Whether this is a test signature request. Test requests have no legal value. Defaults to `false`. | [optional] [default to false]**SignatureRequestId** | **string** | The id of the SignatureRequest. | [optional] **RequesterEmailAddress** | **string** | The email address of the initiator of the SignatureRequest. | [optional] **Title** | **string** | The title the specified Account uses for the SignatureRequest. | [optional] **OriginalTitle** | **string** | Default Label for account. | [optional] **Subject** | **string** | The subject in the email that was initially sent to the signers. | [optional] **Message** | **string** | The custom message in the email that was initially sent to the signers. | [optional] **Metadata** | **Dictionary&lt;string, Object&gt;** | The metadata attached to the signature request. | [optional] **CreatedAt** | **int** | Time the signature request was created. | [optional] **ExpiresAt** | **int?** | The time when the signature request will expire unsigned signatures. See [Signature Request Expiration Date](https://developers.hellosign.com/docs/signature-request/expiration/) for details. | [optional] **IsComplete** | **bool** | Whether or not the SignatureRequest has been fully executed by all signers. | [optional] **IsDeclined** | **bool** | Whether or not the SignatureRequest has been declined by a signer. | [optional] **HasError** | **bool** | Whether or not an error occurred (either during the creation of the SignatureRequest or during one of the signings). | [optional] **FilesUrl** | **string** | The URL where a copy of the request&#39;s documents can be downloaded. | [optional] **SigningUrl** | **string** | The URL where a signer, after authenticating, can sign the documents. This should only be used by users with existing Dropbox Sign accounts as they will be required to log in before signing. | [optional] **DetailsUrl** | **string** | The URL where the requester and the signers can view the current status of the SignatureRequest. | [optional] **CcEmailAddresses** | **List&lt;string&gt;** | A list of email addresses that were CCed on the SignatureRequest. They will receive a copy of the final PDF once all the signers have signed. | [optional] **SigningRedirectUrl** | **string** | The URL you want the signer redirected to after they successfully sign. | [optional] **FinalCopyUri** | **string** | The path where the completed document can be downloaded | [optional] **TemplateIds** | **List&lt;string&gt;** | Templates IDs used in this SignatureRequest (if any). | [optional] **CustomFields** | [**List&lt;SignatureRequestResponseCustomFieldBase&gt;**](SignatureRequestResponseCustomFieldBase.md) | An array of Custom Field objects containing the name and type of each custom field.<br><br>* Text Field uses `SignatureRequestResponseCustomFieldText`<br>* Checkbox Field uses `SignatureRequestResponseCustomFieldCheckbox` | [optional] **Attachments** | [**List&lt;SignatureRequestResponseAttachment&gt;**](SignatureRequestResponseAttachment.md) | Signer attachments. | [optional] **ResponseData** | [**List&lt;SignatureRequestResponseDataBase&gt;**](SignatureRequestResponseDataBase.md) | An array of form field objects containing the name, value, and type of each textbox or checkmark field filled in by the signers. | [optional] **Signatures** | [**List&lt;SignatureRequestResponseSignatures&gt;**](SignatureRequestResponseSignatures.md) | An array of signature objects, 1 for each signer. | [optional] **BulkSendJobId** | **string** | The id of the BulkSendJob. | [optional]

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

Loading
Loading