Added 'separete_files' GET parameter for document download endpoint; Added 'id' field to linked_objects (#8)

Author: akutsanov

README.md

@@ -19,7 +19,7 @@ or add the following to `composer.json`:
 ```json
 {
   "require": {
-    "pandadoc/php-client": "5.0.1"
+    "pandadoc/php-client": "5.1.0"
   }
 }
 ```

composer.json

@@ -1,6 +1,6 @@
 {
     "name": "pandadoc/php-client",
-    "version": "5.0.1",
+    "version": "5.1.0",
     "description": "The Official PandaDoc PHP client SDK",
     "keywords": [
         "openapi",

docs/Api/DocumentsApi.md

@@ -465,7 +465,7 @@ Name | Type | Description  | Notes
 ## `downloadDocument()`
 
 ```php
-downloadDocument($id, $watermarkColor, $watermarkFontSize, $watermarkOpacity, $watermarkText): \SplFileObject
+downloadDocument($id, $watermarkColor, $watermarkFontSize, $watermarkOpacity, $watermarkText, $separateFiles): \SplFileObject
 ```
 
 Document download
@@ -497,9 +497,10 @@ $watermarkColor = #FF5733; // string | HEX code (for example `#FF5733`).
 $watermarkFontSize = 12; // int | Font size of the watermark.
 $watermarkOpacity = 0.5; // float | In range 0.0-1.0
 $watermarkText = John Doe inc.; // string | Specify watermark text.
+$separateFiles = True; // bool | Set as `true` if you want to receive a zip file with all documents in separate when document transaction contains more than 1.
 
 try {
-    $result = $apiInstance->downloadDocument($id, $watermarkColor, $watermarkFontSize, $watermarkOpacity, $watermarkText);
+    $result = $apiInstance->downloadDocument($id, $watermarkColor, $watermarkFontSize, $watermarkOpacity, $watermarkText, $separateFiles);
     print_r($result);
 } catch (Exception $e) {
     echo 'Exception when calling DocumentsApi->downloadDocument: ', $e->getMessage(), PHP_EOL;
@@ -515,6 +516,7 @@ Name | Type | Description  | Notes
  **watermarkFontSize** | **int**| Font size of the watermark. | [optional]
  **watermarkOpacity** | **float**| In range 0.0-1.0 | [optional]
  **watermarkText** | **string**| Specify watermark text. | [optional]
+ **separateFiles** | **bool**| Set as `true` if you want to receive a zip file with all documents in separate when document transaction contains more than 1. | [optional]
 
 ### Return type
 
@@ -535,7 +537,7 @@ Name | Type | Description  | Notes
 ## `downloadProtectedDocument()`
 
 ```php
-downloadProtectedDocument($id): \SplFileObject
+downloadProtectedDocument($id, $separateFiles): \SplFileObject
 ```
 
 Download document protected
@@ -565,9 +567,10 @@ $apiInstance = new PandaDoc\Client\Api\DocumentsApi(
     $config
 );
 $id = Mebvyy3NGsGBnY2rPLkH84; // string | Specify document ID.
+$separateFiles = True; // bool | Set as `true` if you want to receive a zip file with all documents in separate when document transaction contains more than 1.
 
 try {
-    $result = $apiInstance->downloadProtectedDocument($id);
+    $result = $apiInstance->downloadProtectedDocument($id, $separateFiles);
     print_r($result);
 } catch (Exception $e) {
     echo 'Exception when calling DocumentsApi->downloadProtectedDocument: ', $e->getMessage(), PHP_EOL;
@@ -579,6 +582,7 @@ try {
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
  **id** | **string**| Specify document ID. |
+ **separateFiles** | **bool**| Set as `true` if you want to receive a zip file with all documents in separate when document transaction contains more than 1. | [optional]
 
 ### Return type
 

docs/Model/DocumentDetailsResponseLinkedObjects.md

@@ -7,5 +7,6 @@ Name | Type | Description | Notes
 **provider** | **string** |  | [optional]
 **entityType** | **string** |  | [optional]
 **entityId** | **string** |  | [optional]
+**id** | **string** |  | [optional]
 
 [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)

src/Api/DocumentsApi.php

@@ -2480,14 +2480,15 @@ public function detailsDocumentRequest($id)
      * @param  int $watermarkFontSize Font size of the watermark. (optional)
      * @param  float $watermarkOpacity In range 0.0-1.0 (optional)
      * @param  string $watermarkText Specify watermark text. (optional)
+     * @param  bool $separateFiles Set as `true` if you want to receive a zip file with all documents in separate when document transaction contains more than 1. (optional)
      *
      * @throws \PandaDoc\Client\ApiException on non-2xx response
      * @throws \InvalidArgumentException
      * @return \SplFileObject|object|object|object|object|object|object
      */
-    public function downloadDocument($id, $watermarkColor = null, $watermarkFontSize = null, $watermarkOpacity = null, $watermarkText = null)
+    public function downloadDocument($id, $watermarkColor = null, $watermarkFontSize = null, $watermarkOpacity = null, $watermarkText = null, $separateFiles = null)
     {
-        list($response) = $this->downloadDocumentWithHttpInfo($id, $watermarkColor, $watermarkFontSize, $watermarkOpacity, $watermarkText);
+        list($response) = $this->downloadDocumentWithHttpInfo($id, $watermarkColor, $watermarkFontSize, $watermarkOpacity, $watermarkText, $separateFiles);
         return $response;
     }
 
@@ -2501,14 +2502,15 @@ public function downloadDocument($id, $watermarkColor = null, $watermarkFontSize
      * @param  int $watermarkFontSize Font size of the watermark. (optional)
      * @param  float $watermarkOpacity In range 0.0-1.0 (optional)
      * @param  string $watermarkText Specify watermark text. (optional)
+     * @param  bool $separateFiles Set as `true` if you want to receive a zip file with all documents in separate when document transaction contains more than 1. (optional)
      *
      * @throws \PandaDoc\Client\ApiException on non-2xx response
      * @throws \InvalidArgumentException
      * @return array of \SplFileObject|object|object|object|object|object|object, HTTP status code, HTTP response headers (array of strings)
      */
-    public function downloadDocumentWithHttpInfo($id, $watermarkColor = null, $watermarkFontSize = null, $watermarkOpacity = null, $watermarkText = null)
+    public function downloadDocumentWithHttpInfo($id, $watermarkColor = null, $watermarkFontSize = null, $watermarkOpacity = null, $watermarkText = null, $separateFiles = null)
     {
-        $request = $this->downloadDocumentRequest($id, $watermarkColor, $watermarkFontSize, $watermarkOpacity, $watermarkText);
+        $request = $this->downloadDocumentRequest($id, $watermarkColor, $watermarkFontSize, $watermarkOpacity, $watermarkText, $separateFiles);
 
         try {
             $options = $this->createHttpClientOption();
@@ -2718,13 +2720,14 @@ public function downloadDocumentWithHttpInfo($id, $watermarkColor = null, $water
      * @param  int $watermarkFontSize Font size of the watermark. (optional)
      * @param  float $watermarkOpacity In range 0.0-1.0 (optional)
      * @param  string $watermarkText Specify watermark text. (optional)
+     * @param  bool $separateFiles Set as `true` if you want to receive a zip file with all documents in separate when document transaction contains more than 1. (optional)
      *
      * @throws \InvalidArgumentException
      * @return \GuzzleHttp\Promise\PromiseInterface
      */
-    public function downloadDocumentAsync($id, $watermarkColor = null, $watermarkFontSize = null, $watermarkOpacity = null, $watermarkText = null)
+    public function downloadDocumentAsync($id, $watermarkColor = null, $watermarkFontSize = null, $watermarkOpacity = null, $watermarkText = null, $separateFiles = null)
     {
-        return $this->downloadDocumentAsyncWithHttpInfo($id, $watermarkColor, $watermarkFontSize, $watermarkOpacity, $watermarkText)
+        return $this->downloadDocumentAsyncWithHttpInfo($id, $watermarkColor, $watermarkFontSize, $watermarkOpacity, $watermarkText, $separateFiles)
             ->then(
                 function ($response) {
                     return $response[0];
@@ -2742,14 +2745,15 @@ function ($response) {
      * @param  int $watermarkFontSize Font size of the watermark. (optional)
      * @param  float $watermarkOpacity In range 0.0-1.0 (optional)
      * @param  string $watermarkText Specify watermark text. (optional)
+     * @param  bool $separateFiles Set as `true` if you want to receive a zip file with all documents in separate when document transaction contains more than 1. (optional)
      *
      * @throws \InvalidArgumentException
      * @return \GuzzleHttp\Promise\PromiseInterface
      */
-    public function downloadDocumentAsyncWithHttpInfo($id, $watermarkColor = null, $watermarkFontSize = null, $watermarkOpacity = null, $watermarkText = null)
+    public function downloadDocumentAsyncWithHttpInfo($id, $watermarkColor = null, $watermarkFontSize = null, $watermarkOpacity = null, $watermarkText = null, $separateFiles = null)
     {
         $returnType = '\SplFileObject';
-        $request = $this->downloadDocumentRequest($id, $watermarkColor, $watermarkFontSize, $watermarkOpacity, $watermarkText);
+        $request = $this->downloadDocumentRequest($id, $watermarkColor, $watermarkFontSize, $watermarkOpacity, $watermarkText, $separateFiles);
 
         return $this->client
             ->sendAsync($request, $this->createHttpClientOption())
@@ -2792,11 +2796,12 @@ function ($exception) {
      * @param  int $watermarkFontSize Font size of the watermark. (optional)
      * @param  float $watermarkOpacity In range 0.0-1.0 (optional)
      * @param  string $watermarkText Specify watermark text. (optional)
+     * @param  bool $separateFiles Set as `true` if you want to receive a zip file with all documents in separate when document transaction contains more than 1. (optional)
      *
      * @throws \InvalidArgumentException
      * @return \GuzzleHttp\Psr7\Request
      */
-    public function downloadDocumentRequest($id, $watermarkColor = null, $watermarkFontSize = null, $watermarkOpacity = null, $watermarkText = null)
+    public function downloadDocumentRequest($id, $watermarkColor = null, $watermarkFontSize = null, $watermarkOpacity = null, $watermarkText = null, $separateFiles = null)
     {
         // verify the required parameter 'id' is set
         if ($id === null || (is_array($id) && count($id) === 0)) {
@@ -2856,6 +2861,17 @@ public function downloadDocumentRequest($id, $watermarkColor = null, $watermarkF
                 $queryParams['watermark_text'] = $watermarkText;
             }
         }
+        // query params
+        if ($separateFiles !== null) {
+            if('form' === 'form' && is_array($separateFiles)) {
+                foreach($separateFiles as $key => $value) {
+                    $queryParams[$key] = $value;
+                }
+            }
+            else {
+                $queryParams['separate_files'] = $separateFiles;
+            }
+        }
 
 
         // path params
@@ -2940,14 +2956,15 @@ public function downloadDocumentRequest($id, $watermarkColor = null, $watermarkF
      * Download document protected
      *
      * @param  string $id Specify document ID. (required)
+     * @param  bool $separateFiles Set as `true` if you want to receive a zip file with all documents in separate when document transaction contains more than 1. (optional)
      *
      * @throws \PandaDoc\Client\ApiException on non-2xx response
      * @throws \InvalidArgumentException
      * @return \SplFileObject|object|object|object|object|object
      */
-    public function downloadProtectedDocument($id)
+    public function downloadProtectedDocument($id, $separateFiles = null)
     {
-        list($response) = $this->downloadProtectedDocumentWithHttpInfo($id);
+        list($response) = $this->downloadProtectedDocumentWithHttpInfo($id, $separateFiles);
         return $response;
     }
 
@@ -2957,14 +2974,15 @@ public function downloadProtectedDocument($id)
      * Download document protected
      *
      * @param  string $id Specify document ID. (required)
+     * @param  bool $separateFiles Set as `true` if you want to receive a zip file with all documents in separate when document transaction contains more than 1. (optional)
      *
      * @throws \PandaDoc\Client\ApiException on non-2xx response
      * @throws \InvalidArgumentException
      * @return array of \SplFileObject|object|object|object|object|object, HTTP status code, HTTP response headers (array of strings)
      */
-    public function downloadProtectedDocumentWithHttpInfo($id)
+    public function downloadProtectedDocumentWithHttpInfo($id, $separateFiles = null)
     {
-        $request = $this->downloadProtectedDocumentRequest($id);
+        $request = $this->downloadProtectedDocumentRequest($id, $separateFiles);
 
         try {
             $options = $this->createHttpClientOption();
@@ -3150,13 +3168,14 @@ public function downloadProtectedDocumentWithHttpInfo($id)
      * Download document protected
      *
      * @param  string $id Specify document ID. (required)
+     * @param  bool $separateFiles Set as `true` if you want to receive a zip file with all documents in separate when document transaction contains more than 1. (optional)
      *
      * @throws \InvalidArgumentException
      * @return \GuzzleHttp\Promise\PromiseInterface
      */
-    public function downloadProtectedDocumentAsync($id)
+    public function downloadProtectedDocumentAsync($id, $separateFiles = null)
     {
-        return $this->downloadProtectedDocumentAsyncWithHttpInfo($id)
+        return $this->downloadProtectedDocumentAsyncWithHttpInfo($id, $separateFiles)
             ->then(
                 function ($response) {
                     return $response[0];
@@ -3170,14 +3189,15 @@ function ($response) {
      * Download document protected
      *
      * @param  string $id Specify document ID. (required)
+     * @param  bool $separateFiles Set as `true` if you want to receive a zip file with all documents in separate when document transaction contains more than 1. (optional)
      *
      * @throws \InvalidArgumentException
      * @return \GuzzleHttp\Promise\PromiseInterface
      */
-    public function downloadProtectedDocumentAsyncWithHttpInfo($id)
+    public function downloadProtectedDocumentAsyncWithHttpInfo($id, $separateFiles = null)
     {
         $returnType = '\SplFileObject';
-        $request = $this->downloadProtectedDocumentRequest($id);
+        $request = $this->downloadProtectedDocumentRequest($id, $separateFiles);
 
         return $this->client
             ->sendAsync($request, $this->createHttpClientOption())
@@ -3216,11 +3236,12 @@ function ($exception) {
      * Create request for operation 'downloadProtectedDocument'
      *
      * @param  string $id Specify document ID. (required)
+     * @param  bool $separateFiles Set as `true` if you want to receive a zip file with all documents in separate when document transaction contains more than 1. (optional)
      *
      * @throws \InvalidArgumentException
      * @return \GuzzleHttp\Psr7\Request
      */
-    public function downloadProtectedDocumentRequest($id)
+    public function downloadProtectedDocumentRequest($id, $separateFiles = null)
     {
         // verify the required parameter 'id' is set
         if ($id === null || (is_array($id) && count($id) === 0)) {
@@ -3236,6 +3257,17 @@ public function downloadProtectedDocumentRequest($id)
         $httpBody = '';
         $multipart = false;
 
+        // query params
+        if ($separateFiles !== null) {
+            if('form' === 'form' && is_array($separateFiles)) {
+                foreach($separateFiles as $key => $value) {
+                    $queryParams[$key] = $value;
+                }
+            }
+            else {
+                $queryParams['separate_files'] = $separateFiles;
+            }
+        }
 
 
         // path params

src/Configuration.php

@@ -88,7 +88,7 @@ class Configuration
      *
      * @var string
      */
-    protected $userAgent = 'pandadoc_php_client/5.0.1';
+    protected $userAgent = 'pandadoc_php_client/5.1.0';
 
     /**
      * Debug switch (default set to false)
@@ -396,8 +396,8 @@ public static function toDebugReport()
         $report  = 'PHP SDK (PandaDoc\Client) Debug Report:' . PHP_EOL;
         $report .= '    OS: ' . php_uname() . PHP_EOL;
         $report .= '    PHP Version: ' . PHP_VERSION . PHP_EOL;
-        $report .= '    The version of the OpenAPI document: 5.0.1' . PHP_EOL;
-        $report .= '    SDK Package Version: 5.0.1' . PHP_EOL;
+        $report .= '    The version of the OpenAPI document: 5.1.0' . PHP_EOL;
+        $report .= '    SDK Package Version: 5.1.0' . PHP_EOL;
         $report .= '    Temp Folder Path: ' . self::getDefaultConfiguration()->getTempFolderPath() . PHP_EOL;
 
         return $report;

src/Model/DocumentDetailsResponseLinkedObjects.php

@@ -59,7 +59,8 @@ class DocumentDetailsResponseLinkedObjects implements ModelInterface, ArrayAcces
     protected static $openAPITypes = [
         'provider' => 'string',
         'entityType' => 'string',
-        'entityId' => 'string'
+        'entityId' => 'string',
+        'id' => 'string'
     ];
 
     /**
@@ -72,7 +73,8 @@ class DocumentDetailsResponseLinkedObjects implements ModelInterface, ArrayAcces
     protected static $openAPIFormats = [
         'provider' => null,
         'entityType' => null,
-        'entityId' => null
+        'entityId' => null,
+        'id' => null
     ];
 
     /**
@@ -104,7 +106,8 @@ public static function openAPIFormats()
     protected static $attributeMap = [
         'provider' => 'provider',
         'entityType' => 'entity_type',
-        'entityId' => 'entity_id'
+        'entityId' => 'entity_id',
+        'id' => 'id'
     ];
 
     /**
@@ -115,7 +118,8 @@ public static function openAPIFormats()
     protected static $setters = [
         'provider' => 'setProvider',
         'entityType' => 'setEntityType',
-        'entityId' => 'setEntityId'
+        'entityId' => 'setEntityId',
+        'id' => 'setId'
     ];
 
     /**
@@ -126,7 +130,8 @@ public static function openAPIFormats()
     protected static $getters = [
         'provider' => 'getProvider',
         'entityType' => 'getEntityType',
-        'entityId' => 'getEntityId'
+        'entityId' => 'getEntityId',
+        'id' => 'getId'
     ];
 
     /**
@@ -189,6 +194,7 @@ public function __construct(array $data = null)
         $this->container['provider'] = $data['provider'] ?? null;
         $this->container['entityType'] = $data['entityType'] ?? null;
         $this->container['entityId'] = $data['entityId'] ?? null;
+        $this->container['id'] = $data['id'] ?? null;
     }
 
     /**
@@ -286,6 +292,30 @@ public function setEntityId($entityId)
 
         return $this;
     }
+
+    /**
+     * Gets id
+     *
+     * @return string|null
+     */
+    public function getId()
+    {
+        return $this->container['id'];
+    }
+
+    /**
+     * Sets id
+     *
+     * @param string|null $id id
+     *
+     * @return self
+     */
+    public function setId($id)
+    {
+        $this->container['id'] = $id;
+
+        return $this;
+    }
     /**
      * Returns true if offset exists. False otherwise.
      *