Skip to content

Commit 049b319

Browse files
balaji1103balaji1103
authored
Merge pull request #177 from docusign/feature/add-http-info
Checked eSignature module few examples and the API calls and reset time are printing in the console.
2 parents 8e73910 + 72374da commit 049b319

File tree

75 files changed

+4523
-3251
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

75 files changed

+4523
-3251
lines changed

‎app/admin/examples/eg001_create_a_new_user.py‎

Lines changed: 31 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
1+
from datetime import datetime as dt, timezone
12
from docusign_admin import UsersApi, NewUserRequest, NewUserRequestAccountProperties, PermissionProfileRequest, GroupRequest
23
from docusign_esign import AccountsApi, ApiClient, GroupsApi
34
from flask import session
@@ -43,7 +44,16 @@ def get_permission_profiles(args):
4344

4445
#ds-snippet-start:Admin1Step3
4546
accounts_api = AccountsApi(api_client=api_client)
46-
profiles = accounts_api.list_permissions(account_id=account_id)
47+
(profiles, status, headers) = accounts_api.list_permissions_with_http_info(account_id=account_id)
48+
49+
remaining = headers.get("X-RateLimit-Remaining")
50+
reset = headers.get("X-RateLimit-Reset")
51+
52+
if remaining is not None and reset is not None:
53+
reset_date = dt.fromtimestamp(int(reset), tz=timezone.utc)
54+
print(f"API calls remaining: {remaining}")
55+
print(f"Next Reset: {reset_date}")
56+
4757
profiles_list = profiles.to_dict()["permission_profiles"]
4858
#ds-snippet-end:Admin1Step3
4959
return profiles_list
@@ -64,7 +74,16 @@ def get_groups(args):
6474

6575
#ds-snippet-start:Admin1Step4
6676
groups_api = GroupsApi(api_client)
67-
groups = groups_api.list_groups(account_id=account_id)
77+
(groups, status, headers) = groups_api.list_groups_with_http_info(account_id=account_id)
78+
79+
remaining = headers.get("X-RateLimit-Remaining")
80+
reset = headers.get("X-RateLimit-Reset")
81+
82+
if remaining is not None and reset is not None:
83+
reset_date = dt.fromtimestamp(int(reset), tz=timezone.utc)
84+
print(f"API calls remaining: {remaining}")
85+
print(f"Next Reset: {reset_date}")
86+
6887
groups_dict = groups.to_dict()
6988
groups_list = groups_dict["groups"]
7089
#ds-snippet-end:Admin1Step4
@@ -127,9 +146,18 @@ def worker(self, args):
127146

128147
# Creates a user using a method from the user API
129148
#ds-snippet-start:Admin1Step6
130-
response = user_api.create_user(
149+
(response, status, headers) = user_api.create_user_with_http_info(
131150
args["organization_id"],
132151
request_body
133152
)
153+
154+
remaining = headers.get("X-RateLimit-Remaining")
155+
reset = headers.get("X-RateLimit-Reset")
156+
157+
if remaining is not None and reset is not None:
158+
reset_date = dt.fromtimestamp(int(reset), tz=timezone.utc)
159+
print(f"API calls remaining: {remaining}")
160+
print(f"Next Reset: {reset_date}")
134161
#ds-snippet-end:Admin1Step6
162+
135163
return response

‎app/admin/examples/eg002_create_active_clm_esign_user.py‎

Lines changed: 40 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
1+
from datetime import datetime as dt, timezone
12
from docusign_admin import ApiClient, ProductPermissionProfilesApi, DSGroupsApi, UsersApi, NewMultiProductUserAddRequest, ProductPermissionProfileRequest, DSGroupRequest
23
from flask import session, json, request
34

@@ -37,7 +38,19 @@ def get_permission_profiles(args):
3738
)
3839
#ds-snippet-start:Admin2Step3
3940
product_permission_profiles_api = ProductPermissionProfilesApi(api_client=api_client)
40-
profiles = product_permission_profiles_api.get_product_permission_profiles(organization_id=org_id, account_id=session["ds_account_id"])
41+
(profiles, status, headers) = product_permission_profiles_api.get_product_permission_profiles_with_http_info(
42+
organization_id=org_id,
43+
account_id=session["ds_account_id"]
44+
)
45+
46+
remaining = headers.get("X-RateLimit-Remaining")
47+
reset = headers.get("X-RateLimit-Reset")
48+
49+
if remaining is not None and reset is not None:
50+
reset_date = dt.fromtimestamp(int(reset), tz=timezone.utc)
51+
print(f"API calls remaining: {remaining}")
52+
print(f"Next Reset: {reset_date}")
53+
4154
profiles_list = profiles.to_dict()["product_permission_profiles"]
4255
#ds-snippet-end:Admin2Step3
4356
return profiles_list
@@ -59,8 +72,20 @@ def get_groups(args):
5972

