Skip to content

Commit 52f962e

Browse files
Add example urls to sdk templates (#561)
2 parents f00994d + e37b1d4 commit 52f962e

79 files changed

Lines changed: 2290 additions & 1 deletion

Some content is hidden

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

sdks/dotnet/src/Dropbox.Sign/Api/AccountApi.cs

Lines changed: 32 additions & 0 deletions
Large diffs are not rendered by default.

sdks/dotnet/src/Dropbox.Sign/Api/ApiAppApi.cs

Lines changed: 40 additions & 0 deletions
Large diffs are not rendered by default.

sdks/dotnet/src/Dropbox.Sign/Api/BulkSendJobApi.cs

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,7 @@ public interface IBulkSendJobApiSync : IApiAccessor
3333
/// <remarks>
3434
/// Returns the status of the BulkSendJob and its SignatureRequests specified by the &#x60;bulk_send_job_id&#x60; parameter.
3535
/// </remarks>
36+
/// <example>https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/BulkSendJobGetExample.cs</example>
3637
/// <exception cref="Dropbox.Sign.Client.ApiException">Thrown when fails to make API call</exception>
3738
/// <param name="bulkSendJobId">The id of the BulkSendJob to retrieve.</param>
3839
/// <param name="page">Which page number of the BulkSendJob list to return. Defaults to &#x60;1&#x60;. (optional, default to 1)</param>
@@ -47,6 +48,7 @@ public interface IBulkSendJobApiSync : IApiAccessor
4748
/// <remarks>
4849
/// Returns the status of the BulkSendJob and its SignatureRequests specified by the &#x60;bulk_send_job_id&#x60; parameter.
4950
/// </remarks>
51+
/// <example>https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/BulkSendJobGetExample.cs</example>
5052
/// <exception cref="Dropbox.Sign.Client.ApiException">Thrown when fails to make API call</exception>
5153
/// <param name="bulkSendJobId">The id of the BulkSendJob to retrieve.</param>
5254
/// <param name="page">Which page number of the BulkSendJob list to return. Defaults to &#x60;1&#x60;. (optional, default to 1)</param>
@@ -60,6 +62,7 @@ public interface IBulkSendJobApiSync : IApiAccessor
6062
/// <remarks>
6163
/// Returns a list of BulkSendJob that you can access.
6264
/// </remarks>
65+
/// <example>https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/BulkSendJobListExample.cs</example>
6366
/// <exception cref="Dropbox.Sign.Client.ApiException">Thrown when fails to make API call</exception>
6467
/// <param name="page">Which page number of the BulkSendJob List to return. Defaults to &#x60;1&#x60;. (optional, default to 1)</param>
6568
/// <param name="pageSize">Number of objects to be returned per page. Must be between &#x60;1&#x60; and &#x60;100&#x60;. Default is 20. (optional, default to 20)</param>
@@ -73,6 +76,7 @@ public interface IBulkSendJobApiSync : IApiAccessor
7376
/// <remarks>
7477
/// Returns a list of BulkSendJob that you can access.
7578
/// </remarks>
79+
/// <example>https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/BulkSendJobListExample.cs</example>
7680
/// <exception cref="Dropbox.Sign.Client.ApiException">Thrown when fails to make API call</exception>
7781
/// <param name="page">Which page number of the BulkSendJob List to return. Defaults to &#x60;1&#x60;. (optional, default to 1)</param>
7882
/// <param name="pageSize">Number of objects to be returned per page. Must be between &#x60;1&#x60; and &#x60;100&#x60;. Default is 20. (optional, default to 20)</param>
@@ -94,6 +98,7 @@ public interface IBulkSendJobApiAsync : IApiAccessor
9498
/// <remarks>
9599
/// Returns the status of the BulkSendJob and its SignatureRequests specified by the &#x60;bulk_send_job_id&#x60; parameter.
96100
/// </remarks>
101+
/// <example>https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/BulkSendJobGetExample.cs</example>
97102
/// <exception cref="Dropbox.Sign.Client.ApiException">Thrown when fails to make API call</exception>
98103
/// <param name="bulkSendJobId">The id of the BulkSendJob to retrieve.</param>
99104
/// <param name="page">Which page number of the BulkSendJob list to return. Defaults to &#x60;1&#x60;. (optional, default to 1)</param>
@@ -109,6 +114,7 @@ public interface IBulkSendJobApiAsync : IApiAccessor
109114
/// <remarks>
110115
/// Returns the status of the BulkSendJob and its SignatureRequests specified by the &#x60;bulk_send_job_id&#x60; parameter.
111116
/// </remarks>
117+
/// <example>https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/BulkSendJobGetExample.cs</example>
112118
/// <exception cref="Dropbox.Sign.Client.ApiException">Thrown when fails to make API call</exception>
113119
/// <param name="bulkSendJobId">The id of the BulkSendJob to retrieve.</param>
114120
/// <param name="page">Which page number of the BulkSendJob list to return. Defaults to &#x60;1&#x60;. (optional, default to 1)</param>
@@ -123,6 +129,7 @@ public interface IBulkSendJobApiAsync : IApiAccessor
123129
/// <remarks>
124130
/// Returns a list of BulkSendJob that you can access.
125131
/// </remarks>
132+
/// <example>https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/BulkSendJobListExample.cs</example>
126133
/// <exception cref="Dropbox.Sign.Client.ApiException">Thrown when fails to make API call</exception>
127134
/// <param name="page">Which page number of the BulkSendJob List to return. Defaults to &#x60;1&#x60;. (optional, default to 1)</param>
128135
/// <param name="pageSize">Number of objects to be returned per page. Must be between &#x60;1&#x60; and &#x60;100&#x60;. Default is 20. (optional, default to 20)</param>
@@ -137,6 +144,7 @@ public interface IBulkSendJobApiAsync : IApiAccessor
137144
/// <remarks>
138145
/// Returns a list of BulkSendJob that you can access.
139146
/// </remarks>
147+
/// <example>https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/BulkSendJobListExample.cs</example>
140148
/// <exception cref="Dropbox.Sign.Client.ApiException">Thrown when fails to make API call</exception>
141149
/// <param name="page">Which page number of the BulkSendJob List to return. Defaults to &#x60;1&#x60;. (optional, default to 1)</param>
142150
/// <param name="pageSize">Number of objects to be returned per page. Must be between &#x60;1&#x60; and &#x60;100&#x60;. Default is 20. (optional, default to 20)</param>
@@ -267,6 +275,7 @@ public Dropbox.Sign.Client.ExceptionFactory ExceptionFactory
267275
/// <summary>
268276
/// Get Bulk Send Job Returns the status of the BulkSendJob and its SignatureRequests specified by the &#x60;bulk_send_job_id&#x60; parameter.
269277
/// </summary>
278+
/// <example>https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/BulkSendJobGetExample.cs</example>
270279
/// <exception cref="Dropbox.Sign.Client.ApiException">Thrown when fails to make API call</exception>
271280
/// <param name="bulkSendJobId">The id of the BulkSendJob to retrieve.</param>
272281
/// <param name="page">Which page number of the BulkSendJob list to return. Defaults to &#x60;1&#x60;. (optional, default to 1)</param>
@@ -282,6 +291,7 @@ public Dropbox.Sign.Client.ExceptionFactory ExceptionFactory
282291
/// <summary>
283292
/// Get Bulk Send Job Returns the status of the BulkSendJob and its SignatureRequests specified by the &#x60;bulk_send_job_id&#x60; parameter.
284293
/// </summary>
294+
/// <example>https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/BulkSendJobGetExample.cs</example>
285295
/// <exception cref="Dropbox.Sign.Client.ApiException">Thrown when fails to make API call</exception>
286296
/// <param name="bulkSendJobId">The id of the BulkSendJob to retrieve.</param>
287297
/// <param name="page">Which page number of the BulkSendJob list to return. Defaults to &#x60;1&#x60;. (optional, default to 1)</param>
@@ -361,6 +371,7 @@ public Dropbox.Sign.Client.ExceptionFactory ExceptionFactory
361371
/// <summary>
362372
/// Get Bulk Send Job Returns the status of the BulkSendJob and its SignatureRequests specified by the &#x60;bulk_send_job_id&#x60; parameter.
363373
/// </summary>
374+
/// <example>https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/BulkSendJobGetExample.cs</example>
364375
/// <exception cref="Dropbox.Sign.Client.ApiException">Thrown when fails to make API call</exception>
365376
/// <param name="bulkSendJobId">The id of the BulkSendJob to retrieve.</param>
366377
/// <param name="page">Which page number of the BulkSendJob list to return. Defaults to &#x60;1&#x60;. (optional, default to 1)</param>
@@ -377,6 +388,7 @@ public Dropbox.Sign.Client.ExceptionFactory ExceptionFactory
377388
/// <summary>
378389
/// Get Bulk Send Job Returns the status of the BulkSendJob and its SignatureRequests specified by the &#x60;bulk_send_job_id&#x60; parameter.
379390
/// </summary>
391+
/// <example>https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/BulkSendJobGetExample.cs</example>
380392
/// <exception cref="Dropbox.Sign.Client.ApiException">Thrown when fails to make API call</exception>
381393
/// <param name="bulkSendJobId">The id of the BulkSendJob to retrieve.</param>
382394
/// <param name="page">Which page number of the BulkSendJob list to return. Defaults to &#x60;1&#x60;. (optional, default to 1)</param>
@@ -459,6 +471,7 @@ public Dropbox.Sign.Client.ExceptionFactory ExceptionFactory
459471
/// <summary>
460472
/// List Bulk Send Jobs Returns a list of BulkSendJob that you can access.
461473
/// </summary>
474+
/// <example>https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/BulkSendJobListExample.cs</example>
462475
/// <exception cref="Dropbox.Sign.Client.ApiException">Thrown when fails to make API call</exception>
463476
/// <param name="page">Which page number of the BulkSendJob List to return. Defaults to &#x60;1&#x60;. (optional, default to 1)</param>
464477
/// <param name="pageSize">Number of objects to be returned per page. Must be between &#x60;1&#x60; and &#x60;100&#x60;. Default is 20. (optional, default to 20)</param>
@@ -473,6 +486,7 @@ public Dropbox.Sign.Client.ExceptionFactory ExceptionFactory
473486
/// <summary>
474487
/// List Bulk Send Jobs Returns a list of BulkSendJob that you can access.
475488
/// </summary>
489+
/// <example>https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/BulkSendJobListExample.cs</example>
476490
/// <exception cref="Dropbox.Sign.Client.ApiException">Thrown when fails to make API call</exception>
477491
/// <param name="page">Which page number of the BulkSendJob List to return. Defaults to &#x60;1&#x60;. (optional, default to 1)</param>
478492
/// <param name="pageSize">Number of objects to be returned per page. Must be between &#x60;1&#x60; and &#x60;100&#x60;. Default is 20. (optional, default to 20)</param>
@@ -544,6 +558,7 @@ public Dropbox.Sign.Client.ExceptionFactory ExceptionFactory
544558
/// <summary>
545559
/// List Bulk Send Jobs Returns a list of BulkSendJob that you can access.
546560
/// </summary>
561+
/// <example>https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/BulkSendJobListExample.cs</example>
547562
/// <exception cref="Dropbox.Sign.Client.ApiException">Thrown when fails to make API call</exception>
548563
/// <param name="page">Which page number of the BulkSendJob List to return. Defaults to &#x60;1&#x60;. (optional, default to 1)</param>
549564
/// <param name="pageSize">Number of objects to be returned per page. Must be between &#x60;1&#x60; and &#x60;100&#x60;. Default is 20. (optional, default to 20)</param>
@@ -559,6 +574,7 @@ public Dropbox.Sign.Client.ExceptionFactory ExceptionFactory
559574
/// <summary>
560575
/// List Bulk Send Jobs Returns a list of BulkSendJob that you can access.
561576
/// </summary>
577+
/// <example>https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/BulkSendJobListExample.cs</example>
562578
/// <exception cref="Dropbox.Sign.Client.ApiException">Thrown when fails to make API call</exception>
563579
/// <param name="page">Which page number of the BulkSendJob List to return. Defaults to &#x60;1&#x60;. (optional, default to 1)</param>
564580
/// <param name="pageSize">Number of objects to be returned per page. Must be between &#x60;1&#x60; and &#x60;100&#x60;. Default is 20. (optional, default to 20)</param>

0 commit comments

Comments
 (0)