diff --git a/docusign_esign/__init__.py b/docusign_esign/__init__.py index f3ef9514..9e458ecf 100644 --- a/docusign_esign/__init__.py +++ b/docusign_esign/__init__.py @@ -384,7 +384,6 @@ from .apis.billing_api import BillingApi from .apis.bulk_envelopes_api import BulkEnvelopesApi from .apis.cloud_storage_api import CloudStorageApi -from .apis.comments_api import CommentsApi from .apis.connect_api import ConnectApi from .apis.custom_tabs_api import CustomTabsApi from .apis.diagnostics_api import DiagnosticsApi diff --git a/docusign_esign/apis/bulk_envelopes_api.py b/docusign_esign/apis/bulk_envelopes_api.py index b868cdbb..92b99198 100644 --- a/docusign_esign/apis/bulk_envelopes_api.py +++ b/docusign_esign/apis/bulk_envelopes_api.py @@ -420,7 +420,6 @@ def list(self, account_id, **kwargs): for asynchronous request. (optional) :param str account_id: The external account number (int) or account ID Guid. (required) :param str count: The number of results to return. This can be 1 to 20. - :param str include: :param str start_position: The position of the bulk envelope items in the response. This is used for repeated calls, when the number of bulk envelopes returned is too large for one return. The default value is 0. :return: BulkEnvelopesResponse If the method is called asynchronously, @@ -449,14 +448,13 @@ def list_with_http_info(self, account_id, **kwargs): for asynchronous request. (optional) :param str account_id: The external account number (int) or account ID Guid. (required) :param str count: The number of results to return. This can be 1 to 20. - :param str include: :param str start_position: The position of the bulk envelope items in the response. This is used for repeated calls, when the number of bulk envelopes returned is too large for one return. The default value is 0. :return: BulkEnvelopesResponse If the method is called asynchronously, returns the request thread. """ - all_params = ['account_id', 'count', 'include', 'start_position'] + all_params = ['account_id', 'count', 'start_position'] all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') @@ -486,8 +484,6 @@ def list_with_http_info(self, account_id, **kwargs): query_params = {} if 'count' in params: query_params['count'] = params['count'] - if 'include' in params: - query_params['include'] = params['include'] if 'start_position' in params: query_params['start_position'] = params['start_position'] diff --git a/docusign_esign/apis/comments_api.py b/docusign_esign/apis/comments_api.py deleted file mode 100644 index b3994a78..00000000 --- a/docusign_esign/apis/comments_api.py +++ /dev/null @@ -1,153 +0,0 @@ -# coding: utf-8 - -""" - DocuSign REST API - - The DocuSign REST API provides you with a powerful, convenient, and simple Web services API for interacting with DocuSign. - - OpenAPI spec version: v2 - Contact: devcenter@docusign.com - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - - -from __future__ import absolute_import - -import sys -import os -import re - -# python 2 and python 3 compatibility library -from six import iteritems - -from ..client.configuration import Configuration -from ..client.api_client import ApiClient - - -class CommentsApi(object): - """ - NOTE: This class is auto generated by the swagger code generator program. - Do not edit the class manually. - Ref: https://github.com/swagger-api/swagger-codegen - """ - - def __init__(self, api_client=None): - config = Configuration() - if api_client: - self.api_client = api_client - else: - if not config.api_client: - config.api_client = ApiClient() - self.api_client = config.api_client - - def get_comments_transcript(self, account_id, envelope_id, **kwargs): - """ - Gets comment transcript for envelope and user - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_comments_transcript(account_id, envelope_id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str account_id: The external account number (int) or account ID Guid. (required) - :param str envelope_id: The envelopeId Guid of the envelope being accessed. (required) - :param str encoding: - :return: file - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.get_comments_transcript_with_http_info(account_id, envelope_id, **kwargs) - else: - (data) = self.get_comments_transcript_with_http_info(account_id, envelope_id, **kwargs) - return data - - def get_comments_transcript_with_http_info(self, account_id, envelope_id, **kwargs): - """ - Gets comment transcript for envelope and user - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_comments_transcript_with_http_info(account_id, envelope_id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str account_id: The external account number (int) or account ID Guid. (required) - :param str envelope_id: The envelopeId Guid of the envelope being accessed. (required) - :param str encoding: - :return: file - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['account_id', 'envelope_id', 'encoding'] - all_params.append('callback') - all_params.append('_return_http_data_only') - all_params.append('_preload_content') - all_params.append('_request_timeout') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method get_comments_transcript" % key - ) - params[key] = val - del params['kwargs'] - # verify the required parameter 'account_id' is set - if ('account_id' not in params) or (params['account_id'] is None): - raise ValueError("Missing the required parameter `account_id` when calling `get_comments_transcript`") - # verify the required parameter 'envelope_id' is set - if ('envelope_id' not in params) or (params['envelope_id'] is None): - raise ValueError("Missing the required parameter `envelope_id` when calling `get_comments_transcript`") - - - collection_formats = {} - - resource_path = '/v2/accounts/{accountId}/envelopes/{envelopeId}/comments/transcript'.replace('{format}', 'json') - path_params = {} - if 'account_id' in params: - path_params['accountId'] = params['account_id'] - if 'envelope_id' in params: - path_params['envelopeId'] = params['envelope_id'] - - query_params = {} - if 'encoding' in params: - query_params['encoding'] = params['encoding'] - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['application/pdf']) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'GET', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='file', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only'), - _preload_content=params.get('_preload_content', True), - _request_timeout=params.get('_request_timeout'), - collection_formats=collection_formats) diff --git a/docusign_esign/models/new_user.py b/docusign_esign/models/new_user.py index 17c0bc5c..fea885e2 100644 --- a/docusign_esign/models/new_user.py +++ b/docusign_esign/models/new_user.py @@ -35,6 +35,7 @@ class NewUser(object): 'created_date_time': 'str', 'email': 'str', 'error_details': 'ErrorDetails', + 'membership_id': 'str', 'permission_profile_id': 'str', 'permission_profile_name': 'str', 'uri': 'str', @@ -48,6 +49,7 @@ class NewUser(object): 'created_date_time': 'createdDateTime', 'email': 'email', 'error_details': 'errorDetails', + 'membership_id': 'membershipId', 'permission_profile_id': 'permissionProfileId', 'permission_profile_name': 'permissionProfileName', 'uri': 'uri', @@ -56,13 +58,14 @@ class NewUser(object): 'user_status': 'userStatus' } - def __init__(self, api_password=None, created_date_time=None, email=None, error_details=None, permission_profile_id=None, permission_profile_name=None, uri=None, user_id=None, user_name=None, user_status=None): # noqa: E501 + def __init__(self, api_password=None, created_date_time=None, email=None, error_details=None, membership_id=None, permission_profile_id=None, permission_profile_name=None, uri=None, user_id=None, user_name=None, user_status=None): # noqa: E501 """NewUser - a model defined in Swagger""" # noqa: E501 self._api_password = None self._created_date_time = None self._email = None self._error_details = None + self._membership_id = None self._permission_profile_id = None self._permission_profile_name = None self._uri = None @@ -79,6 +82,8 @@ def __init__(self, api_password=None, created_date_time=None, email=None, error_ self.email = email if error_details is not None: self.error_details = error_details + if membership_id is not None: + self.membership_id = membership_id if permission_profile_id is not None: self.permission_profile_id = permission_profile_id if permission_profile_name is not None: @@ -182,6 +187,29 @@ def error_details(self, error_details): self._error_details = error_details + @property + def membership_id(self): + """Gets the membership_id of this NewUser. # noqa: E501 + + # noqa: E501 + + :return: The membership_id of this NewUser. # noqa: E501 + :rtype: str + """ + return self._membership_id + + @membership_id.setter + def membership_id(self, membership_id): + """Sets the membership_id of this NewUser. + + # noqa: E501 + + :param membership_id: The membership_id of this NewUser. # noqa: E501 + :type: str + """ + + self._membership_id = membership_id + @property def permission_profile_id(self): """Gets the permission_profile_id of this NewUser. # noqa: E501 diff --git a/docusign_esign/models/sender_email_notifications.py b/docusign_esign/models/sender_email_notifications.py index cbc3520a..6a16e4e9 100644 --- a/docusign_esign/models/sender_email_notifications.py +++ b/docusign_esign/models/sender_email_notifications.py @@ -37,6 +37,7 @@ class SenderEmailNotifications(object): 'delivery_failed': 'str', 'envelope_complete': 'str', 'offline_signing_failed': 'str', + 'powerform_responses_limit_notification_email': 'str', 'recipient_viewed': 'str', 'sender_envelope_declined': 'str', 'withdrawn_consent': 'str' @@ -49,12 +50,13 @@ class SenderEmailNotifications(object): 'delivery_failed': 'deliveryFailed', 'envelope_complete': 'envelopeComplete', 'offline_signing_failed': 'offlineSigningFailed', + 'powerform_responses_limit_notification_email': 'powerformResponsesLimitNotificationEmail', 'recipient_viewed': 'recipientViewed', 'sender_envelope_declined': 'senderEnvelopeDeclined', 'withdrawn_consent': 'withdrawnConsent' } - def __init__(self, changed_signer=None, comments_only_private_and_mention=None, comments_receive_all=None, delivery_failed=None, envelope_complete=None, offline_signing_failed=None, recipient_viewed=None, sender_envelope_declined=None, withdrawn_consent=None): # noqa: E501 + def __init__(self, changed_signer=None, comments_only_private_and_mention=None, comments_receive_all=None, delivery_failed=None, envelope_complete=None, offline_signing_failed=None, powerform_responses_limit_notification_email=None, recipient_viewed=None, sender_envelope_declined=None, withdrawn_consent=None): # noqa: E501 """SenderEmailNotifications - a model defined in Swagger""" # noqa: E501 self._changed_signer = None @@ -63,6 +65,7 @@ def __init__(self, changed_signer=None, comments_only_private_and_mention=None, self._delivery_failed = None self._envelope_complete = None self._offline_signing_failed = None + self._powerform_responses_limit_notification_email = None self._recipient_viewed = None self._sender_envelope_declined = None self._withdrawn_consent = None @@ -80,6 +83,8 @@ def __init__(self, changed_signer=None, comments_only_private_and_mention=None, self.envelope_complete = envelope_complete if offline_signing_failed is not None: self.offline_signing_failed = offline_signing_failed + if powerform_responses_limit_notification_email is not None: + self.powerform_responses_limit_notification_email = powerform_responses_limit_notification_email if recipient_viewed is not None: self.recipient_viewed = recipient_viewed if sender_envelope_declined is not None: @@ -225,6 +230,29 @@ def offline_signing_failed(self, offline_signing_failed): self._offline_signing_failed = offline_signing_failed + @property + def powerform_responses_limit_notification_email(self): + """Gets the powerform_responses_limit_notification_email of this SenderEmailNotifications. # noqa: E501 + + # noqa: E501 + + :return: The powerform_responses_limit_notification_email of this SenderEmailNotifications. # noqa: E501 + :rtype: str + """ + return self._powerform_responses_limit_notification_email + + @powerform_responses_limit_notification_email.setter + def powerform_responses_limit_notification_email(self, powerform_responses_limit_notification_email): + """Sets the powerform_responses_limit_notification_email of this SenderEmailNotifications. + + # noqa: E501 + + :param powerform_responses_limit_notification_email: The powerform_responses_limit_notification_email of this SenderEmailNotifications. # noqa: E501 + :type: str + """ + + self._powerform_responses_limit_notification_email = powerform_responses_limit_notification_email + @property def recipient_viewed(self): """Gets the recipient_viewed of this SenderEmailNotifications. # noqa: E501 diff --git a/docusign_esign/models/tab_metadata.py b/docusign_esign/models/tab_metadata.py index e069f1e2..3b3b4d2c 100644 --- a/docusign_esign/models/tab_metadata.py +++ b/docusign_esign/models/tab_metadata.py @@ -65,7 +65,9 @@ class TabMetadata(object): 'payment_item_code': 'str', 'payment_item_description': 'str', 'payment_item_name': 'str', + 'require_all': 'str', 'required': 'str', + 'require_initial_on_shared_change': 'str', 'scale_value': 'str', 'selected': 'str', 'shared': 'str', @@ -114,7 +116,9 @@ class TabMetadata(object): 'payment_item_code': 'paymentItemCode', 'payment_item_description': 'paymentItemDescription', 'payment_item_name': 'paymentItemName', + 'require_all': 'requireAll', 'required': 'required', + 'require_initial_on_shared_change': 'requireInitialOnSharedChange', 'scale_value': 'scaleValue', 'selected': 'selected', 'shared': 'shared', @@ -128,7 +132,7 @@ class TabMetadata(object): 'width': 'width' } - def __init__(self, anchor=None, anchor_case_sensitive=None, anchor_horizontal_alignment=None, anchor_ignore_if_not_present=None, anchor_match_whole_word=None, anchor_units=None, anchor_x_offset=None, anchor_y_offset=None, bold=None, collaborative=None, conceal_value_on_document=None, created_by_display_name=None, created_by_user_id=None, custom_tab_id=None, disable_auto_size=None, editable=None, font=None, font_color=None, font_size=None, height=None, included_in_email=None, initial_value=None, italic=None, items=None, last_modified=None, last_modified_by_display_name=None, last_modified_by_user_id=None, locked=None, maximum_length=None, merge_field=None, name=None, payment_item_code=None, payment_item_description=None, payment_item_name=None, required=None, scale_value=None, selected=None, shared=None, stamp_type=None, stamp_type_metadata=None, tab_label=None, type=None, underline=None, validation_message=None, validation_pattern=None, width=None): # noqa: E501 + def __init__(self, anchor=None, anchor_case_sensitive=None, anchor_horizontal_alignment=None, anchor_ignore_if_not_present=None, anchor_match_whole_word=None, anchor_units=None, anchor_x_offset=None, anchor_y_offset=None, bold=None, collaborative=None, conceal_value_on_document=None, created_by_display_name=None, created_by_user_id=None, custom_tab_id=None, disable_auto_size=None, editable=None, font=None, font_color=None, font_size=None, height=None, included_in_email=None, initial_value=None, italic=None, items=None, last_modified=None, last_modified_by_display_name=None, last_modified_by_user_id=None, locked=None, maximum_length=None, merge_field=None, name=None, payment_item_code=None, payment_item_description=None, payment_item_name=None, require_all=None, required=None, require_initial_on_shared_change=None, scale_value=None, selected=None, shared=None, stamp_type=None, stamp_type_metadata=None, tab_label=None, type=None, underline=None, validation_message=None, validation_pattern=None, width=None): # noqa: E501 """TabMetadata - a model defined in Swagger""" # noqa: E501 self._anchor = None @@ -165,7 +169,9 @@ def __init__(self, anchor=None, anchor_case_sensitive=None, anchor_horizontal_al self._payment_item_code = None self._payment_item_description = None self._payment_item_name = None + self._require_all = None self._required = None + self._require_initial_on_shared_change = None self._scale_value = None self._selected = None self._shared = None @@ -247,8 +253,12 @@ def __init__(self, anchor=None, anchor_case_sensitive=None, anchor_horizontal_al self.payment_item_description = payment_item_description if payment_item_name is not None: self.payment_item_name = payment_item_name + if require_all is not None: + self.require_all = require_all if required is not None: self.required = required + if require_initial_on_shared_change is not None: + self.require_initial_on_shared_change = require_initial_on_shared_change if scale_value is not None: self.scale_value = scale_value if selected is not None: @@ -1052,6 +1062,29 @@ def payment_item_name(self, payment_item_name): self._payment_item_name = payment_item_name + @property + def require_all(self): + """Gets the require_all of this TabMetadata. # noqa: E501 + + When set to **true** and shared is true, information must be entered in this field to complete the envelope. # noqa: E501 + + :return: The require_all of this TabMetadata. # noqa: E501 + :rtype: str + """ + return self._require_all + + @require_all.setter + def require_all(self, require_all): + """Sets the require_all of this TabMetadata. + + When set to **true** and shared is true, information must be entered in this field to complete the envelope. # noqa: E501 + + :param require_all: The require_all of this TabMetadata. # noqa: E501 + :type: str + """ + + self._require_all = require_all + @property def required(self): """Gets the required of this TabMetadata. # noqa: E501 @@ -1075,6 +1108,29 @@ def required(self, required): self._required = required + @property + def require_initial_on_shared_change(self): + """Gets the require_initial_on_shared_change of this TabMetadata. # noqa: E501 + + Optional element for field markup. When set to **true**, the signer is required to initial when they modify a shared field. # noqa: E501 + + :return: The require_initial_on_shared_change of this TabMetadata. # noqa: E501 + :rtype: str + """ + return self._require_initial_on_shared_change + + @require_initial_on_shared_change.setter + def require_initial_on_shared_change(self, require_initial_on_shared_change): + """Sets the require_initial_on_shared_change of this TabMetadata. + + Optional element for field markup. When set to **true**, the signer is required to initial when they modify a shared field. # noqa: E501 + + :param require_initial_on_shared_change: The require_initial_on_shared_change of this TabMetadata. # noqa: E501 + :type: str + """ + + self._require_initial_on_shared_change = require_initial_on_shared_change + @property def scale_value(self): """Gets the scale_value of this TabMetadata. # noqa: E501 diff --git a/setup.py b/setup.py index b2e20c2f..a47969a5 100644 --- a/setup.py +++ b/setup.py @@ -14,7 +14,7 @@ from setuptools import setup, find_packages, Command, os # noqa: H301 NAME = "docusign_esign" -VERSION = "2.5.0" +VERSION = "2.6.0rc1" # To install the library, run the following # # python setup.py install @@ -44,6 +44,9 @@ def run(self): install_requires=REQUIRES, packages=find_packages(), include_package_data=True, + cmdclass={ + 'clean': CleanCommand, + }, long_description="""\ The DocuSign REST API provides you with a powerful, convenient, and simple Web services API for interacting with DocuSign. """