Skip to content

[SIGN-15721] Add example URL to SDK source docstrings #557

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
suchcicki-dropbox wants to merge 2 commits into
base: main
Choose a base branch
from
Draft

[SIGN-15721] Add example URL to SDK source docstrings #557

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a38b2b1
[SIGN-15721] Add example URLs to SDK templates
suchcicki-dropbox Aug 27, 2026
8102251
[SIGN-15721] Regenerate SDK sources
suchcicki-dropbox Aug 27, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
32 changes: 32 additions & 0 deletions sdks/dotnet/src/Dropbox.Sign/Api/AccountApi.cs
View file
Open in desktop

Large diffs are not rendered by default.

40 changes: 40 additions & 0 deletions sdks/dotnet/src/Dropbox.Sign/Api/ApiAppApi.cs
View file
Open in desktop

Large diffs are not rendered by default.

16 changes: 16 additions & 0 deletions sdks/dotnet/src/Dropbox.Sign/Api/BulkSendJobApi.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,7 @@ public interface IBulkSendJobApiSync : IApiAccessor
/// <remarks>
/// Returns the status of the BulkSendJob and its SignatureRequests specified by the &#x60;bulk_send_job_id&#x60; parameter.
/// </remarks>
/// <example>https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/BulkSendJobGetExample.cs</example>
/// <exception cref="Dropbox.Sign.Client.ApiException">Thrown when fails to make API call</exception>
/// <param name="bulkSendJobId">The id of the BulkSendJob to retrieve.</param>
/// <param name="page">Which page number of the BulkSendJob list to return. Defaults to &#x60;1&#x60;. (optional, default to 1)</param>
Expand All @@ -47,6 +48,7 @@ public interface IBulkSendJobApiSync : IApiAccessor
/// <remarks>
/// Returns the status of the BulkSendJob and its SignatureRequests specified by the &#x60;bulk_send_job_id&#x60; parameter.
/// </remarks>
/// <example>https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/BulkSendJobGetExample.cs</example>
/// <exception cref="Dropbox.Sign.Client.ApiException">Thrown when fails to make API call</exception>
/// <param name="bulkSendJobId">The id of the BulkSendJob to retrieve.</param>
/// <param name="page">Which page number of the BulkSendJob list to return. Defaults to &#x60;1&#x60;. (optional, default to 1)</param>
Expand All @@ -60,6 +62,7 @@ public interface IBulkSendJobApiSync : IApiAccessor
/// <remarks>
/// Returns a list of BulkSendJob that you can access.
/// </remarks>
/// <example>https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/BulkSendJobListExample.cs</example>
/// <exception cref="Dropbox.Sign.Client.ApiException">Thrown when fails to make API call</exception>
/// <param name="page">Which page number of the BulkSendJob List to return. Defaults to &#x60;1&#x60;. (optional, default to 1)</param>
/// <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>
Expand All @@ -73,6 +76,7 @@ public interface IBulkSendJobApiSync : IApiAccessor
/// <remarks>
/// Returns a list of BulkSendJob that you can access.
/// </remarks>
/// <example>https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/BulkSendJobListExample.cs</example>
/// <exception cref="Dropbox.Sign.Client.ApiException">Thrown when fails to make API call</exception>
/// <param name="page">Which page number of the BulkSendJob List to return. Defaults to &#x60;1&#x60;. (optional, default to 1)</param>
/// <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>
Expand All @@ -94,6 +98,7 @@ public interface IBulkSendJobApiAsync : IApiAccessor
/// <remarks>
/// Returns the status of the BulkSendJob and its SignatureRequests specified by the &#x60;bulk_send_job_id&#x60; parameter.
/// </remarks>
/// <example>https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/BulkSendJobGetExample.cs</example>
/// <exception cref="Dropbox.Sign.Client.ApiException">Thrown when fails to make API call</exception>
/// <param name="bulkSendJobId">The id of the BulkSendJob to retrieve.</param>
/// <param name="page">Which page number of the BulkSendJob list to return. Defaults to &#x60;1&#x60;. (optional, default to 1)</param>
Expand All @@ -109,6 +114,7 @@ public interface IBulkSendJobApiAsync : IApiAccessor
/// <remarks>
/// Returns the status of the BulkSendJob and its SignatureRequests specified by the &#x60;bulk_send_job_id&#x60; parameter.
/// </remarks>
/// <example>https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/BulkSendJobGetExample.cs</example>
/// <exception cref="Dropbox.Sign.Client.ApiException">Thrown when fails to make API call</exception>
/// <param name="bulkSendJobId">The id of the BulkSendJob to retrieve.</param>
/// <param name="page">Which page number of the BulkSendJob list to return. Defaults to &#x60;1&#x60;. (optional, default to 1)</param>
Expand All @@ -123,6 +129,7 @@ public interface IBulkSendJobApiAsync : IApiAccessor
/// <remarks>
/// Returns a list of BulkSendJob that you can access.
/// </remarks>
/// <example>https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/BulkSendJobListExample.cs</example>
/// <exception cref="Dropbox.Sign.Client.ApiException">Thrown when fails to make API call</exception>
/// <param name="page">Which page number of the BulkSendJob List to return. Defaults to &#x60;1&#x60;. (optional, default to 1)</param>
/// <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>
Expand All @@ -137,6 +144,7 @@ public interface IBulkSendJobApiAsync : IApiAccessor
/// <remarks>
/// Returns a list of BulkSendJob that you can access.
/// </remarks>
/// <example>https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/BulkSendJobListExample.cs</example>
/// <exception cref="Dropbox.Sign.Client.ApiException">Thrown when fails to make API call</exception>
/// <param name="page">Which page number of the BulkSendJob List to return. Defaults to &#x60;1&#x60;. (optional, default to 1)</param>
/// <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>
Expand Down Expand Up @@ -267,6 +275,7 @@ public Dropbox.Sign.Client.ExceptionFactory ExceptionFactory
/// <summary>
/// Get Bulk Send Job Returns the status of the BulkSendJob and its SignatureRequests specified by the &#x60;bulk_send_job_id&#x60; parameter.
/// </summary>
/// <example>https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/BulkSendJobGetExample.cs</example>
/// <exception cref="Dropbox.Sign.Client.ApiException">Thrown when fails to make API call</exception>
/// <param name="bulkSendJobId">The id of the BulkSendJob to retrieve.</param>
/// <param name="page">Which page number of the BulkSendJob list to return. Defaults to &#x60;1&#x60;. (optional, default to 1)</param>
Expand All @@ -282,6 +291,7 @@ public Dropbox.Sign.Client.ExceptionFactory ExceptionFactory
/// <summary>
/// Get Bulk Send Job Returns the status of the BulkSendJob and its SignatureRequests specified by the &#x60;bulk_send_job_id&#x60; parameter.
/// </summary>
/// <example>https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/BulkSendJobGetExample.cs</example>
/// <exception cref="Dropbox.Sign.Client.ApiException">Thrown when fails to make API call</exception>
/// <param name="bulkSendJobId">The id of the BulkSendJob to retrieve.</param>
/// <param name="page">Which page number of the BulkSendJob list to return. Defaults to &#x60;1&#x60;. (optional, default to 1)</param>
Expand Down Expand Up @@ -361,6 +371,7 @@ public Dropbox.Sign.Client.ExceptionFactory ExceptionFactory
/// <summary>
/// Get Bulk Send Job Returns the status of the BulkSendJob and its SignatureRequests specified by the &#x60;bulk_send_job_id&#x60; parameter.
/// </summary>
/// <example>https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/BulkSendJobGetExample.cs</example>
/// <exception cref="Dropbox.Sign.Client.ApiException">Thrown when fails to make API call</exception>
/// <param name="bulkSendJobId">The id of the BulkSendJob to retrieve.</param>
/// <param name="page">Which page number of the BulkSendJob list to return. Defaults to &#x60;1&#x60;. (optional, default to 1)</param>
Expand All @@ -377,6 +388,7 @@ public Dropbox.Sign.Client.ExceptionFactory ExceptionFactory
/// <summary>
/// Get Bulk Send Job Returns the status of the BulkSendJob and its SignatureRequests specified by the &#x60;bulk_send_job_id&#x60; parameter.
/// </summary>
/// <example>https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/BulkSendJobGetExample.cs</example>
/// <exception cref="Dropbox.Sign.Client.ApiException">Thrown when fails to make API call</exception>
/// <param name="bulkSendJobId">The id of the BulkSendJob to retrieve.</param>
/// <param name="page">Which page number of the BulkSendJob list to return. Defaults to &#x60;1&#x60;. (optional, default to 1)</param>
Expand Down Expand Up @@ -459,6 +471,7 @@ public Dropbox.Sign.Client.ExceptionFactory ExceptionFactory
/// <summary>
/// List Bulk Send Jobs Returns a list of BulkSendJob that you can access.
/// </summary>
/// <example>https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/BulkSendJobListExample.cs</example>
/// <exception cref="Dropbox.Sign.Client.ApiException">Thrown when fails to make API call</exception>
/// <param name="page">Which page number of the BulkSendJob List to return. Defaults to &#x60;1&#x60;. (optional, default to 1)</param>
/// <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>
Expand All @@ -473,6 +486,7 @@ public Dropbox.Sign.Client.ExceptionFactory ExceptionFactory
/// <summary>
/// List Bulk Send Jobs Returns a list of BulkSendJob that you can access.
/// </summary>
/// <example>https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/BulkSendJobListExample.cs</example>
/// <exception cref="Dropbox.Sign.Client.ApiException">Thrown when fails to make API call</exception>
/// <param name="page">Which page number of the BulkSendJob List to return. Defaults to &#x60;1&#x60;. (optional, default to 1)</param>
/// <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>
Expand Down Expand Up @@ -544,6 +558,7 @@ public Dropbox.Sign.Client.ExceptionFactory ExceptionFactory
/// <summary>
/// List Bulk Send Jobs Returns a list of BulkSendJob that you can access.
/// </summary>
/// <example>https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/BulkSendJobListExample.cs</example>
/// <exception cref="Dropbox.Sign.Client.ApiException">Thrown when fails to make API call</exception>
/// <param name="page">Which page number of the BulkSendJob List to return. Defaults to &#x60;1&#x60;. (optional, default to 1)</param>
/// <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>
Expand All @@ -559,6 +574,7 @@ public Dropbox.Sign.Client.ExceptionFactory ExceptionFactory
/// <summary>
/// List Bulk Send Jobs Returns a list of BulkSendJob that you can access.
/// </summary>
/// <example>https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/BulkSendJobListExample.cs</example>
/// <exception cref="Dropbox.Sign.Client.ApiException">Thrown when fails to make API call</exception>
/// <param name="page">Which page number of the BulkSendJob List to return. Defaults to &#x60;1&#x60;. (optional, default to 1)</param>
/// <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>
Expand Down
Loading
Loading