Skip to content

Commit 867e39b

Browse files
authored
Merge pull request #3 from docusign/1.1.0-v2.1-1.1.0
Version 1.1.0 release
2 parents 1b94d31 + 38feee1 commit 867e39b

12 files changed

+1163
-7
lines changed

.travis.yml

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,3 +12,6 @@ install:
1212
- pip install -r test-requirements.txt
1313
# command to run tests
1414
script: nosetests -s
15+
matrix:
16+
allow_failures:
17+
- python: nightly # Allow all tests to fail for nightly

CHANGELOG.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,11 @@ All notable changes to this project will be documented in this file.
33

44
See [DocuSign Support Center](https://support.docusign.com/en/releasenotes/) for Product Release Notes.
55

6+
## [v1.1.0] - Admin API v2.1-1.1.0 - 2022-04-26
7+
### Changed
8+
- Added support for version v2.1-1.1.0 of the DocuSign Admin API.
9+
- Updated the SDK release version.
10+
611
## [1.0.0] - Admin API v2.1-1.0.0 - 2021-09-16
712
### Changed
813
- Added support for version v2.1-1.0.0 of the DocuSign Admin API.

docusign_admin/__init__.py

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -120,6 +120,7 @@
120120
from docusign_admin.models.product_permission_profiles_request import ProductPermissionProfilesRequest
121121
from docusign_admin.models.product_permission_profiles_response import ProductPermissionProfilesResponse
122122
from docusign_admin.models.remove_ds_group_users_response import RemoveDSGroupUsersResponse
123+
from docusign_admin.models.remove_user_products_response import RemoveUserProductsResponse
123124
from docusign_admin.models.required_attribute_mapping_response import RequiredAttributeMappingResponse
124125
from docusign_admin.models.saml2_identity_provider_response import Saml2IdentityProviderResponse
125126
from docusign_admin.models.setting_response import SettingResponse
@@ -132,7 +133,9 @@
132133
from docusign_admin.models.user_drilldown_response import UserDrilldownResponse
133134
from docusign_admin.models.user_identity_request import UserIdentityRequest
134135
from docusign_admin.models.user_identity_response import UserIdentityResponse
136+
from docusign_admin.models.user_product_permission_profiles_request import UserProductPermissionProfilesRequest
135137
from docusign_admin.models.user_product_permission_profiles_response import UserProductPermissionProfilesResponse
138+
from docusign_admin.models.user_product_profile_delete_request import UserProductProfileDeleteRequest
136139
from docusign_admin.models.user_update_response import UserUpdateResponse
137140
from docusign_admin.models.users_drilldown_response import UsersDrilldownResponse
138141
from docusign_admin.models.users_update_response import UsersUpdateResponse

docusign_admin/apis/product_permission_profiles_api.py

Lines changed: 360 additions & 0 deletions
Large diffs are not rendered by default.

docusign_admin/apis/users_api.py

Lines changed: 233 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -766,6 +766,239 @@ def delete_identities_with_http_info(self, organization_id, user_id, request_mod
766766
_request_timeout=params.get('_request_timeout'),
767767
collection_formats=collection_formats)
768768

769+
def get_user_ds_profile(self, organization_id, user_id, **kwargs):
770+
"""
771+
Returns user information using the userId for lookup.
772+
Required scopes: user_read
773+
This method makes a synchronous HTTP request by default. To make an
774+
asynchronous HTTP request, please define a `callback` function
775+
to be invoked when receiving the response.
776+
>>> def callback_function(response):
777+
>>> pprint(response)
778+
>>>
779+
>>> thread = api.get_user_ds_profile(organization_id, user_id, callback=callback_function)
780+
781+
:param callback function: The callback function
782+
for asynchronous request. (optional)
783+
:param str organization_id: The organization ID Guid (required)
784+
:param str user_id: The user ID Guid (required)
785+
:param bool sort: Sorts user information by account name ascending
786+
:return: UsersDrilldownResponse
787+
If the method is called asynchronously,
788+
returns the request thread.
789+
"""
790+
kwargs['_return_http_data_only'] = True
791+
if kwargs.get('callback'):
792+
return self.get_user_ds_profile_with_http_info(organization_id, user_id, **kwargs)
793+
else:
794+
(data) = self.get_user_ds_profile_with_http_info(organization_id, user_id, **kwargs)
795+
return data
796+
797+
def get_user_ds_profile_with_http_info(self, organization_id, user_id, **kwargs):
798+
"""
799+
Returns user information using the userId for lookup.
800+
Required scopes: user_read
801+
This method makes a synchronous HTTP request by default. To make an
802+
asynchronous HTTP request, please define a `callback` function
803+
to be invoked when receiving the response.
804+
>>> def callback_function(response):
805+
>>> pprint(response)
806+
>>>
807+
>>> thread = api.get_user_ds_profile_with_http_info(organization_id, user_id, callback=callback_function)
808+
809+
:param callback function: The callback function
810+
for asynchronous request. (optional)
811+
:param str organization_id: The organization ID Guid (required)
812+
:param str user_id: The user ID Guid (required)
813+
:param bool sort: Sorts user information by account name ascending
814+
:return: UsersDrilldownResponse
815+
If the method is called asynchronously,
816+
returns the request thread.
817+
"""
818+
819+
all_params = ['organization_id', 'user_id', 'sort']
820+
all_params.append('callback')
821+
all_params.append('_return_http_data_only')
822+
all_params.append('_preload_content')
823+
all_params.append('_request_timeout')
824+
825+
params = locals()
826+
for key, val in iteritems(params['kwargs']):
827+
if key not in all_params:
828+
raise TypeError(
829+
"Got an unexpected keyword argument '%s'"
830+
" to method get_user_ds_profile" % key
831+
)
832+
params[key] = val
833+
del params['kwargs']
834+
# verify the required parameter 'organization_id' is set
835+
if ('organization_id' not in params) or (params['organization_id'] is None):
836+
raise ValueError("Missing the required parameter `organization_id` when calling `get_user_ds_profile`")
837+
# verify the required parameter 'user_id' is set
838+
if ('user_id' not in params) or (params['user_id'] is None):
839+
raise ValueError("Missing the required parameter `user_id` when calling `get_user_ds_profile`")
840+
841+
842+
collection_formats = {}
843+
844+
resource_path = '/v2.1/organizations/{organizationId}/users/{userId}/dsprofile'.replace('{format}', 'json')
845+
path_params = {}
846+
if 'organization_id' in params:
847+
path_params['organizationId'] = params['organization_id']
848+
if 'user_id' in params:
849+
path_params['userId'] = params['user_id']
850+
851+
query_params = {}
852+
if 'sort' in params:
853+
query_params['sort'] = params['sort']
854+
855+
header_params = {}
856+
857+
form_params = []
858+
local_var_files = {}
859+
860+
body_params = None
861+
# HTTP header `Accept`
862+
header_params['Accept'] = self.api_client.\
863+
select_header_accept(['application/json'])
864+
865+
# HTTP header `Content-Type`
866+
header_params['Content-Type'] = self.api_client.\
867+
select_header_content_type(['application/json'])
868+
869+
# Authentication setting
870+
auth_settings = []
871+
872+
return self.api_client.call_api(resource_path, 'GET',
873+
path_params,
874+
query_params,
875+
header_params,
876+
body=body_params,
877+
post_params=form_params,
878+
files=local_var_files,
879+
response_type='UsersDrilldownResponse',
880+
auth_settings=auth_settings,
881+
callback=params.get('callback'),
882+
_return_http_data_only=params.get('_return_http_data_only'),
883+
_preload_content=params.get('_preload_content', True),
884+
_request_timeout=params.get('_request_timeout'),
885+
collection_formats=collection_formats)
886+
887+
def get_user_ds_profiles_by_email(self, organization_id, **kwargs):
888+
"""
889+
Returns DS user profile information.
890+
Required scopes: user_read
891+
This method makes a synchronous HTTP request by default. To make an
892+
asynchronous HTTP request, please define a `callback` function
893+
to be invoked when receiving the response.
894+
>>> def callback_function(response):
895+
>>> pprint(response)
896+
>>>
897+
>>> thread = api.get_user_ds_profiles_by_email(organization_id, callback=callback_function)
898+
899+
:param callback function: The callback function
900+
for asynchronous request. (optional)
901+
:param str organization_id: The organization ID Guid (required)
902+
:param str email: The email address of the user
903+
:param bool sort: Sorts user information by account name ascending
904+
:return: UsersDrilldownResponse
905+
If the method is called asynchronously,
906+
returns the request thread.
907+
"""
908+
kwargs['_return_http_data_only'] = True
909+
if kwargs.get('callback'):
910+
return self.get_user_ds_profiles_by_email_with_http_info(organization_id, **kwargs)
911+
else:
912+
(data) = self.get_user_ds_profiles_by_email_with_http_info(organization_id, **kwargs)
913+
return data
914+
915+
def get_user_ds_profiles_by_email_with_http_info(self, organization_id, **kwargs):
916+
"""
917+
Returns DS user profile information.
918+
Required scopes: user_read
919+
This method makes a synchronous HTTP request by default. To make an
920+
asynchronous HTTP request, please define a `callback` function
921+
to be invoked when receiving the response.
922+
>>> def callback_function(response):
923+
>>> pprint(response)
924+
>>>
925+
>>> thread = api.get_user_ds_profiles_by_email_with_http_info(organization_id, callback=callback_function)
926+
927+
:param callback function: The callback function
928+
for asynchronous request. (optional)
929+
:param str organization_id: The organization ID Guid (required)
930+
:param str email: The email address of the user
931+
:param bool sort: Sorts user information by account name ascending
932+
:return: UsersDrilldownResponse
933+
If the method is called asynchronously,
934+
returns the request thread.
935+
"""
936+
937+
all_params = ['organization_id', 'email', 'sort']
938+
all_params.append('callback')
939+
all_params.append('_return_http_data_only')
940+
all_params.append('_preload_content')
941+
all_params.append('_request_timeout')
942+
943+
params = locals()
944+
for key, val in iteritems(params['kwargs']):
945+
if key not in all_params:
946+
raise TypeError(
947+
"Got an unexpected keyword argument '%s'"
948+
" to method get_user_ds_profiles_by_email" % key
949+
)
950+
params[key] = val
951+
del params['kwargs']
952+
# verify the required parameter 'organization_id' is set
953+
if ('organization_id' not in params) or (params['organization_id'] is None):
954+
raise ValueError("Missing the required parameter `organization_id` when calling `get_user_ds_profiles_by_email`")
955+
956+
957+
collection_formats = {}
958+
959+
resource_path = '/v2.1/organizations/{organizationId}/users/dsprofile'.replace('{format}', 'json')
960+
path_params = {}
961+
if 'organization_id' in params:
962+
path_params['organizationId'] = params['organization_id']
963+
964+
query_params = {}
965+
if 'email' in params:
966+
query_params['email'] = params['email']
967+
if 'sort' in params:
968+
query_params['sort'] = params['sort']
969+
970+
header_params = {}
971+
972+
form_params = []
973+
local_var_files = {}
974+
975+
body_params = None
976+
# HTTP header `Accept`
977+
header_params['Accept'] = self.api_client.\
978+
select_header_accept(['application/json'])
979+
980+
# HTTP header `Content-Type`
981+
header_params['Content-Type'] = self.api_client.\
982+
select_header_content_type(['application/json'])
983+
984+
# Authentication setting
985+
auth_settings = []
986+
987+
return self.api_client.call_api(resource_path, 'GET',
988+
path_params,
989+
query_params,
990+
header_params,
991+
body=body_params,
992+
post_params=form_params,
993+
files=local_var_files,
994+
response_type='UsersDrilldownResponse',
995+
auth_settings=auth_settings,
996+
callback=params.get('callback'),
997+
_return_http_data_only=params.get('_return_http_data_only'),
998+
_preload_content=params.get('_preload_content', True),
999+
_request_timeout=params.get('_request_timeout'),
1000+
collection_formats=collection_formats)
1001+
7691002
def get_user_profiles(self, organization_id, **kwargs):
7701003
"""
7711004
Returns user information.

docusign_admin/client/configuration.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -90,9 +90,9 @@ def __init__(self):
9090
self.key_file = None
9191

9292
if PY3:
93-
self.user_agent = 'Swagger-Codegen/v2.1/1.0.0/python3'
93+
self.user_agent = 'Swagger-Codegen/v2.1/1.1.0/python3'
9494
else:
95-
self.user_agent = 'Swagger-Codegen/v2.1/1.0.0/python2'
95+
self.user_agent = 'Swagger-Codegen/v2.1/1.1.0/python2'
9696

9797
@property
9898
def logger_file(self):

docusign_admin/models/__init__.py

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -98,6 +98,7 @@
9898
from docusign_admin.models.product_permission_profiles_request import ProductPermissionProfilesRequest
9999
from docusign_admin.models.product_permission_profiles_response import ProductPermissionProfilesResponse
100100
from docusign_admin.models.remove_ds_group_users_response import RemoveDSGroupUsersResponse
101+
from docusign_admin.models.remove_user_products_response import RemoveUserProductsResponse
101102
from docusign_admin.models.required_attribute_mapping_response import RequiredAttributeMappingResponse
102103
from docusign_admin.models.saml2_identity_provider_response import Saml2IdentityProviderResponse
103104
from docusign_admin.models.setting_response import SettingResponse
@@ -110,7 +111,9 @@
110111
from docusign_admin.models.user_drilldown_response import UserDrilldownResponse
111112
from docusign_admin.models.user_identity_request import UserIdentityRequest
112113
from docusign_admin.models.user_identity_response import UserIdentityResponse
114+
from docusign_admin.models.user_product_permission_profiles_request import UserProductPermissionProfilesRequest
113115
from docusign_admin.models.user_product_permission_profiles_response import UserProductPermissionProfilesResponse
116+
from docusign_admin.models.user_product_profile_delete_request import UserProductProfileDeleteRequest
114117
from docusign_admin.models.user_update_response import UserUpdateResponse
115118
from docusign_admin.models.users_drilldown_response import UsersDrilldownResponse
116119
from docusign_admin.models.users_update_response import UsersUpdateResponse

docusign_admin/models/ds_group_users_remove_request.py

Lines changed: 27 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -33,11 +33,13 @@ class DSGroupUsersRemoveRequest(object):
3333
and the value is json key in definition.
3434
"""
3535
swagger_types = {
36-
'user_ids': 'list[str]'
36+
'user_ids': 'list[str]',
37+
'user_emails': 'list[str]'
3738
}
3839

3940
attribute_map = {
40-
'user_ids': 'user_ids'
41+
'user_ids': 'user_ids',
42+
'user_emails': 'user_emails'
4143
}
4244

4345
def __init__(self, _configuration=None, **kwargs): # noqa: E501
@@ -47,9 +49,11 @@ def __init__(self, _configuration=None, **kwargs): # noqa: E501
4749
self._configuration = _configuration
4850

4951
self._user_ids = None
52+
self._user_emails = None
5053
self.discriminator = None
5154

5255
setattr(self, "_{}".format('user_ids'), kwargs.get('user_ids', None))
56+
setattr(self, "_{}".format('user_emails'), kwargs.get('user_emails', None))
5357

5458
@property
5559
def user_ids(self):
@@ -69,11 +73,30 @@ def user_ids(self, user_ids):
6973
:param user_ids: The user_ids of this DSGroupUsersRemoveRequest. # noqa: E501
7074
:type: list[str]
7175
"""
72-
if self._configuration.client_side_validation and user_ids is None:
73-
raise ValueError("Invalid value for `user_ids`, must not be `None`") # noqa: E501
7476

7577
self._user_ids = user_ids
7678

79+
@property
80+
def user_emails(self):
81+
"""Gets the user_emails of this DSGroupUsersRemoveRequest. # noqa: E501
82+
83+
84+
:return: The user_emails of this DSGroupUsersRemoveRequest. # noqa: E501
85+
:rtype: list[str]
86+
"""
87+
return self._user_emails
88+
89+
@user_emails.setter
90+
def user_emails(self, user_emails):
91+
"""Sets the user_emails of this DSGroupUsersRemoveRequest.
92+
93+
94+
:param user_emails: The user_emails of this DSGroupUsersRemoveRequest. # noqa: E501
95+
:type: list[str]
96+
"""
97+
98+
self._user_emails = user_emails
99+
77100
def to_dict(self):
78101
"""Returns the model properties as a dict"""
79102
result = {}

0 commit comments

Comments
 (0)