Skip to content

Commit e76e16f

Browse files
committed
Minor fixes/comments/empty lines
1 parent 8080154 commit e76e16f

File tree

6 files changed

+31
-23
lines changed

6 files changed

+31
-23
lines changed

app/eSignature/examples/eg020_phone_authentication.py

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -44,12 +44,12 @@ def worker(args):
4444
2. Create an envelope definition object
4545
"""
4646
# Construct your API headers
47-
# Step 2 start
47+
#ds-snippet-start:eSign20Step2
4848
api_client = create_api_client(base_path=args["base_path"], access_token=args["access_token"])
49-
# Step 2 end
49+
#ds-snippet-end:eSign20Step2
5050

5151
# Construct your envelope
52-
# Step 4 start
52+
#ds-snippet-start:eSign20Step4
5353
envelope_definition = EnvelopeDefinition(
5454
email_subject="Please sign this document set"
5555
)
@@ -100,13 +100,13 @@ def worker(args):
100100

101101
# Tabs are set per recipient
102102
envelope_definition.recipients = Recipients(signers=[signer1])
103-
# Step 4 end
103+
#ds-snippet-end:eSign20Step4
104104

105105
# Call the eSignature REST API
106-
# Step 5 start
106+
#ds-snippet-start:eSign20Step5
107107
envelopes_api = EnvelopesApi(api_client)
108108
results = envelopes_api.create_envelope(account_id=args["account_id"], envelope_definition=envelope_definition)
109-
# Step 5 end
109+
#ds-snippet-end:eSign20Step5
110110

111111
return results
112112

@@ -115,7 +115,7 @@ def get_workflow(args):
115115
"""Retrieve the workflow id"""
116116
try:
117117
api_client = create_api_client(base_path=args["base_path"], access_token=args["access_token"])
118-
# Step 3 start
118+
#ds-snippet-start:eSign20Step3
119119
workflow_details = AccountsApi(api_client)
120120
workflow_response = workflow_details.get_account_identity_verification(account_id=args["account_id"])
121121

@@ -125,7 +125,7 @@ def get_workflow(args):
125125
for workflow in workflow_response.identity_verification:
126126
if workflow.default_name == "Phone Authentication":
127127
session['workflow_id'] = workflow.workflow_id
128-
# Step 3 end
128+
#ds-snippet-end:eSign20Step3
129129
return session['workflow_id']
130130

131131
else:

app/monitor/examples/eg001_get_monitoring_data.py

Lines changed: 2 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -17,22 +17,17 @@ def worker(args):
1717
"""
1818
1. Create an API client with headers
1919
2. Get your monitor data via SDK
20-
"""
21-
22-
23-
20+
"""
2421
# Create an API client with headers
2522
#ds-snippet-start:Monitor1Step2
2623
api_client = create_monitor_api_client(
2724
access_token=args["access_token"]
2825
)
2926
#ds-snippet-end:Monitor1Step2
30-
3127
#ds-snippet-start:Monitor1Step3
3228
dataset_api = DataSetApi(api_client=api_client)
3329
result = dataset_api.get_stream(
3430
data_set_name="monitor",
3531
version="2.0")._data
3632
#ds-snippet-end:Monitor1Step3
37-
38-
return result
33+
return result

app/rooms/examples/eg002_create_room_with_template.py

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,8 +25,10 @@ def get_templates(args):
2525
api_client = create_rooms_api_client(access_token=args["access_token"])
2626

2727
# Step 2. Get room templates
28+
#ds-snippet-start:Rooms2Step3
2829
room_templates_api = RoomTemplatesApi(api_client)
2930
templates = room_templates_api.get_room_templates(account_id=args["account_id"])
31+
#ds-snippet-end:Rooms2Step3
3032
return templates.room_templates
3133

3234
@staticmethod
@@ -38,9 +40,12 @@ def worker(args):
3840
4. Post the room using SDK
3941
"""
4042
# Step 1. Create an API client with headers
43+
#ds-snippet-start:Rooms2Step2
4144
api_client = create_rooms_api_client(access_token=args["access_token"])
45+
#ds-snippet-end:Rooms2Step2
4246

4347
# Step 2. Get Default Admin role id
48+
#ds-snippet-start:Rooms2Step4
4449
roles_api = RolesApi(api_client)
4550
roles = roles_api.get_roles(account_id=args["account_id"])
4651
role_id = [role.role_id for role in roles.roles if role.is_default_for_admin][0]
@@ -59,11 +64,14 @@ def worker(args):
5964
}
6065
)
6166
)
67+
#ds-snippet-end:Rooms2Step4
6268

6369
# Step 4. Create the room using a POST API call.
70+
#ds-snippet-start:Rooms2Step5
6471
rooms_api = RoomsApi(api_client)
6572
response = rooms_api.create_room(
6673
body=room,
6774
account_id=args["account_id"],
6875
)
76+
#ds-snippet-end:Rooms2Step5
6977
return response

app/rooms/examples/eg003_export_data_from_room.py

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,9 @@ def get_rooms(args):
2121
2. Get rooms
2222
"""
2323
# Step 1. Create an API client with headers
24+
#ds-snippet-start:Rooms3Step2
2425
api_client = create_rooms_api_client(access_token=args["access_token"])
26+
#ds-snippet-end:Rooms3Step2
2527

