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

Author: akutsanov

docs/DocumentDetailsResponseLinkedObjects.md

@@ -7,6 +7,7 @@ Name | Type | Description | Notes
 **provider** | **str** |  | [optional] 
 **entity_type** | **str** |  | [optional] 
 **entity_id** | **str** |  | [optional] 
+**id** | **str** |  | [optional] 
 **any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional]
 
 [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

docs/DocumentsApi.md

@@ -789,6 +789,7 @@ with pandadoc_client.ApiClient(configuration) as api_client:
     watermark_font_size = 12  # int | Font size of the watermark. (optional)
     watermark_opacity = 0.5  # float | In range 0.0-1.0 (optional)
     watermark_text = "John Doe inc."  # str | Specify watermark text. (optional)
+    separate_files = 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. (optional)
 
     # example passing only required values which don't have defaults set
     try:
@@ -808,6 +809,7 @@ with pandadoc_client.ApiClient(configuration) as api_client:
             watermark_font_size=watermark_font_size,
             watermark_opacity=watermark_opacity,
             watermark_text=watermark_text,
+            separate_files=separate_files,
         )
         pprint(api_response)
     except pandadoc_client.ApiException as e:
@@ -823,6 +825,7 @@ Name | Type | Description  | Notes
  **watermark_font_size** | **int**| Font size of the watermark. | [optional]
  **watermark_opacity** | **float**| In range 0.0-1.0 | [optional]
  **watermark_text** | **str**| Specify watermark text. | [optional]
+ **separate_files** | **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
 
@@ -895,6 +898,7 @@ with pandadoc_client.ApiClient(configuration) as api_client:
     # Create an instance of the API class
     api_instance = documents_api.DocumentsApi(api_client)
     id = "Mebvyy3NGsGBnY2rPLkH84"  # str | Specify document ID.
+    separate_files = 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. (optional)
 
     # example passing only required values which don't have defaults set
     try:
@@ -903,13 +907,26 @@ with pandadoc_client.ApiClient(configuration) as api_client:
         pprint(api_response)
     except pandadoc_client.ApiException as e:
         print("Exception when calling DocumentsApi->download_protected_document: %s\n" % e)
