From ff378206b52e0f27c54e3f15ee2070279aced8ce Mon Sep 17 00:00:00 2001
From: Juan Treminio <50673996+jtreminio-dropbox@users.noreply.github.com>
Date: Mon, 29 Jan 2024 15:58:36 -0600
Subject: [PATCH] Release 1.3.0 (#7)
---
README.md | 6 +-
VERSION | 2 +-
docs/Api/SignatureRequestApi.md | 3 +-
docs/Api/TemplateApi.md | 3 +-
docs/Model/TemplateCreateResponse.md | 2 +-
...dDraftCreateEmbeddedWithTemplateRequest.md | 1 +
openapi-config.yaml | 4 +-
openapi-sdk.yaml | 214 ++++++++++--------
src/Api/SignatureRequestApi.php | 34 ++-
src/Api/TemplateApi.php | 34 ++-
src/Configuration.php | 4 +-
src/Model/TemplateCreateResponse.php | 8 +-
...DraftCreateEmbeddedWithTemplateRequest.php | 30 +++
...raftCreateEmbeddedWithTemplateRequest.json | 3 +-
14 files changed, 216 insertions(+), 132 deletions(-)
diff --git a/README.md b/README.md
index f2442b5..3ad4f31 100644
--- a/README.md
+++ b/README.md
@@ -53,7 +53,7 @@ To install the bindings via [Composer](https://getcomposer.org/), add the follow
```json
{
"require": {
- "dropbox/sign": "^1.2.0"
+ "dropbox/sign": "^1.3.0"
},
"minimum-stability": "dev"
}
@@ -64,7 +64,7 @@ Then run `composer install`.
Alternatively, install directly with
```
-composer require dropbox/sign:^1.2.0
+composer require dropbox/sign:^1.3.0
```
## Getting Started
@@ -408,5 +408,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.2.0`
+ - Package version: `1.3.0`
- Build package: `org.openapitools.codegen.languages.PhpClientCodegen`
diff --git a/VERSION b/VERSION
index 26aaba0..f0bb29e 100644
--- a/VERSION
+++ b/VERSION
@@ -1 +1 @@
-1.2.0
+1.3.0
diff --git a/docs/Api/SignatureRequestApi.md b/docs/Api/SignatureRequestApi.md
index f55aca4..6286b96 100644
--- a/docs/Api/SignatureRequestApi.md
+++ b/docs/Api/SignatureRequestApi.md
@@ -589,7 +589,7 @@ try {
## `signatureRequestFilesAsFileUrl()`
```php
-signatureRequestFilesAsFileUrl($signature_request_id): \Dropbox\Sign\Model\FileResponse
+signatureRequestFilesAsFileUrl($signature_request_id, $force_download): \Dropbox\Sign\Model\FileResponse
```
Download Files as File Url
@@ -631,6 +631,7 @@ try {
|Name | Type | Description | Notes |
| ------------- | ------------- | ------------- | ------------- |
| **signature_request_id** | **string**| The id of the SignatureRequest to retrieve. | |
+| **force_download** | **int**| By default when opening the `file_url` a browser will download the PDF and save it locally. When set to `0` the PDF file will be displayed in the browser. | [optional] [default to 1] |
### Return type
diff --git a/docs/Api/TemplateApi.md b/docs/Api/TemplateApi.md
index c447de3..c81bc7b 100644
--- a/docs/Api/TemplateApi.md
+++ b/docs/Api/TemplateApi.md
@@ -461,7 +461,7 @@ try {
## `templateFilesAsFileUrl()`
```php
-templateFilesAsFileUrl($template_id): \Dropbox\Sign\Model\FileResponse
+templateFilesAsFileUrl($template_id, $force_download): \Dropbox\Sign\Model\FileResponse
```
Get Template Files as File Url
@@ -503,6 +503,7 @@ try {
|Name | Type | Description | Notes |
| ------------- | ------------- | ------------- | ------------- |
| **template_id** | **string**| The id of the template files to retrieve. | |
+| **force_download** | **int**| By default when opening the `file_url` a browser will download the PDF and save it locally. When set to `0` the PDF file will be displayed in the browser. | [optional] [default to 1] |
### Return type
diff --git a/docs/Model/TemplateCreateResponse.md b/docs/Model/TemplateCreateResponse.md
index 91e59cc..480c24e 100644
--- a/docs/Model/TemplateCreateResponse.md
+++ b/docs/Model/TemplateCreateResponse.md
@@ -6,7 +6,7 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
-| `template` | [```\Dropbox\Sign\Model\TemplateCreateResponse```](TemplateCreateResponse.md) | | |
+| `template` | [```\Dropbox\Sign\Model\TemplateCreateResponseTemplate```](TemplateCreateResponseTemplate.md) | | |
| `warnings` | [```\Dropbox\Sign\Model\WarningResponse[]```](WarningResponse.md) | A list of warnings. | |
[[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)
diff --git a/docs/Model/UnclaimedDraftCreateEmbeddedWithTemplateRequest.md b/docs/Model/UnclaimedDraftCreateEmbeddedWithTemplateRequest.md
index 8219ea7..739ba42 100644
--- a/docs/Model/UnclaimedDraftCreateEmbeddedWithTemplateRequest.md
+++ b/docs/Model/UnclaimedDraftCreateEmbeddedWithTemplateRequest.md
@@ -35,5 +35,6 @@ Name | Type | Description | Notes
| `test_mode` | ```bool``` | Whether this is a test, the signature request created from this draft will not be legally binding if set to `true`. Defaults to `false`. | [default to false] |
| `title` | ```string``` | The title you want to assign to the SignatureRequest. | |
| `populate_auto_fill_fields` | ```bool``` | 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.
⚠️ **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] |
+| `allow_ccs` | ```bool``` | This allows the requester to specify whether the user is allowed to provide email addresses to CC when claiming the draft. | [default to false] |
[[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)
diff --git a/openapi-config.yaml b/openapi-config.yaml
index a3cbf36..ae6594b 100644
--- a/openapi-config.yaml
+++ b/openapi-config.yaml
@@ -3,8 +3,8 @@ typeMappings:
"object": "array"
additionalProperties:
packageName: dropbox/sign
- packageVersion: "^1.2.0"
- artifactVersion: 1.2.0
+ packageVersion: "^1.3.0"
+ artifactVersion: 1.3.0
invokerPackage: "Dropbox\\Sign"
sortModelPropertiesByRequiredFlag: true
srcBasePath: src
diff --git a/openapi-sdk.yaml b/openapi-sdk.yaml
index 44642ca..6ef2e00 100644
--- a/openapi-sdk.yaml
+++ b/openapi-sdk.yaml
@@ -2483,6 +2483,13 @@ paths:
schema:
type: string
example: fa5c8a0b0f492d768749333ad6fcc214c111e967
+ -
+ name: force_download
+ in: query
+ description: 'By default when opening the `file_url` a browser will download the PDF and save it locally. When set to `0` the PDF file will be displayed in the browser.'
+ schema:
+ type: integer
+ default: 1
responses:
200:
description: 'successful operation'
@@ -5214,6 +5221,13 @@ paths:
schema:
type: string
example: f57db65d3f933b5316d398057a36176831451a35
+ -
+ name: force_download
+ in: query
+ description: 'By default when opening the `file_url` a browser will download the PDF and save it locally. When set to `0` the PDF file will be displayed in the browser.'
+ schema:
+ type: integer
+ default: 1
responses:
200:
description: 'successful operation'
@@ -9074,6 +9088,10 @@ components:
⚠️ **Note** ⚠️: Keep your signer's information safe by ensuring that the _signer on your signature request is the intended party_ before using this feature.
type: boolean
default: false
+ allow_ccs:
+ description: 'This allows the requester to specify whether the user is allowed to provide email addresses to CC when claiming the draft.'
+ type: boolean
+ default: false
type: object
UnclaimedDraftEditAndResendRequest:
required:
@@ -9242,20 +9260,6 @@ components:
error:
$ref: '#/components/schemas/ErrorResponseError'
type: object
- EventCallbackRequest:
- title: EventCallbackRequest
- required:
- - event
- properties:
- event:
- $ref: '#/components/schemas/EventCallbackRequestEvent'
- account:
- $ref: '#/components/schemas/AccountResponse'
- signature_request:
- $ref: '#/components/schemas/SignatureRequestResponse'
- template:
- $ref: '#/components/schemas/TemplateResponse'
- type: object
FileResponse:
properties:
file_url:
@@ -9572,69 +9576,6 @@ components:
description: 'Name of the error.'
type: string
type: object
- EventCallbackRequestEvent:
- description: 'Basic information about the event that occurred.'
- required:
- - event_time
- - event_type
- - event_hash
- - event_metadata
- properties:
- event_time:
- description: 'Time the event was created (using Unix time).'
- type: string
- event_type:
- description: 'Type of callback event that was triggered.'
- type: string
- enum:
- - account_confirmed
- - unknown_error
- - file_error
- - sign_url_invalid
- - signature_request_viewed
- - signature_request_signed
- - signature_request_sent
- - signature_request_all_signed
- - signature_request_email_bounce
- - signature_request_remind
- - signature_request_incomplete_qes
- - signature_request_destroyed
- - signature_request_canceled
- - signature_request_downloadable
- - signature_request_declined
- - signature_request_reassigned
- - signature_request_invalid
- - signature_request_prepared
- - signature_request_expired
- - template_created
- - template_error
- - callback_test
- event_hash:
- description: 'Generated hash used to verify source of event data.'
- type: string
- event_metadata:
- $ref: '#/components/schemas/EventCallbackRequestEventMetadata'
- type: object
- EventCallbackRequestEventMetadata:
- description: 'Specific metadata about the event.'
- properties:
- related_signature_id:
- description: 'Signature ID for a specific signer. Applicable to `signature_request_signed` and `signature_request_viewed` events.'
- type: string
- nullable: true
- reported_for_account_id:
- description: 'Account ID the event was reported for.'
- type: string
- nullable: true
- reported_for_app_id:
- description: 'App ID the event was reported for.'
- type: string
- nullable: true
- event_message:
- description: 'Message about a declined or failed (due to error) signature flow.'
- type: string
- nullable: true
- type: object
ListInfoResponse:
description: 'Contains pagination information about the data returned.'
properties:
@@ -11178,7 +11119,7 @@ components:
TemplateCreateResponse:
properties:
template:
- $ref: '#/components/schemas/TemplateCreateResponse'
+ $ref: '#/components/schemas/TemplateCreateResponseTemplate'
warnings:
description: 'A list of warnings.'
type: array
@@ -11247,6 +11188,83 @@ components:
$ref: '#/components/schemas/WarningResponse'
type: object
x-internal: true
+ EventCallbackRequest:
+ title: EventCallbackRequest
+ required:
+ - event
+ properties:
+ event:
+ $ref: '#/components/schemas/EventCallbackRequestEvent'
+ account:
+ $ref: '#/components/schemas/AccountResponse'
+ signature_request:
+ $ref: '#/components/schemas/SignatureRequestResponse'
+ template:
+ $ref: '#/components/schemas/TemplateResponse'
+ type: object
+ EventCallbackRequestEvent:
+ description: 'Basic information about the event that occurred.'
+ required:
+ - event_time
+ - event_type
+ - event_hash
+ - event_metadata
+ properties:
+ event_time:
+ description: 'Time the event was created (using Unix time).'
+ type: string
+ event_type:
+ description: 'Type of callback event that was triggered.'
+ type: string
+ enum:
+ - account_confirmed
+ - unknown_error
+ - file_error
+ - sign_url_invalid
+ - signature_request_viewed
+ - signature_request_signed
+ - signature_request_sent
+ - signature_request_all_signed
+ - signature_request_email_bounce
+ - signature_request_remind
+ - signature_request_incomplete_qes
+ - signature_request_destroyed
+ - signature_request_canceled
+ - signature_request_downloadable
+ - signature_request_declined
+ - signature_request_reassigned
+ - signature_request_invalid
+ - signature_request_prepared
+ - signature_request_expired
+ - template_created
+ - template_error
+ - callback_test
+ event_hash:
+ description: 'Generated hash used to verify source of event data.'
+ type: string
+ event_metadata:
+ $ref: '#/components/schemas/EventCallbackRequestEventMetadata'
+ type: object
+ EventCallbackRequestEventMetadata:
+ description: 'Specific metadata about the event.'
+ properties:
+ related_signature_id:
+ description: 'Signature ID for a specific signer. Applicable to `signature_request_signed` and `signature_request_viewed` events.'
+ type: string
+ nullable: true
+ reported_for_account_id:
+ description: 'Account ID the event was reported for.'
+ type: string
+ nullable: true
+ reported_for_app_id:
+ description: 'App ID the event was reported for.'
+ type: string
+ nullable: true
+ event_message:
+ description: 'Message about a declined or failed (due to error) signature flow.'
+ type: string
+ nullable: true
+ type: object
responses:
EventCallbackResponse:
description: 'successful operation'
@@ -11560,26 +11578,6 @@ components:
summary: 'API App Update'
value:
$ref: examples/json/ApiAppUpdateResponseExample.json
- EventCallbackAccountSignatureRequestSentExample:
- summary: 'Example: signature_request_sent'
- value:
- $ref: examples/json/EventCallbackAccountSignatureRequestSentExample.json
- EventCallbackAccountTemplateCreatedExample:
- summary: 'Example: template_created'
- value:
- $ref: examples/json/EventCallbackAccountTemplateCreatedExample.json
- EventCallbackAppAccountConfirmedExample:
- summary: 'Example: account_confirmed'
- value:
- $ref: examples/json/EventCallbackAppAccountConfirmedExample.json
- EventCallbackAppSignatureRequestSentExample:
- summary: 'Example: signature_request_sent'
- value:
- $ref: examples/json/EventCallbackAppSignatureRequestSentExample.json
- EventCallbackAppTemplateCreatedExample:
- summary: 'Example: template_created'
- value:
- $ref: examples/json/EventCallbackAppTemplateCreatedExample.json
SignatureRequestCreateEmbeddedResponseExample:
summary: 'Create Embedded Signature Request'
value:
@@ -11708,6 +11706,26 @@ components:
summary: 'Unclaimed Draft Create'
value:
$ref: examples/json/UnclaimedDraftCreateResponseExample.json
+ EventCallbackAccountSignatureRequestSentExample:
+ summary: 'Example: signature_request_sent'
+ value:
+ $ref: examples/json/EventCallbackAccountSignatureRequestSentExample.json
+ EventCallbackAccountTemplateCreatedExample:
+ summary: 'Example: template_created'
+ value:
+ $ref: examples/json/EventCallbackAccountTemplateCreatedExample.json
+ EventCallbackAppAccountConfirmedExample:
+ summary: 'Example: account_confirmed'
+ value:
+ $ref: examples/json/EventCallbackAppAccountConfirmedExample.json
+ EventCallbackAppSignatureRequestSentExample:
+ summary: 'Example: signature_request_sent'
+ value:
+ $ref: examples/json/EventCallbackAppSignatureRequestSentExample.json
+ EventCallbackAppTemplateCreatedExample:
+ summary: 'Example: template_created'
+ value:
+ $ref: examples/json/EventCallbackAppTemplateCreatedExample.json
requestBodies:
EventCallbackAccountRequest:
description: |-
diff --git a/src/Api/SignatureRequestApi.php b/src/Api/SignatureRequestApi.php
index c68e516..3de87a5 100644
--- a/src/Api/SignatureRequestApi.php
+++ b/src/Api/SignatureRequestApi.php
@@ -2298,14 +2298,15 @@ public function signatureRequestFilesAsDataUriRequest(string $signature_request_
* Download Files as File Url
*
* @param string $signature_request_id The id of the SignatureRequest to retrieve. (required)
+ * @param int $force_download By default when opening the `file_url` a browser will download the PDF and save it locally. When set to `0` the PDF file will be displayed in the browser. (optional, default to 1)
*
* @throws ApiException on non-2xx response
* @throws InvalidArgumentException
* @return Model\FileResponse
*/
- public function signatureRequestFilesAsFileUrl(string $signature_request_id)
+ public function signatureRequestFilesAsFileUrl(string $signature_request_id, int $force_download = 1)
{
- list($response) = $this->signatureRequestFilesAsFileUrlWithHttpInfo($signature_request_id);
+ list($response) = $this->signatureRequestFilesAsFileUrlWithHttpInfo($signature_request_id, $force_download);
return $response;
}
@@ -2316,14 +2317,15 @@ public function signatureRequestFilesAsFileUrl(string $signature_request_id)
* Download Files as File Url
*
* @param string $signature_request_id The id of the SignatureRequest to retrieve. (required)
+ * @param int $force_download By default when opening the `file_url` a browser will download the PDF and save it locally. When set to `0` the PDF file will be displayed in the browser. (optional, default to 1)
*
* @throws ApiException on non-2xx response
* @throws InvalidArgumentException
* @return array of Model\FileResponse, HTTP status code, HTTP response headers (array of strings)
*/
- public function signatureRequestFilesAsFileUrlWithHttpInfo(string $signature_request_id)
+ public function signatureRequestFilesAsFileUrlWithHttpInfo(string $signature_request_id, int $force_download = 1)
{
- $request = $this->signatureRequestFilesAsFileUrlRequest($signature_request_id);
+ $request = $this->signatureRequestFilesAsFileUrlRequest($signature_request_id, $force_download);
try {
$options = $this->createHttpClientOption();
@@ -2438,13 +2440,14 @@ public function signatureRequestFilesAsFileUrlWithHttpInfo(string $signature_req
* Download Files as File Url
*
* @param string $signature_request_id The id of the SignatureRequest to retrieve. (required)
+ * @param int $force_download By default when opening the `file_url` a browser will download the PDF and save it locally. When set to `0` the PDF file will be displayed in the browser. (optional, default to 1)
*
* @throws InvalidArgumentException
* @return Promise\PromiseInterface
*/
- public function signatureRequestFilesAsFileUrlAsync(string $signature_request_id)
+ public function signatureRequestFilesAsFileUrlAsync(string $signature_request_id, int $force_download = 1)
{
- return $this->signatureRequestFilesAsFileUrlAsyncWithHttpInfo($signature_request_id)
+ return $this->signatureRequestFilesAsFileUrlAsyncWithHttpInfo($signature_request_id, $force_download)
->then(
function ($response) {
return $response[0];
@@ -2458,14 +2461,15 @@ function ($response) {
* Download Files as File Url
*
* @param string $signature_request_id The id of the SignatureRequest to retrieve. (required)
+ * @param int $force_download By default when opening the `file_url` a browser will download the PDF and save it locally. When set to `0` the PDF file will be displayed in the browser. (optional, default to 1)
*
* @throws InvalidArgumentException
* @return Promise\PromiseInterface
*/
- public function signatureRequestFilesAsFileUrlAsyncWithHttpInfo(string $signature_request_id)
+ public function signatureRequestFilesAsFileUrlAsyncWithHttpInfo(string $signature_request_id, int $force_download = 1)
{
$returnType = '\Dropbox\Sign\Model\FileResponse';
- $request = $this->signatureRequestFilesAsFileUrlRequest($signature_request_id);
+ $request = $this->signatureRequestFilesAsFileUrlRequest($signature_request_id, $force_download);
return $this->client
->sendAsync($request, $this->createHttpClientOption())
@@ -2504,11 +2508,12 @@ function ($exception) {
* Create request for operation 'signatureRequestFilesAsFileUrl'
*
* @param string $signature_request_id The id of the SignatureRequest to retrieve. (required)
+ * @param int $force_download By default when opening the `file_url` a browser will download the PDF and save it locally. When set to `0` the PDF file will be displayed in the browser. (optional, default to 1)
*
* @throws InvalidArgumentException
* @return Psr7\Request
*/
- public function signatureRequestFilesAsFileUrlRequest(string $signature_request_id)
+ public function signatureRequestFilesAsFileUrlRequest(string $signature_request_id, int $force_download = 1)
{
// verify the required parameter 'signature_request_id' is set
if ($signature_request_id === null || (is_array($signature_request_id) && count($signature_request_id) === 0)) {
@@ -2525,6 +2530,17 @@ public function signatureRequestFilesAsFileUrlRequest(string $signature_request_
$formParams = [];
$multipart = false;
+ // query params
+ if ($force_download !== null) {
+ if ('form' === 'form' && is_array($force_download)) {
+ foreach ($force_download as $key => $value) {
+ $queryParams[$key] = $value;
+ }
+ } else {
+ $queryParams['force_download'] = $force_download;
+ }
+ }
+
// path params
if ($signature_request_id !== null) {
$resourcePath = str_replace(
diff --git a/src/Api/TemplateApi.php b/src/Api/TemplateApi.php
index 3010c54..92f2406 100644
--- a/src/Api/TemplateApi.php
+++ b/src/Api/TemplateApi.php
@@ -2004,14 +2004,15 @@ public function templateFilesAsDataUriRequest(string $template_id)
* Get Template Files as File Url
*
* @param string $template_id The id of the template files to retrieve. (required)
+ * @param int $force_download By default when opening the `file_url` a browser will download the PDF and save it locally. When set to `0` the PDF file will be displayed in the browser. (optional, default to 1)
*
* @throws ApiException on non-2xx response
* @throws InvalidArgumentException
* @return Model\FileResponse
*/
- public function templateFilesAsFileUrl(string $template_id)
+ public function templateFilesAsFileUrl(string $template_id, int $force_download = 1)
{
- list($response) = $this->templateFilesAsFileUrlWithHttpInfo($template_id);
+ list($response) = $this->templateFilesAsFileUrlWithHttpInfo($template_id, $force_download);
return $response;
}
@@ -2022,14 +2023,15 @@ public function templateFilesAsFileUrl(string $template_id)
* Get Template Files as File Url
*
* @param string $template_id The id of the template files to retrieve. (required)
+ * @param int $force_download By default when opening the `file_url` a browser will download the PDF and save it locally. When set to `0` the PDF file will be displayed in the browser. (optional, default to 1)
*
* @throws ApiException on non-2xx response
* @throws InvalidArgumentException
* @return array of Model\FileResponse, HTTP status code, HTTP response headers (array of strings)
*/
- public function templateFilesAsFileUrlWithHttpInfo(string $template_id)
+ public function templateFilesAsFileUrlWithHttpInfo(string $template_id, int $force_download = 1)
{
- $request = $this->templateFilesAsFileUrlRequest($template_id);
+ $request = $this->templateFilesAsFileUrlRequest($template_id, $force_download);
try {
$options = $this->createHttpClientOption();
@@ -2144,13 +2146,14 @@ public function templateFilesAsFileUrlWithHttpInfo(string $template_id)
* Get Template Files as File Url
*
* @param string $template_id The id of the template files to retrieve. (required)
+ * @param int $force_download By default when opening the `file_url` a browser will download the PDF and save it locally. When set to `0` the PDF file will be displayed in the browser. (optional, default to 1)
*
* @throws InvalidArgumentException
* @return Promise\PromiseInterface
*/
- public function templateFilesAsFileUrlAsync(string $template_id)
+ public function templateFilesAsFileUrlAsync(string $template_id, int $force_download = 1)
{
- return $this->templateFilesAsFileUrlAsyncWithHttpInfo($template_id)
+ return $this->templateFilesAsFileUrlAsyncWithHttpInfo($template_id, $force_download)
->then(
function ($response) {
return $response[0];
@@ -2164,14 +2167,15 @@ function ($response) {
* Get Template Files as File Url
*
* @param string $template_id The id of the template files to retrieve. (required)
+ * @param int $force_download By default when opening the `file_url` a browser will download the PDF and save it locally. When set to `0` the PDF file will be displayed in the browser. (optional, default to 1)
*
* @throws InvalidArgumentException
* @return Promise\PromiseInterface
*/
- public function templateFilesAsFileUrlAsyncWithHttpInfo(string $template_id)
+ public function templateFilesAsFileUrlAsyncWithHttpInfo(string $template_id, int $force_download = 1)
{
$returnType = '\Dropbox\Sign\Model\FileResponse';
- $request = $this->templateFilesAsFileUrlRequest($template_id);
+ $request = $this->templateFilesAsFileUrlRequest($template_id, $force_download);
return $this->client
->sendAsync($request, $this->createHttpClientOption())
@@ -2210,11 +2214,12 @@ function ($exception) {
* Create request for operation 'templateFilesAsFileUrl'
*
* @param string $template_id The id of the template files to retrieve. (required)
+ * @param int $force_download By default when opening the `file_url` a browser will download the PDF and save it locally. When set to `0` the PDF file will be displayed in the browser. (optional, default to 1)
*
* @throws InvalidArgumentException
* @return Psr7\Request
*/
- public function templateFilesAsFileUrlRequest(string $template_id)
+ public function templateFilesAsFileUrlRequest(string $template_id, int $force_download = 1)
{
// verify the required parameter 'template_id' is set
if ($template_id === null || (is_array($template_id) && count($template_id) === 0)) {
@@ -2231,6 +2236,17 @@ public function templateFilesAsFileUrlRequest(string $template_id)
$formParams = [];
$multipart = false;
+ // query params
+ if ($force_download !== null) {
+ if ('form' === 'form' && is_array($force_download)) {
+ foreach ($force_download as $key => $value) {
+ $queryParams[$key] = $value;
+ }
+ } else {
+ $queryParams['force_download'] = $force_download;
+ }
+ }
+
// path params
if ($template_id !== null) {
$resourcePath = str_replace(
diff --git a/src/Configuration.php b/src/Configuration.php
index 60ec7f0..f9ce3c5 100644
--- a/src/Configuration.php
+++ b/src/Configuration.php
@@ -70,7 +70,7 @@ class Configuration
*
* @var string
*/
- protected $userAgent = 'OpenAPI-Generator/1.2.0/PHP';
+ protected $userAgent = 'OpenAPI-Generator/1.3.0/PHP';
/**
* Debug switch (default set to false)
@@ -319,7 +319,7 @@ public static function toDebugReport()
$report .= ' OS: ' . php_uname() . PHP_EOL;
$report .= ' PHP Version: ' . PHP_VERSION . PHP_EOL;
$report .= ' The version of the OpenAPI document: 3.0.0' . PHP_EOL;
- $report .= ' SDK Package Version: 1.2.0' . PHP_EOL;
+ $report .= ' SDK Package Version: 1.3.0' . PHP_EOL;
$report .= ' Temp Folder Path: ' . self::getDefaultConfiguration()->getTempFolderPath() . PHP_EOL;
return $report;
diff --git a/src/Model/TemplateCreateResponse.php b/src/Model/TemplateCreateResponse.php
index 5c95384..2d4a1f2 100644
--- a/src/Model/TemplateCreateResponse.php
+++ b/src/Model/TemplateCreateResponse.php
@@ -61,7 +61,7 @@ class TemplateCreateResponse implements ModelInterface, ArrayAccess, JsonSeriali
* @var string[]
*/
protected static $openAPITypes = [
- 'template' => '\Dropbox\Sign\Model\TemplateCreateResponse',
+ 'template' => '\Dropbox\Sign\Model\TemplateCreateResponseTemplate',
'warnings' => '\Dropbox\Sign\Model\WarningResponse[]',
];
@@ -232,7 +232,7 @@ public function valid()
/**
* Gets template
*
- * @return TemplateCreateResponse|null
+ * @return TemplateCreateResponseTemplate|null
*/
public function getTemplate()
{
@@ -242,11 +242,11 @@ public function getTemplate()
/**
* Sets template
*
- * @param TemplateCreateResponse|null $template template
+ * @param TemplateCreateResponseTemplate|null $template template
*
* @return self
*/
- public function setTemplate(?TemplateCreateResponse $template)
+ public function setTemplate(?TemplateCreateResponseTemplate $template)
{
$this->container['template'] = $template;
diff --git a/src/Model/UnclaimedDraftCreateEmbeddedWithTemplateRequest.php b/src/Model/UnclaimedDraftCreateEmbeddedWithTemplateRequest.php
index 1e29eb0..0659830 100644
--- a/src/Model/UnclaimedDraftCreateEmbeddedWithTemplateRequest.php
+++ b/src/Model/UnclaimedDraftCreateEmbeddedWithTemplateRequest.php
@@ -91,6 +91,7 @@ class UnclaimedDraftCreateEmbeddedWithTemplateRequest implements ModelInterface,
'test_mode' => 'bool',
'title' => 'string',
'populate_auto_fill_fields' => 'bool',
+ 'allow_ccs' => 'bool',
];
/**
@@ -130,6 +131,7 @@ class UnclaimedDraftCreateEmbeddedWithTemplateRequest implements ModelInterface,
'test_mode' => null,
'title' => null,
'populate_auto_fill_fields' => null,
+ 'allow_ccs' => null,
];
/**
@@ -188,6 +190,7 @@ public static function openAPIFormats()
'test_mode' => 'test_mode',
'title' => 'title',
'populate_auto_fill_fields' => 'populate_auto_fill_fields',
+ 'allow_ccs' => 'allow_ccs',
];
/**
@@ -225,6 +228,7 @@ public static function openAPIFormats()
'test_mode' => 'setTestMode',
'title' => 'setTitle',
'populate_auto_fill_fields' => 'setPopulateAutoFillFields',
+ 'allow_ccs' => 'setAllowCcs',
];
/**
@@ -262,6 +266,7 @@ public static function openAPIFormats()
'test_mode' => 'getTestMode',
'title' => 'getTitle',
'populate_auto_fill_fields' => 'getPopulateAutoFillFields',
+ 'allow_ccs' => 'getAllowCcs',
];
/**
@@ -349,6 +354,7 @@ public function __construct(array $data = null)
$this->container['test_mode'] = $data['test_mode'] ?? false;
$this->container['title'] = $data['title'] ?? null;
$this->container['populate_auto_fill_fields'] = $data['populate_auto_fill_fields'] ?? false;
+ $this->container['allow_ccs'] = $data['allow_ccs'] ?? false;
}
/** @deprecated use ::init() */
@@ -1121,6 +1127,30 @@ public function setPopulateAutoFillFields(?bool $populate_auto_fill_fields)
return $this;
}
+ /**
+ * Gets allow_ccs
+ *
+ * @return bool|null
+ */
+ public function getAllowCcs()
+ {
+ return $this->container['allow_ccs'];
+ }
+
+ /**
+ * Sets allow_ccs
+ *
+ * @param bool|null $allow_ccs this allows the requester to specify whether the user is allowed to provide email addresses to CC when claiming the draft
+ *
+ * @return self
+ */
+ public function setAllowCcs(?bool $allow_ccs)
+ {
+ $this->container['allow_ccs'] = $allow_ccs;
+
+ return $this;
+ }
+
/**
* Returns true if offset exists. False otherwise.
*
diff --git a/test_fixtures/UnclaimedDraftCreateEmbeddedWithTemplateRequest.json b/test_fixtures/UnclaimedDraftCreateEmbeddedWithTemplateRequest.json
index d59cf95..4a1aafb 100644
--- a/test_fixtures/UnclaimedDraftCreateEmbeddedWithTemplateRequest.json
+++ b/test_fixtures/UnclaimedDraftCreateEmbeddedWithTemplateRequest.json
@@ -62,6 +62,7 @@
"61a832ff0d8423f91d503e76bfbcc750f7417c78"
],
"test_mode": false,
- "title": "NDA with Acme Co."
+ "title": "NDA with Acme Co.",
+ "allow_ccs": true
}
}