Skip to content

Commit 289cb29

Browse files
committed
text changes
1 parent 5af759b commit 289cb29

5 files changed

Lines changed: 34 additions & 29 deletions

File tree

app/admin/examples/eg003_bulk_export_user_data/views.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ def get_user_list_data():
3636
get_csv=True,
3737
title="Bulk export user data",
3838
h1="Bulk export user data",
39-
message="Results from UserExport:createUserListExport:",
39+
message="Results from UserExport:getUserListExport:",
4040
json=json.dumps(json.dumps(results.to_dict(), default=str))
4141
)
4242

app/admin/examples/eg004_add_users_via_bulk_import/controller.py

Lines changed: 15 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -11,41 +11,45 @@ class Eg004Controller:
1111
@staticmethod
1212
def worker(request):
1313
"""
14-
Create a user list export request and
15-
returns a list of pending and completed export requests:
16-
1. Create the export API object
14+
Create a user list import request and
15+
returns a list of pending and completed import requests:
16+
1. Create the import API object
1717
2. Getting a CSV file from a form and converting it to a string
18-
3. Creating an export API object
18+
3. Creating an import API object
1919
4. Setting headers for creating bulk import request
2020
5. Returns the response from the create_bulk_import_add_users_request method
2121
"""
2222

2323
# Get organization ID
2424
organization_id = get_organization_id()
2525

26-
# 1. Create the export API object
26+
# Create the export API object
27+
# Step 2 start
2728
api_client = create_admin_api_client(
2829
access_token=session["ds_access_token"]
2930
)
31+
# Step 2 end
3032

31-
# 2. Getting a CSV file from a form and saving it
33+
# Getting a CSV file from a form and saving it
3234
uploaded_file = request.files['csv_file']
3335
csv_folder_path = path.abspath(path.join(path.dirname(path.realpath(__file__)), "csv"))
3436
csv_file_path = path.join(csv_folder_path, "uploaded_file.csv")
3537
uploaded_file.save(csv_file_path)
3638

37-
# 3. Creating an export API object
38-
export_api = BulkImportsApi(api_client=api_client)
39+
# Creating an import API object
40+
import_api = BulkImportsApi(api_client=api_client)
3941

40-
# 4. Setting headers for creating bulk import request
42+
# Setting headers for creating bulk import request
4143
header_name, header_value = "Content-Disposition", "filename=myfile.csv"
4244
api_client.set_default_header(header_name, header_value)
4345

