Version 3.3.0-rc1 apiv2.1 (#65)

Version 3.3.0-rc1 * sdk built through Tir * Updated the setup, fixed DCM-3701
docusign · May 15, 2020 · 2c41f04 · 2c41f04
1 parent a643c42
commit 2c41f04
Show file tree

Hide file tree

Showing 437 changed files with 102,648 additions and 85,480 deletions.
diff --git a/.swagger-codegen/VERSION b/.swagger-codegen/VERSION
@@ -0,0 +1 @@
+2.4.13-SNAPSHOT
diff --git a/docusign_esign/apis/__init__.py b/docusign_esign/apis/__init__.py
@@ -1,5 +1,7 @@
 from __future__ import absolute_import
 
+# flake8: noqa
+
 # import apis into api package
 from .accounts_api import AccountsApi
 from .authentication_api import AuthenticationApi

diff --git a/docusign_esign/apis/accounts_api.py b/docusign_esign/apis/accounts_api.py
@@ -3,7 +3,7 @@
 """
     DocuSign REST API
 
-    The DocuSign REST API provides you with a powerful, convenient, and simple Web services API for interacting with DocuSign.
+    The DocuSign REST API provides you with a powerful, convenient, and simple Web services API for interacting with DocuSign.  # noqa: E501
 
     OpenAPI spec version: v2.1
     Contact: devcenter@docusign.com

diff --git a/docusign_esign/apis/authentication_api.py b/docusign_esign/apis/authentication_api.py
@@ -3,7 +3,7 @@
 """
     DocuSign REST API
 
-    The DocuSign REST API provides you with a powerful, convenient, and simple Web services API for interacting with DocuSign.
+    The DocuSign REST API provides you with a powerful, convenient, and simple Web services API for interacting with DocuSign.  # noqa: E501
 
     OpenAPI spec version: v2.1
     Contact: devcenter@docusign.com

diff --git a/docusign_esign/apis/billing_api.py b/docusign_esign/apis/billing_api.py
@@ -3,7 +3,7 @@
 """
     DocuSign REST API
 
-    The DocuSign REST API provides you with a powerful, convenient, and simple Web services API for interacting with DocuSign.
+    The DocuSign REST API provides you with a powerful, convenient, and simple Web services API for interacting with DocuSign.  # noqa: E501
 
     OpenAPI spec version: v2.1
     Contact: devcenter@docusign.com
@@ -244,6 +244,107 @@ def get_credit_card_info_with_http_info(self, account_id, **kwargs):
                                         _request_timeout=params.get('_request_timeout'),
                                         collection_formats=collection_formats)
 
+    def get_downgrade_request_billing_info(self, account_id, **kwargs):
+        """
+        Returns downgrade plan information for the specified account.
+        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_downgrade_request_billing_info(account_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)
+        :return: DowngradRequestBillingInfoResponse
+                 If the method is called asynchronously,
+                 returns the request thread.
+        """
+        kwargs['_return_http_data_only'] = True
+        if kwargs.get('callback'):
+            return self.get_downgrade_request_billing_info_with_http_info(account_id, **kwargs)
+        else:
+            (data) = self.get_downgrade_request_billing_info_with_http_info(account_id, **kwargs)
+            return data
+
+    def get_downgrade_request_billing_info_with_http_info(self, account_id, **kwargs):
+        """
+        Returns downgrade plan information for the specified account.
+        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_downgrade_request_billing_info_with_http_info(account_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)
+        :return: DowngradRequestBillingInfoResponse
+                 If the method is called asynchronously,
+                 returns the request thread.
+        """
+
+        all_params = ['account_id']
+        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_downgrade_request_billing_info" % 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_downgrade_request_billing_info`")
+
+
+        collection_formats = {}
+
+        resource_path = '/v2.1/accounts/{accountId}/billing_plan/downgrade'.replace('{format}', 'json')
+        path_params = {}
+        if 'account_id' in params:
+            path_params['accountId'] = params['account_id']
+
+        query_params = {}
+
+        header_params = {}
+
+        form_params = []
+        local_var_files = {}
+
+        body_params = None
+        # HTTP header `Accept`
+        header_params['Accept'] = self.api_client.\
+            select_header_accept(['application/json'])
+
+        # 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='DowngradRequestBillingInfoResponse',
+                                        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)
+
     def get_invoice(self, account_id, invoice_id, **kwargs):
         """
         Retrieves a billing invoice.

diff --git a/docusign_esign/apis/bulk_envelopes_api.py b/docusign_esign/apis/bulk_envelopes_api.py
@@ -3,7 +3,7 @@
 """
     DocuSign REST API
 
-    The DocuSign REST API provides you with a powerful, convenient, and simple Web services API for interacting with DocuSign.
+    The DocuSign REST API provides you with a powerful, convenient, and simple Web services API for interacting with DocuSign.  # noqa: E501
 
     OpenAPI spec version: v2.1
     Contact: devcenter@docusign.com
@@ -1292,7 +1292,7 @@ def update_recipients(self, account_id, envelope_id, recipient_id, bulk_recipien
         :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 envelope's GUID.   Example: `93be49ab-afa0-4adf-933c-f752070d71ec` (required)
+        :param str envelope_id: The envelope's GUID.   Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec` (required)
         :param str recipient_id: A local reference that senders use to map recipients to other objects, such as specific document tabs. Within an envelope, each `recipientId` must be unique, but there is no uniqueness requirement across envelopes. For example, many envelopes assign the first recipient a `recipientId` of `1`. (required)
         :param str bulk_recipients_request:  (required)
         :return: BulkRecipientsSummaryResponse
@@ -1321,7 +1321,7 @@ def update_recipients_with_http_info(self, account_id, envelope_id, recipient_id
         :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 envelope's GUID.   Example: `93be49ab-afa0-4adf-933c-f752070d71ec` (required)
+        :param str envelope_id: The envelope's GUID.   Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec` (required)
         :param str recipient_id: A local reference that senders use to map recipients to other objects, such as specific document tabs. Within an envelope, each `recipientId` must be unique, but there is no uniqueness requirement across envelopes. For example, many envelopes assign the first recipient a `recipientId` of `1`. (required)
         :param str bulk_recipients_request:  (required)
         :return: BulkRecipientsSummaryResponse

diff --git a/docusign_esign/apis/cloud_storage_api.py b/docusign_esign/apis/cloud_storage_api.py
@@ -3,7 +3,7 @@
 """
     DocuSign REST API
 
-    The DocuSign REST API provides you with a powerful, convenient, and simple Web services API for interacting with DocuSign.
+    The DocuSign REST API provides you with a powerful, convenient, and simple Web services API for interacting with DocuSign.  # noqa: E501
 
     OpenAPI spec version: v2.1
     Contact: devcenter@docusign.com

diff --git a/docusign_esign/apis/connect_api.py b/docusign_esign/apis/connect_api.py
@@ -3,7 +3,7 @@
 """
     DocuSign REST API
 
-    The DocuSign REST API provides you with a powerful, convenient, and simple Web services API for interacting with DocuSign.
+    The DocuSign REST API provides you with a powerful, convenient, and simple Web services API for interacting with DocuSign.  # noqa: E501
 
     OpenAPI spec version: v2.1
     Contact: devcenter@docusign.com

diff --git a/docusign_esign/apis/custom_tabs_api.py b/docusign_esign/apis/custom_tabs_api.py
@@ -3,7 +3,7 @@
 """
     DocuSign REST API
 
-    The DocuSign REST API provides you with a powerful, convenient, and simple Web services API for interacting with DocuSign.
+    The DocuSign REST API provides you with a powerful, convenient, and simple Web services API for interacting with DocuSign.  # noqa: E501
 
     OpenAPI spec version: v2.1
     Contact: devcenter@docusign.com

diff --git a/docusign_esign/apis/data_feed_api.py b/docusign_esign/apis/data_feed_api.py
@@ -3,7 +3,7 @@
 """
     DocuSign REST API
 
-    The DocuSign REST API provides you with a powerful, convenient, and simple Web services API for interacting with DocuSign.
+    The DocuSign REST API provides you with a powerful, convenient, and simple Web services API for interacting with DocuSign.  # noqa: E501
 
     OpenAPI spec version: v2.1
     Contact: devcenter@docusign.com

diff --git a/docusign_esign/apis/diagnostics_api.py b/docusign_esign/apis/diagnostics_api.py
@@ -3,7 +3,7 @@
 """
     DocuSign REST API
 
-    The DocuSign REST API provides you with a powerful, convenient, and simple Web services API for interacting with DocuSign.
+    The DocuSign REST API provides you with a powerful, convenient, and simple Web services API for interacting with DocuSign.  # noqa: E501
 
     OpenAPI spec version: v2.1
     Contact: devcenter@docusign.com

diff --git a/docusign_esign/apis/email_archive_api.py b/docusign_esign/apis/email_archive_api.py
@@ -3,7 +3,7 @@
 """
     DocuSign REST API
 
-    The DocuSign REST API provides you with a powerful, convenient, and simple Web services API for interacting with DocuSign.
+    The DocuSign REST API provides you with a powerful, convenient, and simple Web services API for interacting with DocuSign.  # noqa: E501
 
     OpenAPI spec version: v2.1
     Contact: devcenter@docusign.com

diff --git a/docusign_esign/apis/envelopes_api.py b/docusign_esign/apis/envelopes_api.py
@@ -3,7 +3,7 @@
 """
     DocuSign REST API
 
-    The DocuSign REST API provides you with a powerful, convenient, and simple Web services API for interacting with DocuSign.
+    The DocuSign REST API provides you with a powerful, convenient, and simple Web services API for interacting with DocuSign.  # noqa: E501
 
     OpenAPI spec version: v2.1
     Contact: devcenter@docusign.com
@@ -56,6 +56,7 @@ def apply_template(self, account_id, envelope_id, **kwargs):
             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 preserve_template_recipient:
         :param DocumentTemplateList document_template_list:
         :return: DocumentTemplateList
                  If the method is called asynchronously,
@@ -84,13 +85,14 @@ def apply_template_with_http_info(self, account_id, envelope_id, **kwargs):
             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 preserve_template_recipient:
         :param DocumentTemplateList document_template_list:
         :return: DocumentTemplateList
                  If the method is called asynchronously,
                  returns the request thread.
         """
 
-        all_params = ['account_id', 'envelope_id', 'document_template_list']
+        all_params = ['account_id', 'envelope_id', 'preserve_template_recipient', 'document_template_list']
         all_params.append('callback')
         all_params.append('_return_http_data_only')
         all_params.append('_preload_content')
@@ -123,6 +125,8 @@ def apply_template_with_http_info(self, account_id, envelope_id, **kwargs):
             path_params['envelopeId'] = params['envelope_id']
 
         query_params = {}
+        if 'preserve_template_recipient' in params:
+            query_params['preserve_template_recipient'] = params['preserve_template_recipient']
 
         header_params = {}
 
@@ -171,6 +175,7 @@ def apply_template_to_document(self, account_id, document_id, envelope_id, **kwa
         :param str account_id: The external account number (int) or account ID Guid. (required)
         :param str document_id: The ID of the document being accessed. (required)
         :param str envelope_id: The envelopeId Guid of the envelope being accessed. (required)
+        :param str preserve_template_recipient:
         :param DocumentTemplateList document_template_list:
         :return: DocumentTemplateList
                  If the method is called asynchronously,
@@ -200,13 +205,14 @@ def apply_template_to_document_with_http_info(self, account_id, document_id, env
         :param str account_id: The external account number (int) or account ID Guid. (required)
         :param str document_id: The ID of the document being accessed. (required)
         :param str envelope_id: The envelopeId Guid of the envelope being accessed. (required)
+        :param str preserve_template_recipient:
         :param DocumentTemplateList document_template_list:
         :return: DocumentTemplateList
                  If the method is called asynchronously,
                  returns the request thread.
         """
 
-        all_params = ['account_id', 'document_id', 'envelope_id', 'document_template_list']
+        all_params = ['account_id', 'document_id', 'envelope_id', 'preserve_template_recipient', 'document_template_list']
         all_params.append('callback')
         all_params.append('_return_http_data_only')
         all_params.append('_preload_content')
@@ -244,6 +250,8 @@ def apply_template_to_document_with_http_info(self, account_id, document_id, env
             path_params['envelopeId'] = params['envelope_id']
 
         query_params = {}
+        if 'preserve_template_recipient' in params:
+            query_params['preserve_template_recipient'] = params['preserve_template_recipient']
 
         header_params = {}
 

diff --git a/docusign_esign/apis/folders_api.py b/docusign_esign/apis/folders_api.py
@@ -3,7 +3,7 @@
 """
     DocuSign REST API
 
-    The DocuSign REST API provides you with a powerful, convenient, and simple Web services API for interacting with DocuSign.
+    The DocuSign REST API provides you with a powerful, convenient, and simple Web services API for interacting with DocuSign.  # noqa: E501
 
     OpenAPI spec version: v2.1
     Contact: devcenter@docusign.com

diff --git a/docusign_esign/apis/groups_api.py b/docusign_esign/apis/groups_api.py
@@ -3,7 +3,7 @@
 """
     DocuSign REST API
 
-    The DocuSign REST API provides you with a powerful, convenient, and simple Web services API for interacting with DocuSign.
+    The DocuSign REST API provides you with a powerful, convenient, and simple Web services API for interacting with DocuSign.  # noqa: E501
 
     OpenAPI spec version: v2.1
     Contact: devcenter@docusign.com

diff --git a/docusign_esign/apis/notary_api.py b/docusign_esign/apis/notary_api.py
@@ -3,7 +3,7 @@
 """
     DocuSign REST API
 
-    The DocuSign REST API provides you with a powerful, convenient, and simple Web services API for interacting with DocuSign.
+    The DocuSign REST API provides you with a powerful, convenient, and simple Web services API for interacting with DocuSign.  # noqa: E501
 
     OpenAPI spec version: v2.1
     Contact: devcenter@docusign.com

diff --git a/docusign_esign/apis/organizations_api.py b/docusign_esign/apis/organizations_api.py
@@ -3,7 +3,7 @@
 """
     DocuSign REST API
 
-    The DocuSign REST API provides you with a powerful, convenient, and simple Web services API for interacting with DocuSign.
+    The DocuSign REST API provides you with a powerful, convenient, and simple Web services API for interacting with DocuSign.  # noqa: E501
 
     OpenAPI spec version: v2.1
     Contact: devcenter@docusign.com

diff --git a/docusign_esign/apis/power_forms_api.py b/docusign_esign/apis/power_forms_api.py
@@ -3,7 +3,7 @@
 """
     DocuSign REST API
 
-    The DocuSign REST API provides you with a powerful, convenient, and simple Web services API for interacting with DocuSign.
+    The DocuSign REST API provides you with a powerful, convenient, and simple Web services API for interacting with DocuSign.  # noqa: E501
 
     OpenAPI spec version: v2.1
     Contact: devcenter@docusign.com

diff --git a/docusign_esign/apis/signing_groups_api.py b/docusign_esign/apis/signing_groups_api.py
@@ -3,7 +3,7 @@
 """
     DocuSign REST API
 
-    The DocuSign REST API provides you with a powerful, convenient, and simple Web services API for interacting with DocuSign.
+    The DocuSign REST API provides you with a powerful, convenient, and simple Web services API for interacting with DocuSign.  # noqa: E501
 
     OpenAPI spec version: v2.1
     Contact: devcenter@docusign.com

diff --git a/docusign_esign/apis/templates_api.py b/docusign_esign/apis/templates_api.py
@@ -3,7 +3,7 @@
 """
     DocuSign REST API
 
-    The DocuSign REST API provides you with a powerful, convenient, and simple Web services API for interacting with DocuSign.
+    The DocuSign REST API provides you with a powerful, convenient, and simple Web services API for interacting with DocuSign.  # noqa: E501
 
     OpenAPI spec version: v2.1
     Contact: devcenter@docusign.com

diff --git a/docusign_esign/apis/users_api.py b/docusign_esign/apis/users_api.py
@@ -3,7 +3,7 @@
 """
     DocuSign REST API
 
-    The DocuSign REST API provides you with a powerful, convenient, and simple Web services API for interacting with DocuSign.
+    The DocuSign REST API provides you with a powerful, convenient, and simple Web services API for interacting with DocuSign.  # noqa: E501
 
     OpenAPI spec version: v2.1
     Contact: devcenter@docusign.com

diff --git a/docusign_esign/apis/workspaces_api.py b/docusign_esign/apis/workspaces_api.py
@@ -3,7 +3,7 @@
 """
     DocuSign REST API
 
-    The DocuSign REST API provides you with a powerful, convenient, and simple Web services API for interacting with DocuSign.
+    The DocuSign REST API provides you with a powerful, convenient, and simple Web services API for interacting with DocuSign.  # noqa: E501
 
     OpenAPI spec version: v2.1
     Contact: devcenter@docusign.com