docusign_esign.apis.email_archive_api

  1# coding: utf-8
  2
  3"""
  4    DocuSign REST API
  5
  6    The DocuSign REST API provides you with a powerful, convenient, and simple Web services API for interacting with DocuSign.  # noqa: E501
  7
  8    OpenAPI spec version: v2.1
  9    Contact: devcenter@docusign.com
 10    Generated by: https://github.com/swagger-api/swagger-codegen.git
 11"""
 12
 13
 14from __future__ import absolute_import
 15
 16import sys
 17import os
 18import re
 19
 20# python 2 and python 3 compatibility library
 21from six import iteritems
 22
 23from ..client.configuration import Configuration
 24from ..client.api_client import ApiClient
 25
 26
 27class EmailArchiveApi(object):
 28    """
 29    NOTE: This class is auto generated by the swagger code generator program.
 30    Do not edit the class manually.
 31    Ref: https://github.com/swagger-api/swagger-codegen
 32    """
 33
 34    def __init__(self, api_client=None):
 35        config = Configuration()
 36        if api_client:
 37            self.api_client = api_client
 38        else:
 39            if not config.api_client:
 40                config.api_client = ApiClient()
 41            self.api_client = config.api_client
 42
 43    def create_bcc_email_archive(self, account_id, **kwargs):
 44        """
 45        Creates a blind carbon copy email archive entry
 46        This method creates a BCC email archive configuration for an account (adds a BCC email address to the account for archiving the emails that DocuSign generates).  The only property that you must set in the request body is the BCC email address that you want to use.  **Note:** An account can have up to five active and pending email archive addresses combined, but you must use this method to add them to the account one at a time. Each email address is considered a separate BCC email archive configuration. 
 47        This method makes a synchronous HTTP request by default. To make an
 48        asynchronous HTTP request, please define a `callback` function
 49        to be invoked when receiving the response.
 50        >>> def callback_function(response):
 51        >>>     pprint(response)
 52        >>>
 53        >>> thread = api.create_bcc_email_archive(account_id, callback=callback_function)
 54
 55        :param callback function: The callback function
 56            for asynchronous request. (optional)
 57        :param str account_id: The external account number (int) or account ID Guid. (required)
 58        :param BccEmailArchive bcc_email_archive:
 59        :return: BccEmailArchive
 60                 If the method is called asynchronously,
 61                 returns the request thread.
 62        """
 63        kwargs['_return_http_data_only'] = True
 64        if kwargs.get('callback'):
 65            return self.create_bcc_email_archive_with_http_info(account_id, **kwargs)
 66        else:
 67            (data) = self.create_bcc_email_archive_with_http_info(account_id, **kwargs)
 68            return data
 69
 70    def create_bcc_email_archive_with_http_info(self, account_id, **kwargs):
 71        """
 72        Creates a blind carbon copy email archive entry
 73        This method creates a BCC email archive configuration for an account (adds a BCC email address to the account for archiving the emails that DocuSign generates).  The only property that you must set in the request body is the BCC email address that you want to use.  **Note:** An account can have up to five active and pending email archive addresses combined, but you must use this method to add them to the account one at a time. Each email address is considered a separate BCC email archive configuration. 
 74        This method makes a synchronous HTTP request by default. To make an
 75        asynchronous HTTP request, please define a `callback` function
 76        to be invoked when receiving the response.
 77        >>> def callback_function(response):
 78        >>>     pprint(response)
 79        >>>
 80        >>> thread = api.create_bcc_email_archive_with_http_info(account_id, callback=callback_function)
 81
 82        :param callback function: The callback function
 83            for asynchronous request. (optional)
 84        :param str account_id: The external account number (int) or account ID Guid. (required)
 85        :param BccEmailArchive bcc_email_archive:
 86        :return: BccEmailArchive
 87                 If the method is called asynchronously,
 88                 returns the request thread.
 89        """
 90
 91        all_params = ['account_id', 'bcc_email_archive']
 92        all_params.append('callback')
 93        all_params.append('_return_http_data_only')
 94        all_params.append('_preload_content')
 95        all_params.append('_request_timeout')
 96
 97        params = locals()
 98        for key, val in iteritems(params['kwargs']):
 99            if key not in all_params:
100                raise TypeError(
101                    "Got an unexpected keyword argument '%s'"
102                    " to method create_bcc_email_archive" % key
103                )
104            params[key] = val
105        del params['kwargs']
106        # verify the required parameter 'account_id' is set
107        if ('account_id' not in params) or (params['account_id'] is None):
108            raise ValueError("Missing the required parameter `account_id` when calling `create_bcc_email_archive`")
109
110
111        collection_formats = {}
112
113        resource_path = '/v2.1/accounts/{accountId}/settings/bcc_email_archives'.replace('{format}', 'json')
114        path_params = {}
115        if 'account_id' in params:
116            path_params['accountId'] = params['account_id']
117
118        query_params = {}
119
120        header_params = {}
121
122        form_params = []
123        local_var_files = {}
124
125        body_params = None
126        if 'bcc_email_archive' in params:
127            body_params = params['bcc_email_archive']
128        # HTTP header `Accept`
129        header_params['Accept'] = self.api_client.\
130            select_header_accept(['application/json'])
131
132        # Authentication setting
133        auth_settings = []
134
135        return self.api_client.call_api(resource_path, 'POST',
136                                        path_params,
137                                        query_params,
138                                        header_params,
139                                        body=body_params,
140                                        post_params=form_params,
141                                        files=local_var_files,
142                                        response_type='BccEmailArchive',
143                                        auth_settings=auth_settings,
144                                        callback=params.get('callback'),
145                                        _return_http_data_only=params.get('_return_http_data_only'),
146                                        _preload_content=params.get('_preload_content', True),
147                                        _request_timeout=params.get('_request_timeout'),
148                                        collection_formats=collection_formats)
149
150    def delete_bcc_email_archive(self, account_id, bcc_email_archive_id, **kwargs):
151        """
152        Delete a blind carbon copy email archive for an account.
153        This method deletes a BCC email archive configuration from an account.  When you use this method, the status of the BCC email archive configuration switches to `closed` and the BCC email address is no longer used to archive DocuSign-generated email messages. 
154        This method makes a synchronous HTTP request by default. To make an
155        asynchronous HTTP request, please define a `callback` function
156        to be invoked when receiving the response.
157        >>> def callback_function(response):
158        >>>     pprint(response)
159        >>>
160        >>> thread = api.delete_bcc_email_archive(account_id, bcc_email_archive_id, callback=callback_function)
161
162        :param callback function: The callback function
163            for asynchronous request. (optional)
164        :param str account_id: The external account number (int) or account ID Guid. (required)
165        :param str bcc_email_archive_id: (required)
166        :return: None
167                 If the method is called asynchronously,
168                 returns the request thread.
169        """
170        kwargs['_return_http_data_only'] = True
171        if kwargs.get('callback'):
172            return self.delete_bcc_email_archive_with_http_info(account_id, bcc_email_archive_id, **kwargs)
173        else:
174            (data) = self.delete_bcc_email_archive_with_http_info(account_id, bcc_email_archive_id, **kwargs)
175            return data
176
177    def delete_bcc_email_archive_with_http_info(self, account_id, bcc_email_archive_id, **kwargs):
178        """
179        Delete a blind carbon copy email archive for an account.
180        This method deletes a BCC email archive configuration from an account.  When you use this method, the status of the BCC email archive configuration switches to `closed` and the BCC email address is no longer used to archive DocuSign-generated email messages. 
181        This method makes a synchronous HTTP request by default. To make an
182        asynchronous HTTP request, please define a `callback` function
183        to be invoked when receiving the response.
184        >>> def callback_function(response):
185        >>>     pprint(response)
186        >>>
187        >>> thread = api.delete_bcc_email_archive_with_http_info(account_id, bcc_email_archive_id, callback=callback_function)
188
189        :param callback function: The callback function
190            for asynchronous request. (optional)
191        :param str account_id: The external account number (int) or account ID Guid. (required)
192        :param str bcc_email_archive_id: (required)
193        :return: None
194                 If the method is called asynchronously,
195                 returns the request thread.
196        """
197
198        all_params = ['account_id', 'bcc_email_archive_id']
199        all_params.append('callback')
200        all_params.append('_return_http_data_only')
201        all_params.append('_preload_content')
202        all_params.append('_request_timeout')
203
204        params = locals()
205        for key, val in iteritems(params['kwargs']):
206            if key not in all_params:
207                raise TypeError(
208                    "Got an unexpected keyword argument '%s'"
209                    " to method delete_bcc_email_archive" % key
210                )
211            params[key] = val
212        del params['kwargs']
213        # verify the required parameter 'account_id' is set
214        if ('account_id' not in params) or (params['account_id'] is None):
215            raise ValueError("Missing the required parameter `account_id` when calling `delete_bcc_email_archive`")
216        # verify the required parameter 'bcc_email_archive_id' is set
217        if ('bcc_email_archive_id' not in params) or (params['bcc_email_archive_id'] is None):
218            raise ValueError("Missing the required parameter `bcc_email_archive_id` when calling `delete_bcc_email_archive`")
219
220
221        collection_formats = {}
222
223        resource_path = '/v2.1/accounts/{accountId}/settings/bcc_email_archives/{bccEmailArchiveId}'.replace('{format}', 'json')
224        path_params = {}
225        if 'account_id' in params:
226            path_params['accountId'] = params['account_id']
227        if 'bcc_email_archive_id' in params:
228            path_params['bccEmailArchiveId'] = params['bcc_email_archive_id']
229
230        query_params = {}
231
232        header_params = {}
233
234        form_params = []
235        local_var_files = {}
236
237        body_params = None
238        # HTTP header `Accept`
239        header_params['Accept'] = self.api_client.\
240            select_header_accept(['application/json'])
241
242        # Authentication setting
243        auth_settings = []
244
245        return self.api_client.call_api(resource_path, 'DELETE',
246                                        path_params,
247                                        query_params,
248                                        header_params,
249                                        body=body_params,
250                                        post_params=form_params,
251                                        files=local_var_files,
252                                        response_type=None,
253                                        auth_settings=auth_settings,
254                                        callback=params.get('callback'),
255                                        _return_http_data_only=params.get('_return_http_data_only'),
256                                        _preload_content=params.get('_preload_content', True),
257                                        _request_timeout=params.get('_request_timeout'),
258                                        collection_formats=collection_formats)
259
260    def get_bcc_email_archive_history_list(self, account_id, bcc_email_archive_id, **kwargs):
261        """
262        Get the blind carbon copy email archive history entries for the specified archive
263        This method returns a specific BCC email archive configuration for an account, as well as the history of changes to the email address.
264        This method makes a synchronous HTTP request by default. To make an
265        asynchronous HTTP request, please define a `callback` function
266        to be invoked when receiving the response.
267        >>> def callback_function(response):
268        >>>     pprint(response)
269        >>>
270        >>> thread = api.get_bcc_email_archive_history_list(account_id, bcc_email_archive_id, callback=callback_function)
271
272        :param callback function: The callback function
273            for asynchronous request. (optional)
274        :param str account_id: The external account number (int) or account ID Guid. (required)
275        :param str bcc_email_archive_id: (required)
276        :param str count:
277        :param str start_position:
278        :return: BccEmailArchiveHistoryList
279                 If the method is called asynchronously,
280                 returns the request thread.
281        """
282        kwargs['_return_http_data_only'] = True
283        if kwargs.get('callback'):
284            return self.get_bcc_email_archive_history_list_with_http_info(account_id, bcc_email_archive_id, **kwargs)
285        else:
286            (data) = self.get_bcc_email_archive_history_list_with_http_info(account_id, bcc_email_archive_id, **kwargs)
287            return data
288
289    def get_bcc_email_archive_history_list_with_http_info(self, account_id, bcc_email_archive_id, **kwargs):
290        """
291        Get the blind carbon copy email archive history entries for the specified archive
292        This method returns a specific BCC email archive configuration for an account, as well as the history of changes to the email address.
293        This method makes a synchronous HTTP request by default. To make an
294        asynchronous HTTP request, please define a `callback` function
295        to be invoked when receiving the response.
296        >>> def callback_function(response):
297        >>>     pprint(response)
298        >>>
299        >>> thread = api.get_bcc_email_archive_history_list_with_http_info(account_id, bcc_email_archive_id, callback=callback_function)
300
301        :param callback function: The callback function
302            for asynchronous request. (optional)
303        :param str account_id: The external account number (int) or account ID Guid. (required)
304        :param str bcc_email_archive_id: (required)
305        :param str count:
306        :param str start_position:
307        :return: BccEmailArchiveHistoryList
308                 If the method is called asynchronously,
309                 returns the request thread.
310        """
311
312        all_params = ['account_id', 'bcc_email_archive_id', 'count', 'start_position']
313        all_params.append('callback')
314        all_params.append('_return_http_data_only')
315        all_params.append('_preload_content')
316        all_params.append('_request_timeout')
317
318        params = locals()
319        for key, val in iteritems(params['kwargs']):
320            if key not in all_params:
321                raise TypeError(
322                    "Got an unexpected keyword argument '%s'"
323                    " to method get_bcc_email_archive_history_list" % key
324                )
325            params[key] = val
326        del params['kwargs']
327        # verify the required parameter 'account_id' is set
328        if ('account_id' not in params) or (params['account_id'] is None):
329            raise ValueError("Missing the required parameter `account_id` when calling `get_bcc_email_archive_history_list`")
330        # verify the required parameter 'bcc_email_archive_id' is set
331        if ('bcc_email_archive_id' not in params) or (params['bcc_email_archive_id'] is None):
332            raise ValueError("Missing the required parameter `bcc_email_archive_id` when calling `get_bcc_email_archive_history_list`")
333
334
335        collection_formats = {}
336
337        resource_path = '/v2.1/accounts/{accountId}/settings/bcc_email_archives/{bccEmailArchiveId}'.replace('{format}', 'json')
338        path_params = {}
339        if 'account_id' in params:
340            path_params['accountId'] = params['account_id']
341        if 'bcc_email_archive_id' in params:
342            path_params['bccEmailArchiveId'] = params['bcc_email_archive_id']
343
344        query_params = {}
345        if 'count' in params:
346            query_params['count'] = params['count']
347        if 'start_position' in params:
348            query_params['start_position'] = params['start_position']
349
350        header_params = {}
351
352        form_params = []
353        local_var_files = {}
354
355        body_params = None
356        # HTTP header `Accept`
357        header_params['Accept'] = self.api_client.\
358            select_header_accept(['application/json'])
359
360        # Authentication setting
361        auth_settings = []
362
363        return self.api_client.call_api(resource_path, 'GET',
364                                        path_params,
365                                        query_params,
366                                        header_params,
367                                        body=body_params,
368                                        post_params=form_params,
369                                        files=local_var_files,
370                                        response_type='BccEmailArchiveHistoryList',
371                                        auth_settings=auth_settings,
372                                        callback=params.get('callback'),
373                                        _return_http_data_only=params.get('_return_http_data_only'),
374                                        _preload_content=params.get('_preload_content', True),
375                                        _request_timeout=params.get('_request_timeout'),
376                                        collection_formats=collection_formats)
377
378    def get_bcc_email_archive_list(self, account_id, **kwargs):
379        """
380        Get the blind carbon copy email archive entries owned by the specified account
381        This method retrieves all of the BCC email archive configurations associated with an account.
382        This method makes a synchronous HTTP request by default. To make an
383        asynchronous HTTP request, please define a `callback` function
384        to be invoked when receiving the response.
385        >>> def callback_function(response):
386        >>>     pprint(response)
387        >>>
388        >>> thread = api.get_bcc_email_archive_list(account_id, callback=callback_function)
389
390        :param callback function: The callback function
391            for asynchronous request. (optional)
392        :param str account_id: The external account number (int) or account ID Guid. (required)
393        :param str count:
394        :param str start_position:
395        :return: BccEmailArchiveList
396                 If the method is called asynchronously,
397                 returns the request thread.
398        """
399        kwargs['_return_http_data_only'] = True
400        if kwargs.get('callback'):
401            return self.get_bcc_email_archive_list_with_http_info(account_id, **kwargs)
402        else:
403            (data) = self.get_bcc_email_archive_list_with_http_info(account_id, **kwargs)
404            return data
405
406    def get_bcc_email_archive_list_with_http_info(self, account_id, **kwargs):
407        """
408        Get the blind carbon copy email archive entries owned by the specified account
409        This method retrieves all of the BCC email archive configurations associated with an account.
410        This method makes a synchronous HTTP request by default. To make an
411        asynchronous HTTP request, please define a `callback` function
412        to be invoked when receiving the response.
413        >>> def callback_function(response):
414        >>>     pprint(response)
415        >>>
416        >>> thread = api.get_bcc_email_archive_list_with_http_info(account_id, callback=callback_function)
417
418        :param callback function: The callback function
419            for asynchronous request. (optional)
420        :param str account_id: The external account number (int) or account ID Guid. (required)
421        :param str count:
422        :param str start_position:
423        :return: BccEmailArchiveList
424                 If the method is called asynchronously,
425                 returns the request thread.
426        """
427
428        all_params = ['account_id', 'count', 'start_position']
429        all_params.append('callback')
430        all_params.append('_return_http_data_only')
431        all_params.append('_preload_content')
432        all_params.append('_request_timeout')
433
434        params = locals()
435        for key, val in iteritems(params['kwargs']):
436            if key not in all_params:
437                raise TypeError(
438                    "Got an unexpected keyword argument '%s'"
439                    " to method get_bcc_email_archive_list" % key
440                )
441            params[key] = val
442        del params['kwargs']
443        # verify the required parameter 'account_id' is set
444        if ('account_id' not in params) or (params['account_id'] is None):
445            raise ValueError("Missing the required parameter `account_id` when calling `get_bcc_email_archive_list`")
446
447
448        collection_formats = {}
449
450        resource_path = '/v2.1/accounts/{accountId}/settings/bcc_email_archives'.replace('{format}', 'json')
451        path_params = {}
452        if 'account_id' in params:
453            path_params['accountId'] = params['account_id']
454
455        query_params = {}
456        if 'count' in params:
457            query_params['count'] = params['count']
458        if 'start_position' in params:
459            query_params['start_position'] = params['start_position']
460
461        header_params = {}
462
463        form_params = []
464        local_var_files = {}
465
466        body_params = None
467        # HTTP header `Accept`
468        header_params['Accept'] = self.api_client.\
469            select_header_accept(['application/json'])
470
471        # Authentication setting
472        auth_settings = []
473
474        return self.api_client.call_api(resource_path, 'GET',
475                                        path_params,
476                                        query_params,
477                                        header_params,
478                                        body=body_params,
479                                        post_params=form_params,
480                                        files=local_var_files,
481                                        response_type='BccEmailArchiveList',
482                                        auth_settings=auth_settings,
483                                        callback=params.get('callback'),
484                                        _return_http_data_only=params.get('_return_http_data_only'),
485                                        _preload_content=params.get('_preload_content', True),
486                                        _request_timeout=params.get('_request_timeout'),
487                                        collection_formats=collection_formats)