Skip to content

Commit 7b49a65

Browse files
committed
Updating all code examples to use withHttpInfo() methods to get API call limits information
1 parent f2c4c10 commit 7b49a65

File tree

82 files changed

+1676
-218
lines changed

Some content is hidden

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

82 files changed

+1676
-218
lines changed

JWT-Console/JWT-Console.csproj

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@
2929
</ItemGroup>
3030

3131
<ItemGroup>
32-
<PackageReference Include="DocuSign.eSign.dll" Version="8.4.0" />
32+
<PackageReference Include="DocuSign.eSign.dll" Version="8.5.0" />
3333
<PackageReference Include="System.Configuration.ConfigurationManager" Version="7.0.0" />
3434
<PackageReference Include="System.Runtime.Caching" Version="7.0.0" />
3535
</ItemGroup>

Quick_ACG/Quick_ACG.csproj

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@
4848

4949
<ItemGroup>
5050
<PackageReference Include="DocuSign.Admin" Version="2.0.2" />
51-
<PackageReference Include="DocuSign.eSign.dll" Version="8.4.0" />
51+
<PackageReference Include="DocuSign.eSign.dll" Version="8.5.0" />
5252
<PackageReference Include="Microsoft.AspNetCore.Session" Version="2.3.0" />
5353
<PackageReference Include="Microsoft.EntityFrameworkCore.SqlServer" Version="8.0.10" />
5454
<PackageReference Include="Microsoft.EntityFrameworkCore.Tools" Version="8.0.10">

