docusign_esign.apis.trust_service_providers_api

DocuSign REST API

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 Generated by: https://github.com/swagger-api/swagger-codegen.git

  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 TrustServiceProvidersApi(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 get_seal_providers(self, account_id, **kwargs):
 44        """
 45        Returns Account available seals for specified account.
 46        
 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.get_seal_providers(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        :return: AccountSeals
 59                 If the method is called asynchronously,
 60                 returns the request thread.
 61        """
 62        kwargs['_return_http_data_only'] = True
 63        if kwargs.get('callback'):
 64            return self.get_seal_providers_with_http_info(account_id, **kwargs)
 65        else:
 66            (data) = self.get_seal_providers_with_http_info(account_id, **kwargs)
 67            return data
 68
 69    def get_seal_providers_with_http_info(self, account_id, **kwargs):
 70        """
 71        Returns Account available seals for specified account.
 72        
 73        This method makes a synchronous HTTP request by default. To make an
 74        asynchronous HTTP request, please define a `callback` function
 75        to be invoked when receiving the response.
 76        >>> def callback_function(response):
 77        >>>     pprint(response)
 78        >>>
 79        >>> thread = api.get_seal_providers_with_http_info(account_id, callback=callback_function)
 80
 81        :param callback function: The callback function
 82            for asynchronous request. (optional)
 83        :param str account_id: The external account number (int) or account ID Guid. (required)
 84        :return: AccountSeals
 85                 If the method is called asynchronously,
 86                 returns the request thread.
 87        """
 88
 89        all_params = ['account_id']
 90        all_params.append('callback')
 91        all_params.append('_return_http_data_only')
 92        all_params.append('_preload_content')
 93        all_params.append('_request_timeout')
 94
 95        params = locals()
 96        for key, val in iteritems(params['kwargs']):
 97            if key not in all_params:
 98                raise TypeError(
 99                    "Got an unexpected keyword argument '%s'"
100                    " to method get_seal_providers" % key
101                )
102            params[key] = val
103        del params['kwargs']
104        # verify the required parameter 'account_id' is set
105        if ('account_id' not in params) or (params['account_id'] is None):
106            raise ValueError("Missing the required parameter `account_id` when calling `get_seal_providers`")
107
108
109        collection_formats = {}
110
111        resource_path = '/v2.1/accounts/{accountId}/seals'.replace('{format}', 'json')
112        path_params = {}
113        if 'account_id' in params:
114            path_params['accountId'] = params['account_id']
115
116        query_params = {}
117
118        header_params = {}
119
120        form_params = []
121        local_var_files = {}
122
123        body_params = None
124        # HTTP header `Accept`
125        header_params['Accept'] = self.api_client.\
126            select_header_accept(['application/json'])
127
128        # Authentication setting
129        auth_settings = []
130
131        return self.api_client.call_api(resource_path, 'GET',
132                                        path_params,
133                                        query_params,
134                                        header_params,
135                                        body=body_params,
136                                        post_params=form_params,
137                                        files=local_var_files,
138                                        response_type='AccountSeals',
139                                        auth_settings=auth_settings,
140                                        callback=params.get('callback'),
141                                        _return_http_data_only=params.get('_return_http_data_only'),
142                                        _preload_content=params.get('_preload_content', True),
143                                        _request_timeout=params.get('_request_timeout'),
144                                        collection_formats=collection_formats)
class TrustServiceProvidersApi:
 28class TrustServiceProvidersApi(object):
 29    """
 30    NOTE: This class is auto generated by the swagger code generator program.
 31    Do not edit the class manually.
 32    Ref: https://github.com/swagger-api/swagger-codegen
 33    """
 34
 35    def __init__(self, api_client=None):
 36        config = Configuration()
 37        if api_client:
 38            self.api_client = api_client
 39        else:
 40            if not config.api_client:
 41                config.api_client = ApiClient()
 42            self.api_client = config.api_client
 43
 44    def get_seal_providers(self, account_id, **kwargs):
 45        """
 46        Returns Account available seals for specified account.
 47        
 48        This method makes a synchronous HTTP request by default. To make an
 49        asynchronous HTTP request, please define a `callback` function
 50        to be invoked when receiving the response.
 51        >>> def callback_function(response):
 52        >>>     pprint(response)
 53        >>>
 54        >>> thread = api.get_seal_providers(account_id, callback=callback_function)
 55
 56        :param callback function: The callback function
 57            for asynchronous request. (optional)
 58        :param str account_id: The external account number (int) or account ID Guid. (required)
 59        :return: AccountSeals
 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.get_seal_providers_with_http_info(account_id, **kwargs)
 66        else:
 67            (data) = self.get_seal_providers_with_http_info(account_id, **kwargs)
 68            return data
 69
 70    def get_seal_providers_with_http_info(self, account_id, **kwargs):
 71        """
 72        Returns Account available seals for specified account.
 73        
 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.get_seal_providers_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        :return: AccountSeals
 86                 If the method is called asynchronously,
 87                 returns the request thread.
 88        """
 89
 90        all_params = ['account_id']
 91        all_params.append('callback')
 92        all_params.append('_return_http_data_only')
 93        all_params.append('_preload_content')
 94        all_params.append('_request_timeout')
 95
 96        params = locals()
 97        for key, val in iteritems(params['kwargs']):
 98            if key not in all_params:
 99                raise TypeError(
100                    "Got an unexpected keyword argument '%s'"
101                    " to method get_seal_providers" % key
102                )
103            params[key] = val
104        del params['kwargs']
105        # verify the required parameter 'account_id' is set
106        if ('account_id' not in params) or (params['account_id'] is None):
107            raise ValueError("Missing the required parameter `account_id` when calling `get_seal_providers`")
108
109
110        collection_formats = {}
111
112        resource_path = '/v2.1/accounts/{accountId}/seals'.replace('{format}', 'json')
113        path_params = {}
114        if 'account_id' in params:
115            path_params['accountId'] = params['account_id']
116
117        query_params = {}
118
119        header_params = {}
120
121        form_params = []
122        local_var_files = {}
123
124        body_params = None
125        # HTTP header `Accept`
126        header_params['Accept'] = self.api_client.\
127            select_header_accept(['application/json'])
128
129        # Authentication setting
130        auth_settings = []
131
132        return self.api_client.call_api(resource_path, 'GET',
133                                        path_params,
134                                        query_params,
135                                        header_params,
136                                        body=body_params,
137                                        post_params=form_params,
138                                        files=local_var_files,
139                                        response_type='AccountSeals',
140                                        auth_settings=auth_settings,
141                                        callback=params.get('callback'),
142                                        _return_http_data_only=params.get('_return_http_data_only'),
143                                        _preload_content=params.get('_preload_content', True),
144                                        _request_timeout=params.get('_request_timeout'),
145                                        collection_formats=collection_formats)

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

TrustServiceProvidersApi(api_client=None)
35    def __init__(self, api_client=None):
36        config = Configuration()
37        if api_client:
38            self.api_client = api_client
39        else:
40            if not config.api_client:
41                config.api_client = ApiClient()
42            self.api_client = config.api_client
def get_seal_providers(self, account_id, **kwargs)
44    def get_seal_providers(self, account_id, **kwargs):
45        """
46        Returns Account available seals for specified account.
47        
48        This method makes a synchronous HTTP request by default. To make an
49        asynchronous HTTP request, please define a `callback` function
50        to be invoked when receiving the response.
51        >>> def callback_function(response):
52        >>>     pprint(response)
53        >>>
54        >>> thread = api.get_seal_providers(account_id, callback=callback_function)
55
56        :param callback function: The callback function
57            for asynchronous request. (optional)
58        :param str account_id: The external account number (int) or account ID Guid. (required)
59        :return: AccountSeals
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.get_seal_providers_with_http_info(account_id, **kwargs)
66        else:
67            (data) = self.get_seal_providers_with_http_info(account_id, **kwargs)
68            return data

Returns Account available seals for 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_seal_providers(account_id, callback=callback_function)
Parameters
  • callback function: The callback function for asynchronous request. (optional)
  • str account_id: The external account number (int) or account ID Guid. (required)
Returns

AccountSeals If the method is called asynchronously, returns the request thread.

def get_seal_providers_with_http_info(self, account_id, **kwargs)
 70    def get_seal_providers_with_http_info(self, account_id, **kwargs):
 71        """
 72        Returns Account available seals for specified account.
 73        
 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.get_seal_providers_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        :return: AccountSeals
 86                 If the method is called asynchronously,
 87                 returns the request thread.
 88        """
 89
 90        all_params = ['account_id']
 91        all_params.append('callback')
 92        all_params.append('_return_http_data_only')
 93        all_params.append('_preload_content')
 94        all_params.append('_request_timeout')
 95
 96        params = locals()
 97        for key, val in iteritems(params['kwargs']):
 98            if key not in all_params:
 99                raise TypeError(
100                    "Got an unexpected keyword argument '%s'"
101                    " to method get_seal_providers" % key
102                )
103            params[key] = val
104        del params['kwargs']
105        # verify the required parameter 'account_id' is set
106        if ('account_id' not in params) or (params['account_id'] is None):
107            raise ValueError("Missing the required parameter `account_id` when calling `get_seal_providers`")
108
109
110        collection_formats = {}
111
112        resource_path = '/v2.1/accounts/{accountId}/seals'.replace('{format}', 'json')
113        path_params = {}
114        if 'account_id' in params:
115            path_params['accountId'] = params['account_id']
116
117        query_params = {}
118
119        header_params = {}
120
121        form_params = []
122        local_var_files = {}
123
124        body_params = None
125        # HTTP header `Accept`
126        header_params['Accept'] = self.api_client.\
127            select_header_accept(['application/json'])
128
129        # Authentication setting
130        auth_settings = []
131
132        return self.api_client.call_api(resource_path, 'GET',
133                                        path_params,
134                                        query_params,
135                                        header_params,
136                                        body=body_params,
137                                        post_params=form_params,
138                                        files=local_var_files,
139                                        response_type='AccountSeals',
140                                        auth_settings=auth_settings,
141                                        callback=params.get('callback'),
142                                        _return_http_data_only=params.get('_return_http_data_only'),
143                                        _preload_content=params.get('_preload_content', True),
144                                        _request_timeout=params.get('_request_timeout'),
145                                        collection_formats=collection_formats)

Returns Account available seals for 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_seal_providers_with_http_info(account_id, callback=callback_function)
Parameters
  • callback function: The callback function for asynchronous request. (optional)
  • str account_id: The external account number (int) or account ID Guid. (required)
Returns

AccountSeals If the method is called asynchronously, returns the request thread.