Skip to content

Commit

Permalink
Release 1.1.0 (#4)
Browse files Browse the repository at this point in the history
  • Loading branch information
jtreminio-dropbox authored Feb 27, 2023
1 parent 268a1be commit f0a3094
Show file tree
Hide file tree
Showing 72 changed files with 9,415 additions and 2,059 deletions.
33 changes: 25 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@ To install the bindings via [Composer](https://getcomposer.org/), add the follow
```json
{
"require": {
"dropbox/sign": "^1.0.0"
"dropbox/sign": "^1.1.0"
},
"minimum-stability": "dev"
}
Expand All @@ -64,7 +64,7 @@ Then run `composer install`.
Alternatively, install directly with

```
composer require dropbox/sign:^1.0.0
composer require dropbox/sign:^1.1.0
```

## Getting Started
Expand Down Expand Up @@ -337,14 +337,31 @@ All URIs are relative to *https://api.hellosign.com/v3*
- [TemplateResponseAccount](docs/Model/TemplateResponseAccount.md)
- [TemplateResponseAccountQuota](docs/Model/TemplateResponseAccountQuota.md)
- [TemplateResponseCCRole](docs/Model/TemplateResponseCCRole.md)
- [TemplateResponseCustomField](docs/Model/TemplateResponseCustomField.md)
- [TemplateResponseDocument](docs/Model/TemplateResponseDocument.md)
- [TemplateResponseDocumentCustomField](docs/Model/TemplateResponseDocumentCustomField.md)
- [TemplateResponseDocumentCustomFieldBase](docs/Model/TemplateResponseDocumentCustomFieldBase.md)
- [TemplateResponseDocumentCustomFieldCheckbox](docs/Model/TemplateResponseDocumentCustomFieldCheckbox.md)
- [TemplateResponseDocumentCustomFieldText](docs/Model/TemplateResponseDocumentCustomFieldText.md)
- [TemplateResponseDocumentFieldGroup](docs/Model/TemplateResponseDocumentFieldGroup.md)
- [TemplateResponseDocumentFormField](docs/Model/TemplateResponseDocumentFormField.md)
- [TemplateResponseDocumentStaticField](docs/Model/TemplateResponseDocumentStaticField.md)
- [TemplateResponseDocumentFieldGroupRule](docs/Model/TemplateResponseDocumentFieldGroupRule.md)
- [TemplateResponseDocumentFormFieldBase](docs/Model/TemplateResponseDocumentFormFieldBase.md)
- [TemplateResponseDocumentFormFieldCheckbox](docs/Model/TemplateResponseDocumentFormFieldCheckbox.md)
- [TemplateResponseDocumentFormFieldDateSigned](docs/Model/TemplateResponseDocumentFormFieldDateSigned.md)
- [TemplateResponseDocumentFormFieldDropdown](docs/Model/TemplateResponseDocumentFormFieldDropdown.md)
- [TemplateResponseDocumentFormFieldHyperlink](docs/Model/TemplateResponseDocumentFormFieldHyperlink.md)
- [TemplateResponseDocumentFormFieldInitials](docs/Model/TemplateResponseDocumentFormFieldInitials.md)
- [TemplateResponseDocumentFormFieldRadio](docs/Model/TemplateResponseDocumentFormFieldRadio.md)
- [TemplateResponseDocumentFormFieldSignature](docs/Model/TemplateResponseDocumentFormFieldSignature.md)
- [TemplateResponseDocumentFormFieldText](docs/Model/TemplateResponseDocumentFormFieldText.md)
- [TemplateResponseDocumentStaticFieldBase](docs/Model/TemplateResponseDocumentStaticFieldBase.md)
- [TemplateResponseDocumentStaticFieldCheckbox](docs/Model/TemplateResponseDocumentStaticFieldCheckbox.md)
- [TemplateResponseDocumentStaticFieldDateSigned](docs/Model/TemplateResponseDocumentStaticFieldDateSigned.md)
- [TemplateResponseDocumentStaticFieldDropdown](docs/Model/TemplateResponseDocumentStaticFieldDropdown.md)
- [TemplateResponseDocumentStaticFieldHyperlink](docs/Model/TemplateResponseDocumentStaticFieldHyperlink.md)
- [TemplateResponseDocumentStaticFieldInitials](docs/Model/TemplateResponseDocumentStaticFieldInitials.md)
- [TemplateResponseDocumentStaticFieldRadio](docs/Model/TemplateResponseDocumentStaticFieldRadio.md)
- [TemplateResponseDocumentStaticFieldSignature](docs/Model/TemplateResponseDocumentStaticFieldSignature.md)
- [TemplateResponseDocumentStaticFieldText](docs/Model/TemplateResponseDocumentStaticFieldText.md)
- [TemplateResponseFieldAvgTextLength](docs/Model/TemplateResponseFieldAvgTextLength.md)
- [TemplateResponseNamedFormField](docs/Model/TemplateResponseNamedFormField.md)
- [TemplateResponseSignerRole](docs/Model/TemplateResponseSignerRole.md)
- [TemplateUpdateFilesRequest](docs/Model/TemplateUpdateFilesRequest.md)
- [TemplateUpdateFilesResponse](docs/Model/TemplateUpdateFilesResponse.md)
Expand Down Expand Up @@ -386,5 +403,5 @@ apisupport@hellosign.com
This PHP package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:

- API version: `3.0.0`
- Package version: `1.0.1`
- Package version: `1.1.0`
- Build package: `org.openapitools.codegen.languages.PhpClientCodegen`
2 changes: 1 addition & 1 deletion VERSION
Original file line number Diff line number Diff line change
@@ -1 +1 @@
1.0.1
1.1.0
4 changes: 3 additions & 1 deletion docs/Api/BulkSendJobApi.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ All URIs are relative to https://api.hellosign.com/v3.
## `bulkSendJobGet()`

```php
bulkSendJobGet($bulk_send_job_id): \Dropbox\Sign\Model\BulkSendJobGetResponse
bulkSendJobGet($bulk_send_job_id, $page, $page_size): \Dropbox\Sign\Model\BulkSendJobGetResponse
```

Get Bulk Send Job
Expand Down Expand Up @@ -53,6 +53,8 @@ try {
|Name | Type | Description | Notes |
| ------------- | ------------- | ------------- | ------------- |
| **bulk_send_job_id** | **string**| The id of the BulkSendJob to retrieve. | |
| **page** | **int**| Which page number of the BulkSendJob list to return. Defaults to `1`. | [optional] [default to 1] |
| **page_size** | **int**| Number of objects to be returned per page. Must be between `1` and `100`. Default is 20. | [optional] [default to 20] |

### Return type

Expand Down
1 change: 1 addition & 0 deletions docs/Model/TeamResponse.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,5 +9,6 @@ Name | Type | Description | Notes
| `name` | ```string``` | The name of your Team | |
| `accounts` | [```\Dropbox\Sign\Model\AccountResponse[]```](AccountResponse.md) | | |
| `invited_accounts` | [```\Dropbox\Sign\Model\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`. | |
| `invited_emails` | ```string[]``` | A list of email addresses that have an outstanding invitation to join your Team and do not yet have a Dropbox Sign account. | |

[[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)
4 changes: 2 additions & 2 deletions docs/Model/TemplateResponse.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,8 +18,8 @@ Name | Type | Description | Notes
| `signer_roles` | [```\Dropbox\Sign\Model\TemplateResponseSignerRole[]```](TemplateResponseSignerRole.md) | An array of the designated signer roles that must be specified when sending a SignatureRequest using this Template. | |
| `cc_roles` | [```\Dropbox\Sign\Model\TemplateResponseCCRole[]```](TemplateResponseCCRole.md) | An array of the designated CC roles that must be specified when sending a SignatureRequest using this Template. | |
| `documents` | [```\Dropbox\Sign\Model\TemplateResponseDocument[]```](TemplateResponseDocument.md) | An array describing each document associated with this Template. Includes form field data for each document. | |
| `custom_fields` | [```\Dropbox\Sign\Model\TemplateResponseCustomField[]```](TemplateResponseCustomField.md) | An array of Custom Field objects. | |
| `named_form_fields` | [```\Dropbox\Sign\Model\TemplateResponseNamedFormField[]```](TemplateResponseNamedFormField.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. | |
| `custom_fields` | [```\Dropbox\Sign\Model\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. | |
| `named_form_fields` | [```\Dropbox\Sign\Model\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. | |
| `accounts` | [```\Dropbox\Sign\Model\TemplateResponseAccount[]```](TemplateResponseAccount.md) | An array of the Accounts that can use this Template. | |

[[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)
6 changes: 3 additions & 3 deletions docs/Model/TemplateResponseDocument.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,8 @@ Name | Type | Description | Notes
| `name` | ```string``` | Name of the associated file. | |
| `index` | ```int``` | Document ordering, the lowest index is displayed first and the highest last (0-based indexing). | |
| `field_groups` | [```\Dropbox\Sign\Model\TemplateResponseDocumentFieldGroup[]```](TemplateResponseDocumentFieldGroup.md) | An array of Form Field Group objects. | |
| `form_fields` | [```\Dropbox\Sign\Model\TemplateResponseDocumentFormField[]```](TemplateResponseDocumentFormField.md) | An array of Form Field objects containing the name and type of each named textbox and checkmark field. | |
| `custom_fields` | [```\Dropbox\Sign\Model\TemplateResponseDocumentCustomField[]```](TemplateResponseDocumentCustomField.md) | An array of Document Custom Field objects. | |
| `static_fields` | [```\Dropbox\Sign\Model\TemplateResponseDocumentStaticField[]```](TemplateResponseDocumentStaticField.md) | An array describing static overlay fields. <b>Note</b> only available for certain subscriptions. | |
| `form_fields` | [```\Dropbox\Sign\Model\TemplateResponseDocumentFormFieldBase[]```](TemplateResponseDocumentFormFieldBase.md) | An array of Form Field objects containing the name and type of each named field. | |
| `custom_fields` | [```\Dropbox\Sign\Model\TemplateResponseDocumentCustomFieldBase[]```](TemplateResponseDocumentCustomFieldBase.md) | An array of Form Field objects containing the name and type of each named field. | |
| `static_fields` | [```\Dropbox\Sign\Model\TemplateResponseDocumentStaticFieldBase[]```](TemplateResponseDocumentStaticFieldBase.md) | An array describing static overlay fields. **Note** only available for certain subscriptions. | |

[[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)
26 changes: 0 additions & 26 deletions docs/Model/TemplateResponseDocumentCustomField.md

This file was deleted.

Original file line number Diff line number Diff line change
@@ -1,23 +1,21 @@
# # TemplateResponseCustomField

# # TemplateResponseDocumentCustomFieldBase

An array of Form Field objects containing the name and type of each named field.

## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
| `type`<sup>*_required_</sup> | ```string``` | | |
| `api_id` | ```string``` | The unique ID for this field. | |
| `name` | ```string``` | The name of the Custom Field. | |
| `type` | ```string``` | The type of this Custom Field. Only `text` and `checkbox` are currently supported. | |
| `signer` | ```string``` | The signer of the Custom Field. Can be `null` if field is a merge field (assigned to Sender). | |
| `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. | |
| `api_id` | ```string``` | The unique ID for this field. | |
| `group` | ```string``` | The name of the group this field is in. If this field is not a group, this defaults to `null`. | |
| `avg_text_length` | [```\Dropbox\Sign\Model\TemplateResponseFieldAvgTextLength```](TemplateResponseFieldAvgTextLength.md) | | |
| `is_multiline` | ```bool``` | Whether this form field is multiline text. | |
| `original_font_size` | ```int``` | Original font size used in this form field&#39;s text. | |
| `font_family` | ```string``` | Font family used in this form field&#39;s text. | |
| `font_size` | ```int``` | Final font size used by this form field. | |

[[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)
11 changes: 11 additions & 0 deletions docs/Model/TemplateResponseDocumentCustomFieldCheckbox.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
# # TemplateResponseDocumentCustomFieldCheckbox

This class extends `TemplateResponseDocumentCustomFieldBase`

## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
| `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'] |

[[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)
15 changes: 15 additions & 0 deletions docs/Model/TemplateResponseDocumentCustomFieldText.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
# # TemplateResponseDocumentCustomFieldText

This class extends `TemplateResponseDocumentCustomFieldBase`

## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
| `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'] |
| `avg_text_length` | [```\Dropbox\Sign\Model\TemplateResponseFieldAvgTextLength```](TemplateResponseFieldAvgTextLength.md) | | |
| `is_multiline` | ```bool``` | Whether this form field is multiline text. | |
| `original_font_size` | ```int``` | Original font size used in this form field&#39;s text. | |
| `font_family` | ```string``` | Font family used in this form field&#39;s text. | |

[[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)
2 changes: 1 addition & 1 deletion docs/Model/TemplateResponseDocumentFieldGroup.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,6 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
| `name` | ```string``` | The name of the form field group. | |
| `rule` | ```string``` | The rule used to validate checkboxes in the form field group. See [checkbox field grouping](/api/reference/constants/#checkbox-field-grouping). | |
| `rule` | [```\Dropbox\Sign\Model\TemplateResponseDocumentFieldGroupRule```](TemplateResponseDocumentFieldGroupRule.md) | | |

[[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)
12 changes: 12 additions & 0 deletions docs/Model/TemplateResponseDocumentFieldGroupRule.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
# # TemplateResponseDocumentFieldGroupRule

The rule used to validate checkboxes in the form field group. See [checkbox field grouping](/api/reference/constants/#checkbox-field-grouping).

## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
| `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. | |
| `group_label` | ```string``` | Name of the group | |

[[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)
Original file line number Diff line number Diff line change
@@ -1,24 +1,21 @@
# # TemplateResponseDocumentFormField

# # TemplateResponseDocumentFormFieldBase

An array of Form Field objects containing the name and type of each named field.

## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
| `type`<sup>*_required_</sup> | ```string``` | | |
| `api_id` | ```string``` | A unique id for the form field. | |
| `name` | ```string``` | The name of the form field. | |
| `type` | ```string``` | The type of this form field. See [field types](/api/reference/constants/#field-types). | |
| `signer` | ```string``` | The signer of the Form 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. | |
| `group` | ```string``` | The name of the group this field is in. If this field is not a group, this defaults to `null`. | |
| `avg_text_length` | [```\Dropbox\Sign\Model\TemplateResponseFieldAvgTextLength```](TemplateResponseFieldAvgTextLength.md) | | |
| `is_multiline` | ```bool``` | Whether this form field is multiline text. | |
| `original_font_size` | ```int``` | Original font size used in this form field&#39;s text. | |
| `font_family` | ```string``` | Font family used in this form field&#39;s text. | |
| `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. | |
| `font_size` | ```int``` | Final font size used by this form field. | |

[[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)
11 changes: 11 additions & 0 deletions docs/Model/TemplateResponseDocumentFormFieldCheckbox.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
# # TemplateResponseDocumentFormFieldCheckbox

This class extends `TemplateResponseDocumentFormFieldBase`

## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
| `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'] |

[[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)
Loading

0 comments on commit f0a3094

Please sign in to comment.