README.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,7 @@ When the token expires, the user is asked to re-authenticate. The refresh token
2525
* Authentication with Docusign via [JSON Web Token (JWT) Grant](https://developers.docusign.com/platform/auth/jwt/).
2626
When the token expires, it updates automatically.
2727

28+
2829
## eSignature API
2930

3031
For more information about the scopes used for obtaining authorization to use the eSignature API, see [Required scopes](https://developers.docusign.com/docs/esign-rest-api/esign101/auth#required-scopes).

launcher-csharp.Tests/launcher-csharp.Tests.csproj

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@
2525

2626
<ItemGroup>
2727
<PackageReference Include="DocuSign.Admin" Version="2.0.2" />
28-
<PackageReference Include="DocuSign.eSign.dll" Version="8.4.0" />
28+
<PackageReference Include="DocuSign.eSign.dll" Version="8.5.0" />
2929
<PackageReference Include="FluentAssertions" Version="8.4.0" />
3030
<PackageReference Include="Microsoft.NET.Test.Sdk" Version="17.10.0" />
3131
<PackageReference Include="xunit" Version="2.9.3" />

launcher-csharp/Admin/Examples/AuditUsers.cs

Lines changed: 24 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -35,19 +35,40 @@ public static IEnumerable<UserDrilldownResponse> GetRecentlyModifiedUsersData(st
3535
lastModifiedSince = DateTime.Today.AddDays(tenDaysAgo).ToString("yyyy-MM-dd"),
3636
};
3737

38-
var recentlyModifiedUsers = usersApi.GetUsers(orgId, getUsersOptions);
38+
var recentlyModifiedUsers = usersApi.GetUsersWithHttpInfo(orgId, getUsersOptions);
39+
recentlyModifiedUsers.Headers.TryGetValue("X-RateLimit-Remaining", out string remaining);
40+
recentlyModifiedUsers.Headers.TryGetValue("X-RateLimit-Reset", out string reset);
41+
42+
if (reset != null && remaining != null)
43+
{
44+
DateTime resetDate = DateTimeOffset.FromUnixTimeSeconds(long.Parse(reset)).UtcDateTime;
45+
Console.WriteLine("API calls remaining: " + remaining);
46+
Console.WriteLine("Next Reset: " + resetDate);
47+
}
48+
3949
//ds-snippet-end:Admin5Step3
4050

4151
//ds-snippet-start:Admin5Step5
4252
var usersData = new List<UserDrilldownResponse>();
4353
//ds-snippet-end:Admin5Step5
4454
//ds-snippet-start:Admin5Step4
45-
foreach (var user in recentlyModifiedUsers.Users)
55+
foreach (var user in recentlyModifiedUsers.Data.Users)
4656
{
4757
var getUserProfilesOptions = new UsersApi.GetUserProfilesOptions { email = user.Email };
4858
//ds-snippet-end:Admin5Step4
4959
//ds-snippet-start:Admin5Step5
50-
usersData.AddRange(usersApi.GetUserProfiles(orgId, getUserProfilesOptions).Users);
60+
var users = usersApi.GetUserProfilesWithHttpInfo(orgId, getUserProfilesOptions);
61+
users.Headers.TryGetValue("X-RateLimit-Remaining", out remaining);
62+
users.Headers.TryGetValue("X-RateLimit-Reset", out reset);
63+
64+
if (reset != null && remaining != null)
65+
{
66+
DateTime resetDate = DateTimeOffset.FromUnixTimeSeconds(long.Parse(reset)).UtcDateTime;
67+
Console.WriteLine("API calls remaining: " + remaining);
68+
Console.WriteLine("Next Reset: " + resetDate);
69+
}
70+
71+
usersData.AddRange(users.Data.Users);
5172
//ds-snippet-end:Admin5Step5
5273
}
5374

launcher-csharp/Admin/Examples/BulkExportUserData.cs

Lines changed: 33 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -41,29 +41,48 @@ public static OrganizationExportResponse CreateBulkExportRequest(
4141
Type = "organization_memberships_export",
4242
};
4343

44-
var exportResponse = bulkExportsApi.CreateUserListExport(organizationId, organizationExportRequest);
44+
var exportResponse = bulkExportsApi.CreateUserListExportWithHttpInfo(organizationId, organizationExportRequest);
45+
exportResponse.Headers.TryGetValue("X-RateLimit-Remaining", out string remaining);
46+
exportResponse.Headers.TryGetValue("X-RateLimit-Reset", out string reset);
47+
48+
if (reset != null && remaining != null)
49+
{
50+
DateTime resetDate = DateTimeOffset.FromUnixTimeSeconds(long.Parse(reset)).UtcDateTime;
51+
Console.WriteLine("API calls remaining: " + remaining);
52+
Console.WriteLine("Next Reset: " + resetDate);
53+
}
54+
4555
//ds-snippet-end:Admin3Step3
4656

4757
//ds-snippet-start:Admin3Step4
4858
int retryCount = 5;
4959

5060
while (retryCount >= 0)
5161
{
52-
if (exportResponse.Results != null)
62+
if (exportResponse.Data.Results != null)
5363
{
54-
GetUserData(accessToken, exportResponse.Results.FirstOrDefault().Url, filePath);
64+
GetUserData(accessToken, exportResponse.Data.Results.FirstOrDefault().Url, filePath);
5565
break;
5666
}
5767
else
5868
{
5969
--retryCount;
6070
System.Threading.Thread.Sleep(5000);
61-
exportResponse = bulkExportsApi.GetUserListExport(organizationId, exportResponse.Id);
71+
exportResponse = bulkExportsApi.GetUserListExportWithHttpInfo(organizationId, exportResponse.Data.Id);
72+
exportResponse.Headers.TryGetValue("X-RateLimit-Remaining", out remaining);
73+
exportResponse.Headers.TryGetValue("X-RateLimit-Reset", out reset);
74+
75+
if (reset != null && remaining != null)
76+
{
77+
DateTime resetDate = DateTimeOffset.FromUnixTimeSeconds(long.Parse(reset)).UtcDateTime;
78+
Console.WriteLine("API calls remaining: " + remaining);
79+
Console.WriteLine("Next Reset: " + resetDate);
80+
}
6281
}
6382
}
6483

6584
//ds-snippet-end:Admin3Step4
66-
return exportResponse;
85+
return exportResponse.Data;
6786
}
6887

6988
/// <summary>
@@ -92,6 +111,15 @@ private static void GetUserData(string accessToken, string csvUrl, string filePa
92111
request.AllowWriteStreamBuffering = false;
93112

94113
response = (HttpWebResponse)request.GetResponse();
114+
string remaining = response.Headers.Get("X-RateLimit-Remaining");
115+
string reset = response.Headers.Get("X-RateLimit-Reset");
116+
117+
if (reset != null && remaining != null)
118+
{
119+
DateTime resetDate = DateTimeOffset.FromUnixTimeSeconds(long.Parse(reset)).UtcDateTime;
120+
Console.WriteLine("API calls remaining: " + remaining);
121+
Console.WriteLine("Next Reset: " + resetDate);
122+
}
95123

96124
Stream stream = response.GetResponseStream();
97125

launcher-csharp/Admin/Examples/CloneAccount.cs

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,18 @@ public static AssetGroupAccountsResponse GetGroupAccounts(string basePath, strin
3333
compliant = true,
3434
};
3535

36-
return assetGroupApi.GetAssetGroupAccounts(orgId, options);
36+
var response = assetGroupApi.GetAssetGroupAccountsWithHttpInfo(orgId, options);
37+
response.Headers.TryGetValue("X-RateLimit-Remaining", out string remaining);
38+
response.Headers.TryGetValue("X-RateLimit-Reset", out string reset);
39+
40+
if (reset != null && remaining != null)
41+
{
42+
DateTime resetDate = DateTimeOffset.FromUnixTimeSeconds(long.Parse(reset)).UtcDateTime;
43+
Console.WriteLine("API calls remaining: " + remaining);
44+
Console.WriteLine("Next Reset: " + resetDate);
45+
}
46+
47+
return response.Data;
3748
//ds-snippet-end:Admin12Step3
3849
}
3950

launcher-csharp/Admin/Examples/CreateAccount.cs

Lines changed: 24 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,18 @@ public static OrganizationSubscriptionResponse GetFirstPlanItem(
3636
//ds-snippet-end:Admin13Step2
3737

3838
//ds-snippet-start:Admin13Step3
39-
return assetGroupApi.GetOrganizationPlanItems(orgId).FirstOrDefault();
39+
var response = assetGroupApi.GetOrganizationPlanItemsWithHttpInfo(orgId);
40+
response.Headers.TryGetValue("X-RateLimit-Remaining", out string remaining);
41+
response.Headers.TryGetValue("X-RateLimit-Reset", out string reset);
42+
43+
if (reset != null && remaining != null)
44+
{
45+
DateTime resetDate = DateTimeOffset.FromUnixTimeSeconds(long.Parse(reset)).UtcDateTime;
46+
Console.WriteLine("API calls remaining: " + remaining);
47+
Console.WriteLine("Next Reset: " + resetDate);
48+
}
49+
50+
return response.Data.FirstOrDefault();
4051
//ds-snippet-end:Admin13Step3
4152
}
4253

@@ -70,7 +81,18 @@ public static SubscriptionProvisionModelAssetGroupWorkResult CreateAccountBySubs
7081
//ds-snippet-end:Admin13Step4
7182

7283
//ds-snippet-start:Admin13Step5
73-
return assetGroupApi.CreateAssetGroupAccount(orgId, subAccountRequest);
84+
var response = assetGroupApi.CreateAssetGroupAccountWithHttpInfo(orgId, subAccountRequest);
85+
response.Headers.TryGetValue("X-RateLimit-Remaining", out string remaining);
86+
response.Headers.TryGetValue("X-RateLimit-Reset", out string reset);
87+
88+
if (reset != null && remaining != null)
89+
{
90+
DateTime resetDate = DateTimeOffset.FromUnixTimeSeconds(long.Parse(reset)).UtcDateTime;
91+
Console.WriteLine("API calls remaining: " + remaining);
92+
Console.WriteLine("Next Reset: " + resetDate);
93+
}
94+
95+
return response.Data;
7496
//ds-snippet-end:Admin13Step5
7597
}
7698