+
+    # example passing only required values which don't have defaults set
+    # and optional values
+    try:
+        # Download document protected
+        api_response = api_instance.download_protected_document(
+            id,
+            separate_files=separate_files,
+        )
+        pprint(api_response)
+    except pandadoc_client.ApiException as e:
+        print("Exception when calling DocumentsApi->download_protected_document: %s\n" % e)
 ```
 
 ### Parameters
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
  **id** | **str**| Specify document ID. |
+ **separate_files** | **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
 

pandadoc_client/__init__.py

@@ -9,7 +9,7 @@
 """
 
 
-__version__ = "5.0.1"
+__version__ = "5.1.0"
 
 # import ApiClient
 from pandadoc_client.api_client import ApiClient

pandadoc_client/api/documents_api.py

@@ -468,6 +468,7 @@ def __init__(self, api_client=None):
                     'watermark_font_size',
                     'watermark_opacity',
                     'watermark_text',
+                    'separate_files',
                 ],
                 'required': [
                     'id',
@@ -495,20 +496,24 @@ def __init__(self, api_client=None):
                         (float,),
                     'watermark_text':
                         (str,),
+                    'separate_files':
+                        (bool,),
                 },
                 'attribute_map': {
                     'id': 'id',
                     'watermark_color': 'watermark_color',
                     'watermark_font_size': 'watermark_font_size',
                     'watermark_opacity': 'watermark_opacity',
                     'watermark_text': 'watermark_text',
+                    'separate_files': 'separate_files',
                 },
                 'location_map': {
                     'id': 'path',
                     'watermark_color': 'query',
                     'watermark_font_size': 'query',
                     'watermark_opacity': 'query',
                     'watermark_text': 'query',
+                    'separate_files': 'query',
                 },
                 'collection_format_map': {
                 }
@@ -537,6 +542,7 @@ def __init__(self, api_client=None):
             params_map={
                 'all': [
                     'id',
+                    'separate_files',
                 ],
                 'required': [
                     'id',
@@ -556,12 +562,16 @@ def __init__(self, api_client=None):
                 'openapi_types': {
                     'id':
                         (str,),
+                    'separate_files':
+                        (bool,),
                 },
                 'attribute_map': {
                     'id': 'id',
+                    'separate_files': 'separate_files',
                 },
                 'location_map': {
                     'id': 'path',
+                    'separate_files': 'query',
                 },
                 'collection_format_map': {
                 }
@@ -1584,6 +1594,7 @@ def download_document(
             watermark_font_size (int): Font size of the watermark.. [optional]
             watermark_opacity (float): In range 0.0-1.0. [optional]
             watermark_text (str): Specify watermark text.. [optional]
+            separate_files (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_http_data_only (bool): response data without head status
                 code and headers. Default is True.
             _preload_content (bool): if False, the urllib3.HTTPResponse object
@@ -1662,6 +1673,7 @@ def download_protected_document(
             id (str): Specify document ID.
 
         Keyword Args:
+            separate_files (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_http_data_only (bool): response data without head status
                 code and headers. Default is True.
             _preload_content (bool): if False, the urllib3.HTTPResponse object

pandadoc_client/api_client.py

@@ -75,7 +75,7 @@ def __init__(self, configuration=None, header_name=None, header_value=None,
             self.default_headers[header_name] = header_value
         self.cookie = cookie
         # Set default User-Agent.
-        self.user_agent = 'pandadoc_python_client/5.0.1'
+        self.user_agent = 'pandadoc_python_client/5.1.0'
 
     def __enter__(self):
         return self

pandadoc_client/configuration.py

@@ -414,8 +414,8 @@ def to_debug_report(self):
         return "Python SDK Debug Report:\n"\
                "OS: {env}\n"\
                "Python Version: {pyversion}\n"\
-               "Version of the API: 5.0.1\n"\
-               "SDK Package Version: 5.0.1".\
+               "Version of the API: 5.1.0\n"\
+               "SDK Package Version: 5.1.0".\
                format(env=sys.platform, pyversion=sys.version)
 
     def get_host_settings(self):

pandadoc_client/model/document_details_response_linked_objects.py

@@ -83,6 +83,7 @@ def openapi_types():
             'provider': (str,),  # noqa: E501
             'entity_type': (str,),  # noqa: E501
             'entity_id': (str,),  # noqa: E501
+            'id': (str,),  # noqa: E501
         }
 
     @cached_property
@@ -94,6 +95,7 @@ def discriminator():
         'provider': 'provider',  # noqa: E501
         'entity_type': 'entity_type',  # noqa: E501
         'entity_id': 'entity_id',  # noqa: E501
+        'id': 'id',  # noqa: E501
     }
 
     read_only_vars = {
@@ -140,6 +142,7 @@ def _from_openapi_data(cls, *args, **kwargs):  # noqa: E501
             provider (str): [optional]  # noqa: E501
             entity_type (str): [optional]  # noqa: E501
             entity_id (str): [optional]  # noqa: E501
+            id (str): [optional]  # noqa: E501
         """
 
         _check_type = kwargs.pop('_check_type', True)
@@ -224,6 +227,7 @@ def __init__(self, *args, **kwargs):  # noqa: E501
             provider (str): [optional]  # noqa: E501
             entity_type (str): [optional]  # noqa: E501
             entity_id (str): [optional]  # noqa: E501
+            id (str): [optional]  # noqa: E501
         """
 
         _check_type = kwargs.pop('_check_type', True)

setup.py

@@ -17,7 +17,7 @@
     description = full_description[0:from_index] + full_description[to_index::]
 
 NAME = "pandadoc-python-client"
-VERSION = "5.0.1"
+VERSION = "5.1.0"
 # To install the library, run the following
 #
 # python setup.py install