6073
#ds-snippet-start:Admin2Step4
6174
ds_groups_api = DSGroupsApi(api_client)
62-
ds_groups = ds_groups_api.get_ds_groups(organization_id=org_id, account_id=session["ds_account_id"])
75+
(ds_groups, status, headers) = ds_groups_api.get_ds_groups_with_http_info(
76+
organization_id=org_id,
77+
account_id=session["ds_account_id"]
78+
)
79+
80+
remaining = headers.get("X-RateLimit-Remaining")
81+
reset = headers.get("X-RateLimit-Reset")
82+
83+
if remaining is not None and reset is not None:
84+
reset_date = dt.fromtimestamp(int(reset), tz=timezone.utc)
85+
print(f"API calls remaining: {remaining}")
86+
print(f"Next Reset: {reset_date}")
6387
#ds-snippet-end:Admin2Step4
88+
6489
return ds_groups
6590

6691
@staticmethod
@@ -108,7 +133,19 @@ def worker(self, args):
108133

109134
#ds-snippet-start:Admin2Step6
110135
users_api = UsersApi(api_client)
111-
response = users_api.add_or_update_user(organization_id=org_id, account_id=session["ds_account_id"], request=new_user)
136+
(response, status, headers) = users_api.add_or_update_user_with_http_info(
137+
organization_id=org_id,
138+
account_id=session["ds_account_id"],
139+
request=new_user
140+
)
141+
142+
remaining = headers.get("X-RateLimit-Remaining")
143+
reset = headers.get("X-RateLimit-Reset")
144+
145+
if remaining is not None and reset is not None:
146+
reset_date = dt.fromtimestamp(int(reset), tz=timezone.utc)
147+
print(f"API calls remaining: {remaining}")
148+
print(f"Next Reset: {reset_date}")
112149
#ds-snippet-end:Admin2Step6
113150

114151
return response.to_dict()

‎app/admin/examples/eg003_bulk_export_user_data.py‎

Lines changed: 19 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
1+
from datetime import datetime as dt, timezone
12
from docusign_admin import ApiClient
23
from docusign_admin.apis import BulkExportsApi
34
from flask import session
@@ -28,12 +29,20 @@ def worker(cls):
2829

