Skip to content

Improvements to Template response; reduces nullability #440

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
jtreminio-dropbox merged 4 commits into from
Oct 17, 2024
Merged

Improvements to Template response; reduces nullability #440

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
c81d915
Improvements to Template response; reduces nullability
jtreminio-dropbox Oct 15, 2024
f0865d2
Adds a few more non-nullables
jtreminio-dropbox Oct 15, 2024
0df4bb8
Undo bad merge
jtreminio-dropbox Oct 16, 2024
3538c25
Updating documentation for template.is_embedded
jtreminio-dropbox Oct 17, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
165 changes: 124 additions & 41 deletions openapi-raw.yaml
View file
Open in desktop

Large diffs are not rendered by default.

167 changes: 125 additions & 42 deletions openapi-sdk.yaml
View file
Open in desktop

Large diffs are not rendered by default.

167 changes: 125 additions & 42 deletions openapi.yaml
View file
Open in desktop

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion sdks/dotnet/docs/TemplateCreateEmbeddedDraftResponseTemplate.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ Template object with parameters: `template_id`, `edit_url`, `expires_at`.

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**TemplateId** | **string** | The id of the Template. | [optional] **EditUrl** | **string** | Link to edit the template. | [optional] **ExpiresAt** | **int** | When the link expires. | [optional] **Warnings** | [**List<WarningResponse>**](WarningResponse.md) | A list of warnings. | [optional]
**TemplateId** | **string** | The id of the Template. | **EditUrl** | **string** | Link to edit the template. | **ExpiresAt** | **int** | When the link expires. | **Warnings** | [**List<WarningResponse>**](WarningResponse.md) | A list of warnings. | [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)

2 changes: 1 addition & 1 deletion sdks/dotnet/docs/TemplateCreateResponseTemplate.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ Template object with parameters: `template_id`.

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**TemplateId** | **string** | The id of the Template. | [optional]
**TemplateId** | **string** | The id of the Template. |

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