44-
# 5. Returns the response from the create_bulk_import_add_users_request method
45-
return export_api.create_bulk_import_add_users_request(
46+
# Returns the response from the create_bulk_import_add_users_request method
47+
# Step 3 start
48+
return import_api.create_bulk_import_add_users_request(
4649
organization_id,
4750
csv_file_path
4851
)
52+
# Step 3 end
4953

5054
@staticmethod
5155
def get_example_csv():

app/admin/templates/eg003_bulk_export_user_data.html

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,15 @@
11
<!-- extend base layout --> {% extends "base.html" %} {% block content %}
22

33
<h4>3. Bulk export user data</h4>
4-
<p>Demonstrates how to bulk-export user accounts within an organization into a CSV (comma separated value) file</p>
4+
<p>Demonstrates how to bulk-export user accounts within an organization into a CSV (comma separated value) file.</p>
55

66
{% if show_doc %}
77
<p><a target='_blank' href='{{ documentation | safe }}'>Documentation</a> about this example.</p>
88
{% endif %}
99

10-
<p>API method used:
11-
<a target='_blank' href="https://developers.docusign.com/docs/admin-api/reference/bulkoperations/userexport/createuserlistexport/">UserExport:createUserListExport</a>.
10+
<p>API methods used:
11+
<a target='_blank' href="https://developers.docusign.com/docs/admin-api/reference/bulkoperations/userexport/createuserlistexport/">UserExport:createUserListExport</a>
12+
<a target='_blank' href="https://developers.docusign.com/docs/admin-api/reference/bulkoperations/userexport/getuserlistexport/">UserExport::getUserListExport</a>
1213
</p>
1314
<p>
1415
View source file <a target="_blank" href="{{ source_url | safe }}">{{ source_file }}</a> on GitHub.

app/admin/templates/eg004_add_users_via_bulk_import.html

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
<!-- extend base layout --> {% extends "base.html" %} {% block content %}
22

33
<h4>4. Add users via bulk import</h4>
4-
<p>Demonstrates how to bulk-import users and add user data from an example CSV (comma-separated value) file into a DocuSign Admin organization</p>
4+
<p>Demonstrates how to bulk-import users and add user data from an example CSV (comma-separated value) file into a DocuSign Admin organization.</p>
55

66
{% if show_doc %}
77
<p><a target='_blank' href='{{ documentation | safe }}'>Documentation</a> about this example.</p>
@@ -16,7 +16,7 @@ <h4>4. Add users via bulk import</h4>
1616
<br>
1717
<p>
1818
You can <a href="eg004examplecsv">download an example of the required csv file</a>
19-
and change it as you see fit
19+
and change it as you see fit.
2020
</p>
2121
<form class="eg" action="" method="post" data-busy="form" enctype="multipart/form-data">
2222
<label>Upload your CSV file:</label>
@@ -27,6 +27,6 @@ <h4>4. Add users via bulk import</h4>
2727
<button type="submit" class="btn btn-docu mt-4 mb-4">Continue</button>
2828
</form>
2929

30-
<p>After you click the continue button. Your account should have new users specified in the csv file.</p>
30+
<p>After you select the "Continue" button, your account should have new users specified in the CSV file.</p>
3131

3232
{% endblock %}

app/admin/templates/home_admin.html

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -26,10 +26,10 @@ <h1 class="display-4">Python Launcher</h1>
2626
{% endif %}
2727

2828
<h2>DocuSign Admin API Code Examples</h2>
29-
<h4 id="example001">1. <a href="eg001">Create a new user</a></h4>
30-
<p>Demonstrates how to create a new user with active status</p>
29+
<h4 id="example001">1. <a href="eg001">Create a new active eSignature user</a></h4>
30+
<p>Demonstrates how to create a new eSignature user and activate their account automatically.</p>
3131

32-
<p>API method used:
32+
<p>API methods used:
3333
<a target='_blank' href="https://developers.docusign.com/docs/esign-rest-api/reference/accounts/accountpermissionprofiles/list/">AccountPermissionProfiles::list</a>,
3434
<a target='_blank' href="https://developers.docusign.com/docs/esign-rest-api/reference/usergroups/groups/list/">Groups::list</a>,
3535
<a target='_blank' href="https://developers.docusign.com/docs/admin-api/reference/users/users/createuser/">Users::createUser</a>.
@@ -39,31 +39,31 @@ <h4 id="example002">2. <a href="eg002">Create a new active user for CLM and eSig
3939
<p>Demonstrates how to create a new DocuSign user (valid for both CLM and eSignature APIs) and activate their account automatically.</p>
4040

4141
<p>API methods used:
42-
<a target ='_blank' href="https://developers.docusign.com/docs/admin-api/reference/productpermissionprofiles/productpermissionprofiles/getproductpermissionprofiles/">ProductPermissionProfiles::getProductPermissionProfiles</a>,
43-
<a target ='_blank' href="https://developers.docusign.com/docs/admin-api/reference/dsgroups/dsgroups/getdsgroups/">DsGroups::getDsGroups</a>, and
42+
<a target ='_blank' href="https://developers.docusign.com/docs/admin-api/reference/productpermissionprofiles/productpermissionprofiles/getproductpermissionprofiles/">ProductPermissionProfiles::getProductPermissionProfiles</a>
43+
<a target ='_blank' href="https://developers.docusign.com/docs/admin-api/reference/dsgroups/dsgroups/getdsgroups/">DsGroups::getDsGroups</a>
4444
<a target ='_blank' href="https://developers.docusign.com/docs/admin-api/reference/usermanagement/multiproductusermanagement/addorupdateuser/">MultiProductUserManagement::addOrUpdateUser</a>
4545
</p>
4646

4747
<h4 id="example003">3. <a href="eg003">Bulk export user data</a></h4>
48-
<p>Demonstrates how to bulk-export user accounts within an organization into a CSV (comma separated value) file.</p>
48+
<p>Demonstrates how to bulk export user accounts within an organization into a CSV (comma separated value) file.</p>
4949

50-
<p>API method used:
51-
<a target='_blank' href="https://developers.docusign.com/docs/admin-api/reference/bulkoperations/userexport/createuserlistexport/">UserExport:createUserListExport</a> and
52-
<a target='_blank' href="https://developers.docusign.com/docs/admin-api/reference/bulkoperations/userexport/getuserlistexport/">UserExport::getUserListExport</a>.
50+
<p>API methods used:
51+
<a target='_blank' href="https://developers.docusign.com/docs/admin-api/reference/bulkoperations/userexport/createuserlistexport/">UserExport:createUserListExport</a>
52+
<a target='_blank' href="https://developers.docusign.com/docs/admin-api/reference/bulkoperations/userexport/getuserlistexport/">UserExport::getUserListExport</a>
5353
</p>
5454

5555
<h4 id="example004">4. <a href="eg004">Add users via bulk import</a></h4>
5656
<p>Demonstrates how to bulk import users and add user data from an example CSV (comma-separated value) file into a DocuSign Admin organization.</p>
5757

5858
<p>API method used:
59-
<a target='_blank' href="https://developers.docusign.com/docs/admin-api/reference/bulkoperations/userimport/addbulkuserimport/">UserImport:addBulkUserImport</a>.
59+
<a target='_blank' href="https://developers.docusign.com/docs/admin-api/reference/bulkoperations/userimport/addbulkuserimport/">UserImport:addBulkUserImport</a>
6060
</p>
6161

6262
<h4 id="example005">5. <a href="eg005">Audit users</a></h4>
6363
<p>Demonstrates how to audit the users in your account by retrieving the profiles of users that were modified after a specified date.</p>
6464

6565
<p>API methods used:
66-
<a target='_blank' href="https://developers.docusign.com/docs/admin-api/reference/users/users/getusers/">Users::getUsers</a> and
66+
<a target='_blank' href="https://developers.docusign.com/docs/admin-api/reference/users/users/getusers/">Users::getUsers</a>
6767
<a target='_blank' href="https://developers.docusign.com/docs/admin-api/reference/users/users/getuserprofiles/">Users::getUserProfiles</a>
6868
</p>
6969
</div>

0 commit comments

Comments
 (0)