2628
# Step 2. Get room templates
2729
rooms_api = RoomsApi(api_client)
@@ -38,9 +40,11 @@ def worker(args):
3840
api_client = create_rooms_api_client(access_token=args["access_token"])
3941

4042
# Step 2. Get room field data using SDK
43+
#ds-snippet-start:Rooms3Step3
4144
rooms_api = RoomsApi(api_client)
4245
response = rooms_api.get_room_field_data(
4346
room_id=args['room_id'],
4447
account_id=args["account_id"]
4548
)
49+
#ds-snippet-end:Rooms3Step3
4650
return response

app/rooms/examples/eg004_add_forms_to_room.py

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,9 @@ def get_rooms(args):
2222
2. Get rooms
2323
"""
2424
# Step 1. Create an API client with headers
25+
#ds-snippet-start:Rooms4Step2
2526
api_client = create_rooms_api_client(access_token=args["access_token"])
27+
#ds-snippet-end:Rooms4Step2
2628

2729
# Step 2. Get rooms
2830
rooms_api = RoomsApi(api_client)
@@ -40,15 +42,19 @@ def get_forms(args):
4042
api_client = create_rooms_api_client(access_token=args["access_token"])
4143

4244
# Step 2. Get first form library id
45+
#ds-snippet-start:Rooms4Step3
4346
form_libraries_api = FormLibrariesApi(api_client)
4447
form_libraries = form_libraries_api.get_form_libraries(account_id=args["account_id"])
4548
first_form_library_id = form_libraries.forms_library_summaries[0].forms_library_id
49+
#ds-snippet-end:Rooms4Step3
4650

4751
# Step 3. Get forms
52+
#ds-snippet-start:Rooms4Step2
4853
form_library_forms = form_libraries_api.get_form_library_forms(
4954
form_library_id=first_form_library_id,
5055
account_id=args["account_id"]
5156
)
57+
#ds-snippet-end:Rooms4Step3
5258
return form_library_forms.forms
5359

5460
@staticmethod
@@ -61,10 +67,12 @@ def worker(args):
6167
api_client = create_rooms_api_client(access_token=args["access_token"])
6268

6369
# Step 2. Add the form to the room
70+
#ds-snippet-start:Rooms4Step4
6471
rooms_api = RoomsApi(api_client)
6572
response = rooms_api.add_form_to_room(
6673
room_id=args['room_id'],
6774
body=FormForAdd(form_id=args['form_id']),
6875
account_id=args["account_id"]
6976
)
77+
#ds-snippet-end:Rooms4Step4
7078
return response

app/rooms/examples/eg007_create_form_group.py

Lines changed: 1 addition & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,6 @@
33

44
from app.rooms import create_rooms_api_client
55

6-
76
class Eg007CreateFormGroupController:
87
@staticmethod
98
def get_args():
@@ -21,20 +20,14 @@ def worker(args):
2120
2. Create FormGroupForCreate object
2221
3. POST the form using SDK
2322
"""
24-
25-
2623
# Create an API with headers
2724
#ds-snippet-start:Rooms7Step2
2825
api_client = create_rooms_api_client(access_token=args["access_token"])
2926
#ds-snippet-end:Rooms7Step2
30-
31-
3227
# Create FormGroupForCreate object
3328
#ds-snippet-start:Rooms7Step3
3429
form = FormGroupForCreate(name=args["form_group_name"])
3530
#ds-snippet-end:Rooms7Step3
36-
37-
3831
# Post the form object using SDK
3932
#ds-snippet-start:Rooms7Step4
4033
form_groups_api = FormGroupsApi(api_client)
@@ -43,4 +36,4 @@ def worker(args):
4336
)
4437
#ds-snippet-end:Rooms7Step4
4538

46-
return response
39+
return response

0 commit comments

Comments
 (0)