From 6579f46f8ed4d4dbc26f0a7b7c6e6bba8a90fe54 Mon Sep 17 00:00:00 2001 From: Chris Jackson Date: Thu, 9 Jan 2020 22:01:42 -1000 Subject: [PATCH] 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 | 2 +- docs/Document.md | 1 + docs/DocumentSignerTemplateConf.md | 8 ++-- docs/DocumentSignrequest.md | 2 +- docs/InlineDocumentSignerIntegrationData.md | 2 +- docs/InlineIntegrationData.md | 2 +- docs/InlineSignRequest.md | 2 +- docs/SignRequest.md | 4 +- docs/SignRequestQuickCreate.md | 4 +- docs/Signer.md | 8 ++-- setup.py | 2 +- signrequest_client/api_client.py | 2 +- signrequest_client/configuration.py | 20 ++++++--- signrequest_client/models/document.py | 43 +++++++++++++------ .../models/document_signer_template_conf.py | 10 ++++- .../models/document_signrequest.py | 9 +--- signrequest_client/models/event.py | 4 -- ...inline_document_signer_integration_data.py | 8 ++-- .../models/inline_integration_data.py | 8 ++-- .../models/inline_response200.py | 2 - .../models/inline_response2001.py | 2 - .../models/inline_response2002.py | 2 - .../models/inline_response2003.py | 2 - .../models/inline_response2004.py | 2 - .../models/inline_response2005.py | 2 - .../models/inline_response2006.py | 2 - .../models/inline_response2007.py | 2 - .../models/inline_response2008.py | 2 - .../models/inline_response2009.py | 2 - .../models/inline_sign_request.py | 9 +--- .../models/inline_team_member.py | 2 - signrequest_client/models/sign_request.py | 15 +++---- .../models/sign_request_quick_create.py | 18 +++----- signrequest_client/models/signer.py | 12 ++++-- .../models/signer_attachment.py | 2 - signrequest_client/models/team.py | 2 - signrequest_client/models/team_member.py | 3 -- signrequest_client/models/template.py | 4 -- .../models/webhook_subscription.py | 4 +- 39 files changed, 106 insertions(+), 126 deletions(-) diff --git a/.swagger-codegen/VERSION b/.swagger-codegen/VERSION index 752a79e..e393c3c 100644 --- a/.swagger-codegen/VERSION +++ b/.swagger-codegen/VERSION @@ -1 +1 @@ -2.4.8 \ No newline at end of file +2.4.11 \ No newline at end of file diff --git a/docs/Document.md b/docs/Document.md index 540bbc6..0424992 100644 --- a/docs/Document.md +++ b/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) diff --git a/docs/DocumentSignerTemplateConf.md b/docs/DocumentSignerTemplateConf.md index 2a28d89..efcfc04 100644 --- a/docs/DocumentSignerTemplateConf.md +++ b/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] diff --git a/docs/DocumentSignrequest.md b/docs/DocumentSignrequest.md index c6f74f5..7f7e65e 100644 --- a/docs/DocumentSignrequest.md +++ b/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] diff --git a/docs/InlineDocumentSignerIntegrationData.md b/docs/InlineDocumentSignerIntegrationData.md index 81c644a..0c804b6 100644 --- a/docs/InlineDocumentSignerIntegrationData.md +++ b/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) diff --git a/docs/InlineIntegrationData.md b/docs/InlineIntegrationData.md index 81ece44..afb0ed1 100644 --- a/docs/InlineIntegrationData.md +++ b/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) diff --git a/docs/InlineSignRequest.md b/docs/InlineSignRequest.md index 03dc3ad..acf43cc 100644 --- a/docs/InlineSignRequest.md +++ b/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] diff --git a/docs/SignRequest.md b/docs/SignRequest.md index ee0f053..3528759 100644 --- a/docs/SignRequest.md +++ b/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) diff --git a/docs/SignRequestQuickCreate.md b/docs/SignRequestQuickCreate.md index 6bc8742..6ca06ac 100644 --- a/docs/SignRequestQuickCreate.md +++ b/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] diff --git a/docs/Signer.md b/docs/Signer.md index caa8779..e0f6328 100644 --- a/docs/Signer.md +++ b/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] diff --git a/setup.py b/setup.py index 9648738..6fc1e20 100644 --- a/setup.py +++ b/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() diff --git a/signrequest_client/api_client.py b/signrequest_client/api_client.py index 67282b4..01be236 100644 --- a/signrequest_client/api_client.py +++ b/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: diff --git a/signrequest_client/configuration.py b/signrequest_client/configuration.py index 1e60258..31f12ae 100644 --- a/signrequest_client/configuration.py +++ b/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) diff --git a/signrequest_client/models/document.py b/signrequest_client/models/document.py index fd8042b..2a351ad 100644 --- a/signrequest_client/models/document.py +++ b/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 = {} diff --git a/signrequest_client/models/document_signer_template_conf.py b/signrequest_client/models/document_signer_template_conf.py index 21fc9e2..b9b53d3 100644 --- a/signrequest_client/models/document_signer_template_conf.py +++ b/signrequest_client/models/document_signer_template_conf.py @@ -16,8 +16,6 @@ import six -from signrequest_client.models.placeholder import Placeholder # noqa: F401,E501 - class DocumentSignerTemplateConf(object): """NOTE: This class is auto generated by the swagger code generator program. @@ -108,6 +106,7 @@ def signer_index(self, signer_index): def needs_to_sign(self): """Gets the needs_to_sign of this DocumentSignerTemplateConf. # noqa: E501 + 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) # noqa: E501 :return: The needs_to_sign of this DocumentSignerTemplateConf. # noqa: E501 :rtype: bool @@ -118,6 +117,7 @@ def needs_to_sign(self): def needs_to_sign(self, needs_to_sign): """Sets the needs_to_sign of this DocumentSignerTemplateConf. + 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) # noqa: E501 :param needs_to_sign: The needs_to_sign of this DocumentSignerTemplateConf. # noqa: E501 :type: bool @@ -129,6 +129,7 @@ def needs_to_sign(self, needs_to_sign): def approve_only(self): """Gets the approve_only of this DocumentSignerTemplateConf. # noqa: E501 + Require user to approve the document (without adding a signature), see: [Approve only](#section/Additional-signing-methods/Approve-only) # noqa: E501 :return: The approve_only of this DocumentSignerTemplateConf. # noqa: E501 :rtype: bool @@ -139,6 +140,7 @@ def approve_only(self): def approve_only(self, approve_only): """Sets the approve_only of this DocumentSignerTemplateConf. + Require user to approve the document (without adding a signature), see: [Approve only](#section/Additional-signing-methods/Approve-only) # noqa: E501 :param approve_only: The approve_only of this DocumentSignerTemplateConf. # noqa: E501 :type: bool @@ -150,6 +152,7 @@ def approve_only(self, approve_only): def notify_only(self): """Gets the notify_only of this DocumentSignerTemplateConf. # noqa: E501 + 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) # noqa: E501 :return: The notify_only of this DocumentSignerTemplateConf. # noqa: E501 :rtype: bool @@ -160,6 +163,7 @@ def notify_only(self): def notify_only(self, notify_only): """Sets the notify_only of this DocumentSignerTemplateConf. + 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) # noqa: E501 :param notify_only: The notify_only of this DocumentSignerTemplateConf. # noqa: E501 :type: bool @@ -171,6 +175,7 @@ def notify_only(self, notify_only): def in_person(self): """Gets the in_person of this DocumentSignerTemplateConf. # noqa: E501 + 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) # noqa: E501 :return: The in_person of this DocumentSignerTemplateConf. # noqa: E501 :rtype: bool @@ -181,6 +186,7 @@ def in_person(self): def in_person(self, in_person): """Sets the in_person of this DocumentSignerTemplateConf. + 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) # noqa: E501 :param in_person: The in_person of this DocumentSignerTemplateConf. # noqa: E501 :type: bool diff --git a/signrequest_client/models/document_signrequest.py b/signrequest_client/models/document_signrequest.py index 180cda1..ec60e25 100644 --- a/signrequest_client/models/document_signrequest.py +++ b/signrequest_client/models/document_signrequest.py @@ -16,9 +16,6 @@ import six -from signrequest_client.models.required_attachment import RequiredAttachment # noqa: F401,E501 -from signrequest_client.models.signer import Signer # noqa: F401,E501 - class DocumentSignrequest(object): """NOTE: This class is auto generated by the swagger code generator program. @@ -170,8 +167,6 @@ def from_email(self, from_email): :param from_email: The from_email of this DocumentSignrequest. # noqa: E501 :type: str """ - if from_email is not None and len(from_email) < 1: - raise ValueError("Invalid value for `from_email`, length must be greater than or equal to `1`") # noqa: E501 self._from_email = from_email @@ -584,7 +579,7 @@ def who(self, who): def send_reminders(self): """Gets the send_reminders of this DocumentSignrequest. # noqa: E501 - Automatically remind signers to sign a document # noqa: E501 + Automatically remind signers to sign a document, see: [automatic reminders](#section/Working-with-a-SignRequest/Automatic-reminders) # noqa: E501 :return: The send_reminders of this DocumentSignrequest. # noqa: E501 :rtype: bool @@ -595,7 +590,7 @@ def send_reminders(self): def send_reminders(self, send_reminders): """Sets the send_reminders of this DocumentSignrequest. - Automatically remind signers to sign a document # noqa: E501 + Automatically remind signers to sign a document, see: [automatic reminders](#section/Working-with-a-SignRequest/Automatic-reminders) # noqa: E501 :param send_reminders: The send_reminders of this DocumentSignrequest. # noqa: E501 :type: bool diff --git a/signrequest_client/models/event.py b/signrequest_client/models/event.py index 7b115e7..a937589 100644 --- a/signrequest_client/models/event.py +++ b/signrequest_client/models/event.py @@ -16,10 +16,6 @@ import six -from signrequest_client.models.document import Document # noqa: F401,E501 -from signrequest_client.models.document_team import DocumentTeam # noqa: F401,E501 -from signrequest_client.models.signer import Signer # noqa: F401,E501 - class Event(object): """NOTE: This class is auto generated by the swagger code generator program. diff --git a/signrequest_client/models/inline_document_signer_integration_data.py b/signrequest_client/models/inline_document_signer_integration_data.py index ef75b66..ce6df56 100644 --- a/signrequest_client/models/inline_document_signer_integration_data.py +++ b/signrequest_client/models/inline_document_signer_integration_data.py @@ -32,7 +32,7 @@ class InlineDocumentSignerIntegrationData(object): """ swagger_types = { 'integration': 'str', - 'integration_data': 'str' + 'integration_data': 'object' } attribute_map = { @@ -70,7 +70,7 @@ def integration(self, integration): :param integration: The integration of this InlineDocumentSignerIntegrationData. # noqa: E501 :type: str """ - allowed_values = ["mfiles", "salesforce", "formdesk", "zapier", "txhash"] # noqa: E501 + allowed_values = ["mfiles", "salesforce", "formdesk", "zapier"] # noqa: E501 if integration not in allowed_values: raise ValueError( "Invalid value for `integration` ({0}), must be one of {1}" # noqa: E501 @@ -85,7 +85,7 @@ def integration_data(self): :return: The integration_data of this InlineDocumentSignerIntegrationData. # noqa: E501 - :rtype: str + :rtype: object """ return self._integration_data @@ -95,7 +95,7 @@ def integration_data(self, integration_data): :param integration_data: The integration_data of this InlineDocumentSignerIntegrationData. # noqa: E501 - :type: str + :type: object """ self._integration_data = integration_data diff --git a/signrequest_client/models/inline_integration_data.py b/signrequest_client/models/inline_integration_data.py index 294b741..b59fa96 100644 --- a/signrequest_client/models/inline_integration_data.py +++ b/signrequest_client/models/inline_integration_data.py @@ -32,7 +32,7 @@ class InlineIntegrationData(object): """ swagger_types = { 'integration': 'str', - 'integration_data': 'str' + 'integration_data': 'object' } attribute_map = { @@ -70,7 +70,7 @@ def integration(self, integration): :param integration: The integration of this InlineIntegrationData. # noqa: E501 :type: str """ - allowed_values = ["mfiles", "salesforce", "formdesk", "zapier", "txhash"] # noqa: E501 + allowed_values = ["mfiles", "salesforce", "formdesk", "zapier"] # noqa: E501 if integration not in allowed_values: raise ValueError( "Invalid value for `integration` ({0}), must be one of {1}" # noqa: E501 @@ -85,7 +85,7 @@ def integration_data(self): :return: The integration_data of this InlineIntegrationData. # noqa: E501 - :rtype: str + :rtype: object """ return self._integration_data @@ -95,7 +95,7 @@ def integration_data(self, integration_data): :param integration_data: The integration_data of this InlineIntegrationData. # noqa: E501 - :type: str + :type: object """ self._integration_data = integration_data diff --git a/signrequest_client/models/inline_response200.py b/signrequest_client/models/inline_response200.py index aaef618..c9e1ea2 100644 --- a/signrequest_client/models/inline_response200.py +++ b/signrequest_client/models/inline_response200.py @@ -16,8 +16,6 @@ import six -from signrequest_client.models.auth_token import AuthToken # noqa: F401,E501 - class InlineResponse200(object): """NOTE: This class is auto generated by the swagger code generator program. diff --git a/signrequest_client/models/inline_response2001.py b/signrequest_client/models/inline_response2001.py index 4e4a6ce..66e89a2 100644 --- a/signrequest_client/models/inline_response2001.py +++ b/signrequest_client/models/inline_response2001.py @@ -16,8 +16,6 @@ import six -from signrequest_client.models.document_attachment import DocumentAttachment # noqa: F401,E501 - class InlineResponse2001(object): """NOTE: This class is auto generated by the swagger code generator program. diff --git a/signrequest_client/models/inline_response2002.py b/signrequest_client/models/inline_response2002.py index e8fc714..5dee27f 100644 --- a/signrequest_client/models/inline_response2002.py +++ b/signrequest_client/models/inline_response2002.py @@ -16,8 +16,6 @@ import six -from signrequest_client.models.document_search import DocumentSearch # noqa: F401,E501 - class InlineResponse2002(object): """NOTE: This class is auto generated by the swagger code generator program. diff --git a/signrequest_client/models/inline_response2003.py b/signrequest_client/models/inline_response2003.py index 8d16842..30de50e 100644 --- a/signrequest_client/models/inline_response2003.py +++ b/signrequest_client/models/inline_response2003.py @@ -16,8 +16,6 @@ import six -from signrequest_client.models.document import Document # noqa: F401,E501 - class InlineResponse2003(object): """NOTE: This class is auto generated by the swagger code generator program. diff --git a/signrequest_client/models/inline_response2004.py b/signrequest_client/models/inline_response2004.py index 4032783..0825df9 100644 --- a/signrequest_client/models/inline_response2004.py +++ b/signrequest_client/models/inline_response2004.py @@ -16,8 +16,6 @@ import six -from signrequest_client.models.event import Event # noqa: F401,E501 - class InlineResponse2004(object): """NOTE: This class is auto generated by the swagger code generator program. diff --git a/signrequest_client/models/inline_response2005.py b/signrequest_client/models/inline_response2005.py index eb3dd1f..a962d61 100644 --- a/signrequest_client/models/inline_response2005.py +++ b/signrequest_client/models/inline_response2005.py @@ -16,8 +16,6 @@ import six -from signrequest_client.models.sign_request import SignRequest # noqa: F401,E501 - class InlineResponse2005(object): """NOTE: This class is auto generated by the swagger code generator program. diff --git a/signrequest_client/models/inline_response2006.py b/signrequest_client/models/inline_response2006.py index 91aa4dc..77b8033 100644 --- a/signrequest_client/models/inline_response2006.py +++ b/signrequest_client/models/inline_response2006.py @@ -16,8 +16,6 @@ import six -from signrequest_client.models.team_member import TeamMember # noqa: F401,E501 - class InlineResponse2006(object): """NOTE: This class is auto generated by the swagger code generator program. diff --git a/signrequest_client/models/inline_response2007.py b/signrequest_client/models/inline_response2007.py index c7dbe52..bfbbbed 100644 --- a/signrequest_client/models/inline_response2007.py +++ b/signrequest_client/models/inline_response2007.py @@ -16,8 +16,6 @@ import six -from signrequest_client.models.team import Team # noqa: F401,E501 - class InlineResponse2007(object): """NOTE: This class is auto generated by the swagger code generator program. diff --git a/signrequest_client/models/inline_response2008.py b/signrequest_client/models/inline_response2008.py index 078ec6b..15c9a11 100644 --- a/signrequest_client/models/inline_response2008.py +++ b/signrequest_client/models/inline_response2008.py @@ -16,8 +16,6 @@ import six -from signrequest_client.models.template import Template # noqa: F401,E501 - class InlineResponse2008(object): """NOTE: This class is auto generated by the swagger code generator program. diff --git a/signrequest_client/models/inline_response2009.py b/signrequest_client/models/inline_response2009.py index 4e24a04..e082d48 100644 --- a/signrequest_client/models/inline_response2009.py +++ b/signrequest_client/models/inline_response2009.py @@ -16,8 +16,6 @@ import six -from signrequest_client.models.webhook_subscription import WebhookSubscription # noqa: F401,E501 - class InlineResponse2009(object): """NOTE: This class is auto generated by the swagger code generator program. diff --git a/signrequest_client/models/inline_sign_request.py b/signrequest_client/models/inline_sign_request.py index 486e0c2..d465f6c 100644 --- a/signrequest_client/models/inline_sign_request.py +++ b/signrequest_client/models/inline_sign_request.py @@ -16,9 +16,6 @@ import six -from signrequest_client.models.required_attachment import RequiredAttachment # noqa: F401,E501 -from signrequest_client.models.signer import Signer # noqa: F401,E501 - class InlineSignRequest(object): """NOTE: This class is auto generated by the swagger code generator program. @@ -170,8 +167,6 @@ def from_email(self, from_email): :param from_email: The from_email of this InlineSignRequest. # noqa: E501 :type: str """ - if from_email is not None and len(from_email) < 1: - raise ValueError("Invalid value for `from_email`, length must be greater than or equal to `1`") # noqa: E501 self._from_email = from_email @@ -584,7 +579,7 @@ def who(self, who): def send_reminders(self): """Gets the send_reminders of this InlineSignRequest. # noqa: E501 - Automatically remind signers to sign a document # noqa: E501 + Automatically remind signers to sign a document, see: [automatic reminders](#section/Working-with-a-SignRequest/Automatic-reminders) # noqa: E501 :return: The send_reminders of this InlineSignRequest. # noqa: E501 :rtype: bool @@ -595,7 +590,7 @@ def send_reminders(self): def send_reminders(self, send_reminders): """Sets the send_reminders of this InlineSignRequest. - Automatically remind signers to sign a document # noqa: E501 + Automatically remind signers to sign a document, see: [automatic reminders](#section/Working-with-a-SignRequest/Automatic-reminders) # noqa: E501 :param send_reminders: The send_reminders of this InlineSignRequest. # noqa: E501 :type: bool diff --git a/signrequest_client/models/inline_team_member.py b/signrequest_client/models/inline_team_member.py index 4674687..e3694bb 100644 --- a/signrequest_client/models/inline_team_member.py +++ b/signrequest_client/models/inline_team_member.py @@ -16,8 +16,6 @@ import six -from signrequest_client.models.user import User # noqa: F401,E501 - class InlineTeamMember(object): """NOTE: This class is auto generated by the swagger code generator program. diff --git a/signrequest_client/models/sign_request.py b/signrequest_client/models/sign_request.py index 944d644..e36aefb 100644 --- a/signrequest_client/models/sign_request.py +++ b/signrequest_client/models/sign_request.py @@ -16,9 +16,6 @@ import six -from signrequest_client.models.required_attachment import RequiredAttachment # noqa: F401,E501 -from signrequest_client.models.signer import Signer # noqa: F401,E501 - class SignRequest(object): """NOTE: This class is auto generated by the swagger code generator program. @@ -58,7 +55,7 @@ class SignRequest(object): 'url': 'str', 'document': 'str', 'integration': 'str', - 'integration_data': 'str' + 'integration_data': 'object' } attribute_map = { @@ -604,7 +601,7 @@ def who(self, who): def send_reminders(self): """Gets the send_reminders of this SignRequest. # noqa: E501 - Automatically remind signers to sign a document # noqa: E501 + Automatically remind signers to sign a document, see: [automatic reminders](#section/Working-with-a-SignRequest/Automatic-reminders) # noqa: E501 :return: The send_reminders of this SignRequest. # noqa: E501 :rtype: bool @@ -615,7 +612,7 @@ def send_reminders(self): def send_reminders(self, send_reminders): """Sets the send_reminders of this SignRequest. - Automatically remind signers to sign a document # noqa: E501 + Automatically remind signers to sign a document, see: [automatic reminders](#section/Working-with-a-SignRequest/Automatic-reminders) # noqa: E501 :param send_reminders: The send_reminders of this SignRequest. # noqa: E501 :type: bool @@ -731,7 +728,7 @@ def integration(self, integration): :param integration: The integration of this SignRequest. # noqa: E501 :type: str """ - allowed_values = ["mfiles", "salesforce", "formdesk", "zapier", "txhash"] # noqa: E501 + allowed_values = ["mfiles", "salesforce", "formdesk", "zapier"] # noqa: E501 if integration not in allowed_values: raise ValueError( "Invalid value for `integration` ({0}), must be one of {1}" # noqa: E501 @@ -746,7 +743,7 @@ def integration_data(self): :return: The integration_data of this SignRequest. # noqa: E501 - :rtype: str + :rtype: object """ return self._integration_data @@ -756,7 +753,7 @@ def integration_data(self, integration_data): :param integration_data: The integration_data of this SignRequest. # noqa: E501 - :type: str + :type: object """ self._integration_data = integration_data diff --git a/signrequest_client/models/sign_request_quick_create.py b/signrequest_client/models/sign_request_quick_create.py index fe63b8c..dfb2eaa 100644 --- a/signrequest_client/models/sign_request_quick_create.py +++ b/signrequest_client/models/sign_request_quick_create.py @@ -16,12 +16,6 @@ import six -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.required_attachment import RequiredAttachment # noqa: F401,E501 -from signrequest_client.models.signer import Signer # noqa: F401,E501 - class SignRequestQuickCreate(object): """NOTE: This class is auto generated by the swagger code generator program. @@ -61,7 +55,7 @@ class SignRequestQuickCreate(object): 'url': 'str', 'document': 'str', 'integration': 'str', - 'integration_data': 'str', + 'integration_data': 'object', 'name': 'str', 'external_id': 'str', 'frontend_id': 'str', @@ -678,7 +672,7 @@ def who(self, who): def send_reminders(self): """Gets the send_reminders of this SignRequestQuickCreate. # noqa: E501 - Automatically remind signers to sign a document # noqa: E501 + Automatically remind signers to sign a document, see: [automatic reminders](#section/Working-with-a-SignRequest/Automatic-reminders) # noqa: E501 :return: The send_reminders of this SignRequestQuickCreate. # noqa: E501 :rtype: bool @@ -689,7 +683,7 @@ def send_reminders(self): def send_reminders(self, send_reminders): """Sets the send_reminders of this SignRequestQuickCreate. - Automatically remind signers to sign a document # noqa: E501 + Automatically remind signers to sign a document, see: [automatic reminders](#section/Working-with-a-SignRequest/Automatic-reminders) # noqa: E501 :param send_reminders: The send_reminders of this SignRequestQuickCreate. # noqa: E501 :type: bool @@ -803,7 +797,7 @@ def integration(self, integration): :param integration: The integration of this SignRequestQuickCreate. # noqa: E501 :type: str """ - allowed_values = ["mfiles", "salesforce", "formdesk", "zapier", "txhash"] # noqa: E501 + allowed_values = ["mfiles", "salesforce", "formdesk", "zapier"] # noqa: E501 if integration not in allowed_values: raise ValueError( "Invalid value for `integration` ({0}), must be one of {1}" # noqa: E501 @@ -818,7 +812,7 @@ def integration_data(self): :return: The integration_data of this SignRequestQuickCreate. # noqa: E501 - :rtype: str + :rtype: object """ return self._integration_data @@ -828,7 +822,7 @@ def integration_data(self, integration_data): :param integration_data: The integration_data of this SignRequestQuickCreate. # noqa: E501 - :type: str + :type: object """ self._integration_data = integration_data diff --git a/signrequest_client/models/signer.py b/signrequest_client/models/signer.py index 078c2d2..008d23c 100644 --- a/signrequest_client/models/signer.py +++ b/signrequest_client/models/signer.py @@ -16,10 +16,6 @@ import six -from signrequest_client.models.inline_document_signer_integration_data import InlineDocumentSignerIntegrationData # noqa: F401,E501 -from signrequest_client.models.signer_attachment import SignerAttachment # noqa: F401,E501 -from signrequest_client.models.signer_inputs import SignerInputs # noqa: F401,E501 - class Signer(object): """NOTE: This class is auto generated by the swagger code generator program. @@ -430,6 +426,7 @@ def signed_on(self, signed_on): def needs_to_sign(self): """Gets the needs_to_sign of this Signer. # noqa: E501 + 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) # noqa: E501 :return: The needs_to_sign of this Signer. # noqa: E501 :rtype: bool @@ -440,6 +437,7 @@ def needs_to_sign(self): def needs_to_sign(self, needs_to_sign): """Sets the needs_to_sign of this Signer. + 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) # noqa: E501 :param needs_to_sign: The needs_to_sign of this Signer. # noqa: E501 :type: bool @@ -451,6 +449,7 @@ def needs_to_sign(self, needs_to_sign): def approve_only(self): """Gets the approve_only of this Signer. # noqa: E501 + Require user to approve the document (without adding a signature), see: [Approve only](#section/Additional-signing-methods/Approve-only) # noqa: E501 :return: The approve_only of this Signer. # noqa: E501 :rtype: bool @@ -461,6 +460,7 @@ def approve_only(self): def approve_only(self, approve_only): """Sets the approve_only of this Signer. + Require user to approve the document (without adding a signature), see: [Approve only](#section/Additional-signing-methods/Approve-only) # noqa: E501 :param approve_only: The approve_only of this Signer. # noqa: E501 :type: bool @@ -472,6 +472,7 @@ def approve_only(self, approve_only): def notify_only(self): """Gets the notify_only of this Signer. # noqa: E501 + 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) # noqa: E501 :return: The notify_only of this Signer. # noqa: E501 :rtype: bool @@ -482,6 +483,7 @@ def notify_only(self): def notify_only(self, notify_only): """Sets the notify_only of this Signer. + 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) # noqa: E501 :param notify_only: The notify_only of this Signer. # noqa: E501 :type: bool @@ -493,6 +495,7 @@ def notify_only(self, notify_only): def in_person(self): """Gets the in_person of this Signer. # noqa: E501 + 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) # noqa: E501 :return: The in_person of this Signer. # noqa: E501 :rtype: bool @@ -503,6 +506,7 @@ def in_person(self): def in_person(self, in_person): """Sets the in_person of this Signer. + 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) # noqa: E501 :param in_person: The in_person of this Signer. # noqa: E501 :type: bool diff --git a/signrequest_client/models/signer_attachment.py b/signrequest_client/models/signer_attachment.py index 58e3d39..868b89d 100644 --- a/signrequest_client/models/signer_attachment.py +++ b/signrequest_client/models/signer_attachment.py @@ -16,8 +16,6 @@ import six -from signrequest_client.models.required_attachment import RequiredAttachment # noqa: F401,E501 - class SignerAttachment(object): """NOTE: This class is auto generated by the swagger code generator program. diff --git a/signrequest_client/models/team.py b/signrequest_client/models/team.py index 2bb352f..1d482a4 100644 --- a/signrequest_client/models/team.py +++ b/signrequest_client/models/team.py @@ -16,8 +16,6 @@ import six -from signrequest_client.models.inline_team_member import InlineTeamMember # noqa: F401,E501 - class Team(object): """NOTE: This class is auto generated by the swagger code generator program. diff --git a/signrequest_client/models/team_member.py b/signrequest_client/models/team_member.py index 92271ee..6841c78 100644 --- a/signrequest_client/models/team_member.py +++ b/signrequest_client/models/team_member.py @@ -16,9 +16,6 @@ import six -from signrequest_client.models.document_team import DocumentTeam # noqa: F401,E501 -from signrequest_client.models.user import User # noqa: F401,E501 - class TeamMember(object): """NOTE: This class is auto generated by the swagger code generator program. diff --git a/signrequest_client/models/template.py b/signrequest_client/models/template.py index 20bee25..ab7bd89 100644 --- a/signrequest_client/models/template.py +++ b/signrequest_client/models/template.py @@ -16,10 +16,6 @@ import six -from signrequest_client.models.document_signer_template_conf import DocumentSignerTemplateConf # noqa: F401,E501 -from signrequest_client.models.document_team import DocumentTeam # noqa: F401,E501 -from signrequest_client.models.user import User # noqa: F401,E501 - class Template(object): """NOTE: This class is auto generated by the swagger code generator program. diff --git a/signrequest_client/models/webhook_subscription.py b/signrequest_client/models/webhook_subscription.py index eef9015..4491c60 100644 --- a/signrequest_client/models/webhook_subscription.py +++ b/signrequest_client/models/webhook_subscription.py @@ -16,8 +16,6 @@ import six -from signrequest_client.models.document_team import DocumentTeam # noqa: F401,E501 - class WebhookSubscription(object): """NOTE: This class is auto generated by the swagger code generator program. @@ -225,7 +223,7 @@ def integration(self, integration): :param integration: The integration of this WebhookSubscription. # noqa: E501 :type: str """ - allowed_values = ["mfiles", "salesforce", "formdesk", "zapier", "txhash"] # noqa: E501 + allowed_values = ["mfiles", "salesforce", "formdesk", "zapier"] # noqa: E501 if integration not in allowed_values: raise ValueError( "Invalid value for `integration` ({0}), must be one of {1}" # noqa: E501