2 changes: 1 addition & 1 deletion sdks/dotnet/docs/TemplateResponse.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ Contains information about the templates you and your team have created.

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**TemplateId** | **string** | The id of the Template. | [optional] **Title** | **string** | The title of the Template. This will also be the default subject of the message sent to signers when using this Template to send a SignatureRequest. This can be overridden when sending the SignatureRequest. | [optional] **Message** | **string** | The default message that will be sent to signers when using this Template to send a SignatureRequest. This can be overridden when sending the SignatureRequest. | [optional] **UpdatedAt** | **int** | Time the template was last updated. | [optional] **IsEmbedded** | **bool?** | `true` if this template was created using an embedded flow, `false` if it was created on our website. | [optional] **IsCreator** | **bool?** | `true` if you are the owner of this template, `false` if it's been shared with you by a team member. | [optional] **CanEdit** | **bool?** | Indicates whether edit rights have been granted to you by the owner (always `true` if that's you). | [optional] **IsLocked** | **bool?** | Indicates whether the template is locked. If `true`, then the template was created outside your quota and can only be used in `test_mode`. If `false`, then the template is within your quota and can be used to create signature requests. | [optional] **Metadata** | **Object** | The metadata attached to the template. | [optional] **SignerRoles** | [**List<TemplateResponseSignerRole>**](TemplateResponseSignerRole.md) | An array of the designated signer roles that must be specified when sending a SignatureRequest using this Template. | [optional] **CcRoles** | [**List<TemplateResponseCCRole>**](TemplateResponseCCRole.md) | An array of the designated CC roles that must be specified when sending a SignatureRequest using this Template. | [optional] **Documents** | [**List<TemplateResponseDocument>**](TemplateResponseDocument.md) | An array describing each document associated with this Template. Includes form field data for each document. | [optional] **CustomFields** | [**List<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. | [optional] **NamedFormFields** | [**List<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. | [optional] **Accounts** | [**List<TemplateResponseAccount>**](TemplateResponseAccount.md) | An array of the Accounts that can use this Template. | [optional]
**TemplateId** | **string** | The id of the Template. | **Title** | **string** | The title of the Template. This will also be the default subject of the message sent to signers when using this Template to send a SignatureRequest. This can be overridden when sending the SignatureRequest. | **Message** | **string** | The default message that will be sent to signers when using this Template to send a SignatureRequest. This can be overridden when sending the SignatureRequest. | **IsCreator** | **bool** | `true` if you are the owner of this template, `false` if it's been shared with you by a team member. | **CanEdit** | **bool** | Indicates whether edit rights have been granted to you by the owner (always `true` if that's you). | **IsLocked** | **bool** | Indicates whether the template is locked. If `true`, then the template was created outside your quota and can only be used in `test_mode`. If `false`, then the template is within your quota and can be used to create signature requests. | **Metadata** | **Object** | The metadata attached to the template. | **SignerRoles** | [**List<TemplateResponseSignerRole>**](TemplateResponseSignerRole.md) | An array of the designated signer roles that must be specified when sending a SignatureRequest using this Template. | **CcRoles** | [**List<TemplateResponseCCRole>**](TemplateResponseCCRole.md) | An array of the designated CC roles that must be specified when sending a SignatureRequest using this Template. | **Documents** | [**List<TemplateResponseDocument>**](TemplateResponseDocument.md) | An array describing each document associated with this Template. Includes form field data for each document. | **Accounts** | [**List<TemplateResponseAccount>**](TemplateResponseAccount.md) | An array of the Accounts that can use this Template. | **Attachments** | [**List<SignatureRequestResponseAttachment>**](SignatureRequestResponseAttachment.md) | Signer attachments. | **UpdatedAt** | **int** | Time the template was last updated. | [optional] **IsEmbedded** | **bool?** | `true` if this template was created using an embedded flow, `false` if it was created on our website. Will be `null` when you are not the creator of the Template. | [optional] **CustomFields** | [**List<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. | [optional] **NamedFormFields** | [**List<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. | [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)

2 changes: 1 addition & 1 deletion sdks/dotnet/docs/TemplateResponseAccount.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**AccountId** | **string** | The id of the Account. | [optional] **EmailAddress** | **string** | The email address associated with the Account. | [optional] **IsLocked** | **bool** | Returns `true` if the user has been locked out of their account by a team admin. | [optional] **IsPaidHs** | **bool** | Returns `true` if the user has a paid Dropbox Sign account. | [optional] **IsPaidHf** | **bool** | Returns `true` if the user has a paid HelloFax account. | [optional] **Quotas** | [**TemplateResponseAccountQuota**](TemplateResponseAccountQuota.md) | | [optional]
**AccountId** | **string** | The id of the Account. | **IsLocked** | **bool** | Returns `true` if the user has been locked out of their account by a team admin. | **IsPaidHs** | **bool** | Returns `true` if the user has a paid Dropbox Sign account. | **IsPaidHf** | **bool** | Returns `true` if the user has a paid HelloFax account. | **Quotas** | [**TemplateResponseAccountQuota**](TemplateResponseAccountQuota.md) | | **EmailAddress** | **string** | The email address associated with the Account. | [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)

2 changes: 1 addition & 1 deletion sdks/dotnet/docs/TemplateResponseAccountQuota.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ An array of the designated CC roles that must be specified when sending a Signat

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**TemplatesLeft** | **int** | API templates remaining. | [optional] **ApiSignatureRequestsLeft** | **int** | API signature requests remaining. | [optional] **DocumentsLeft** | **int** | Signature requests remaining. | [optional] **SmsVerificationsLeft** | **int** | SMS verifications remaining. | [optional]
**TemplatesLeft** | **int** | API templates remaining. | **ApiSignatureRequestsLeft** | **int** | API signature requests remaining. | **DocumentsLeft** | **int** | Signature requests remaining. | **SmsVerificationsLeft** | **int** | SMS verifications remaining. |

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

2 changes: 1 addition & 1 deletion sdks/dotnet/docs/TemplateResponseCCRole.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Name** | **string** | The name of the Role. | [optional]
**Name** | **string** | The name of the Role. |

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

2 changes: 1 addition & 1 deletion sdks/dotnet/docs/TemplateResponseDocument.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Name** | **string** | Name of the associated file. | [optional] **Index** | **int** | Document ordering, the lowest index is displayed first and the highest last (0-based indexing). | [optional] **FieldGroups** | [**List<TemplateResponseDocumentFieldGroup>**](TemplateResponseDocumentFieldGroup.md) | An array of Form Field Group objects. | [optional] **FormFields** | [**List<TemplateResponseDocumentFormFieldBase>**](TemplateResponseDocumentFormFieldBase.md) | An array of Form Field objects containing the name and type of each named field. | [optional] **CustomFields** | [**List<TemplateResponseDocumentCustomFieldBase>**](TemplateResponseDocumentCustomFieldBase.md) | An array of Form Field objects containing the name and type of each named field. | [optional] **StaticFields** | [**List<TemplateResponseDocumentStaticFieldBase>**](TemplateResponseDocumentStaticFieldBase.md) | An array describing static overlay fields. **NOTE:** Only available for certain subscriptions. | [optional]
**Name** | **string** | Name of the associated file. | **FieldGroups** | [**List<TemplateResponseDocumentFieldGroup>**](TemplateResponseDocumentFieldGroup.md) | An array of Form Field Group objects. | **FormFields** | [**List<TemplateResponseDocumentFormFieldBase>**](TemplateResponseDocumentFormFieldBase.md) | An array of Form Field objects containing the name and type of each named field. | **CustomFields** | [**List<TemplateResponseDocumentCustomFieldBase>**](TemplateResponseDocumentCustomFieldBase.md) | An array of Form Field objects containing the name and type of each named field. | **StaticFields** | [**List<TemplateResponseDocumentStaticFieldBase>**](TemplateResponseDocumentStaticFieldBase.md) | An array describing static overlay fields. **NOTE:** Only available for certain subscriptions. | **Index** | **int** | Document ordering, the lowest index is displayed first and the highest last (0-based indexing). | [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)

2 changes: 1 addition & 1 deletion sdks/dotnet/docs/TemplateResponseDocumentCustomFieldBase.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ An array of Form Field objects containing the name and type of each named field.

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Type** | **string** | | **ApiId** | **string** | The unique ID for this field. | [optional] **Name** | **string** | The name of the Custom Field. | [optional] **Signer** | **string** | The signer of the Custom Field. Can be `null` if field is a merge field (assigned to Sender). | [optional] **X** | **int** | The horizontal offset in pixels for this form field. | [optional] **Y** | **int** | The vertical offset in pixels for this form field. | [optional] **Width** | **int** | The width in pixels of this form field. | [optional] **Height** | **int** | The height in pixels of this form field. | [optional] **Required** | **bool** | Boolean showing whether or not this field is required. | [optional] **Group** | **string** | The name of the group this field is in. If this field is not a group, this defaults to `null`. | [optional]
**ApiId** | **string** | The unique ID for this field. | **Name** | **string** | The name of the Custom Field. | **Type** | **string** | | **X** | **int** | The horizontal offset in pixels for this form field. | **Y** | **int** | The vertical offset in pixels for this form field. | **Width** | **int** | The width in pixels of this form field. | **Height** | **int** | The height in pixels of this form field. | **Required** | **bool** | Boolean showing whether or not this field is required. | **Signer** | **string** | The signer of the Custom Field. Can be `null` if field is a merge field (assigned to Sender). | [optional] **Group** | **string** | The name of the group this field is in. If this field is not a group, this defaults to `null`. | [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)

14 changes: 7 additions & 7 deletions sdks/dotnet/docs/TemplateResponseDocumentCustomFieldCheckbox.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,14 +5,14 @@ This class extends `TemplateResponseDocumentCustomFieldBase`

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**ApiId** | **string** | The unique ID for this field. | [optional]
**Name** | **string** | The name of the Custom Field. | [optional]
**ApiId** | **string** | The unique ID for this field. |
**Name** | **string** | The name of the Custom Field. |
**X** | **int** | The horizontal offset in pixels for this form field. |
**Y** | **int** | The vertical offset in pixels for this form field. |
**Width** | **int** | The width in pixels of this form field. |
**Height** | **int** | The height in pixels of this form field. |
**Required** | **bool** | Boolean showing whether or not this field is required. |
**Signer** | **string** | The signer of the Custom Field. Can be `null` if field is a merge field (assigned to Sender). | [optional]
**X** | **int** | The horizontal offset in pixels for this form field. | [optional]
**Y** | **int** | The vertical offset in pixels for this form field. | [optional]
**Width** | **int** | The width in pixels of this form field. | [optional]
**Height** | **int** | The height in pixels of this form field. | [optional]
**Required** | **bool** | Boolean showing whether or not this field is required. | [optional]
**Group** | **string** | The name of the group this field is in. If this field is not a group, this defaults to `null`. | [optional]
**Type** | **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"]

Expand Down
16 changes: 8 additions & 8 deletions sdks/dotnet/docs/TemplateResponseDocumentCustomFieldText.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,16 +5,16 @@ This class extends `TemplateResponseDocumentCustomFieldBase`

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**ApiId** | **string** | The unique ID for this field. | [optional]
**Name** | **string** | The name of the Custom Field. | [optional]
**ApiId** | **string** | The unique ID for this field. |
**Name** | **string** | The name of the Custom Field. |
**X** | **int** | The horizontal offset in pixels for this form field. |
**Y** | **int** | The vertical offset in pixels for this form field. |
**Width** | **int** | The width in pixels of this form field. |
**Height** | **int** | The height in pixels of this form field. |
**Required** | **bool** | Boolean showing whether or not this field is required. |
**Signer** | **string** | The signer of the Custom Field. Can be `null` if field is a merge field (assigned to Sender). | [optional]
**X** | **int** | The horizontal offset in pixels for this form field. | [optional]
**Y** | **int** | The vertical offset in pixels for this form field. | [optional]
**Width** | **int** | The width in pixels of this form field. | [optional]
**Height** | **int** | The height in pixels of this form field. | [optional]
**Required** | **bool** | Boolean showing whether or not this field is required. | [optional]
**Group** | **string** | The name of the group this field is in. If this field is not a group, this defaults to `null`. | [optional]
**Type** | **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"]**AvgTextLength** | [**TemplateResponseFieldAvgTextLength**](TemplateResponseFieldAvgTextLength.md) | | [optional] **IsMultiline** | **bool** | Whether this form field is multiline text. | [optional] **OriginalFontSize** | **int** | Original font size used in this form field&#39;s text. | [optional] **FontFamily** | **string** | Font family used in this form field&#39;s text. | [optional]
**Type** | **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"]**AvgTextLength** | [**TemplateResponseFieldAvgTextLength**](TemplateResponseFieldAvgTextLength.md) | | **IsMultiline** | **bool** | Whether this form field is multiline text. | **OriginalFontSize** | **int** | Original font size used in this form field&#39;s text. | **FontFamily** | **string** | Font family used in this form field&#39;s text. |

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

2 changes: 1 addition & 1 deletion sdks/dotnet/docs/TemplateResponseDocumentFieldGroup.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Name** | **string** | The name of the form field group. | [optional] **Rule** | [**TemplateResponseDocumentFieldGroupRule**](TemplateResponseDocumentFieldGroupRule.md) | | [optional]
**Name** | **string** | The name of the form field group. | **Rule** | [**TemplateResponseDocumentFieldGroupRule**](TemplateResponseDocumentFieldGroupRule.md) | |

[[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