Release 1.3.0 (#7)

hellosign · Jan 29, 2024 · ff37820 · ff37820
1 parent 6792afd
commit ff37820
Show file tree

Hide file tree

Showing 14 changed files with 216 additions and 132 deletions.
diff --git 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 @@ [email protected]
 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
@@ -1 +1 @@
-1.2.0
+1.3.0
diff --git 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
@@ -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
@@ -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
@@ -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&#39;s information during signing.<br><br>⚠️ **Note** ⚠️: Keep your signer&#39;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
@@ -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
@@ -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: |-