launcher-csharp/Admin/Examples/CreateCLMESignUser.cs

Lines changed: 12 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -51,10 +51,20 @@ public static AddUserResponse Create(string userName, string firstName, string l
5151
//ds-snippet-end:Admin2Step5
5252

5353
//ds-snippet-start:Admin2Step6
54-
AddUserResponse response = usersApi.AddOrUpdateUser(orgId, accountId, newMultiProductUserAddRequest);
54+
var response = usersApi.AddOrUpdateUserWithHttpInfo(orgId, accountId, newMultiProductUserAddRequest);
55+
response.Headers.TryGetValue("X-RateLimit-Remaining", out string remaining);
56+
response.Headers.TryGetValue("X-RateLimit-Reset", out string reset);
57+
58+
if (reset != null && remaining != null)
59+
{
60+
DateTime resetDate = DateTimeOffset.FromUnixTimeSeconds(long.Parse(reset)).UtcDateTime;
61+
Console.WriteLine("API calls remaining: " + remaining);
62+
Console.WriteLine("Next Reset: " + resetDate);
63+
}
64+
5565
//ds-snippet-end:Admin2Step6
5666

57-
return response;
67+
return response.Data;
5868
}
5969
}
6070
}

launcher-csharp/Admin/Examples/CreateUser.cs

Lines changed: 24 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,18 @@ public static NewUserResponse CreateNewUser(
5656
lastName,
5757
userName);
5858

59-
return usersApi.CreateUser(organizationId, newUserRequest);
59+
var response = usersApi.CreateUserWithHttpInfo(organizationId, newUserRequest);
60+
response.Headers.TryGetValue("X-RateLimit-Remaining", out string remaining);
61+
response.Headers.TryGetValue("X-RateLimit-Reset", out string reset);
62+
63+
if (reset != null && remaining != null)
64+
{
65+
DateTime resetDate = DateTimeOffset.FromUnixTimeSeconds(long.Parse(reset)).UtcDateTime;
66+
Console.WriteLine("API calls remaining: " + remaining);
67+
Console.WriteLine("Next Reset: " + resetDate);
68+
}
69+
70+
return response.Data;
6071
//ds-snippet-end:Admin1Step6
6172
}
6273

@@ -80,9 +91,19 @@ public static (PermissionProfileInformation, GroupInformation) GetPermissionProf
8091

8192
//ds-snippet-start:Admin1Step4
8293
var dsGroupsApi = new GroupsApi(docuSignClient);
83-
var groups = dsGroupsApi.ListGroups(accountId);
94+
var groups = dsGroupsApi.ListGroupsWithHttpInfo(accountId);
95+
groups.Headers.TryGetValue("X-RateLimit-Remaining", out string remaining);
96+
groups.Headers.TryGetValue("X-RateLimit-Reset", out string reset);
97+
98+
if (reset != null && remaining != null)
99+
{
100+
DateTime resetDate = DateTimeOffset.FromUnixTimeSeconds(long.Parse(reset)).UtcDateTime;
101+
Console.WriteLine("API calls remaining: " + remaining);
102+
Console.WriteLine("Next Reset: " + resetDate);
103+
}
104+
84105
//ds-snippet-end:Admin1Step4
85-
return (permissionProfiles, groups);
106+
return (permissionProfiles, groups.Data);
86107
}
87108

88109
/// <summary>

0 commit comments

Comments
 (0)