- Added 'separete_files' GET parameter for document download endpoint (#12)

- Added 'id' field to linked_objects

Author: akutsanov

README.md

@@ -35,7 +35,7 @@ Add this dependency to your project's POM:
 <dependency>
   <groupId>com.pandadoc</groupId>
   <artifactId>pandadoc-java-client</artifactId>
-  <version>5.0.2</version>
+  <version>5.1.0</version>
   <scope>compile</scope>
 </dependency>
 ```
@@ -45,7 +45,7 @@ Add this dependency to your project's POM:
 Add this dependency to your project's build file:
 
 ```groovy
-compile "com.pandadoc:pandadoc-java-client:5.0.2"
+compile "com.pandadoc:pandadoc-java-client:5.1.0"
 ```
 
 ### Others
@@ -58,7 +58,7 @@ mvn clean package
 
 Then manually install the following JARs:
 
-- `target/pandadoc-java-client-5.0.2.jar`
+- `target/pandadoc-java-client-5.1.0.jar`
 - `target/lib/*.jar`
 
 ## Getting Started

build.gradle

@@ -4,7 +4,7 @@ apply plugin: 'java'
 apply plugin: 'com.diffplug.spotless'
 
 group = 'com.pandadoc'
-version = '5.0.2'
+version = '5.1.0'
 
 buildscript {
     repositories {

build.sbt

@@ -2,7 +2,7 @@ lazy val root = (project in file(".")).
   settings(
     organization := "com.pandadoc",
     name := "pandadoc-java-client",
-    version := "5.0.2",
+    version := "5.1.0",
     scalaVersion := "2.11.4",
     scalacOptions ++= Seq("-feature"),
     javacOptions in compile ++= Seq("-Xlint:deprecation"),

docs/DocumentDetailsResponseLinkedObjects.md

@@ -10,6 +10,7 @@ Name | Type | Description | Notes
 **provider** | **String** |  |  [optional]
 **entityType** | **String** |  |  [optional]
 **entityId** | **String** |  |  [optional]
+**id** | **String** |  |  [optional]
 
 
 

docs/DocumentsApi.md

@@ -625,7 +625,7 @@ Name | Type | Description  | Notes
 
 ## downloadDocument
 
-> File downloadDocument(id, watermarkColor, watermarkFontSize, watermarkOpacity, watermarkText)
+> File downloadDocument(id, watermarkColor, watermarkFontSize, watermarkOpacity, watermarkText, separateFiles)
 
 Document download
 
@@ -670,8 +670,10 @@ public class Example {
         Float watermarkOpacity = 0.5F;
         // String | Specify watermark text.
         String watermarkText = "John Doe inc.";
+        // Boolean | Set as `true` if you want to receive a zip file with all documents in separate when document transaction contains more than 1.
+        Boolean separateFiles = true;
         try {
-            File result = apiInstance.downloadDocument(id, watermarkColor, watermarkFontSize, watermarkOpacity, watermarkText);
+            File result = apiInstance.downloadDocument(id, watermarkColor, watermarkFontSize, watermarkOpacity, watermarkText, separateFiles);
             System.out.println(result);
         } catch (ApiException e) {
             System.err.println("Exception when calling DocumentsApi#downloadDocument");
@@ -694,6 +696,7 @@ Name | Type | Description  | Notes
  **watermarkFontSize** | **Integer**| Font size of the watermark. | [optional]
  **watermarkOpacity** | **Float**| In range 0.0-1.0 | [optional]
  **watermarkText** | **String**| Specify watermark text. | [optional]
+ **separateFiles** | **Boolean**| 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
 
@@ -723,7 +726,7 @@ Name | Type | Description  | Notes
 
 ## downloadProtectedDocument
 
-> File downloadProtectedDocument(id)
+> File downloadProtectedDocument(id, separateFiles)
 
 Download document protected
 
@@ -762,8 +765,10 @@ public class Example {
         DocumentsApi apiInstance = new DocumentsApi(defaultClient);
         // String | Specify document ID.
         String id = "Mebvyy3NGsGBnY2rPLkH84";
+        // Boolean | Set as `true` if you want to receive a zip file with all documents in separate when document transaction contains more than 1.
+        Boolean separateFiles = true;
         try {
-            File result = apiInstance.downloadProtectedDocument(id);
+            File result = apiInstance.downloadProtectedDocument(id, separateFiles);
             System.out.println(result);
         } catch (ApiException e) {
             System.err.println("Exception when calling DocumentsApi#downloadProtectedDocument");
@@ -782,6 +787,7 @@ public class Example {
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
  **id** | **String**| Specify document ID. |
+ **separateFiles** | **Boolean**| 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
 

pom.xml

@@ -5,7 +5,7 @@
     <artifactId>pandadoc-java-client</artifactId>
     <packaging>jar</packaging>
     <name>pandadoc-java-client</name>
-    <version>5.0.2</version>
+    <version>5.1.0</version>
     <url>https://github.com/PandaDoc/pandadoc-api-java-client</url>
     <description>PandaDoc SDK spans a broad range of functionality to help you build incredible documents automation experiences inside your product.</description>
     <scm>

src/main/java/com/pandadoc/client/ApiClient.java

@@ -204,7 +204,7 @@ private void init() {
         json = new JSON();
 
         // Set default User-Agent.
-        setUserAgent("pandadoc_java_client/5.0.2");
+        setUserAgent("pandadoc_java_client/5.1.0");
 
         authentications = new HashMap<String, Authentication>();
     }

src/main/java/com/pandadoc/client/api/DocumentsApi.java

@@ -1139,6 +1139,7 @@ public okhttp3.Call detailsDocumentAsync(String id, final ApiCallback<DocumentDe
      * @param watermarkFontSize Font size of the watermark. (optional)
      * @param watermarkOpacity In range 0.0-1.0 (optional)
      * @param watermarkText Specify watermark text. (optional)
+     * @param separateFiles Set as &#x60;true&#x60; if you want to receive a zip file with all documents in separate when document transaction contains more than 1. (optional)
      * @param _callback Callback for upload/download progress
      * @return Call to execute
      * @throws ApiException If fail to serialize the request body object
@@ -1154,7 +1155,7 @@ public okhttp3.Call detailsDocumentAsync(String id, final ApiCallback<DocumentDe
         <tr><td> 429 </td><td> Too Many Requests </td><td>  -  </td></tr>
      </table>
      */
-    public okhttp3.Call downloadDocumentCall(String id, String watermarkColor, Integer watermarkFontSize, Float watermarkOpacity, String watermarkText, final ApiCallback _callback) throws ApiException {
+    public okhttp3.Call downloadDocumentCall(String id, String watermarkColor, Integer watermarkFontSize, Float watermarkOpacity, String watermarkText, Boolean separateFiles, final ApiCallback _callback) throws ApiException {
         String basePath = null;
 
         // Operation Servers
@@ -1197,6 +1198,10 @@ public okhttp3.Call downloadDocumentCall(String id, String watermarkColor, Integ
             localVarQueryParams.addAll(localVarApiClient.parameterToPair("watermark_text", watermarkText));
         }
 
+        if (separateFiles != null) {
+            localVarQueryParams.addAll(localVarApiClient.parameterToPair("separate_files", separateFiles));
+        }
+
         final String[] localVarAccepts = {
             "application/pdf", "application/json"
         };
@@ -1218,15 +1223,15 @@ public okhttp3.Call downloadDocumentCall(String id, String watermarkColor, Integ
     }
 
     @SuppressWarnings("rawtypes")
-    private okhttp3.Call downloadDocumentValidateBeforeCall(String id, String watermarkColor, Integer watermarkFontSize, Float watermarkOpacity, String watermarkText, final ApiCallback _callback) throws ApiException {
+    private okhttp3.Call downloadDocumentValidateBeforeCall(String id, String watermarkColor, Integer watermarkFontSize, Float watermarkOpacity, String watermarkText, Boolean separateFiles, final ApiCallback _callback) throws ApiException {
 
         // verify the required parameter 'id' is set
         if (id == null) {
             throw new ApiException("Missing the required parameter 'id' when calling downloadDocument(Async)");
         }
 
 
-        okhttp3.Call localVarCall = downloadDocumentCall(id, watermarkColor, watermarkFontSize, watermarkOpacity, watermarkText, _callback);
+        okhttp3.Call localVarCall = downloadDocumentCall(id, watermarkColor, watermarkFontSize, watermarkOpacity, watermarkText, separateFiles, _callback);
         return localVarCall;
 
     }
@@ -1239,6 +1244,7 @@ private okhttp3.Call downloadDocumentValidateBeforeCall(String id, String waterm
      * @param watermarkFontSize Font size of the watermark. (optional)
      * @param watermarkOpacity In range 0.0-1.0 (optional)
      * @param watermarkText Specify watermark text. (optional)
+     * @param separateFiles Set as &#x60;true&#x60; if you want to receive a zip file with all documents in separate when document transaction contains more than 1. (optional)
      * @return File
      * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body
      * @http.response.details
@@ -1253,8 +1259,8 @@ private okhttp3.Call downloadDocumentValidateBeforeCall(String id, String waterm
         <tr><td> 429 </td><td> Too Many Requests </td><td>  -  </td></tr>
      </table>
      */
-    public File downloadDocument(String id, String watermarkColor, Integer watermarkFontSize, Float watermarkOpacity, String watermarkText) throws ApiException {
-        ApiResponse<File> localVarResp = downloadDocumentWithHttpInfo(id, watermarkColor, watermarkFontSize, watermarkOpacity, watermarkText);
+    public File downloadDocument(String id, String watermarkColor, Integer watermarkFontSize, Float watermarkOpacity, String watermarkText, Boolean separateFiles) throws ApiException {
+        ApiResponse<File> localVarResp = downloadDocumentWithHttpInfo(id, watermarkColor, watermarkFontSize, watermarkOpacity, watermarkText, separateFiles);
         return localVarResp.getData();
     }
 
@@ -1266,6 +1272,7 @@ public File downloadDocument(String id, String watermarkColor, Integer watermark
      * @param watermarkFontSize Font size of the watermark. (optional)
      * @param watermarkOpacity In range 0.0-1.0 (optional)
      * @param watermarkText Specify watermark text. (optional)
+     * @param separateFiles Set as &#x60;true&#x60; if you want to receive a zip file with all documents in separate when document transaction contains more than 1. (optional)
      * @return ApiResponse&lt;File&gt;
      * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body
      * @http.response.details
@@ -1280,8 +1287,8 @@ public File downloadDocument(String id, String watermarkColor, Integer watermark
         <tr><td> 429 </td><td> Too Many Requests </td><td>  -  </td></tr>
      </table>
      */
-    public ApiResponse<File> downloadDocumentWithHttpInfo(String id, String watermarkColor, Integer watermarkFontSize, Float watermarkOpacity, String watermarkText) throws ApiException {
-        okhttp3.Call localVarCall = downloadDocumentValidateBeforeCall(id, watermarkColor, watermarkFontSize, watermarkOpacity, watermarkText, null);
+    public ApiResponse<File> downloadDocumentWithHttpInfo(String id, String watermarkColor, Integer watermarkFontSize, Float watermarkOpacity, String watermarkText, Boolean separateFiles) throws ApiException {
+        okhttp3.Call localVarCall = downloadDocumentValidateBeforeCall(id, watermarkColor, watermarkFontSize, watermarkOpacity, watermarkText, separateFiles, null);
         Type localVarReturnType = new TypeToken<File>(){}.getType();
         return localVarApiClient.execute(localVarCall, localVarReturnType);
     }
@@ -1294,6 +1301,7 @@ public ApiResponse<File> downloadDocumentWithHttpInfo(String id, String watermar
      * @param watermarkFontSize Font size of the watermark. (optional)
      * @param watermarkOpacity In range 0.0-1.0 (optional)
      * @param watermarkText Specify watermark text. (optional)
+     * @param separateFiles Set as &#x60;true&#x60; if you want to receive a zip file with all documents in separate when document transaction contains more than 1. (optional)
      * @param _callback The callback to be executed when the API call finishes
      * @return The request call
      * @throws ApiException If fail to process the API call, e.g. serializing the request body object
@@ -1309,16 +1317,17 @@ public ApiResponse<File> downloadDocumentWithHttpInfo(String id, String watermar
         <tr><td> 429 </td><td> Too Many Requests </td><td>  -  </td></tr>
      </table>
      */
-    public okhttp3.Call downloadDocumentAsync(String id, String watermarkColor, Integer watermarkFontSize, Float watermarkOpacity, String watermarkText, final ApiCallback<File> _callback) throws ApiException {
+    public okhttp3.Call downloadDocumentAsync(String id, String watermarkColor, Integer watermarkFontSize, Float watermarkOpacity, String watermarkText, Boolean separateFiles, final ApiCallback<File> _callback) throws ApiException {
 
-        okhttp3.Call localVarCall = downloadDocumentValidateBeforeCall(id, watermarkColor, watermarkFontSize, watermarkOpacity, watermarkText, _callback);
+        okhttp3.Call localVarCall = downloadDocumentValidateBeforeCall(id, watermarkColor, watermarkFontSize, watermarkOpacity, watermarkText, separateFiles, _callback);
         Type localVarReturnType = new TypeToken<File>(){}.getType();
         localVarApiClient.executeAsync(localVarCall, localVarReturnType, _callback);
         return localVarCall;
     }
     /**
      * Build call for downloadProtectedDocument
      * @param id Specify document ID. (required)
+     * @param separateFiles Set as &#x60;true&#x60; if you want to receive a zip file with all documents in separate when document transaction contains more than 1. (optional)
      * @param _callback Callback for upload/download progress
      * @return Call to execute
      * @throws ApiException If fail to serialize the request body object
@@ -1333,7 +1342,7 @@ public okhttp3.Call downloadDocumentAsync(String id, String watermarkColor, Inte
         <tr><td> 429 </td><td> Too Many Requests </td><td>  -  </td></tr>
      </table>
      */
-    public okhttp3.Call downloadProtectedDocumentCall(String id, final ApiCallback _callback) throws ApiException {
+    public okhttp3.Call downloadProtectedDocumentCall(String id, Boolean separateFiles, final ApiCallback _callback) throws ApiException {
         String basePath = null;
 
         // Operation Servers
@@ -1360,6 +1369,10 @@ public okhttp3.Call downloadProtectedDocumentCall(String id, final ApiCallback _
         Map<String, String> localVarCookieParams = new HashMap<String, String>();
         Map<String, Object> localVarFormParams = new HashMap<String, Object>();
 
+        if (separateFiles != null) {
+            localVarQueryParams.addAll(localVarApiClient.parameterToPair("separate_files", separateFiles));
+        }
+
         final String[] localVarAccepts = {
             "application/pdf", "application/json"
         };
@@ -1381,15 +1394,15 @@ public okhttp3.Call downloadProtectedDocumentCall(String id, final ApiCallback _
     }
 
     @SuppressWarnings("rawtypes")
-    private okhttp3.Call downloadProtectedDocumentValidateBeforeCall(String id, final ApiCallback _callback) throws ApiException {
+    private okhttp3.Call downloadProtectedDocumentValidateBeforeCall(String id, Boolean separateFiles, final ApiCallback _callback) throws ApiException {
 
         // verify the required parameter 'id' is set
         if (id == null) {
             throw new ApiException("Missing the required parameter 'id' when calling downloadProtectedDocument(Async)");
         }
 
 
-        okhttp3.Call localVarCall = downloadProtectedDocumentCall(id, _callback);
+        okhttp3.Call localVarCall = downloadProtectedDocumentCall(id, separateFiles, _callback);
         return localVarCall;
 
     }
@@ -1398,6 +1411,7 @@ private okhttp3.Call downloadProtectedDocumentValidateBeforeCall(String id, fina
      * Download document protected
      * Download a signed PDF of a completed document
      * @param id Specify document ID. (required)
+     * @param separateFiles Set as &#x60;true&#x60; if you want to receive a zip file with all documents in separate when document transaction contains more than 1. (optional)
      * @return File
      * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body
      * @http.response.details
@@ -1411,15 +1425,16 @@ private okhttp3.Call downloadProtectedDocumentValidateBeforeCall(String id, fina
         <tr><td> 429 </td><td> Too Many Requests </td><td>  -  </td></tr>
      </table>
      */
-    public File downloadProtectedDocument(String id) throws ApiException {
-        ApiResponse<File> localVarResp = downloadProtectedDocumentWithHttpInfo(id);
+    public File downloadProtectedDocument(String id, Boolean separateFiles) throws ApiException {
+        ApiResponse<File> localVarResp = downloadProtectedDocumentWithHttpInfo(id, separateFiles);
         return localVarResp.getData();
     }
 
     /**
      * Download document protected
      * Download a signed PDF of a completed document
      * @param id Specify document ID. (required)
+     * @param separateFiles Set as &#x60;true&#x60; if you want to receive a zip file with all documents in separate when document transaction contains more than 1. (optional)
      * @return ApiResponse&lt;File&gt;
      * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body
      * @http.response.details
@@ -1433,8 +1448,8 @@ public File downloadProtectedDocument(String id) throws ApiException {
         <tr><td> 429 </td><td> Too Many Requests </td><td>  -  </td></tr>
      </table>
      */
-    public ApiResponse<File> downloadProtectedDocumentWithHttpInfo(String id) throws ApiException {
-        okhttp3.Call localVarCall = downloadProtectedDocumentValidateBeforeCall(id, null);
+    public ApiResponse<File> downloadProtectedDocumentWithHttpInfo(String id, Boolean separateFiles) throws ApiException {
+        okhttp3.Call localVarCall = downloadProtectedDocumentValidateBeforeCall(id, separateFiles, null);
         Type localVarReturnType = new TypeToken<File>(){}.getType();
         return localVarApiClient.execute(localVarCall, localVarReturnType);
     }
@@ -1443,6 +1458,7 @@ public ApiResponse<File> downloadProtectedDocumentWithHttpInfo(String id) throws
      * Download document protected (asynchronously)
      * Download a signed PDF of a completed document
      * @param id Specify document ID. (required)
+     * @param separateFiles Set as &#x60;true&#x60; if you want to receive a zip file with all documents in separate when document transaction contains more than 1. (optional)
      * @param _callback The callback to be executed when the API call finishes
      * @return The request call
      * @throws ApiException If fail to process the API call, e.g. serializing the request body object
@@ -1457,9 +1473,9 @@ public ApiResponse<File> downloadProtectedDocumentWithHttpInfo(String id) throws
         <tr><td> 429 </td><td> Too Many Requests </td><td>  -  </td></tr>
      </table>
      */
-    public okhttp3.Call downloadProtectedDocumentAsync(String id, final ApiCallback<File> _callback) throws ApiException {
+    public okhttp3.Call downloadProtectedDocumentAsync(String id, Boolean separateFiles, final ApiCallback<File> _callback) throws ApiException {
 
-        okhttp3.Call localVarCall = downloadProtectedDocumentValidateBeforeCall(id, _callback);
+        okhttp3.Call localVarCall = downloadProtectedDocumentValidateBeforeCall(id, separateFiles, _callback);
         Type localVarReturnType = new TypeToken<File>(){}.getType();
         localVarApiClient.executeAsync(localVarCall, localVarReturnType, _callback);
         return localVarCall;