2930
# Create a user list export request
3031
#ds-snippet-start:Admin3Step3
31-
response = export_api.create_user_list_export(
32+
(response, status, headers) = export_api.create_user_list_export_with_http_info(
3233
organization_id,
3334
{
3435
"type": "organization_memberships_export"
3536
}
3637
)
38+
39+
remaining = headers.get("X-RateLimit-Remaining")
40+
reset = headers.get("X-RateLimit-Reset")
41+
42+
if remaining is not None and reset is not None:
43+
reset_date = dt.fromtimestamp(int(reset), tz=timezone.utc)
44+
print(f"API calls remaining: {remaining}")
45+
print(f"Next Reset: {reset_date}")
3746
#ds-snippet-end:Admin3Step3
3847

3948
# Save user_list_export_id in a client session
@@ -68,10 +77,18 @@ def get_csv_user_list(cls):
6877

6978
# Getting the user list export response
7079
#ds-snippet-start:Admin3Step4
71-
response = export_api.get_user_list_export(
80+
(response, status, headers) = export_api.get_user_list_export_with_http_info(
7281
organization_id,
7382
session['user_list_export_id']
7483
)
84+
85+
remaining = headers.get("X-RateLimit-Remaining")
86+
reset = headers.get("X-RateLimit-Reset")
87+
88+
if remaining is not None and reset is not None:
89+
reset_date = dt.fromtimestamp(int(reset), tz=timezone.utc)
90+
print(f"API calls remaining: {remaining}")
91+
print(f"Next Reset: {reset_date}")
7592
#ds-snippet-end:Admin3Step4
7693

7794
# Trying to get the user list export id

‎app/admin/examples/eg004_add_users_via_bulk_import.py‎

Lines changed: 22 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
1+
from datetime import datetime as dt, timezone
12
from os import path
23
from docusign_admin.apis import BulkImportsApi
34
from flask import session, Response
@@ -67,10 +68,18 @@ def worker(self, request):
6768
api_client.set_default_header(header_name, header_value)
6869

6970
# Returns the response from the create_bulk_import_add_users_request method
70-
response = import_api.create_bulk_import_add_users_request(
71+
(response, status, headers) = import_api.create_bulk_import_add_users_request_with_http_info(
7172
organization_id,
7273
csv_file_path
7374
)
75+
76+
remaining = headers.get("X-RateLimit-Remaining")
77+
reset = headers.get("X-RateLimit-Reset")
78+
79+
if remaining is not None and reset is not None:
80+
reset_date = dt.fromtimestamp(int(reset), tz=timezone.utc)
81+
print(f"API calls remaining: {remaining}")
82+
print(f"Next Reset: {reset_date}")
7483
#ds-snippet-end:Admin4Step3
7584

7685
# Save user list import id in a client session
@@ -92,7 +101,18 @@ def check_status():
92101
import_api = BulkImportsApi(api_client=api_client)
93102

94103
#ds-snippet-start:Admin4Step4
95-
import_results = import_api.get_bulk_user_import_request(organization_id, session['import_data_id'])
104+
(import_results, status, headers) = import_api.get_bulk_user_import_request_with_http_info(
105+
organization_id,
106+
session['import_data_id']
107+
)
108+
109+
remaining = headers.get("X-RateLimit-Remaining")
110+
reset = headers.get("X-RateLimit-Reset")
111+
112+
if remaining is not None and reset is not None:
113+
reset_date = dt.fromtimestamp(int(reset), tz=timezone.utc)
114+
print(f"API calls remaining: {remaining}")
115+
print(f"Next Reset: {reset_date}")
96116
#ds-snippet-end:Admin4Step4
97117

98118
if import_results.status == "completed":

‎app/admin/examples/eg005_audit_users.py‎

Lines changed: 21 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33

44
from ...ds_config import DS_CONFIG
55
from app.admin.utils import get_organization_id
6-
import datetime
6+
from datetime import datetime as dt, timezone, timedelta
77

88
class Eg005AuditUsersController:
99
@staticmethod
@@ -37,15 +37,23 @@ def worker(args):
3737
#ds-snippet-end:Admin5Step2
3838

3939
#ds-snippet-start:Admin5Step3
40-
today = datetime.datetime.now()
41-
ten_days_ago = today - (datetime.timedelta(days = 10))
40+
today = dt.now()
41+
ten_days_ago = today - (timedelta(days = 10))
4242
last_modified_since = ten_days_ago.strftime('%Y-%m-%d')
4343

4444
users_api = UsersApi(api_client=api_client)
45-
users = users_api.get_users(
45+
(users, status, headers) = users_api.get_users_with_http_info(
4646
organization_id=org_id,
4747
account_id=account_id,
4848
last_modified_since=last_modified_since)
49+
50+
remaining = headers.get("X-RateLimit-Remaining")
51+
reset = headers.get("X-RateLimit-Reset")
52+
53+
if remaining is not None and reset is not None:
54+
reset_date = dt.fromtimestamp(int(reset), tz=timezone.utc)
55+
print(f"API calls remaining: {remaining}")
56+
print(f"Next Reset: {reset_date}")
4957
#ds-snippet-end:Admin5Step3
5058

5159
#ds-snippet-start:Admin5Step4
@@ -59,7 +67,15 @@ def worker(args):
5967
#ds-snippet-start:Admin5Step5
6068
profile_list = []
6169
for email in emails:
62-
profile = users_api.get_user_profiles(organization_id=org_id, email=email)
70+
(profile, status, headers) = users_api.get_user_profiles_with_http_info(organization_id=org_id, email=email)
71+
72+
remaining = headers.get("X-RateLimit-Remaining")
73+
reset = headers.get("X-RateLimit-Reset")
74+
75+
if remaining is not None and reset is not None:
76+
reset_date = dt.fromtimestamp(int(reset), tz=timezone.utc)
77+
print(f"API calls remaining: {remaining}")
78+
print(f"Next Reset: {reset_date}")
6379
profile_list.append(profile.to_dict())
6480

6581
results = {"Modified users": profile_list}

‎app/admin/examples/eg006_get_user_profile_by_email.py‎

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
1+
from datetime import datetime as dt, timezone
12
from docusign_admin import ApiClient, UsersApi
23
from flask import session, request
34

@@ -39,9 +40,17 @@ def worker(args):
3940
#ds-snippet-start:Admin6Step3
4041
users_api = UsersApi(api_client=api_client)
4142

42-
results = users_api.get_user_ds_profiles_by_email(
43+
(results, status, headers) = users_api.get_user_ds_profiles_by_email_with_http_info(
4344
organization_id=org_id,
4445
email=email)
46+
47+
remaining = headers.get("X-RateLimit-Remaining")
48+
reset = headers.get("X-RateLimit-Reset")
49+
50+
if remaining is not None and reset is not None:
51+
reset_date = dt.fromtimestamp(int(reset), tz=timezone.utc)
52+
print(f"API calls remaining: {remaining}")
53+
print(f"Next Reset: {reset_date}")
4554
#ds-snippet-end:Admin6Step3
4655

4756
return results

‎app/admin/examples/eg007_get_user_profile_by_user_id.py‎

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
1+
from datetime import datetime as dt, timezone
12
from docusign_admin import ApiClient, UsersApi
23
from flask import session, request
34

@@ -39,9 +40,17 @@ def worker(args):
3940
#ds-snippet-start:Admin7Step3
4041
users_api = UsersApi(api_client=api_client)
4142

42-
results = users_api.get_user_ds_profile(
43+
(results, status, headers) = users_api.get_user_ds_profile_with_http_info(
4344
organization_id=org_id,
4445
user_id=user_id)
46+
47+
remaining = headers.get("X-RateLimit-Remaining")
48+
reset = headers.get("X-RateLimit-Reset")
49+
50+
if remaining is not None and reset is not None:
51+
reset_date = dt.fromtimestamp(int(reset), tz=timezone.utc)
52+
print(f"API calls remaining: {remaining}")
53+
print(f"Next Reset: {reset_date}")
4554
#ds-snippet-end:Admin7Step3
4655

4756
return results

‎app/admin/examples/eg008_update_user_product_permission_profile.py‎

Lines changed: 20 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
1+
from datetime import datetime as dt, timezone
12
from docusign_admin import (
23
ApiClient,
34
ProductPermissionProfilesApi,
@@ -33,10 +34,19 @@ def get_permission_profiles():
3334
)
3435

3536
product_permission_profiles_api = ProductPermissionProfilesApi(api_client=api_client)
36-
profiles = product_permission_profiles_api.get_product_permission_profiles(
37+
(profiles, status, headers) = product_permission_profiles_api.get_product_permission_profiles_with_http_info(
3738
organization_id=get_organization_id(),
3839
account_id=session["ds_account_id"]
3940
)
41+
42+
remaining = headers.get("X-RateLimit-Remaining")
43+
reset = headers.get("X-RateLimit-Reset")
44+
45+
if remaining is not None and reset is not None:
46+
reset_date = dt.fromtimestamp(int(reset), tz=timezone.utc)
47+
print(f"API calls remaining: {remaining}")
48+
print(f"Next Reset: {reset_date}")
49+
4050
profiles_list = profiles.to_dict()["product_permission_profiles"]
4151
return profiles_list
4252

@@ -76,11 +86,19 @@ def worker(self, args):
7686

7787
#ds-snippet-start:Admin8Step4
7888
product_permission_profiles_api = ProductPermissionProfilesApi(api_client=api_client)
79-
response = product_permission_profiles_api.add_user_product_permission_profiles_by_email(
89+
(response, status, headers) = product_permission_profiles_api.add_user_product_permission_profiles_by_email_with_http_info(
8090
organization_id=org_id,
8191
account_id=account_id,
8292
user_product_permission_profiles_request=user_product_permission_profile_request
8393
)
94+
95+
remaining = headers.get("X-RateLimit-Remaining")
96+
reset = headers.get("X-RateLimit-Reset")
97+
98+
if remaining is not None and reset is not None:
99+
reset_date = dt.fromtimestamp(int(reset), tz=timezone.utc)
100+
print(f"API calls remaining: {remaining}")
101+
print(f"Next Reset: {reset_date}")
84102
#ds-snippet-end:Admin8Step4
85103

86104
return response.to_dict()

0 commit comments

Comments
 (0)