Updating comments

Author: InbarGazit

app/admin/examples/eg010_delete_user_data_from_organization.py

@@ -31,28 +31,28 @@ def worker(args):
         email = args["email"]
 
         # Create an API client with headers
-        # Step 2 start
+        #ds-snippet-start:Admin10Step2
         api_client = ApiClient(host=DS_CONFIG["admin_api_client_host"])
         api_client.set_default_header(
             header_name="Authorization",
             header_value=f"Bearer {access_token}"
         )
-        # Step 2 end
+        #ds-snippet-end:Admin10Step2
 
         users_api = UsersApi(api_client=api_client)
         results = users_api.get_user_ds_profiles_by_email(organization_id=org_id, email=email)
         user = results.users[0]
 
-        # Step 3 start
+        #ds-snippet-start:Admin10Step3
         organizations_api = OrganizationsApi(api_client=api_client)
         user_data_redaction_request = IndividualUserDataRedactionRequest(
             user_id=user.id,
             memberships=[MembershipDataRedactionRequest(account_id=user.memberships[0].account_id)]
         )
-        # Step 3 end
+        #ds-snippet-end:Admin10Step3
 
-        # Step 4 start
+        #ds-snippet-start:Admin10Step4
         results = organizations_api.redact_individual_user_data(org_id, user_data_redaction_request)
-        # Step 4 end
+        #ds-snippet-end:Admin10Step4
 
         return results

app/click/examples/eg002_activate_clickwrap.py

@@ -43,9 +43,11 @@ def worker(args):
         3. Update a clickwrap using SDK
         """
         # Step 1. Create an API client with headers
+        #ds-snippet-start:Click2Step2
         api_client = create_click_api_client(
             access_token=args["access_token"]
         )
+        #ds-snippet-end:Click2Step2
 
         # Step 2. Create a clickwrap request model
         #ds-snippet-start:Click2Step3

app/click/examples/eg006_embed_clickwrap.py

@@ -27,9 +27,11 @@ def get_active_clickwraps(args):
         2. Get a list of active clickwraps
         """
         # Step 1. Create an API client with headers
+        #ds-snippet-start:Click6Step2
         api_client = create_click_api_client(
             access_token=args["access_token"]
         )
+        #ds-snippet-end:Click6Step2
 
         # Step 2. Get a list of active clickwraps
         accounts_api = AccountsApi(api_client)
@@ -53,6 +55,7 @@ def worker(args):
         )
 
         # Create a user agreement request model
+        #ds-snippet-start:Click6Step3
         user_agreement_request = UserAgreementRequest(
             client_user_id=args["email"],
             document_data={
@@ -63,8 +66,10 @@ def worker(args):
                 "date": args["date"]
             },
         )
+        #ds-snippet-end:Click6Step3
 
-        # Retrieve Agreement Url using SDK
+        # Retrieve Agreement URL using SDK
+        #ds-snippet-start:Click6Step4
         accounts_api = AccountsApi(api_client)
         clickwrap = ast.literal_eval(args["clickwrap"])
         print(type(clickwrap))
@@ -73,5 +78,6 @@ def worker(args):
             clickwrap_id=clickwrap["clickwrap_id"],
             user_agreement_request=user_agreement_request,
         )
+        #ds-snippet-end:Click6Step4
 
         return response

app/eSignature/examples/eg012_embedded_console.py

@@ -34,6 +34,7 @@ def worker(args):
         # with the NDSE. It is usually the case that the
         # user will never "finish" with the NDSE.
         # Assume that control will not be passed back to your app.
+        #ds-snippet-start:eSign12Step2
         view_request = ConsoleViewRequest(return_url=args["ds_return_url"])
         if args["starting_view"] == "envelope" and args["envelope_id"]:
             view_request.envelope_id = args["envelope_id"]
@@ -45,4 +46,5 @@ def worker(args):
         envelope_api = EnvelopesApi(api_client)
         results = envelope_api.create_console_view(account_id=args["account_id"], console_view_request=view_request)
         url = results.url
+        #ds-snippet-end:eSign12Step2
         return {"redirect_url": url}

app/eSignature/examples/eg043_shared_access.py

@@ -10,8 +10,12 @@
 class Eg043SharedAccessController:
     @classmethod
     def create_agent(cls, args):
+        #ds-snippet-start:eSign43Step2
         api_client = create_api_client(base_path=args["base_path"], access_token=args["access_token"])
+        #ds-snippet-end:eSign43Step2
+        #ds-snippet-start:eSign43Step3
         users_api = UsersApi(api_client)
+        #ds-snippet-end:eSign43Step3
 
         # check if agent already exists
         try:
@@ -29,9 +33,12 @@ def create_agent(cls, args):
                 raise err
 
         # create new agent
+        #ds-snippet-start:eSign43Step3
         new_users = users_api.create(args["account_id"], new_users_definition=cls.new_users_definition(args))
         return new_users.new_users[0]
+        #ds-snippet-end:eSign43Step3
 
+    #ds-snippet-start:eSign43Step4
     @classmethod
     def create_authorization(cls, args):
         api_client = create_api_client(base_path=args["base_path"], access_token=args["access_token"])
@@ -52,7 +59,9 @@ def create_authorization(cls, args):
             args["user_id"],
             user_authorization_create_request=cls.user_authorization_request(args)
         )
+        #ds-snippet-end:eSign43Step4
 
+    #ds-snippet-start:eSign43Step3
     @classmethod
     def new_users_definition(cls, args):
         agent = UserInformation(
@@ -61,6 +70,7 @@ def new_users_definition(cls, args):
             activation_access_code=args["activation"]
         )
         return NewUsersDefinition(new_users=[agent])
+    #ds-snippet-end:eSign43Step3
 
     @classmethod
     def user_authorization_request(cls, args):
@@ -72,6 +82,7 @@ def user_authorization_request(cls, args):
             permission="manage"
         )
 
+    #ds-snippet-start:eSign43Step5
     @classmethod
     def get_envelopes(cls, args):
         api_client = create_api_client(base_path=args["base_path"], access_token=args["access_token"])
@@ -80,3 +91,4 @@ def get_envelopes(cls, args):
 
         from_date = (datetime.utcnow() - timedelta(days=10)).isoformat()
         return envelopes_api.list_status_changes(account_id=args["account_id"], from_date=from_date)
+    #ds-snippet-end:eSign43Step5

app/rooms/examples/eg005_get_rooms_with_filters.py

@@ -23,11 +23,15 @@ def get_rooms(args):
         2. Get rooms with filter
         """
         # Step 1. Create an API client with headers
+        #ds-snippet-start:Rooms5Step2
         api_client = create_rooms_api_client(access_token=args["access_token"])
+        #ds-snippet-end:Rooms5Step2
 
         # Step 2. Get room templates
+        #ds-snippet-start:Rooms5Step4
         rooms_api = RoomsApi(api_client)
         rooms = rooms_api.get_rooms(account_id=args["account_id"])
+        #ds-snippet-end:Rooms5Step4
         return rooms.rooms
 
     @staticmethod
@@ -43,7 +47,9 @@ def worker(args):
         rooms_api = RoomsApi(api_client)
         response = rooms_api.get_rooms(
             account_id=args["account_id"],
+            #ds-snippet-start:Rooms5Step3
             field_data_changed_start_date=datetime.strptime(args['start_date'], "%Y-%m-%d"),
             field_data_changed_end_date=datetime.strptime(args['end_date'], "%Y-%m-%d"),
+            #ds-snippet-end:Rooms5Step3
         )
         return response