v2.1.0 (#10)

No longer require from_email on InlineSignRequest, add processing flag to Document, integration_data is now an object instead of a string, generate using Swagger Codegen 2.4.11 instead of 2.4.8

.swagger-codegen/VERSION

@@ -1 +1 @@
-2.4.8
+2.4.11

docs/Document.md

@@ -32,6 +32,7 @@ Name | Type | Description | Notes
 **auto_delete_after** | **datetime** | Date and time calculated using `auto_delete_days` after which a finished document (signed/cancelled/declined) will be automatically deleted | [optional] 
 **sandbox** | **bool** | Indicates whether document was created as part of a sandbox team | [optional] 
 **auto_expire_after** | **datetime** | Date and time calculated using `auto_expire_days` after which a non finished document will be automatically expired | [optional] 
+**processing** | **bool** | Indicates whether a change to the document is processing and the PDF may be out of date. It is recommended to wait until processing has finished before downloading the PDF. Webhooks are not sent until processing has been completed. | [optional] 
 
 [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
 

docs/DocumentSignerTemplateConf.md

@@ -4,10 +4,10 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **signer_index** | **int** |  | [optional] 
-**needs_to_sign** | **bool** |  | [optional] 
-**approve_only** | **bool** |  | [optional] 
-**notify_only** | **bool** |  | [optional] 
-**in_person** | **bool** |  | [optional] 
+**needs_to_sign** | **bool** | When `false` user does not need to sign, but will receive a copy of the signed document and signing log, see: [Copy only](#section/Additional-signing-methods/Copy-only) | [optional] 
+**approve_only** | **bool** | Require user to approve the document (without adding a signature), see: [Approve only](#section/Additional-signing-methods/Approve-only) | [optional] 
+**notify_only** | **bool** | Send notifications about the document and a copy of the signed document and signing log, but don't require them to take any action, see: [Notify only](#section/Additional-signing-methods/Notify-only) | [optional] 
+**in_person** | **bool** | When used in combination with an embed url on the sender, after sender has signed, they will be redirected to the next `in_person` signer, see: [In person signing](#section/Additional-signing-methods/In-person-signing) | [optional] 
 **order** | **int** |  | [optional] 
 **placeholders** | [**list[Placeholder]**](Placeholder.md) |  | [optional] 
 

docs/DocumentSignrequest.md

@@ -21,7 +21,7 @@ Name | Type | Description | Notes
 **subject** | **str** | Subject of SignRequest email | [optional] 
 **message** | **str** | Message to include in SignRequest email, may contain the following html tags: `a`, `abbr`, `acronym`, `b`, `blockquote`, `code`, `em`, `i`, `ul`, `li`, `ol`, and `strong` | [optional] 
 **who** | **str** | `m`: only me, `mo`: me and others, `o`: only others | [optional] 
-**send_reminders** | **bool** | Automatically remind signers to sign a document | [optional] 
+**send_reminders** | **bool** | Automatically remind signers to sign a document, see: [automatic reminders](#section/Working-with-a-SignRequest/Automatic-reminders) | [optional] 
 **signers** | [**list[Signer]**](Signer.md) |  | [optional] 
 **uuid** | **str** |  | [optional] 
 

docs/InlineDocumentSignerIntegrationData.md

@@ -4,7 +4,7 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **integration** | **str** |  | [optional] 
-**integration_data** | **str** |  | [optional] 
+**integration_data** | **object** |  | [optional] 
 
 [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
 

docs/InlineIntegrationData.md

@@ -4,7 +4,7 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **integration** | **str** |  | [optional] 
-**integration_data** | **str** |  | [optional] 
+**integration_data** | **object** |  | [optional] 
 
 [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
 

docs/InlineSignRequest.md

@@ -21,7 +21,7 @@ Name | Type | Description | Notes
 **subject** | **str** | Subject of SignRequest email | [optional] 
 **message** | **str** | Message to include in SignRequest email, may contain the following html tags: `a`, `abbr`, `acronym`, `b`, `blockquote`, `code`, `em`, `i`, `ul`, `li`, `ol`, and `strong` | [optional] 
 **who** | **str** | `m`: only me, `mo`: me and others, `o`: only others | [optional] 
-**send_reminders** | **bool** | Automatically remind signers to sign a document | [optional] 
+**send_reminders** | **bool** | Automatically remind signers to sign a document, see: [automatic reminders](#section/Working-with-a-SignRequest/Automatic-reminders) | [optional] 
 **signers** | [**list[Signer]**](Signer.md) |  | [optional] 
 **uuid** | **str** |  | [optional] 
 

docs/SignRequest.md

@@ -21,13 +21,13 @@ Name | Type | Description | Notes
 **subject** | **str** | Subject of SignRequest email | [optional] 
 **message** | **str** | Message to include in SignRequest email, may contain the following html tags: `a`, `abbr`, `acronym`, `b`, `blockquote`, `code`, `em`, `i`, `ul`, `li`, `ol`, and `strong` | [optional] 
 **who** | **str** | `m`: only me, `mo`: me and others, `o`: only others | [optional] [default to 'o']
-**send_reminders** | **bool** | Automatically remind signers to sign a document | [optional] 
+**send_reminders** | **bool** | Automatically remind signers to sign a document, see: [automatic reminders](#section/Working-with-a-SignRequest/Automatic-reminders) | [optional] 
 **signers** | [**list[Signer]**](Signer.md) |  | 
 **uuid** | **str** |  | [optional] 
 **url** | **str** |  | [optional] 
 **document** | **str** |  | 
 **integration** | **str** |  | [optional] 
-**integration_data** | **str** |  | [optional] 
+**integration_data** | **object** |  | [optional] 
 
 [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
 

docs/SignRequestQuickCreate.md

@@ -21,13 +21,13 @@ Name | Type | Description | Notes
 **subject** | **str** | Subject of SignRequest email | [optional] 
 **message** | **str** | Message to include in SignRequest email, may contain the following html tags: `a`, `abbr`, `acronym`, `b`, `blockquote`, `code`, `em`, `i`, `ul`, `li`, `ol`, and `strong` | [optional] 
 **who** | **str** | `m`: only me, `mo`: me and others, `o`: only others | [optional] [default to 'o']
-**send_reminders** | **bool** | Automatically remind signers to sign a document | [optional] 
+**send_reminders** | **bool** | Automatically remind signers to sign a document, see: [automatic reminders](#section/Working-with-a-SignRequest/Automatic-reminders) | [optional] 
 **signers** | [**list[Signer]**](Signer.md) |  | 
 **uuid** | **str** |  | [optional] 
 **url** | **str** |  | [optional] 
 **document** | **str** |  | [optional] 
 **integration** | **str** |  | [optional] 
-**integration_data** | **str** |  | [optional] 
+**integration_data** | **object** |  | [optional] 
 **name** | **str** | Defaults to filename, including extension | [optional] 
 **external_id** | **str** | ID used to reference document in external system | [optional] 
 **frontend_id** | **str** | Shared secret used in conjunction with <a href=\"#section/Frontend-API/SignRequest-js-client-(beta)\">SignRequest-js client</a> to grant user access to a document that's not a member of the document's team | [optional] 

docs/Signer.md

@@ -12,10 +12,10 @@ Name | Type | Description | Notes
 **signed** | **bool** |  | [optional] 
 **downloaded** | **bool** |  | [optional] 
 **signed_on** | **datetime** |  | [optional] 
-**needs_to_sign** | **bool** |  | [optional] [default to True]
-**approve_only** | **bool** |  | [optional] 
-**notify_only** | **bool** |  | [optional] 
-**in_person** | **bool** |  | [optional] 
+**needs_to_sign** | **bool** | When `false` user does not need to sign, but will receive a copy of the signed document and signing log, see: [Copy only](#section/Additional-signing-methods/Copy-only) | [optional] [default to True]
+**approve_only** | **bool** | Require user to approve the document (without adding a signature), see: [Approve only](#section/Additional-signing-methods/Approve-only) | [optional] 
+**notify_only** | **bool** | Send notifications about the document and a copy of the signed document and signing log, but don't require them to take any action, see: [Notify only](#section/Additional-signing-methods/Notify-only) | [optional] 
+**in_person** | **bool** | When used in combination with an embed url on the sender, after sender has signed, they will be redirected to the next `in_person` signer, see: [In person signing](#section/Additional-signing-methods/In-person-signing) | [optional] 
 **order** | **int** |  | [optional] 
 **language** | **str** |  | [optional] 
 **force_language** | **bool** |  | [optional] 

setup.py

@@ -15,7 +15,7 @@
 import os
 
 NAME = "signrequest-python-client"
-VERSION = "2.0.0"
+VERSION = "2.1.0"
 
 def read(fname):
     return open(os.path.join(os.path.dirname(__file__), fname)).read()

signrequest_client/api_client.py

@@ -74,7 +74,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 = 'Swagger-Codegen/2.0.0/python'
+        self.user_agent = 'Swagger-Codegen/2.1.0/python'
 
     def __del__(self):
         if self._pool is not None:

signrequest_client/configuration.py

@@ -49,6 +49,8 @@ def __init__(self):
         self.api_key = {}
         # dict to store API prefix (e.g. Bearer)
         self.api_key_prefix = {}
+        # function to refresh API key if expired
+        self.refresh_api_key_hook = None
         # Username for HTTP basic authentication
         self.username = ""
         # Password for HTTP basic authentication
@@ -200,11 +202,17 @@ def get_api_key_with_prefix(self, identifier):
         :param identifier: The identifier of apiKey.
         :return: The token for api key authentication.
         """
-        if (self.api_key.get(identifier) and
-                self.api_key_prefix.get(identifier)):
-            return self.api_key_prefix[identifier] + ' ' + self.api_key[identifier]  # noqa: E501
-        elif self.api_key.get(identifier):
-            return self.api_key[identifier]
+
+        if self.refresh_api_key_hook:
+            self.refresh_api_key_hook(self)
+
+        key = self.api_key.get(identifier)
+        if key:
+            prefix = self.api_key_prefix.get(identifier)
+            if prefix:
+                return "%s %s" % (prefix, key)
+            else:
+                return key
 
     def get_basic_auth_token(self):
         """Gets HTTP basic authentication header (string).
@@ -240,5 +248,5 @@ def to_debug_report(self):
                "OS: {env}\n"\
                "Python Version: {pyversion}\n"\
                "Version of the API: v1\n"\
-               "SDK Package Version: 2.0.0".\
+               "SDK Package Version: 2.1.0".\
                format(env=sys.platform, pyversion=sys.version)

signrequest_client/models/document.py

@@ -16,15 +16,6 @@
 
 import six
 
-from signrequest_client.models.document_attachment import DocumentAttachment  # noqa: F401,E501
-from signrequest_client.models.document_signing_log import DocumentSigningLog  # noqa: F401,E501
-from signrequest_client.models.document_signrequest import DocumentSignrequest  # noqa: F401,E501
-from signrequest_client.models.document_team import DocumentTeam  # noqa: F401,E501
-from signrequest_client.models.file_from_sf import FileFromSf  # noqa: F401,E501
-from signrequest_client.models.inline_integration_data import InlineIntegrationData  # noqa: F401,E501
-from signrequest_client.models.inline_prefill_tags import InlinePrefillTags  # noqa: F401,E501
-from signrequest_client.models.user import User  # noqa: F401,E501
-
 
 class Document(object):
     """NOTE: This class is auto generated by the swagger code generator program.
@@ -68,7 +59,8 @@ class Document(object):
         'attachments': 'list[DocumentAttachment]',
         'auto_delete_after': 'datetime',
         'sandbox': 'bool',
-        'auto_expire_after': 'datetime'
+        'auto_expire_after': 'datetime',
+        'processing': 'bool'
     }
 
     attribute_map = {
@@ -100,10 +92,11 @@ class Document(object):
         'attachments': 'attachments',
         'auto_delete_after': 'auto_delete_after',
         'sandbox': 'sandbox',
-        'auto_expire_after': 'auto_expire_after'
+        'auto_expire_after': 'auto_expire_after',
+        'processing': 'processing'
     }
 
-    def __init__(self, url=None, team=None, uuid=None, user=None, file_as_pdf=None, name=None, external_id=None, frontend_id=None, file=None, file_from_url=None, events_callback_url=None, file_from_content=None, file_from_content_name=None, template=None, prefill_tags=None, integrations=None, file_from_sf=None, auto_delete_days=None, auto_expire_days=None, pdf=None, status=None, signrequest=None, api_used=None, signing_log=None, security_hash=None, attachments=None, auto_delete_after=None, sandbox=None, auto_expire_after=None):  # noqa: E501
+    def __init__(self, url=None, team=None, uuid=None, user=None, file_as_pdf=None, name=None, external_id=None, frontend_id=None, file=None, file_from_url=None, events_callback_url=None, file_from_content=None, file_from_content_name=None, template=None, prefill_tags=None, integrations=None, file_from_sf=None, auto_delete_days=None, auto_expire_days=None, pdf=None, status=None, signrequest=None, api_used=None, signing_log=None, security_hash=None, attachments=None, auto_delete_after=None, sandbox=None, auto_expire_after=None, processing=None):  # noqa: E501
         """Document - a model defined in Swagger"""  # noqa: E501
 
         self._url = None
@@ -135,6 +128,7 @@ def __init__(self, url=None, team=None, uuid=None, user=None, file_as_pdf=None,
         self._auto_delete_after = None
         self._sandbox = None
         self._auto_expire_after = None
+        self._processing = None
         self.discriminator = None
 
         if url is not None:
@@ -195,6 +189,8 @@ def __init__(self, url=None, team=None, uuid=None, user=None, file_as_pdf=None,
             self.sandbox = sandbox
         if auto_expire_after is not None:
             self.auto_expire_after = auto_expire_after
+        if processing is not None:
+            self.processing = processing
 
     @property
     def url(self):
@@ -873,6 +869,29 @@ def auto_expire_after(self, auto_expire_after):
 
         self._auto_expire_after = auto_expire_after
 
+    @property
+    def processing(self):
+        """Gets the processing of this Document.  # noqa: E501
+
+        Indicates whether a change to the document is processing and the PDF may be out of date. It is recommended to wait until processing has finished before downloading the PDF. Webhooks are not sent until processing has been completed.  # noqa: E501
+
+        :return: The processing of this Document.  # noqa: E501
+        :rtype: bool
+        """
+        return self._processing
+
+    @processing.setter
+    def processing(self, processing):
+        """Sets the processing of this Document.
+
+        Indicates whether a change to the document is processing and the PDF may be out of date. It is recommended to wait until processing has finished before downloading the PDF. Webhooks are not sent until processing has been completed.  # noqa: E501
+
+        :param processing: The processing of this Document.  # noqa: E501
+        :type: bool
+        """
+
+        self._processing = processing
+
     def to_dict(self):
         """Returns the model properties as a dict"""
         result = {}