diff --git a/sdks/dotnet/src/Dropbox.Sign/Api/AccountApi.cs b/sdks/dotnet/src/Dropbox.Sign/Api/AccountApi.cs index 0e70ee233..1a06b0003 100644 --- a/sdks/dotnet/src/Dropbox.Sign/Api/AccountApi.cs +++ b/sdks/dotnet/src/Dropbox.Sign/Api/AccountApi.cs @@ -33,6 +33,7 @@ public interface IAccountApiSync : IApiAccessor /// /// Creates a new Dropbox Sign Account that is associated with the specified `email_address`. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/AccountCreateExample.cs /// Thrown when fails to make API call /// /// Index associated with the operation. @@ -45,6 +46,7 @@ public interface IAccountApiSync : IApiAccessor /// /// Creates a new Dropbox Sign Account that is associated with the specified `email_address`. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/AccountCreateExample.cs /// Thrown when fails to make API call /// /// Index associated with the operation. @@ -56,6 +58,7 @@ public interface IAccountApiSync : IApiAccessor /// /// Returns the properties and settings of your Account. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/AccountGetExample.cs /// Thrown when fails to make API call /// `account_id` or `email_address` is required. If both are provided, the account id prevails. The ID of the Account. (optional) /// `account_id` or `email_address` is required, If both are provided, the account id prevails. The email address of the Account. (optional) @@ -69,6 +72,7 @@ public interface IAccountApiSync : IApiAccessor /// /// Returns the properties and settings of your Account. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/AccountGetExample.cs /// Thrown when fails to make API call /// `account_id` or `email_address` is required. If both are provided, the account id prevails. The ID of the Account. (optional) /// `account_id` or `email_address` is required, If both are provided, the account id prevails. The email address of the Account. (optional) @@ -81,6 +85,7 @@ public interface IAccountApiSync : IApiAccessor /// /// Updates the properties and settings of your Account. Currently only allows for updates to the [Callback URL](/api/reference/tag/Callbacks-and-Events) and locale. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/AccountUpdateExample.cs /// Thrown when fails to make API call /// /// Index associated with the operation. @@ -93,6 +98,7 @@ public interface IAccountApiSync : IApiAccessor /// /// Updates the properties and settings of your Account. Currently only allows for updates to the [Callback URL](/api/reference/tag/Callbacks-and-Events) and locale. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/AccountUpdateExample.cs /// Thrown when fails to make API call /// /// Index associated with the operation. @@ -104,6 +110,7 @@ public interface IAccountApiSync : IApiAccessor /// /// Verifies whether an Dropbox Sign Account exists for the given email address. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/AccountVerifyExample.cs /// Thrown when fails to make API call /// /// Index associated with the operation. @@ -116,6 +123,7 @@ public interface IAccountApiSync : IApiAccessor /// /// Verifies whether an Dropbox Sign Account exists for the given email address. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/AccountVerifyExample.cs /// Thrown when fails to make API call /// /// Index associated with the operation. @@ -136,6 +144,7 @@ public interface IAccountApiAsync : IApiAccessor /// /// Creates a new Dropbox Sign Account that is associated with the specified `email_address`. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/AccountCreateExample.cs /// Thrown when fails to make API call /// /// Index associated with the operation. @@ -149,6 +158,7 @@ public interface IAccountApiAsync : IApiAccessor /// /// Creates a new Dropbox Sign Account that is associated with the specified `email_address`. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/AccountCreateExample.cs /// Thrown when fails to make API call /// /// Index associated with the operation. @@ -161,6 +171,7 @@ public interface IAccountApiAsync : IApiAccessor /// /// Returns the properties and settings of your Account. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/AccountGetExample.cs /// Thrown when fails to make API call /// `account_id` or `email_address` is required. If both are provided, the account id prevails. The ID of the Account. (optional) /// `account_id` or `email_address` is required, If both are provided, the account id prevails. The email address of the Account. (optional) @@ -175,6 +186,7 @@ public interface IAccountApiAsync : IApiAccessor /// /// Returns the properties and settings of your Account. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/AccountGetExample.cs /// Thrown when fails to make API call /// `account_id` or `email_address` is required. If both are provided, the account id prevails. The ID of the Account. (optional) /// `account_id` or `email_address` is required, If both are provided, the account id prevails. The email address of the Account. (optional) @@ -188,6 +200,7 @@ public interface IAccountApiAsync : IApiAccessor /// /// Updates the properties and settings of your Account. Currently only allows for updates to the [Callback URL](/api/reference/tag/Callbacks-and-Events) and locale. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/AccountUpdateExample.cs /// Thrown when fails to make API call /// /// Index associated with the operation. @@ -201,6 +214,7 @@ public interface IAccountApiAsync : IApiAccessor /// /// Updates the properties and settings of your Account. Currently only allows for updates to the [Callback URL](/api/reference/tag/Callbacks-and-Events) and locale. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/AccountUpdateExample.cs /// Thrown when fails to make API call /// /// Index associated with the operation. @@ -213,6 +227,7 @@ public interface IAccountApiAsync : IApiAccessor /// /// Verifies whether an Dropbox Sign Account exists for the given email address. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/AccountVerifyExample.cs /// Thrown when fails to make API call /// /// Index associated with the operation. @@ -226,6 +241,7 @@ public interface IAccountApiAsync : IApiAccessor /// /// Verifies whether an Dropbox Sign Account exists for the given email address. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/AccountVerifyExample.cs /// Thrown when fails to make API call /// /// Index associated with the operation. @@ -355,6 +371,7 @@ public Dropbox.Sign.Client.ExceptionFactory ExceptionFactory /// /// Create Account Creates a new Dropbox Sign Account that is associated with the specified `email_address`. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/AccountCreateExample.cs /// Thrown when fails to make API call /// /// Index associated with the operation. @@ -368,6 +385,7 @@ public AccountCreateResponse AccountCreate(AccountCreateRequest accountCreateReq /// /// Create Account Creates a new Dropbox Sign Account that is associated with the specified `email_address`. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/AccountCreateExample.cs /// Thrown when fails to make API call /// /// Index associated with the operation. @@ -445,6 +463,7 @@ public Dropbox.Sign.Client.ApiResponse AccountCreateWithH /// /// Create Account Creates a new Dropbox Sign Account that is associated with the specified `email_address`. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/AccountCreateExample.cs /// Thrown when fails to make API call /// /// Index associated with the operation. @@ -459,6 +478,7 @@ public Dropbox.Sign.Client.ApiResponse AccountCreateWithH /// /// Create Account Creates a new Dropbox Sign Account that is associated with the specified `email_address`. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/AccountCreateExample.cs /// Thrown when fails to make API call /// /// Index associated with the operation. @@ -539,6 +559,7 @@ public Dropbox.Sign.Client.ApiResponse AccountCreateWithH /// /// Get Account Returns the properties and settings of your Account. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/AccountGetExample.cs /// Thrown when fails to make API call /// `account_id` or `email_address` is required. If both are provided, the account id prevails. The ID of the Account. (optional) /// `account_id` or `email_address` is required, If both are provided, the account id prevails. The email address of the Account. (optional) @@ -553,6 +574,7 @@ public Dropbox.Sign.Client.ApiResponse AccountCreateWithH /// /// Get Account Returns the properties and settings of your Account. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/AccountGetExample.cs /// Thrown when fails to make API call /// `account_id` or `email_address` is required. If both are provided, the account id prevails. The ID of the Account. (optional) /// `account_id` or `email_address` is required, If both are provided, the account id prevails. The email address of the Account. (optional) @@ -624,6 +646,7 @@ public Dropbox.Sign.Client.ApiResponse AccountCreateWithH /// /// Get Account Returns the properties and settings of your Account. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/AccountGetExample.cs /// Thrown when fails to make API call /// `account_id` or `email_address` is required. If both are provided, the account id prevails. The ID of the Account. (optional) /// `account_id` or `email_address` is required, If both are provided, the account id prevails. The email address of the Account. (optional) @@ -639,6 +662,7 @@ public Dropbox.Sign.Client.ApiResponse AccountCreateWithH /// /// Get Account Returns the properties and settings of your Account. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/AccountGetExample.cs /// Thrown when fails to make API call /// `account_id` or `email_address` is required. If both are provided, the account id prevails. The ID of the Account. (optional) /// `account_id` or `email_address` is required, If both are provided, the account id prevails. The email address of the Account. (optional) @@ -713,6 +737,7 @@ public Dropbox.Sign.Client.ApiResponse AccountCreateWithH /// /// Update Account Updates the properties and settings of your Account. Currently only allows for updates to the [Callback URL](/api/reference/tag/Callbacks-and-Events) and locale. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/AccountUpdateExample.cs /// Thrown when fails to make API call /// /// Index associated with the operation. @@ -726,6 +751,7 @@ public AccountGetResponse AccountUpdate(AccountUpdateRequest accountUpdateReques /// /// Update Account Updates the properties and settings of your Account. Currently only allows for updates to the [Callback URL](/api/reference/tag/Callbacks-and-Events) and locale. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/AccountUpdateExample.cs /// Thrown when fails to make API call /// /// Index associated with the operation. @@ -803,6 +829,7 @@ public Dropbox.Sign.Client.ApiResponse AccountUpdateWithHttp /// /// Update Account Updates the properties and settings of your Account. Currently only allows for updates to the [Callback URL](/api/reference/tag/Callbacks-and-Events) and locale. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/AccountUpdateExample.cs /// Thrown when fails to make API call /// /// Index associated with the operation. @@ -817,6 +844,7 @@ public Dropbox.Sign.Client.ApiResponse AccountUpdateWithHttp /// /// Update Account Updates the properties and settings of your Account. Currently only allows for updates to the [Callback URL](/api/reference/tag/Callbacks-and-Events) and locale. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/AccountUpdateExample.cs /// Thrown when fails to make API call /// /// Index associated with the operation. @@ -897,6 +925,7 @@ public Dropbox.Sign.Client.ApiResponse AccountUpdateWithHttp /// /// Verify Account Verifies whether an Dropbox Sign Account exists for the given email address. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/AccountVerifyExample.cs /// Thrown when fails to make API call /// /// Index associated with the operation. @@ -910,6 +939,7 @@ public AccountVerifyResponse AccountVerify(AccountVerifyRequest accountVerifyReq /// /// Verify Account Verifies whether an Dropbox Sign Account exists for the given email address. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/AccountVerifyExample.cs /// Thrown when fails to make API call /// /// Index associated with the operation. @@ -987,6 +1017,7 @@ public Dropbox.Sign.Client.ApiResponse AccountVerifyWithH /// /// Verify Account Verifies whether an Dropbox Sign Account exists for the given email address. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/AccountVerifyExample.cs /// Thrown when fails to make API call /// /// Index associated with the operation. @@ -1001,6 +1032,7 @@ public Dropbox.Sign.Client.ApiResponse AccountVerifyWithH /// /// Verify Account Verifies whether an Dropbox Sign Account exists for the given email address. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/AccountVerifyExample.cs /// Thrown when fails to make API call /// /// Index associated with the operation. diff --git a/sdks/dotnet/src/Dropbox.Sign/Api/ApiAppApi.cs b/sdks/dotnet/src/Dropbox.Sign/Api/ApiAppApi.cs index d5ff4381b..10610c791 100644 --- a/sdks/dotnet/src/Dropbox.Sign/Api/ApiAppApi.cs +++ b/sdks/dotnet/src/Dropbox.Sign/Api/ApiAppApi.cs @@ -33,6 +33,7 @@ public interface IApiAppApiSync : IApiAccessor /// /// Creates a new API App. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/ApiAppCreateExample.cs /// Thrown when fails to make API call /// /// Index associated with the operation. @@ -45,6 +46,7 @@ public interface IApiAppApiSync : IApiAccessor /// /// Creates a new API App. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/ApiAppCreateExample.cs /// Thrown when fails to make API call /// /// Index associated with the operation. @@ -56,6 +58,7 @@ public interface IApiAppApiSync : IApiAccessor /// /// Deletes an API App. Can only be invoked for apps you own. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/ApiAppDeleteExample.cs /// Thrown when fails to make API call /// The client id of the API App to delete. /// Index associated with the operation. @@ -68,6 +71,7 @@ public interface IApiAppApiSync : IApiAccessor /// /// Deletes an API App. Can only be invoked for apps you own. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/ApiAppDeleteExample.cs /// Thrown when fails to make API call /// The client id of the API App to delete. /// Index associated with the operation. @@ -79,6 +83,7 @@ public interface IApiAppApiSync : IApiAccessor /// /// Returns an object with information about an API App. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/ApiAppGetExample.cs /// Thrown when fails to make API call /// The client id of the API App to retrieve. /// Index associated with the operation. @@ -91,6 +96,7 @@ public interface IApiAppApiSync : IApiAccessor /// /// Returns an object with information about an API App. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/ApiAppGetExample.cs /// Thrown when fails to make API call /// The client id of the API App to retrieve. /// Index associated with the operation. @@ -102,6 +108,7 @@ public interface IApiAppApiSync : IApiAccessor /// /// Returns a list of API Apps that are accessible by you. If you are on a team with an Admin or Developer role, this list will include apps owned by teammates. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/ApiAppListExample.cs /// Thrown when fails to make API call /// Which page number of the API App List to return. Defaults to `1`. (optional, default to 1) /// Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. (optional, default to 20) @@ -115,6 +122,7 @@ public interface IApiAppApiSync : IApiAccessor /// /// Returns a list of API Apps that are accessible by you. If you are on a team with an Admin or Developer role, this list will include apps owned by teammates. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/ApiAppListExample.cs /// Thrown when fails to make API call /// Which page number of the API App List to return. Defaults to `1`. (optional, default to 1) /// Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. (optional, default to 20) @@ -127,6 +135,7 @@ public interface IApiAppApiSync : IApiAccessor /// /// Updates an existing API App. Can only be invoked for apps you own. Only the fields you provide will be updated. If you wish to clear an existing optional field, provide an empty string. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/ApiAppUpdateExample.cs /// Thrown when fails to make API call /// The client id of the API App to update. /// @@ -140,6 +149,7 @@ public interface IApiAppApiSync : IApiAccessor /// /// Updates an existing API App. Can only be invoked for apps you own. Only the fields you provide will be updated. If you wish to clear an existing optional field, provide an empty string. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/ApiAppUpdateExample.cs /// Thrown when fails to make API call /// The client id of the API App to update. /// @@ -161,6 +171,7 @@ public interface IApiAppApiAsync : IApiAccessor /// /// Creates a new API App. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/ApiAppCreateExample.cs /// Thrown when fails to make API call /// /// Index associated with the operation. @@ -174,6 +185,7 @@ public interface IApiAppApiAsync : IApiAccessor /// /// Creates a new API App. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/ApiAppCreateExample.cs /// Thrown when fails to make API call /// /// Index associated with the operation. @@ -186,6 +198,7 @@ public interface IApiAppApiAsync : IApiAccessor /// /// Deletes an API App. Can only be invoked for apps you own. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/ApiAppDeleteExample.cs /// Thrown when fails to make API call /// The client id of the API App to delete. /// Index associated with the operation. @@ -199,6 +212,7 @@ public interface IApiAppApiAsync : IApiAccessor /// /// Deletes an API App. Can only be invoked for apps you own. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/ApiAppDeleteExample.cs /// Thrown when fails to make API call /// The client id of the API App to delete. /// Index associated with the operation. @@ -211,6 +225,7 @@ public interface IApiAppApiAsync : IApiAccessor /// /// Returns an object with information about an API App. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/ApiAppGetExample.cs /// Thrown when fails to make API call /// The client id of the API App to retrieve. /// Index associated with the operation. @@ -224,6 +239,7 @@ public interface IApiAppApiAsync : IApiAccessor /// /// Returns an object with information about an API App. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/ApiAppGetExample.cs /// Thrown when fails to make API call /// The client id of the API App to retrieve. /// Index associated with the operation. @@ -236,6 +252,7 @@ public interface IApiAppApiAsync : IApiAccessor /// /// Returns a list of API Apps that are accessible by you. If you are on a team with an Admin or Developer role, this list will include apps owned by teammates. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/ApiAppListExample.cs /// Thrown when fails to make API call /// Which page number of the API App List to return. Defaults to `1`. (optional, default to 1) /// Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. (optional, default to 20) @@ -250,6 +267,7 @@ public interface IApiAppApiAsync : IApiAccessor /// /// Returns a list of API Apps that are accessible by you. If you are on a team with an Admin or Developer role, this list will include apps owned by teammates. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/ApiAppListExample.cs /// Thrown when fails to make API call /// Which page number of the API App List to return. Defaults to `1`. (optional, default to 1) /// Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. (optional, default to 20) @@ -263,6 +281,7 @@ public interface IApiAppApiAsync : IApiAccessor /// /// Updates an existing API App. Can only be invoked for apps you own. Only the fields you provide will be updated. If you wish to clear an existing optional field, provide an empty string. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/ApiAppUpdateExample.cs /// Thrown when fails to make API call /// The client id of the API App to update. /// @@ -277,6 +296,7 @@ public interface IApiAppApiAsync : IApiAccessor /// /// Updates an existing API App. Can only be invoked for apps you own. Only the fields you provide will be updated. If you wish to clear an existing optional field, provide an empty string. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/ApiAppUpdateExample.cs /// Thrown when fails to make API call /// The client id of the API App to update. /// @@ -407,6 +427,7 @@ public Dropbox.Sign.Client.ExceptionFactory ExceptionFactory /// /// Create API App Creates a new API App. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/ApiAppCreateExample.cs /// Thrown when fails to make API call /// /// Index associated with the operation. @@ -420,6 +441,7 @@ public ApiAppGetResponse ApiAppCreate(ApiAppCreateRequest apiAppCreateRequest, i /// /// Create API App Creates a new API App. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/ApiAppCreateExample.cs /// Thrown when fails to make API call /// /// Index associated with the operation. @@ -497,6 +519,7 @@ public Dropbox.Sign.Client.ApiResponse ApiAppCreateWithHttpIn /// /// Create API App Creates a new API App. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/ApiAppCreateExample.cs /// Thrown when fails to make API call /// /// Index associated with the operation. @@ -511,6 +534,7 @@ public Dropbox.Sign.Client.ApiResponse ApiAppCreateWithHttpIn /// /// Create API App Creates a new API App. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/ApiAppCreateExample.cs /// Thrown when fails to make API call /// /// Index associated with the operation. @@ -591,6 +615,7 @@ public Dropbox.Sign.Client.ApiResponse ApiAppCreateWithHttpIn /// /// Delete API App Deletes an API App. Can only be invoked for apps you own. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/ApiAppDeleteExample.cs /// Thrown when fails to make API call /// The client id of the API App to delete. /// Index associated with the operation. @@ -603,6 +628,7 @@ public void ApiAppDelete(string clientId, int operationIndex = 0) /// /// Delete API App Deletes an API App. Can only be invoked for apps you own. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/ApiAppDeleteExample.cs /// Thrown when fails to make API call /// The client id of the API App to delete. /// Index associated with the operation. @@ -672,6 +698,7 @@ public Dropbox.Sign.Client.ApiResponse ApiAppDeleteWithHttpInfo(string c /// /// Delete API App Deletes an API App. Can only be invoked for apps you own. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/ApiAppDeleteExample.cs /// Thrown when fails to make API call /// The client id of the API App to delete. /// Index associated with the operation. @@ -685,6 +712,7 @@ public Dropbox.Sign.Client.ApiResponse ApiAppDeleteWithHttpInfo(string c /// /// Delete API App Deletes an API App. Can only be invoked for apps you own. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/ApiAppDeleteExample.cs /// Thrown when fails to make API call /// The client id of the API App to delete. /// Index associated with the operation. @@ -757,6 +785,7 @@ public Dropbox.Sign.Client.ApiResponse ApiAppDeleteWithHttpInfo(string c /// /// Get API App Returns an object with information about an API App. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/ApiAppGetExample.cs /// Thrown when fails to make API call /// The client id of the API App to retrieve. /// Index associated with the operation. @@ -770,6 +799,7 @@ public ApiAppGetResponse ApiAppGet(string clientId, int operationIndex = 0) /// /// Get API App Returns an object with information about an API App. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/ApiAppGetExample.cs /// Thrown when fails to make API call /// The client id of the API App to retrieve. /// Index associated with the operation. @@ -839,6 +869,7 @@ public Dropbox.Sign.Client.ApiResponse ApiAppGetWithHttpInfo( /// /// Get API App Returns an object with information about an API App. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/ApiAppGetExample.cs /// Thrown when fails to make API call /// The client id of the API App to retrieve. /// Index associated with the operation. @@ -853,6 +884,7 @@ public Dropbox.Sign.Client.ApiResponse ApiAppGetWithHttpInfo( /// /// Get API App Returns an object with information about an API App. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/ApiAppGetExample.cs /// Thrown when fails to make API call /// The client id of the API App to retrieve. /// Index associated with the operation. @@ -925,6 +957,7 @@ public Dropbox.Sign.Client.ApiResponse ApiAppGetWithHttpInfo( /// /// List API Apps Returns a list of API Apps that are accessible by you. If you are on a team with an Admin or Developer role, this list will include apps owned by teammates. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/ApiAppListExample.cs /// Thrown when fails to make API call /// Which page number of the API App List to return. Defaults to `1`. (optional, default to 1) /// Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. (optional, default to 20) @@ -939,6 +972,7 @@ public Dropbox.Sign.Client.ApiResponse ApiAppGetWithHttpInfo( /// /// List API Apps Returns a list of API Apps that are accessible by you. If you are on a team with an Admin or Developer role, this list will include apps owned by teammates. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/ApiAppListExample.cs /// Thrown when fails to make API call /// Which page number of the API App List to return. Defaults to `1`. (optional, default to 1) /// Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. (optional, default to 20) @@ -1010,6 +1044,7 @@ public Dropbox.Sign.Client.ApiResponse ApiAppGetWithHttpInfo( /// /// List API Apps Returns a list of API Apps that are accessible by you. If you are on a team with an Admin or Developer role, this list will include apps owned by teammates. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/ApiAppListExample.cs /// Thrown when fails to make API call /// Which page number of the API App List to return. Defaults to `1`. (optional, default to 1) /// Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. (optional, default to 20) @@ -1025,6 +1060,7 @@ public Dropbox.Sign.Client.ApiResponse ApiAppGetWithHttpInfo( /// /// List API Apps Returns a list of API Apps that are accessible by you. If you are on a team with an Admin or Developer role, this list will include apps owned by teammates. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/ApiAppListExample.cs /// Thrown when fails to make API call /// Which page number of the API App List to return. Defaults to `1`. (optional, default to 1) /// Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. (optional, default to 20) @@ -1099,6 +1135,7 @@ public Dropbox.Sign.Client.ApiResponse ApiAppGetWithHttpInfo( /// /// Update API App Updates an existing API App. Can only be invoked for apps you own. Only the fields you provide will be updated. If you wish to clear an existing optional field, provide an empty string. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/ApiAppUpdateExample.cs /// Thrown when fails to make API call /// The client id of the API App to update. /// @@ -1113,6 +1150,7 @@ public ApiAppGetResponse ApiAppUpdate(string clientId, ApiAppUpdateRequest apiAp /// /// Update API App Updates an existing API App. Can only be invoked for apps you own. Only the fields you provide will be updated. If you wish to clear an existing optional field, provide an empty string. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/ApiAppUpdateExample.cs /// Thrown when fails to make API call /// The client id of the API App to update. /// @@ -1198,6 +1236,7 @@ public Dropbox.Sign.Client.ApiResponse ApiAppUpdateWithHttpIn /// /// Update API App Updates an existing API App. Can only be invoked for apps you own. Only the fields you provide will be updated. If you wish to clear an existing optional field, provide an empty string. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/ApiAppUpdateExample.cs /// Thrown when fails to make API call /// The client id of the API App to update. /// @@ -1213,6 +1252,7 @@ public Dropbox.Sign.Client.ApiResponse ApiAppUpdateWithHttpIn /// /// Update API App Updates an existing API App. Can only be invoked for apps you own. Only the fields you provide will be updated. If you wish to clear an existing optional field, provide an empty string. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/ApiAppUpdateExample.cs /// Thrown when fails to make API call /// The client id of the API App to update. /// diff --git a/sdks/dotnet/src/Dropbox.Sign/Api/BulkSendJobApi.cs b/sdks/dotnet/src/Dropbox.Sign/Api/BulkSendJobApi.cs index 25915628e..80a539517 100644 --- a/sdks/dotnet/src/Dropbox.Sign/Api/BulkSendJobApi.cs +++ b/sdks/dotnet/src/Dropbox.Sign/Api/BulkSendJobApi.cs @@ -33,6 +33,7 @@ public interface IBulkSendJobApiSync : IApiAccessor /// /// Returns the status of the BulkSendJob and its SignatureRequests specified by the `bulk_send_job_id` parameter. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/BulkSendJobGetExample.cs /// Thrown when fails to make API call /// The id of the BulkSendJob to retrieve. /// Which page number of the BulkSendJob list to return. Defaults to `1`. (optional, default to 1) @@ -47,6 +48,7 @@ public interface IBulkSendJobApiSync : IApiAccessor /// /// Returns the status of the BulkSendJob and its SignatureRequests specified by the `bulk_send_job_id` parameter. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/BulkSendJobGetExample.cs /// Thrown when fails to make API call /// The id of the BulkSendJob to retrieve. /// Which page number of the BulkSendJob list to return. Defaults to `1`. (optional, default to 1) @@ -60,6 +62,7 @@ public interface IBulkSendJobApiSync : IApiAccessor /// /// Returns a list of BulkSendJob that you can access. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/BulkSendJobListExample.cs /// Thrown when fails to make API call /// Which page number of the BulkSendJob List to return. Defaults to `1`. (optional, default to 1) /// Number of objects to be returned per page. Must be between `1` and `100`. Default is 20. (optional, default to 20) @@ -73,6 +76,7 @@ public interface IBulkSendJobApiSync : IApiAccessor /// /// Returns a list of BulkSendJob that you can access. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/BulkSendJobListExample.cs /// Thrown when fails to make API call /// Which page number of the BulkSendJob List to return. Defaults to `1`. (optional, default to 1) /// Number of objects to be returned per page. Must be between `1` and `100`. Default is 20. (optional, default to 20) @@ -94,6 +98,7 @@ public interface IBulkSendJobApiAsync : IApiAccessor /// /// Returns the status of the BulkSendJob and its SignatureRequests specified by the `bulk_send_job_id` parameter. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/BulkSendJobGetExample.cs /// Thrown when fails to make API call /// The id of the BulkSendJob to retrieve. /// Which page number of the BulkSendJob list to return. Defaults to `1`. (optional, default to 1) @@ -109,6 +114,7 @@ public interface IBulkSendJobApiAsync : IApiAccessor /// /// Returns the status of the BulkSendJob and its SignatureRequests specified by the `bulk_send_job_id` parameter. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/BulkSendJobGetExample.cs /// Thrown when fails to make API call /// The id of the BulkSendJob to retrieve. /// Which page number of the BulkSendJob list to return. Defaults to `1`. (optional, default to 1) @@ -123,6 +129,7 @@ public interface IBulkSendJobApiAsync : IApiAccessor /// /// Returns a list of BulkSendJob that you can access. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/BulkSendJobListExample.cs /// Thrown when fails to make API call /// Which page number of the BulkSendJob List to return. Defaults to `1`. (optional, default to 1) /// Number of objects to be returned per page. Must be between `1` and `100`. Default is 20. (optional, default to 20) @@ -137,6 +144,7 @@ public interface IBulkSendJobApiAsync : IApiAccessor /// /// Returns a list of BulkSendJob that you can access. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/BulkSendJobListExample.cs /// Thrown when fails to make API call /// Which page number of the BulkSendJob List to return. Defaults to `1`. (optional, default to 1) /// Number of objects to be returned per page. Must be between `1` and `100`. Default is 20. (optional, default to 20) @@ -267,6 +275,7 @@ public Dropbox.Sign.Client.ExceptionFactory ExceptionFactory /// /// Get Bulk Send Job Returns the status of the BulkSendJob and its SignatureRequests specified by the `bulk_send_job_id` parameter. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/BulkSendJobGetExample.cs /// Thrown when fails to make API call /// The id of the BulkSendJob to retrieve. /// Which page number of the BulkSendJob list to return. Defaults to `1`. (optional, default to 1) @@ -282,6 +291,7 @@ public Dropbox.Sign.Client.ExceptionFactory ExceptionFactory /// /// Get Bulk Send Job Returns the status of the BulkSendJob and its SignatureRequests specified by the `bulk_send_job_id` parameter. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/BulkSendJobGetExample.cs /// Thrown when fails to make API call /// The id of the BulkSendJob to retrieve. /// Which page number of the BulkSendJob list to return. Defaults to `1`. (optional, default to 1) @@ -361,6 +371,7 @@ public Dropbox.Sign.Client.ExceptionFactory ExceptionFactory /// /// Get Bulk Send Job Returns the status of the BulkSendJob and its SignatureRequests specified by the `bulk_send_job_id` parameter. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/BulkSendJobGetExample.cs /// Thrown when fails to make API call /// The id of the BulkSendJob to retrieve. /// Which page number of the BulkSendJob list to return. Defaults to `1`. (optional, default to 1) @@ -377,6 +388,7 @@ public Dropbox.Sign.Client.ExceptionFactory ExceptionFactory /// /// Get Bulk Send Job Returns the status of the BulkSendJob and its SignatureRequests specified by the `bulk_send_job_id` parameter. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/BulkSendJobGetExample.cs /// Thrown when fails to make API call /// The id of the BulkSendJob to retrieve. /// Which page number of the BulkSendJob list to return. Defaults to `1`. (optional, default to 1) @@ -459,6 +471,7 @@ public Dropbox.Sign.Client.ExceptionFactory ExceptionFactory /// /// List Bulk Send Jobs Returns a list of BulkSendJob that you can access. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/BulkSendJobListExample.cs /// Thrown when fails to make API call /// Which page number of the BulkSendJob List to return. Defaults to `1`. (optional, default to 1) /// Number of objects to be returned per page. Must be between `1` and `100`. Default is 20. (optional, default to 20) @@ -473,6 +486,7 @@ public Dropbox.Sign.Client.ExceptionFactory ExceptionFactory /// /// List Bulk Send Jobs Returns a list of BulkSendJob that you can access. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/BulkSendJobListExample.cs /// Thrown when fails to make API call /// Which page number of the BulkSendJob List to return. Defaults to `1`. (optional, default to 1) /// Number of objects to be returned per page. Must be between `1` and `100`. Default is 20. (optional, default to 20) @@ -544,6 +558,7 @@ public Dropbox.Sign.Client.ExceptionFactory ExceptionFactory /// /// List Bulk Send Jobs Returns a list of BulkSendJob that you can access. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/BulkSendJobListExample.cs /// Thrown when fails to make API call /// Which page number of the BulkSendJob List to return. Defaults to `1`. (optional, default to 1) /// Number of objects to be returned per page. Must be between `1` and `100`. Default is 20. (optional, default to 20) @@ -559,6 +574,7 @@ public Dropbox.Sign.Client.ExceptionFactory ExceptionFactory /// /// List Bulk Send Jobs Returns a list of BulkSendJob that you can access. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/BulkSendJobListExample.cs /// Thrown when fails to make API call /// Which page number of the BulkSendJob List to return. Defaults to `1`. (optional, default to 1) /// Number of objects to be returned per page. Must be between `1` and `100`. Default is 20. (optional, default to 20) diff --git a/sdks/dotnet/src/Dropbox.Sign/Api/EmbeddedApi.cs b/sdks/dotnet/src/Dropbox.Sign/Api/EmbeddedApi.cs index 32115b268..85ab285a4 100644 --- a/sdks/dotnet/src/Dropbox.Sign/Api/EmbeddedApi.cs +++ b/sdks/dotnet/src/Dropbox.Sign/Api/EmbeddedApi.cs @@ -33,6 +33,7 @@ public interface IEmbeddedApiSync : IApiAccessor /// /// Retrieves an embedded object containing a template url that can be opened in an iFrame. Note that only templates created via the embedded template process are available to be edited with this endpoint. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/EmbeddedEditUrlExample.cs /// Thrown when fails to make API call /// The id of the template to edit. /// @@ -46,6 +47,7 @@ public interface IEmbeddedApiSync : IApiAccessor /// /// Retrieves an embedded object containing a template url that can be opened in an iFrame. Note that only templates created via the embedded template process are available to be edited with this endpoint. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/EmbeddedEditUrlExample.cs /// Thrown when fails to make API call /// The id of the template to edit. /// @@ -58,6 +60,7 @@ public interface IEmbeddedApiSync : IApiAccessor /// /// Retrieves an embedded object containing a signature url that can be opened in an iFrame. Note that templates created via the embedded template process will only be accessible through the API. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/EmbeddedSignUrlExample.cs /// Thrown when fails to make API call /// The id of the signature to get a signature url for. /// Index associated with the operation. @@ -70,6 +73,7 @@ public interface IEmbeddedApiSync : IApiAccessor /// /// Retrieves an embedded object containing a signature url that can be opened in an iFrame. Note that templates created via the embedded template process will only be accessible through the API. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/EmbeddedSignUrlExample.cs /// Thrown when fails to make API call /// The id of the signature to get a signature url for. /// Index associated with the operation. @@ -90,6 +94,7 @@ public interface IEmbeddedApiAsync : IApiAccessor /// /// Retrieves an embedded object containing a template url that can be opened in an iFrame. Note that only templates created via the embedded template process are available to be edited with this endpoint. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/EmbeddedEditUrlExample.cs /// Thrown when fails to make API call /// The id of the template to edit. /// @@ -104,6 +109,7 @@ public interface IEmbeddedApiAsync : IApiAccessor /// /// Retrieves an embedded object containing a template url that can be opened in an iFrame. Note that only templates created via the embedded template process are available to be edited with this endpoint. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/EmbeddedEditUrlExample.cs /// Thrown when fails to make API call /// The id of the template to edit. /// @@ -117,6 +123,7 @@ public interface IEmbeddedApiAsync : IApiAccessor /// /// Retrieves an embedded object containing a signature url that can be opened in an iFrame. Note that templates created via the embedded template process will only be accessible through the API. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/EmbeddedSignUrlExample.cs /// Thrown when fails to make API call /// The id of the signature to get a signature url for. /// Index associated with the operation. @@ -130,6 +137,7 @@ public interface IEmbeddedApiAsync : IApiAccessor /// /// Retrieves an embedded object containing a signature url that can be opened in an iFrame. Note that templates created via the embedded template process will only be accessible through the API. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/EmbeddedSignUrlExample.cs /// Thrown when fails to make API call /// The id of the signature to get a signature url for. /// Index associated with the operation. @@ -259,6 +267,7 @@ public Dropbox.Sign.Client.ExceptionFactory ExceptionFactory /// /// Get Embedded Template Edit URL Retrieves an embedded object containing a template url that can be opened in an iFrame. Note that only templates created via the embedded template process are available to be edited with this endpoint. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/EmbeddedEditUrlExample.cs /// Thrown when fails to make API call /// The id of the template to edit. /// @@ -273,6 +282,7 @@ public EmbeddedEditUrlResponse EmbeddedEditUrl(string templateId, EmbeddedEditUr /// /// Get Embedded Template Edit URL Retrieves an embedded object containing a template url that can be opened in an iFrame. Note that only templates created via the embedded template process are available to be edited with this endpoint. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/EmbeddedEditUrlExample.cs /// Thrown when fails to make API call /// The id of the template to edit. /// @@ -358,6 +368,7 @@ public Dropbox.Sign.Client.ApiResponse EmbeddedEditUrlW /// /// Get Embedded Template Edit URL Retrieves an embedded object containing a template url that can be opened in an iFrame. Note that only templates created via the embedded template process are available to be edited with this endpoint. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/EmbeddedEditUrlExample.cs /// Thrown when fails to make API call /// The id of the template to edit. /// @@ -373,6 +384,7 @@ public Dropbox.Sign.Client.ApiResponse EmbeddedEditUrlW /// /// Get Embedded Template Edit URL Retrieves an embedded object containing a template url that can be opened in an iFrame. Note that only templates created via the embedded template process are available to be edited with this endpoint. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/EmbeddedEditUrlExample.cs /// Thrown when fails to make API call /// The id of the template to edit. /// @@ -461,6 +473,7 @@ public Dropbox.Sign.Client.ApiResponse EmbeddedEditUrlW /// /// Get Embedded Sign URL Retrieves an embedded object containing a signature url that can be opened in an iFrame. Note that templates created via the embedded template process will only be accessible through the API. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/EmbeddedSignUrlExample.cs /// Thrown when fails to make API call /// The id of the signature to get a signature url for. /// Index associated with the operation. @@ -474,6 +487,7 @@ public EmbeddedSignUrlResponse EmbeddedSignUrl(string signatureId, int operation /// /// Get Embedded Sign URL Retrieves an embedded object containing a signature url that can be opened in an iFrame. Note that templates created via the embedded template process will only be accessible through the API. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/EmbeddedSignUrlExample.cs /// Thrown when fails to make API call /// The id of the signature to get a signature url for. /// Index associated with the operation. @@ -543,6 +557,7 @@ public Dropbox.Sign.Client.ApiResponse EmbeddedSignUrlW /// /// Get Embedded Sign URL Retrieves an embedded object containing a signature url that can be opened in an iFrame. Note that templates created via the embedded template process will only be accessible through the API. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/EmbeddedSignUrlExample.cs /// Thrown when fails to make API call /// The id of the signature to get a signature url for. /// Index associated with the operation. @@ -557,6 +572,7 @@ public Dropbox.Sign.Client.ApiResponse EmbeddedSignUrlW /// /// Get Embedded Sign URL Retrieves an embedded object containing a signature url that can be opened in an iFrame. Note that templates created via the embedded template process will only be accessible through the API. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/EmbeddedSignUrlExample.cs /// Thrown when fails to make API call /// The id of the signature to get a signature url for. /// Index associated with the operation. diff --git a/sdks/dotnet/src/Dropbox.Sign/Api/FaxApi.cs b/sdks/dotnet/src/Dropbox.Sign/Api/FaxApi.cs index 096d3bf66..faa75bbde 100644 --- a/sdks/dotnet/src/Dropbox.Sign/Api/FaxApi.cs +++ b/sdks/dotnet/src/Dropbox.Sign/Api/FaxApi.cs @@ -33,6 +33,7 @@ public interface IFaxApiSync : IApiAccessor /// /// Deletes the specified Fax from the system /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/FaxDeleteExample.cs /// Thrown when fails to make API call /// Fax ID /// Index associated with the operation. @@ -45,6 +46,7 @@ public interface IFaxApiSync : IApiAccessor /// /// Deletes the specified Fax from the system /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/FaxDeleteExample.cs /// Thrown when fails to make API call /// Fax ID /// Index associated with the operation. @@ -56,6 +58,7 @@ public interface IFaxApiSync : IApiAccessor /// /// Downloads files associated with a Fax /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/FaxFilesExample.cs /// Thrown when fails to make API call /// Fax ID /// Index associated with the operation. @@ -68,6 +71,7 @@ public interface IFaxApiSync : IApiAccessor /// /// Downloads files associated with a Fax /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/FaxFilesExample.cs /// Thrown when fails to make API call /// Fax ID /// Index associated with the operation. @@ -79,6 +83,7 @@ public interface IFaxApiSync : IApiAccessor /// /// Returns information about a Fax /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/FaxGetExample.cs /// Thrown when fails to make API call /// Fax ID /// Index associated with the operation. @@ -91,6 +96,7 @@ public interface IFaxApiSync : IApiAccessor /// /// Returns information about a Fax /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/FaxGetExample.cs /// Thrown when fails to make API call /// Fax ID /// Index associated with the operation. @@ -102,6 +108,7 @@ public interface IFaxApiSync : IApiAccessor /// /// Returns properties of multiple Faxes /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/FaxListExample.cs /// Thrown when fails to make API call /// Which page number of the Fax List to return. Defaults to `1`. (optional, default to 1) /// Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. (optional, default to 20) @@ -115,6 +122,7 @@ public interface IFaxApiSync : IApiAccessor /// /// Returns properties of multiple Faxes /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/FaxListExample.cs /// Thrown when fails to make API call /// Which page number of the Fax List to return. Defaults to `1`. (optional, default to 1) /// Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. (optional, default to 20) @@ -127,6 +135,7 @@ public interface IFaxApiSync : IApiAccessor /// /// Creates and sends a new Fax with the submitted file(s) /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/FaxSendExample.cs /// Thrown when fails to make API call /// /// Index associated with the operation. @@ -139,6 +148,7 @@ public interface IFaxApiSync : IApiAccessor /// /// Creates and sends a new Fax with the submitted file(s) /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/FaxSendExample.cs /// Thrown when fails to make API call /// /// Index associated with the operation. @@ -159,6 +169,7 @@ public interface IFaxApiAsync : IApiAccessor /// /// Deletes the specified Fax from the system /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/FaxDeleteExample.cs /// Thrown when fails to make API call /// Fax ID /// Index associated with the operation. @@ -172,6 +183,7 @@ public interface IFaxApiAsync : IApiAccessor /// /// Deletes the specified Fax from the system /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/FaxDeleteExample.cs /// Thrown when fails to make API call /// Fax ID /// Index associated with the operation. @@ -184,6 +196,7 @@ public interface IFaxApiAsync : IApiAccessor /// /// Downloads files associated with a Fax /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/FaxFilesExample.cs /// Thrown when fails to make API call /// Fax ID /// Index associated with the operation. @@ -197,6 +210,7 @@ public interface IFaxApiAsync : IApiAccessor /// /// Downloads files associated with a Fax /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/FaxFilesExample.cs /// Thrown when fails to make API call /// Fax ID /// Index associated with the operation. @@ -209,6 +223,7 @@ public interface IFaxApiAsync : IApiAccessor /// /// Returns information about a Fax /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/FaxGetExample.cs /// Thrown when fails to make API call /// Fax ID /// Index associated with the operation. @@ -222,6 +237,7 @@ public interface IFaxApiAsync : IApiAccessor /// /// Returns information about a Fax /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/FaxGetExample.cs /// Thrown when fails to make API call /// Fax ID /// Index associated with the operation. @@ -234,6 +250,7 @@ public interface IFaxApiAsync : IApiAccessor /// /// Returns properties of multiple Faxes /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/FaxListExample.cs /// Thrown when fails to make API call /// Which page number of the Fax List to return. Defaults to `1`. (optional, default to 1) /// Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. (optional, default to 20) @@ -248,6 +265,7 @@ public interface IFaxApiAsync : IApiAccessor /// /// Returns properties of multiple Faxes /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/FaxListExample.cs /// Thrown when fails to make API call /// Which page number of the Fax List to return. Defaults to `1`. (optional, default to 1) /// Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. (optional, default to 20) @@ -261,6 +279,7 @@ public interface IFaxApiAsync : IApiAccessor /// /// Creates and sends a new Fax with the submitted file(s) /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/FaxSendExample.cs /// Thrown when fails to make API call /// /// Index associated with the operation. @@ -274,6 +293,7 @@ public interface IFaxApiAsync : IApiAccessor /// /// Creates and sends a new Fax with the submitted file(s) /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/FaxSendExample.cs /// Thrown when fails to make API call /// /// Index associated with the operation. @@ -403,6 +423,7 @@ public Dropbox.Sign.Client.ExceptionFactory ExceptionFactory /// /// Delete Fax Deletes the specified Fax from the system /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/FaxDeleteExample.cs /// Thrown when fails to make API call /// Fax ID /// Index associated with the operation. @@ -415,6 +436,7 @@ public void FaxDelete(string faxId, int operationIndex = 0) /// /// Delete Fax Deletes the specified Fax from the system /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/FaxDeleteExample.cs /// Thrown when fails to make API call /// Fax ID /// Index associated with the operation. @@ -478,6 +500,7 @@ public Dropbox.Sign.Client.ApiResponse FaxDeleteWithHttpInfo(string faxI /// /// Delete Fax Deletes the specified Fax from the system /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/FaxDeleteExample.cs /// Thrown when fails to make API call /// Fax ID /// Index associated with the operation. @@ -491,6 +514,7 @@ public Dropbox.Sign.Client.ApiResponse FaxDeleteWithHttpInfo(string faxI /// /// Delete Fax Deletes the specified Fax from the system /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/FaxDeleteExample.cs /// Thrown when fails to make API call /// Fax ID /// Index associated with the operation. @@ -557,6 +581,7 @@ public Dropbox.Sign.Client.ApiResponse FaxDeleteWithHttpInfo(string faxI /// /// Download Fax Files Downloads files associated with a Fax /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/FaxFilesExample.cs /// Thrown when fails to make API call /// Fax ID /// Index associated with the operation. @@ -570,6 +595,7 @@ public System.IO.Stream FaxFiles(string faxId, int operationIndex = 0) /// /// Download Fax Files Downloads files associated with a Fax /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/FaxFilesExample.cs /// Thrown when fails to make API call /// Fax ID /// Index associated with the operation. @@ -634,6 +660,7 @@ public System.IO.Stream FaxFiles(string faxId, int operationIndex = 0) /// /// Download Fax Files Downloads files associated with a Fax /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/FaxFilesExample.cs /// Thrown when fails to make API call /// Fax ID /// Index associated with the operation. @@ -648,6 +675,7 @@ public System.IO.Stream FaxFiles(string faxId, int operationIndex = 0) /// /// Download Fax Files Downloads files associated with a Fax /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/FaxFilesExample.cs /// Thrown when fails to make API call /// Fax ID /// Index associated with the operation. @@ -715,6 +743,7 @@ public System.IO.Stream FaxFiles(string faxId, int operationIndex = 0) /// /// Get Fax Returns information about a Fax /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/FaxGetExample.cs /// Thrown when fails to make API call /// Fax ID /// Index associated with the operation. @@ -728,6 +757,7 @@ public FaxGetResponse FaxGet(string faxId, int operationIndex = 0) /// /// Get Fax Returns information about a Fax /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/FaxGetExample.cs /// Thrown when fails to make API call /// Fax ID /// Index associated with the operation. @@ -791,6 +821,7 @@ public Dropbox.Sign.Client.ApiResponse FaxGetWithHttpInfo(string /// /// Get Fax Returns information about a Fax /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/FaxGetExample.cs /// Thrown when fails to make API call /// Fax ID /// Index associated with the operation. @@ -805,6 +836,7 @@ public Dropbox.Sign.Client.ApiResponse FaxGetWithHttpInfo(string /// /// Get Fax Returns information about a Fax /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/FaxGetExample.cs /// Thrown when fails to make API call /// Fax ID /// Index associated with the operation. @@ -871,6 +903,7 @@ public Dropbox.Sign.Client.ApiResponse FaxGetWithHttpInfo(string /// /// Lists Faxes Returns properties of multiple Faxes /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/FaxListExample.cs /// Thrown when fails to make API call /// Which page number of the Fax List to return. Defaults to `1`. (optional, default to 1) /// Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. (optional, default to 20) @@ -885,6 +918,7 @@ public Dropbox.Sign.Client.ApiResponse FaxGetWithHttpInfo(string /// /// Lists Faxes Returns properties of multiple Faxes /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/FaxListExample.cs /// Thrown when fails to make API call /// Which page number of the Fax List to return. Defaults to `1`. (optional, default to 1) /// Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. (optional, default to 20) @@ -950,6 +984,7 @@ public Dropbox.Sign.Client.ApiResponse FaxGetWithHttpInfo(string /// /// Lists Faxes Returns properties of multiple Faxes /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/FaxListExample.cs /// Thrown when fails to make API call /// Which page number of the Fax List to return. Defaults to `1`. (optional, default to 1) /// Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. (optional, default to 20) @@ -965,6 +1000,7 @@ public Dropbox.Sign.Client.ApiResponse FaxGetWithHttpInfo(string /// /// Lists Faxes Returns properties of multiple Faxes /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/FaxListExample.cs /// Thrown when fails to make API call /// Which page number of the Fax List to return. Defaults to `1`. (optional, default to 1) /// Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. (optional, default to 20) @@ -1033,6 +1069,7 @@ public Dropbox.Sign.Client.ApiResponse FaxGetWithHttpInfo(string /// /// Send Fax Creates and sends a new Fax with the submitted file(s) /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/FaxSendExample.cs /// Thrown when fails to make API call /// /// Index associated with the operation. @@ -1046,6 +1083,7 @@ public FaxGetResponse FaxSend(FaxSendRequest faxSendRequest, int operationIndex /// /// Send Fax Creates and sends a new Fax with the submitted file(s) /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/FaxSendExample.cs /// Thrown when fails to make API call /// /// Index associated with the operation. @@ -1117,6 +1155,7 @@ public Dropbox.Sign.Client.ApiResponse FaxSendWithHttpInfo(FaxSe /// /// Send Fax Creates and sends a new Fax with the submitted file(s) /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/FaxSendExample.cs /// Thrown when fails to make API call /// /// Index associated with the operation. @@ -1131,6 +1170,7 @@ public Dropbox.Sign.Client.ApiResponse FaxSendWithHttpInfo(FaxSe /// /// Send Fax Creates and sends a new Fax with the submitted file(s) /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/FaxSendExample.cs /// Thrown when fails to make API call /// /// Index associated with the operation. diff --git a/sdks/dotnet/src/Dropbox.Sign/Api/FaxLineApi.cs b/sdks/dotnet/src/Dropbox.Sign/Api/FaxLineApi.cs index 127f2e4d7..e756a48f5 100644 --- a/sdks/dotnet/src/Dropbox.Sign/Api/FaxLineApi.cs +++ b/sdks/dotnet/src/Dropbox.Sign/Api/FaxLineApi.cs @@ -33,6 +33,7 @@ public interface IFaxLineApiSync : IApiAccessor /// /// Grants a user access to the specified Fax Line. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/FaxLineAddUserExample.cs /// Thrown when fails to make API call /// /// Index associated with the operation. @@ -45,6 +46,7 @@ public interface IFaxLineApiSync : IApiAccessor /// /// Grants a user access to the specified Fax Line. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/FaxLineAddUserExample.cs /// Thrown when fails to make API call /// /// Index associated with the operation. @@ -56,6 +58,7 @@ public interface IFaxLineApiSync : IApiAccessor /// /// Returns a list of available area codes for a given state/province and city /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/FaxLineAreaCodeGetExample.cs /// Thrown when fails to make API call /// Filter area codes by country /// Filter area codes by state (optional) @@ -71,6 +74,7 @@ public interface IFaxLineApiSync : IApiAccessor /// /// Returns a list of available area codes for a given state/province and city /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/FaxLineAreaCodeGetExample.cs /// Thrown when fails to make API call /// Filter area codes by country /// Filter area codes by state (optional) @@ -85,6 +89,7 @@ public interface IFaxLineApiSync : IApiAccessor /// /// Purchases a new Fax Line /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/FaxLineCreateExample.cs /// Thrown when fails to make API call /// /// Index associated with the operation. @@ -97,6 +102,7 @@ public interface IFaxLineApiSync : IApiAccessor /// /// Purchases a new Fax Line /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/FaxLineCreateExample.cs /// Thrown when fails to make API call /// /// Index associated with the operation. @@ -108,6 +114,7 @@ public interface IFaxLineApiSync : IApiAccessor /// /// Deletes the specified Fax Line from the subscription. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/FaxLineDeleteExample.cs /// Thrown when fails to make API call /// /// Index associated with the operation. @@ -120,6 +127,7 @@ public interface IFaxLineApiSync : IApiAccessor /// /// Deletes the specified Fax Line from the subscription. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/FaxLineDeleteExample.cs /// Thrown when fails to make API call /// /// Index associated with the operation. @@ -131,6 +139,7 @@ public interface IFaxLineApiSync : IApiAccessor /// /// Returns the properties and settings of a Fax Line. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/FaxLineGetExample.cs /// Thrown when fails to make API call /// The Fax Line number /// Index associated with the operation. @@ -143,6 +152,7 @@ public interface IFaxLineApiSync : IApiAccessor /// /// Returns the properties and settings of a Fax Line. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/FaxLineGetExample.cs /// Thrown when fails to make API call /// The Fax Line number /// Index associated with the operation. @@ -154,6 +164,7 @@ public interface IFaxLineApiSync : IApiAccessor /// /// Returns the properties and settings of multiple Fax Lines. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/FaxLineListExample.cs /// Thrown when fails to make API call /// Account ID (optional) /// Which page number of the Fax Line List to return. Defaults to `1`. (optional, default to 1) @@ -169,6 +180,7 @@ public interface IFaxLineApiSync : IApiAccessor /// /// Returns the properties and settings of multiple Fax Lines. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/FaxLineListExample.cs /// Thrown when fails to make API call /// Account ID (optional) /// Which page number of the Fax Line List to return. Defaults to `1`. (optional, default to 1) @@ -183,6 +195,7 @@ public interface IFaxLineApiSync : IApiAccessor /// /// Removes a user's access to the specified Fax Line /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/FaxLineRemoveUserExample.cs /// Thrown when fails to make API call /// /// Index associated with the operation. @@ -195,6 +208,7 @@ public interface IFaxLineApiSync : IApiAccessor /// /// Removes a user's access to the specified Fax Line /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/FaxLineRemoveUserExample.cs /// Thrown when fails to make API call /// /// Index associated with the operation. @@ -215,6 +229,7 @@ public interface IFaxLineApiAsync : IApiAccessor /// /// Grants a user access to the specified Fax Line. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/FaxLineAddUserExample.cs /// Thrown when fails to make API call /// /// Index associated with the operation. @@ -228,6 +243,7 @@ public interface IFaxLineApiAsync : IApiAccessor /// /// Grants a user access to the specified Fax Line. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/FaxLineAddUserExample.cs /// Thrown when fails to make API call /// /// Index associated with the operation. @@ -240,6 +256,7 @@ public interface IFaxLineApiAsync : IApiAccessor /// /// Returns a list of available area codes for a given state/province and city /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/FaxLineAreaCodeGetExample.cs /// Thrown when fails to make API call /// Filter area codes by country /// Filter area codes by state (optional) @@ -256,6 +273,7 @@ public interface IFaxLineApiAsync : IApiAccessor /// /// Returns a list of available area codes for a given state/province and city /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/FaxLineAreaCodeGetExample.cs /// Thrown when fails to make API call /// Filter area codes by country /// Filter area codes by state (optional) @@ -271,6 +289,7 @@ public interface IFaxLineApiAsync : IApiAccessor /// /// Purchases a new Fax Line /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/FaxLineCreateExample.cs /// Thrown when fails to make API call /// /// Index associated with the operation. @@ -284,6 +303,7 @@ public interface IFaxLineApiAsync : IApiAccessor /// /// Purchases a new Fax Line /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/FaxLineCreateExample.cs /// Thrown when fails to make API call /// /// Index associated with the operation. @@ -296,6 +316,7 @@ public interface IFaxLineApiAsync : IApiAccessor /// /// Deletes the specified Fax Line from the subscription. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/FaxLineDeleteExample.cs /// Thrown when fails to make API call /// /// Index associated with the operation. @@ -309,6 +330,7 @@ public interface IFaxLineApiAsync : IApiAccessor /// /// Deletes the specified Fax Line from the subscription. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/FaxLineDeleteExample.cs /// Thrown when fails to make API call /// /// Index associated with the operation. @@ -321,6 +343,7 @@ public interface IFaxLineApiAsync : IApiAccessor /// /// Returns the properties and settings of a Fax Line. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/FaxLineGetExample.cs /// Thrown when fails to make API call /// The Fax Line number /// Index associated with the operation. @@ -334,6 +357,7 @@ public interface IFaxLineApiAsync : IApiAccessor /// /// Returns the properties and settings of a Fax Line. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/FaxLineGetExample.cs /// Thrown when fails to make API call /// The Fax Line number /// Index associated with the operation. @@ -346,6 +370,7 @@ public interface IFaxLineApiAsync : IApiAccessor /// /// Returns the properties and settings of multiple Fax Lines. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/FaxLineListExample.cs /// Thrown when fails to make API call /// Account ID (optional) /// Which page number of the Fax Line List to return. Defaults to `1`. (optional, default to 1) @@ -362,6 +387,7 @@ public interface IFaxLineApiAsync : IApiAccessor /// /// Returns the properties and settings of multiple Fax Lines. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/FaxLineListExample.cs /// Thrown when fails to make API call /// Account ID (optional) /// Which page number of the Fax Line List to return. Defaults to `1`. (optional, default to 1) @@ -377,6 +403,7 @@ public interface IFaxLineApiAsync : IApiAccessor /// /// Removes a user's access to the specified Fax Line /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/FaxLineRemoveUserExample.cs /// Thrown when fails to make API call /// /// Index associated with the operation. @@ -390,6 +417,7 @@ public interface IFaxLineApiAsync : IApiAccessor /// /// Removes a user's access to the specified Fax Line /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/FaxLineRemoveUserExample.cs /// Thrown when fails to make API call /// /// Index associated with the operation. @@ -519,6 +547,7 @@ public Dropbox.Sign.Client.ExceptionFactory ExceptionFactory /// /// Add Fax Line User Grants a user access to the specified Fax Line. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/FaxLineAddUserExample.cs /// Thrown when fails to make API call /// /// Index associated with the operation. @@ -532,6 +561,7 @@ public FaxLineResponse FaxLineAddUser(FaxLineAddUserRequest faxLineAddUserReques /// /// Add Fax Line User Grants a user access to the specified Fax Line. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/FaxLineAddUserExample.cs /// Thrown when fails to make API call /// /// Index associated with the operation. @@ -603,6 +633,7 @@ public Dropbox.Sign.Client.ApiResponse FaxLineAddUserWithHttpIn /// /// Add Fax Line User Grants a user access to the specified Fax Line. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/FaxLineAddUserExample.cs /// Thrown when fails to make API call /// /// Index associated with the operation. @@ -617,6 +648,7 @@ public Dropbox.Sign.Client.ApiResponse FaxLineAddUserWithHttpIn /// /// Add Fax Line User Grants a user access to the specified Fax Line. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/FaxLineAddUserExample.cs /// Thrown when fails to make API call /// /// Index associated with the operation. @@ -691,6 +723,7 @@ public Dropbox.Sign.Client.ApiResponse FaxLineAddUserWithHttpIn /// /// Get Available Fax Line Area Codes Returns a list of available area codes for a given state/province and city /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/FaxLineAreaCodeGetExample.cs /// Thrown when fails to make API call /// Filter area codes by country /// Filter area codes by state (optional) @@ -707,6 +740,7 @@ public Dropbox.Sign.Client.ApiResponse FaxLineAddUserWithHttpIn /// /// Get Available Fax Line Area Codes Returns a list of available area codes for a given state/province and city /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/FaxLineAreaCodeGetExample.cs /// Thrown when fails to make API call /// Filter area codes by country /// Filter area codes by state (optional) @@ -785,6 +819,7 @@ public Dropbox.Sign.Client.ApiResponse FaxLineAddUserWithHttpIn /// /// Get Available Fax Line Area Codes Returns a list of available area codes for a given state/province and city /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/FaxLineAreaCodeGetExample.cs /// Thrown when fails to make API call /// Filter area codes by country /// Filter area codes by state (optional) @@ -802,6 +837,7 @@ public Dropbox.Sign.Client.ApiResponse FaxLineAddUserWithHttpIn /// /// Get Available Fax Line Area Codes Returns a list of available area codes for a given state/province and city /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/FaxLineAreaCodeGetExample.cs /// Thrown when fails to make API call /// Filter area codes by country /// Filter area codes by state (optional) @@ -883,6 +919,7 @@ public Dropbox.Sign.Client.ApiResponse FaxLineAddUserWithHttpIn /// /// Purchase Fax Line Purchases a new Fax Line /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/FaxLineCreateExample.cs /// Thrown when fails to make API call /// /// Index associated with the operation. @@ -896,6 +933,7 @@ public FaxLineResponse FaxLineCreate(FaxLineCreateRequest faxLineCreateRequest, /// /// Purchase Fax Line Purchases a new Fax Line /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/FaxLineCreateExample.cs /// Thrown when fails to make API call /// /// Index associated with the operation. @@ -967,6 +1005,7 @@ public Dropbox.Sign.Client.ApiResponse FaxLineCreateWithHttpInf /// /// Purchase Fax Line Purchases a new Fax Line /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/FaxLineCreateExample.cs /// Thrown when fails to make API call /// /// Index associated with the operation. @@ -981,6 +1020,7 @@ public Dropbox.Sign.Client.ApiResponse FaxLineCreateWithHttpInf /// /// Purchase Fax Line Purchases a new Fax Line /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/FaxLineCreateExample.cs /// Thrown when fails to make API call /// /// Index associated with the operation. @@ -1055,6 +1095,7 @@ public Dropbox.Sign.Client.ApiResponse FaxLineCreateWithHttpInf /// /// Delete Fax Line Deletes the specified Fax Line from the subscription. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/FaxLineDeleteExample.cs /// Thrown when fails to make API call /// /// Index associated with the operation. @@ -1067,6 +1108,7 @@ public void FaxLineDelete(FaxLineDeleteRequest faxLineDeleteRequest, int operati /// /// Delete Fax Line Deletes the specified Fax Line from the subscription. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/FaxLineDeleteExample.cs /// Thrown when fails to make API call /// /// Index associated with the operation. @@ -1138,6 +1180,7 @@ public Dropbox.Sign.Client.ApiResponse FaxLineDeleteWithHttpInfo(FaxLine /// /// Delete Fax Line Deletes the specified Fax Line from the subscription. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/FaxLineDeleteExample.cs /// Thrown when fails to make API call /// /// Index associated with the operation. @@ -1151,6 +1194,7 @@ public Dropbox.Sign.Client.ApiResponse FaxLineDeleteWithHttpInfo(FaxLine /// /// Delete Fax Line Deletes the specified Fax Line from the subscription. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/FaxLineDeleteExample.cs /// Thrown when fails to make API call /// /// Index associated with the operation. @@ -1225,6 +1269,7 @@ public Dropbox.Sign.Client.ApiResponse FaxLineDeleteWithHttpInfo(FaxLine /// /// Get Fax Line Returns the properties and settings of a Fax Line. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/FaxLineGetExample.cs /// Thrown when fails to make API call /// The Fax Line number /// Index associated with the operation. @@ -1238,6 +1283,7 @@ public FaxLineResponse FaxLineGet(string number, int operationIndex = 0) /// /// Get Fax Line Returns the properties and settings of a Fax Line. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/FaxLineGetExample.cs /// Thrown when fails to make API call /// The Fax Line number /// Index associated with the operation. @@ -1301,6 +1347,7 @@ public Dropbox.Sign.Client.ApiResponse FaxLineGetWithHttpInfo(s /// /// Get Fax Line Returns the properties and settings of a Fax Line. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/FaxLineGetExample.cs /// Thrown when fails to make API call /// The Fax Line number /// Index associated with the operation. @@ -1315,6 +1362,7 @@ public Dropbox.Sign.Client.ApiResponse FaxLineGetWithHttpInfo(s /// /// Get Fax Line Returns the properties and settings of a Fax Line. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/FaxLineGetExample.cs /// Thrown when fails to make API call /// The Fax Line number /// Index associated with the operation. @@ -1381,6 +1429,7 @@ public Dropbox.Sign.Client.ApiResponse FaxLineGetWithHttpInfo(s /// /// List Fax Lines Returns the properties and settings of multiple Fax Lines. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/FaxLineListExample.cs /// Thrown when fails to make API call /// Account ID (optional) /// Which page number of the Fax Line List to return. Defaults to `1`. (optional, default to 1) @@ -1397,6 +1446,7 @@ public Dropbox.Sign.Client.ApiResponse FaxLineGetWithHttpInfo(s /// /// List Fax Lines Returns the properties and settings of multiple Fax Lines. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/FaxLineListExample.cs /// Thrown when fails to make API call /// Account ID (optional) /// Which page number of the Fax Line List to return. Defaults to `1`. (optional, default to 1) @@ -1472,6 +1522,7 @@ public Dropbox.Sign.Client.ApiResponse FaxLineGetWithHttpInfo(s /// /// List Fax Lines Returns the properties and settings of multiple Fax Lines. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/FaxLineListExample.cs /// Thrown when fails to make API call /// Account ID (optional) /// Which page number of the Fax Line List to return. Defaults to `1`. (optional, default to 1) @@ -1489,6 +1540,7 @@ public Dropbox.Sign.Client.ApiResponse FaxLineGetWithHttpInfo(s /// /// List Fax Lines Returns the properties and settings of multiple Fax Lines. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/FaxLineListExample.cs /// Thrown when fails to make API call /// Account ID (optional) /// Which page number of the Fax Line List to return. Defaults to `1`. (optional, default to 1) @@ -1567,6 +1619,7 @@ public Dropbox.Sign.Client.ApiResponse FaxLineGetWithHttpInfo(s /// /// Remove Fax Line Access Removes a user's access to the specified Fax Line /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/FaxLineRemoveUserExample.cs /// Thrown when fails to make API call /// /// Index associated with the operation. @@ -1580,6 +1633,7 @@ public FaxLineResponse FaxLineRemoveUser(FaxLineRemoveUserRequest faxLineRemoveU /// /// Remove Fax Line Access Removes a user's access to the specified Fax Line /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/FaxLineRemoveUserExample.cs /// Thrown when fails to make API call /// /// Index associated with the operation. @@ -1651,6 +1705,7 @@ public Dropbox.Sign.Client.ApiResponse FaxLineRemoveUserWithHtt /// /// Remove Fax Line Access Removes a user's access to the specified Fax Line /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/FaxLineRemoveUserExample.cs /// Thrown when fails to make API call /// /// Index associated with the operation. @@ -1665,6 +1720,7 @@ public Dropbox.Sign.Client.ApiResponse FaxLineRemoveUserWithHtt /// /// Remove Fax Line Access Removes a user's access to the specified Fax Line /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/FaxLineRemoveUserExample.cs /// Thrown when fails to make API call /// /// Index associated with the operation. diff --git a/sdks/dotnet/src/Dropbox.Sign/Api/OAuthApi.cs b/sdks/dotnet/src/Dropbox.Sign/Api/OAuthApi.cs index 563c0a500..bf27a01b4 100644 --- a/sdks/dotnet/src/Dropbox.Sign/Api/OAuthApi.cs +++ b/sdks/dotnet/src/Dropbox.Sign/Api/OAuthApi.cs @@ -33,6 +33,7 @@ public interface IOAuthApiSync : IApiAccessor /// /// Once you have retrieved the code from the user callback, you will need to exchange it for an access token via a backend call. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/OauthTokenGenerateExample.cs /// Thrown when fails to make API call /// /// Index associated with the operation. @@ -45,6 +46,7 @@ public interface IOAuthApiSync : IApiAccessor /// /// Once you have retrieved the code from the user callback, you will need to exchange it for an access token via a backend call. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/OauthTokenGenerateExample.cs /// Thrown when fails to make API call /// /// Index associated with the operation. @@ -56,6 +58,7 @@ public interface IOAuthApiSync : IApiAccessor /// /// Access tokens are only valid for a given period of time (typically one hour) for security reasons. Whenever acquiring an new access token its TTL is also given (see `expires_in`), along with a refresh token that can be used to acquire a new access token after the current one has expired. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/OauthTokenRefreshExample.cs /// Thrown when fails to make API call /// /// Index associated with the operation. @@ -68,6 +71,7 @@ public interface IOAuthApiSync : IApiAccessor /// /// Access tokens are only valid for a given period of time (typically one hour) for security reasons. Whenever acquiring an new access token its TTL is also given (see `expires_in`), along with a refresh token that can be used to acquire a new access token after the current one has expired. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/OauthTokenRefreshExample.cs /// Thrown when fails to make API call /// /// Index associated with the operation. @@ -88,6 +92,7 @@ public interface IOAuthApiAsync : IApiAccessor /// /// Once you have retrieved the code from the user callback, you will need to exchange it for an access token via a backend call. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/OauthTokenGenerateExample.cs /// Thrown when fails to make API call /// /// Index associated with the operation. @@ -101,6 +106,7 @@ public interface IOAuthApiAsync : IApiAccessor /// /// Once you have retrieved the code from the user callback, you will need to exchange it for an access token via a backend call. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/OauthTokenGenerateExample.cs /// Thrown when fails to make API call /// /// Index associated with the operation. @@ -113,6 +119,7 @@ public interface IOAuthApiAsync : IApiAccessor /// /// Access tokens are only valid for a given period of time (typically one hour) for security reasons. Whenever acquiring an new access token its TTL is also given (see `expires_in`), along with a refresh token that can be used to acquire a new access token after the current one has expired. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/OauthTokenRefreshExample.cs /// Thrown when fails to make API call /// /// Index associated with the operation. @@ -126,6 +133,7 @@ public interface IOAuthApiAsync : IApiAccessor /// /// Access tokens are only valid for a given period of time (typically one hour) for security reasons. Whenever acquiring an new access token its TTL is also given (see `expires_in`), along with a refresh token that can be used to acquire a new access token after the current one has expired. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/OauthTokenRefreshExample.cs /// Thrown when fails to make API call /// /// Index associated with the operation. @@ -255,6 +263,7 @@ public Dropbox.Sign.Client.ExceptionFactory ExceptionFactory /// /// OAuth Token Generate Once you have retrieved the code from the user callback, you will need to exchange it for an access token via a backend call. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/OauthTokenGenerateExample.cs /// Thrown when fails to make API call /// /// Index associated with the operation. @@ -268,6 +277,7 @@ public OAuthTokenResponse OauthTokenGenerate(OAuthTokenGenerateRequest oAuthToke /// /// OAuth Token Generate Once you have retrieved the code from the user callback, you will need to exchange it for an access token via a backend call. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/OauthTokenGenerateExample.cs /// Thrown when fails to make API call /// /// Index associated with the operation. @@ -333,6 +343,7 @@ public Dropbox.Sign.Client.ApiResponse OauthTokenGenerateWit /// /// OAuth Token Generate Once you have retrieved the code from the user callback, you will need to exchange it for an access token via a backend call. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/OauthTokenGenerateExample.cs /// Thrown when fails to make API call /// /// Index associated with the operation. @@ -347,6 +358,7 @@ public Dropbox.Sign.Client.ApiResponse OauthTokenGenerateWit /// /// OAuth Token Generate Once you have retrieved the code from the user callback, you will need to exchange it for an access token via a backend call. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/OauthTokenGenerateExample.cs /// Thrown when fails to make API call /// /// Index associated with the operation. @@ -415,6 +427,7 @@ public Dropbox.Sign.Client.ApiResponse OauthTokenGenerateWit /// /// OAuth Token Refresh Access tokens are only valid for a given period of time (typically one hour) for security reasons. Whenever acquiring an new access token its TTL is also given (see `expires_in`), along with a refresh token that can be used to acquire a new access token after the current one has expired. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/OauthTokenRefreshExample.cs /// Thrown when fails to make API call /// /// Index associated with the operation. @@ -428,6 +441,7 @@ public OAuthTokenResponse OauthTokenRefresh(OAuthTokenRefreshRequest oAuthTokenR /// /// OAuth Token Refresh Access tokens are only valid for a given period of time (typically one hour) for security reasons. Whenever acquiring an new access token its TTL is also given (see `expires_in`), along with a refresh token that can be used to acquire a new access token after the current one has expired. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/OauthTokenRefreshExample.cs /// Thrown when fails to make API call /// /// Index associated with the operation. @@ -493,6 +507,7 @@ public Dropbox.Sign.Client.ApiResponse OauthTokenRefreshWith /// /// OAuth Token Refresh Access tokens are only valid for a given period of time (typically one hour) for security reasons. Whenever acquiring an new access token its TTL is also given (see `expires_in`), along with a refresh token that can be used to acquire a new access token after the current one has expired. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/OauthTokenRefreshExample.cs /// Thrown when fails to make API call /// /// Index associated with the operation. @@ -507,6 +522,7 @@ public Dropbox.Sign.Client.ApiResponse OauthTokenRefreshWith /// /// OAuth Token Refresh Access tokens are only valid for a given period of time (typically one hour) for security reasons. Whenever acquiring an new access token its TTL is also given (see `expires_in`), along with a refresh token that can be used to acquire a new access token after the current one has expired. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/OauthTokenRefreshExample.cs /// Thrown when fails to make API call /// /// Index associated with the operation. diff --git a/sdks/dotnet/src/Dropbox.Sign/Api/ReportApi.cs b/sdks/dotnet/src/Dropbox.Sign/Api/ReportApi.cs index a3e26932a..0e075a0e3 100644 --- a/sdks/dotnet/src/Dropbox.Sign/Api/ReportApi.cs +++ b/sdks/dotnet/src/Dropbox.Sign/Api/ReportApi.cs @@ -33,6 +33,7 @@ public interface IReportApiSync : IApiAccessor /// /// Request the creation of one or more report(s). When the report(s) have been generated, you will receive an email (one per requested report type) containing a link to download the report as a CSV file. The requested date range may be up to 12 months in duration, and `start_date` must not be more than 10 years in the past. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/ReportCreateExample.cs /// Thrown when fails to make API call /// /// Index associated with the operation. @@ -45,6 +46,7 @@ public interface IReportApiSync : IApiAccessor /// /// Request the creation of one or more report(s). When the report(s) have been generated, you will receive an email (one per requested report type) containing a link to download the report as a CSV file. The requested date range may be up to 12 months in duration, and `start_date` must not be more than 10 years in the past. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/ReportCreateExample.cs /// Thrown when fails to make API call /// /// Index associated with the operation. @@ -65,6 +67,7 @@ public interface IReportApiAsync : IApiAccessor /// /// Request the creation of one or more report(s). When the report(s) have been generated, you will receive an email (one per requested report type) containing a link to download the report as a CSV file. The requested date range may be up to 12 months in duration, and `start_date` must not be more than 10 years in the past. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/ReportCreateExample.cs /// Thrown when fails to make API call /// /// Index associated with the operation. @@ -78,6 +81,7 @@ public interface IReportApiAsync : IApiAccessor /// /// Request the creation of one or more report(s). When the report(s) have been generated, you will receive an email (one per requested report type) containing a link to download the report as a CSV file. The requested date range may be up to 12 months in duration, and `start_date` must not be more than 10 years in the past. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/ReportCreateExample.cs /// Thrown when fails to make API call /// /// Index associated with the operation. @@ -207,6 +211,7 @@ public Dropbox.Sign.Client.ExceptionFactory ExceptionFactory /// /// Create Report Request the creation of one or more report(s). When the report(s) have been generated, you will receive an email (one per requested report type) containing a link to download the report as a CSV file. The requested date range may be up to 12 months in duration, and `start_date` must not be more than 10 years in the past. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/ReportCreateExample.cs /// Thrown when fails to make API call /// /// Index associated with the operation. @@ -220,6 +225,7 @@ public ReportCreateResponse ReportCreate(ReportCreateRequest reportCreateRequest /// /// Create Report Request the creation of one or more report(s). When the report(s) have been generated, you will receive an email (one per requested report type) containing a link to download the report as a CSV file. The requested date range may be up to 12 months in duration, and `start_date` must not be more than 10 years in the past. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/ReportCreateExample.cs /// Thrown when fails to make API call /// /// Index associated with the operation. @@ -291,6 +297,7 @@ public Dropbox.Sign.Client.ApiResponse ReportCreateWithHtt /// /// Create Report Request the creation of one or more report(s). When the report(s) have been generated, you will receive an email (one per requested report type) containing a link to download the report as a CSV file. The requested date range may be up to 12 months in duration, and `start_date` must not be more than 10 years in the past. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/ReportCreateExample.cs /// Thrown when fails to make API call /// /// Index associated with the operation. @@ -305,6 +312,7 @@ public Dropbox.Sign.Client.ApiResponse ReportCreateWithHtt /// /// Create Report Request the creation of one or more report(s). When the report(s) have been generated, you will receive an email (one per requested report type) containing a link to download the report as a CSV file. The requested date range may be up to 12 months in duration, and `start_date` must not be more than 10 years in the past. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/ReportCreateExample.cs /// Thrown when fails to make API call /// /// Index associated with the operation. diff --git a/sdks/dotnet/src/Dropbox.Sign/Api/SignatureRequestApi.cs b/sdks/dotnet/src/Dropbox.Sign/Api/SignatureRequestApi.cs index f2862217d..05be3bf6d 100644 --- a/sdks/dotnet/src/Dropbox.Sign/Api/SignatureRequestApi.cs +++ b/sdks/dotnet/src/Dropbox.Sign/Api/SignatureRequestApi.cs @@ -33,6 +33,7 @@ public interface ISignatureRequestApiSync : IApiAccessor /// /// Creates BulkSendJob which sends up to 250 SignatureRequests in bulk based off of the provided Template(s) specified with the `template_ids` parameter to be signed in an embedded iFrame. These embedded signature requests can only be signed in embedded iFrames whereas normal signature requests can only be signed on Dropbox Sign. **NOTE:** Only available for Standard plan and higher. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/SignatureRequestBulkCreateEmbeddedWithTemplateExample.cs /// Thrown when fails to make API call /// /// Index associated with the operation. @@ -45,6 +46,7 @@ public interface ISignatureRequestApiSync : IApiAccessor /// /// Creates BulkSendJob which sends up to 250 SignatureRequests in bulk based off of the provided Template(s) specified with the `template_ids` parameter to be signed in an embedded iFrame. These embedded signature requests can only be signed in embedded iFrames whereas normal signature requests can only be signed on Dropbox Sign. **NOTE:** Only available for Standard plan and higher. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/SignatureRequestBulkCreateEmbeddedWithTemplateExample.cs /// Thrown when fails to make API call /// /// Index associated with the operation. @@ -56,6 +58,7 @@ public interface ISignatureRequestApiSync : IApiAccessor /// /// Creates BulkSendJob which sends up to 250 SignatureRequests in bulk based off of the provided Template(s) specified with the `template_ids` parameter. **NOTE:** Only available for Standard plan and higher. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/SignatureRequestBulkSendWithTemplateExample.cs /// Thrown when fails to make API call /// /// Index associated with the operation. @@ -68,6 +71,7 @@ public interface ISignatureRequestApiSync : IApiAccessor /// /// Creates BulkSendJob which sends up to 250 SignatureRequests in bulk based off of the provided Template(s) specified with the `template_ids` parameter. **NOTE:** Only available for Standard plan and higher. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/SignatureRequestBulkSendWithTemplateExample.cs /// Thrown when fails to make API call /// /// Index associated with the operation. @@ -79,6 +83,7 @@ public interface ISignatureRequestApiSync : IApiAccessor /// /// Cancels an incomplete signature request. This action is **not reversible**. The request will be canceled and signers will no longer be able to sign. If they try to access the signature request they will receive a HTTP 410 status code indicating that the resource has been deleted. Cancelation is asynchronous and a successful call to this endpoint will return an empty 200 OK response if the signature request is eligible to be canceled and has been successfully queued. This 200 OK response does not indicate a successful cancelation of the signature request itself. The cancelation is confirmed via the `signature_request_canceled` event. It is recommended that a [callback handler](/api/reference/tag/Callbacks-and-Events) be implemented to listen for the `signature_request_canceled` event. This callback will be sent only when the cancelation has completed successfully. If a callback handler has been configured and the event has not been received within 60 minutes of making the call, check the status of the request in the [API Dashboard](https://app.hellosign.com/apidashboard) and retry the cancelation if necessary. To be eligible for cancelation, a signature request must have been sent successfully, must not yet have been signed by all signers, and you must either be the sender or own the API app under which it was sent. A partially signed signature request can be canceled. **NOTE:** To remove your access to a completed signature request, use the endpoint: `POST /signature_request/remove/[:signature_request_id]`. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/SignatureRequestCancelExample.cs /// Thrown when fails to make API call /// The id of the incomplete SignatureRequest to cancel. /// Index associated with the operation. @@ -91,6 +96,7 @@ public interface ISignatureRequestApiSync : IApiAccessor /// /// Cancels an incomplete signature request. This action is **not reversible**. The request will be canceled and signers will no longer be able to sign. If they try to access the signature request they will receive a HTTP 410 status code indicating that the resource has been deleted. Cancelation is asynchronous and a successful call to this endpoint will return an empty 200 OK response if the signature request is eligible to be canceled and has been successfully queued. This 200 OK response does not indicate a successful cancelation of the signature request itself. The cancelation is confirmed via the `signature_request_canceled` event. It is recommended that a [callback handler](/api/reference/tag/Callbacks-and-Events) be implemented to listen for the `signature_request_canceled` event. This callback will be sent only when the cancelation has completed successfully. If a callback handler has been configured and the event has not been received within 60 minutes of making the call, check the status of the request in the [API Dashboard](https://app.hellosign.com/apidashboard) and retry the cancelation if necessary. To be eligible for cancelation, a signature request must have been sent successfully, must not yet have been signed by all signers, and you must either be the sender or own the API app under which it was sent. A partially signed signature request can be canceled. **NOTE:** To remove your access to a completed signature request, use the endpoint: `POST /signature_request/remove/[:signature_request_id]`. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/SignatureRequestCancelExample.cs /// Thrown when fails to make API call /// The id of the incomplete SignatureRequest to cancel. /// Index associated with the operation. @@ -102,6 +108,7 @@ public interface ISignatureRequestApiSync : IApiAccessor /// /// Creates a new SignatureRequest with the submitted documents to be signed in an embedded iFrame. If form_fields_per_document is not specified, a signature page will be affixed where all signers will be required to add their signature, signifying their agreement to all contained documents. Note that embedded signature requests can only be signed in embedded iFrames whereas normal signature requests can only be signed on Dropbox Sign. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/SignatureRequestCreateEmbeddedExample.cs /// Thrown when fails to make API call /// /// Index associated with the operation. @@ -114,6 +121,7 @@ public interface ISignatureRequestApiSync : IApiAccessor /// /// Creates a new SignatureRequest with the submitted documents to be signed in an embedded iFrame. If form_fields_per_document is not specified, a signature page will be affixed where all signers will be required to add their signature, signifying their agreement to all contained documents. Note that embedded signature requests can only be signed in embedded iFrames whereas normal signature requests can only be signed on Dropbox Sign. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/SignatureRequestCreateEmbeddedExample.cs /// Thrown when fails to make API call /// /// Index associated with the operation. @@ -125,6 +133,7 @@ public interface ISignatureRequestApiSync : IApiAccessor /// /// Creates a new SignatureRequest based on the given Template(s) to be signed in an embedded iFrame. Note that embedded signature requests can only be signed in embedded iFrames whereas normal signature requests can only be signed on Dropbox Sign. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/SignatureRequestCreateEmbeddedWithTemplateExample.cs /// Thrown when fails to make API call /// /// Index associated with the operation. @@ -137,6 +146,7 @@ public interface ISignatureRequestApiSync : IApiAccessor /// /// Creates a new SignatureRequest based on the given Template(s) to be signed in an embedded iFrame. Note that embedded signature requests can only be signed in embedded iFrames whereas normal signature requests can only be signed on Dropbox Sign. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/SignatureRequestCreateEmbeddedWithTemplateExample.cs /// Thrown when fails to make API call /// /// Index associated with the operation. @@ -148,6 +158,7 @@ public interface ISignatureRequestApiSync : IApiAccessor /// /// Edits and sends a SignatureRequest with the submitted documents. If `form_fields_per_document` is not specified, a signature page will be affixed where all signers will be required to add their signature, signifying their agreement to all contained documents. **NOTE:** Edit and resend *will* deduct your signature request quota. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/SignatureRequestEditExample.cs /// Thrown when fails to make API call /// The id of the SignatureRequest to edit. /// @@ -161,6 +172,7 @@ public interface ISignatureRequestApiSync : IApiAccessor /// /// Edits and sends a SignatureRequest with the submitted documents. If `form_fields_per_document` is not specified, a signature page will be affixed where all signers will be required to add their signature, signifying their agreement to all contained documents. **NOTE:** Edit and resend *will* deduct your signature request quota. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/SignatureRequestEditExample.cs /// Thrown when fails to make API call /// The id of the SignatureRequest to edit. /// @@ -173,6 +185,7 @@ public interface ISignatureRequestApiSync : IApiAccessor /// /// Edits a SignatureRequest with the submitted documents to be signed in an embedded iFrame. If form_fields_per_document is not specified, a signature page will be affixed where all signers will be required to add their signature, signifying their agreement to all contained documents. Note that embedded signature requests can only be signed in embedded iFrames whereas normal signature requests can only be signed on Dropbox Sign. **NOTE:** Edit and resend *will* deduct your signature request quota. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/SignatureRequestEditEmbeddedExample.cs /// Thrown when fails to make API call /// The id of the SignatureRequest to edit. /// @@ -186,6 +199,7 @@ public interface ISignatureRequestApiSync : IApiAccessor /// /// Edits a SignatureRequest with the submitted documents to be signed in an embedded iFrame. If form_fields_per_document is not specified, a signature page will be affixed where all signers will be required to add their signature, signifying their agreement to all contained documents. Note that embedded signature requests can only be signed in embedded iFrames whereas normal signature requests can only be signed on Dropbox Sign. **NOTE:** Edit and resend *will* deduct your signature request quota. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/SignatureRequestEditEmbeddedExample.cs /// Thrown when fails to make API call /// The id of the SignatureRequest to edit. /// @@ -198,6 +212,7 @@ public interface ISignatureRequestApiSync : IApiAccessor /// /// Edits a SignatureRequest based on the given Template(s) to be signed in an embedded iFrame. Note that embedded signature requests can only be signed in embedded iFrames whereas normal signature requests can only be signed on Dropbox Sign. **NOTE:** Edit and resend *will* deduct your signature request quota. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/SignatureRequestEditEmbeddedWithTemplateExample.cs /// Thrown when fails to make API call /// The id of the SignatureRequest to edit. /// @@ -211,6 +226,7 @@ public interface ISignatureRequestApiSync : IApiAccessor /// /// Edits a SignatureRequest based on the given Template(s) to be signed in an embedded iFrame. Note that embedded signature requests can only be signed in embedded iFrames whereas normal signature requests can only be signed on Dropbox Sign. **NOTE:** Edit and resend *will* deduct your signature request quota. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/SignatureRequestEditEmbeddedWithTemplateExample.cs /// Thrown when fails to make API call /// The id of the SignatureRequest to edit. /// @@ -223,6 +239,7 @@ public interface ISignatureRequestApiSync : IApiAccessor /// /// Edits and sends a SignatureRequest based off of the Template(s) specified with the template_ids parameter. **NOTE:** Edit and resend *will* deduct your signature request quota. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/SignatureRequestEditWithTemplateExample.cs /// Thrown when fails to make API call /// The id of the SignatureRequest to edit. /// @@ -236,6 +253,7 @@ public interface ISignatureRequestApiSync : IApiAccessor /// /// Edits and sends a SignatureRequest based off of the Template(s) specified with the template_ids parameter. **NOTE:** Edit and resend *will* deduct your signature request quota. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/SignatureRequestEditWithTemplateExample.cs /// Thrown when fails to make API call /// The id of the SignatureRequest to edit. /// @@ -248,6 +266,7 @@ public interface ISignatureRequestApiSync : IApiAccessor /// /// Obtain a copy of the current documents specified by the `signature_request_id` parameter. Returns a PDF or ZIP file. If the files are currently being prepared, a status code of `409` will be returned instead. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/SignatureRequestFilesExample.cs /// Thrown when fails to make API call /// The id of the SignatureRequest to retrieve. /// Set to `pdf` for a single merged document or `zip` for a collection of individual documents. (optional, default to pdf) @@ -261,6 +280,7 @@ public interface ISignatureRequestApiSync : IApiAccessor /// /// Obtain a copy of the current documents specified by the `signature_request_id` parameter. Returns a PDF or ZIP file. If the files are currently being prepared, a status code of `409` will be returned instead. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/SignatureRequestFilesExample.cs /// Thrown when fails to make API call /// The id of the SignatureRequest to retrieve. /// Set to `pdf` for a single merged document or `zip` for a collection of individual documents. (optional, default to pdf) @@ -273,6 +293,7 @@ public interface ISignatureRequestApiSync : IApiAccessor /// /// Obtain a copy of the current documents specified by the `signature_request_id` parameter. Returns a JSON object with a `data_uri` representing the base64 encoded file (PDFs only). If the files are currently being prepared, a status code of `409` will be returned instead. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/SignatureRequestFilesAsDataUriExample.cs /// Thrown when fails to make API call /// The id of the SignatureRequest to retrieve. /// Index associated with the operation. @@ -285,6 +306,7 @@ public interface ISignatureRequestApiSync : IApiAccessor /// /// Obtain a copy of the current documents specified by the `signature_request_id` parameter. Returns a JSON object with a `data_uri` representing the base64 encoded file (PDFs only). If the files are currently being prepared, a status code of `409` will be returned instead. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/SignatureRequestFilesAsDataUriExample.cs /// Thrown when fails to make API call /// The id of the SignatureRequest to retrieve. /// Index associated with the operation. @@ -296,6 +318,7 @@ public interface ISignatureRequestApiSync : IApiAccessor /// /// Obtain a copy of the current documents specified by the `signature_request_id` parameter. Returns a JSON object with a url to the file (PDFs only). If the files are currently being prepared, a status code of `409` will be returned instead. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/SignatureRequestFilesAsFileUrlExample.cs /// Thrown when fails to make API call /// The id of the SignatureRequest to retrieve. /// By default when opening the `file_url` a browser will download the PDF and save it locally. When set to `0` the PDF file will be displayed in the browser. (optional, default to 1) @@ -309,6 +332,7 @@ public interface ISignatureRequestApiSync : IApiAccessor /// /// Obtain a copy of the current documents specified by the `signature_request_id` parameter. Returns a JSON object with a url to the file (PDFs only). If the files are currently being prepared, a status code of `409` will be returned instead. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/SignatureRequestFilesAsFileUrlExample.cs /// Thrown when fails to make API call /// The id of the SignatureRequest to retrieve. /// By default when opening the `file_url` a browser will download the PDF and save it locally. When set to `0` the PDF file will be displayed in the browser. (optional, default to 1) @@ -321,6 +345,7 @@ public interface ISignatureRequestApiSync : IApiAccessor /// /// Returns the status of the SignatureRequest specified by the `signature_request_id` parameter. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/SignatureRequestGetExample.cs /// Thrown when fails to make API call /// The id of the SignatureRequest to retrieve. /// Index associated with the operation. @@ -333,6 +358,7 @@ public interface ISignatureRequestApiSync : IApiAccessor /// /// Returns the status of the SignatureRequest specified by the `signature_request_id` parameter. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/SignatureRequestGetExample.cs /// Thrown when fails to make API call /// The id of the SignatureRequest to retrieve. /// Index associated with the operation. @@ -344,6 +370,7 @@ public interface ISignatureRequestApiSync : IApiAccessor /// /// Returns a list of SignatureRequests that you can access. This includes SignatureRequests you have sent as well as received, but not ones that you have been CCed on. Take a look at our [search guide](/api/reference/search/) to learn more about querying signature requests. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/SignatureRequestListExample.cs /// Thrown when fails to make API call /// Which account to return SignatureRequests for. Must be a team member. Use `all` to indicate all team members. Defaults to your account. (optional) /// Which page number of the SignatureRequest List to return. Defaults to `1`. (optional, default to 1) @@ -359,6 +386,7 @@ public interface ISignatureRequestApiSync : IApiAccessor /// /// Returns a list of SignatureRequests that you can access. This includes SignatureRequests you have sent as well as received, but not ones that you have been CCed on. Take a look at our [search guide](/api/reference/search/) to learn more about querying signature requests. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/SignatureRequestListExample.cs /// Thrown when fails to make API call /// Which account to return SignatureRequests for. Must be a team member. Use `all` to indicate all team members. Defaults to your account. (optional) /// Which page number of the SignatureRequest List to return. Defaults to `1`. (optional, default to 1) @@ -373,6 +401,7 @@ public interface ISignatureRequestApiSync : IApiAccessor /// /// Releases a held SignatureRequest that was claimed and prepared from an [UnclaimedDraft](/api/reference/tag/Unclaimed-Draft). The owner of the Draft must indicate at Draft creation that the SignatureRequest created from the Draft should be held. Releasing the SignatureRequest will send requests to all signers. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/SignatureRequestReleaseHoldExample.cs /// Thrown when fails to make API call /// The id of the SignatureRequest to release. /// Index associated with the operation. @@ -385,6 +414,7 @@ public interface ISignatureRequestApiSync : IApiAccessor /// /// Releases a held SignatureRequest that was claimed and prepared from an [UnclaimedDraft](/api/reference/tag/Unclaimed-Draft). The owner of the Draft must indicate at Draft creation that the SignatureRequest created from the Draft should be held. Releasing the SignatureRequest will send requests to all signers. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/SignatureRequestReleaseHoldExample.cs /// Thrown when fails to make API call /// The id of the SignatureRequest to release. /// Index associated with the operation. @@ -396,6 +426,7 @@ public interface ISignatureRequestApiSync : IApiAccessor /// /// Sends an email to the signer reminding them to sign the signature request. You cannot send a reminder within 1 hour of the last reminder that was sent. This includes manual AND automatic reminders. **NOTE:** This action can **not** be used with embedded signature requests. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/SignatureRequestRemindExample.cs /// Thrown when fails to make API call /// The id of the SignatureRequest to send a reminder for. /// @@ -409,6 +440,7 @@ public interface ISignatureRequestApiSync : IApiAccessor /// /// Sends an email to the signer reminding them to sign the signature request. You cannot send a reminder within 1 hour of the last reminder that was sent. This includes manual AND automatic reminders. **NOTE:** This action can **not** be used with embedded signature requests. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/SignatureRequestRemindExample.cs /// Thrown when fails to make API call /// The id of the SignatureRequest to send a reminder for. /// @@ -421,6 +453,7 @@ public interface ISignatureRequestApiSync : IApiAccessor /// /// Removes your access to a completed signature request. This action is **not reversible**. The signature request must be fully executed by all parties (signed or declined to sign). Other parties will continue to maintain access to the completed signature request document(s). Unlike /signature_request/cancel, this endpoint is synchronous and your access will be immediately removed. Upon successful removal, this endpoint will return a 200 OK response. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/SignatureRequestRemoveExample.cs /// Thrown when fails to make API call /// The id of the SignatureRequest to remove. /// Index associated with the operation. @@ -433,6 +466,7 @@ public interface ISignatureRequestApiSync : IApiAccessor /// /// Removes your access to a completed signature request. This action is **not reversible**. The signature request must be fully executed by all parties (signed or declined to sign). Other parties will continue to maintain access to the completed signature request document(s). Unlike /signature_request/cancel, this endpoint is synchronous and your access will be immediately removed. Upon successful removal, this endpoint will return a 200 OK response. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/SignatureRequestRemoveExample.cs /// Thrown when fails to make API call /// The id of the SignatureRequest to remove. /// Index associated with the operation. @@ -444,6 +478,7 @@ public interface ISignatureRequestApiSync : IApiAccessor /// /// Creates and sends a new SignatureRequest with the submitted documents. If `form_fields_per_document` is not specified, a signature page will be affixed where all signers will be required to add their signature, signifying their agreement to all contained documents. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/SignatureRequestSendExample.cs /// Thrown when fails to make API call /// /// Index associated with the operation. @@ -456,6 +491,7 @@ public interface ISignatureRequestApiSync : IApiAccessor /// /// Creates and sends a new SignatureRequest with the submitted documents. If `form_fields_per_document` is not specified, a signature page will be affixed where all signers will be required to add their signature, signifying their agreement to all contained documents. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/SignatureRequestSendExample.cs /// Thrown when fails to make API call /// /// Index associated with the operation. @@ -467,6 +503,7 @@ public interface ISignatureRequestApiSync : IApiAccessor /// /// Creates and sends a new SignatureRequest based off of the Template(s) specified with the `template_ids` parameter. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/SignatureRequestSendWithTemplateExample.cs /// Thrown when fails to make API call /// /// Index associated with the operation. @@ -479,6 +516,7 @@ public interface ISignatureRequestApiSync : IApiAccessor /// /// Creates and sends a new SignatureRequest based off of the Template(s) specified with the `template_ids` parameter. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/SignatureRequestSendWithTemplateExample.cs /// Thrown when fails to make API call /// /// Index associated with the operation. @@ -490,6 +528,7 @@ public interface ISignatureRequestApiSync : IApiAccessor /// /// Updates the email address and/or the name for a given signer on a signature request. You can listen for the `signature_request_email_bounce` event on your app or account to detect bounced emails, and respond with this method. Updating the email address of a signer will generate a new `signature_id` value. **NOTE:** This action cannot be performed on a signature request with an appended signature page. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/SignatureRequestUpdateExample.cs /// Thrown when fails to make API call /// The id of the SignatureRequest to update. /// @@ -503,6 +542,7 @@ public interface ISignatureRequestApiSync : IApiAccessor /// /// Updates the email address and/or the name for a given signer on a signature request. You can listen for the `signature_request_email_bounce` event on your app or account to detect bounced emails, and respond with this method. Updating the email address of a signer will generate a new `signature_id` value. **NOTE:** This action cannot be performed on a signature request with an appended signature page. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/SignatureRequestUpdateExample.cs /// Thrown when fails to make API call /// The id of the SignatureRequest to update. /// @@ -524,6 +564,7 @@ public interface ISignatureRequestApiAsync : IApiAccessor /// /// Creates BulkSendJob which sends up to 250 SignatureRequests in bulk based off of the provided Template(s) specified with the `template_ids` parameter to be signed in an embedded iFrame. These embedded signature requests can only be signed in embedded iFrames whereas normal signature requests can only be signed on Dropbox Sign. **NOTE:** Only available for Standard plan and higher. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/SignatureRequestBulkCreateEmbeddedWithTemplateExample.cs /// Thrown when fails to make API call /// /// Index associated with the operation. @@ -537,6 +578,7 @@ public interface ISignatureRequestApiAsync : IApiAccessor /// /// Creates BulkSendJob which sends up to 250 SignatureRequests in bulk based off of the provided Template(s) specified with the `template_ids` parameter to be signed in an embedded iFrame. These embedded signature requests can only be signed in embedded iFrames whereas normal signature requests can only be signed on Dropbox Sign. **NOTE:** Only available for Standard plan and higher. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/SignatureRequestBulkCreateEmbeddedWithTemplateExample.cs /// Thrown when fails to make API call /// /// Index associated with the operation. @@ -549,6 +591,7 @@ public interface ISignatureRequestApiAsync : IApiAccessor /// /// Creates BulkSendJob which sends up to 250 SignatureRequests in bulk based off of the provided Template(s) specified with the `template_ids` parameter. **NOTE:** Only available for Standard plan and higher. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/SignatureRequestBulkSendWithTemplateExample.cs /// Thrown when fails to make API call /// /// Index associated with the operation. @@ -562,6 +605,7 @@ public interface ISignatureRequestApiAsync : IApiAccessor /// /// Creates BulkSendJob which sends up to 250 SignatureRequests in bulk based off of the provided Template(s) specified with the `template_ids` parameter. **NOTE:** Only available for Standard plan and higher. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/SignatureRequestBulkSendWithTemplateExample.cs /// Thrown when fails to make API call /// /// Index associated with the operation. @@ -574,6 +618,7 @@ public interface ISignatureRequestApiAsync : IApiAccessor /// /// Cancels an incomplete signature request. This action is **not reversible**. The request will be canceled and signers will no longer be able to sign. If they try to access the signature request they will receive a HTTP 410 status code indicating that the resource has been deleted. Cancelation is asynchronous and a successful call to this endpoint will return an empty 200 OK response if the signature request is eligible to be canceled and has been successfully queued. This 200 OK response does not indicate a successful cancelation of the signature request itself. The cancelation is confirmed via the `signature_request_canceled` event. It is recommended that a [callback handler](/api/reference/tag/Callbacks-and-Events) be implemented to listen for the `signature_request_canceled` event. This callback will be sent only when the cancelation has completed successfully. If a callback handler has been configured and the event has not been received within 60 minutes of making the call, check the status of the request in the [API Dashboard](https://app.hellosign.com/apidashboard) and retry the cancelation if necessary. To be eligible for cancelation, a signature request must have been sent successfully, must not yet have been signed by all signers, and you must either be the sender or own the API app under which it was sent. A partially signed signature request can be canceled. **NOTE:** To remove your access to a completed signature request, use the endpoint: `POST /signature_request/remove/[:signature_request_id]`. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/SignatureRequestCancelExample.cs /// Thrown when fails to make API call /// The id of the incomplete SignatureRequest to cancel. /// Index associated with the operation. @@ -587,6 +632,7 @@ public interface ISignatureRequestApiAsync : IApiAccessor /// /// Cancels an incomplete signature request. This action is **not reversible**. The request will be canceled and signers will no longer be able to sign. If they try to access the signature request they will receive a HTTP 410 status code indicating that the resource has been deleted. Cancelation is asynchronous and a successful call to this endpoint will return an empty 200 OK response if the signature request is eligible to be canceled and has been successfully queued. This 200 OK response does not indicate a successful cancelation of the signature request itself. The cancelation is confirmed via the `signature_request_canceled` event. It is recommended that a [callback handler](/api/reference/tag/Callbacks-and-Events) be implemented to listen for the `signature_request_canceled` event. This callback will be sent only when the cancelation has completed successfully. If a callback handler has been configured and the event has not been received within 60 minutes of making the call, check the status of the request in the [API Dashboard](https://app.hellosign.com/apidashboard) and retry the cancelation if necessary. To be eligible for cancelation, a signature request must have been sent successfully, must not yet have been signed by all signers, and you must either be the sender or own the API app under which it was sent. A partially signed signature request can be canceled. **NOTE:** To remove your access to a completed signature request, use the endpoint: `POST /signature_request/remove/[:signature_request_id]`. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/SignatureRequestCancelExample.cs /// Thrown when fails to make API call /// The id of the incomplete SignatureRequest to cancel. /// Index associated with the operation. @@ -599,6 +645,7 @@ public interface ISignatureRequestApiAsync : IApiAccessor /// /// Creates a new SignatureRequest with the submitted documents to be signed in an embedded iFrame. If form_fields_per_document is not specified, a signature page will be affixed where all signers will be required to add their signature, signifying their agreement to all contained documents. Note that embedded signature requests can only be signed in embedded iFrames whereas normal signature requests can only be signed on Dropbox Sign. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/SignatureRequestCreateEmbeddedExample.cs /// Thrown when fails to make API call /// /// Index associated with the operation. @@ -612,6 +659,7 @@ public interface ISignatureRequestApiAsync : IApiAccessor /// /// Creates a new SignatureRequest with the submitted documents to be signed in an embedded iFrame. If form_fields_per_document is not specified, a signature page will be affixed where all signers will be required to add their signature, signifying their agreement to all contained documents. Note that embedded signature requests can only be signed in embedded iFrames whereas normal signature requests can only be signed on Dropbox Sign. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/SignatureRequestCreateEmbeddedExample.cs /// Thrown when fails to make API call /// /// Index associated with the operation. @@ -624,6 +672,7 @@ public interface ISignatureRequestApiAsync : IApiAccessor /// /// Creates a new SignatureRequest based on the given Template(s) to be signed in an embedded iFrame. Note that embedded signature requests can only be signed in embedded iFrames whereas normal signature requests can only be signed on Dropbox Sign. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/SignatureRequestCreateEmbeddedWithTemplateExample.cs /// Thrown when fails to make API call /// /// Index associated with the operation. @@ -637,6 +686,7 @@ public interface ISignatureRequestApiAsync : IApiAccessor /// /// Creates a new SignatureRequest based on the given Template(s) to be signed in an embedded iFrame. Note that embedded signature requests can only be signed in embedded iFrames whereas normal signature requests can only be signed on Dropbox Sign. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/SignatureRequestCreateEmbeddedWithTemplateExample.cs /// Thrown when fails to make API call /// /// Index associated with the operation. @@ -649,6 +699,7 @@ public interface ISignatureRequestApiAsync : IApiAccessor /// /// Edits and sends a SignatureRequest with the submitted documents. If `form_fields_per_document` is not specified, a signature page will be affixed where all signers will be required to add their signature, signifying their agreement to all contained documents. **NOTE:** Edit and resend *will* deduct your signature request quota. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/SignatureRequestEditExample.cs /// Thrown when fails to make API call /// The id of the SignatureRequest to edit. /// @@ -663,6 +714,7 @@ public interface ISignatureRequestApiAsync : IApiAccessor /// /// Edits and sends a SignatureRequest with the submitted documents. If `form_fields_per_document` is not specified, a signature page will be affixed where all signers will be required to add their signature, signifying their agreement to all contained documents. **NOTE:** Edit and resend *will* deduct your signature request quota. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/SignatureRequestEditExample.cs /// Thrown when fails to make API call /// The id of the SignatureRequest to edit. /// @@ -676,6 +728,7 @@ public interface ISignatureRequestApiAsync : IApiAccessor /// /// Edits a SignatureRequest with the submitted documents to be signed in an embedded iFrame. If form_fields_per_document is not specified, a signature page will be affixed where all signers will be required to add their signature, signifying their agreement to all contained documents. Note that embedded signature requests can only be signed in embedded iFrames whereas normal signature requests can only be signed on Dropbox Sign. **NOTE:** Edit and resend *will* deduct your signature request quota. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/SignatureRequestEditEmbeddedExample.cs /// Thrown when fails to make API call /// The id of the SignatureRequest to edit. /// @@ -690,6 +743,7 @@ public interface ISignatureRequestApiAsync : IApiAccessor /// /// Edits a SignatureRequest with the submitted documents to be signed in an embedded iFrame. If form_fields_per_document is not specified, a signature page will be affixed where all signers will be required to add their signature, signifying their agreement to all contained documents. Note that embedded signature requests can only be signed in embedded iFrames whereas normal signature requests can only be signed on Dropbox Sign. **NOTE:** Edit and resend *will* deduct your signature request quota. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/SignatureRequestEditEmbeddedExample.cs /// Thrown when fails to make API call /// The id of the SignatureRequest to edit. /// @@ -703,6 +757,7 @@ public interface ISignatureRequestApiAsync : IApiAccessor /// /// Edits a SignatureRequest based on the given Template(s) to be signed in an embedded iFrame. Note that embedded signature requests can only be signed in embedded iFrames whereas normal signature requests can only be signed on Dropbox Sign. **NOTE:** Edit and resend *will* deduct your signature request quota. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/SignatureRequestEditEmbeddedWithTemplateExample.cs /// Thrown when fails to make API call /// The id of the SignatureRequest to edit. /// @@ -717,6 +772,7 @@ public interface ISignatureRequestApiAsync : IApiAccessor /// /// Edits a SignatureRequest based on the given Template(s) to be signed in an embedded iFrame. Note that embedded signature requests can only be signed in embedded iFrames whereas normal signature requests can only be signed on Dropbox Sign. **NOTE:** Edit and resend *will* deduct your signature request quota. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/SignatureRequestEditEmbeddedWithTemplateExample.cs /// Thrown when fails to make API call /// The id of the SignatureRequest to edit. /// @@ -730,6 +786,7 @@ public interface ISignatureRequestApiAsync : IApiAccessor /// /// Edits and sends a SignatureRequest based off of the Template(s) specified with the template_ids parameter. **NOTE:** Edit and resend *will* deduct your signature request quota. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/SignatureRequestEditWithTemplateExample.cs /// Thrown when fails to make API call /// The id of the SignatureRequest to edit. /// @@ -744,6 +801,7 @@ public interface ISignatureRequestApiAsync : IApiAccessor /// /// Edits and sends a SignatureRequest based off of the Template(s) specified with the template_ids parameter. **NOTE:** Edit and resend *will* deduct your signature request quota. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/SignatureRequestEditWithTemplateExample.cs /// Thrown when fails to make API call /// The id of the SignatureRequest to edit. /// @@ -757,6 +815,7 @@ public interface ISignatureRequestApiAsync : IApiAccessor /// /// Obtain a copy of the current documents specified by the `signature_request_id` parameter. Returns a PDF or ZIP file. If the files are currently being prepared, a status code of `409` will be returned instead. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/SignatureRequestFilesExample.cs /// Thrown when fails to make API call /// The id of the SignatureRequest to retrieve. /// Set to `pdf` for a single merged document or `zip` for a collection of individual documents. (optional, default to pdf) @@ -771,6 +830,7 @@ public interface ISignatureRequestApiAsync : IApiAccessor /// /// Obtain a copy of the current documents specified by the `signature_request_id` parameter. Returns a PDF or ZIP file. If the files are currently being prepared, a status code of `409` will be returned instead. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/SignatureRequestFilesExample.cs /// Thrown when fails to make API call /// The id of the SignatureRequest to retrieve. /// Set to `pdf` for a single merged document or `zip` for a collection of individual documents. (optional, default to pdf) @@ -784,6 +844,7 @@ public interface ISignatureRequestApiAsync : IApiAccessor /// /// Obtain a copy of the current documents specified by the `signature_request_id` parameter. Returns a JSON object with a `data_uri` representing the base64 encoded file (PDFs only). If the files are currently being prepared, a status code of `409` will be returned instead. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/SignatureRequestFilesAsDataUriExample.cs /// Thrown when fails to make API call /// The id of the SignatureRequest to retrieve. /// Index associated with the operation. @@ -797,6 +858,7 @@ public interface ISignatureRequestApiAsync : IApiAccessor /// /// Obtain a copy of the current documents specified by the `signature_request_id` parameter. Returns a JSON object with a `data_uri` representing the base64 encoded file (PDFs only). If the files are currently being prepared, a status code of `409` will be returned instead. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/SignatureRequestFilesAsDataUriExample.cs /// Thrown when fails to make API call /// The id of the SignatureRequest to retrieve. /// Index associated with the operation. @@ -809,6 +871,7 @@ public interface ISignatureRequestApiAsync : IApiAccessor /// /// Obtain a copy of the current documents specified by the `signature_request_id` parameter. Returns a JSON object with a url to the file (PDFs only). If the files are currently being prepared, a status code of `409` will be returned instead. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/SignatureRequestFilesAsFileUrlExample.cs /// Thrown when fails to make API call /// The id of the SignatureRequest to retrieve. /// By default when opening the `file_url` a browser will download the PDF and save it locally. When set to `0` the PDF file will be displayed in the browser. (optional, default to 1) @@ -823,6 +886,7 @@ public interface ISignatureRequestApiAsync : IApiAccessor /// /// Obtain a copy of the current documents specified by the `signature_request_id` parameter. Returns a JSON object with a url to the file (PDFs only). If the files are currently being prepared, a status code of `409` will be returned instead. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/SignatureRequestFilesAsFileUrlExample.cs /// Thrown when fails to make API call /// The id of the SignatureRequest to retrieve. /// By default when opening the `file_url` a browser will download the PDF and save it locally. When set to `0` the PDF file will be displayed in the browser. (optional, default to 1) @@ -836,6 +900,7 @@ public interface ISignatureRequestApiAsync : IApiAccessor /// /// Returns the status of the SignatureRequest specified by the `signature_request_id` parameter. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/SignatureRequestGetExample.cs /// Thrown when fails to make API call /// The id of the SignatureRequest to retrieve. /// Index associated with the operation. @@ -849,6 +914,7 @@ public interface ISignatureRequestApiAsync : IApiAccessor /// /// Returns the status of the SignatureRequest specified by the `signature_request_id` parameter. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/SignatureRequestGetExample.cs /// Thrown when fails to make API call /// The id of the SignatureRequest to retrieve. /// Index associated with the operation. @@ -861,6 +927,7 @@ public interface ISignatureRequestApiAsync : IApiAccessor /// /// Returns a list of SignatureRequests that you can access. This includes SignatureRequests you have sent as well as received, but not ones that you have been CCed on. Take a look at our [search guide](/api/reference/search/) to learn more about querying signature requests. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/SignatureRequestListExample.cs /// Thrown when fails to make API call /// Which account to return SignatureRequests for. Must be a team member. Use `all` to indicate all team members. Defaults to your account. (optional) /// Which page number of the SignatureRequest List to return. Defaults to `1`. (optional, default to 1) @@ -877,6 +944,7 @@ public interface ISignatureRequestApiAsync : IApiAccessor /// /// Returns a list of SignatureRequests that you can access. This includes SignatureRequests you have sent as well as received, but not ones that you have been CCed on. Take a look at our [search guide](/api/reference/search/) to learn more about querying signature requests. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/SignatureRequestListExample.cs /// Thrown when fails to make API call /// Which account to return SignatureRequests for. Must be a team member. Use `all` to indicate all team members. Defaults to your account. (optional) /// Which page number of the SignatureRequest List to return. Defaults to `1`. (optional, default to 1) @@ -892,6 +960,7 @@ public interface ISignatureRequestApiAsync : IApiAccessor /// /// Releases a held SignatureRequest that was claimed and prepared from an [UnclaimedDraft](/api/reference/tag/Unclaimed-Draft). The owner of the Draft must indicate at Draft creation that the SignatureRequest created from the Draft should be held. Releasing the SignatureRequest will send requests to all signers. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/SignatureRequestReleaseHoldExample.cs /// Thrown when fails to make API call /// The id of the SignatureRequest to release. /// Index associated with the operation. @@ -905,6 +974,7 @@ public interface ISignatureRequestApiAsync : IApiAccessor /// /// Releases a held SignatureRequest that was claimed and prepared from an [UnclaimedDraft](/api/reference/tag/Unclaimed-Draft). The owner of the Draft must indicate at Draft creation that the SignatureRequest created from the Draft should be held. Releasing the SignatureRequest will send requests to all signers. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/SignatureRequestReleaseHoldExample.cs /// Thrown when fails to make API call /// The id of the SignatureRequest to release. /// Index associated with the operation. @@ -917,6 +987,7 @@ public interface ISignatureRequestApiAsync : IApiAccessor /// /// Sends an email to the signer reminding them to sign the signature request. You cannot send a reminder within 1 hour of the last reminder that was sent. This includes manual AND automatic reminders. **NOTE:** This action can **not** be used with embedded signature requests. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/SignatureRequestRemindExample.cs /// Thrown when fails to make API call /// The id of the SignatureRequest to send a reminder for. /// @@ -931,6 +1002,7 @@ public interface ISignatureRequestApiAsync : IApiAccessor /// /// Sends an email to the signer reminding them to sign the signature request. You cannot send a reminder within 1 hour of the last reminder that was sent. This includes manual AND automatic reminders. **NOTE:** This action can **not** be used with embedded signature requests. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/SignatureRequestRemindExample.cs /// Thrown when fails to make API call /// The id of the SignatureRequest to send a reminder for. /// @@ -944,6 +1016,7 @@ public interface ISignatureRequestApiAsync : IApiAccessor /// /// Removes your access to a completed signature request. This action is **not reversible**. The signature request must be fully executed by all parties (signed or declined to sign). Other parties will continue to maintain access to the completed signature request document(s). Unlike /signature_request/cancel, this endpoint is synchronous and your access will be immediately removed. Upon successful removal, this endpoint will return a 200 OK response. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/SignatureRequestRemoveExample.cs /// Thrown when fails to make API call /// The id of the SignatureRequest to remove. /// Index associated with the operation. @@ -957,6 +1030,7 @@ public interface ISignatureRequestApiAsync : IApiAccessor /// /// Removes your access to a completed signature request. This action is **not reversible**. The signature request must be fully executed by all parties (signed or declined to sign). Other parties will continue to maintain access to the completed signature request document(s). Unlike /signature_request/cancel, this endpoint is synchronous and your access will be immediately removed. Upon successful removal, this endpoint will return a 200 OK response. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/SignatureRequestRemoveExample.cs /// Thrown when fails to make API call /// The id of the SignatureRequest to remove. /// Index associated with the operation. @@ -969,6 +1043,7 @@ public interface ISignatureRequestApiAsync : IApiAccessor /// /// Creates and sends a new SignatureRequest with the submitted documents. If `form_fields_per_document` is not specified, a signature page will be affixed where all signers will be required to add their signature, signifying their agreement to all contained documents. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/SignatureRequestSendExample.cs /// Thrown when fails to make API call /// /// Index associated with the operation. @@ -982,6 +1057,7 @@ public interface ISignatureRequestApiAsync : IApiAccessor /// /// Creates and sends a new SignatureRequest with the submitted documents. If `form_fields_per_document` is not specified, a signature page will be affixed where all signers will be required to add their signature, signifying their agreement to all contained documents. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/SignatureRequestSendExample.cs /// Thrown when fails to make API call /// /// Index associated with the operation. @@ -994,6 +1070,7 @@ public interface ISignatureRequestApiAsync : IApiAccessor /// /// Creates and sends a new SignatureRequest based off of the Template(s) specified with the `template_ids` parameter. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/SignatureRequestSendWithTemplateExample.cs /// Thrown when fails to make API call /// /// Index associated with the operation. @@ -1007,6 +1084,7 @@ public interface ISignatureRequestApiAsync : IApiAccessor /// /// Creates and sends a new SignatureRequest based off of the Template(s) specified with the `template_ids` parameter. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/SignatureRequestSendWithTemplateExample.cs /// Thrown when fails to make API call /// /// Index associated with the operation. @@ -1019,6 +1097,7 @@ public interface ISignatureRequestApiAsync : IApiAccessor /// /// Updates the email address and/or the name for a given signer on a signature request. You can listen for the `signature_request_email_bounce` event on your app or account to detect bounced emails, and respond with this method. Updating the email address of a signer will generate a new `signature_id` value. **NOTE:** This action cannot be performed on a signature request with an appended signature page. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/SignatureRequestUpdateExample.cs /// Thrown when fails to make API call /// The id of the SignatureRequest to update. /// @@ -1033,6 +1112,7 @@ public interface ISignatureRequestApiAsync : IApiAccessor /// /// Updates the email address and/or the name for a given signer on a signature request. You can listen for the `signature_request_email_bounce` event on your app or account to detect bounced emails, and respond with this method. Updating the email address of a signer will generate a new `signature_id` value. **NOTE:** This action cannot be performed on a signature request with an appended signature page. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/SignatureRequestUpdateExample.cs /// Thrown when fails to make API call /// The id of the SignatureRequest to update. /// @@ -1163,6 +1243,7 @@ public Dropbox.Sign.Client.ExceptionFactory ExceptionFactory /// /// Embedded Bulk Send with Template Creates BulkSendJob which sends up to 250 SignatureRequests in bulk based off of the provided Template(s) specified with the `template_ids` parameter to be signed in an embedded iFrame. These embedded signature requests can only be signed in embedded iFrames whereas normal signature requests can only be signed on Dropbox Sign. **NOTE:** Only available for Standard plan and higher. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/SignatureRequestBulkCreateEmbeddedWithTemplateExample.cs /// Thrown when fails to make API call /// /// Index associated with the operation. @@ -1176,6 +1257,7 @@ public BulkSendJobSendResponse SignatureRequestBulkCreateEmbeddedWithTemplate(Si /// /// Embedded Bulk Send with Template Creates BulkSendJob which sends up to 250 SignatureRequests in bulk based off of the provided Template(s) specified with the `template_ids` parameter to be signed in an embedded iFrame. These embedded signature requests can only be signed in embedded iFrames whereas normal signature requests can only be signed on Dropbox Sign. **NOTE:** Only available for Standard plan and higher. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/SignatureRequestBulkCreateEmbeddedWithTemplateExample.cs /// Thrown when fails to make API call /// /// Index associated with the operation. @@ -1247,6 +1329,7 @@ public Dropbox.Sign.Client.ApiResponse SignatureRequest /// /// Embedded Bulk Send with Template Creates BulkSendJob which sends up to 250 SignatureRequests in bulk based off of the provided Template(s) specified with the `template_ids` parameter to be signed in an embedded iFrame. These embedded signature requests can only be signed in embedded iFrames whereas normal signature requests can only be signed on Dropbox Sign. **NOTE:** Only available for Standard plan and higher. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/SignatureRequestBulkCreateEmbeddedWithTemplateExample.cs /// Thrown when fails to make API call /// /// Index associated with the operation. @@ -1261,6 +1344,7 @@ public Dropbox.Sign.Client.ApiResponse SignatureRequest /// /// Embedded Bulk Send with Template Creates BulkSendJob which sends up to 250 SignatureRequests in bulk based off of the provided Template(s) specified with the `template_ids` parameter to be signed in an embedded iFrame. These embedded signature requests can only be signed in embedded iFrames whereas normal signature requests can only be signed on Dropbox Sign. **NOTE:** Only available for Standard plan and higher. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/SignatureRequestBulkCreateEmbeddedWithTemplateExample.cs /// Thrown when fails to make API call /// /// Index associated with the operation. @@ -1335,6 +1419,7 @@ public Dropbox.Sign.Client.ApiResponse SignatureRequest /// /// Bulk Send with Template Creates BulkSendJob which sends up to 250 SignatureRequests in bulk based off of the provided Template(s) specified with the `template_ids` parameter. **NOTE:** Only available for Standard plan and higher. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/SignatureRequestBulkSendWithTemplateExample.cs /// Thrown when fails to make API call /// /// Index associated with the operation. @@ -1348,6 +1433,7 @@ public BulkSendJobSendResponse SignatureRequestBulkSendWithTemplate(SignatureReq /// /// Bulk Send with Template Creates BulkSendJob which sends up to 250 SignatureRequests in bulk based off of the provided Template(s) specified with the `template_ids` parameter. **NOTE:** Only available for Standard plan and higher. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/SignatureRequestBulkSendWithTemplateExample.cs /// Thrown when fails to make API call /// /// Index associated with the operation. @@ -1425,6 +1511,7 @@ public Dropbox.Sign.Client.ApiResponse SignatureRequest /// /// Bulk Send with Template Creates BulkSendJob which sends up to 250 SignatureRequests in bulk based off of the provided Template(s) specified with the `template_ids` parameter. **NOTE:** Only available for Standard plan and higher. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/SignatureRequestBulkSendWithTemplateExample.cs /// Thrown when fails to make API call /// /// Index associated with the operation. @@ -1439,6 +1526,7 @@ public Dropbox.Sign.Client.ApiResponse SignatureRequest /// /// Bulk Send with Template Creates BulkSendJob which sends up to 250 SignatureRequests in bulk based off of the provided Template(s) specified with the `template_ids` parameter. **NOTE:** Only available for Standard plan and higher. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/SignatureRequestBulkSendWithTemplateExample.cs /// Thrown when fails to make API call /// /// Index associated with the operation. @@ -1519,6 +1607,7 @@ public Dropbox.Sign.Client.ApiResponse SignatureRequest /// /// Cancel Incomplete Signature Request Cancels an incomplete signature request. This action is **not reversible**. The request will be canceled and signers will no longer be able to sign. If they try to access the signature request they will receive a HTTP 410 status code indicating that the resource has been deleted. Cancelation is asynchronous and a successful call to this endpoint will return an empty 200 OK response if the signature request is eligible to be canceled and has been successfully queued. This 200 OK response does not indicate a successful cancelation of the signature request itself. The cancelation is confirmed via the `signature_request_canceled` event. It is recommended that a [callback handler](/api/reference/tag/Callbacks-and-Events) be implemented to listen for the `signature_request_canceled` event. This callback will be sent only when the cancelation has completed successfully. If a callback handler has been configured and the event has not been received within 60 minutes of making the call, check the status of the request in the [API Dashboard](https://app.hellosign.com/apidashboard) and retry the cancelation if necessary. To be eligible for cancelation, a signature request must have been sent successfully, must not yet have been signed by all signers, and you must either be the sender or own the API app under which it was sent. A partially signed signature request can be canceled. **NOTE:** To remove your access to a completed signature request, use the endpoint: `POST /signature_request/remove/[:signature_request_id]`. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/SignatureRequestCancelExample.cs /// Thrown when fails to make API call /// The id of the incomplete SignatureRequest to cancel. /// Index associated with the operation. @@ -1531,6 +1620,7 @@ public void SignatureRequestCancel(string signatureRequestId, int operationIndex /// /// Cancel Incomplete Signature Request Cancels an incomplete signature request. This action is **not reversible**. The request will be canceled and signers will no longer be able to sign. If they try to access the signature request they will receive a HTTP 410 status code indicating that the resource has been deleted. Cancelation is asynchronous and a successful call to this endpoint will return an empty 200 OK response if the signature request is eligible to be canceled and has been successfully queued. This 200 OK response does not indicate a successful cancelation of the signature request itself. The cancelation is confirmed via the `signature_request_canceled` event. It is recommended that a [callback handler](/api/reference/tag/Callbacks-and-Events) be implemented to listen for the `signature_request_canceled` event. This callback will be sent only when the cancelation has completed successfully. If a callback handler has been configured and the event has not been received within 60 minutes of making the call, check the status of the request in the [API Dashboard](https://app.hellosign.com/apidashboard) and retry the cancelation if necessary. To be eligible for cancelation, a signature request must have been sent successfully, must not yet have been signed by all signers, and you must either be the sender or own the API app under which it was sent. A partially signed signature request can be canceled. **NOTE:** To remove your access to a completed signature request, use the endpoint: `POST /signature_request/remove/[:signature_request_id]`. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/SignatureRequestCancelExample.cs /// Thrown when fails to make API call /// The id of the incomplete SignatureRequest to cancel. /// Index associated with the operation. @@ -1600,6 +1690,7 @@ public Dropbox.Sign.Client.ApiResponse SignatureRequestCancelWithHttpInf /// /// Cancel Incomplete Signature Request Cancels an incomplete signature request. This action is **not reversible**. The request will be canceled and signers will no longer be able to sign. If they try to access the signature request they will receive a HTTP 410 status code indicating that the resource has been deleted. Cancelation is asynchronous and a successful call to this endpoint will return an empty 200 OK response if the signature request is eligible to be canceled and has been successfully queued. This 200 OK response does not indicate a successful cancelation of the signature request itself. The cancelation is confirmed via the `signature_request_canceled` event. It is recommended that a [callback handler](/api/reference/tag/Callbacks-and-Events) be implemented to listen for the `signature_request_canceled` event. This callback will be sent only when the cancelation has completed successfully. If a callback handler has been configured and the event has not been received within 60 minutes of making the call, check the status of the request in the [API Dashboard](https://app.hellosign.com/apidashboard) and retry the cancelation if necessary. To be eligible for cancelation, a signature request must have been sent successfully, must not yet have been signed by all signers, and you must either be the sender or own the API app under which it was sent. A partially signed signature request can be canceled. **NOTE:** To remove your access to a completed signature request, use the endpoint: `POST /signature_request/remove/[:signature_request_id]`. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/SignatureRequestCancelExample.cs /// Thrown when fails to make API call /// The id of the incomplete SignatureRequest to cancel. /// Index associated with the operation. @@ -1613,6 +1704,7 @@ public Dropbox.Sign.Client.ApiResponse SignatureRequestCancelWithHttpInf /// /// Cancel Incomplete Signature Request Cancels an incomplete signature request. This action is **not reversible**. The request will be canceled and signers will no longer be able to sign. If they try to access the signature request they will receive a HTTP 410 status code indicating that the resource has been deleted. Cancelation is asynchronous and a successful call to this endpoint will return an empty 200 OK response if the signature request is eligible to be canceled and has been successfully queued. This 200 OK response does not indicate a successful cancelation of the signature request itself. The cancelation is confirmed via the `signature_request_canceled` event. It is recommended that a [callback handler](/api/reference/tag/Callbacks-and-Events) be implemented to listen for the `signature_request_canceled` event. This callback will be sent only when the cancelation has completed successfully. If a callback handler has been configured and the event has not been received within 60 minutes of making the call, check the status of the request in the [API Dashboard](https://app.hellosign.com/apidashboard) and retry the cancelation if necessary. To be eligible for cancelation, a signature request must have been sent successfully, must not yet have been signed by all signers, and you must either be the sender or own the API app under which it was sent. A partially signed signature request can be canceled. **NOTE:** To remove your access to a completed signature request, use the endpoint: `POST /signature_request/remove/[:signature_request_id]`. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/SignatureRequestCancelExample.cs /// Thrown when fails to make API call /// The id of the incomplete SignatureRequest to cancel. /// Index associated with the operation. @@ -1685,6 +1777,7 @@ public Dropbox.Sign.Client.ApiResponse SignatureRequestCancelWithHttpInf /// /// Create Embedded Signature Request Creates a new SignatureRequest with the submitted documents to be signed in an embedded iFrame. If form_fields_per_document is not specified, a signature page will be affixed where all signers will be required to add their signature, signifying their agreement to all contained documents. Note that embedded signature requests can only be signed in embedded iFrames whereas normal signature requests can only be signed on Dropbox Sign. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/SignatureRequestCreateEmbeddedExample.cs /// Thrown when fails to make API call /// /// Index associated with the operation. @@ -1698,6 +1791,7 @@ public SignatureRequestGetResponse SignatureRequestCreateEmbedded(SignatureReque /// /// Create Embedded Signature Request Creates a new SignatureRequest with the submitted documents to be signed in an embedded iFrame. If form_fields_per_document is not specified, a signature page will be affixed where all signers will be required to add their signature, signifying their agreement to all contained documents. Note that embedded signature requests can only be signed in embedded iFrames whereas normal signature requests can only be signed on Dropbox Sign. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/SignatureRequestCreateEmbeddedExample.cs /// Thrown when fails to make API call /// /// Index associated with the operation. @@ -1775,6 +1869,7 @@ public Dropbox.Sign.Client.ApiResponse SignatureReq /// /// Create Embedded Signature Request Creates a new SignatureRequest with the submitted documents to be signed in an embedded iFrame. If form_fields_per_document is not specified, a signature page will be affixed where all signers will be required to add their signature, signifying their agreement to all contained documents. Note that embedded signature requests can only be signed in embedded iFrames whereas normal signature requests can only be signed on Dropbox Sign. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/SignatureRequestCreateEmbeddedExample.cs /// Thrown when fails to make API call /// /// Index associated with the operation. @@ -1789,6 +1884,7 @@ public Dropbox.Sign.Client.ApiResponse SignatureReq /// /// Create Embedded Signature Request Creates a new SignatureRequest with the submitted documents to be signed in an embedded iFrame. If form_fields_per_document is not specified, a signature page will be affixed where all signers will be required to add their signature, signifying their agreement to all contained documents. Note that embedded signature requests can only be signed in embedded iFrames whereas normal signature requests can only be signed on Dropbox Sign. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/SignatureRequestCreateEmbeddedExample.cs /// Thrown when fails to make API call /// /// Index associated with the operation. @@ -1869,6 +1965,7 @@ public Dropbox.Sign.Client.ApiResponse SignatureReq /// /// Create Embedded Signature Request with Template Creates a new SignatureRequest based on the given Template(s) to be signed in an embedded iFrame. Note that embedded signature requests can only be signed in embedded iFrames whereas normal signature requests can only be signed on Dropbox Sign. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/SignatureRequestCreateEmbeddedWithTemplateExample.cs /// Thrown when fails to make API call /// /// Index associated with the operation. @@ -1882,6 +1979,7 @@ public SignatureRequestGetResponse SignatureRequestCreateEmbeddedWithTemplate(Si /// /// Create Embedded Signature Request with Template Creates a new SignatureRequest based on the given Template(s) to be signed in an embedded iFrame. Note that embedded signature requests can only be signed in embedded iFrames whereas normal signature requests can only be signed on Dropbox Sign. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/SignatureRequestCreateEmbeddedWithTemplateExample.cs /// Thrown when fails to make API call /// /// Index associated with the operation. @@ -1959,6 +2057,7 @@ public Dropbox.Sign.Client.ApiResponse SignatureReq /// /// Create Embedded Signature Request with Template Creates a new SignatureRequest based on the given Template(s) to be signed in an embedded iFrame. Note that embedded signature requests can only be signed in embedded iFrames whereas normal signature requests can only be signed on Dropbox Sign. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/SignatureRequestCreateEmbeddedWithTemplateExample.cs /// Thrown when fails to make API call /// /// Index associated with the operation. @@ -1973,6 +2072,7 @@ public Dropbox.Sign.Client.ApiResponse SignatureReq /// /// Create Embedded Signature Request with Template Creates a new SignatureRequest based on the given Template(s) to be signed in an embedded iFrame. Note that embedded signature requests can only be signed in embedded iFrames whereas normal signature requests can only be signed on Dropbox Sign. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/SignatureRequestCreateEmbeddedWithTemplateExample.cs /// Thrown when fails to make API call /// /// Index associated with the operation. @@ -2053,6 +2153,7 @@ public Dropbox.Sign.Client.ApiResponse SignatureReq /// /// Edit Signature Request Edits and sends a SignatureRequest with the submitted documents. If `form_fields_per_document` is not specified, a signature page will be affixed where all signers will be required to add their signature, signifying their agreement to all contained documents. **NOTE:** Edit and resend *will* deduct your signature request quota. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/SignatureRequestEditExample.cs /// Thrown when fails to make API call /// The id of the SignatureRequest to edit. /// @@ -2067,6 +2168,7 @@ public SignatureRequestGetResponse SignatureRequestEdit(string signatureRequestI /// /// Edit Signature Request Edits and sends a SignatureRequest with the submitted documents. If `form_fields_per_document` is not specified, a signature page will be affixed where all signers will be required to add their signature, signifying their agreement to all contained documents. **NOTE:** Edit and resend *will* deduct your signature request quota. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/SignatureRequestEditExample.cs /// Thrown when fails to make API call /// The id of the SignatureRequest to edit. /// @@ -2152,6 +2254,7 @@ public Dropbox.Sign.Client.ApiResponse SignatureReq /// /// Edit Signature Request Edits and sends a SignatureRequest with the submitted documents. If `form_fields_per_document` is not specified, a signature page will be affixed where all signers will be required to add their signature, signifying their agreement to all contained documents. **NOTE:** Edit and resend *will* deduct your signature request quota. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/SignatureRequestEditExample.cs /// Thrown when fails to make API call /// The id of the SignatureRequest to edit. /// @@ -2167,6 +2270,7 @@ public Dropbox.Sign.Client.ApiResponse SignatureReq /// /// Edit Signature Request Edits and sends a SignatureRequest with the submitted documents. If `form_fields_per_document` is not specified, a signature page will be affixed where all signers will be required to add their signature, signifying their agreement to all contained documents. **NOTE:** Edit and resend *will* deduct your signature request quota. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/SignatureRequestEditExample.cs /// Thrown when fails to make API call /// The id of the SignatureRequest to edit. /// @@ -2255,6 +2359,7 @@ public Dropbox.Sign.Client.ApiResponse SignatureReq /// /// Edit Embedded Signature Request Edits a SignatureRequest with the submitted documents to be signed in an embedded iFrame. If form_fields_per_document is not specified, a signature page will be affixed where all signers will be required to add their signature, signifying their agreement to all contained documents. Note that embedded signature requests can only be signed in embedded iFrames whereas normal signature requests can only be signed on Dropbox Sign. **NOTE:** Edit and resend *will* deduct your signature request quota. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/SignatureRequestEditEmbeddedExample.cs /// Thrown when fails to make API call /// The id of the SignatureRequest to edit. /// @@ -2269,6 +2374,7 @@ public SignatureRequestGetResponse SignatureRequestEditEmbedded(string signature /// /// Edit Embedded Signature Request Edits a SignatureRequest with the submitted documents to be signed in an embedded iFrame. If form_fields_per_document is not specified, a signature page will be affixed where all signers will be required to add their signature, signifying their agreement to all contained documents. Note that embedded signature requests can only be signed in embedded iFrames whereas normal signature requests can only be signed on Dropbox Sign. **NOTE:** Edit and resend *will* deduct your signature request quota. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/SignatureRequestEditEmbeddedExample.cs /// Thrown when fails to make API call /// The id of the SignatureRequest to edit. /// @@ -2354,6 +2460,7 @@ public Dropbox.Sign.Client.ApiResponse SignatureReq /// /// Edit Embedded Signature Request Edits a SignatureRequest with the submitted documents to be signed in an embedded iFrame. If form_fields_per_document is not specified, a signature page will be affixed where all signers will be required to add their signature, signifying their agreement to all contained documents. Note that embedded signature requests can only be signed in embedded iFrames whereas normal signature requests can only be signed on Dropbox Sign. **NOTE:** Edit and resend *will* deduct your signature request quota. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/SignatureRequestEditEmbeddedExample.cs /// Thrown when fails to make API call /// The id of the SignatureRequest to edit. /// @@ -2369,6 +2476,7 @@ public Dropbox.Sign.Client.ApiResponse SignatureReq /// /// Edit Embedded Signature Request Edits a SignatureRequest with the submitted documents to be signed in an embedded iFrame. If form_fields_per_document is not specified, a signature page will be affixed where all signers will be required to add their signature, signifying their agreement to all contained documents. Note that embedded signature requests can only be signed in embedded iFrames whereas normal signature requests can only be signed on Dropbox Sign. **NOTE:** Edit and resend *will* deduct your signature request quota. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/SignatureRequestEditEmbeddedExample.cs /// Thrown when fails to make API call /// The id of the SignatureRequest to edit. /// @@ -2457,6 +2565,7 @@ public Dropbox.Sign.Client.ApiResponse SignatureReq /// /// Edit Embedded Signature Request with Template Edits a SignatureRequest based on the given Template(s) to be signed in an embedded iFrame. Note that embedded signature requests can only be signed in embedded iFrames whereas normal signature requests can only be signed on Dropbox Sign. **NOTE:** Edit and resend *will* deduct your signature request quota. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/SignatureRequestEditEmbeddedWithTemplateExample.cs /// Thrown when fails to make API call /// The id of the SignatureRequest to edit. /// @@ -2471,6 +2580,7 @@ public SignatureRequestGetResponse SignatureRequestEditEmbeddedWithTemplate(stri /// /// Edit Embedded Signature Request with Template Edits a SignatureRequest based on the given Template(s) to be signed in an embedded iFrame. Note that embedded signature requests can only be signed in embedded iFrames whereas normal signature requests can only be signed on Dropbox Sign. **NOTE:** Edit and resend *will* deduct your signature request quota. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/SignatureRequestEditEmbeddedWithTemplateExample.cs /// Thrown when fails to make API call /// The id of the SignatureRequest to edit. /// @@ -2556,6 +2666,7 @@ public Dropbox.Sign.Client.ApiResponse SignatureReq /// /// Edit Embedded Signature Request with Template Edits a SignatureRequest based on the given Template(s) to be signed in an embedded iFrame. Note that embedded signature requests can only be signed in embedded iFrames whereas normal signature requests can only be signed on Dropbox Sign. **NOTE:** Edit and resend *will* deduct your signature request quota. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/SignatureRequestEditEmbeddedWithTemplateExample.cs /// Thrown when fails to make API call /// The id of the SignatureRequest to edit. /// @@ -2571,6 +2682,7 @@ public Dropbox.Sign.Client.ApiResponse SignatureReq /// /// Edit Embedded Signature Request with Template Edits a SignatureRequest based on the given Template(s) to be signed in an embedded iFrame. Note that embedded signature requests can only be signed in embedded iFrames whereas normal signature requests can only be signed on Dropbox Sign. **NOTE:** Edit and resend *will* deduct your signature request quota. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/SignatureRequestEditEmbeddedWithTemplateExample.cs /// Thrown when fails to make API call /// The id of the SignatureRequest to edit. /// @@ -2659,6 +2771,7 @@ public Dropbox.Sign.Client.ApiResponse SignatureReq /// /// Edit Signature Request With Template Edits and sends a SignatureRequest based off of the Template(s) specified with the template_ids parameter. **NOTE:** Edit and resend *will* deduct your signature request quota. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/SignatureRequestEditWithTemplateExample.cs /// Thrown when fails to make API call /// The id of the SignatureRequest to edit. /// @@ -2673,6 +2786,7 @@ public SignatureRequestGetResponse SignatureRequestEditWithTemplate(string signa /// /// Edit Signature Request With Template Edits and sends a SignatureRequest based off of the Template(s) specified with the template_ids parameter. **NOTE:** Edit and resend *will* deduct your signature request quota. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/SignatureRequestEditWithTemplateExample.cs /// Thrown when fails to make API call /// The id of the SignatureRequest to edit. /// @@ -2758,6 +2872,7 @@ public Dropbox.Sign.Client.ApiResponse SignatureReq /// /// Edit Signature Request With Template Edits and sends a SignatureRequest based off of the Template(s) specified with the template_ids parameter. **NOTE:** Edit and resend *will* deduct your signature request quota. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/SignatureRequestEditWithTemplateExample.cs /// Thrown when fails to make API call /// The id of the SignatureRequest to edit. /// @@ -2773,6 +2888,7 @@ public Dropbox.Sign.Client.ApiResponse SignatureReq /// /// Edit Signature Request With Template Edits and sends a SignatureRequest based off of the Template(s) specified with the template_ids parameter. **NOTE:** Edit and resend *will* deduct your signature request quota. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/SignatureRequestEditWithTemplateExample.cs /// Thrown when fails to make API call /// The id of the SignatureRequest to edit. /// @@ -2861,6 +2977,7 @@ public Dropbox.Sign.Client.ApiResponse SignatureReq /// /// Download Files Obtain a copy of the current documents specified by the `signature_request_id` parameter. Returns a PDF or ZIP file. If the files are currently being prepared, a status code of `409` will be returned instead. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/SignatureRequestFilesExample.cs /// Thrown when fails to make API call /// The id of the SignatureRequest to retrieve. /// Set to `pdf` for a single merged document or `zip` for a collection of individual documents. (optional, default to pdf) @@ -2875,6 +2992,7 @@ public Dropbox.Sign.Client.ApiResponse SignatureReq /// /// Download Files Obtain a copy of the current documents specified by the `signature_request_id` parameter. Returns a PDF or ZIP file. If the files are currently being prepared, a status code of `409` will be returned instead. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/SignatureRequestFilesExample.cs /// Thrown when fails to make API call /// The id of the SignatureRequest to retrieve. /// Set to `pdf` for a single merged document or `zip` for a collection of individual documents. (optional, default to pdf) @@ -2951,6 +3069,7 @@ public Dropbox.Sign.Client.ApiResponse SignatureReq /// /// Download Files Obtain a copy of the current documents specified by the `signature_request_id` parameter. Returns a PDF or ZIP file. If the files are currently being prepared, a status code of `409` will be returned instead. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/SignatureRequestFilesExample.cs /// Thrown when fails to make API call /// The id of the SignatureRequest to retrieve. /// Set to `pdf` for a single merged document or `zip` for a collection of individual documents. (optional, default to pdf) @@ -2966,6 +3085,7 @@ public Dropbox.Sign.Client.ApiResponse SignatureReq /// /// Download Files Obtain a copy of the current documents specified by the `signature_request_id` parameter. Returns a PDF or ZIP file. If the files are currently being prepared, a status code of `409` will be returned instead. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/SignatureRequestFilesExample.cs /// Thrown when fails to make API call /// The id of the SignatureRequest to retrieve. /// Set to `pdf` for a single merged document or `zip` for a collection of individual documents. (optional, default to pdf) @@ -3045,6 +3165,7 @@ public Dropbox.Sign.Client.ApiResponse SignatureReq /// /// Download Files as Data Uri Obtain a copy of the current documents specified by the `signature_request_id` parameter. Returns a JSON object with a `data_uri` representing the base64 encoded file (PDFs only). If the files are currently being prepared, a status code of `409` will be returned instead. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/SignatureRequestFilesAsDataUriExample.cs /// Thrown when fails to make API call /// The id of the SignatureRequest to retrieve. /// Index associated with the operation. @@ -3058,6 +3179,7 @@ public FileResponseDataUri SignatureRequestFilesAsDataUri(string signatureReques /// /// Download Files as Data Uri Obtain a copy of the current documents specified by the `signature_request_id` parameter. Returns a JSON object with a `data_uri` representing the base64 encoded file (PDFs only). If the files are currently being prepared, a status code of `409` will be returned instead. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/SignatureRequestFilesAsDataUriExample.cs /// Thrown when fails to make API call /// The id of the SignatureRequest to retrieve. /// Index associated with the operation. @@ -3127,6 +3249,7 @@ public Dropbox.Sign.Client.ApiResponse SignatureRequestFile /// /// Download Files as Data Uri Obtain a copy of the current documents specified by the `signature_request_id` parameter. Returns a JSON object with a `data_uri` representing the base64 encoded file (PDFs only). If the files are currently being prepared, a status code of `409` will be returned instead. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/SignatureRequestFilesAsDataUriExample.cs /// Thrown when fails to make API call /// The id of the SignatureRequest to retrieve. /// Index associated with the operation. @@ -3141,6 +3264,7 @@ public Dropbox.Sign.Client.ApiResponse SignatureRequestFile /// /// Download Files as Data Uri Obtain a copy of the current documents specified by the `signature_request_id` parameter. Returns a JSON object with a `data_uri` representing the base64 encoded file (PDFs only). If the files are currently being prepared, a status code of `409` will be returned instead. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/SignatureRequestFilesAsDataUriExample.cs /// Thrown when fails to make API call /// The id of the SignatureRequest to retrieve. /// Index associated with the operation. @@ -3213,6 +3337,7 @@ public Dropbox.Sign.Client.ApiResponse SignatureRequestFile /// /// Download Files as File Url Obtain a copy of the current documents specified by the `signature_request_id` parameter. Returns a JSON object with a url to the file (PDFs only). If the files are currently being prepared, a status code of `409` will be returned instead. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/SignatureRequestFilesAsFileUrlExample.cs /// Thrown when fails to make API call /// The id of the SignatureRequest to retrieve. /// By default when opening the `file_url` a browser will download the PDF and save it locally. When set to `0` the PDF file will be displayed in the browser. (optional, default to 1) @@ -3227,6 +3352,7 @@ public Dropbox.Sign.Client.ApiResponse SignatureRequestFile /// /// Download Files as File Url Obtain a copy of the current documents specified by the `signature_request_id` parameter. Returns a JSON object with a url to the file (PDFs only). If the files are currently being prepared, a status code of `409` will be returned instead. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/SignatureRequestFilesAsFileUrlExample.cs /// Thrown when fails to make API call /// The id of the SignatureRequest to retrieve. /// By default when opening the `file_url` a browser will download the PDF and save it locally. When set to `0` the PDF file will be displayed in the browser. (optional, default to 1) @@ -3301,6 +3427,7 @@ public Dropbox.Sign.Client.ApiResponse SignatureRequestFile /// /// Download Files as File Url Obtain a copy of the current documents specified by the `signature_request_id` parameter. Returns a JSON object with a url to the file (PDFs only). If the files are currently being prepared, a status code of `409` will be returned instead. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/SignatureRequestFilesAsFileUrlExample.cs /// Thrown when fails to make API call /// The id of the SignatureRequest to retrieve. /// By default when opening the `file_url` a browser will download the PDF and save it locally. When set to `0` the PDF file will be displayed in the browser. (optional, default to 1) @@ -3316,6 +3443,7 @@ public Dropbox.Sign.Client.ApiResponse SignatureRequestFile /// /// Download Files as File Url Obtain a copy of the current documents specified by the `signature_request_id` parameter. Returns a JSON object with a url to the file (PDFs only). If the files are currently being prepared, a status code of `409` will be returned instead. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/SignatureRequestFilesAsFileUrlExample.cs /// Thrown when fails to make API call /// The id of the SignatureRequest to retrieve. /// By default when opening the `file_url` a browser will download the PDF and save it locally. When set to `0` the PDF file will be displayed in the browser. (optional, default to 1) @@ -3393,6 +3521,7 @@ public Dropbox.Sign.Client.ApiResponse SignatureRequestFile /// /// Get Signature Request Returns the status of the SignatureRequest specified by the `signature_request_id` parameter. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/SignatureRequestGetExample.cs /// Thrown when fails to make API call /// The id of the SignatureRequest to retrieve. /// Index associated with the operation. @@ -3406,6 +3535,7 @@ public SignatureRequestGetResponse SignatureRequestGet(string signatureRequestId /// /// Get Signature Request Returns the status of the SignatureRequest specified by the `signature_request_id` parameter. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/SignatureRequestGetExample.cs /// Thrown when fails to make API call /// The id of the SignatureRequest to retrieve. /// Index associated with the operation. @@ -3475,6 +3605,7 @@ public Dropbox.Sign.Client.ApiResponse SignatureReq /// /// Get Signature Request Returns the status of the SignatureRequest specified by the `signature_request_id` parameter. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/SignatureRequestGetExample.cs /// Thrown when fails to make API call /// The id of the SignatureRequest to retrieve. /// Index associated with the operation. @@ -3489,6 +3620,7 @@ public Dropbox.Sign.Client.ApiResponse SignatureReq /// /// Get Signature Request Returns the status of the SignatureRequest specified by the `signature_request_id` parameter. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/SignatureRequestGetExample.cs /// Thrown when fails to make API call /// The id of the SignatureRequest to retrieve. /// Index associated with the operation. @@ -3561,6 +3693,7 @@ public Dropbox.Sign.Client.ApiResponse SignatureReq /// /// List Signature Requests Returns a list of SignatureRequests that you can access. This includes SignatureRequests you have sent as well as received, but not ones that you have been CCed on. Take a look at our [search guide](/api/reference/search/) to learn more about querying signature requests. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/SignatureRequestListExample.cs /// Thrown when fails to make API call /// Which account to return SignatureRequests for. Must be a team member. Use `all` to indicate all team members. Defaults to your account. (optional) /// Which page number of the SignatureRequest List to return. Defaults to `1`. (optional, default to 1) @@ -3577,6 +3710,7 @@ public Dropbox.Sign.Client.ApiResponse SignatureReq /// /// List Signature Requests Returns a list of SignatureRequests that you can access. This includes SignatureRequests you have sent as well as received, but not ones that you have been CCed on. Take a look at our [search guide](/api/reference/search/) to learn more about querying signature requests. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/SignatureRequestListExample.cs /// Thrown when fails to make API call /// Which account to return SignatureRequests for. Must be a team member. Use `all` to indicate all team members. Defaults to your account. (optional) /// Which page number of the SignatureRequest List to return. Defaults to `1`. (optional, default to 1) @@ -3658,6 +3792,7 @@ public Dropbox.Sign.Client.ApiResponse SignatureReq /// /// List Signature Requests Returns a list of SignatureRequests that you can access. This includes SignatureRequests you have sent as well as received, but not ones that you have been CCed on. Take a look at our [search guide](/api/reference/search/) to learn more about querying signature requests. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/SignatureRequestListExample.cs /// Thrown when fails to make API call /// Which account to return SignatureRequests for. Must be a team member. Use `all` to indicate all team members. Defaults to your account. (optional) /// Which page number of the SignatureRequest List to return. Defaults to `1`. (optional, default to 1) @@ -3675,6 +3810,7 @@ public Dropbox.Sign.Client.ApiResponse SignatureReq /// /// List Signature Requests Returns a list of SignatureRequests that you can access. This includes SignatureRequests you have sent as well as received, but not ones that you have been CCed on. Take a look at our [search guide](/api/reference/search/) to learn more about querying signature requests. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/SignatureRequestListExample.cs /// Thrown when fails to make API call /// Which account to return SignatureRequests for. Must be a team member. Use `all` to indicate all team members. Defaults to your account. (optional) /// Which page number of the SignatureRequest List to return. Defaults to `1`. (optional, default to 1) @@ -3759,6 +3895,7 @@ public Dropbox.Sign.Client.ApiResponse SignatureReq /// /// Release On-Hold Signature Request Releases a held SignatureRequest that was claimed and prepared from an [UnclaimedDraft](/api/reference/tag/Unclaimed-Draft). The owner of the Draft must indicate at Draft creation that the SignatureRequest created from the Draft should be held. Releasing the SignatureRequest will send requests to all signers. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/SignatureRequestReleaseHoldExample.cs /// Thrown when fails to make API call /// The id of the SignatureRequest to release. /// Index associated with the operation. @@ -3772,6 +3909,7 @@ public SignatureRequestGetResponse SignatureRequestReleaseHold(string signatureR /// /// Release On-Hold Signature Request Releases a held SignatureRequest that was claimed and prepared from an [UnclaimedDraft](/api/reference/tag/Unclaimed-Draft). The owner of the Draft must indicate at Draft creation that the SignatureRequest created from the Draft should be held. Releasing the SignatureRequest will send requests to all signers. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/SignatureRequestReleaseHoldExample.cs /// Thrown when fails to make API call /// The id of the SignatureRequest to release. /// Index associated with the operation. @@ -3841,6 +3979,7 @@ public Dropbox.Sign.Client.ApiResponse SignatureReq /// /// Release On-Hold Signature Request Releases a held SignatureRequest that was claimed and prepared from an [UnclaimedDraft](/api/reference/tag/Unclaimed-Draft). The owner of the Draft must indicate at Draft creation that the SignatureRequest created from the Draft should be held. Releasing the SignatureRequest will send requests to all signers. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/SignatureRequestReleaseHoldExample.cs /// Thrown when fails to make API call /// The id of the SignatureRequest to release. /// Index associated with the operation. @@ -3855,6 +3994,7 @@ public Dropbox.Sign.Client.ApiResponse SignatureReq /// /// Release On-Hold Signature Request Releases a held SignatureRequest that was claimed and prepared from an [UnclaimedDraft](/api/reference/tag/Unclaimed-Draft). The owner of the Draft must indicate at Draft creation that the SignatureRequest created from the Draft should be held. Releasing the SignatureRequest will send requests to all signers. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/SignatureRequestReleaseHoldExample.cs /// Thrown when fails to make API call /// The id of the SignatureRequest to release. /// Index associated with the operation. @@ -3927,6 +4067,7 @@ public Dropbox.Sign.Client.ApiResponse SignatureReq /// /// Send Request Reminder Sends an email to the signer reminding them to sign the signature request. You cannot send a reminder within 1 hour of the last reminder that was sent. This includes manual AND automatic reminders. **NOTE:** This action can **not** be used with embedded signature requests. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/SignatureRequestRemindExample.cs /// Thrown when fails to make API call /// The id of the SignatureRequest to send a reminder for. /// @@ -3941,6 +4082,7 @@ public SignatureRequestGetResponse SignatureRequestRemind(string signatureReques /// /// Send Request Reminder Sends an email to the signer reminding them to sign the signature request. You cannot send a reminder within 1 hour of the last reminder that was sent. This includes manual AND automatic reminders. **NOTE:** This action can **not** be used with embedded signature requests. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/SignatureRequestRemindExample.cs /// Thrown when fails to make API call /// The id of the SignatureRequest to send a reminder for. /// @@ -4026,6 +4168,7 @@ public Dropbox.Sign.Client.ApiResponse SignatureReq /// /// Send Request Reminder Sends an email to the signer reminding them to sign the signature request. You cannot send a reminder within 1 hour of the last reminder that was sent. This includes manual AND automatic reminders. **NOTE:** This action can **not** be used with embedded signature requests. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/SignatureRequestRemindExample.cs /// Thrown when fails to make API call /// The id of the SignatureRequest to send a reminder for. /// @@ -4041,6 +4184,7 @@ public Dropbox.Sign.Client.ApiResponse SignatureReq /// /// Send Request Reminder Sends an email to the signer reminding them to sign the signature request. You cannot send a reminder within 1 hour of the last reminder that was sent. This includes manual AND automatic reminders. **NOTE:** This action can **not** be used with embedded signature requests. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/SignatureRequestRemindExample.cs /// Thrown when fails to make API call /// The id of the SignatureRequest to send a reminder for. /// @@ -4129,6 +4273,7 @@ public Dropbox.Sign.Client.ApiResponse SignatureReq /// /// Remove Signature Request Access Removes your access to a completed signature request. This action is **not reversible**. The signature request must be fully executed by all parties (signed or declined to sign). Other parties will continue to maintain access to the completed signature request document(s). Unlike /signature_request/cancel, this endpoint is synchronous and your access will be immediately removed. Upon successful removal, this endpoint will return a 200 OK response. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/SignatureRequestRemoveExample.cs /// Thrown when fails to make API call /// The id of the SignatureRequest to remove. /// Index associated with the operation. @@ -4141,6 +4286,7 @@ public void SignatureRequestRemove(string signatureRequestId, int operationIndex /// /// Remove Signature Request Access Removes your access to a completed signature request. This action is **not reversible**. The signature request must be fully executed by all parties (signed or declined to sign). Other parties will continue to maintain access to the completed signature request document(s). Unlike /signature_request/cancel, this endpoint is synchronous and your access will be immediately removed. Upon successful removal, this endpoint will return a 200 OK response. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/SignatureRequestRemoveExample.cs /// Thrown when fails to make API call /// The id of the SignatureRequest to remove. /// Index associated with the operation. @@ -4204,6 +4350,7 @@ public Dropbox.Sign.Client.ApiResponse SignatureRequestRemoveWithHttpInf /// /// Remove Signature Request Access Removes your access to a completed signature request. This action is **not reversible**. The signature request must be fully executed by all parties (signed or declined to sign). Other parties will continue to maintain access to the completed signature request document(s). Unlike /signature_request/cancel, this endpoint is synchronous and your access will be immediately removed. Upon successful removal, this endpoint will return a 200 OK response. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/SignatureRequestRemoveExample.cs /// Thrown when fails to make API call /// The id of the SignatureRequest to remove. /// Index associated with the operation. @@ -4217,6 +4364,7 @@ public Dropbox.Sign.Client.ApiResponse SignatureRequestRemoveWithHttpInf /// /// Remove Signature Request Access Removes your access to a completed signature request. This action is **not reversible**. The signature request must be fully executed by all parties (signed or declined to sign). Other parties will continue to maintain access to the completed signature request document(s). Unlike /signature_request/cancel, this endpoint is synchronous and your access will be immediately removed. Upon successful removal, this endpoint will return a 200 OK response. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/SignatureRequestRemoveExample.cs /// Thrown when fails to make API call /// The id of the SignatureRequest to remove. /// Index associated with the operation. @@ -4283,6 +4431,7 @@ public Dropbox.Sign.Client.ApiResponse SignatureRequestRemoveWithHttpInf /// /// Send Signature Request Creates and sends a new SignatureRequest with the submitted documents. If `form_fields_per_document` is not specified, a signature page will be affixed where all signers will be required to add their signature, signifying their agreement to all contained documents. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/SignatureRequestSendExample.cs /// Thrown when fails to make API call /// /// Index associated with the operation. @@ -4296,6 +4445,7 @@ public SignatureRequestGetResponse SignatureRequestSend(SignatureRequestSendRequ /// /// Send Signature Request Creates and sends a new SignatureRequest with the submitted documents. If `form_fields_per_document` is not specified, a signature page will be affixed where all signers will be required to add their signature, signifying their agreement to all contained documents. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/SignatureRequestSendExample.cs /// Thrown when fails to make API call /// /// Index associated with the operation. @@ -4373,6 +4523,7 @@ public Dropbox.Sign.Client.ApiResponse SignatureReq /// /// Send Signature Request Creates and sends a new SignatureRequest with the submitted documents. If `form_fields_per_document` is not specified, a signature page will be affixed where all signers will be required to add their signature, signifying their agreement to all contained documents. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/SignatureRequestSendExample.cs /// Thrown when fails to make API call /// /// Index associated with the operation. @@ -4387,6 +4538,7 @@ public Dropbox.Sign.Client.ApiResponse SignatureReq /// /// Send Signature Request Creates and sends a new SignatureRequest with the submitted documents. If `form_fields_per_document` is not specified, a signature page will be affixed where all signers will be required to add their signature, signifying their agreement to all contained documents. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/SignatureRequestSendExample.cs /// Thrown when fails to make API call /// /// Index associated with the operation. @@ -4467,6 +4619,7 @@ public Dropbox.Sign.Client.ApiResponse SignatureReq /// /// Send with Template Creates and sends a new SignatureRequest based off of the Template(s) specified with the `template_ids` parameter. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/SignatureRequestSendWithTemplateExample.cs /// Thrown when fails to make API call /// /// Index associated with the operation. @@ -4480,6 +4633,7 @@ public SignatureRequestGetResponse SignatureRequestSendWithTemplate(SignatureReq /// /// Send with Template Creates and sends a new SignatureRequest based off of the Template(s) specified with the `template_ids` parameter. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/SignatureRequestSendWithTemplateExample.cs /// Thrown when fails to make API call /// /// Index associated with the operation. @@ -4557,6 +4711,7 @@ public Dropbox.Sign.Client.ApiResponse SignatureReq /// /// Send with Template Creates and sends a new SignatureRequest based off of the Template(s) specified with the `template_ids` parameter. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/SignatureRequestSendWithTemplateExample.cs /// Thrown when fails to make API call /// /// Index associated with the operation. @@ -4571,6 +4726,7 @@ public Dropbox.Sign.Client.ApiResponse SignatureReq /// /// Send with Template Creates and sends a new SignatureRequest based off of the Template(s) specified with the `template_ids` parameter. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/SignatureRequestSendWithTemplateExample.cs /// Thrown when fails to make API call /// /// Index associated with the operation. @@ -4651,6 +4807,7 @@ public Dropbox.Sign.Client.ApiResponse SignatureReq /// /// Update Signature Request Updates the email address and/or the name for a given signer on a signature request. You can listen for the `signature_request_email_bounce` event on your app or account to detect bounced emails, and respond with this method. Updating the email address of a signer will generate a new `signature_id` value. **NOTE:** This action cannot be performed on a signature request with an appended signature page. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/SignatureRequestUpdateExample.cs /// Thrown when fails to make API call /// The id of the SignatureRequest to update. /// @@ -4665,6 +4822,7 @@ public SignatureRequestGetResponse SignatureRequestUpdate(string signatureReques /// /// Update Signature Request Updates the email address and/or the name for a given signer on a signature request. You can listen for the `signature_request_email_bounce` event on your app or account to detect bounced emails, and respond with this method. Updating the email address of a signer will generate a new `signature_id` value. **NOTE:** This action cannot be performed on a signature request with an appended signature page. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/SignatureRequestUpdateExample.cs /// Thrown when fails to make API call /// The id of the SignatureRequest to update. /// @@ -4750,6 +4908,7 @@ public Dropbox.Sign.Client.ApiResponse SignatureReq /// /// Update Signature Request Updates the email address and/or the name for a given signer on a signature request. You can listen for the `signature_request_email_bounce` event on your app or account to detect bounced emails, and respond with this method. Updating the email address of a signer will generate a new `signature_id` value. **NOTE:** This action cannot be performed on a signature request with an appended signature page. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/SignatureRequestUpdateExample.cs /// Thrown when fails to make API call /// The id of the SignatureRequest to update. /// @@ -4765,6 +4924,7 @@ public Dropbox.Sign.Client.ApiResponse SignatureReq /// /// Update Signature Request Updates the email address and/or the name for a given signer on a signature request. You can listen for the `signature_request_email_bounce` event on your app or account to detect bounced emails, and respond with this method. Updating the email address of a signer will generate a new `signature_id` value. **NOTE:** This action cannot be performed on a signature request with an appended signature page. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/SignatureRequestUpdateExample.cs /// Thrown when fails to make API call /// The id of the SignatureRequest to update. /// diff --git a/sdks/dotnet/src/Dropbox.Sign/Api/TeamApi.cs b/sdks/dotnet/src/Dropbox.Sign/Api/TeamApi.cs index 8fd6f3b1c..fd94530dd 100644 --- a/sdks/dotnet/src/Dropbox.Sign/Api/TeamApi.cs +++ b/sdks/dotnet/src/Dropbox.Sign/Api/TeamApi.cs @@ -33,6 +33,7 @@ public interface ITeamApiSync : IApiAccessor /// /// Invites a user (specified using the `email_address` parameter) to your Team. If the user does not currently have a Dropbox Sign Account, a new one will be created for them. If a user is already a part of another Team, a `team_invite_failed` error will be returned. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/TeamAddMemberExample.cs /// Thrown when fails to make API call /// /// The id of the team. (optional) @@ -46,6 +47,7 @@ public interface ITeamApiSync : IApiAccessor /// /// Invites a user (specified using the `email_address` parameter) to your Team. If the user does not currently have a Dropbox Sign Account, a new one will be created for them. If a user is already a part of another Team, a `team_invite_failed` error will be returned. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/TeamAddMemberExample.cs /// Thrown when fails to make API call /// /// The id of the team. (optional) @@ -58,6 +60,7 @@ public interface ITeamApiSync : IApiAccessor /// /// Creates a new Team and makes you a member. You must not currently belong to a Team to invoke. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/TeamCreateExample.cs /// Thrown when fails to make API call /// /// Index associated with the operation. @@ -70,6 +73,7 @@ public interface ITeamApiSync : IApiAccessor /// /// Creates a new Team and makes you a member. You must not currently belong to a Team to invoke. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/TeamCreateExample.cs /// Thrown when fails to make API call /// /// Index associated with the operation. @@ -81,6 +85,7 @@ public interface ITeamApiSync : IApiAccessor /// /// Deletes your Team. Can only be invoked when you have a Team with only one member (yourself). /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/TeamDeleteExample.cs /// Thrown when fails to make API call /// Index associated with the operation. /// @@ -92,6 +97,7 @@ public interface ITeamApiSync : IApiAccessor /// /// Deletes your Team. Can only be invoked when you have a Team with only one member (yourself). /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/TeamDeleteExample.cs /// Thrown when fails to make API call /// Index associated with the operation. /// ApiResponse of Object(void) @@ -102,6 +108,7 @@ public interface ITeamApiSync : IApiAccessor /// /// Returns information about your Team as well as a list of its members. If you do not belong to a Team, a 404 error with an error_name of \"not_found\" will be returned. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/TeamGetExample.cs /// Thrown when fails to make API call /// Index associated with the operation. /// TeamGetResponse @@ -113,6 +120,7 @@ public interface ITeamApiSync : IApiAccessor /// /// Returns information about your Team as well as a list of its members. If you do not belong to a Team, a 404 error with an error_name of \"not_found\" will be returned. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/TeamGetExample.cs /// Thrown when fails to make API call /// Index associated with the operation. /// ApiResponse of TeamGetResponse @@ -123,6 +131,7 @@ public interface ITeamApiSync : IApiAccessor /// /// Provides information about a team. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/TeamInfoExample.cs /// Thrown when fails to make API call /// The id of the team. (optional) /// Index associated with the operation. @@ -135,6 +144,7 @@ public interface ITeamApiSync : IApiAccessor /// /// Provides information about a team. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/TeamInfoExample.cs /// Thrown when fails to make API call /// The id of the team. (optional) /// Index associated with the operation. @@ -146,6 +156,7 @@ public interface ITeamApiSync : IApiAccessor /// /// Provides a list of team invites (and their roles). /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/TeamInvitesExample.cs /// Thrown when fails to make API call /// The email address for which to display the team invites. (optional) /// Index associated with the operation. @@ -158,6 +169,7 @@ public interface ITeamApiSync : IApiAccessor /// /// Provides a list of team invites (and their roles). /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/TeamInvitesExample.cs /// Thrown when fails to make API call /// The email address for which to display the team invites. (optional) /// Index associated with the operation. @@ -169,6 +181,7 @@ public interface ITeamApiSync : IApiAccessor /// /// Provides a paginated list of members (and their roles) that belong to a given team. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/TeamMembersExample.cs /// Thrown when fails to make API call /// The id of the team that a member list is being requested from. /// Which page number of the team member list to return. Defaults to `1`. (optional, default to 1) @@ -183,6 +196,7 @@ public interface ITeamApiSync : IApiAccessor /// /// Provides a paginated list of members (and their roles) that belong to a given team. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/TeamMembersExample.cs /// Thrown when fails to make API call /// The id of the team that a member list is being requested from. /// Which page number of the team member list to return. Defaults to `1`. (optional, default to 1) @@ -196,6 +210,7 @@ public interface ITeamApiSync : IApiAccessor /// /// Removes the provided user Account from your Team. If the Account had an outstanding invitation to your Team, the invitation will be expired. If you choose to transfer documents from the removed Account to an Account provided in the `new_owner_email_address` parameter (available only for Enterprise plans), the response status code will be 201, which indicates that your request has been queued but not fully executed. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/TeamRemoveMemberExample.cs /// Thrown when fails to make API call /// /// Index associated with the operation. @@ -208,6 +223,7 @@ public interface ITeamApiSync : IApiAccessor /// /// Removes the provided user Account from your Team. If the Account had an outstanding invitation to your Team, the invitation will be expired. If you choose to transfer documents from the removed Account to an Account provided in the `new_owner_email_address` parameter (available only for Enterprise plans), the response status code will be 201, which indicates that your request has been queued but not fully executed. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/TeamRemoveMemberExample.cs /// Thrown when fails to make API call /// /// Index associated with the operation. @@ -219,6 +235,7 @@ public interface ITeamApiSync : IApiAccessor /// /// Provides a paginated list of sub teams that belong to a given team. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/TeamSubTeamsExample.cs /// Thrown when fails to make API call /// The id of the parent Team. /// Which page number of the SubTeam List to return. Defaults to `1`. (optional, default to 1) @@ -233,6 +250,7 @@ public interface ITeamApiSync : IApiAccessor /// /// Provides a paginated list of sub teams that belong to a given team. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/TeamSubTeamsExample.cs /// Thrown when fails to make API call /// The id of the parent Team. /// Which page number of the SubTeam List to return. Defaults to `1`. (optional, default to 1) @@ -246,6 +264,7 @@ public interface ITeamApiSync : IApiAccessor /// /// Updates the name of your Team. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/TeamUpdateExample.cs /// Thrown when fails to make API call /// /// Index associated with the operation. @@ -258,6 +277,7 @@ public interface ITeamApiSync : IApiAccessor /// /// Updates the name of your Team. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/TeamUpdateExample.cs /// Thrown when fails to make API call /// /// Index associated with the operation. @@ -278,6 +298,7 @@ public interface ITeamApiAsync : IApiAccessor /// /// Invites a user (specified using the `email_address` parameter) to your Team. If the user does not currently have a Dropbox Sign Account, a new one will be created for them. If a user is already a part of another Team, a `team_invite_failed` error will be returned. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/TeamAddMemberExample.cs /// Thrown when fails to make API call /// /// The id of the team. (optional) @@ -292,6 +313,7 @@ public interface ITeamApiAsync : IApiAccessor /// /// Invites a user (specified using the `email_address` parameter) to your Team. If the user does not currently have a Dropbox Sign Account, a new one will be created for them. If a user is already a part of another Team, a `team_invite_failed` error will be returned. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/TeamAddMemberExample.cs /// Thrown when fails to make API call /// /// The id of the team. (optional) @@ -305,6 +327,7 @@ public interface ITeamApiAsync : IApiAccessor /// /// Creates a new Team and makes you a member. You must not currently belong to a Team to invoke. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/TeamCreateExample.cs /// Thrown when fails to make API call /// /// Index associated with the operation. @@ -318,6 +341,7 @@ public interface ITeamApiAsync : IApiAccessor /// /// Creates a new Team and makes you a member. You must not currently belong to a Team to invoke. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/TeamCreateExample.cs /// Thrown when fails to make API call /// /// Index associated with the operation. @@ -330,6 +354,7 @@ public interface ITeamApiAsync : IApiAccessor /// /// Deletes your Team. Can only be invoked when you have a Team with only one member (yourself). /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/TeamDeleteExample.cs /// Thrown when fails to make API call /// Index associated with the operation. /// Cancellation Token to cancel the request. @@ -342,6 +367,7 @@ public interface ITeamApiAsync : IApiAccessor /// /// Deletes your Team. Can only be invoked when you have a Team with only one member (yourself). /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/TeamDeleteExample.cs /// Thrown when fails to make API call /// Index associated with the operation. /// Cancellation Token to cancel the request. @@ -353,6 +379,7 @@ public interface ITeamApiAsync : IApiAccessor /// /// Returns information about your Team as well as a list of its members. If you do not belong to a Team, a 404 error with an error_name of \"not_found\" will be returned. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/TeamGetExample.cs /// Thrown when fails to make API call /// Index associated with the operation. /// Cancellation Token to cancel the request. @@ -365,6 +392,7 @@ public interface ITeamApiAsync : IApiAccessor /// /// Returns information about your Team as well as a list of its members. If you do not belong to a Team, a 404 error with an error_name of \"not_found\" will be returned. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/TeamGetExample.cs /// Thrown when fails to make API call /// Index associated with the operation. /// Cancellation Token to cancel the request. @@ -376,6 +404,7 @@ public interface ITeamApiAsync : IApiAccessor /// /// Provides information about a team. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/TeamInfoExample.cs /// Thrown when fails to make API call /// The id of the team. (optional) /// Index associated with the operation. @@ -389,6 +418,7 @@ public interface ITeamApiAsync : IApiAccessor /// /// Provides information about a team. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/TeamInfoExample.cs /// Thrown when fails to make API call /// The id of the team. (optional) /// Index associated with the operation. @@ -401,6 +431,7 @@ public interface ITeamApiAsync : IApiAccessor /// /// Provides a list of team invites (and their roles). /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/TeamInvitesExample.cs /// Thrown when fails to make API call /// The email address for which to display the team invites. (optional) /// Index associated with the operation. @@ -414,6 +445,7 @@ public interface ITeamApiAsync : IApiAccessor /// /// Provides a list of team invites (and their roles). /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/TeamInvitesExample.cs /// Thrown when fails to make API call /// The email address for which to display the team invites. (optional) /// Index associated with the operation. @@ -426,6 +458,7 @@ public interface ITeamApiAsync : IApiAccessor /// /// Provides a paginated list of members (and their roles) that belong to a given team. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/TeamMembersExample.cs /// Thrown when fails to make API call /// The id of the team that a member list is being requested from. /// Which page number of the team member list to return. Defaults to `1`. (optional, default to 1) @@ -441,6 +474,7 @@ public interface ITeamApiAsync : IApiAccessor /// /// Provides a paginated list of members (and their roles) that belong to a given team. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/TeamMembersExample.cs /// Thrown when fails to make API call /// The id of the team that a member list is being requested from. /// Which page number of the team member list to return. Defaults to `1`. (optional, default to 1) @@ -455,6 +489,7 @@ public interface ITeamApiAsync : IApiAccessor /// /// Removes the provided user Account from your Team. If the Account had an outstanding invitation to your Team, the invitation will be expired. If you choose to transfer documents from the removed Account to an Account provided in the `new_owner_email_address` parameter (available only for Enterprise plans), the response status code will be 201, which indicates that your request has been queued but not fully executed. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/TeamRemoveMemberExample.cs /// Thrown when fails to make API call /// /// Index associated with the operation. @@ -468,6 +503,7 @@ public interface ITeamApiAsync : IApiAccessor /// /// Removes the provided user Account from your Team. If the Account had an outstanding invitation to your Team, the invitation will be expired. If you choose to transfer documents from the removed Account to an Account provided in the `new_owner_email_address` parameter (available only for Enterprise plans), the response status code will be 201, which indicates that your request has been queued but not fully executed. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/TeamRemoveMemberExample.cs /// Thrown when fails to make API call /// /// Index associated with the operation. @@ -480,6 +516,7 @@ public interface ITeamApiAsync : IApiAccessor /// /// Provides a paginated list of sub teams that belong to a given team. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/TeamSubTeamsExample.cs /// Thrown when fails to make API call /// The id of the parent Team. /// Which page number of the SubTeam List to return. Defaults to `1`. (optional, default to 1) @@ -495,6 +532,7 @@ public interface ITeamApiAsync : IApiAccessor /// /// Provides a paginated list of sub teams that belong to a given team. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/TeamSubTeamsExample.cs /// Thrown when fails to make API call /// The id of the parent Team. /// Which page number of the SubTeam List to return. Defaults to `1`. (optional, default to 1) @@ -509,6 +547,7 @@ public interface ITeamApiAsync : IApiAccessor /// /// Updates the name of your Team. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/TeamUpdateExample.cs /// Thrown when fails to make API call /// /// Index associated with the operation. @@ -522,6 +561,7 @@ public interface ITeamApiAsync : IApiAccessor /// /// Updates the name of your Team. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/TeamUpdateExample.cs /// Thrown when fails to make API call /// /// Index associated with the operation. @@ -651,6 +691,7 @@ public Dropbox.Sign.Client.ExceptionFactory ExceptionFactory /// /// Add User to Team Invites a user (specified using the `email_address` parameter) to your Team. If the user does not currently have a Dropbox Sign Account, a new one will be created for them. If a user is already a part of another Team, a `team_invite_failed` error will be returned. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/TeamAddMemberExample.cs /// Thrown when fails to make API call /// /// The id of the team. (optional) @@ -665,6 +706,7 @@ public Dropbox.Sign.Client.ExceptionFactory ExceptionFactory /// /// Add User to Team Invites a user (specified using the `email_address` parameter) to your Team. If the user does not currently have a Dropbox Sign Account, a new one will be created for them. If a user is already a part of another Team, a `team_invite_failed` error will be returned. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/TeamAddMemberExample.cs /// Thrown when fails to make API call /// /// The id of the team. (optional) @@ -747,6 +789,7 @@ public Dropbox.Sign.Client.ExceptionFactory ExceptionFactory /// /// Add User to Team Invites a user (specified using the `email_address` parameter) to your Team. If the user does not currently have a Dropbox Sign Account, a new one will be created for them. If a user is already a part of another Team, a `team_invite_failed` error will be returned. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/TeamAddMemberExample.cs /// Thrown when fails to make API call /// /// The id of the team. (optional) @@ -762,6 +805,7 @@ public Dropbox.Sign.Client.ExceptionFactory ExceptionFactory /// /// Add User to Team Invites a user (specified using the `email_address` parameter) to your Team. If the user does not currently have a Dropbox Sign Account, a new one will be created for them. If a user is already a part of another Team, a `team_invite_failed` error will be returned. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/TeamAddMemberExample.cs /// Thrown when fails to make API call /// /// The id of the team. (optional) @@ -847,6 +891,7 @@ public Dropbox.Sign.Client.ExceptionFactory ExceptionFactory /// /// Create Team Creates a new Team and makes you a member. You must not currently belong to a Team to invoke. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/TeamCreateExample.cs /// Thrown when fails to make API call /// /// Index associated with the operation. @@ -860,6 +905,7 @@ public TeamGetResponse TeamCreate(TeamCreateRequest teamCreateRequest, int opera /// /// Create Team Creates a new Team and makes you a member. You must not currently belong to a Team to invoke. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/TeamCreateExample.cs /// Thrown when fails to make API call /// /// Index associated with the operation. @@ -937,6 +983,7 @@ public Dropbox.Sign.Client.ApiResponse TeamCreateWithHttpInfo(T /// /// Create Team Creates a new Team and makes you a member. You must not currently belong to a Team to invoke. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/TeamCreateExample.cs /// Thrown when fails to make API call /// /// Index associated with the operation. @@ -951,6 +998,7 @@ public Dropbox.Sign.Client.ApiResponse TeamCreateWithHttpInfo(T /// /// Create Team Creates a new Team and makes you a member. You must not currently belong to a Team to invoke. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/TeamCreateExample.cs /// Thrown when fails to make API call /// /// Index associated with the operation. @@ -1031,6 +1079,7 @@ public Dropbox.Sign.Client.ApiResponse TeamCreateWithHttpInfo(T /// /// Delete Team Deletes your Team. Can only be invoked when you have a Team with only one member (yourself). /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/TeamDeleteExample.cs /// Thrown when fails to make API call /// Index associated with the operation. /// @@ -1042,6 +1091,7 @@ public void TeamDelete(int operationIndex = 0) /// /// Delete Team Deletes your Team. Can only be invoked when you have a Team with only one member (yourself). /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/TeamDeleteExample.cs /// Thrown when fails to make API call /// Index associated with the operation. /// ApiResponse of Object(void) @@ -1103,6 +1153,7 @@ public Dropbox.Sign.Client.ApiResponse TeamDeleteWithHttpInfo(int operat /// /// Delete Team Deletes your Team. Can only be invoked when you have a Team with only one member (yourself). /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/TeamDeleteExample.cs /// Thrown when fails to make API call /// Index associated with the operation. /// Cancellation Token to cancel the request. @@ -1115,6 +1166,7 @@ public Dropbox.Sign.Client.ApiResponse TeamDeleteWithHttpInfo(int operat /// /// Delete Team Deletes your Team. Can only be invoked when you have a Team with only one member (yourself). /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/TeamDeleteExample.cs /// Thrown when fails to make API call /// Index associated with the operation. /// Cancellation Token to cancel the request. @@ -1179,6 +1231,7 @@ public Dropbox.Sign.Client.ApiResponse TeamDeleteWithHttpInfo(int operat /// /// Get Team Returns information about your Team as well as a list of its members. If you do not belong to a Team, a 404 error with an error_name of \"not_found\" will be returned. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/TeamGetExample.cs /// Thrown when fails to make API call /// Index associated with the operation. /// TeamGetResponse @@ -1191,6 +1244,7 @@ public TeamGetResponse TeamGet(int operationIndex = 0) /// /// Get Team Returns information about your Team as well as a list of its members. If you do not belong to a Team, a 404 error with an error_name of \"not_found\" will be returned. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/TeamGetExample.cs /// Thrown when fails to make API call /// Index associated with the operation. /// ApiResponse of TeamGetResponse @@ -1252,6 +1306,7 @@ public Dropbox.Sign.Client.ApiResponse TeamGetWithHttpInfo(int /// /// Get Team Returns information about your Team as well as a list of its members. If you do not belong to a Team, a 404 error with an error_name of \"not_found\" will be returned. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/TeamGetExample.cs /// Thrown when fails to make API call /// Index associated with the operation. /// Cancellation Token to cancel the request. @@ -1265,6 +1320,7 @@ public Dropbox.Sign.Client.ApiResponse TeamGetWithHttpInfo(int /// /// Get Team Returns information about your Team as well as a list of its members. If you do not belong to a Team, a 404 error with an error_name of \"not_found\" will be returned. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/TeamGetExample.cs /// Thrown when fails to make API call /// Index associated with the operation. /// Cancellation Token to cancel the request. @@ -1329,6 +1385,7 @@ public Dropbox.Sign.Client.ApiResponse TeamGetWithHttpInfo(int /// /// Get Team Info Provides information about a team. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/TeamInfoExample.cs /// Thrown when fails to make API call /// The id of the team. (optional) /// Index associated with the operation. @@ -1342,6 +1399,7 @@ public Dropbox.Sign.Client.ApiResponse TeamGetWithHttpInfo(int /// /// Get Team Info Provides information about a team. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/TeamInfoExample.cs /// Thrown when fails to make API call /// The id of the team. (optional) /// Index associated with the operation. @@ -1408,6 +1466,7 @@ public Dropbox.Sign.Client.ApiResponse TeamGetWithHttpInfo(int /// /// Get Team Info Provides information about a team. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/TeamInfoExample.cs /// Thrown when fails to make API call /// The id of the team. (optional) /// Index associated with the operation. @@ -1422,6 +1481,7 @@ public Dropbox.Sign.Client.ApiResponse TeamGetWithHttpInfo(int /// /// Get Team Info Provides information about a team. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/TeamInfoExample.cs /// Thrown when fails to make API call /// The id of the team. (optional) /// Index associated with the operation. @@ -1491,6 +1551,7 @@ public Dropbox.Sign.Client.ApiResponse TeamGetWithHttpInfo(int /// /// List Team Invites Provides a list of team invites (and their roles). /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/TeamInvitesExample.cs /// Thrown when fails to make API call /// The email address for which to display the team invites. (optional) /// Index associated with the operation. @@ -1504,6 +1565,7 @@ public Dropbox.Sign.Client.ApiResponse TeamGetWithHttpInfo(int /// /// List Team Invites Provides a list of team invites (and their roles). /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/TeamInvitesExample.cs /// Thrown when fails to make API call /// The email address for which to display the team invites. (optional) /// Index associated with the operation. @@ -1570,6 +1632,7 @@ public Dropbox.Sign.Client.ApiResponse TeamGetWithHttpInfo(int /// /// List Team Invites Provides a list of team invites (and their roles). /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/TeamInvitesExample.cs /// Thrown when fails to make API call /// The email address for which to display the team invites. (optional) /// Index associated with the operation. @@ -1584,6 +1647,7 @@ public Dropbox.Sign.Client.ApiResponse TeamGetWithHttpInfo(int /// /// List Team Invites Provides a list of team invites (and their roles). /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/TeamInvitesExample.cs /// Thrown when fails to make API call /// The email address for which to display the team invites. (optional) /// Index associated with the operation. @@ -1653,6 +1717,7 @@ public Dropbox.Sign.Client.ApiResponse TeamGetWithHttpInfo(int /// /// List Team Members Provides a paginated list of members (and their roles) that belong to a given team. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/TeamMembersExample.cs /// Thrown when fails to make API call /// The id of the team that a member list is being requested from. /// Which page number of the team member list to return. Defaults to `1`. (optional, default to 1) @@ -1668,6 +1733,7 @@ public Dropbox.Sign.Client.ApiResponse TeamGetWithHttpInfo(int /// /// List Team Members Provides a paginated list of members (and their roles) that belong to a given team. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/TeamMembersExample.cs /// Thrown when fails to make API call /// The id of the team that a member list is being requested from. /// Which page number of the team member list to return. Defaults to `1`. (optional, default to 1) @@ -1747,6 +1813,7 @@ public Dropbox.Sign.Client.ApiResponse TeamGetWithHttpInfo(int /// /// List Team Members Provides a paginated list of members (and their roles) that belong to a given team. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/TeamMembersExample.cs /// Thrown when fails to make API call /// The id of the team that a member list is being requested from. /// Which page number of the team member list to return. Defaults to `1`. (optional, default to 1) @@ -1763,6 +1830,7 @@ public Dropbox.Sign.Client.ApiResponse TeamGetWithHttpInfo(int /// /// List Team Members Provides a paginated list of members (and their roles) that belong to a given team. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/TeamMembersExample.cs /// Thrown when fails to make API call /// The id of the team that a member list is being requested from. /// Which page number of the team member list to return. Defaults to `1`. (optional, default to 1) @@ -1845,6 +1913,7 @@ public Dropbox.Sign.Client.ApiResponse TeamGetWithHttpInfo(int /// /// Remove User from Team Removes the provided user Account from your Team. If the Account had an outstanding invitation to your Team, the invitation will be expired. If you choose to transfer documents from the removed Account to an Account provided in the `new_owner_email_address` parameter (available only for Enterprise plans), the response status code will be 201, which indicates that your request has been queued but not fully executed. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/TeamRemoveMemberExample.cs /// Thrown when fails to make API call /// /// Index associated with the operation. @@ -1858,6 +1927,7 @@ public TeamGetResponse TeamRemoveMember(TeamRemoveMemberRequest teamRemoveMember /// /// Remove User from Team Removes the provided user Account from your Team. If the Account had an outstanding invitation to your Team, the invitation will be expired. If you choose to transfer documents from the removed Account to an Account provided in the `new_owner_email_address` parameter (available only for Enterprise plans), the response status code will be 201, which indicates that your request has been queued but not fully executed. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/TeamRemoveMemberExample.cs /// Thrown when fails to make API call /// /// Index associated with the operation. @@ -1935,6 +2005,7 @@ public Dropbox.Sign.Client.ApiResponse TeamRemoveMemberWithHttp /// /// Remove User from Team Removes the provided user Account from your Team. If the Account had an outstanding invitation to your Team, the invitation will be expired. If you choose to transfer documents from the removed Account to an Account provided in the `new_owner_email_address` parameter (available only for Enterprise plans), the response status code will be 201, which indicates that your request has been queued but not fully executed. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/TeamRemoveMemberExample.cs /// Thrown when fails to make API call /// /// Index associated with the operation. @@ -1949,6 +2020,7 @@ public Dropbox.Sign.Client.ApiResponse TeamRemoveMemberWithHttp /// /// Remove User from Team Removes the provided user Account from your Team. If the Account had an outstanding invitation to your Team, the invitation will be expired. If you choose to transfer documents from the removed Account to an Account provided in the `new_owner_email_address` parameter (available only for Enterprise plans), the response status code will be 201, which indicates that your request has been queued but not fully executed. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/TeamRemoveMemberExample.cs /// Thrown when fails to make API call /// /// Index associated with the operation. @@ -2029,6 +2101,7 @@ public Dropbox.Sign.Client.ApiResponse TeamRemoveMemberWithHttp /// /// List Sub Teams Provides a paginated list of sub teams that belong to a given team. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/TeamSubTeamsExample.cs /// Thrown when fails to make API call /// The id of the parent Team. /// Which page number of the SubTeam List to return. Defaults to `1`. (optional, default to 1) @@ -2044,6 +2117,7 @@ public Dropbox.Sign.Client.ApiResponse TeamRemoveMemberWithHttp /// /// List Sub Teams Provides a paginated list of sub teams that belong to a given team. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/TeamSubTeamsExample.cs /// Thrown when fails to make API call /// The id of the parent Team. /// Which page number of the SubTeam List to return. Defaults to `1`. (optional, default to 1) @@ -2123,6 +2197,7 @@ public Dropbox.Sign.Client.ApiResponse TeamRemoveMemberWithHttp /// /// List Sub Teams Provides a paginated list of sub teams that belong to a given team. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/TeamSubTeamsExample.cs /// Thrown when fails to make API call /// The id of the parent Team. /// Which page number of the SubTeam List to return. Defaults to `1`. (optional, default to 1) @@ -2139,6 +2214,7 @@ public Dropbox.Sign.Client.ApiResponse TeamRemoveMemberWithHttp /// /// List Sub Teams Provides a paginated list of sub teams that belong to a given team. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/TeamSubTeamsExample.cs /// Thrown when fails to make API call /// The id of the parent Team. /// Which page number of the SubTeam List to return. Defaults to `1`. (optional, default to 1) @@ -2221,6 +2297,7 @@ public Dropbox.Sign.Client.ApiResponse TeamRemoveMemberWithHttp /// /// Update Team Updates the name of your Team. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/TeamUpdateExample.cs /// Thrown when fails to make API call /// /// Index associated with the operation. @@ -2234,6 +2311,7 @@ public TeamGetResponse TeamUpdate(TeamUpdateRequest teamUpdateRequest, int opera /// /// Update Team Updates the name of your Team. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/TeamUpdateExample.cs /// Thrown when fails to make API call /// /// Index associated with the operation. @@ -2311,6 +2389,7 @@ public Dropbox.Sign.Client.ApiResponse TeamUpdateWithHttpInfo(T /// /// Update Team Updates the name of your Team. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/TeamUpdateExample.cs /// Thrown when fails to make API call /// /// Index associated with the operation. @@ -2325,6 +2404,7 @@ public Dropbox.Sign.Client.ApiResponse TeamUpdateWithHttpInfo(T /// /// Update Team Updates the name of your Team. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/TeamUpdateExample.cs /// Thrown when fails to make API call /// /// Index associated with the operation. diff --git a/sdks/dotnet/src/Dropbox.Sign/Api/TemplateApi.cs b/sdks/dotnet/src/Dropbox.Sign/Api/TemplateApi.cs index 80da8262a..b80bdffd5 100644 --- a/sdks/dotnet/src/Dropbox.Sign/Api/TemplateApi.cs +++ b/sdks/dotnet/src/Dropbox.Sign/Api/TemplateApi.cs @@ -33,6 +33,7 @@ public interface ITemplateApiSync : IApiAccessor /// /// Gives the specified Account access to the specified Template. The specified Account must be a part of your Team. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/TemplateAddUserExample.cs /// Thrown when fails to make API call /// The id of the Template to give the Account access to. /// @@ -46,6 +47,7 @@ public interface ITemplateApiSync : IApiAccessor /// /// Gives the specified Account access to the specified Template. The specified Account must be a part of your Team. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/TemplateAddUserExample.cs /// Thrown when fails to make API call /// The id of the Template to give the Account access to. /// @@ -58,6 +60,7 @@ public interface ITemplateApiSync : IApiAccessor /// /// Creates a template that can be used in future signature requests. If `client_id` is provided, the template will be created as an embedded template. Embedded templates can be used for embedded signature requests and can be edited later by generating a new `edit_url` with [/embedded/edit_url/{template_id}](/api/reference/operation/embeddedEditUrl/). Template creation may complete asynchronously after the initial request is accepted. It is recommended that a callback be implemented to listen for the callback event. A `template_created` event indicates the template is ready to use, while a `template_error` event indicates there was a problem while creating the template. If a callback handler has been configured and the event has not been received within 60 minutes of making the call, check the status of the request in the API dashboard and retry the request if necessary. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/TemplateCreateExample.cs /// Thrown when fails to make API call /// /// Index associated with the operation. @@ -70,6 +73,7 @@ public interface ITemplateApiSync : IApiAccessor /// /// Creates a template that can be used in future signature requests. If `client_id` is provided, the template will be created as an embedded template. Embedded templates can be used for embedded signature requests and can be edited later by generating a new `edit_url` with [/embedded/edit_url/{template_id}](/api/reference/operation/embeddedEditUrl/). Template creation may complete asynchronously after the initial request is accepted. It is recommended that a callback be implemented to listen for the callback event. A `template_created` event indicates the template is ready to use, while a `template_error` event indicates there was a problem while creating the template. If a callback handler has been configured and the event has not been received within 60 minutes of making the call, check the status of the request in the API dashboard and retry the request if necessary. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/TemplateCreateExample.cs /// Thrown when fails to make API call /// /// Index associated with the operation. @@ -81,6 +85,7 @@ public interface ITemplateApiSync : IApiAccessor /// /// The first step in an embedded template workflow. Creates a draft template that can then be further set up in the template 'edit' stage. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/TemplateCreateEmbeddedDraftExample.cs /// Thrown when fails to make API call /// /// Index associated with the operation. @@ -93,6 +98,7 @@ public interface ITemplateApiSync : IApiAccessor /// /// The first step in an embedded template workflow. Creates a draft template that can then be further set up in the template 'edit' stage. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/TemplateCreateEmbeddedDraftExample.cs /// Thrown when fails to make API call /// /// Index associated with the operation. @@ -104,6 +110,7 @@ public interface ITemplateApiSync : IApiAccessor /// /// Completely deletes the template specified from the account. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/TemplateDeleteExample.cs /// Thrown when fails to make API call /// The id of the Template to delete. /// Index associated with the operation. @@ -116,6 +123,7 @@ public interface ITemplateApiSync : IApiAccessor /// /// Completely deletes the template specified from the account. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/TemplateDeleteExample.cs /// Thrown when fails to make API call /// The id of the Template to delete. /// Index associated with the operation. @@ -127,6 +135,7 @@ public interface ITemplateApiSync : IApiAccessor /// /// Obtain a copy of the current documents specified by the `template_id` parameter. Returns a PDF or ZIP file. If the files are currently being prepared, a status code of `409` will be returned instead. In this case please wait for the `template_created` callback event. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/TemplateFilesExample.cs /// Thrown when fails to make API call /// The id of the template files to retrieve. /// Set to `pdf` for a single merged document or `zip` for a collection of individual documents. (optional) @@ -140,6 +149,7 @@ public interface ITemplateApiSync : IApiAccessor /// /// Obtain a copy of the current documents specified by the `template_id` parameter. Returns a PDF or ZIP file. If the files are currently being prepared, a status code of `409` will be returned instead. In this case please wait for the `template_created` callback event. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/TemplateFilesExample.cs /// Thrown when fails to make API call /// The id of the template files to retrieve. /// Set to `pdf` for a single merged document or `zip` for a collection of individual documents. (optional) @@ -152,6 +162,7 @@ public interface ITemplateApiSync : IApiAccessor /// /// Obtain a copy of the current documents specified by the `template_id` parameter. Returns a JSON object with a `data_uri` representing the base64 encoded file (PDFs only). If the files are currently being prepared, a status code of `409` will be returned instead. In this case please wait for the `template_created` callback event. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/TemplateFilesAsDataUriExample.cs /// Thrown when fails to make API call /// The id of the template files to retrieve. /// Index associated with the operation. @@ -164,6 +175,7 @@ public interface ITemplateApiSync : IApiAccessor /// /// Obtain a copy of the current documents specified by the `template_id` parameter. Returns a JSON object with a `data_uri` representing the base64 encoded file (PDFs only). If the files are currently being prepared, a status code of `409` will be returned instead. In this case please wait for the `template_created` callback event. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/TemplateFilesAsDataUriExample.cs /// Thrown when fails to make API call /// The id of the template files to retrieve. /// Index associated with the operation. @@ -175,6 +187,7 @@ public interface ITemplateApiSync : IApiAccessor /// /// Obtain a copy of the current documents specified by the `template_id` parameter. Returns a JSON object with a url to the file (PDFs only). If the files are currently being prepared, a status code of `409` will be returned instead. In this case please wait for the `template_created` callback event. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/TemplateFilesAsFileUrlExample.cs /// Thrown when fails to make API call /// The id of the template files to retrieve. /// By default when opening the `file_url` a browser will download the PDF and save it locally. When set to `0` the PDF file will be displayed in the browser. (optional, default to 1) @@ -188,6 +201,7 @@ public interface ITemplateApiSync : IApiAccessor /// /// Obtain a copy of the current documents specified by the `template_id` parameter. Returns a JSON object with a url to the file (PDFs only). If the files are currently being prepared, a status code of `409` will be returned instead. In this case please wait for the `template_created` callback event. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/TemplateFilesAsFileUrlExample.cs /// Thrown when fails to make API call /// The id of the template files to retrieve. /// By default when opening the `file_url` a browser will download the PDF and save it locally. When set to `0` the PDF file will be displayed in the browser. (optional, default to 1) @@ -200,6 +214,7 @@ public interface ITemplateApiSync : IApiAccessor /// /// Returns the Template specified by the `template_id` parameter. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/TemplateGetExample.cs /// Thrown when fails to make API call /// The id of the Template to retrieve. /// Index associated with the operation. @@ -212,6 +227,7 @@ public interface ITemplateApiSync : IApiAccessor /// /// Returns the Template specified by the `template_id` parameter. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/TemplateGetExample.cs /// Thrown when fails to make API call /// The id of the Template to retrieve. /// Index associated with the operation. @@ -223,6 +239,7 @@ public interface ITemplateApiSync : IApiAccessor /// /// Returns a list of the Templates that are accessible by you. Take a look at our [search guide](/api/reference/search/) to learn more about querying templates. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/TemplateListExample.cs /// Thrown when fails to make API call /// Which account to return Templates for. Must be a team member. Use `all` to indicate all team members. Defaults to your account. (optional) /// Which page number of the Template List to return. Defaults to `1`. (optional, default to 1) @@ -238,6 +255,7 @@ public interface ITemplateApiSync : IApiAccessor /// /// Returns a list of the Templates that are accessible by you. Take a look at our [search guide](/api/reference/search/) to learn more about querying templates. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/TemplateListExample.cs /// Thrown when fails to make API call /// Which account to return Templates for. Must be a team member. Use `all` to indicate all team members. Defaults to your account. (optional) /// Which page number of the Template List to return. Defaults to `1`. (optional, default to 1) @@ -252,6 +270,7 @@ public interface ITemplateApiSync : IApiAccessor /// /// Removes the specified Account's access to the specified Template. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/TemplateRemoveUserExample.cs /// Thrown when fails to make API call /// The id of the Template to remove the Account's access to. /// @@ -265,6 +284,7 @@ public interface ITemplateApiSync : IApiAccessor /// /// Removes the specified Account's access to the specified Template. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/TemplateRemoveUserExample.cs /// Thrown when fails to make API call /// The id of the Template to remove the Account's access to. /// @@ -277,6 +297,7 @@ public interface ITemplateApiSync : IApiAccessor /// /// Overlays a new file with the overlay of an existing template. The new file(s) must: 1. have the same or higher page count 2. the same orientation as the file(s) being replaced. This will not overwrite or in any way affect the existing template. Both the existing template and new template will be available for use after executing this endpoint. Also note that this will decrement your template quota. Overlaying new files is asynchronous and a successful call to this endpoint will return 200 OK response if the request passes initial validation checks. It is recommended that a callback be implemented to listen for the callback event. A `template_created` event will be sent when the files are updated or a `template_error` event will be sent if there was a problem while updating the files. If a callback handler has been configured and the event has not been received within 60 minutes of making the call, check the status of the request in the API dashboard and retry the request if necessary. If the page orientation or page count is different from the original template document, we will notify you with a `template_error` [callback event](https://app.hellosign.com/api/eventsAndCallbacksWalkthrough). /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/TemplateUpdateFilesExample.cs /// Thrown when fails to make API call /// The ID of the template whose files to update. /// @@ -290,6 +311,7 @@ public interface ITemplateApiSync : IApiAccessor /// /// Overlays a new file with the overlay of an existing template. The new file(s) must: 1. have the same or higher page count 2. the same orientation as the file(s) being replaced. This will not overwrite or in any way affect the existing template. Both the existing template and new template will be available for use after executing this endpoint. Also note that this will decrement your template quota. Overlaying new files is asynchronous and a successful call to this endpoint will return 200 OK response if the request passes initial validation checks. It is recommended that a callback be implemented to listen for the callback event. A `template_created` event will be sent when the files are updated or a `template_error` event will be sent if there was a problem while updating the files. If a callback handler has been configured and the event has not been received within 60 minutes of making the call, check the status of the request in the API dashboard and retry the request if necessary. If the page orientation or page count is different from the original template document, we will notify you with a `template_error` [callback event](https://app.hellosign.com/api/eventsAndCallbacksWalkthrough). /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/TemplateUpdateFilesExample.cs /// Thrown when fails to make API call /// The ID of the template whose files to update. /// @@ -311,6 +333,7 @@ public interface ITemplateApiAsync : IApiAccessor /// /// Gives the specified Account access to the specified Template. The specified Account must be a part of your Team. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/TemplateAddUserExample.cs /// Thrown when fails to make API call /// The id of the Template to give the Account access to. /// @@ -325,6 +348,7 @@ public interface ITemplateApiAsync : IApiAccessor /// /// Gives the specified Account access to the specified Template. The specified Account must be a part of your Team. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/TemplateAddUserExample.cs /// Thrown when fails to make API call /// The id of the Template to give the Account access to. /// @@ -338,6 +362,7 @@ public interface ITemplateApiAsync : IApiAccessor /// /// Creates a template that can be used in future signature requests. If `client_id` is provided, the template will be created as an embedded template. Embedded templates can be used for embedded signature requests and can be edited later by generating a new `edit_url` with [/embedded/edit_url/{template_id}](/api/reference/operation/embeddedEditUrl/). Template creation may complete asynchronously after the initial request is accepted. It is recommended that a callback be implemented to listen for the callback event. A `template_created` event indicates the template is ready to use, while a `template_error` event indicates there was a problem while creating the template. If a callback handler has been configured and the event has not been received within 60 minutes of making the call, check the status of the request in the API dashboard and retry the request if necessary. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/TemplateCreateExample.cs /// Thrown when fails to make API call /// /// Index associated with the operation. @@ -351,6 +376,7 @@ public interface ITemplateApiAsync : IApiAccessor /// /// Creates a template that can be used in future signature requests. If `client_id` is provided, the template will be created as an embedded template. Embedded templates can be used for embedded signature requests and can be edited later by generating a new `edit_url` with [/embedded/edit_url/{template_id}](/api/reference/operation/embeddedEditUrl/). Template creation may complete asynchronously after the initial request is accepted. It is recommended that a callback be implemented to listen for the callback event. A `template_created` event indicates the template is ready to use, while a `template_error` event indicates there was a problem while creating the template. If a callback handler has been configured and the event has not been received within 60 minutes of making the call, check the status of the request in the API dashboard and retry the request if necessary. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/TemplateCreateExample.cs /// Thrown when fails to make API call /// /// Index associated with the operation. @@ -363,6 +389,7 @@ public interface ITemplateApiAsync : IApiAccessor /// /// The first step in an embedded template workflow. Creates a draft template that can then be further set up in the template 'edit' stage. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/TemplateCreateEmbeddedDraftExample.cs /// Thrown when fails to make API call /// /// Index associated with the operation. @@ -376,6 +403,7 @@ public interface ITemplateApiAsync : IApiAccessor /// /// The first step in an embedded template workflow. Creates a draft template that can then be further set up in the template 'edit' stage. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/TemplateCreateEmbeddedDraftExample.cs /// Thrown when fails to make API call /// /// Index associated with the operation. @@ -388,6 +416,7 @@ public interface ITemplateApiAsync : IApiAccessor /// /// Completely deletes the template specified from the account. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/TemplateDeleteExample.cs /// Thrown when fails to make API call /// The id of the Template to delete. /// Index associated with the operation. @@ -401,6 +430,7 @@ public interface ITemplateApiAsync : IApiAccessor /// /// Completely deletes the template specified from the account. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/TemplateDeleteExample.cs /// Thrown when fails to make API call /// The id of the Template to delete. /// Index associated with the operation. @@ -413,6 +443,7 @@ public interface ITemplateApiAsync : IApiAccessor /// /// Obtain a copy of the current documents specified by the `template_id` parameter. Returns a PDF or ZIP file. If the files are currently being prepared, a status code of `409` will be returned instead. In this case please wait for the `template_created` callback event. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/TemplateFilesExample.cs /// Thrown when fails to make API call /// The id of the template files to retrieve. /// Set to `pdf` for a single merged document or `zip` for a collection of individual documents. (optional) @@ -427,6 +458,7 @@ public interface ITemplateApiAsync : IApiAccessor /// /// Obtain a copy of the current documents specified by the `template_id` parameter. Returns a PDF or ZIP file. If the files are currently being prepared, a status code of `409` will be returned instead. In this case please wait for the `template_created` callback event. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/TemplateFilesExample.cs /// Thrown when fails to make API call /// The id of the template files to retrieve. /// Set to `pdf` for a single merged document or `zip` for a collection of individual documents. (optional) @@ -440,6 +472,7 @@ public interface ITemplateApiAsync : IApiAccessor /// /// Obtain a copy of the current documents specified by the `template_id` parameter. Returns a JSON object with a `data_uri` representing the base64 encoded file (PDFs only). If the files are currently being prepared, a status code of `409` will be returned instead. In this case please wait for the `template_created` callback event. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/TemplateFilesAsDataUriExample.cs /// Thrown when fails to make API call /// The id of the template files to retrieve. /// Index associated with the operation. @@ -453,6 +486,7 @@ public interface ITemplateApiAsync : IApiAccessor /// /// Obtain a copy of the current documents specified by the `template_id` parameter. Returns a JSON object with a `data_uri` representing the base64 encoded file (PDFs only). If the files are currently being prepared, a status code of `409` will be returned instead. In this case please wait for the `template_created` callback event. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/TemplateFilesAsDataUriExample.cs /// Thrown when fails to make API call /// The id of the template files to retrieve. /// Index associated with the operation. @@ -465,6 +499,7 @@ public interface ITemplateApiAsync : IApiAccessor /// /// Obtain a copy of the current documents specified by the `template_id` parameter. Returns a JSON object with a url to the file (PDFs only). If the files are currently being prepared, a status code of `409` will be returned instead. In this case please wait for the `template_created` callback event. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/TemplateFilesAsFileUrlExample.cs /// Thrown when fails to make API call /// The id of the template files to retrieve. /// By default when opening the `file_url` a browser will download the PDF and save it locally. When set to `0` the PDF file will be displayed in the browser. (optional, default to 1) @@ -479,6 +514,7 @@ public interface ITemplateApiAsync : IApiAccessor /// /// Obtain a copy of the current documents specified by the `template_id` parameter. Returns a JSON object with a url to the file (PDFs only). If the files are currently being prepared, a status code of `409` will be returned instead. In this case please wait for the `template_created` callback event. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/TemplateFilesAsFileUrlExample.cs /// Thrown when fails to make API call /// The id of the template files to retrieve. /// By default when opening the `file_url` a browser will download the PDF and save it locally. When set to `0` the PDF file will be displayed in the browser. (optional, default to 1) @@ -492,6 +528,7 @@ public interface ITemplateApiAsync : IApiAccessor /// /// Returns the Template specified by the `template_id` parameter. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/TemplateGetExample.cs /// Thrown when fails to make API call /// The id of the Template to retrieve. /// Index associated with the operation. @@ -505,6 +542,7 @@ public interface ITemplateApiAsync : IApiAccessor /// /// Returns the Template specified by the `template_id` parameter. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/TemplateGetExample.cs /// Thrown when fails to make API call /// The id of the Template to retrieve. /// Index associated with the operation. @@ -517,6 +555,7 @@ public interface ITemplateApiAsync : IApiAccessor /// /// Returns a list of the Templates that are accessible by you. Take a look at our [search guide](/api/reference/search/) to learn more about querying templates. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/TemplateListExample.cs /// Thrown when fails to make API call /// Which account to return Templates for. Must be a team member. Use `all` to indicate all team members. Defaults to your account. (optional) /// Which page number of the Template List to return. Defaults to `1`. (optional, default to 1) @@ -533,6 +572,7 @@ public interface ITemplateApiAsync : IApiAccessor /// /// Returns a list of the Templates that are accessible by you. Take a look at our [search guide](/api/reference/search/) to learn more about querying templates. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/TemplateListExample.cs /// Thrown when fails to make API call /// Which account to return Templates for. Must be a team member. Use `all` to indicate all team members. Defaults to your account. (optional) /// Which page number of the Template List to return. Defaults to `1`. (optional, default to 1) @@ -548,6 +588,7 @@ public interface ITemplateApiAsync : IApiAccessor /// /// Removes the specified Account's access to the specified Template. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/TemplateRemoveUserExample.cs /// Thrown when fails to make API call /// The id of the Template to remove the Account's access to. /// @@ -562,6 +603,7 @@ public interface ITemplateApiAsync : IApiAccessor /// /// Removes the specified Account's access to the specified Template. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/TemplateRemoveUserExample.cs /// Thrown when fails to make API call /// The id of the Template to remove the Account's access to. /// @@ -575,6 +617,7 @@ public interface ITemplateApiAsync : IApiAccessor /// /// Overlays a new file with the overlay of an existing template. The new file(s) must: 1. have the same or higher page count 2. the same orientation as the file(s) being replaced. This will not overwrite or in any way affect the existing template. Both the existing template and new template will be available for use after executing this endpoint. Also note that this will decrement your template quota. Overlaying new files is asynchronous and a successful call to this endpoint will return 200 OK response if the request passes initial validation checks. It is recommended that a callback be implemented to listen for the callback event. A `template_created` event will be sent when the files are updated or a `template_error` event will be sent if there was a problem while updating the files. If a callback handler has been configured and the event has not been received within 60 minutes of making the call, check the status of the request in the API dashboard and retry the request if necessary. If the page orientation or page count is different from the original template document, we will notify you with a `template_error` [callback event](https://app.hellosign.com/api/eventsAndCallbacksWalkthrough). /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/TemplateUpdateFilesExample.cs /// Thrown when fails to make API call /// The ID of the template whose files to update. /// @@ -589,6 +632,7 @@ public interface ITemplateApiAsync : IApiAccessor /// /// Overlays a new file with the overlay of an existing template. The new file(s) must: 1. have the same or higher page count 2. the same orientation as the file(s) being replaced. This will not overwrite or in any way affect the existing template. Both the existing template and new template will be available for use after executing this endpoint. Also note that this will decrement your template quota. Overlaying new files is asynchronous and a successful call to this endpoint will return 200 OK response if the request passes initial validation checks. It is recommended that a callback be implemented to listen for the callback event. A `template_created` event will be sent when the files are updated or a `template_error` event will be sent if there was a problem while updating the files. If a callback handler has been configured and the event has not been received within 60 minutes of making the call, check the status of the request in the API dashboard and retry the request if necessary. If the page orientation or page count is different from the original template document, we will notify you with a `template_error` [callback event](https://app.hellosign.com/api/eventsAndCallbacksWalkthrough). /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/TemplateUpdateFilesExample.cs /// Thrown when fails to make API call /// The ID of the template whose files to update. /// @@ -719,6 +763,7 @@ public Dropbox.Sign.Client.ExceptionFactory ExceptionFactory /// /// Add User to Template Gives the specified Account access to the specified Template. The specified Account must be a part of your Team. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/TemplateAddUserExample.cs /// Thrown when fails to make API call /// The id of the Template to give the Account access to. /// @@ -733,6 +778,7 @@ public TemplateGetResponse TemplateAddUser(string templateId, TemplateAddUserReq /// /// Add User to Template Gives the specified Account access to the specified Template. The specified Account must be a part of your Team. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/TemplateAddUserExample.cs /// Thrown when fails to make API call /// The id of the Template to give the Account access to. /// @@ -818,6 +864,7 @@ public Dropbox.Sign.Client.ApiResponse TemplateAddUserWithH /// /// Add User to Template Gives the specified Account access to the specified Template. The specified Account must be a part of your Team. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/TemplateAddUserExample.cs /// Thrown when fails to make API call /// The id of the Template to give the Account access to. /// @@ -833,6 +880,7 @@ public Dropbox.Sign.Client.ApiResponse TemplateAddUserWithH /// /// Add User to Template Gives the specified Account access to the specified Template. The specified Account must be a part of your Team. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/TemplateAddUserExample.cs /// Thrown when fails to make API call /// The id of the Template to give the Account access to. /// @@ -921,6 +969,7 @@ public Dropbox.Sign.Client.ApiResponse TemplateAddUserWithH /// /// Create Template Creates a template that can be used in future signature requests. If `client_id` is provided, the template will be created as an embedded template. Embedded templates can be used for embedded signature requests and can be edited later by generating a new `edit_url` with [/embedded/edit_url/{template_id}](/api/reference/operation/embeddedEditUrl/). Template creation may complete asynchronously after the initial request is accepted. It is recommended that a callback be implemented to listen for the callback event. A `template_created` event indicates the template is ready to use, while a `template_error` event indicates there was a problem while creating the template. If a callback handler has been configured and the event has not been received within 60 minutes of making the call, check the status of the request in the API dashboard and retry the request if necessary. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/TemplateCreateExample.cs /// Thrown when fails to make API call /// /// Index associated with the operation. @@ -934,6 +983,7 @@ public TemplateCreateResponse TemplateCreate(TemplateCreateRequest templateCreat /// /// Create Template Creates a template that can be used in future signature requests. If `client_id` is provided, the template will be created as an embedded template. Embedded templates can be used for embedded signature requests and can be edited later by generating a new `edit_url` with [/embedded/edit_url/{template_id}](/api/reference/operation/embeddedEditUrl/). Template creation may complete asynchronously after the initial request is accepted. It is recommended that a callback be implemented to listen for the callback event. A `template_created` event indicates the template is ready to use, while a `template_error` event indicates there was a problem while creating the template. If a callback handler has been configured and the event has not been received within 60 minutes of making the call, check the status of the request in the API dashboard and retry the request if necessary. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/TemplateCreateExample.cs /// Thrown when fails to make API call /// /// Index associated with the operation. @@ -1011,6 +1061,7 @@ public Dropbox.Sign.Client.ApiResponse TemplateCreateWit /// /// Create Template Creates a template that can be used in future signature requests. If `client_id` is provided, the template will be created as an embedded template. Embedded templates can be used for embedded signature requests and can be edited later by generating a new `edit_url` with [/embedded/edit_url/{template_id}](/api/reference/operation/embeddedEditUrl/). Template creation may complete asynchronously after the initial request is accepted. It is recommended that a callback be implemented to listen for the callback event. A `template_created` event indicates the template is ready to use, while a `template_error` event indicates there was a problem while creating the template. If a callback handler has been configured and the event has not been received within 60 minutes of making the call, check the status of the request in the API dashboard and retry the request if necessary. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/TemplateCreateExample.cs /// Thrown when fails to make API call /// /// Index associated with the operation. @@ -1025,6 +1076,7 @@ public Dropbox.Sign.Client.ApiResponse TemplateCreateWit /// /// Create Template Creates a template that can be used in future signature requests. If `client_id` is provided, the template will be created as an embedded template. Embedded templates can be used for embedded signature requests and can be edited later by generating a new `edit_url` with [/embedded/edit_url/{template_id}](/api/reference/operation/embeddedEditUrl/). Template creation may complete asynchronously after the initial request is accepted. It is recommended that a callback be implemented to listen for the callback event. A `template_created` event indicates the template is ready to use, while a `template_error` event indicates there was a problem while creating the template. If a callback handler has been configured and the event has not been received within 60 minutes of making the call, check the status of the request in the API dashboard and retry the request if necessary. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/TemplateCreateExample.cs /// Thrown when fails to make API call /// /// Index associated with the operation. @@ -1105,6 +1157,7 @@ public Dropbox.Sign.Client.ApiResponse TemplateCreateWit /// /// Create Embedded Template Draft The first step in an embedded template workflow. Creates a draft template that can then be further set up in the template 'edit' stage. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/TemplateCreateEmbeddedDraftExample.cs /// Thrown when fails to make API call /// /// Index associated with the operation. @@ -1118,6 +1171,7 @@ public TemplateCreateEmbeddedDraftResponse TemplateCreateEmbeddedDraft(TemplateC /// /// Create Embedded Template Draft The first step in an embedded template workflow. Creates a draft template that can then be further set up in the template 'edit' stage. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/TemplateCreateEmbeddedDraftExample.cs /// Thrown when fails to make API call /// /// Index associated with the operation. @@ -1195,6 +1249,7 @@ public Dropbox.Sign.Client.ApiResponse Temp /// /// Create Embedded Template Draft The first step in an embedded template workflow. Creates a draft template that can then be further set up in the template 'edit' stage. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/TemplateCreateEmbeddedDraftExample.cs /// Thrown when fails to make API call /// /// Index associated with the operation. @@ -1209,6 +1264,7 @@ public Dropbox.Sign.Client.ApiResponse Temp /// /// Create Embedded Template Draft The first step in an embedded template workflow. Creates a draft template that can then be further set up in the template 'edit' stage. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/TemplateCreateEmbeddedDraftExample.cs /// Thrown when fails to make API call /// /// Index associated with the operation. @@ -1289,6 +1345,7 @@ public Dropbox.Sign.Client.ApiResponse Temp /// /// Delete Template Completely deletes the template specified from the account. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/TemplateDeleteExample.cs /// Thrown when fails to make API call /// The id of the Template to delete. /// Index associated with the operation. @@ -1301,6 +1358,7 @@ public void TemplateDelete(string templateId, int operationIndex = 0) /// /// Delete Template Completely deletes the template specified from the account. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/TemplateDeleteExample.cs /// Thrown when fails to make API call /// The id of the Template to delete. /// Index associated with the operation. @@ -1370,6 +1428,7 @@ public Dropbox.Sign.Client.ApiResponse TemplateDeleteWithHttpInfo(string /// /// Delete Template Completely deletes the template specified from the account. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/TemplateDeleteExample.cs /// Thrown when fails to make API call /// The id of the Template to delete. /// Index associated with the operation. @@ -1383,6 +1442,7 @@ public Dropbox.Sign.Client.ApiResponse TemplateDeleteWithHttpInfo(string /// /// Delete Template Completely deletes the template specified from the account. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/TemplateDeleteExample.cs /// Thrown when fails to make API call /// The id of the Template to delete. /// Index associated with the operation. @@ -1455,6 +1515,7 @@ public Dropbox.Sign.Client.ApiResponse TemplateDeleteWithHttpInfo(string /// /// Get Template Files Obtain a copy of the current documents specified by the `template_id` parameter. Returns a PDF or ZIP file. If the files are currently being prepared, a status code of `409` will be returned instead. In this case please wait for the `template_created` callback event. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/TemplateFilesExample.cs /// Thrown when fails to make API call /// The id of the template files to retrieve. /// Set to `pdf` for a single merged document or `zip` for a collection of individual documents. (optional) @@ -1469,6 +1530,7 @@ public Dropbox.Sign.Client.ApiResponse TemplateDeleteWithHttpInfo(string /// /// Get Template Files Obtain a copy of the current documents specified by the `template_id` parameter. Returns a PDF or ZIP file. If the files are currently being prepared, a status code of `409` will be returned instead. In this case please wait for the `template_created` callback event. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/TemplateFilesExample.cs /// Thrown when fails to make API call /// The id of the template files to retrieve. /// Set to `pdf` for a single merged document or `zip` for a collection of individual documents. (optional) @@ -1545,6 +1607,7 @@ public Dropbox.Sign.Client.ApiResponse TemplateDeleteWithHttpInfo(string /// /// Get Template Files Obtain a copy of the current documents specified by the `template_id` parameter. Returns a PDF or ZIP file. If the files are currently being prepared, a status code of `409` will be returned instead. In this case please wait for the `template_created` callback event. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/TemplateFilesExample.cs /// Thrown when fails to make API call /// The id of the template files to retrieve. /// Set to `pdf` for a single merged document or `zip` for a collection of individual documents. (optional) @@ -1560,6 +1623,7 @@ public Dropbox.Sign.Client.ApiResponse TemplateDeleteWithHttpInfo(string /// /// Get Template Files Obtain a copy of the current documents specified by the `template_id` parameter. Returns a PDF or ZIP file. If the files are currently being prepared, a status code of `409` will be returned instead. In this case please wait for the `template_created` callback event. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/TemplateFilesExample.cs /// Thrown when fails to make API call /// The id of the template files to retrieve. /// Set to `pdf` for a single merged document or `zip` for a collection of individual documents. (optional) @@ -1639,6 +1703,7 @@ public Dropbox.Sign.Client.ApiResponse TemplateDeleteWithHttpInfo(string /// /// Get Template Files as Data Uri Obtain a copy of the current documents specified by the `template_id` parameter. Returns a JSON object with a `data_uri` representing the base64 encoded file (PDFs only). If the files are currently being prepared, a status code of `409` will be returned instead. In this case please wait for the `template_created` callback event. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/TemplateFilesAsDataUriExample.cs /// Thrown when fails to make API call /// The id of the template files to retrieve. /// Index associated with the operation. @@ -1652,6 +1717,7 @@ public FileResponseDataUri TemplateFilesAsDataUri(string templateId, int operati /// /// Get Template Files as Data Uri Obtain a copy of the current documents specified by the `template_id` parameter. Returns a JSON object with a `data_uri` representing the base64 encoded file (PDFs only). If the files are currently being prepared, a status code of `409` will be returned instead. In this case please wait for the `template_created` callback event. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/TemplateFilesAsDataUriExample.cs /// Thrown when fails to make API call /// The id of the template files to retrieve. /// Index associated with the operation. @@ -1721,6 +1787,7 @@ public Dropbox.Sign.Client.ApiResponse TemplateFilesAsDataU /// /// Get Template Files as Data Uri Obtain a copy of the current documents specified by the `template_id` parameter. Returns a JSON object with a `data_uri` representing the base64 encoded file (PDFs only). If the files are currently being prepared, a status code of `409` will be returned instead. In this case please wait for the `template_created` callback event. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/TemplateFilesAsDataUriExample.cs /// Thrown when fails to make API call /// The id of the template files to retrieve. /// Index associated with the operation. @@ -1735,6 +1802,7 @@ public Dropbox.Sign.Client.ApiResponse TemplateFilesAsDataU /// /// Get Template Files as Data Uri Obtain a copy of the current documents specified by the `template_id` parameter. Returns a JSON object with a `data_uri` representing the base64 encoded file (PDFs only). If the files are currently being prepared, a status code of `409` will be returned instead. In this case please wait for the `template_created` callback event. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/TemplateFilesAsDataUriExample.cs /// Thrown when fails to make API call /// The id of the template files to retrieve. /// Index associated with the operation. @@ -1807,6 +1875,7 @@ public Dropbox.Sign.Client.ApiResponse TemplateFilesAsDataU /// /// Get Template Files as File Url Obtain a copy of the current documents specified by the `template_id` parameter. Returns a JSON object with a url to the file (PDFs only). If the files are currently being prepared, a status code of `409` will be returned instead. In this case please wait for the `template_created` callback event. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/TemplateFilesAsFileUrlExample.cs /// Thrown when fails to make API call /// The id of the template files to retrieve. /// By default when opening the `file_url` a browser will download the PDF and save it locally. When set to `0` the PDF file will be displayed in the browser. (optional, default to 1) @@ -1821,6 +1890,7 @@ public Dropbox.Sign.Client.ApiResponse TemplateFilesAsDataU /// /// Get Template Files as File Url Obtain a copy of the current documents specified by the `template_id` parameter. Returns a JSON object with a url to the file (PDFs only). If the files are currently being prepared, a status code of `409` will be returned instead. In this case please wait for the `template_created` callback event. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/TemplateFilesAsFileUrlExample.cs /// Thrown when fails to make API call /// The id of the template files to retrieve. /// By default when opening the `file_url` a browser will download the PDF and save it locally. When set to `0` the PDF file will be displayed in the browser. (optional, default to 1) @@ -1895,6 +1965,7 @@ public Dropbox.Sign.Client.ApiResponse TemplateFilesAsDataU /// /// Get Template Files as File Url Obtain a copy of the current documents specified by the `template_id` parameter. Returns a JSON object with a url to the file (PDFs only). If the files are currently being prepared, a status code of `409` will be returned instead. In this case please wait for the `template_created` callback event. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/TemplateFilesAsFileUrlExample.cs /// Thrown when fails to make API call /// The id of the template files to retrieve. /// By default when opening the `file_url` a browser will download the PDF and save it locally. When set to `0` the PDF file will be displayed in the browser. (optional, default to 1) @@ -1910,6 +1981,7 @@ public Dropbox.Sign.Client.ApiResponse TemplateFilesAsDataU /// /// Get Template Files as File Url Obtain a copy of the current documents specified by the `template_id` parameter. Returns a JSON object with a url to the file (PDFs only). If the files are currently being prepared, a status code of `409` will be returned instead. In this case please wait for the `template_created` callback event. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/TemplateFilesAsFileUrlExample.cs /// Thrown when fails to make API call /// The id of the template files to retrieve. /// By default when opening the `file_url` a browser will download the PDF and save it locally. When set to `0` the PDF file will be displayed in the browser. (optional, default to 1) @@ -1987,6 +2059,7 @@ public Dropbox.Sign.Client.ApiResponse TemplateFilesAsDataU /// /// Get Template Returns the Template specified by the `template_id` parameter. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/TemplateGetExample.cs /// Thrown when fails to make API call /// The id of the Template to retrieve. /// Index associated with the operation. @@ -2000,6 +2073,7 @@ public TemplateGetResponse TemplateGet(string templateId, int operationIndex = 0 /// /// Get Template Returns the Template specified by the `template_id` parameter. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/TemplateGetExample.cs /// Thrown when fails to make API call /// The id of the Template to retrieve. /// Index associated with the operation. @@ -2069,6 +2143,7 @@ public Dropbox.Sign.Client.ApiResponse TemplateGetWithHttpI /// /// Get Template Returns the Template specified by the `template_id` parameter. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/TemplateGetExample.cs /// Thrown when fails to make API call /// The id of the Template to retrieve. /// Index associated with the operation. @@ -2083,6 +2158,7 @@ public Dropbox.Sign.Client.ApiResponse TemplateGetWithHttpI /// /// Get Template Returns the Template specified by the `template_id` parameter. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/TemplateGetExample.cs /// Thrown when fails to make API call /// The id of the Template to retrieve. /// Index associated with the operation. @@ -2155,6 +2231,7 @@ public Dropbox.Sign.Client.ApiResponse TemplateGetWithHttpI /// /// List Templates Returns a list of the Templates that are accessible by you. Take a look at our [search guide](/api/reference/search/) to learn more about querying templates. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/TemplateListExample.cs /// Thrown when fails to make API call /// Which account to return Templates for. Must be a team member. Use `all` to indicate all team members. Defaults to your account. (optional) /// Which page number of the Template List to return. Defaults to `1`. (optional, default to 1) @@ -2171,6 +2248,7 @@ public Dropbox.Sign.Client.ApiResponse TemplateGetWithHttpI /// /// List Templates Returns a list of the Templates that are accessible by you. Take a look at our [search guide](/api/reference/search/) to learn more about querying templates. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/TemplateListExample.cs /// Thrown when fails to make API call /// Which account to return Templates for. Must be a team member. Use `all` to indicate all team members. Defaults to your account. (optional) /// Which page number of the Template List to return. Defaults to `1`. (optional, default to 1) @@ -2252,6 +2330,7 @@ public Dropbox.Sign.Client.ApiResponse TemplateGetWithHttpI /// /// List Templates Returns a list of the Templates that are accessible by you. Take a look at our [search guide](/api/reference/search/) to learn more about querying templates. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/TemplateListExample.cs /// Thrown when fails to make API call /// Which account to return Templates for. Must be a team member. Use `all` to indicate all team members. Defaults to your account. (optional) /// Which page number of the Template List to return. Defaults to `1`. (optional, default to 1) @@ -2269,6 +2348,7 @@ public Dropbox.Sign.Client.ApiResponse TemplateGetWithHttpI /// /// List Templates Returns a list of the Templates that are accessible by you. Take a look at our [search guide](/api/reference/search/) to learn more about querying templates. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/TemplateListExample.cs /// Thrown when fails to make API call /// Which account to return Templates for. Must be a team member. Use `all` to indicate all team members. Defaults to your account. (optional) /// Which page number of the Template List to return. Defaults to `1`. (optional, default to 1) @@ -2353,6 +2433,7 @@ public Dropbox.Sign.Client.ApiResponse TemplateGetWithHttpI /// /// Remove User from Template Removes the specified Account's access to the specified Template. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/TemplateRemoveUserExample.cs /// Thrown when fails to make API call /// The id of the Template to remove the Account's access to. /// @@ -2367,6 +2448,7 @@ public TemplateGetResponse TemplateRemoveUser(string templateId, TemplateRemoveU /// /// Remove User from Template Removes the specified Account's access to the specified Template. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/TemplateRemoveUserExample.cs /// Thrown when fails to make API call /// The id of the Template to remove the Account's access to. /// @@ -2452,6 +2534,7 @@ public Dropbox.Sign.Client.ApiResponse TemplateRemoveUserWi /// /// Remove User from Template Removes the specified Account's access to the specified Template. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/TemplateRemoveUserExample.cs /// Thrown when fails to make API call /// The id of the Template to remove the Account's access to. /// @@ -2467,6 +2550,7 @@ public Dropbox.Sign.Client.ApiResponse TemplateRemoveUserWi /// /// Remove User from Template Removes the specified Account's access to the specified Template. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/TemplateRemoveUserExample.cs /// Thrown when fails to make API call /// The id of the Template to remove the Account's access to. /// @@ -2555,6 +2639,7 @@ public Dropbox.Sign.Client.ApiResponse TemplateRemoveUserWi /// /// Update Template Files Overlays a new file with the overlay of an existing template. The new file(s) must: 1. have the same or higher page count 2. the same orientation as the file(s) being replaced. This will not overwrite or in any way affect the existing template. Both the existing template and new template will be available for use after executing this endpoint. Also note that this will decrement your template quota. Overlaying new files is asynchronous and a successful call to this endpoint will return 200 OK response if the request passes initial validation checks. It is recommended that a callback be implemented to listen for the callback event. A `template_created` event will be sent when the files are updated or a `template_error` event will be sent if there was a problem while updating the files. If a callback handler has been configured and the event has not been received within 60 minutes of making the call, check the status of the request in the API dashboard and retry the request if necessary. If the page orientation or page count is different from the original template document, we will notify you with a `template_error` [callback event](https://app.hellosign.com/api/eventsAndCallbacksWalkthrough). /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/TemplateUpdateFilesExample.cs /// Thrown when fails to make API call /// The ID of the template whose files to update. /// @@ -2569,6 +2654,7 @@ public TemplateUpdateFilesResponse TemplateUpdateFiles(string templateId, Templa /// /// Update Template Files Overlays a new file with the overlay of an existing template. The new file(s) must: 1. have the same or higher page count 2. the same orientation as the file(s) being replaced. This will not overwrite or in any way affect the existing template. Both the existing template and new template will be available for use after executing this endpoint. Also note that this will decrement your template quota. Overlaying new files is asynchronous and a successful call to this endpoint will return 200 OK response if the request passes initial validation checks. It is recommended that a callback be implemented to listen for the callback event. A `template_created` event will be sent when the files are updated or a `template_error` event will be sent if there was a problem while updating the files. If a callback handler has been configured and the event has not been received within 60 minutes of making the call, check the status of the request in the API dashboard and retry the request if necessary. If the page orientation or page count is different from the original template document, we will notify you with a `template_error` [callback event](https://app.hellosign.com/api/eventsAndCallbacksWalkthrough). /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/TemplateUpdateFilesExample.cs /// Thrown when fails to make API call /// The ID of the template whose files to update. /// @@ -2654,6 +2740,7 @@ public Dropbox.Sign.Client.ApiResponse TemplateUpda /// /// Update Template Files Overlays a new file with the overlay of an existing template. The new file(s) must: 1. have the same or higher page count 2. the same orientation as the file(s) being replaced. This will not overwrite or in any way affect the existing template. Both the existing template and new template will be available for use after executing this endpoint. Also note that this will decrement your template quota. Overlaying new files is asynchronous and a successful call to this endpoint will return 200 OK response if the request passes initial validation checks. It is recommended that a callback be implemented to listen for the callback event. A `template_created` event will be sent when the files are updated or a `template_error` event will be sent if there was a problem while updating the files. If a callback handler has been configured and the event has not been received within 60 minutes of making the call, check the status of the request in the API dashboard and retry the request if necessary. If the page orientation or page count is different from the original template document, we will notify you with a `template_error` [callback event](https://app.hellosign.com/api/eventsAndCallbacksWalkthrough). /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/TemplateUpdateFilesExample.cs /// Thrown when fails to make API call /// The ID of the template whose files to update. /// @@ -2669,6 +2756,7 @@ public Dropbox.Sign.Client.ApiResponse TemplateUpda /// /// Update Template Files Overlays a new file with the overlay of an existing template. The new file(s) must: 1. have the same or higher page count 2. the same orientation as the file(s) being replaced. This will not overwrite or in any way affect the existing template. Both the existing template and new template will be available for use after executing this endpoint. Also note that this will decrement your template quota. Overlaying new files is asynchronous and a successful call to this endpoint will return 200 OK response if the request passes initial validation checks. It is recommended that a callback be implemented to listen for the callback event. A `template_created` event will be sent when the files are updated or a `template_error` event will be sent if there was a problem while updating the files. If a callback handler has been configured and the event has not been received within 60 minutes of making the call, check the status of the request in the API dashboard and retry the request if necessary. If the page orientation or page count is different from the original template document, we will notify you with a `template_error` [callback event](https://app.hellosign.com/api/eventsAndCallbacksWalkthrough). /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/TemplateUpdateFilesExample.cs /// Thrown when fails to make API call /// The ID of the template whose files to update. /// diff --git a/sdks/dotnet/src/Dropbox.Sign/Api/UnclaimedDraftApi.cs b/sdks/dotnet/src/Dropbox.Sign/Api/UnclaimedDraftApi.cs index 6e23e47ef..a41df498f 100644 --- a/sdks/dotnet/src/Dropbox.Sign/Api/UnclaimedDraftApi.cs +++ b/sdks/dotnet/src/Dropbox.Sign/Api/UnclaimedDraftApi.cs @@ -33,6 +33,7 @@ public interface IUnclaimedDraftApiSync : IApiAccessor /// /// Creates a new Draft that can be claimed using the claim URL. The first authenticated user to access the URL will claim the Draft and will be shown either the \"Sign and send\" or the \"Request signature\" page with the Draft loaded. Subsequent access to the claim URL will result in a 404. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/UnclaimedDraftCreateExample.cs /// Thrown when fails to make API call /// /// Index associated with the operation. @@ -45,6 +46,7 @@ public interface IUnclaimedDraftApiSync : IApiAccessor /// /// Creates a new Draft that can be claimed using the claim URL. The first authenticated user to access the URL will claim the Draft and will be shown either the \"Sign and send\" or the \"Request signature\" page with the Draft loaded. Subsequent access to the claim URL will result in a 404. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/UnclaimedDraftCreateExample.cs /// Thrown when fails to make API call /// /// Index associated with the operation. @@ -56,6 +58,7 @@ public interface IUnclaimedDraftApiSync : IApiAccessor /// /// Creates a new Draft that can be claimed and used in an embedded iFrame. The first authenticated user to access the URL will claim the Draft and will be shown the \"Request signature\" page with the Draft loaded. Subsequent access to the claim URL will result in a `404`. For this embedded endpoint the `requester_email_address` parameter is required. **NOTE:** Embedded unclaimed drafts can only be accessed in embedded iFrames whereas normal drafts can be used and accessed on Dropbox Sign. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/UnclaimedDraftCreateEmbeddedExample.cs /// Thrown when fails to make API call /// /// Index associated with the operation. @@ -68,6 +71,7 @@ public interface IUnclaimedDraftApiSync : IApiAccessor /// /// Creates a new Draft that can be claimed and used in an embedded iFrame. The first authenticated user to access the URL will claim the Draft and will be shown the \"Request signature\" page with the Draft loaded. Subsequent access to the claim URL will result in a `404`. For this embedded endpoint the `requester_email_address` parameter is required. **NOTE:** Embedded unclaimed drafts can only be accessed in embedded iFrames whereas normal drafts can be used and accessed on Dropbox Sign. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/UnclaimedDraftCreateEmbeddedExample.cs /// Thrown when fails to make API call /// /// Index associated with the operation. @@ -79,6 +83,7 @@ public interface IUnclaimedDraftApiSync : IApiAccessor /// /// Creates a new Draft with a previously saved template(s) that can be claimed and used in an embedded iFrame. The first authenticated user to access the URL will claim the Draft and will be shown the \"Request signature\" page with the Draft loaded. Subsequent access to the claim URL will result in a `404`. For this embedded endpoint the `requester_email_address` parameter is required. **NOTE:** Embedded unclaimed drafts can only be accessed in embedded iFrames whereas normal drafts can be used and accessed on Dropbox Sign. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/UnclaimedDraftCreateEmbeddedWithTemplateExample.cs /// Thrown when fails to make API call /// /// Index associated with the operation. @@ -91,6 +96,7 @@ public interface IUnclaimedDraftApiSync : IApiAccessor /// /// Creates a new Draft with a previously saved template(s) that can be claimed and used in an embedded iFrame. The first authenticated user to access the URL will claim the Draft and will be shown the \"Request signature\" page with the Draft loaded. Subsequent access to the claim URL will result in a `404`. For this embedded endpoint the `requester_email_address` parameter is required. **NOTE:** Embedded unclaimed drafts can only be accessed in embedded iFrames whereas normal drafts can be used and accessed on Dropbox Sign. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/UnclaimedDraftCreateEmbeddedWithTemplateExample.cs /// Thrown when fails to make API call /// /// Index associated with the operation. @@ -102,6 +108,7 @@ public interface IUnclaimedDraftApiSync : IApiAccessor /// /// Creates a new signature request from an embedded request that can be edited prior to being sent to the recipients. Parameter `test_mode` can be edited prior to request. Signers can be edited in embedded editor. Requester's email address will remain unchanged if `requester_email_address` parameter is not set. **NOTE:** Embedded unclaimed drafts can only be accessed in embedded iFrames whereas normal drafts can be used and accessed on Dropbox Sign. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/UnclaimedDraftEditAndResendExample.cs /// Thrown when fails to make API call /// The ID of the signature request to edit and resend. /// @@ -115,6 +122,7 @@ public interface IUnclaimedDraftApiSync : IApiAccessor /// /// Creates a new signature request from an embedded request that can be edited prior to being sent to the recipients. Parameter `test_mode` can be edited prior to request. Signers can be edited in embedded editor. Requester's email address will remain unchanged if `requester_email_address` parameter is not set. **NOTE:** Embedded unclaimed drafts can only be accessed in embedded iFrames whereas normal drafts can be used and accessed on Dropbox Sign. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/UnclaimedDraftEditAndResendExample.cs /// Thrown when fails to make API call /// The ID of the signature request to edit and resend. /// @@ -136,6 +144,7 @@ public interface IUnclaimedDraftApiAsync : IApiAccessor /// /// Creates a new Draft that can be claimed using the claim URL. The first authenticated user to access the URL will claim the Draft and will be shown either the \"Sign and send\" or the \"Request signature\" page with the Draft loaded. Subsequent access to the claim URL will result in a 404. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/UnclaimedDraftCreateExample.cs /// Thrown when fails to make API call /// /// Index associated with the operation. @@ -149,6 +158,7 @@ public interface IUnclaimedDraftApiAsync : IApiAccessor /// /// Creates a new Draft that can be claimed using the claim URL. The first authenticated user to access the URL will claim the Draft and will be shown either the \"Sign and send\" or the \"Request signature\" page with the Draft loaded. Subsequent access to the claim URL will result in a 404. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/UnclaimedDraftCreateExample.cs /// Thrown when fails to make API call /// /// Index associated with the operation. @@ -161,6 +171,7 @@ public interface IUnclaimedDraftApiAsync : IApiAccessor /// /// Creates a new Draft that can be claimed and used in an embedded iFrame. The first authenticated user to access the URL will claim the Draft and will be shown the \"Request signature\" page with the Draft loaded. Subsequent access to the claim URL will result in a `404`. For this embedded endpoint the `requester_email_address` parameter is required. **NOTE:** Embedded unclaimed drafts can only be accessed in embedded iFrames whereas normal drafts can be used and accessed on Dropbox Sign. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/UnclaimedDraftCreateEmbeddedExample.cs /// Thrown when fails to make API call /// /// Index associated with the operation. @@ -174,6 +185,7 @@ public interface IUnclaimedDraftApiAsync : IApiAccessor /// /// Creates a new Draft that can be claimed and used in an embedded iFrame. The first authenticated user to access the URL will claim the Draft and will be shown the \"Request signature\" page with the Draft loaded. Subsequent access to the claim URL will result in a `404`. For this embedded endpoint the `requester_email_address` parameter is required. **NOTE:** Embedded unclaimed drafts can only be accessed in embedded iFrames whereas normal drafts can be used and accessed on Dropbox Sign. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/UnclaimedDraftCreateEmbeddedExample.cs /// Thrown when fails to make API call /// /// Index associated with the operation. @@ -186,6 +198,7 @@ public interface IUnclaimedDraftApiAsync : IApiAccessor /// /// Creates a new Draft with a previously saved template(s) that can be claimed and used in an embedded iFrame. The first authenticated user to access the URL will claim the Draft and will be shown the \"Request signature\" page with the Draft loaded. Subsequent access to the claim URL will result in a `404`. For this embedded endpoint the `requester_email_address` parameter is required. **NOTE:** Embedded unclaimed drafts can only be accessed in embedded iFrames whereas normal drafts can be used and accessed on Dropbox Sign. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/UnclaimedDraftCreateEmbeddedWithTemplateExample.cs /// Thrown when fails to make API call /// /// Index associated with the operation. @@ -199,6 +212,7 @@ public interface IUnclaimedDraftApiAsync : IApiAccessor /// /// Creates a new Draft with a previously saved template(s) that can be claimed and used in an embedded iFrame. The first authenticated user to access the URL will claim the Draft and will be shown the \"Request signature\" page with the Draft loaded. Subsequent access to the claim URL will result in a `404`. For this embedded endpoint the `requester_email_address` parameter is required. **NOTE:** Embedded unclaimed drafts can only be accessed in embedded iFrames whereas normal drafts can be used and accessed on Dropbox Sign. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/UnclaimedDraftCreateEmbeddedWithTemplateExample.cs /// Thrown when fails to make API call /// /// Index associated with the operation. @@ -211,6 +225,7 @@ public interface IUnclaimedDraftApiAsync : IApiAccessor /// /// Creates a new signature request from an embedded request that can be edited prior to being sent to the recipients. Parameter `test_mode` can be edited prior to request. Signers can be edited in embedded editor. Requester's email address will remain unchanged if `requester_email_address` parameter is not set. **NOTE:** Embedded unclaimed drafts can only be accessed in embedded iFrames whereas normal drafts can be used and accessed on Dropbox Sign. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/UnclaimedDraftEditAndResendExample.cs /// Thrown when fails to make API call /// The ID of the signature request to edit and resend. /// @@ -225,6 +240,7 @@ public interface IUnclaimedDraftApiAsync : IApiAccessor /// /// Creates a new signature request from an embedded request that can be edited prior to being sent to the recipients. Parameter `test_mode` can be edited prior to request. Signers can be edited in embedded editor. Requester's email address will remain unchanged if `requester_email_address` parameter is not set. **NOTE:** Embedded unclaimed drafts can only be accessed in embedded iFrames whereas normal drafts can be used and accessed on Dropbox Sign. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/UnclaimedDraftEditAndResendExample.cs /// Thrown when fails to make API call /// The ID of the signature request to edit and resend. /// @@ -355,6 +371,7 @@ public Dropbox.Sign.Client.ExceptionFactory ExceptionFactory /// /// Create Unclaimed Draft Creates a new Draft that can be claimed using the claim URL. The first authenticated user to access the URL will claim the Draft and will be shown either the \"Sign and send\" or the \"Request signature\" page with the Draft loaded. Subsequent access to the claim URL will result in a 404. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/UnclaimedDraftCreateExample.cs /// Thrown when fails to make API call /// /// Index associated with the operation. @@ -368,6 +385,7 @@ public UnclaimedDraftCreateResponse UnclaimedDraftCreate(UnclaimedDraftCreateReq /// /// Create Unclaimed Draft Creates a new Draft that can be claimed using the claim URL. The first authenticated user to access the URL will claim the Draft and will be shown either the \"Sign and send\" or the \"Request signature\" page with the Draft loaded. Subsequent access to the claim URL will result in a 404. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/UnclaimedDraftCreateExample.cs /// Thrown when fails to make API call /// /// Index associated with the operation. @@ -445,6 +463,7 @@ public Dropbox.Sign.Client.ApiResponse UnclaimedDr /// /// Create Unclaimed Draft Creates a new Draft that can be claimed using the claim URL. The first authenticated user to access the URL will claim the Draft and will be shown either the \"Sign and send\" or the \"Request signature\" page with the Draft loaded. Subsequent access to the claim URL will result in a 404. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/UnclaimedDraftCreateExample.cs /// Thrown when fails to make API call /// /// Index associated with the operation. @@ -459,6 +478,7 @@ public Dropbox.Sign.Client.ApiResponse UnclaimedDr /// /// Create Unclaimed Draft Creates a new Draft that can be claimed using the claim URL. The first authenticated user to access the URL will claim the Draft and will be shown either the \"Sign and send\" or the \"Request signature\" page with the Draft loaded. Subsequent access to the claim URL will result in a 404. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/UnclaimedDraftCreateExample.cs /// Thrown when fails to make API call /// /// Index associated with the operation. @@ -539,6 +559,7 @@ public Dropbox.Sign.Client.ApiResponse UnclaimedDr /// /// Create Embedded Unclaimed Draft Creates a new Draft that can be claimed and used in an embedded iFrame. The first authenticated user to access the URL will claim the Draft and will be shown the \"Request signature\" page with the Draft loaded. Subsequent access to the claim URL will result in a `404`. For this embedded endpoint the `requester_email_address` parameter is required. **NOTE:** Embedded unclaimed drafts can only be accessed in embedded iFrames whereas normal drafts can be used and accessed on Dropbox Sign. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/UnclaimedDraftCreateEmbeddedExample.cs /// Thrown when fails to make API call /// /// Index associated with the operation. @@ -552,6 +573,7 @@ public UnclaimedDraftCreateResponse UnclaimedDraftCreateEmbedded(UnclaimedDraftC /// /// Create Embedded Unclaimed Draft Creates a new Draft that can be claimed and used in an embedded iFrame. The first authenticated user to access the URL will claim the Draft and will be shown the \"Request signature\" page with the Draft loaded. Subsequent access to the claim URL will result in a `404`. For this embedded endpoint the `requester_email_address` parameter is required. **NOTE:** Embedded unclaimed drafts can only be accessed in embedded iFrames whereas normal drafts can be used and accessed on Dropbox Sign. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/UnclaimedDraftCreateEmbeddedExample.cs /// Thrown when fails to make API call /// /// Index associated with the operation. @@ -629,6 +651,7 @@ public Dropbox.Sign.Client.ApiResponse UnclaimedDr /// /// Create Embedded Unclaimed Draft Creates a new Draft that can be claimed and used in an embedded iFrame. The first authenticated user to access the URL will claim the Draft and will be shown the \"Request signature\" page with the Draft loaded. Subsequent access to the claim URL will result in a `404`. For this embedded endpoint the `requester_email_address` parameter is required. **NOTE:** Embedded unclaimed drafts can only be accessed in embedded iFrames whereas normal drafts can be used and accessed on Dropbox Sign. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/UnclaimedDraftCreateEmbeddedExample.cs /// Thrown when fails to make API call /// /// Index associated with the operation. @@ -643,6 +666,7 @@ public Dropbox.Sign.Client.ApiResponse UnclaimedDr /// /// Create Embedded Unclaimed Draft Creates a new Draft that can be claimed and used in an embedded iFrame. The first authenticated user to access the URL will claim the Draft and will be shown the \"Request signature\" page with the Draft loaded. Subsequent access to the claim URL will result in a `404`. For this embedded endpoint the `requester_email_address` parameter is required. **NOTE:** Embedded unclaimed drafts can only be accessed in embedded iFrames whereas normal drafts can be used and accessed on Dropbox Sign. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/UnclaimedDraftCreateEmbeddedExample.cs /// Thrown when fails to make API call /// /// Index associated with the operation. @@ -723,6 +747,7 @@ public Dropbox.Sign.Client.ApiResponse UnclaimedDr /// /// Create Embedded Unclaimed Draft with Template Creates a new Draft with a previously saved template(s) that can be claimed and used in an embedded iFrame. The first authenticated user to access the URL will claim the Draft and will be shown the \"Request signature\" page with the Draft loaded. Subsequent access to the claim URL will result in a `404`. For this embedded endpoint the `requester_email_address` parameter is required. **NOTE:** Embedded unclaimed drafts can only be accessed in embedded iFrames whereas normal drafts can be used and accessed on Dropbox Sign. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/UnclaimedDraftCreateEmbeddedWithTemplateExample.cs /// Thrown when fails to make API call /// /// Index associated with the operation. @@ -736,6 +761,7 @@ public UnclaimedDraftCreateResponse UnclaimedDraftCreateEmbeddedWithTemplate(Unc /// /// Create Embedded Unclaimed Draft with Template Creates a new Draft with a previously saved template(s) that can be claimed and used in an embedded iFrame. The first authenticated user to access the URL will claim the Draft and will be shown the \"Request signature\" page with the Draft loaded. Subsequent access to the claim URL will result in a `404`. For this embedded endpoint the `requester_email_address` parameter is required. **NOTE:** Embedded unclaimed drafts can only be accessed in embedded iFrames whereas normal drafts can be used and accessed on Dropbox Sign. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/UnclaimedDraftCreateEmbeddedWithTemplateExample.cs /// Thrown when fails to make API call /// /// Index associated with the operation. @@ -813,6 +839,7 @@ public Dropbox.Sign.Client.ApiResponse UnclaimedDr /// /// Create Embedded Unclaimed Draft with Template Creates a new Draft with a previously saved template(s) that can be claimed and used in an embedded iFrame. The first authenticated user to access the URL will claim the Draft and will be shown the \"Request signature\" page with the Draft loaded. Subsequent access to the claim URL will result in a `404`. For this embedded endpoint the `requester_email_address` parameter is required. **NOTE:** Embedded unclaimed drafts can only be accessed in embedded iFrames whereas normal drafts can be used and accessed on Dropbox Sign. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/UnclaimedDraftCreateEmbeddedWithTemplateExample.cs /// Thrown when fails to make API call /// /// Index associated with the operation. @@ -827,6 +854,7 @@ public Dropbox.Sign.Client.ApiResponse UnclaimedDr /// /// Create Embedded Unclaimed Draft with Template Creates a new Draft with a previously saved template(s) that can be claimed and used in an embedded iFrame. The first authenticated user to access the URL will claim the Draft and will be shown the \"Request signature\" page with the Draft loaded. Subsequent access to the claim URL will result in a `404`. For this embedded endpoint the `requester_email_address` parameter is required. **NOTE:** Embedded unclaimed drafts can only be accessed in embedded iFrames whereas normal drafts can be used and accessed on Dropbox Sign. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/UnclaimedDraftCreateEmbeddedWithTemplateExample.cs /// Thrown when fails to make API call /// /// Index associated with the operation. @@ -907,6 +935,7 @@ public Dropbox.Sign.Client.ApiResponse UnclaimedDr /// /// Edit and Resend Unclaimed Draft Creates a new signature request from an embedded request that can be edited prior to being sent to the recipients. Parameter `test_mode` can be edited prior to request. Signers can be edited in embedded editor. Requester's email address will remain unchanged if `requester_email_address` parameter is not set. **NOTE:** Embedded unclaimed drafts can only be accessed in embedded iFrames whereas normal drafts can be used and accessed on Dropbox Sign. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/UnclaimedDraftEditAndResendExample.cs /// Thrown when fails to make API call /// The ID of the signature request to edit and resend. /// @@ -921,6 +950,7 @@ public UnclaimedDraftCreateResponse UnclaimedDraftEditAndResend(string signature /// /// Edit and Resend Unclaimed Draft Creates a new signature request from an embedded request that can be edited prior to being sent to the recipients. Parameter `test_mode` can be edited prior to request. Signers can be edited in embedded editor. Requester's email address will remain unchanged if `requester_email_address` parameter is not set. **NOTE:** Embedded unclaimed drafts can only be accessed in embedded iFrames whereas normal drafts can be used and accessed on Dropbox Sign. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/UnclaimedDraftEditAndResendExample.cs /// Thrown when fails to make API call /// The ID of the signature request to edit and resend. /// @@ -1006,6 +1036,7 @@ public Dropbox.Sign.Client.ApiResponse UnclaimedDr /// /// Edit and Resend Unclaimed Draft Creates a new signature request from an embedded request that can be edited prior to being sent to the recipients. Parameter `test_mode` can be edited prior to request. Signers can be edited in embedded editor. Requester's email address will remain unchanged if `requester_email_address` parameter is not set. **NOTE:** Embedded unclaimed drafts can only be accessed in embedded iFrames whereas normal drafts can be used and accessed on Dropbox Sign. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/UnclaimedDraftEditAndResendExample.cs /// Thrown when fails to make API call /// The ID of the signature request to edit and resend. /// @@ -1021,6 +1052,7 @@ public Dropbox.Sign.Client.ApiResponse UnclaimedDr /// /// Edit and Resend Unclaimed Draft Creates a new signature request from an embedded request that can be edited prior to being sent to the recipients. Parameter `test_mode` can be edited prior to request. Signers can be edited in embedded editor. Requester's email address will remain unchanged if `requester_email_address` parameter is not set. **NOTE:** Embedded unclaimed drafts can only be accessed in embedded iFrames whereas normal drafts can be used and accessed on Dropbox Sign. /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/UnclaimedDraftEditAndResendExample.cs /// Thrown when fails to make API call /// The ID of the signature request to edit and resend. /// diff --git a/sdks/dotnet/templates/api.mustache b/sdks/dotnet/templates/api.mustache index c0b29af2e..804b98767 100644 --- a/sdks/dotnet/templates/api.mustache +++ b/sdks/dotnet/templates/api.mustache @@ -31,6 +31,7 @@ namespace {{packageName}}.{{apiPackage}} /// {{.}} /// {{/notes}} + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/{{operationIdCamelCase}}Example.cs /// Thrown when fails to make API call {{#allParams}}/// {{description}}{{^required}} (optional{{#defaultValue}}, default to {{.}}{{/defaultValue}}){{/required}}{{#isDeprecated}} (deprecated){{/isDeprecated}} {{/allParams}}/// Index associated with the operation. @@ -46,6 +47,7 @@ namespace {{packageName}}.{{apiPackage}} /// /// {{notes}} /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/{{operationIdCamelCase}}Example.cs /// Thrown when fails to make API call {{#allParams}}/// {{description}}{{^required}} (optional{{#defaultValue}}, default to {{.}}{{/defaultValue}}){{/required}}{{#isDeprecated}} (deprecated){{/isDeprecated}} {{/allParams}}/// Index associated with the operation. @@ -72,6 +74,7 @@ namespace {{packageName}}.{{apiPackage}} /// /// {{notes}} /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/{{operationIdCamelCase}}Example.cs /// Thrown when fails to make API call {{#allParams}} /// {{description}}{{^required}} (optional{{#defaultValue}}, default to {{.}}{{/defaultValue}}){{/required}}{{#isDeprecated}} (deprecated){{/isDeprecated}} @@ -90,6 +93,7 @@ namespace {{packageName}}.{{apiPackage}} /// /// {{notes}} /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/{{operationIdCamelCase}}Example.cs /// Thrown when fails to make API call {{#allParams}} /// {{description}}{{^required}} (optional{{#defaultValue}}, default to {{.}}{{/defaultValue}}){{/required}}{{#isDeprecated}} (deprecated){{/isDeprecated}} @@ -237,6 +241,7 @@ namespace {{packageName}}.{{apiPackage}} /// /// {{summary}} {{notes}} /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/{{operationIdCamelCase}}Example.cs /// Thrown when fails to make API call {{#allParams}}/// {{description}}{{^required}} (optional{{#defaultValue}}, default to {{.}}{{/defaultValue}}){{/required}}{{#isDeprecated}} (deprecated){{/isDeprecated}} {{/allParams}}/// Index associated with the operation. @@ -253,6 +258,7 @@ namespace {{packageName}}.{{apiPackage}} /// /// {{summary}} {{notes}} /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/{{operationIdCamelCase}}Example.cs /// Thrown when fails to make API call {{#allParams}}/// {{description}}{{^required}} (optional{{#defaultValue}}, default to {{.}}{{/defaultValue}}){{/required}}{{#isDeprecated}} (deprecated){{/isDeprecated}} {{/allParams}}/// Index associated with the operation. @@ -533,6 +539,7 @@ namespace {{packageName}}.{{apiPackage}} /// /// {{summary}} {{notes}} /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/{{operationIdCamelCase}}Example.cs /// Thrown when fails to make API call {{#allParams}} /// {{description}}{{^required}} (optional{{#defaultValue}}, default to {{.}}{{/defaultValue}}){{/required}}{{#isDeprecated}} (deprecated){{/isDeprecated}} @@ -552,6 +559,7 @@ namespace {{packageName}}.{{apiPackage}} /// /// {{summary}} {{notes}} /// + /// https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/{{operationIdCamelCase}}Example.cs /// Thrown when fails to make API call {{#allParams}} /// {{description}}{{^required}} (optional{{#defaultValue}}, default to {{.}}{{/defaultValue}}){{/required}}{{#isDeprecated}} (deprecated){{/isDeprecated}} diff --git a/sdks/java-v2/src/main/java/com/dropbox/sign/api/AccountApi.java b/sdks/java-v2/src/main/java/com/dropbox/sign/api/AccountApi.java index 3981d8dee..95a905691 100644 --- a/sdks/java-v2/src/main/java/com/dropbox/sign/api/AccountApi.java +++ b/sdks/java-v2/src/main/java/com/dropbox/sign/api/AccountApi.java @@ -55,6 +55,7 @@ public void setApiClient(ApiClient apiClient) { /** * Create Account * Creates a new Dropbox Sign Account that is associated with the specified `email_address`. + * Example: https://github.com/hellosign/dropbox-sign-java/blob/main/examples/AccountCreateExample.java * @param accountCreateRequest (required) * @return AccountCreateResponse * @throws ApiException if fails to make API call @@ -74,6 +75,7 @@ public AccountCreateResponse accountCreate(AccountCreateRequest accountCreateReq /** * Create Account * Creates a new Dropbox Sign Account that is associated with the specified `email_address`. + * Example: https://github.com/hellosign/dropbox-sign-java/blob/main/examples/AccountCreateExample.java * @param accountCreateRequest (required) * @return ApiResponse<AccountCreateResponse> * @throws ApiException if fails to make API call @@ -118,6 +120,7 @@ public ApiResponse accountCreateWithHttpInfo(AccountCreat /** * Get Account * Returns the properties and settings of your Account. + * Example: https://github.com/hellosign/dropbox-sign-java/blob/main/examples/AccountGetExample.java * @param accountId `account_id` or `email_address` is required. If both are provided, the account id prevails. The ID of the Account. (optional) * @param emailAddress `account_id` or `email_address` is required, If both are provided, the account id prevails. The email address of the Account. (optional) * @return AccountGetResponse @@ -177,6 +180,7 @@ public ApiResponse accountGetWithHttpInfo(String accountId) /** * Get Account * Returns the properties and settings of your Account. + * Example: https://github.com/hellosign/dropbox-sign-java/blob/main/examples/AccountGetExample.java * @param accountId `account_id` or `email_address` is required. If both are provided, the account id prevails. The ID of the Account. (optional) * @param emailAddress `account_id` or `email_address` is required, If both are provided, the account id prevails. The email address of the Account. (optional) * @return ApiResponse<AccountGetResponse> @@ -223,6 +227,7 @@ public ApiResponse accountGetWithHttpInfo(String accountId, /** * Update Account * Updates the properties and settings of your Account. Currently only allows for updates to the [Callback URL](/api/reference/tag/Callbacks-and-Events) and locale. + * Example: https://github.com/hellosign/dropbox-sign-java/blob/main/examples/AccountUpdateExample.java * @param accountUpdateRequest (required) * @return AccountGetResponse * @throws ApiException if fails to make API call @@ -242,6 +247,7 @@ public AccountGetResponse accountUpdate(AccountUpdateRequest accountUpdateReques /** * Update Account * Updates the properties and settings of your Account. Currently only allows for updates to the [Callback URL](/api/reference/tag/Callbacks-and-Events) and locale. + * Example: https://github.com/hellosign/dropbox-sign-java/blob/main/examples/AccountUpdateExample.java * @param accountUpdateRequest (required) * @return ApiResponse<AccountGetResponse> * @throws ApiException if fails to make API call @@ -286,6 +292,7 @@ public ApiResponse accountUpdateWithHttpInfo(AccountUpdateRe /** * Verify Account * Verifies whether an Dropbox Sign Account exists for the given email address. + * Example: https://github.com/hellosign/dropbox-sign-java/blob/main/examples/AccountVerifyExample.java * @param accountVerifyRequest (required) * @return AccountVerifyResponse * @throws ApiException if fails to make API call @@ -305,6 +312,7 @@ public AccountVerifyResponse accountVerify(AccountVerifyRequest accountVerifyReq /** * Verify Account * Verifies whether an Dropbox Sign Account exists for the given email address. + * Example: https://github.com/hellosign/dropbox-sign-java/blob/main/examples/AccountVerifyExample.java * @param accountVerifyRequest (required) * @return ApiResponse<AccountVerifyResponse> * @throws ApiException if fails to make API call diff --git a/sdks/java-v2/src/main/java/com/dropbox/sign/api/ApiAppApi.java b/sdks/java-v2/src/main/java/com/dropbox/sign/api/ApiAppApi.java index 813cf39c4..b30d6505b 100644 --- a/sdks/java-v2/src/main/java/com/dropbox/sign/api/ApiAppApi.java +++ b/sdks/java-v2/src/main/java/com/dropbox/sign/api/ApiAppApi.java @@ -53,6 +53,7 @@ public void setApiClient(ApiClient apiClient) { /** * Create API App * Creates a new API App. + * Example: https://github.com/hellosign/dropbox-sign-java/blob/main/examples/ApiAppCreateExample.java * @param apiAppCreateRequest (required) * @return ApiAppGetResponse * @throws ApiException if fails to make API call @@ -72,6 +73,7 @@ public ApiAppGetResponse apiAppCreate(ApiAppCreateRequest apiAppCreateRequest) t /** * Create API App * Creates a new API App. + * Example: https://github.com/hellosign/dropbox-sign-java/blob/main/examples/ApiAppCreateExample.java * @param apiAppCreateRequest (required) * @return ApiResponse<ApiAppGetResponse> * @throws ApiException if fails to make API call @@ -116,6 +118,7 @@ public ApiResponse apiAppCreateWithHttpInfo(ApiAppCreateReque /** * Delete API App * Deletes an API App. Can only be invoked for apps you own. + * Example: https://github.com/hellosign/dropbox-sign-java/blob/main/examples/ApiAppDeleteExample.java * @param clientId The client id of the API App to delete. (required) * @throws ApiException if fails to make API call * @http.response.details @@ -134,6 +137,7 @@ public void apiAppDelete(String clientId) throws ApiException { /** * Delete API App * Deletes an API App. Can only be invoked for apps you own. + * Example: https://github.com/hellosign/dropbox-sign-java/blob/main/examples/ApiAppDeleteExample.java * @param clientId The client id of the API App to delete. (required) * @return ApiResponse<Void> * @throws ApiException if fails to make API call @@ -181,6 +185,7 @@ public ApiResponse apiAppDeleteWithHttpInfo(String clientId) throws ApiExc /** * Get API App * Returns an object with information about an API App. + * Example: https://github.com/hellosign/dropbox-sign-java/blob/main/examples/ApiAppGetExample.java * @param clientId The client id of the API App to retrieve. (required) * @return ApiAppGetResponse * @throws ApiException if fails to make API call @@ -200,6 +205,7 @@ public ApiAppGetResponse apiAppGet(String clientId) throws ApiException { /** * Get API App * Returns an object with information about an API App. + * Example: https://github.com/hellosign/dropbox-sign-java/blob/main/examples/ApiAppGetExample.java * @param clientId The client id of the API App to retrieve. (required) * @return ApiResponse<ApiAppGetResponse> * @throws ApiException if fails to make API call @@ -248,6 +254,7 @@ public ApiResponse apiAppGetWithHttpInfo(String clientId) thr /** * List API Apps * Returns a list of API Apps that are accessible by you. If you are on a team with an Admin or Developer role, this list will include apps owned by teammates. + * Example: https://github.com/hellosign/dropbox-sign-java/blob/main/examples/ApiAppListExample.java * @param page Which page number of the API App List to return. Defaults to `1`. (optional, default to 1) * @param pageSize Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. (optional, default to 20) * @return ApiAppListResponse @@ -307,6 +314,7 @@ public ApiResponse apiAppListWithHttpInfo(Integer page) thro /** * List API Apps * Returns a list of API Apps that are accessible by you. If you are on a team with an Admin or Developer role, this list will include apps owned by teammates. + * Example: https://github.com/hellosign/dropbox-sign-java/blob/main/examples/ApiAppListExample.java * @param page Which page number of the API App List to return. Defaults to `1`. (optional, default to 1) * @param pageSize Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. (optional, default to 20) * @return ApiResponse<ApiAppListResponse> @@ -359,6 +367,7 @@ public ApiResponse apiAppListWithHttpInfo(Integer page, Inte /** * Update API App * Updates an existing API App. Can only be invoked for apps you own. Only the fields you provide will be updated. If you wish to clear an existing optional field, provide an empty string. + * Example: https://github.com/hellosign/dropbox-sign-java/blob/main/examples/ApiAppUpdateExample.java * @param clientId The client id of the API App to update. (required) * @param apiAppUpdateRequest (required) * @return ApiAppGetResponse @@ -379,6 +388,7 @@ public ApiAppGetResponse apiAppUpdate(String clientId, ApiAppUpdateRequest apiAp /** * Update API App * Updates an existing API App. Can only be invoked for apps you own. Only the fields you provide will be updated. If you wish to clear an existing optional field, provide an empty string. + * Example: https://github.com/hellosign/dropbox-sign-java/blob/main/examples/ApiAppUpdateExample.java * @param clientId The client id of the API App to update. (required) * @param apiAppUpdateRequest (required) * @return ApiResponse<ApiAppGetResponse> diff --git a/sdks/java-v2/src/main/java/com/dropbox/sign/api/BulkSendJobApi.java b/sdks/java-v2/src/main/java/com/dropbox/sign/api/BulkSendJobApi.java index 098c28cce..bde06732f 100644 --- a/sdks/java-v2/src/main/java/com/dropbox/sign/api/BulkSendJobApi.java +++ b/sdks/java-v2/src/main/java/com/dropbox/sign/api/BulkSendJobApi.java @@ -51,6 +51,7 @@ public void setApiClient(ApiClient apiClient) { /** * Get Bulk Send Job * Returns the status of the BulkSendJob and its SignatureRequests specified by the `bulk_send_job_id` parameter. + * Example: https://github.com/hellosign/dropbox-sign-java/blob/main/examples/BulkSendJobGetExample.java * @param bulkSendJobId The id of the BulkSendJob to retrieve. (required) * @param page Which page number of the BulkSendJob list to return. Defaults to `1`. (optional, default to 1) * @param pageSize Number of objects to be returned per page. Must be between `1` and `100`. Default is 20. (optional, default to 20) @@ -111,6 +112,7 @@ public ApiResponse bulkSendJobGetWithHttpInfo(String bul /** * Get Bulk Send Job * Returns the status of the BulkSendJob and its SignatureRequests specified by the `bulk_send_job_id` parameter. + * Example: https://github.com/hellosign/dropbox-sign-java/blob/main/examples/BulkSendJobGetExample.java * @param bulkSendJobId The id of the BulkSendJob to retrieve. (required) * @param page Which page number of the BulkSendJob list to return. Defaults to `1`. (optional, default to 1) * @param pageSize Number of objects to be returned per page. Must be between `1` and `100`. Default is 20. (optional, default to 20) @@ -173,6 +175,7 @@ public ApiResponse bulkSendJobGetWithHttpInfo(String bul /** * List Bulk Send Jobs * Returns a list of BulkSendJob that you can access. + * Example: https://github.com/hellosign/dropbox-sign-java/blob/main/examples/BulkSendJobListExample.java * @param page Which page number of the BulkSendJob List to return. Defaults to `1`. (optional, default to 1) * @param pageSize Number of objects to be returned per page. Must be between `1` and `100`. Default is 20. (optional, default to 20) * @return BulkSendJobListResponse @@ -232,6 +235,7 @@ public ApiResponse bulkSendJobListWithHttpInfo(Integer /** * List Bulk Send Jobs * Returns a list of BulkSendJob that you can access. + * Example: https://github.com/hellosign/dropbox-sign-java/blob/main/examples/BulkSendJobListExample.java * @param page Which page number of the BulkSendJob List to return. Defaults to `1`. (optional, default to 1) * @param pageSize Number of objects to be returned per page. Must be between `1` and `100`. Default is 20. (optional, default to 20) * @return ApiResponse<BulkSendJobListResponse> diff --git a/sdks/java-v2/src/main/java/com/dropbox/sign/api/EmbeddedApi.java b/sdks/java-v2/src/main/java/com/dropbox/sign/api/EmbeddedApi.java index a847620d5..3cc198b87 100644 --- a/sdks/java-v2/src/main/java/com/dropbox/sign/api/EmbeddedApi.java +++ b/sdks/java-v2/src/main/java/com/dropbox/sign/api/EmbeddedApi.java @@ -52,6 +52,7 @@ public void setApiClient(ApiClient apiClient) { /** * Get Embedded Template Edit URL * Retrieves an embedded object containing a template url that can be opened in an iFrame. Note that only templates created via the embedded template process are available to be edited with this endpoint. + * Example: https://github.com/hellosign/dropbox-sign-java/blob/main/examples/EmbeddedEditUrlExample.java * @param templateId The id of the template to edit. (required) * @param embeddedEditUrlRequest (required) * @return EmbeddedEditUrlResponse @@ -72,6 +73,7 @@ public EmbeddedEditUrlResponse embeddedEditUrl(String templateId, EmbeddedEditUr /** * Get Embedded Template Edit URL * Retrieves an embedded object containing a template url that can be opened in an iFrame. Note that only templates created via the embedded template process are available to be edited with this endpoint. + * Example: https://github.com/hellosign/dropbox-sign-java/blob/main/examples/EmbeddedEditUrlExample.java * @param templateId The id of the template to edit. (required) * @param embeddedEditUrlRequest (required) * @return ApiResponse<EmbeddedEditUrlResponse> @@ -124,6 +126,7 @@ public ApiResponse embeddedEditUrlWithHttpInfo(String t /** * Get Embedded Sign URL * Retrieves an embedded object containing a signature url that can be opened in an iFrame. Note that templates created via the embedded template process will only be accessible through the API. + * Example: https://github.com/hellosign/dropbox-sign-java/blob/main/examples/EmbeddedSignUrlExample.java * @param signatureId The id of the signature to get a signature url for. (required) * @return EmbeddedSignUrlResponse * @throws ApiException if fails to make API call @@ -143,6 +146,7 @@ public EmbeddedSignUrlResponse embeddedSignUrl(String signatureId) throws ApiExc /** * Get Embedded Sign URL * Retrieves an embedded object containing a signature url that can be opened in an iFrame. Note that templates created via the embedded template process will only be accessible through the API. + * Example: https://github.com/hellosign/dropbox-sign-java/blob/main/examples/EmbeddedSignUrlExample.java * @param signatureId The id of the signature to get a signature url for. (required) * @return ApiResponse<EmbeddedSignUrlResponse> * @throws ApiException if fails to make API call diff --git a/sdks/java-v2/src/main/java/com/dropbox/sign/api/FaxApi.java b/sdks/java-v2/src/main/java/com/dropbox/sign/api/FaxApi.java index e438d0d03..07aa92b07 100644 --- a/sdks/java-v2/src/main/java/com/dropbox/sign/api/FaxApi.java +++ b/sdks/java-v2/src/main/java/com/dropbox/sign/api/FaxApi.java @@ -53,6 +53,7 @@ public void setApiClient(ApiClient apiClient) { /** * Delete Fax * Deletes the specified Fax from the system + * Example: https://github.com/hellosign/dropbox-sign-java/blob/main/examples/FaxDeleteExample.java * @param faxId Fax ID (required) * @throws ApiException if fails to make API call * @http.response.details @@ -71,6 +72,7 @@ public void faxDelete(String faxId) throws ApiException { /** * Delete Fax * Deletes the specified Fax from the system + * Example: https://github.com/hellosign/dropbox-sign-java/blob/main/examples/FaxDeleteExample.java * @param faxId Fax ID (required) * @return ApiResponse<Void> * @throws ApiException if fails to make API call @@ -118,6 +120,7 @@ public ApiResponse faxDeleteWithHttpInfo(String faxId) throws ApiException /** * Download Fax Files * Downloads files associated with a Fax + * Example: https://github.com/hellosign/dropbox-sign-java/blob/main/examples/FaxFilesExample.java * @param faxId Fax ID (required) * @return File * @throws ApiException if fails to make API call @@ -137,6 +140,7 @@ public File faxFiles(String faxId) throws ApiException { /** * Download Fax Files * Downloads files associated with a Fax + * Example: https://github.com/hellosign/dropbox-sign-java/blob/main/examples/FaxFilesExample.java * @param faxId Fax ID (required) * @return ApiResponse<File> * @throws ApiException if fails to make API call @@ -185,6 +189,7 @@ public ApiResponse faxFilesWithHttpInfo(String faxId) throws ApiException /** * Get Fax * Returns information about a Fax + * Example: https://github.com/hellosign/dropbox-sign-java/blob/main/examples/FaxGetExample.java * @param faxId Fax ID (required) * @return FaxGetResponse * @throws ApiException if fails to make API call @@ -204,6 +209,7 @@ public FaxGetResponse faxGet(String faxId) throws ApiException { /** * Get Fax * Returns information about a Fax + * Example: https://github.com/hellosign/dropbox-sign-java/blob/main/examples/FaxGetExample.java * @param faxId Fax ID (required) * @return ApiResponse<FaxGetResponse> * @throws ApiException if fails to make API call @@ -252,6 +258,7 @@ public ApiResponse faxGetWithHttpInfo(String faxId) throws ApiEx /** * Lists Faxes * Returns properties of multiple Faxes + * Example: https://github.com/hellosign/dropbox-sign-java/blob/main/examples/FaxListExample.java * @param page Which page number of the Fax List to return. Defaults to `1`. (optional, default to 1) * @param pageSize Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. (optional, default to 20) * @return FaxListResponse @@ -311,6 +318,7 @@ public ApiResponse faxListWithHttpInfo(Integer page) throws Api /** * Lists Faxes * Returns properties of multiple Faxes + * Example: https://github.com/hellosign/dropbox-sign-java/blob/main/examples/FaxListExample.java * @param page Which page number of the Fax List to return. Defaults to `1`. (optional, default to 1) * @param pageSize Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. (optional, default to 20) * @return ApiResponse<FaxListResponse> @@ -363,6 +371,7 @@ public ApiResponse faxListWithHttpInfo(Integer page, Integer pa /** * Send Fax * Creates and sends a new Fax with the submitted file(s) + * Example: https://github.com/hellosign/dropbox-sign-java/blob/main/examples/FaxSendExample.java * @param faxSendRequest (required) * @return FaxGetResponse * @throws ApiException if fails to make API call @@ -382,6 +391,7 @@ public FaxGetResponse faxSend(FaxSendRequest faxSendRequest) throws ApiException /** * Send Fax * Creates and sends a new Fax with the submitted file(s) + * Example: https://github.com/hellosign/dropbox-sign-java/blob/main/examples/FaxSendExample.java * @param faxSendRequest (required) * @return ApiResponse<FaxGetResponse> * @throws ApiException if fails to make API call diff --git a/sdks/java-v2/src/main/java/com/dropbox/sign/api/FaxLineApi.java b/sdks/java-v2/src/main/java/com/dropbox/sign/api/FaxLineApi.java index 2d6eb5a96..4980f9f75 100644 --- a/sdks/java-v2/src/main/java/com/dropbox/sign/api/FaxLineApi.java +++ b/sdks/java-v2/src/main/java/com/dropbox/sign/api/FaxLineApi.java @@ -56,6 +56,7 @@ public void setApiClient(ApiClient apiClient) { /** * Add Fax Line User * Grants a user access to the specified Fax Line. + * Example: https://github.com/hellosign/dropbox-sign-java/blob/main/examples/FaxLineAddUserExample.java * @param faxLineAddUserRequest (required) * @return FaxLineResponse * @throws ApiException if fails to make API call @@ -75,6 +76,7 @@ public FaxLineResponse faxLineAddUser(FaxLineAddUserRequest faxLineAddUserReques /** * Add Fax Line User * Grants a user access to the specified Fax Line. + * Example: https://github.com/hellosign/dropbox-sign-java/blob/main/examples/FaxLineAddUserExample.java * @param faxLineAddUserRequest (required) * @return ApiResponse<FaxLineResponse> * @throws ApiException if fails to make API call @@ -119,6 +121,7 @@ public ApiResponse faxLineAddUserWithHttpInfo(FaxLineAddUserReq /** * Get Available Fax Line Area Codes * Returns a list of available area codes for a given state/province and city + * Example: https://github.com/hellosign/dropbox-sign-java/blob/main/examples/FaxLineAreaCodeGetExample.java * @param country Filter area codes by country (required) * @param state Filter area codes by state (optional) * @param province Filter area codes by province (optional) @@ -202,6 +205,7 @@ public ApiResponse faxLineAreaCodeGetWithHttpInfo(St /** * Get Available Fax Line Area Codes * Returns a list of available area codes for a given state/province and city + * Example: https://github.com/hellosign/dropbox-sign-java/blob/main/examples/FaxLineAreaCodeGetExample.java * @param country Filter area codes by country (required) * @param state Filter area codes by state (optional) * @param province Filter area codes by province (optional) @@ -257,6 +261,7 @@ public ApiResponse faxLineAreaCodeGetWithHttpInfo(St /** * Purchase Fax Line * Purchases a new Fax Line + * Example: https://github.com/hellosign/dropbox-sign-java/blob/main/examples/FaxLineCreateExample.java * @param faxLineCreateRequest (required) * @return FaxLineResponse * @throws ApiException if fails to make API call @@ -276,6 +281,7 @@ public FaxLineResponse faxLineCreate(FaxLineCreateRequest faxLineCreateRequest) /** * Purchase Fax Line * Purchases a new Fax Line + * Example: https://github.com/hellosign/dropbox-sign-java/blob/main/examples/FaxLineCreateExample.java * @param faxLineCreateRequest (required) * @return ApiResponse<FaxLineResponse> * @throws ApiException if fails to make API call @@ -320,6 +326,7 @@ public ApiResponse faxLineCreateWithHttpInfo(FaxLineCreateReque /** * Delete Fax Line * Deletes the specified Fax Line from the subscription. + * Example: https://github.com/hellosign/dropbox-sign-java/blob/main/examples/FaxLineDeleteExample.java * @param faxLineDeleteRequest (required) * @throws ApiException if fails to make API call * @http.response.details @@ -338,6 +345,7 @@ public void faxLineDelete(FaxLineDeleteRequest faxLineDeleteRequest) throws ApiE /** * Delete Fax Line * Deletes the specified Fax Line from the subscription. + * Example: https://github.com/hellosign/dropbox-sign-java/blob/main/examples/FaxLineDeleteExample.java * @param faxLineDeleteRequest (required) * @return ApiResponse<Void> * @throws ApiException if fails to make API call @@ -381,6 +389,7 @@ public ApiResponse faxLineDeleteWithHttpInfo(FaxLineDeleteRequest faxLineD /** * Get Fax Line * Returns the properties and settings of a Fax Line. + * Example: https://github.com/hellosign/dropbox-sign-java/blob/main/examples/FaxLineGetExample.java * @param number The Fax Line number (required) * @return FaxLineResponse * @throws ApiException if fails to make API call @@ -400,6 +409,7 @@ public FaxLineResponse faxLineGet(String number) throws ApiException { /** * Get Fax Line * Returns the properties and settings of a Fax Line. + * Example: https://github.com/hellosign/dropbox-sign-java/blob/main/examples/FaxLineGetExample.java * @param number The Fax Line number (required) * @return ApiResponse<FaxLineResponse> * @throws ApiException if fails to make API call @@ -449,6 +459,7 @@ public ApiResponse faxLineGetWithHttpInfo(String number) throws /** * List Fax Lines * Returns the properties and settings of multiple Fax Lines. + * Example: https://github.com/hellosign/dropbox-sign-java/blob/main/examples/FaxLineListExample.java * @param accountId Account ID (optional) * @param page Which page number of the Fax Line List to return. Defaults to `1`. (optional, default to 1) * @param pageSize Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. (optional, default to 20) @@ -556,6 +567,7 @@ public ApiResponse faxLineListWithHttpInfo(String accountId /** * List Fax Lines * Returns the properties and settings of multiple Fax Lines. + * Example: https://github.com/hellosign/dropbox-sign-java/blob/main/examples/FaxLineListExample.java * @param accountId Account ID (optional) * @param page Which page number of the Fax Line List to return. Defaults to `1`. (optional, default to 1) * @param pageSize Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. (optional, default to 20) @@ -612,6 +624,7 @@ public ApiResponse faxLineListWithHttpInfo(String accountId /** * Remove Fax Line Access * Removes a user's access to the specified Fax Line + * Example: https://github.com/hellosign/dropbox-sign-java/blob/main/examples/FaxLineRemoveUserExample.java * @param faxLineRemoveUserRequest (required) * @return FaxLineResponse * @throws ApiException if fails to make API call @@ -631,6 +644,7 @@ public FaxLineResponse faxLineRemoveUser(FaxLineRemoveUserRequest faxLineRemoveU /** * Remove Fax Line Access * Removes a user's access to the specified Fax Line + * Example: https://github.com/hellosign/dropbox-sign-java/blob/main/examples/FaxLineRemoveUserExample.java * @param faxLineRemoveUserRequest (required) * @return ApiResponse<FaxLineResponse> * @throws ApiException if fails to make API call diff --git a/sdks/java-v2/src/main/java/com/dropbox/sign/api/OAuthApi.java b/sdks/java-v2/src/main/java/com/dropbox/sign/api/OAuthApi.java index ddcaa24aa..d14b6cdb2 100644 --- a/sdks/java-v2/src/main/java/com/dropbox/sign/api/OAuthApi.java +++ b/sdks/java-v2/src/main/java/com/dropbox/sign/api/OAuthApi.java @@ -52,6 +52,7 @@ public void setApiClient(ApiClient apiClient) { /** * OAuth Token Generate * Once you have retrieved the code from the user callback, you will need to exchange it for an access token via a backend call. + * Example: https://github.com/hellosign/dropbox-sign-java/blob/main/examples/OauthTokenGenerateExample.java * @param oauthTokenGenerateRequest (required) * @return OAuthTokenResponse * @throws ApiException if fails to make API call @@ -71,6 +72,7 @@ public OAuthTokenResponse oauthTokenGenerate(OAuthTokenGenerateRequest oauthToke /** * OAuth Token Generate * Once you have retrieved the code from the user callback, you will need to exchange it for an access token via a backend call. + * Example: https://github.com/hellosign/dropbox-sign-java/blob/main/examples/OauthTokenGenerateExample.java * @param oauthTokenGenerateRequest (required) * @return ApiResponse<OAuthTokenResponse> * @throws ApiException if fails to make API call @@ -114,6 +116,7 @@ public ApiResponse oauthTokenGenerateWithHttpInfo(OAuthToken /** * OAuth Token Refresh * Access tokens are only valid for a given period of time (typically one hour) for security reasons. Whenever acquiring an new access token its TTL is also given (see `expires_in`), along with a refresh token that can be used to acquire a new access token after the current one has expired. + * Example: https://github.com/hellosign/dropbox-sign-java/blob/main/examples/OauthTokenRefreshExample.java * @param oauthTokenRefreshRequest (required) * @return OAuthTokenResponse * @throws ApiException if fails to make API call @@ -133,6 +136,7 @@ public OAuthTokenResponse oauthTokenRefresh(OAuthTokenRefreshRequest oauthTokenR /** * OAuth Token Refresh * Access tokens are only valid for a given period of time (typically one hour) for security reasons. Whenever acquiring an new access token its TTL is also given (see `expires_in`), along with a refresh token that can be used to acquire a new access token after the current one has expired. + * Example: https://github.com/hellosign/dropbox-sign-java/blob/main/examples/OauthTokenRefreshExample.java * @param oauthTokenRefreshRequest (required) * @return ApiResponse<OAuthTokenResponse> * @throws ApiException if fails to make API call diff --git a/sdks/java-v2/src/main/java/com/dropbox/sign/api/ReportApi.java b/sdks/java-v2/src/main/java/com/dropbox/sign/api/ReportApi.java index a9a590576..472111d66 100644 --- a/sdks/java-v2/src/main/java/com/dropbox/sign/api/ReportApi.java +++ b/sdks/java-v2/src/main/java/com/dropbox/sign/api/ReportApi.java @@ -51,6 +51,7 @@ public void setApiClient(ApiClient apiClient) { /** * Create Report * Request the creation of one or more report(s). When the report(s) have been generated, you will receive an email (one per requested report type) containing a link to download the report as a CSV file. The requested date range may be up to 12 months in duration, and `start_date` must not be more than 10 years in the past. + * Example: https://github.com/hellosign/dropbox-sign-java/blob/main/examples/ReportCreateExample.java * @param reportCreateRequest (required) * @return ReportCreateResponse * @throws ApiException if fails to make API call @@ -70,6 +71,7 @@ public ReportCreateResponse reportCreate(ReportCreateRequest reportCreateRequest /** * Create Report * Request the creation of one or more report(s). When the report(s) have been generated, you will receive an email (one per requested report type) containing a link to download the report as a CSV file. The requested date range may be up to 12 months in duration, and `start_date` must not be more than 10 years in the past. + * Example: https://github.com/hellosign/dropbox-sign-java/blob/main/examples/ReportCreateExample.java * @param reportCreateRequest (required) * @return ApiResponse<ReportCreateResponse> * @throws ApiException if fails to make API call diff --git a/sdks/java-v2/src/main/java/com/dropbox/sign/api/SignatureRequestApi.java b/sdks/java-v2/src/main/java/com/dropbox/sign/api/SignatureRequestApi.java index 88f08b45f..539a8720c 100644 --- a/sdks/java-v2/src/main/java/com/dropbox/sign/api/SignatureRequestApi.java +++ b/sdks/java-v2/src/main/java/com/dropbox/sign/api/SignatureRequestApi.java @@ -67,6 +67,7 @@ public void setApiClient(ApiClient apiClient) { /** * Embedded Bulk Send with Template * Creates BulkSendJob which sends up to 250 SignatureRequests in bulk based off of the provided Template(s) specified with the `template_ids` parameter to be signed in an embedded iFrame. These embedded signature requests can only be signed in embedded iFrames whereas normal signature requests can only be signed on Dropbox Sign. **NOTE:** Only available for Standard plan and higher. + * Example: https://github.com/hellosign/dropbox-sign-java/blob/main/examples/SignatureRequestBulkCreateEmbeddedWithTemplateExample.java * @param signatureRequestBulkCreateEmbeddedWithTemplateRequest (required) * @return BulkSendJobSendResponse * @throws ApiException if fails to make API call @@ -86,6 +87,7 @@ public BulkSendJobSendResponse signatureRequestBulkCreateEmbeddedWithTemplate(Si /** * Embedded Bulk Send with Template * Creates BulkSendJob which sends up to 250 SignatureRequests in bulk based off of the provided Template(s) specified with the `template_ids` parameter to be signed in an embedded iFrame. These embedded signature requests can only be signed in embedded iFrames whereas normal signature requests can only be signed on Dropbox Sign. **NOTE:** Only available for Standard plan and higher. + * Example: https://github.com/hellosign/dropbox-sign-java/blob/main/examples/SignatureRequestBulkCreateEmbeddedWithTemplateExample.java * @param signatureRequestBulkCreateEmbeddedWithTemplateRequest (required) * @return ApiResponse<BulkSendJobSendResponse> * @throws ApiException if fails to make API call @@ -130,6 +132,7 @@ public ApiResponse signatureRequestBulkCreateEmbeddedWi /** * Bulk Send with Template * Creates BulkSendJob which sends up to 250 SignatureRequests in bulk based off of the provided Template(s) specified with the `template_ids` parameter. **NOTE:** Only available for Standard plan and higher. + * Example: https://github.com/hellosign/dropbox-sign-java/blob/main/examples/SignatureRequestBulkSendWithTemplateExample.java * @param signatureRequestBulkSendWithTemplateRequest (required) * @return BulkSendJobSendResponse * @throws ApiException if fails to make API call @@ -149,6 +152,7 @@ public BulkSendJobSendResponse signatureRequestBulkSendWithTemplate(SignatureReq /** * Bulk Send with Template * Creates BulkSendJob which sends up to 250 SignatureRequests in bulk based off of the provided Template(s) specified with the `template_ids` parameter. **NOTE:** Only available for Standard plan and higher. + * Example: https://github.com/hellosign/dropbox-sign-java/blob/main/examples/SignatureRequestBulkSendWithTemplateExample.java * @param signatureRequestBulkSendWithTemplateRequest (required) * @return ApiResponse<BulkSendJobSendResponse> * @throws ApiException if fails to make API call @@ -193,6 +197,7 @@ public ApiResponse signatureRequestBulkSendWithTemplate /** * Cancel Incomplete Signature Request * Cancels an incomplete signature request. This action is **not reversible**. The request will be canceled and signers will no longer be able to sign. If they try to access the signature request they will receive a HTTP 410 status code indicating that the resource has been deleted. Cancelation is asynchronous and a successful call to this endpoint will return an empty 200 OK response if the signature request is eligible to be canceled and has been successfully queued. This 200 OK response does not indicate a successful cancelation of the signature request itself. The cancelation is confirmed via the `signature_request_canceled` event. It is recommended that a [callback handler](/api/reference/tag/Callbacks-and-Events) be implemented to listen for the `signature_request_canceled` event. This callback will be sent only when the cancelation has completed successfully. If a callback handler has been configured and the event has not been received within 60 minutes of making the call, check the status of the request in the [API Dashboard](https://app.hellosign.com/apidashboard) and retry the cancelation if necessary. To be eligible for cancelation, a signature request must have been sent successfully, must not yet have been signed by all signers, and you must either be the sender or own the API app under which it was sent. A partially signed signature request can be canceled. **NOTE:** To remove your access to a completed signature request, use the endpoint: `POST /signature_request/remove/[:signature_request_id]`. + * Example: https://github.com/hellosign/dropbox-sign-java/blob/main/examples/SignatureRequestCancelExample.java * @param signatureRequestId The id of the incomplete SignatureRequest to cancel. (required) * @throws ApiException if fails to make API call * @http.response.details @@ -211,6 +216,7 @@ public void signatureRequestCancel(String signatureRequestId) throws ApiExceptio /** * Cancel Incomplete Signature Request * Cancels an incomplete signature request. This action is **not reversible**. The request will be canceled and signers will no longer be able to sign. If they try to access the signature request they will receive a HTTP 410 status code indicating that the resource has been deleted. Cancelation is asynchronous and a successful call to this endpoint will return an empty 200 OK response if the signature request is eligible to be canceled and has been successfully queued. This 200 OK response does not indicate a successful cancelation of the signature request itself. The cancelation is confirmed via the `signature_request_canceled` event. It is recommended that a [callback handler](/api/reference/tag/Callbacks-and-Events) be implemented to listen for the `signature_request_canceled` event. This callback will be sent only when the cancelation has completed successfully. If a callback handler has been configured and the event has not been received within 60 minutes of making the call, check the status of the request in the [API Dashboard](https://app.hellosign.com/apidashboard) and retry the cancelation if necessary. To be eligible for cancelation, a signature request must have been sent successfully, must not yet have been signed by all signers, and you must either be the sender or own the API app under which it was sent. A partially signed signature request can be canceled. **NOTE:** To remove your access to a completed signature request, use the endpoint: `POST /signature_request/remove/[:signature_request_id]`. + * Example: https://github.com/hellosign/dropbox-sign-java/blob/main/examples/SignatureRequestCancelExample.java * @param signatureRequestId The id of the incomplete SignatureRequest to cancel. (required) * @return ApiResponse<Void> * @throws ApiException if fails to make API call @@ -258,6 +264,7 @@ public ApiResponse signatureRequestCancelWithHttpInfo(String signatureRequ /** * Create Embedded Signature Request * Creates a new SignatureRequest with the submitted documents to be signed in an embedded iFrame. If form_fields_per_document is not specified, a signature page will be affixed where all signers will be required to add their signature, signifying their agreement to all contained documents. Note that embedded signature requests can only be signed in embedded iFrames whereas normal signature requests can only be signed on Dropbox Sign. + * Example: https://github.com/hellosign/dropbox-sign-java/blob/main/examples/SignatureRequestCreateEmbeddedExample.java * @param signatureRequestCreateEmbeddedRequest (required) * @return SignatureRequestGetResponse * @throws ApiException if fails to make API call @@ -277,6 +284,7 @@ public SignatureRequestGetResponse signatureRequestCreateEmbedded(SignatureReque /** * Create Embedded Signature Request * Creates a new SignatureRequest with the submitted documents to be signed in an embedded iFrame. If form_fields_per_document is not specified, a signature page will be affixed where all signers will be required to add their signature, signifying their agreement to all contained documents. Note that embedded signature requests can only be signed in embedded iFrames whereas normal signature requests can only be signed on Dropbox Sign. + * Example: https://github.com/hellosign/dropbox-sign-java/blob/main/examples/SignatureRequestCreateEmbeddedExample.java * @param signatureRequestCreateEmbeddedRequest (required) * @return ApiResponse<SignatureRequestGetResponse> * @throws ApiException if fails to make API call @@ -321,6 +329,7 @@ public ApiResponse signatureRequestCreateEmbeddedWi /** * Create Embedded Signature Request with Template * Creates a new SignatureRequest based on the given Template(s) to be signed in an embedded iFrame. Note that embedded signature requests can only be signed in embedded iFrames whereas normal signature requests can only be signed on Dropbox Sign. + * Example: https://github.com/hellosign/dropbox-sign-java/blob/main/examples/SignatureRequestCreateEmbeddedWithTemplateExample.java * @param signatureRequestCreateEmbeddedWithTemplateRequest (required) * @return SignatureRequestGetResponse * @throws ApiException if fails to make API call @@ -340,6 +349,7 @@ public SignatureRequestGetResponse signatureRequestCreateEmbeddedWithTemplate(Si /** * Create Embedded Signature Request with Template * Creates a new SignatureRequest based on the given Template(s) to be signed in an embedded iFrame. Note that embedded signature requests can only be signed in embedded iFrames whereas normal signature requests can only be signed on Dropbox Sign. + * Example: https://github.com/hellosign/dropbox-sign-java/blob/main/examples/SignatureRequestCreateEmbeddedWithTemplateExample.java * @param signatureRequestCreateEmbeddedWithTemplateRequest (required) * @return ApiResponse<SignatureRequestGetResponse> * @throws ApiException if fails to make API call @@ -384,6 +394,7 @@ public ApiResponse signatureRequestCreateEmbeddedWi /** * Edit Signature Request * Edits and sends a SignatureRequest with the submitted documents. If `form_fields_per_document` is not specified, a signature page will be affixed where all signers will be required to add their signature, signifying their agreement to all contained documents. **NOTE:** Edit and resend *will* deduct your signature request quota. + * Example: https://github.com/hellosign/dropbox-sign-java/blob/main/examples/SignatureRequestEditExample.java * @param signatureRequestId The id of the SignatureRequest to edit. (required) * @param signatureRequestEditRequest (required) * @return SignatureRequestGetResponse @@ -404,6 +415,7 @@ public SignatureRequestGetResponse signatureRequestEdit(String signatureRequestI /** * Edit Signature Request * Edits and sends a SignatureRequest with the submitted documents. If `form_fields_per_document` is not specified, a signature page will be affixed where all signers will be required to add their signature, signifying their agreement to all contained documents. **NOTE:** Edit and resend *will* deduct your signature request quota. + * Example: https://github.com/hellosign/dropbox-sign-java/blob/main/examples/SignatureRequestEditExample.java * @param signatureRequestId The id of the SignatureRequest to edit. (required) * @param signatureRequestEditRequest (required) * @return ApiResponse<SignatureRequestGetResponse> @@ -456,6 +468,7 @@ public ApiResponse signatureRequestEditWithHttpInfo /** * Edit Embedded Signature Request * Edits a SignatureRequest with the submitted documents to be signed in an embedded iFrame. If form_fields_per_document is not specified, a signature page will be affixed where all signers will be required to add their signature, signifying their agreement to all contained documents. Note that embedded signature requests can only be signed in embedded iFrames whereas normal signature requests can only be signed on Dropbox Sign. **NOTE:** Edit and resend *will* deduct your signature request quota. + * Example: https://github.com/hellosign/dropbox-sign-java/blob/main/examples/SignatureRequestEditEmbeddedExample.java * @param signatureRequestId The id of the SignatureRequest to edit. (required) * @param signatureRequestEditEmbeddedRequest (required) * @return SignatureRequestGetResponse @@ -476,6 +489,7 @@ public SignatureRequestGetResponse signatureRequestEditEmbedded(String signature /** * Edit Embedded Signature Request * Edits a SignatureRequest with the submitted documents to be signed in an embedded iFrame. If form_fields_per_document is not specified, a signature page will be affixed where all signers will be required to add their signature, signifying their agreement to all contained documents. Note that embedded signature requests can only be signed in embedded iFrames whereas normal signature requests can only be signed on Dropbox Sign. **NOTE:** Edit and resend *will* deduct your signature request quota. + * Example: https://github.com/hellosign/dropbox-sign-java/blob/main/examples/SignatureRequestEditEmbeddedExample.java * @param signatureRequestId The id of the SignatureRequest to edit. (required) * @param signatureRequestEditEmbeddedRequest (required) * @return ApiResponse<SignatureRequestGetResponse> @@ -528,6 +542,7 @@ public ApiResponse signatureRequestEditEmbeddedWith /** * Edit Embedded Signature Request with Template * Edits a SignatureRequest based on the given Template(s) to be signed in an embedded iFrame. Note that embedded signature requests can only be signed in embedded iFrames whereas normal signature requests can only be signed on Dropbox Sign. **NOTE:** Edit and resend *will* deduct your signature request quota. + * Example: https://github.com/hellosign/dropbox-sign-java/blob/main/examples/SignatureRequestEditEmbeddedWithTemplateExample.java * @param signatureRequestId The id of the SignatureRequest to edit. (required) * @param signatureRequestEditEmbeddedWithTemplateRequest (required) * @return SignatureRequestGetResponse @@ -548,6 +563,7 @@ public SignatureRequestGetResponse signatureRequestEditEmbeddedWithTemplate(Stri /** * Edit Embedded Signature Request with Template * Edits a SignatureRequest based on the given Template(s) to be signed in an embedded iFrame. Note that embedded signature requests can only be signed in embedded iFrames whereas normal signature requests can only be signed on Dropbox Sign. **NOTE:** Edit and resend *will* deduct your signature request quota. + * Example: https://github.com/hellosign/dropbox-sign-java/blob/main/examples/SignatureRequestEditEmbeddedWithTemplateExample.java * @param signatureRequestId The id of the SignatureRequest to edit. (required) * @param signatureRequestEditEmbeddedWithTemplateRequest (required) * @return ApiResponse<SignatureRequestGetResponse> @@ -600,6 +616,7 @@ public ApiResponse signatureRequestEditEmbeddedWith /** * Edit Signature Request With Template * Edits and sends a SignatureRequest based off of the Template(s) specified with the template_ids parameter. **NOTE:** Edit and resend *will* deduct your signature request quota. + * Example: https://github.com/hellosign/dropbox-sign-java/blob/main/examples/SignatureRequestEditWithTemplateExample.java * @param signatureRequestId The id of the SignatureRequest to edit. (required) * @param signatureRequestEditWithTemplateRequest (required) * @return SignatureRequestGetResponse @@ -620,6 +637,7 @@ public SignatureRequestGetResponse signatureRequestEditWithTemplate(String signa /** * Edit Signature Request With Template * Edits and sends a SignatureRequest based off of the Template(s) specified with the template_ids parameter. **NOTE:** Edit and resend *will* deduct your signature request quota. + * Example: https://github.com/hellosign/dropbox-sign-java/blob/main/examples/SignatureRequestEditWithTemplateExample.java * @param signatureRequestId The id of the SignatureRequest to edit. (required) * @param signatureRequestEditWithTemplateRequest (required) * @return ApiResponse<SignatureRequestGetResponse> @@ -672,6 +690,7 @@ public ApiResponse signatureRequestEditWithTemplate /** * Download Files * Obtain a copy of the current documents specified by the `signature_request_id` parameter. Returns a PDF or ZIP file. If the files are currently being prepared, a status code of `409` will be returned instead. + * Example: https://github.com/hellosign/dropbox-sign-java/blob/main/examples/SignatureRequestFilesExample.java * @param signatureRequestId The id of the SignatureRequest to retrieve. (required) * @param fileType Set to `pdf` for a single merged document or `zip` for a collection of individual documents. (optional, default to pdf) * @return File @@ -711,6 +730,7 @@ public ApiResponse signatureRequestFilesWithHttpInfo(String signatureReque /** * Download Files * Obtain a copy of the current documents specified by the `signature_request_id` parameter. Returns a PDF or ZIP file. If the files are currently being prepared, a status code of `409` will be returned instead. + * Example: https://github.com/hellosign/dropbox-sign-java/blob/main/examples/SignatureRequestFilesExample.java * @param signatureRequestId The id of the SignatureRequest to retrieve. (required) * @param fileType Set to `pdf` for a single merged document or `zip` for a collection of individual documents. (optional, default to pdf) * @return ApiResponse<File> @@ -768,6 +788,7 @@ public ApiResponse signatureRequestFilesWithHttpInfo(String signatureReque /** * Download Files as Data Uri * Obtain a copy of the current documents specified by the `signature_request_id` parameter. Returns a JSON object with a `data_uri` representing the base64 encoded file (PDFs only). If the files are currently being prepared, a status code of `409` will be returned instead. + * Example: https://github.com/hellosign/dropbox-sign-java/blob/main/examples/SignatureRequestFilesAsDataUriExample.java * @param signatureRequestId The id of the SignatureRequest to retrieve. (required) * @return FileResponseDataUri * @throws ApiException if fails to make API call @@ -787,6 +808,7 @@ public FileResponseDataUri signatureRequestFilesAsDataUri(String signatureReques /** * Download Files as Data Uri * Obtain a copy of the current documents specified by the `signature_request_id` parameter. Returns a JSON object with a `data_uri` representing the base64 encoded file (PDFs only). If the files are currently being prepared, a status code of `409` will be returned instead. + * Example: https://github.com/hellosign/dropbox-sign-java/blob/main/examples/SignatureRequestFilesAsDataUriExample.java * @param signatureRequestId The id of the SignatureRequest to retrieve. (required) * @return ApiResponse<FileResponseDataUri> * @throws ApiException if fails to make API call @@ -835,6 +857,7 @@ public ApiResponse signatureRequestFilesAsDataUriWithHttpIn /** * Download Files as File Url * Obtain a copy of the current documents specified by the `signature_request_id` parameter. Returns a JSON object with a url to the file (PDFs only). If the files are currently being prepared, a status code of `409` will be returned instead. + * Example: https://github.com/hellosign/dropbox-sign-java/blob/main/examples/SignatureRequestFilesAsFileUrlExample.java * @param signatureRequestId The id of the SignatureRequest to retrieve. (required) * @param forceDownload By default when opening the `file_url` a browser will download the PDF and save it locally. When set to `0` the PDF file will be displayed in the browser. (optional, default to 1) * @return FileResponse @@ -874,6 +897,7 @@ public ApiResponse signatureRequestFilesAsFileUrlWithHttpInfo(Stri /** * Download Files as File Url * Obtain a copy of the current documents specified by the `signature_request_id` parameter. Returns a JSON object with a url to the file (PDFs only). If the files are currently being prepared, a status code of `409` will be returned instead. + * Example: https://github.com/hellosign/dropbox-sign-java/blob/main/examples/SignatureRequestFilesAsFileUrlExample.java * @param signatureRequestId The id of the SignatureRequest to retrieve. (required) * @param forceDownload By default when opening the `file_url` a browser will download the PDF and save it locally. When set to `0` the PDF file will be displayed in the browser. (optional, default to 1) * @return ApiResponse<FileResponse> @@ -931,6 +955,7 @@ public ApiResponse signatureRequestFilesAsFileUrlWithHttpInfo(Stri /** * Get Signature Request * Returns the status of the SignatureRequest specified by the `signature_request_id` parameter. + * Example: https://github.com/hellosign/dropbox-sign-java/blob/main/examples/SignatureRequestGetExample.java * @param signatureRequestId The id of the SignatureRequest to retrieve. (required) * @return SignatureRequestGetResponse * @throws ApiException if fails to make API call @@ -950,6 +975,7 @@ public SignatureRequestGetResponse signatureRequestGet(String signatureRequestId /** * Get Signature Request * Returns the status of the SignatureRequest specified by the `signature_request_id` parameter. + * Example: https://github.com/hellosign/dropbox-sign-java/blob/main/examples/SignatureRequestGetExample.java * @param signatureRequestId The id of the SignatureRequest to retrieve. (required) * @return ApiResponse<SignatureRequestGetResponse> * @throws ApiException if fails to make API call @@ -998,6 +1024,7 @@ public ApiResponse signatureRequestGetWithHttpInfo( /** * List Signature Requests * Returns a list of SignatureRequests that you can access. This includes SignatureRequests you have sent as well as received, but not ones that you have been CCed on. Take a look at our [search guide](/api/reference/search/) to learn more about querying signature requests. + * Example: https://github.com/hellosign/dropbox-sign-java/blob/main/examples/SignatureRequestListExample.java * @param accountId Which account to return SignatureRequests for. Must be a team member. Use `all` to indicate all team members. Defaults to your account. (optional) * @param page Which page number of the SignatureRequest List to return. Defaults to `1`. (optional, default to 1) * @param pageSize Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. (optional, default to 20) @@ -1105,6 +1132,7 @@ public ApiResponse signatureRequestListWithHttpInf /** * List Signature Requests * Returns a list of SignatureRequests that you can access. This includes SignatureRequests you have sent as well as received, but not ones that you have been CCed on. Take a look at our [search guide](/api/reference/search/) to learn more about querying signature requests. + * Example: https://github.com/hellosign/dropbox-sign-java/blob/main/examples/SignatureRequestListExample.java * @param accountId Which account to return SignatureRequests for. Must be a team member. Use `all` to indicate all team members. Defaults to your account. (optional) * @param page Which page number of the SignatureRequest List to return. Defaults to `1`. (optional, default to 1) * @param pageSize Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. (optional, default to 20) @@ -1161,6 +1189,7 @@ public ApiResponse signatureRequestListWithHttpInf /** * Release On-Hold Signature Request * Releases a held SignatureRequest that was claimed and prepared from an [UnclaimedDraft](/api/reference/tag/Unclaimed-Draft). The owner of the Draft must indicate at Draft creation that the SignatureRequest created from the Draft should be held. Releasing the SignatureRequest will send requests to all signers. + * Example: https://github.com/hellosign/dropbox-sign-java/blob/main/examples/SignatureRequestReleaseHoldExample.java * @param signatureRequestId The id of the SignatureRequest to release. (required) * @return SignatureRequestGetResponse * @throws ApiException if fails to make API call @@ -1180,6 +1209,7 @@ public SignatureRequestGetResponse signatureRequestReleaseHold(String signatureR /** * Release On-Hold Signature Request * Releases a held SignatureRequest that was claimed and prepared from an [UnclaimedDraft](/api/reference/tag/Unclaimed-Draft). The owner of the Draft must indicate at Draft creation that the SignatureRequest created from the Draft should be held. Releasing the SignatureRequest will send requests to all signers. + * Example: https://github.com/hellosign/dropbox-sign-java/blob/main/examples/SignatureRequestReleaseHoldExample.java * @param signatureRequestId The id of the SignatureRequest to release. (required) * @return ApiResponse<SignatureRequestGetResponse> * @throws ApiException if fails to make API call @@ -1228,6 +1258,7 @@ public ApiResponse signatureRequestReleaseHoldWithH /** * Send Request Reminder * Sends an email to the signer reminding them to sign the signature request. You cannot send a reminder within 1 hour of the last reminder that was sent. This includes manual AND automatic reminders. **NOTE:** This action can **not** be used with embedded signature requests. + * Example: https://github.com/hellosign/dropbox-sign-java/blob/main/examples/SignatureRequestRemindExample.java * @param signatureRequestId The id of the SignatureRequest to send a reminder for. (required) * @param signatureRequestRemindRequest (required) * @return SignatureRequestGetResponse @@ -1248,6 +1279,7 @@ public SignatureRequestGetResponse signatureRequestRemind(String signatureReques /** * Send Request Reminder * Sends an email to the signer reminding them to sign the signature request. You cannot send a reminder within 1 hour of the last reminder that was sent. This includes manual AND automatic reminders. **NOTE:** This action can **not** be used with embedded signature requests. + * Example: https://github.com/hellosign/dropbox-sign-java/blob/main/examples/SignatureRequestRemindExample.java * @param signatureRequestId The id of the SignatureRequest to send a reminder for. (required) * @param signatureRequestRemindRequest (required) * @return ApiResponse<SignatureRequestGetResponse> @@ -1300,6 +1332,7 @@ public ApiResponse signatureRequestRemindWithHttpIn /** * Remove Signature Request Access * Removes your access to a completed signature request. This action is **not reversible**. The signature request must be fully executed by all parties (signed or declined to sign). Other parties will continue to maintain access to the completed signature request document(s). Unlike /signature_request/cancel, this endpoint is synchronous and your access will be immediately removed. Upon successful removal, this endpoint will return a 200 OK response. + * Example: https://github.com/hellosign/dropbox-sign-java/blob/main/examples/SignatureRequestRemoveExample.java * @param signatureRequestId The id of the SignatureRequest to remove. (required) * @throws ApiException if fails to make API call * @http.response.details @@ -1318,6 +1351,7 @@ public void signatureRequestRemove(String signatureRequestId) throws ApiExceptio /** * Remove Signature Request Access * Removes your access to a completed signature request. This action is **not reversible**. The signature request must be fully executed by all parties (signed or declined to sign). Other parties will continue to maintain access to the completed signature request document(s). Unlike /signature_request/cancel, this endpoint is synchronous and your access will be immediately removed. Upon successful removal, this endpoint will return a 200 OK response. + * Example: https://github.com/hellosign/dropbox-sign-java/blob/main/examples/SignatureRequestRemoveExample.java * @param signatureRequestId The id of the SignatureRequest to remove. (required) * @return ApiResponse<Void> * @throws ApiException if fails to make API call @@ -1365,6 +1399,7 @@ public ApiResponse signatureRequestRemoveWithHttpInfo(String signatureRequ /** * Send Signature Request * Creates and sends a new SignatureRequest with the submitted documents. If `form_fields_per_document` is not specified, a signature page will be affixed where all signers will be required to add their signature, signifying their agreement to all contained documents. + * Example: https://github.com/hellosign/dropbox-sign-java/blob/main/examples/SignatureRequestSendExample.java * @param signatureRequestSendRequest (required) * @return SignatureRequestGetResponse * @throws ApiException if fails to make API call @@ -1384,6 +1419,7 @@ public SignatureRequestGetResponse signatureRequestSend(SignatureRequestSendRequ /** * Send Signature Request * Creates and sends a new SignatureRequest with the submitted documents. If `form_fields_per_document` is not specified, a signature page will be affixed where all signers will be required to add their signature, signifying their agreement to all contained documents. + * Example: https://github.com/hellosign/dropbox-sign-java/blob/main/examples/SignatureRequestSendExample.java * @param signatureRequestSendRequest (required) * @return ApiResponse<SignatureRequestGetResponse> * @throws ApiException if fails to make API call @@ -1428,6 +1464,7 @@ public ApiResponse signatureRequestSendWithHttpInfo /** * Send with Template * Creates and sends a new SignatureRequest based off of the Template(s) specified with the `template_ids` parameter. + * Example: https://github.com/hellosign/dropbox-sign-java/blob/main/examples/SignatureRequestSendWithTemplateExample.java * @param signatureRequestSendWithTemplateRequest (required) * @return SignatureRequestGetResponse * @throws ApiException if fails to make API call @@ -1447,6 +1484,7 @@ public SignatureRequestGetResponse signatureRequestSendWithTemplate(SignatureReq /** * Send with Template * Creates and sends a new SignatureRequest based off of the Template(s) specified with the `template_ids` parameter. + * Example: https://github.com/hellosign/dropbox-sign-java/blob/main/examples/SignatureRequestSendWithTemplateExample.java * @param signatureRequestSendWithTemplateRequest (required) * @return ApiResponse<SignatureRequestGetResponse> * @throws ApiException if fails to make API call @@ -1491,6 +1529,7 @@ public ApiResponse signatureRequestSendWithTemplate /** * Update Signature Request * Updates the email address and/or the name for a given signer on a signature request. You can listen for the `signature_request_email_bounce` event on your app or account to detect bounced emails, and respond with this method. Updating the email address of a signer will generate a new `signature_id` value. **NOTE:** This action cannot be performed on a signature request with an appended signature page. + * Example: https://github.com/hellosign/dropbox-sign-java/blob/main/examples/SignatureRequestUpdateExample.java * @param signatureRequestId The id of the SignatureRequest to update. (required) * @param signatureRequestUpdateRequest (required) * @return SignatureRequestGetResponse @@ -1511,6 +1550,7 @@ public SignatureRequestGetResponse signatureRequestUpdate(String signatureReques /** * Update Signature Request * Updates the email address and/or the name for a given signer on a signature request. You can listen for the `signature_request_email_bounce` event on your app or account to detect bounced emails, and respond with this method. Updating the email address of a signer will generate a new `signature_id` value. **NOTE:** This action cannot be performed on a signature request with an appended signature page. + * Example: https://github.com/hellosign/dropbox-sign-java/blob/main/examples/SignatureRequestUpdateExample.java * @param signatureRequestId The id of the SignatureRequest to update. (required) * @param signatureRequestUpdateRequest (required) * @return ApiResponse<SignatureRequestGetResponse> diff --git a/sdks/java-v2/src/main/java/com/dropbox/sign/api/TeamApi.java b/sdks/java-v2/src/main/java/com/dropbox/sign/api/TeamApi.java index ac28133ff..a2d67bc45 100644 --- a/sdks/java-v2/src/main/java/com/dropbox/sign/api/TeamApi.java +++ b/sdks/java-v2/src/main/java/com/dropbox/sign/api/TeamApi.java @@ -58,6 +58,7 @@ public void setApiClient(ApiClient apiClient) { /** * Add User to Team * Invites a user (specified using the `email_address` parameter) to your Team. If the user does not currently have a Dropbox Sign Account, a new one will be created for them. If a user is already a part of another Team, a `team_invite_failed` error will be returned. + * Example: https://github.com/hellosign/dropbox-sign-java/blob/main/examples/TeamAddMemberExample.java * @param teamAddMemberRequest (required) * @param teamId The id of the team. (optional) * @return TeamGetResponse @@ -97,6 +98,7 @@ public ApiResponse teamAddMemberWithHttpInfo(TeamAddMemberReque /** * Add User to Team * Invites a user (specified using the `email_address` parameter) to your Team. If the user does not currently have a Dropbox Sign Account, a new one will be created for them. If a user is already a part of another Team, a `team_invite_failed` error will be returned. + * Example: https://github.com/hellosign/dropbox-sign-java/blob/main/examples/TeamAddMemberExample.java * @param teamAddMemberRequest (required) * @param teamId The id of the team. (optional) * @return ApiResponse<TeamGetResponse> @@ -147,6 +149,7 @@ public ApiResponse teamAddMemberWithHttpInfo(TeamAddMemberReque /** * Create Team * Creates a new Team and makes you a member. You must not currently belong to a Team to invoke. + * Example: https://github.com/hellosign/dropbox-sign-java/blob/main/examples/TeamCreateExample.java * @param teamCreateRequest (required) * @return TeamGetResponse * @throws ApiException if fails to make API call @@ -166,6 +169,7 @@ public TeamGetResponse teamCreate(TeamCreateRequest teamCreateRequest) throws Ap /** * Create Team * Creates a new Team and makes you a member. You must not currently belong to a Team to invoke. + * Example: https://github.com/hellosign/dropbox-sign-java/blob/main/examples/TeamCreateExample.java * @param teamCreateRequest (required) * @return ApiResponse<TeamGetResponse> * @throws ApiException if fails to make API call @@ -210,6 +214,7 @@ public ApiResponse teamCreateWithHttpInfo(TeamCreateRequest tea /** * Delete Team * Deletes your Team. Can only be invoked when you have a Team with only one member (yourself). + * Example: https://github.com/hellosign/dropbox-sign-java/blob/main/examples/TeamDeleteExample.java * @throws ApiException if fails to make API call * @http.response.details @@ -227,6 +232,7 @@ public void teamDelete() throws ApiException { /** * Delete Team * Deletes your Team. Can only be invoked when you have a Team with only one member (yourself). + * Example: https://github.com/hellosign/dropbox-sign-java/blob/main/examples/TeamDeleteExample.java * @return ApiResponse<Void> * @throws ApiException if fails to make API call * @http.response.details @@ -264,6 +270,7 @@ public ApiResponse teamDeleteWithHttpInfo() throws ApiException { /** * Get Team * Returns information about your Team as well as a list of its members. If you do not belong to a Team, a 404 error with an error_name of \"not_found\" will be returned. + * Example: https://github.com/hellosign/dropbox-sign-java/blob/main/examples/TeamGetExample.java * @return TeamGetResponse * @throws ApiException if fails to make API call * @http.response.details @@ -282,6 +289,7 @@ public TeamGetResponse teamGet() throws ApiException { /** * Get Team * Returns information about your Team as well as a list of its members. If you do not belong to a Team, a 404 error with an error_name of \"not_found\" will be returned. + * Example: https://github.com/hellosign/dropbox-sign-java/blob/main/examples/TeamGetExample.java * @return ApiResponse<TeamGetResponse> * @throws ApiException if fails to make API call * @http.response.details @@ -320,6 +328,7 @@ public ApiResponse teamGetWithHttpInfo() throws ApiException { /** * Get Team Info * Provides information about a team. + * Example: https://github.com/hellosign/dropbox-sign-java/blob/main/examples/TeamInfoExample.java * @param teamId The id of the team. (optional) * @return TeamGetInfoResponse * @throws ApiException if fails to make API call @@ -358,6 +367,7 @@ public ApiResponse teamInfoWithHttpInfo() throws ApiExcepti /** * Get Team Info * Provides information about a team. + * Example: https://github.com/hellosign/dropbox-sign-java/blob/main/examples/TeamInfoExample.java * @param teamId The id of the team. (optional) * @return ApiResponse<TeamGetInfoResponse> * @throws ApiException if fails to make API call @@ -402,6 +412,7 @@ public ApiResponse teamInfoWithHttpInfo(String teamId) thro /** * List Team Invites * Provides a list of team invites (and their roles). + * Example: https://github.com/hellosign/dropbox-sign-java/blob/main/examples/TeamInvitesExample.java * @param emailAddress The email address for which to display the team invites. (optional) * @return TeamInvitesResponse * @throws ApiException if fails to make API call @@ -440,6 +451,7 @@ public ApiResponse teamInvitesWithHttpInfo() throws ApiExce /** * List Team Invites * Provides a list of team invites (and their roles). + * Example: https://github.com/hellosign/dropbox-sign-java/blob/main/examples/TeamInvitesExample.java * @param emailAddress The email address for which to display the team invites. (optional) * @return ApiResponse<TeamInvitesResponse> * @throws ApiException if fails to make API call @@ -484,6 +496,7 @@ public ApiResponse teamInvitesWithHttpInfo(String emailAddr /** * List Team Members * Provides a paginated list of members (and their roles) that belong to a given team. + * Example: https://github.com/hellosign/dropbox-sign-java/blob/main/examples/TeamMembersExample.java * @param teamId The id of the team that a member list is being requested from. (required) * @param page Which page number of the team member list to return. Defaults to `1`. (optional, default to 1) * @param pageSize Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. (optional, default to 20) @@ -544,6 +557,7 @@ public ApiResponse teamMembersWithHttpInfo(String teamId, I /** * List Team Members * Provides a paginated list of members (and their roles) that belong to a given team. + * Example: https://github.com/hellosign/dropbox-sign-java/blob/main/examples/TeamMembersExample.java * @param teamId The id of the team that a member list is being requested from. (required) * @param page Which page number of the team member list to return. Defaults to `1`. (optional, default to 1) * @param pageSize Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. (optional, default to 20) @@ -606,6 +620,7 @@ public ApiResponse teamMembersWithHttpInfo(String teamId, I /** * Remove User from Team * Removes the provided user Account from your Team. If the Account had an outstanding invitation to your Team, the invitation will be expired. If you choose to transfer documents from the removed Account to an Account provided in the `new_owner_email_address` parameter (available only for Enterprise plans), the response status code will be 201, which indicates that your request has been queued but not fully executed. + * Example: https://github.com/hellosign/dropbox-sign-java/blob/main/examples/TeamRemoveMemberExample.java * @param teamRemoveMemberRequest (required) * @return TeamGetResponse * @throws ApiException if fails to make API call @@ -625,6 +640,7 @@ public TeamGetResponse teamRemoveMember(TeamRemoveMemberRequest teamRemoveMember /** * Remove User from Team * Removes the provided user Account from your Team. If the Account had an outstanding invitation to your Team, the invitation will be expired. If you choose to transfer documents from the removed Account to an Account provided in the `new_owner_email_address` parameter (available only for Enterprise plans), the response status code will be 201, which indicates that your request has been queued but not fully executed. + * Example: https://github.com/hellosign/dropbox-sign-java/blob/main/examples/TeamRemoveMemberExample.java * @param teamRemoveMemberRequest (required) * @return ApiResponse<TeamGetResponse> * @throws ApiException if fails to make API call @@ -669,6 +685,7 @@ public ApiResponse teamRemoveMemberWithHttpInfo(TeamRemoveMembe /** * List Sub Teams * Provides a paginated list of sub teams that belong to a given team. + * Example: https://github.com/hellosign/dropbox-sign-java/blob/main/examples/TeamSubTeamsExample.java * @param teamId The id of the parent Team. (required) * @param page Which page number of the SubTeam List to return. Defaults to `1`. (optional, default to 1) * @param pageSize Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. (optional, default to 20) @@ -729,6 +746,7 @@ public ApiResponse teamSubTeamsWithHttpInfo(String teamId, /** * List Sub Teams * Provides a paginated list of sub teams that belong to a given team. + * Example: https://github.com/hellosign/dropbox-sign-java/blob/main/examples/TeamSubTeamsExample.java * @param teamId The id of the parent Team. (required) * @param page Which page number of the SubTeam List to return. Defaults to `1`. (optional, default to 1) * @param pageSize Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. (optional, default to 20) @@ -791,6 +809,7 @@ public ApiResponse teamSubTeamsWithHttpInfo(String teamId, /** * Update Team * Updates the name of your Team. + * Example: https://github.com/hellosign/dropbox-sign-java/blob/main/examples/TeamUpdateExample.java * @param teamUpdateRequest (required) * @return TeamGetResponse * @throws ApiException if fails to make API call @@ -810,6 +829,7 @@ public TeamGetResponse teamUpdate(TeamUpdateRequest teamUpdateRequest) throws Ap /** * Update Team * Updates the name of your Team. + * Example: https://github.com/hellosign/dropbox-sign-java/blob/main/examples/TeamUpdateExample.java * @param teamUpdateRequest (required) * @return ApiResponse<TeamGetResponse> * @throws ApiException if fails to make API call diff --git a/sdks/java-v2/src/main/java/com/dropbox/sign/api/TemplateApi.java b/sdks/java-v2/src/main/java/com/dropbox/sign/api/TemplateApi.java index f6f6d255b..b26de1c3a 100644 --- a/sdks/java-v2/src/main/java/com/dropbox/sign/api/TemplateApi.java +++ b/sdks/java-v2/src/main/java/com/dropbox/sign/api/TemplateApi.java @@ -62,6 +62,7 @@ public void setApiClient(ApiClient apiClient) { /** * Add User to Template * Gives the specified Account access to the specified Template. The specified Account must be a part of your Team. + * Example: https://github.com/hellosign/dropbox-sign-java/blob/main/examples/TemplateAddUserExample.java * @param templateId The id of the Template to give the Account access to. (required) * @param templateAddUserRequest (required) * @return TemplateGetResponse @@ -82,6 +83,7 @@ public TemplateGetResponse templateAddUser(String templateId, TemplateAddUserReq /** * Add User to Template * Gives the specified Account access to the specified Template. The specified Account must be a part of your Team. + * Example: https://github.com/hellosign/dropbox-sign-java/blob/main/examples/TemplateAddUserExample.java * @param templateId The id of the Template to give the Account access to. (required) * @param templateAddUserRequest (required) * @return ApiResponse<TemplateGetResponse> @@ -134,6 +136,7 @@ public ApiResponse templateAddUserWithHttpInfo(String templ /** * Create Template * Creates a template that can be used in future signature requests. If `client_id` is provided, the template will be created as an embedded template. Embedded templates can be used for embedded signature requests and can be edited later by generating a new `edit_url` with [/embedded/edit_url/{template_id}](/api/reference/operation/embeddedEditUrl/). Template creation may complete asynchronously after the initial request is accepted. It is recommended that a callback be implemented to listen for the callback event. A `template_created` event indicates the template is ready to use, while a `template_error` event indicates there was a problem while creating the template. If a callback handler has been configured and the event has not been received within 60 minutes of making the call, check the status of the request in the API dashboard and retry the request if necessary. + * Example: https://github.com/hellosign/dropbox-sign-java/blob/main/examples/TemplateCreateExample.java * @param templateCreateRequest (required) * @return TemplateCreateResponse * @throws ApiException if fails to make API call @@ -153,6 +156,7 @@ public TemplateCreateResponse templateCreate(TemplateCreateRequest templateCreat /** * Create Template * Creates a template that can be used in future signature requests. If `client_id` is provided, the template will be created as an embedded template. Embedded templates can be used for embedded signature requests and can be edited later by generating a new `edit_url` with [/embedded/edit_url/{template_id}](/api/reference/operation/embeddedEditUrl/). Template creation may complete asynchronously after the initial request is accepted. It is recommended that a callback be implemented to listen for the callback event. A `template_created` event indicates the template is ready to use, while a `template_error` event indicates there was a problem while creating the template. If a callback handler has been configured and the event has not been received within 60 minutes of making the call, check the status of the request in the API dashboard and retry the request if necessary. + * Example: https://github.com/hellosign/dropbox-sign-java/blob/main/examples/TemplateCreateExample.java * @param templateCreateRequest (required) * @return ApiResponse<TemplateCreateResponse> * @throws ApiException if fails to make API call @@ -197,6 +201,7 @@ public ApiResponse templateCreateWithHttpInfo(TemplateCr /** * Create Embedded Template Draft * The first step in an embedded template workflow. Creates a draft template that can then be further set up in the template 'edit' stage. + * Example: https://github.com/hellosign/dropbox-sign-java/blob/main/examples/TemplateCreateEmbeddedDraftExample.java * @param templateCreateEmbeddedDraftRequest (required) * @return TemplateCreateEmbeddedDraftResponse * @throws ApiException if fails to make API call @@ -216,6 +221,7 @@ public TemplateCreateEmbeddedDraftResponse templateCreateEmbeddedDraft(TemplateC /** * Create Embedded Template Draft * The first step in an embedded template workflow. Creates a draft template that can then be further set up in the template 'edit' stage. + * Example: https://github.com/hellosign/dropbox-sign-java/blob/main/examples/TemplateCreateEmbeddedDraftExample.java * @param templateCreateEmbeddedDraftRequest (required) * @return ApiResponse<TemplateCreateEmbeddedDraftResponse> * @throws ApiException if fails to make API call @@ -260,6 +266,7 @@ public ApiResponse templateCreateEmbeddedDr /** * Delete Template * Completely deletes the template specified from the account. + * Example: https://github.com/hellosign/dropbox-sign-java/blob/main/examples/TemplateDeleteExample.java * @param templateId The id of the Template to delete. (required) * @throws ApiException if fails to make API call * @http.response.details @@ -278,6 +285,7 @@ public void templateDelete(String templateId) throws ApiException { /** * Delete Template * Completely deletes the template specified from the account. + * Example: https://github.com/hellosign/dropbox-sign-java/blob/main/examples/TemplateDeleteExample.java * @param templateId The id of the Template to delete. (required) * @return ApiResponse<Void> * @throws ApiException if fails to make API call @@ -325,6 +333,7 @@ public ApiResponse templateDeleteWithHttpInfo(String templateId) throws Ap /** * Get Template Files * Obtain a copy of the current documents specified by the `template_id` parameter. Returns a PDF or ZIP file. If the files are currently being prepared, a status code of `409` will be returned instead. In this case please wait for the `template_created` callback event. + * Example: https://github.com/hellosign/dropbox-sign-java/blob/main/examples/TemplateFilesExample.java * @param templateId The id of the template files to retrieve. (required) * @param fileType Set to `pdf` for a single merged document or `zip` for a collection of individual documents. (optional) * @return File @@ -364,6 +373,7 @@ public ApiResponse templateFilesWithHttpInfo(String templateId) throws Api /** * Get Template Files * Obtain a copy of the current documents specified by the `template_id` parameter. Returns a PDF or ZIP file. If the files are currently being prepared, a status code of `409` will be returned instead. In this case please wait for the `template_created` callback event. + * Example: https://github.com/hellosign/dropbox-sign-java/blob/main/examples/TemplateFilesExample.java * @param templateId The id of the template files to retrieve. (required) * @param fileType Set to `pdf` for a single merged document or `zip` for a collection of individual documents. (optional) * @return ApiResponse<File> @@ -418,6 +428,7 @@ public ApiResponse templateFilesWithHttpInfo(String templateId, String fil /** * Get Template Files as Data Uri * Obtain a copy of the current documents specified by the `template_id` parameter. Returns a JSON object with a `data_uri` representing the base64 encoded file (PDFs only). If the files are currently being prepared, a status code of `409` will be returned instead. In this case please wait for the `template_created` callback event. + * Example: https://github.com/hellosign/dropbox-sign-java/blob/main/examples/TemplateFilesAsDataUriExample.java * @param templateId The id of the template files to retrieve. (required) * @return FileResponseDataUri * @throws ApiException if fails to make API call @@ -437,6 +448,7 @@ public FileResponseDataUri templateFilesAsDataUri(String templateId) throws ApiE /** * Get Template Files as Data Uri * Obtain a copy of the current documents specified by the `template_id` parameter. Returns a JSON object with a `data_uri` representing the base64 encoded file (PDFs only). If the files are currently being prepared, a status code of `409` will be returned instead. In this case please wait for the `template_created` callback event. + * Example: https://github.com/hellosign/dropbox-sign-java/blob/main/examples/TemplateFilesAsDataUriExample.java * @param templateId The id of the template files to retrieve. (required) * @return ApiResponse<FileResponseDataUri> * @throws ApiException if fails to make API call @@ -485,6 +497,7 @@ public ApiResponse templateFilesAsDataUriWithHttpInfo(Strin /** * Get Template Files as File Url * Obtain a copy of the current documents specified by the `template_id` parameter. Returns a JSON object with a url to the file (PDFs only). If the files are currently being prepared, a status code of `409` will be returned instead. In this case please wait for the `template_created` callback event. + * Example: https://github.com/hellosign/dropbox-sign-java/blob/main/examples/TemplateFilesAsFileUrlExample.java * @param templateId The id of the template files to retrieve. (required) * @param forceDownload By default when opening the `file_url` a browser will download the PDF and save it locally. When set to `0` the PDF file will be displayed in the browser. (optional, default to 1) * @return FileResponse @@ -524,6 +537,7 @@ public ApiResponse templateFilesAsFileUrlWithHttpInfo(String templ /** * Get Template Files as File Url * Obtain a copy of the current documents specified by the `template_id` parameter. Returns a JSON object with a url to the file (PDFs only). If the files are currently being prepared, a status code of `409` will be returned instead. In this case please wait for the `template_created` callback event. + * Example: https://github.com/hellosign/dropbox-sign-java/blob/main/examples/TemplateFilesAsFileUrlExample.java * @param templateId The id of the template files to retrieve. (required) * @param forceDownload By default when opening the `file_url` a browser will download the PDF and save it locally. When set to `0` the PDF file will be displayed in the browser. (optional, default to 1) * @return ApiResponse<FileResponse> @@ -581,6 +595,7 @@ public ApiResponse templateFilesAsFileUrlWithHttpInfo(String templ /** * Get Template * Returns the Template specified by the `template_id` parameter. + * Example: https://github.com/hellosign/dropbox-sign-java/blob/main/examples/TemplateGetExample.java * @param templateId The id of the Template to retrieve. (required) * @return TemplateGetResponse * @throws ApiException if fails to make API call @@ -600,6 +615,7 @@ public TemplateGetResponse templateGet(String templateId) throws ApiException { /** * Get Template * Returns the Template specified by the `template_id` parameter. + * Example: https://github.com/hellosign/dropbox-sign-java/blob/main/examples/TemplateGetExample.java * @param templateId The id of the Template to retrieve. (required) * @return ApiResponse<TemplateGetResponse> * @throws ApiException if fails to make API call @@ -648,6 +664,7 @@ public ApiResponse templateGetWithHttpInfo(String templateI /** * List Templates * Returns a list of the Templates that are accessible by you. Take a look at our [search guide](/api/reference/search/) to learn more about querying templates. + * Example: https://github.com/hellosign/dropbox-sign-java/blob/main/examples/TemplateListExample.java * @param accountId Which account to return Templates for. Must be a team member. Use `all` to indicate all team members. Defaults to your account. (optional) * @param page Which page number of the Template List to return. Defaults to `1`. (optional, default to 1) * @param pageSize Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. (optional, default to 20) @@ -755,6 +772,7 @@ public ApiResponse templateListWithHttpInfo(String account /** * List Templates * Returns a list of the Templates that are accessible by you. Take a look at our [search guide](/api/reference/search/) to learn more about querying templates. + * Example: https://github.com/hellosign/dropbox-sign-java/blob/main/examples/TemplateListExample.java * @param accountId Which account to return Templates for. Must be a team member. Use `all` to indicate all team members. Defaults to your account. (optional) * @param page Which page number of the Template List to return. Defaults to `1`. (optional, default to 1) * @param pageSize Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. (optional, default to 20) @@ -811,6 +829,7 @@ public ApiResponse templateListWithHttpInfo(String account /** * Remove User from Template * Removes the specified Account's access to the specified Template. + * Example: https://github.com/hellosign/dropbox-sign-java/blob/main/examples/TemplateRemoveUserExample.java * @param templateId The id of the Template to remove the Account's access to. (required) * @param templateRemoveUserRequest (required) * @return TemplateGetResponse @@ -831,6 +850,7 @@ public TemplateGetResponse templateRemoveUser(String templateId, TemplateRemoveU /** * Remove User from Template * Removes the specified Account's access to the specified Template. + * Example: https://github.com/hellosign/dropbox-sign-java/blob/main/examples/TemplateRemoveUserExample.java * @param templateId The id of the Template to remove the Account's access to. (required) * @param templateRemoveUserRequest (required) * @return ApiResponse<TemplateGetResponse> @@ -883,6 +903,7 @@ public ApiResponse templateRemoveUserWithHttpInfo(String te /** * Update Template Files * Overlays a new file with the overlay of an existing template. The new file(s) must: 1. have the same or higher page count 2. the same orientation as the file(s) being replaced. This will not overwrite or in any way affect the existing template. Both the existing template and new template will be available for use after executing this endpoint. Also note that this will decrement your template quota. Overlaying new files is asynchronous and a successful call to this endpoint will return 200 OK response if the request passes initial validation checks. It is recommended that a callback be implemented to listen for the callback event. A `template_created` event will be sent when the files are updated or a `template_error` event will be sent if there was a problem while updating the files. If a callback handler has been configured and the event has not been received within 60 minutes of making the call, check the status of the request in the API dashboard and retry the request if necessary. If the page orientation or page count is different from the original template document, we will notify you with a `template_error` [callback event](https://app.hellosign.com/api/eventsAndCallbacksWalkthrough). + * Example: https://github.com/hellosign/dropbox-sign-java/blob/main/examples/TemplateUpdateFilesExample.java * @param templateId The ID of the template whose files to update. (required) * @param templateUpdateFilesRequest (required) * @return TemplateUpdateFilesResponse @@ -903,6 +924,7 @@ public TemplateUpdateFilesResponse templateUpdateFiles(String templateId, Templa /** * Update Template Files * Overlays a new file with the overlay of an existing template. The new file(s) must: 1. have the same or higher page count 2. the same orientation as the file(s) being replaced. This will not overwrite or in any way affect the existing template. Both the existing template and new template will be available for use after executing this endpoint. Also note that this will decrement your template quota. Overlaying new files is asynchronous and a successful call to this endpoint will return 200 OK response if the request passes initial validation checks. It is recommended that a callback be implemented to listen for the callback event. A `template_created` event will be sent when the files are updated or a `template_error` event will be sent if there was a problem while updating the files. If a callback handler has been configured and the event has not been received within 60 minutes of making the call, check the status of the request in the API dashboard and retry the request if necessary. If the page orientation or page count is different from the original template document, we will notify you with a `template_error` [callback event](https://app.hellosign.com/api/eventsAndCallbacksWalkthrough). + * Example: https://github.com/hellosign/dropbox-sign-java/blob/main/examples/TemplateUpdateFilesExample.java * @param templateId The ID of the template whose files to update. (required) * @param templateUpdateFilesRequest (required) * @return ApiResponse<TemplateUpdateFilesResponse> diff --git a/sdks/java-v2/src/main/java/com/dropbox/sign/api/UnclaimedDraftApi.java b/sdks/java-v2/src/main/java/com/dropbox/sign/api/UnclaimedDraftApi.java index 8416bd8d2..f2ce33706 100644 --- a/sdks/java-v2/src/main/java/com/dropbox/sign/api/UnclaimedDraftApi.java +++ b/sdks/java-v2/src/main/java/com/dropbox/sign/api/UnclaimedDraftApi.java @@ -54,6 +54,7 @@ public void setApiClient(ApiClient apiClient) { /** * Create Unclaimed Draft * Creates a new Draft that can be claimed using the claim URL. The first authenticated user to access the URL will claim the Draft and will be shown either the \"Sign and send\" or the \"Request signature\" page with the Draft loaded. Subsequent access to the claim URL will result in a 404. + * Example: https://github.com/hellosign/dropbox-sign-java/blob/main/examples/UnclaimedDraftCreateExample.java * @param unclaimedDraftCreateRequest (required) * @return UnclaimedDraftCreateResponse * @throws ApiException if fails to make API call @@ -73,6 +74,7 @@ public UnclaimedDraftCreateResponse unclaimedDraftCreate(UnclaimedDraftCreateReq /** * Create Unclaimed Draft * Creates a new Draft that can be claimed using the claim URL. The first authenticated user to access the URL will claim the Draft and will be shown either the \"Sign and send\" or the \"Request signature\" page with the Draft loaded. Subsequent access to the claim URL will result in a 404. + * Example: https://github.com/hellosign/dropbox-sign-java/blob/main/examples/UnclaimedDraftCreateExample.java * @param unclaimedDraftCreateRequest (required) * @return ApiResponse<UnclaimedDraftCreateResponse> * @throws ApiException if fails to make API call @@ -117,6 +119,7 @@ public ApiResponse unclaimedDraftCreateWithHttpInf /** * Create Embedded Unclaimed Draft * Creates a new Draft that can be claimed and used in an embedded iFrame. The first authenticated user to access the URL will claim the Draft and will be shown the \"Request signature\" page with the Draft loaded. Subsequent access to the claim URL will result in a `404`. For this embedded endpoint the `requester_email_address` parameter is required. **NOTE:** Embedded unclaimed drafts can only be accessed in embedded iFrames whereas normal drafts can be used and accessed on Dropbox Sign. + * Example: https://github.com/hellosign/dropbox-sign-java/blob/main/examples/UnclaimedDraftCreateEmbeddedExample.java * @param unclaimedDraftCreateEmbeddedRequest (required) * @return UnclaimedDraftCreateResponse * @throws ApiException if fails to make API call @@ -136,6 +139,7 @@ public UnclaimedDraftCreateResponse unclaimedDraftCreateEmbedded(UnclaimedDraftC /** * Create Embedded Unclaimed Draft * Creates a new Draft that can be claimed and used in an embedded iFrame. The first authenticated user to access the URL will claim the Draft and will be shown the \"Request signature\" page with the Draft loaded. Subsequent access to the claim URL will result in a `404`. For this embedded endpoint the `requester_email_address` parameter is required. **NOTE:** Embedded unclaimed drafts can only be accessed in embedded iFrames whereas normal drafts can be used and accessed on Dropbox Sign. + * Example: https://github.com/hellosign/dropbox-sign-java/blob/main/examples/UnclaimedDraftCreateEmbeddedExample.java * @param unclaimedDraftCreateEmbeddedRequest (required) * @return ApiResponse<UnclaimedDraftCreateResponse> * @throws ApiException if fails to make API call @@ -180,6 +184,7 @@ public ApiResponse unclaimedDraftCreateEmbeddedWit /** * Create Embedded Unclaimed Draft with Template * Creates a new Draft with a previously saved template(s) that can be claimed and used in an embedded iFrame. The first authenticated user to access the URL will claim the Draft and will be shown the \"Request signature\" page with the Draft loaded. Subsequent access to the claim URL will result in a `404`. For this embedded endpoint the `requester_email_address` parameter is required. **NOTE:** Embedded unclaimed drafts can only be accessed in embedded iFrames whereas normal drafts can be used and accessed on Dropbox Sign. + * Example: https://github.com/hellosign/dropbox-sign-java/blob/main/examples/UnclaimedDraftCreateEmbeddedWithTemplateExample.java * @param unclaimedDraftCreateEmbeddedWithTemplateRequest (required) * @return UnclaimedDraftCreateResponse * @throws ApiException if fails to make API call @@ -199,6 +204,7 @@ public UnclaimedDraftCreateResponse unclaimedDraftCreateEmbeddedWithTemplate(Unc /** * Create Embedded Unclaimed Draft with Template * Creates a new Draft with a previously saved template(s) that can be claimed and used in an embedded iFrame. The first authenticated user to access the URL will claim the Draft and will be shown the \"Request signature\" page with the Draft loaded. Subsequent access to the claim URL will result in a `404`. For this embedded endpoint the `requester_email_address` parameter is required. **NOTE:** Embedded unclaimed drafts can only be accessed in embedded iFrames whereas normal drafts can be used and accessed on Dropbox Sign. + * Example: https://github.com/hellosign/dropbox-sign-java/blob/main/examples/UnclaimedDraftCreateEmbeddedWithTemplateExample.java * @param unclaimedDraftCreateEmbeddedWithTemplateRequest (required) * @return ApiResponse<UnclaimedDraftCreateResponse> * @throws ApiException if fails to make API call @@ -243,6 +249,7 @@ public ApiResponse unclaimedDraftCreateEmbeddedWit /** * Edit and Resend Unclaimed Draft * Creates a new signature request from an embedded request that can be edited prior to being sent to the recipients. Parameter `test_mode` can be edited prior to request. Signers can be edited in embedded editor. Requester's email address will remain unchanged if `requester_email_address` parameter is not set. **NOTE:** Embedded unclaimed drafts can only be accessed in embedded iFrames whereas normal drafts can be used and accessed on Dropbox Sign. + * Example: https://github.com/hellosign/dropbox-sign-java/blob/main/examples/UnclaimedDraftEditAndResendExample.java * @param signatureRequestId The ID of the signature request to edit and resend. (required) * @param unclaimedDraftEditAndResendRequest (required) * @return UnclaimedDraftCreateResponse @@ -263,6 +270,7 @@ public UnclaimedDraftCreateResponse unclaimedDraftEditAndResend(String signature /** * Edit and Resend Unclaimed Draft * Creates a new signature request from an embedded request that can be edited prior to being sent to the recipients. Parameter `test_mode` can be edited prior to request. Signers can be edited in embedded editor. Requester's email address will remain unchanged if `requester_email_address` parameter is not set. **NOTE:** Embedded unclaimed drafts can only be accessed in embedded iFrames whereas normal drafts can be used and accessed on Dropbox Sign. + * Example: https://github.com/hellosign/dropbox-sign-java/blob/main/examples/UnclaimedDraftEditAndResendExample.java * @param signatureRequestId The ID of the signature request to edit and resend. (required) * @param unclaimedDraftEditAndResendRequest (required) * @return ApiResponse<UnclaimedDraftCreateResponse> diff --git a/sdks/java-v2/templates/libraries/jersey3/api.mustache b/sdks/java-v2/templates/libraries/jersey3/api.mustache index 0c0e2c8da..85a1af442 100644 --- a/sdks/java-v2/templates/libraries/jersey3/api.mustache +++ b/sdks/java-v2/templates/libraries/jersey3/api.mustache @@ -58,6 +58,7 @@ public class {{classname}} { /** * {{summary}} * {{notes}} + * Example: https://github.com/hellosign/dropbox-sign-java/blob/main/examples/{{operationIdCamelCase}}Example.java {{#allParams}} * @param {{paramName}} {{description}}{{#required}} (required){{/required}}{{^required}} (optional{{#defaultValue}}, default to {{.}}{{/defaultValue}}){{/required}} {{/allParams}} @@ -99,6 +100,7 @@ public class {{classname}} { /** * {{summary}} * {{notes}} + * Example: https://github.com/hellosign/dropbox-sign-java/blob/main/examples/{{operationIdCamelCase}}Example.java {{#allParams}} * @param {{paramName}} {{description}}{{#required}} (required){{/required}}{{^required}} (optional{{#defaultValue}}, default to {{.}}{{/defaultValue}}){{/required}} {{/allParams}} @@ -269,6 +271,7 @@ public class {{classname}} { /** * Execute {{operationId}} request + * Example: https://github.com/hellosign/dropbox-sign-java/blob/main/examples/{{operationIdCamelCase}}Example.java {{#returnType}}* @return {{.}}{{/returnType}} * @throws ApiException if fails to make API call {{#responses.0}} @@ -290,6 +293,7 @@ public class {{classname}} { /** * Execute {{operationId}} request with HTTP info returned + * Example: https://github.com/hellosign/dropbox-sign-java/blob/main/examples/{{operationIdCamelCase}}Example.java * @return ApiResponse<{{returnType}}{{^returnType}}Void{{/returnType}}> * @throws ApiException if fails to make API call {{#responses.0}} @@ -316,6 +320,7 @@ public class {{classname}} { /** * {{summary}} * {{notes}}{{#pathParams}} + * Example: https://github.com/hellosign/dropbox-sign-java/blob/main/examples/{{operationIdCamelCase}}Example.java * @param {{paramName}} {{description}} (required){{/pathParams}} * @return {{operationId}}Request * @throws ApiException if fails to make API call diff --git a/sdks/node/api/accountApi.ts b/sdks/node/api/accountApi.ts index 8d322b0f9..829eba59d 100644 --- a/sdks/node/api/accountApi.ts +++ b/sdks/node/api/accountApi.ts @@ -123,6 +123,7 @@ export class AccountApi { /** * Creates a new Dropbox Sign Account that is associated with the specified `email_address`. * @summary Create Account + * Example: https://github.com/hellosign/dropbox-sign-node/blob/main/examples/AccountCreateExample.ts * @param accountCreateRequest * @param options */ @@ -268,6 +269,7 @@ export class AccountApi { /** * Returns the properties and settings of your Account. * @summary Get Account + * Example: https://github.com/hellosign/dropbox-sign-node/blob/main/examples/AccountGetExample.ts * @param accountId `account_id` or `email_address` is required. If both are provided, the account id prevails. The ID of the Account. * @param emailAddress `account_id` or `email_address` is required, If both are provided, the account id prevails. The email address of the Account. * @param options @@ -394,6 +396,7 @@ export class AccountApi { /** * Updates the properties and settings of your Account. Currently only allows for updates to the [Callback URL](/api/reference/tag/Callbacks-and-Events) and locale. * @summary Update Account + * Example: https://github.com/hellosign/dropbox-sign-node/blob/main/examples/AccountUpdateExample.ts * @param accountUpdateRequest * @param options */ @@ -537,6 +540,7 @@ export class AccountApi { /** * Verifies whether an Dropbox Sign Account exists for the given email address. * @summary Verify Account + * Example: https://github.com/hellosign/dropbox-sign-node/blob/main/examples/AccountVerifyExample.ts * @param accountVerifyRequest * @param options */ diff --git a/sdks/node/api/apiAppApi.ts b/sdks/node/api/apiAppApi.ts index b7bb4b961..de0d7346b 100644 --- a/sdks/node/api/apiAppApi.ts +++ b/sdks/node/api/apiAppApi.ts @@ -122,6 +122,7 @@ export class ApiAppApi { /** * Creates a new API App. * @summary Create API App + * Example: https://github.com/hellosign/dropbox-sign-node/blob/main/examples/ApiAppCreateExample.ts * @param apiAppCreateRequest * @param options */ @@ -265,6 +266,7 @@ export class ApiAppApi { /** * Deletes an API App. Can only be invoked for apps you own. * @summary Delete API App + * Example: https://github.com/hellosign/dropbox-sign-node/blob/main/examples/ApiAppDeleteExample.ts * @param clientId The client id of the API App to delete. * @param options */ @@ -371,6 +373,7 @@ export class ApiAppApi { /** * Returns an object with information about an API App. * @summary Get API App + * Example: https://github.com/hellosign/dropbox-sign-node/blob/main/examples/ApiAppGetExample.ts * @param clientId The client id of the API App to retrieve. * @param options */ @@ -493,6 +496,7 @@ export class ApiAppApi { /** * Returns a list of API Apps that are accessible by you. If you are on a team with an Admin or Developer role, this list will include apps owned by teammates. * @summary List API Apps + * Example: https://github.com/hellosign/dropbox-sign-node/blob/main/examples/ApiAppListExample.ts * @param page Which page number of the API App List to return. Defaults to `1`. * @param pageSize Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. * @param options @@ -619,6 +623,7 @@ export class ApiAppApi { /** * Updates an existing API App. Can only be invoked for apps you own. Only the fields you provide will be updated. If you wish to clear an existing optional field, provide an empty string. * @summary Update API App + * Example: https://github.com/hellosign/dropbox-sign-node/blob/main/examples/ApiAppUpdateExample.ts * @param clientId The client id of the API App to update. * @param apiAppUpdateRequest * @param options diff --git a/sdks/node/api/bulkSendJobApi.ts b/sdks/node/api/bulkSendJobApi.ts index 650400586..a420803e3 100644 --- a/sdks/node/api/bulkSendJobApi.ts +++ b/sdks/node/api/bulkSendJobApi.ts @@ -117,6 +117,7 @@ export class BulkSendJobApi { /** * Returns the status of the BulkSendJob and its SignatureRequests specified by the `bulk_send_job_id` parameter. * @summary Get Bulk Send Job + * Example: https://github.com/hellosign/dropbox-sign-node/blob/main/examples/BulkSendJobGetExample.ts * @param bulkSendJobId The id of the BulkSendJob to retrieve. * @param page Which page number of the BulkSendJob list to return. Defaults to `1`. * @param pageSize Number of objects to be returned per page. Must be between `1` and `100`. Default is 20. @@ -259,6 +260,7 @@ export class BulkSendJobApi { /** * Returns a list of BulkSendJob that you can access. * @summary List Bulk Send Jobs + * Example: https://github.com/hellosign/dropbox-sign-node/blob/main/examples/BulkSendJobListExample.ts * @param page Which page number of the BulkSendJob List to return. Defaults to `1`. * @param pageSize Number of objects to be returned per page. Must be between `1` and `100`. Default is 20. * @param options diff --git a/sdks/node/api/embeddedApi.ts b/sdks/node/api/embeddedApi.ts index 17d3b9615..7fd0e08f3 100644 --- a/sdks/node/api/embeddedApi.ts +++ b/sdks/node/api/embeddedApi.ts @@ -120,6 +120,7 @@ export class EmbeddedApi { /** * Retrieves an embedded object containing a template url that can be opened in an iFrame. Note that only templates created via the embedded template process are available to be edited with this endpoint. * @summary Get Embedded Template Edit URL + * Example: https://github.com/hellosign/dropbox-sign-node/blob/main/examples/EmbeddedEditUrlExample.ts * @param templateId The id of the template to edit. * @param embeddedEditUrlRequest * @param options @@ -282,6 +283,7 @@ export class EmbeddedApi { /** * Retrieves an embedded object containing a signature url that can be opened in an iFrame. Note that templates created via the embedded template process will only be accessible through the API. * @summary Get Embedded Sign URL + * Example: https://github.com/hellosign/dropbox-sign-node/blob/main/examples/EmbeddedSignUrlExample.ts * @param signatureId The id of the signature to get a signature url for. * @param options */ diff --git a/sdks/node/api/faxApi.ts b/sdks/node/api/faxApi.ts index 26e224280..464d37537 100644 --- a/sdks/node/api/faxApi.ts +++ b/sdks/node/api/faxApi.ts @@ -121,6 +121,7 @@ export class FaxApi { /** * Deletes the specified Fax from the system * @summary Delete Fax + * Example: https://github.com/hellosign/dropbox-sign-node/blob/main/examples/FaxDeleteExample.ts * @param faxId Fax ID * @param options */ @@ -222,6 +223,7 @@ export class FaxApi { /** * Downloads files associated with a Fax * @summary Download Fax Files + * Example: https://github.com/hellosign/dropbox-sign-node/blob/main/examples/FaxFilesExample.ts * @param faxId Fax ID * @param options */ @@ -339,6 +341,7 @@ export class FaxApi { /** * Returns information about a Fax * @summary Get Fax + * Example: https://github.com/hellosign/dropbox-sign-node/blob/main/examples/FaxGetExample.ts * @param faxId Fax ID * @param options */ @@ -456,6 +459,7 @@ export class FaxApi { /** * Returns properties of multiple Faxes * @summary Lists Faxes + * Example: https://github.com/hellosign/dropbox-sign-node/blob/main/examples/FaxListExample.ts * @param page Which page number of the Fax List to return. Defaults to `1`. * @param pageSize Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. * @param options @@ -577,6 +581,7 @@ export class FaxApi { /** * Creates and sends a new Fax with the submitted file(s) * @summary Send Fax + * Example: https://github.com/hellosign/dropbox-sign-node/blob/main/examples/FaxSendExample.ts * @param faxSendRequest * @param options */ diff --git a/sdks/node/api/faxLineApi.ts b/sdks/node/api/faxLineApi.ts index 24510ee88..8a662d0fa 100644 --- a/sdks/node/api/faxLineApi.ts +++ b/sdks/node/api/faxLineApi.ts @@ -125,6 +125,7 @@ export class FaxLineApi { /** * Grants a user access to the specified Fax Line. * @summary Add Fax Line User + * Example: https://github.com/hellosign/dropbox-sign-node/blob/main/examples/FaxLineAddUserExample.ts * @param faxLineAddUserRequest * @param options */ @@ -263,6 +264,7 @@ export class FaxLineApi { /** * Returns a list of available area codes for a given state/province and city * @summary Get Available Fax Line Area Codes + * Example: https://github.com/hellosign/dropbox-sign-node/blob/main/examples/FaxLineAreaCodeGetExample.ts * @param country Filter area codes by country * @param state Filter area codes by state * @param province Filter area codes by province @@ -475,6 +477,7 @@ export class FaxLineApi { /** * Purchases a new Fax Line * @summary Purchase Fax Line + * Example: https://github.com/hellosign/dropbox-sign-node/blob/main/examples/FaxLineCreateExample.ts * @param faxLineCreateRequest * @param options */ @@ -613,6 +616,7 @@ export class FaxLineApi { /** * Deletes the specified Fax Line from the subscription. * @summary Delete Fax Line + * Example: https://github.com/hellosign/dropbox-sign-node/blob/main/examples/FaxLineDeleteExample.ts * @param faxLineDeleteRequest * @param options */ @@ -735,6 +739,7 @@ export class FaxLineApi { /** * Returns the properties and settings of a Fax Line. * @summary Get Fax Line + * Example: https://github.com/hellosign/dropbox-sign-node/blob/main/examples/FaxLineGetExample.ts * @param number The Fax Line number * @param options */ @@ -854,6 +859,7 @@ export class FaxLineApi { /** * Returns the properties and settings of multiple Fax Lines. * @summary List Fax Lines + * Example: https://github.com/hellosign/dropbox-sign-node/blob/main/examples/FaxLineListExample.ts * @param accountId Account ID * @param page Which page number of the Fax Line List to return. Defaults to `1`. * @param pageSize Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. @@ -995,6 +1001,7 @@ export class FaxLineApi { /** * Removes a user\'s access to the specified Fax Line * @summary Remove Fax Line Access + * Example: https://github.com/hellosign/dropbox-sign-node/blob/main/examples/FaxLineRemoveUserExample.ts * @param faxLineRemoveUserRequest * @param options */ diff --git a/sdks/node/api/oAuthApi.ts b/sdks/node/api/oAuthApi.ts index 1478d53e0..49896b1c0 100644 --- a/sdks/node/api/oAuthApi.ts +++ b/sdks/node/api/oAuthApi.ts @@ -120,6 +120,7 @@ export class OAuthApi { /** * Once you have retrieved the code from the user callback, you will need to exchange it for an access token via a backend call. * @summary OAuth Token Generate + * Example: https://github.com/hellosign/dropbox-sign-node/blob/main/examples/OauthTokenGenerateExample.ts * @param oAuthTokenGenerateRequest * @param options */ @@ -256,6 +257,7 @@ export class OAuthApi { /** * Access tokens are only valid for a given period of time (typically one hour) for security reasons. Whenever acquiring an new access token its TTL is also given (see `expires_in`), along with a refresh token that can be used to acquire a new access token after the current one has expired. * @summary OAuth Token Refresh + * Example: https://github.com/hellosign/dropbox-sign-node/blob/main/examples/OauthTokenRefreshExample.ts * @param oAuthTokenRefreshRequest * @param options */ diff --git a/sdks/node/api/reportApi.ts b/sdks/node/api/reportApi.ts index 94eea7973..dc0ab70c1 100644 --- a/sdks/node/api/reportApi.ts +++ b/sdks/node/api/reportApi.ts @@ -119,6 +119,7 @@ export class ReportApi { /** * Request the creation of one or more report(s). When the report(s) have been generated, you will receive an email (one per requested report type) containing a link to download the report as a CSV file. The requested date range may be up to 12 months in duration, and `start_date` must not be more than 10 years in the past. * @summary Create Report + * Example: https://github.com/hellosign/dropbox-sign-node/blob/main/examples/ReportCreateExample.ts * @param reportCreateRequest * @param options */ diff --git a/sdks/node/api/signatureRequestApi.ts b/sdks/node/api/signatureRequestApi.ts index 474ebb7a5..1358d7d92 100644 --- a/sdks/node/api/signatureRequestApi.ts +++ b/sdks/node/api/signatureRequestApi.ts @@ -135,6 +135,7 @@ export class SignatureRequestApi { /** * Creates BulkSendJob which sends up to 250 SignatureRequests in bulk based off of the provided Template(s) specified with the `template_ids` parameter to be signed in an embedded iFrame. These embedded signature requests can only be signed in embedded iFrames whereas normal signature requests can only be signed on Dropbox Sign. **NOTE:** Only available for Standard plan and higher. * @summary Embedded Bulk Send with Template + * Example: https://github.com/hellosign/dropbox-sign-node/blob/main/examples/SignatureRequestBulkCreateEmbeddedWithTemplateExample.ts * @param signatureRequestBulkCreateEmbeddedWithTemplateRequest * @param options */ @@ -279,6 +280,7 @@ export class SignatureRequestApi { /** * Creates BulkSendJob which sends up to 250 SignatureRequests in bulk based off of the provided Template(s) specified with the `template_ids` parameter. **NOTE:** Only available for Standard plan and higher. * @summary Bulk Send with Template + * Example: https://github.com/hellosign/dropbox-sign-node/blob/main/examples/SignatureRequestBulkSendWithTemplateExample.ts * @param signatureRequestBulkSendWithTemplateRequest * @param options */ @@ -428,6 +430,7 @@ export class SignatureRequestApi { /** * Cancels an incomplete signature request. This action is **not reversible**. The request will be canceled and signers will no longer be able to sign. If they try to access the signature request they will receive a HTTP 410 status code indicating that the resource has been deleted. Cancelation is asynchronous and a successful call to this endpoint will return an empty 200 OK response if the signature request is eligible to be canceled and has been successfully queued. This 200 OK response does not indicate a successful cancelation of the signature request itself. The cancelation is confirmed via the `signature_request_canceled` event. It is recommended that a [callback handler](/api/reference/tag/Callbacks-and-Events) be implemented to listen for the `signature_request_canceled` event. This callback will be sent only when the cancelation has completed successfully. If a callback handler has been configured and the event has not been received within 60 minutes of making the call, check the status of the request in the [API Dashboard](https://app.hellosign.com/apidashboard) and retry the cancelation if necessary. To be eligible for cancelation, a signature request must have been sent successfully, must not yet have been signed by all signers, and you must either be the sender or own the API app under which it was sent. A partially signed signature request can be canceled. **NOTE:** To remove your access to a completed signature request, use the endpoint: `POST /signature_request/remove/[:signature_request_id]`. * @summary Cancel Incomplete Signature Request + * Example: https://github.com/hellosign/dropbox-sign-node/blob/main/examples/SignatureRequestCancelExample.ts * @param signatureRequestId The id of the incomplete SignatureRequest to cancel. * @param options */ @@ -534,6 +537,7 @@ export class SignatureRequestApi { /** * Creates a new SignatureRequest with the submitted documents to be signed in an embedded iFrame. If form_fields_per_document is not specified, a signature page will be affixed where all signers will be required to add their signature, signifying their agreement to all contained documents. Note that embedded signature requests can only be signed in embedded iFrames whereas normal signature requests can only be signed on Dropbox Sign. * @summary Create Embedded Signature Request + * Example: https://github.com/hellosign/dropbox-sign-node/blob/main/examples/SignatureRequestCreateEmbeddedExample.ts * @param signatureRequestCreateEmbeddedRequest * @param options */ @@ -682,6 +686,7 @@ export class SignatureRequestApi { /** * Creates a new SignatureRequest based on the given Template(s) to be signed in an embedded iFrame. Note that embedded signature requests can only be signed in embedded iFrames whereas normal signature requests can only be signed on Dropbox Sign. * @summary Create Embedded Signature Request with Template + * Example: https://github.com/hellosign/dropbox-sign-node/blob/main/examples/SignatureRequestCreateEmbeddedWithTemplateExample.ts * @param signatureRequestCreateEmbeddedWithTemplateRequest * @param options */ @@ -831,6 +836,7 @@ export class SignatureRequestApi { /** * Edits and sends a SignatureRequest with the submitted documents. If `form_fields_per_document` is not specified, a signature page will be affixed where all signers will be required to add their signature, signifying their agreement to all contained documents. **NOTE:** Edit and resend *will* deduct your signature request quota. * @summary Edit Signature Request + * Example: https://github.com/hellosign/dropbox-sign-node/blob/main/examples/SignatureRequestEditExample.ts * @param signatureRequestId The id of the SignatureRequest to edit. * @param signatureRequestEditRequest * @param options @@ -993,6 +999,7 @@ export class SignatureRequestApi { /** * Edits a SignatureRequest with the submitted documents to be signed in an embedded iFrame. If form_fields_per_document is not specified, a signature page will be affixed where all signers will be required to add their signature, signifying their agreement to all contained documents. Note that embedded signature requests can only be signed in embedded iFrames whereas normal signature requests can only be signed on Dropbox Sign. **NOTE:** Edit and resend *will* deduct your signature request quota. * @summary Edit Embedded Signature Request + * Example: https://github.com/hellosign/dropbox-sign-node/blob/main/examples/SignatureRequestEditEmbeddedExample.ts * @param signatureRequestId The id of the SignatureRequest to edit. * @param signatureRequestEditEmbeddedRequest * @param options @@ -1155,6 +1162,7 @@ export class SignatureRequestApi { /** * Edits a SignatureRequest based on the given Template(s) to be signed in an embedded iFrame. Note that embedded signature requests can only be signed in embedded iFrames whereas normal signature requests can only be signed on Dropbox Sign. **NOTE:** Edit and resend *will* deduct your signature request quota. * @summary Edit Embedded Signature Request with Template + * Example: https://github.com/hellosign/dropbox-sign-node/blob/main/examples/SignatureRequestEditEmbeddedWithTemplateExample.ts * @param signatureRequestId The id of the SignatureRequest to edit. * @param signatureRequestEditEmbeddedWithTemplateRequest * @param options @@ -1317,6 +1325,7 @@ export class SignatureRequestApi { /** * Edits and sends a SignatureRequest based off of the Template(s) specified with the template_ids parameter. **NOTE:** Edit and resend *will* deduct your signature request quota. * @summary Edit Signature Request With Template + * Example: https://github.com/hellosign/dropbox-sign-node/blob/main/examples/SignatureRequestEditWithTemplateExample.ts * @param signatureRequestId The id of the SignatureRequest to edit. * @param signatureRequestEditWithTemplateRequest * @param options @@ -1479,6 +1488,7 @@ export class SignatureRequestApi { /** * Obtain a copy of the current documents specified by the `signature_request_id` parameter. Returns a PDF or ZIP file. If the files are currently being prepared, a status code of `409` will be returned instead. * @summary Download Files + * Example: https://github.com/hellosign/dropbox-sign-node/blob/main/examples/SignatureRequestFilesExample.ts * @param signatureRequestId The id of the SignatureRequest to retrieve. * @param fileType Set to `pdf` for a single merged document or `zip` for a collection of individual documents. * @param options @@ -1610,6 +1620,7 @@ export class SignatureRequestApi { /** * Obtain a copy of the current documents specified by the `signature_request_id` parameter. Returns a JSON object with a `data_uri` representing the base64 encoded file (PDFs only). If the files are currently being prepared, a status code of `409` will be returned instead. * @summary Download Files as Data Uri + * Example: https://github.com/hellosign/dropbox-sign-node/blob/main/examples/SignatureRequestFilesAsDataUriExample.ts * @param signatureRequestId The id of the SignatureRequest to retrieve. * @param options */ @@ -1734,6 +1745,7 @@ export class SignatureRequestApi { /** * Obtain a copy of the current documents specified by the `signature_request_id` parameter. Returns a JSON object with a url to the file (PDFs only). If the files are currently being prepared, a status code of `409` will be returned instead. * @summary Download Files as File Url + * Example: https://github.com/hellosign/dropbox-sign-node/blob/main/examples/SignatureRequestFilesAsFileUrlExample.ts * @param signatureRequestId The id of the SignatureRequest to retrieve. * @param forceDownload By default when opening the `file_url` a browser will download the PDF and save it locally. When set to `0` the PDF file will be displayed in the browser. * @param options @@ -1865,6 +1877,7 @@ export class SignatureRequestApi { /** * Returns the status of the SignatureRequest specified by the `signature_request_id` parameter. * @summary Get Signature Request + * Example: https://github.com/hellosign/dropbox-sign-node/blob/main/examples/SignatureRequestGetExample.ts * @param signatureRequestId The id of the SignatureRequest to retrieve. * @param options */ @@ -1989,6 +2002,7 @@ export class SignatureRequestApi { /** * Returns a list of SignatureRequests that you can access. This includes SignatureRequests you have sent as well as received, but not ones that you have been CCed on. Take a look at our [search guide](/api/reference/search/) to learn more about querying signature requests. * @summary List Signature Requests + * Example: https://github.com/hellosign/dropbox-sign-node/blob/main/examples/SignatureRequestListExample.ts * @param accountId Which account to return SignatureRequests for. Must be a team member. Use `all` to indicate all team members. Defaults to your account. * @param page Which page number of the SignatureRequest List to return. Defaults to `1`. * @param pageSize Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. @@ -2135,6 +2149,7 @@ export class SignatureRequestApi { /** * Releases a held SignatureRequest that was claimed and prepared from an [UnclaimedDraft](/api/reference/tag/Unclaimed-Draft). The owner of the Draft must indicate at Draft creation that the SignatureRequest created from the Draft should be held. Releasing the SignatureRequest will send requests to all signers. * @summary Release On-Hold Signature Request + * Example: https://github.com/hellosign/dropbox-sign-node/blob/main/examples/SignatureRequestReleaseHoldExample.ts * @param signatureRequestId The id of the SignatureRequest to release. * @param options */ @@ -2259,6 +2274,7 @@ export class SignatureRequestApi { /** * Sends an email to the signer reminding them to sign the signature request. You cannot send a reminder within 1 hour of the last reminder that was sent. This includes manual AND automatic reminders. **NOTE:** This action can **not** be used with embedded signature requests. * @summary Send Request Reminder + * Example: https://github.com/hellosign/dropbox-sign-node/blob/main/examples/SignatureRequestRemindExample.ts * @param signatureRequestId The id of the SignatureRequest to send a reminder for. * @param signatureRequestRemindRequest * @param options @@ -2421,6 +2437,7 @@ export class SignatureRequestApi { /** * Removes your access to a completed signature request. This action is **not reversible**. The signature request must be fully executed by all parties (signed or declined to sign). Other parties will continue to maintain access to the completed signature request document(s). Unlike /signature_request/cancel, this endpoint is synchronous and your access will be immediately removed. Upon successful removal, this endpoint will return a 200 OK response. * @summary Remove Signature Request Access + * Example: https://github.com/hellosign/dropbox-sign-node/blob/main/examples/SignatureRequestRemoveExample.ts * @param signatureRequestId The id of the SignatureRequest to remove. * @param options */ @@ -2522,6 +2539,7 @@ export class SignatureRequestApi { /** * Creates and sends a new SignatureRequest with the submitted documents. If `form_fields_per_document` is not specified, a signature page will be affixed where all signers will be required to add their signature, signifying their agreement to all contained documents. * @summary Send Signature Request + * Example: https://github.com/hellosign/dropbox-sign-node/blob/main/examples/SignatureRequestSendExample.ts * @param signatureRequestSendRequest * @param options */ @@ -2670,6 +2688,7 @@ export class SignatureRequestApi { /** * Creates and sends a new SignatureRequest based off of the Template(s) specified with the `template_ids` parameter. * @summary Send with Template + * Example: https://github.com/hellosign/dropbox-sign-node/blob/main/examples/SignatureRequestSendWithTemplateExample.ts * @param signatureRequestSendWithTemplateRequest * @param options */ @@ -2819,6 +2838,7 @@ export class SignatureRequestApi { /** * Updates the email address and/or the name for a given signer on a signature request. You can listen for the `signature_request_email_bounce` event on your app or account to detect bounced emails, and respond with this method. Updating the email address of a signer will generate a new `signature_id` value. **NOTE:** This action cannot be performed on a signature request with an appended signature page. * @summary Update Signature Request + * Example: https://github.com/hellosign/dropbox-sign-node/blob/main/examples/SignatureRequestUpdateExample.ts * @param signatureRequestId The id of the SignatureRequest to update. * @param signatureRequestUpdateRequest * @param options diff --git a/sdks/node/api/teamApi.ts b/sdks/node/api/teamApi.ts index d912160c9..455a54c17 100644 --- a/sdks/node/api/teamApi.ts +++ b/sdks/node/api/teamApi.ts @@ -127,6 +127,7 @@ export class TeamApi { /** * Invites a user (specified using the `email_address` parameter) to your Team. If the user does not currently have a Dropbox Sign Account, a new one will be created for them. If a user is already a part of another Team, a `team_invite_failed` error will be returned. * @summary Add User to Team + * Example: https://github.com/hellosign/dropbox-sign-node/blob/main/examples/TeamAddMemberExample.ts * @param teamAddMemberRequest * @param teamId The id of the team. * @param options @@ -279,6 +280,7 @@ export class TeamApi { /** * Creates a new Team and makes you a member. You must not currently belong to a Team to invoke. * @summary Create Team + * Example: https://github.com/hellosign/dropbox-sign-node/blob/main/examples/TeamCreateExample.ts * @param teamCreateRequest * @param options */ @@ -419,6 +421,7 @@ export class TeamApi { /** * Deletes your Team. Can only be invoked when you have a Team with only one member (yourself). * @summary Delete Team + * Example: https://github.com/hellosign/dropbox-sign-node/blob/main/examples/TeamDeleteExample.ts * @param options */ public async teamDelete( @@ -511,6 +514,7 @@ export class TeamApi { /** * Returns information about your Team as well as a list of its members. If you do not belong to a Team, a 404 error with an error_name of \"not_found\" will be returned. * @summary Get Team + * Example: https://github.com/hellosign/dropbox-sign-node/blob/main/examples/TeamGetExample.ts * @param options */ public async teamGet( @@ -619,6 +623,7 @@ export class TeamApi { /** * Provides information about a team. * @summary Get Team Info + * Example: https://github.com/hellosign/dropbox-sign-node/blob/main/examples/TeamInfoExample.ts * @param teamId The id of the team. * @param options */ @@ -738,6 +743,7 @@ export class TeamApi { /** * Provides a list of team invites (and their roles). * @summary List Team Invites + * Example: https://github.com/hellosign/dropbox-sign-node/blob/main/examples/TeamInvitesExample.ts * @param emailAddress The email address for which to display the team invites. * @param options */ @@ -857,6 +863,7 @@ export class TeamApi { /** * Provides a paginated list of members (and their roles) that belong to a given team. * @summary List Team Members + * Example: https://github.com/hellosign/dropbox-sign-node/blob/main/examples/TeamMembersExample.ts * @param teamId The id of the team that a member list is being requested from. * @param page Which page number of the team member list to return. Defaults to `1`. * @param pageSize Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. @@ -999,6 +1006,7 @@ export class TeamApi { /** * Removes the provided user Account from your Team. If the Account had an outstanding invitation to your Team, the invitation will be expired. If you choose to transfer documents from the removed Account to an Account provided in the `new_owner_email_address` parameter (available only for Enterprise plans), the response status code will be 201, which indicates that your request has been queued but not fully executed. * @summary Remove User from Team + * Example: https://github.com/hellosign/dropbox-sign-node/blob/main/examples/TeamRemoveMemberExample.ts * @param teamRemoveMemberRequest * @param options */ @@ -1145,6 +1153,7 @@ export class TeamApi { /** * Provides a paginated list of sub teams that belong to a given team. * @summary List Sub Teams + * Example: https://github.com/hellosign/dropbox-sign-node/blob/main/examples/TeamSubTeamsExample.ts * @param teamId The id of the parent Team. * @param page Which page number of the SubTeam List to return. Defaults to `1`. * @param pageSize Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. @@ -1287,6 +1296,7 @@ export class TeamApi { /** * Updates the name of your Team. * @summary Update Team + * Example: https://github.com/hellosign/dropbox-sign-node/blob/main/examples/TeamUpdateExample.ts * @param teamUpdateRequest * @param options */ diff --git a/sdks/node/api/templateApi.ts b/sdks/node/api/templateApi.ts index 676e33e18..a869a9b6f 100644 --- a/sdks/node/api/templateApi.ts +++ b/sdks/node/api/templateApi.ts @@ -130,6 +130,7 @@ export class TemplateApi { /** * Gives the specified Account access to the specified Template. The specified Account must be a part of your Team. * @summary Add User to Template + * Example: https://github.com/hellosign/dropbox-sign-node/blob/main/examples/TemplateAddUserExample.ts * @param templateId The id of the Template to give the Account access to. * @param templateAddUserRequest * @param options @@ -292,6 +293,7 @@ export class TemplateApi { /** * Creates a template that can be used in future signature requests. If `client_id` is provided, the template will be created as an embedded template. Embedded templates can be used for embedded signature requests and can be edited later by generating a new `edit_url` with [/embedded/edit_url/{template_id}](/api/reference/operation/embeddedEditUrl/). Template creation may complete asynchronously after the initial request is accepted. It is recommended that a callback be implemented to listen for the callback event. A `template_created` event indicates the template is ready to use, while a `template_error` event indicates there was a problem while creating the template. If a callback handler has been configured and the event has not been received within 60 minutes of making the call, check the status of the request in the API dashboard and retry the request if necessary. * @summary Create Template + * Example: https://github.com/hellosign/dropbox-sign-node/blob/main/examples/TemplateCreateExample.ts * @param templateCreateRequest * @param options */ @@ -437,6 +439,7 @@ export class TemplateApi { /** * The first step in an embedded template workflow. Creates a draft template that can then be further set up in the template \'edit\' stage. * @summary Create Embedded Template Draft + * Example: https://github.com/hellosign/dropbox-sign-node/blob/main/examples/TemplateCreateEmbeddedDraftExample.ts * @param templateCreateEmbeddedDraftRequest * @param options */ @@ -585,6 +588,7 @@ export class TemplateApi { /** * Completely deletes the template specified from the account. * @summary Delete Template + * Example: https://github.com/hellosign/dropbox-sign-node/blob/main/examples/TemplateDeleteExample.ts * @param templateId The id of the Template to delete. * @param options */ @@ -691,6 +695,7 @@ export class TemplateApi { /** * Obtain a copy of the current documents specified by the `template_id` parameter. Returns a PDF or ZIP file. If the files are currently being prepared, a status code of `409` will be returned instead. In this case please wait for the `template_created` callback event. * @summary Get Template Files + * Example: https://github.com/hellosign/dropbox-sign-node/blob/main/examples/TemplateFilesExample.ts * @param templateId The id of the template files to retrieve. * @param fileType Set to `pdf` for a single merged document or `zip` for a collection of individual documents. * @param options @@ -822,6 +827,7 @@ export class TemplateApi { /** * Obtain a copy of the current documents specified by the `template_id` parameter. Returns a JSON object with a `data_uri` representing the base64 encoded file (PDFs only). If the files are currently being prepared, a status code of `409` will be returned instead. In this case please wait for the `template_created` callback event. * @summary Get Template Files as Data Uri + * Example: https://github.com/hellosign/dropbox-sign-node/blob/main/examples/TemplateFilesAsDataUriExample.ts * @param templateId The id of the template files to retrieve. * @param options */ @@ -946,6 +952,7 @@ export class TemplateApi { /** * Obtain a copy of the current documents specified by the `template_id` parameter. Returns a JSON object with a url to the file (PDFs only). If the files are currently being prepared, a status code of `409` will be returned instead. In this case please wait for the `template_created` callback event. * @summary Get Template Files as File Url + * Example: https://github.com/hellosign/dropbox-sign-node/blob/main/examples/TemplateFilesAsFileUrlExample.ts * @param templateId The id of the template files to retrieve. * @param forceDownload By default when opening the `file_url` a browser will download the PDF and save it locally. When set to `0` the PDF file will be displayed in the browser. * @param options @@ -1077,6 +1084,7 @@ export class TemplateApi { /** * Returns the Template specified by the `template_id` parameter. * @summary Get Template + * Example: https://github.com/hellosign/dropbox-sign-node/blob/main/examples/TemplateGetExample.ts * @param templateId The id of the Template to retrieve. * @param options */ @@ -1201,6 +1209,7 @@ export class TemplateApi { /** * Returns a list of the Templates that are accessible by you. Take a look at our [search guide](/api/reference/search/) to learn more about querying templates. * @summary List Templates + * Example: https://github.com/hellosign/dropbox-sign-node/blob/main/examples/TemplateListExample.ts * @param accountId Which account to return Templates for. Must be a team member. Use `all` to indicate all team members. Defaults to your account. * @param page Which page number of the Template List to return. Defaults to `1`. * @param pageSize Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. @@ -1347,6 +1356,7 @@ export class TemplateApi { /** * Removes the specified Account\'s access to the specified Template. * @summary Remove User from Template + * Example: https://github.com/hellosign/dropbox-sign-node/blob/main/examples/TemplateRemoveUserExample.ts * @param templateId The id of the Template to remove the Account\'s access to. * @param templateRemoveUserRequest * @param options @@ -1509,6 +1519,7 @@ export class TemplateApi { /** * Overlays a new file with the overlay of an existing template. The new file(s) must: 1. have the same or higher page count 2. the same orientation as the file(s) being replaced. This will not overwrite or in any way affect the existing template. Both the existing template and new template will be available for use after executing this endpoint. Also note that this will decrement your template quota. Overlaying new files is asynchronous and a successful call to this endpoint will return 200 OK response if the request passes initial validation checks. It is recommended that a callback be implemented to listen for the callback event. A `template_created` event will be sent when the files are updated or a `template_error` event will be sent if there was a problem while updating the files. If a callback handler has been configured and the event has not been received within 60 minutes of making the call, check the status of the request in the API dashboard and retry the request if necessary. If the page orientation or page count is different from the original template document, we will notify you with a `template_error` [callback event](https://app.hellosign.com/api/eventsAndCallbacksWalkthrough). * @summary Update Template Files + * Example: https://github.com/hellosign/dropbox-sign-node/blob/main/examples/TemplateUpdateFilesExample.ts * @param templateId The ID of the template whose files to update. * @param templateUpdateFilesRequest * @param options diff --git a/sdks/node/api/unclaimedDraftApi.ts b/sdks/node/api/unclaimedDraftApi.ts index c121d17bb..6fac772c1 100644 --- a/sdks/node/api/unclaimedDraftApi.ts +++ b/sdks/node/api/unclaimedDraftApi.ts @@ -122,6 +122,7 @@ export class UnclaimedDraftApi { /** * Creates a new Draft that can be claimed using the claim URL. The first authenticated user to access the URL will claim the Draft and will be shown either the \"Sign and send\" or the \"Request signature\" page with the Draft loaded. Subsequent access to the claim URL will result in a 404. * @summary Create Unclaimed Draft + * Example: https://github.com/hellosign/dropbox-sign-node/blob/main/examples/UnclaimedDraftCreateExample.ts * @param unclaimedDraftCreateRequest * @param options */ @@ -270,6 +271,7 @@ export class UnclaimedDraftApi { /** * Creates a new Draft that can be claimed and used in an embedded iFrame. The first authenticated user to access the URL will claim the Draft and will be shown the \"Request signature\" page with the Draft loaded. Subsequent access to the claim URL will result in a `404`. For this embedded endpoint the `requester_email_address` parameter is required. **NOTE:** Embedded unclaimed drafts can only be accessed in embedded iFrames whereas normal drafts can be used and accessed on Dropbox Sign. * @summary Create Embedded Unclaimed Draft + * Example: https://github.com/hellosign/dropbox-sign-node/blob/main/examples/UnclaimedDraftCreateEmbeddedExample.ts * @param unclaimedDraftCreateEmbeddedRequest * @param options */ @@ -418,6 +420,7 @@ export class UnclaimedDraftApi { /** * Creates a new Draft with a previously saved template(s) that can be claimed and used in an embedded iFrame. The first authenticated user to access the URL will claim the Draft and will be shown the \"Request signature\" page with the Draft loaded. Subsequent access to the claim URL will result in a `404`. For this embedded endpoint the `requester_email_address` parameter is required. **NOTE:** Embedded unclaimed drafts can only be accessed in embedded iFrames whereas normal drafts can be used and accessed on Dropbox Sign. * @summary Create Embedded Unclaimed Draft with Template + * Example: https://github.com/hellosign/dropbox-sign-node/blob/main/examples/UnclaimedDraftCreateEmbeddedWithTemplateExample.ts * @param unclaimedDraftCreateEmbeddedWithTemplateRequest * @param options */ @@ -567,6 +570,7 @@ export class UnclaimedDraftApi { /** * Creates a new signature request from an embedded request that can be edited prior to being sent to the recipients. Parameter `test_mode` can be edited prior to request. Signers can be edited in embedded editor. Requester\'s email address will remain unchanged if `requester_email_address` parameter is not set. **NOTE:** Embedded unclaimed drafts can only be accessed in embedded iFrames whereas normal drafts can be used and accessed on Dropbox Sign. * @summary Edit and Resend Unclaimed Draft + * Example: https://github.com/hellosign/dropbox-sign-node/blob/main/examples/UnclaimedDraftEditAndResendExample.ts * @param signatureRequestId The ID of the signature request to edit and resend. * @param unclaimedDraftEditAndResendRequest * @param options diff --git a/sdks/node/dist/api.js b/sdks/node/dist/api.js index a1419df7a..478b7291c 100644 --- a/sdks/node/dist/api.js +++ b/sdks/node/dist/api.js @@ -27136,6 +27136,7 @@ var AccountApi = class { /** * Creates a new Dropbox Sign Account that is associated with the specified `email_address`. * @summary Create Account + * Example: https://github.com/hellosign/dropbox-sign-node/blob/main/examples/AccountCreateExample.ts * @param accountCreateRequest * @param options */ @@ -27258,6 +27259,7 @@ var AccountApi = class { /** * Returns the properties and settings of your Account. * @summary Get Account + * Example: https://github.com/hellosign/dropbox-sign-node/blob/main/examples/AccountGetExample.ts * @param accountId `account_id` or `email_address` is required. If both are provided, the account id prevails. The ID of the Account. * @param emailAddress `account_id` or `email_address` is required, If both are provided, the account id prevails. The email address of the Account. * @param options @@ -27362,6 +27364,7 @@ var AccountApi = class { /** * Updates the properties and settings of your Account. Currently only allows for updates to the [Callback URL](/api/reference/tag/Callbacks-and-Events) and locale. * @summary Update Account + * Example: https://github.com/hellosign/dropbox-sign-node/blob/main/examples/AccountUpdateExample.ts * @param accountUpdateRequest * @param options */ @@ -27482,6 +27485,7 @@ var AccountApi = class { /** * Verifies whether an Dropbox Sign Account exists for the given email address. * @summary Verify Account + * Example: https://github.com/hellosign/dropbox-sign-node/blob/main/examples/AccountVerifyExample.ts * @param accountVerifyRequest * @param options */ @@ -27691,6 +27695,7 @@ var ApiAppApi = class { /** * Creates a new API App. * @summary Create API App + * Example: https://github.com/hellosign/dropbox-sign-node/blob/main/examples/ApiAppCreateExample.ts * @param apiAppCreateRequest * @param options */ @@ -27811,6 +27816,7 @@ var ApiAppApi = class { /** * Deletes an API App. Can only be invoked for apps you own. * @summary Delete API App + * Example: https://github.com/hellosign/dropbox-sign-node/blob/main/examples/ApiAppDeleteExample.ts * @param clientId The client id of the API App to delete. * @param options */ @@ -27897,6 +27903,7 @@ var ApiAppApi = class { /** * Returns an object with information about an API App. * @summary Get API App + * Example: https://github.com/hellosign/dropbox-sign-node/blob/main/examples/ApiAppGetExample.ts * @param clientId The client id of the API App to retrieve. * @param options */ @@ -27996,6 +28003,7 @@ var ApiAppApi = class { /** * Returns a list of API Apps that are accessible by you. If you are on a team with an Admin or Developer role, this list will include apps owned by teammates. * @summary List API Apps + * Example: https://github.com/hellosign/dropbox-sign-node/blob/main/examples/ApiAppListExample.ts * @param page Which page number of the API App List to return. Defaults to `1`. * @param pageSize Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. * @param options @@ -28100,6 +28108,7 @@ var ApiAppApi = class { /** * Updates an existing API App. Can only be invoked for apps you own. Only the fields you provide will be updated. If you wish to clear an existing optional field, provide an empty string. * @summary Update API App + * Example: https://github.com/hellosign/dropbox-sign-node/blob/main/examples/ApiAppUpdateExample.ts * @param clientId The client id of the API App to update. * @param apiAppUpdateRequest * @param options @@ -28316,6 +28325,7 @@ var BulkSendJobApi = class { /** * Returns the status of the BulkSendJob and its SignatureRequests specified by the `bulk_send_job_id` parameter. * @summary Get Bulk Send Job + * Example: https://github.com/hellosign/dropbox-sign-node/blob/main/examples/BulkSendJobGetExample.ts * @param bulkSendJobId The id of the BulkSendJob to retrieve. * @param page Which page number of the BulkSendJob list to return. Defaults to `1`. * @param pageSize Number of objects to be returned per page. Must be between `1` and `100`. Default is 20. @@ -28431,6 +28441,7 @@ var BulkSendJobApi = class { /** * Returns a list of BulkSendJob that you can access. * @summary List Bulk Send Jobs + * Example: https://github.com/hellosign/dropbox-sign-node/blob/main/examples/BulkSendJobListExample.ts * @param page Which page number of the BulkSendJob List to return. Defaults to `1`. * @param pageSize Number of objects to be returned per page. Must be between `1` and `100`. Default is 20. * @param options @@ -28618,6 +28629,7 @@ var EmbeddedApi = class { /** * Retrieves an embedded object containing a template url that can be opened in an iFrame. Note that only templates created via the embedded template process are available to be edited with this endpoint. * @summary Get Embedded Template Edit URL + * Example: https://github.com/hellosign/dropbox-sign-node/blob/main/examples/EmbeddedEditUrlExample.ts * @param templateId The id of the template to edit. * @param embeddedEditUrlRequest * @param options @@ -28749,6 +28761,7 @@ var EmbeddedApi = class { /** * Retrieves an embedded object containing a signature url that can be opened in an iFrame. Note that templates created via the embedded template process will only be accessible through the API. * @summary Get Embedded Sign URL + * Example: https://github.com/hellosign/dropbox-sign-node/blob/main/examples/EmbeddedSignUrlExample.ts * @param signatureId The id of the signature to get a signature url for. * @param options */ @@ -28937,6 +28950,7 @@ var FaxApi = class { /** * Deletes the specified Fax from the system * @summary Delete Fax + * Example: https://github.com/hellosign/dropbox-sign-node/blob/main/examples/FaxDeleteExample.ts * @param faxId Fax ID * @param options */ @@ -29018,6 +29032,7 @@ var FaxApi = class { /** * Downloads files associated with a Fax * @summary Download Fax Files + * Example: https://github.com/hellosign/dropbox-sign-node/blob/main/examples/FaxFilesExample.ts * @param faxId Fax ID * @param options */ @@ -29112,6 +29127,7 @@ var FaxApi = class { /** * Returns information about a Fax * @summary Get Fax + * Example: https://github.com/hellosign/dropbox-sign-node/blob/main/examples/FaxGetExample.ts * @param faxId Fax ID * @param options */ @@ -29206,6 +29222,7 @@ var FaxApi = class { /** * Returns properties of multiple Faxes * @summary Lists Faxes + * Example: https://github.com/hellosign/dropbox-sign-node/blob/main/examples/FaxListExample.ts * @param page Which page number of the Fax List to return. Defaults to `1`. * @param pageSize Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. * @param options @@ -29305,6 +29322,7 @@ var FaxApi = class { /** * Creates and sends a new Fax with the submitted file(s) * @summary Send Fax + * Example: https://github.com/hellosign/dropbox-sign-node/blob/main/examples/FaxSendExample.ts * @param faxSendRequest * @param options */ @@ -29501,6 +29519,7 @@ var FaxLineApi = class { /** * Grants a user access to the specified Fax Line. * @summary Add Fax Line User + * Example: https://github.com/hellosign/dropbox-sign-node/blob/main/examples/FaxLineAddUserExample.ts * @param faxLineAddUserRequest * @param options */ @@ -29616,6 +29635,7 @@ var FaxLineApi = class { /** * Returns a list of available area codes for a given state/province and city * @summary Get Available Fax Line Area Codes + * Example: https://github.com/hellosign/dropbox-sign-node/blob/main/examples/FaxLineAreaCodeGetExample.ts * @param country Filter area codes by country * @param state Filter area codes by state * @param province Filter area codes by province @@ -29736,6 +29756,7 @@ var FaxLineApi = class { /** * Purchases a new Fax Line * @summary Purchase Fax Line + * Example: https://github.com/hellosign/dropbox-sign-node/blob/main/examples/FaxLineCreateExample.ts * @param faxLineCreateRequest * @param options */ @@ -29851,6 +29872,7 @@ var FaxLineApi = class { /** * Deletes the specified Fax Line from the subscription. * @summary Delete Fax Line + * Example: https://github.com/hellosign/dropbox-sign-node/blob/main/examples/FaxLineDeleteExample.ts * @param faxLineDeleteRequest * @param options */ @@ -29953,6 +29975,7 @@ var FaxLineApi = class { /** * Returns the properties and settings of a Fax Line. * @summary Get Fax Line + * Example: https://github.com/hellosign/dropbox-sign-node/blob/main/examples/FaxLineGetExample.ts * @param number The Fax Line number * @param options */ @@ -30050,6 +30073,7 @@ var FaxLineApi = class { /** * Returns the properties and settings of multiple Fax Lines. * @summary List Fax Lines + * Example: https://github.com/hellosign/dropbox-sign-node/blob/main/examples/FaxLineListExample.ts * @param accountId Account ID * @param page Which page number of the Fax Line List to return. Defaults to `1`. * @param pageSize Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. @@ -30165,6 +30189,7 @@ var FaxLineApi = class { /** * Removes a user\'s access to the specified Fax Line * @summary Remove Fax Line Access + * Example: https://github.com/hellosign/dropbox-sign-node/blob/main/examples/FaxLineRemoveUserExample.ts * @param faxLineRemoveUserRequest * @param options */ @@ -30367,6 +30392,7 @@ var OAuthApi = class { /** * Once you have retrieved the code from the user callback, you will need to exchange it for an access token via a backend call. * @summary OAuth Token Generate + * Example: https://github.com/hellosign/dropbox-sign-node/blob/main/examples/OauthTokenGenerateExample.ts * @param oAuthTokenGenerateRequest * @param options */ @@ -30477,6 +30503,7 @@ var OAuthApi = class { /** * Access tokens are only valid for a given period of time (typically one hour) for security reasons. Whenever acquiring an new access token its TTL is also given (see `expires_in`), along with a refresh token that can be used to acquire a new access token after the current one has expired. * @summary OAuth Token Refresh + * Example: https://github.com/hellosign/dropbox-sign-node/blob/main/examples/OauthTokenRefreshExample.ts * @param oAuthTokenRefreshRequest * @param options */ @@ -30674,6 +30701,7 @@ var ReportApi = class { /** * Request the creation of one or more report(s). When the report(s) have been generated, you will receive an email (one per requested report type) containing a link to download the report as a CSV file. The requested date range may be up to 12 months in duration, and `start_date` must not be more than 10 years in the past. * @summary Create Report + * Example: https://github.com/hellosign/dropbox-sign-node/blob/main/examples/ReportCreateExample.ts * @param reportCreateRequest * @param options */ @@ -30878,6 +30906,7 @@ var SignatureRequestApi = class { /** * Creates BulkSendJob which sends up to 250 SignatureRequests in bulk based off of the provided Template(s) specified with the `template_ids` parameter to be signed in an embedded iFrame. These embedded signature requests can only be signed in embedded iFrames whereas normal signature requests can only be signed on Dropbox Sign. **NOTE:** Only available for Standard plan and higher. * @summary Embedded Bulk Send with Template + * Example: https://github.com/hellosign/dropbox-sign-node/blob/main/examples/SignatureRequestBulkCreateEmbeddedWithTemplateExample.ts * @param signatureRequestBulkCreateEmbeddedWithTemplateRequest * @param options */ @@ -30995,6 +31024,7 @@ var SignatureRequestApi = class { /** * Creates BulkSendJob which sends up to 250 SignatureRequests in bulk based off of the provided Template(s) specified with the `template_ids` parameter. **NOTE:** Only available for Standard plan and higher. * @summary Bulk Send with Template + * Example: https://github.com/hellosign/dropbox-sign-node/blob/main/examples/SignatureRequestBulkSendWithTemplateExample.ts * @param signatureRequestBulkSendWithTemplateRequest * @param options */ @@ -31117,6 +31147,7 @@ var SignatureRequestApi = class { /** * Cancels an incomplete signature request. This action is **not reversible**. The request will be canceled and signers will no longer be able to sign. If they try to access the signature request they will receive a HTTP 410 status code indicating that the resource has been deleted. Cancelation is asynchronous and a successful call to this endpoint will return an empty 200 OK response if the signature request is eligible to be canceled and has been successfully queued. This 200 OK response does not indicate a successful cancelation of the signature request itself. The cancelation is confirmed via the `signature_request_canceled` event. It is recommended that a [callback handler](/api/reference/tag/Callbacks-and-Events) be implemented to listen for the `signature_request_canceled` event. This callback will be sent only when the cancelation has completed successfully. If a callback handler has been configured and the event has not been received within 60 minutes of making the call, check the status of the request in the [API Dashboard](https://app.hellosign.com/apidashboard) and retry the cancelation if necessary. To be eligible for cancelation, a signature request must have been sent successfully, must not yet have been signed by all signers, and you must either be the sender or own the API app under which it was sent. A partially signed signature request can be canceled. **NOTE:** To remove your access to a completed signature request, use the endpoint: `POST /signature_request/remove/[:signature_request_id]`. * @summary Cancel Incomplete Signature Request + * Example: https://github.com/hellosign/dropbox-sign-node/blob/main/examples/SignatureRequestCancelExample.ts * @param signatureRequestId The id of the incomplete SignatureRequest to cancel. * @param options */ @@ -31203,6 +31234,7 @@ var SignatureRequestApi = class { /** * Creates a new SignatureRequest with the submitted documents to be signed in an embedded iFrame. If form_fields_per_document is not specified, a signature page will be affixed where all signers will be required to add their signature, signifying their agreement to all contained documents. Note that embedded signature requests can only be signed in embedded iFrames whereas normal signature requests can only be signed on Dropbox Sign. * @summary Create Embedded Signature Request + * Example: https://github.com/hellosign/dropbox-sign-node/blob/main/examples/SignatureRequestCreateEmbeddedExample.ts * @param signatureRequestCreateEmbeddedRequest * @param options */ @@ -31325,6 +31357,7 @@ var SignatureRequestApi = class { /** * Creates a new SignatureRequest based on the given Template(s) to be signed in an embedded iFrame. Note that embedded signature requests can only be signed in embedded iFrames whereas normal signature requests can only be signed on Dropbox Sign. * @summary Create Embedded Signature Request with Template + * Example: https://github.com/hellosign/dropbox-sign-node/blob/main/examples/SignatureRequestCreateEmbeddedWithTemplateExample.ts * @param signatureRequestCreateEmbeddedWithTemplateRequest * @param options */ @@ -31447,6 +31480,7 @@ var SignatureRequestApi = class { /** * Edits and sends a SignatureRequest with the submitted documents. If `form_fields_per_document` is not specified, a signature page will be affixed where all signers will be required to add their signature, signifying their agreement to all contained documents. **NOTE:** Edit and resend *will* deduct your signature request quota. * @summary Edit Signature Request + * Example: https://github.com/hellosign/dropbox-sign-node/blob/main/examples/SignatureRequestEditExample.ts * @param signatureRequestId The id of the SignatureRequest to edit. * @param signatureRequestEditRequest * @param options @@ -31578,6 +31612,7 @@ var SignatureRequestApi = class { /** * Edits a SignatureRequest with the submitted documents to be signed in an embedded iFrame. If form_fields_per_document is not specified, a signature page will be affixed where all signers will be required to add their signature, signifying their agreement to all contained documents. Note that embedded signature requests can only be signed in embedded iFrames whereas normal signature requests can only be signed on Dropbox Sign. **NOTE:** Edit and resend *will* deduct your signature request quota. * @summary Edit Embedded Signature Request + * Example: https://github.com/hellosign/dropbox-sign-node/blob/main/examples/SignatureRequestEditEmbeddedExample.ts * @param signatureRequestId The id of the SignatureRequest to edit. * @param signatureRequestEditEmbeddedRequest * @param options @@ -31709,6 +31744,7 @@ var SignatureRequestApi = class { /** * Edits a SignatureRequest based on the given Template(s) to be signed in an embedded iFrame. Note that embedded signature requests can only be signed in embedded iFrames whereas normal signature requests can only be signed on Dropbox Sign. **NOTE:** Edit and resend *will* deduct your signature request quota. * @summary Edit Embedded Signature Request with Template + * Example: https://github.com/hellosign/dropbox-sign-node/blob/main/examples/SignatureRequestEditEmbeddedWithTemplateExample.ts * @param signatureRequestId The id of the SignatureRequest to edit. * @param signatureRequestEditEmbeddedWithTemplateRequest * @param options @@ -31840,6 +31876,7 @@ var SignatureRequestApi = class { /** * Edits and sends a SignatureRequest based off of the Template(s) specified with the template_ids parameter. **NOTE:** Edit and resend *will* deduct your signature request quota. * @summary Edit Signature Request With Template + * Example: https://github.com/hellosign/dropbox-sign-node/blob/main/examples/SignatureRequestEditWithTemplateExample.ts * @param signatureRequestId The id of the SignatureRequest to edit. * @param signatureRequestEditWithTemplateRequest * @param options @@ -31971,6 +32008,7 @@ var SignatureRequestApi = class { /** * Obtain a copy of the current documents specified by the `signature_request_id` parameter. Returns a PDF or ZIP file. If the files are currently being prepared, a status code of `409` will be returned instead. * @summary Download Files + * Example: https://github.com/hellosign/dropbox-sign-node/blob/main/examples/SignatureRequestFilesExample.ts * @param signatureRequestId The id of the SignatureRequest to retrieve. * @param fileType Set to `pdf` for a single merged document or `zip` for a collection of individual documents. * @param options @@ -32077,6 +32115,7 @@ var SignatureRequestApi = class { /** * Obtain a copy of the current documents specified by the `signature_request_id` parameter. Returns a JSON object with a `data_uri` representing the base64 encoded file (PDFs only). If the files are currently being prepared, a status code of `409` will be returned instead. * @summary Download Files as Data Uri + * Example: https://github.com/hellosign/dropbox-sign-node/blob/main/examples/SignatureRequestFilesAsDataUriExample.ts * @param signatureRequestId The id of the SignatureRequest to retrieve. * @param options */ @@ -32178,6 +32217,7 @@ var SignatureRequestApi = class { /** * Obtain a copy of the current documents specified by the `signature_request_id` parameter. Returns a JSON object with a url to the file (PDFs only). If the files are currently being prepared, a status code of `409` will be returned instead. * @summary Download Files as File Url + * Example: https://github.com/hellosign/dropbox-sign-node/blob/main/examples/SignatureRequestFilesAsFileUrlExample.ts * @param signatureRequestId The id of the SignatureRequest to retrieve. * @param forceDownload By default when opening the `file_url` a browser will download the PDF and save it locally. When set to `0` the PDF file will be displayed in the browser. * @param options @@ -32284,6 +32324,7 @@ var SignatureRequestApi = class { /** * Returns the status of the SignatureRequest specified by the `signature_request_id` parameter. * @summary Get Signature Request + * Example: https://github.com/hellosign/dropbox-sign-node/blob/main/examples/SignatureRequestGetExample.ts * @param signatureRequestId The id of the SignatureRequest to retrieve. * @param options */ @@ -32385,6 +32426,7 @@ var SignatureRequestApi = class { /** * Returns a list of SignatureRequests that you can access. This includes SignatureRequests you have sent as well as received, but not ones that you have been CCed on. Take a look at our [search guide](/api/reference/search/) to learn more about querying signature requests. * @summary List Signature Requests + * Example: https://github.com/hellosign/dropbox-sign-node/blob/main/examples/SignatureRequestListExample.ts * @param accountId Which account to return SignatureRequests for. Must be a team member. Use `all` to indicate all team members. Defaults to your account. * @param page Which page number of the SignatureRequest List to return. Defaults to `1`. * @param pageSize Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. @@ -32505,6 +32547,7 @@ var SignatureRequestApi = class { /** * Releases a held SignatureRequest that was claimed and prepared from an [UnclaimedDraft](/api/reference/tag/Unclaimed-Draft). The owner of the Draft must indicate at Draft creation that the SignatureRequest created from the Draft should be held. Releasing the SignatureRequest will send requests to all signers. * @summary Release On-Hold Signature Request + * Example: https://github.com/hellosign/dropbox-sign-node/blob/main/examples/SignatureRequestReleaseHoldExample.ts * @param signatureRequestId The id of the SignatureRequest to release. * @param options */ @@ -32606,6 +32649,7 @@ var SignatureRequestApi = class { /** * Sends an email to the signer reminding them to sign the signature request. You cannot send a reminder within 1 hour of the last reminder that was sent. This includes manual AND automatic reminders. **NOTE:** This action can **not** be used with embedded signature requests. * @summary Send Request Reminder + * Example: https://github.com/hellosign/dropbox-sign-node/blob/main/examples/SignatureRequestRemindExample.ts * @param signatureRequestId The id of the SignatureRequest to send a reminder for. * @param signatureRequestRemindRequest * @param options @@ -32737,6 +32781,7 @@ var SignatureRequestApi = class { /** * Removes your access to a completed signature request. This action is **not reversible**. The signature request must be fully executed by all parties (signed or declined to sign). Other parties will continue to maintain access to the completed signature request document(s). Unlike /signature_request/cancel, this endpoint is synchronous and your access will be immediately removed. Upon successful removal, this endpoint will return a 200 OK response. * @summary Remove Signature Request Access + * Example: https://github.com/hellosign/dropbox-sign-node/blob/main/examples/SignatureRequestRemoveExample.ts * @param signatureRequestId The id of the SignatureRequest to remove. * @param options */ @@ -32818,6 +32863,7 @@ var SignatureRequestApi = class { /** * Creates and sends a new SignatureRequest with the submitted documents. If `form_fields_per_document` is not specified, a signature page will be affixed where all signers will be required to add their signature, signifying their agreement to all contained documents. * @summary Send Signature Request + * Example: https://github.com/hellosign/dropbox-sign-node/blob/main/examples/SignatureRequestSendExample.ts * @param signatureRequestSendRequest * @param options */ @@ -32940,6 +32986,7 @@ var SignatureRequestApi = class { /** * Creates and sends a new SignatureRequest based off of the Template(s) specified with the `template_ids` parameter. * @summary Send with Template + * Example: https://github.com/hellosign/dropbox-sign-node/blob/main/examples/SignatureRequestSendWithTemplateExample.ts * @param signatureRequestSendWithTemplateRequest * @param options */ @@ -33062,6 +33109,7 @@ var SignatureRequestApi = class { /** * Updates the email address and/or the name for a given signer on a signature request. You can listen for the `signature_request_email_bounce` event on your app or account to detect bounced emails, and respond with this method. Updating the email address of a signer will generate a new `signature_id` value. **NOTE:** This action cannot be performed on a signature request with an appended signature page. * @summary Update Signature Request + * Example: https://github.com/hellosign/dropbox-sign-node/blob/main/examples/SignatureRequestUpdateExample.ts * @param signatureRequestId The id of the SignatureRequest to update. * @param signatureRequestUpdateRequest * @param options @@ -33280,6 +33328,7 @@ var TeamApi = class { /** * Invites a user (specified using the `email_address` parameter) to your Team. If the user does not currently have a Dropbox Sign Account, a new one will be created for them. If a user is already a part of another Team, a `team_invite_failed` error will be returned. * @summary Add User to Team + * Example: https://github.com/hellosign/dropbox-sign-node/blob/main/examples/TeamAddMemberExample.ts * @param teamAddMemberRequest * @param teamId The id of the team. * @param options @@ -33407,6 +33456,7 @@ var TeamApi = class { /** * Creates a new Team and makes you a member. You must not currently belong to a Team to invoke. * @summary Create Team + * Example: https://github.com/hellosign/dropbox-sign-node/blob/main/examples/TeamCreateExample.ts * @param teamCreateRequest * @param options */ @@ -33524,6 +33574,7 @@ var TeamApi = class { /** * Deletes your Team. Can only be invoked when you have a Team with only one member (yourself). * @summary Delete Team + * Example: https://github.com/hellosign/dropbox-sign-node/blob/main/examples/TeamDeleteExample.ts * @param options */ async teamDelete(options = { headers: {} }) { @@ -33601,6 +33652,7 @@ var TeamApi = class { /** * Returns information about your Team as well as a list of its members. If you do not belong to a Team, a 404 error with an error_name of \"not_found\" will be returned. * @summary Get Team + * Example: https://github.com/hellosign/dropbox-sign-node/blob/main/examples/TeamGetExample.ts * @param options */ async teamGet(options = { headers: {} }) { @@ -33691,6 +33743,7 @@ var TeamApi = class { /** * Provides information about a team. * @summary Get Team Info + * Example: https://github.com/hellosign/dropbox-sign-node/blob/main/examples/TeamInfoExample.ts * @param teamId The id of the team. * @param options */ @@ -33790,6 +33843,7 @@ var TeamApi = class { /** * Provides a list of team invites (and their roles). * @summary List Team Invites + * Example: https://github.com/hellosign/dropbox-sign-node/blob/main/examples/TeamInvitesExample.ts * @param emailAddress The email address for which to display the team invites. * @param options */ @@ -33889,6 +33943,7 @@ var TeamApi = class { /** * Provides a paginated list of members (and their roles) that belong to a given team. * @summary List Team Members + * Example: https://github.com/hellosign/dropbox-sign-node/blob/main/examples/TeamMembersExample.ts * @param teamId The id of the team that a member list is being requested from. * @param page Which page number of the team member list to return. Defaults to `1`. * @param pageSize Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. @@ -34004,6 +34059,7 @@ var TeamApi = class { /** * Removes the provided user Account from your Team. If the Account had an outstanding invitation to your Team, the invitation will be expired. If you choose to transfer documents from the removed Account to an Account provided in the `new_owner_email_address` parameter (available only for Enterprise plans), the response status code will be 201, which indicates that your request has been queued but not fully executed. * @summary Remove User from Team + * Example: https://github.com/hellosign/dropbox-sign-node/blob/main/examples/TeamRemoveMemberExample.ts * @param teamRemoveMemberRequest * @param options */ @@ -34124,6 +34180,7 @@ var TeamApi = class { /** * Provides a paginated list of sub teams that belong to a given team. * @summary List Sub Teams + * Example: https://github.com/hellosign/dropbox-sign-node/blob/main/examples/TeamSubTeamsExample.ts * @param teamId The id of the parent Team. * @param page Which page number of the SubTeam List to return. Defaults to `1`. * @param pageSize Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. @@ -34239,6 +34296,7 @@ var TeamApi = class { /** * Updates the name of your Team. * @summary Update Team + * Example: https://github.com/hellosign/dropbox-sign-node/blob/main/examples/TeamUpdateExample.ts * @param teamUpdateRequest * @param options */ @@ -34443,6 +34501,7 @@ var TemplateApi = class { /** * Gives the specified Account access to the specified Template. The specified Account must be a part of your Team. * @summary Add User to Template + * Example: https://github.com/hellosign/dropbox-sign-node/blob/main/examples/TemplateAddUserExample.ts * @param templateId The id of the Template to give the Account access to. * @param templateAddUserRequest * @param options @@ -34574,6 +34633,7 @@ var TemplateApi = class { /** * Creates a template that can be used in future signature requests. If `client_id` is provided, the template will be created as an embedded template. Embedded templates can be used for embedded signature requests and can be edited later by generating a new `edit_url` with [/embedded/edit_url/{template_id}](/api/reference/operation/embeddedEditUrl/). Template creation may complete asynchronously after the initial request is accepted. It is recommended that a callback be implemented to listen for the callback event. A `template_created` event indicates the template is ready to use, while a `template_error` event indicates there was a problem while creating the template. If a callback handler has been configured and the event has not been received within 60 minutes of making the call, check the status of the request in the API dashboard and retry the request if necessary. * @summary Create Template + * Example: https://github.com/hellosign/dropbox-sign-node/blob/main/examples/TemplateCreateExample.ts * @param templateCreateRequest * @param options */ @@ -34696,6 +34756,7 @@ var TemplateApi = class { /** * The first step in an embedded template workflow. Creates a draft template that can then be further set up in the template \'edit\' stage. * @summary Create Embedded Template Draft + * Example: https://github.com/hellosign/dropbox-sign-node/blob/main/examples/TemplateCreateEmbeddedDraftExample.ts * @param templateCreateEmbeddedDraftRequest * @param options */ @@ -34818,6 +34879,7 @@ var TemplateApi = class { /** * Completely deletes the template specified from the account. * @summary Delete Template + * Example: https://github.com/hellosign/dropbox-sign-node/blob/main/examples/TemplateDeleteExample.ts * @param templateId The id of the Template to delete. * @param options */ @@ -34904,6 +34966,7 @@ var TemplateApi = class { /** * Obtain a copy of the current documents specified by the `template_id` parameter. Returns a PDF or ZIP file. If the files are currently being prepared, a status code of `409` will be returned instead. In this case please wait for the `template_created` callback event. * @summary Get Template Files + * Example: https://github.com/hellosign/dropbox-sign-node/blob/main/examples/TemplateFilesExample.ts * @param templateId The id of the template files to retrieve. * @param fileType Set to `pdf` for a single merged document or `zip` for a collection of individual documents. * @param options @@ -35010,6 +35073,7 @@ var TemplateApi = class { /** * Obtain a copy of the current documents specified by the `template_id` parameter. Returns a JSON object with a `data_uri` representing the base64 encoded file (PDFs only). If the files are currently being prepared, a status code of `409` will be returned instead. In this case please wait for the `template_created` callback event. * @summary Get Template Files as Data Uri + * Example: https://github.com/hellosign/dropbox-sign-node/blob/main/examples/TemplateFilesAsDataUriExample.ts * @param templateId The id of the template files to retrieve. * @param options */ @@ -35111,6 +35175,7 @@ var TemplateApi = class { /** * Obtain a copy of the current documents specified by the `template_id` parameter. Returns a JSON object with a url to the file (PDFs only). If the files are currently being prepared, a status code of `409` will be returned instead. In this case please wait for the `template_created` callback event. * @summary Get Template Files as File Url + * Example: https://github.com/hellosign/dropbox-sign-node/blob/main/examples/TemplateFilesAsFileUrlExample.ts * @param templateId The id of the template files to retrieve. * @param forceDownload By default when opening the `file_url` a browser will download the PDF and save it locally. When set to `0` the PDF file will be displayed in the browser. * @param options @@ -35217,6 +35282,7 @@ var TemplateApi = class { /** * Returns the Template specified by the `template_id` parameter. * @summary Get Template + * Example: https://github.com/hellosign/dropbox-sign-node/blob/main/examples/TemplateGetExample.ts * @param templateId The id of the Template to retrieve. * @param options */ @@ -35318,6 +35384,7 @@ var TemplateApi = class { /** * Returns a list of the Templates that are accessible by you. Take a look at our [search guide](/api/reference/search/) to learn more about querying templates. * @summary List Templates + * Example: https://github.com/hellosign/dropbox-sign-node/blob/main/examples/TemplateListExample.ts * @param accountId Which account to return Templates for. Must be a team member. Use `all` to indicate all team members. Defaults to your account. * @param page Which page number of the Template List to return. Defaults to `1`. * @param pageSize Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. @@ -35438,6 +35505,7 @@ var TemplateApi = class { /** * Removes the specified Account\'s access to the specified Template. * @summary Remove User from Template + * Example: https://github.com/hellosign/dropbox-sign-node/blob/main/examples/TemplateRemoveUserExample.ts * @param templateId The id of the Template to remove the Account\'s access to. * @param templateRemoveUserRequest * @param options @@ -35569,6 +35637,7 @@ var TemplateApi = class { /** * Overlays a new file with the overlay of an existing template. The new file(s) must: 1. have the same or higher page count 2. the same orientation as the file(s) being replaced. This will not overwrite or in any way affect the existing template. Both the existing template and new template will be available for use after executing this endpoint. Also note that this will decrement your template quota. Overlaying new files is asynchronous and a successful call to this endpoint will return 200 OK response if the request passes initial validation checks. It is recommended that a callback be implemented to listen for the callback event. A `template_created` event will be sent when the files are updated or a `template_error` event will be sent if there was a problem while updating the files. If a callback handler has been configured and the event has not been received within 60 minutes of making the call, check the status of the request in the API dashboard and retry the request if necessary. If the page orientation or page count is different from the original template document, we will notify you with a `template_error` [callback event](https://app.hellosign.com/api/eventsAndCallbacksWalkthrough). * @summary Update Template Files + * Example: https://github.com/hellosign/dropbox-sign-node/blob/main/examples/TemplateUpdateFilesExample.ts * @param templateId The ID of the template whose files to update. * @param templateUpdateFilesRequest * @param options @@ -35787,6 +35856,7 @@ var UnclaimedDraftApi = class { /** * Creates a new Draft that can be claimed using the claim URL. The first authenticated user to access the URL will claim the Draft and will be shown either the \"Sign and send\" or the \"Request signature\" page with the Draft loaded. Subsequent access to the claim URL will result in a 404. * @summary Create Unclaimed Draft + * Example: https://github.com/hellosign/dropbox-sign-node/blob/main/examples/UnclaimedDraftCreateExample.ts * @param unclaimedDraftCreateRequest * @param options */ @@ -35909,6 +35979,7 @@ var UnclaimedDraftApi = class { /** * Creates a new Draft that can be claimed and used in an embedded iFrame. The first authenticated user to access the URL will claim the Draft and will be shown the \"Request signature\" page with the Draft loaded. Subsequent access to the claim URL will result in a `404`. For this embedded endpoint the `requester_email_address` parameter is required. **NOTE:** Embedded unclaimed drafts can only be accessed in embedded iFrames whereas normal drafts can be used and accessed on Dropbox Sign. * @summary Create Embedded Unclaimed Draft + * Example: https://github.com/hellosign/dropbox-sign-node/blob/main/examples/UnclaimedDraftCreateEmbeddedExample.ts * @param unclaimedDraftCreateEmbeddedRequest * @param options */ @@ -36031,6 +36102,7 @@ var UnclaimedDraftApi = class { /** * Creates a new Draft with a previously saved template(s) that can be claimed and used in an embedded iFrame. The first authenticated user to access the URL will claim the Draft and will be shown the \"Request signature\" page with the Draft loaded. Subsequent access to the claim URL will result in a `404`. For this embedded endpoint the `requester_email_address` parameter is required. **NOTE:** Embedded unclaimed drafts can only be accessed in embedded iFrames whereas normal drafts can be used and accessed on Dropbox Sign. * @summary Create Embedded Unclaimed Draft with Template + * Example: https://github.com/hellosign/dropbox-sign-node/blob/main/examples/UnclaimedDraftCreateEmbeddedWithTemplateExample.ts * @param unclaimedDraftCreateEmbeddedWithTemplateRequest * @param options */ @@ -36153,6 +36225,7 @@ var UnclaimedDraftApi = class { /** * Creates a new signature request from an embedded request that can be edited prior to being sent to the recipients. Parameter `test_mode` can be edited prior to request. Signers can be edited in embedded editor. Requester\'s email address will remain unchanged if `requester_email_address` parameter is not set. **NOTE:** Embedded unclaimed drafts can only be accessed in embedded iFrames whereas normal drafts can be used and accessed on Dropbox Sign. * @summary Edit and Resend Unclaimed Draft + * Example: https://github.com/hellosign/dropbox-sign-node/blob/main/examples/UnclaimedDraftEditAndResendExample.ts * @param signatureRequestId The ID of the signature request to edit and resend. * @param unclaimedDraftEditAndResendRequest * @param options diff --git a/sdks/node/templates/api-single.mustache b/sdks/node/templates/api-single.mustache index da9213701..ef38b1f15 100644 --- a/sdks/node/templates/api-single.mustache +++ b/sdks/node/templates/api-single.mustache @@ -198,6 +198,7 @@ export class {{classname}} { {{#summary}} * @summary {{&summary}} {{/summary}} + * Example: https://github.com/hellosign/dropbox-sign-node/blob/main/examples/{{operationIdCamelCase}}Example.ts {{#allParams}} * @param {{paramName}} {{description}} {{/allParams}} diff --git a/sdks/php/src/Api/AccountApi.php b/sdks/php/src/Api/AccountApi.php index 700b22166..81a201bd4 100644 --- a/sdks/php/src/Api/AccountApi.php +++ b/sdks/php/src/Api/AccountApi.php @@ -142,6 +142,8 @@ public function getResponse() * * Create Account * + * Example: https://github.com/hellosign/dropbox-sign-php/blob/main/examples/AccountCreateExample.php + * * @param Model\AccountCreateRequest $account_create_request account_create_request (required) * * @return Model\AccountCreateResponse @@ -159,6 +161,8 @@ public function accountCreate(Model\AccountCreateRequest $account_create_request * * Create Account * + * Example: https://github.com/hellosign/dropbox-sign-php/blob/main/examples/AccountCreateExample.php + * * @param Model\AccountCreateRequest $account_create_request (required) * @param string $contentType The value for the Content-Type header. Check self::contentTypes['accountCreate'] to see the possible values for this operation * @@ -296,6 +300,8 @@ public function accountCreateWithHttpInfo(Model\AccountCreateRequest $account_cr * * Create Account * + * Example: https://github.com/hellosign/dropbox-sign-php/blob/main/examples/AccountCreateExample.php + * * @param Model\AccountCreateRequest $account_create_request (required) * @param string $contentType The value for the Content-Type header. Check self::contentTypes['accountCreate'] to see the possible values for this operation * @@ -318,6 +324,8 @@ function ($response) { * * Create Account * + * Example: https://github.com/hellosign/dropbox-sign-php/blob/main/examples/AccountCreateExample.php + * * @param Model\AccountCreateRequest $account_create_request (required) * @param string $contentType The value for the Content-Type header. Check self::contentTypes['accountCreate'] to see the possible values for this operation * @@ -481,6 +489,8 @@ public function accountCreateRequest(Model\AccountCreateRequest $account_create_ * * Get Account * + * Example: https://github.com/hellosign/dropbox-sign-php/blob/main/examples/AccountGetExample.php + * * @param string|null $account_id `account_id` or `email_address` is required. If both are provided, the account id prevails. The ID of the Account. (optional) * @param string|null $email_address `account_id` or `email_address` is required, If both are provided, the account id prevails. The email address of the Account. (optional) * @@ -499,6 +509,8 @@ public function accountGet(?string $account_id = null, ?string $email_address = * * Get Account * + * Example: https://github.com/hellosign/dropbox-sign-php/blob/main/examples/AccountGetExample.php + * * @param string|null $account_id `account_id` or `email_address` is required. If both are provided, the account id prevails. The ID of the Account. (optional) * @param string|null $email_address `account_id` or `email_address` is required, If both are provided, the account id prevails. The email address of the Account. (optional) * @param string $contentType The value for the Content-Type header. Check self::contentTypes['accountGet'] to see the possible values for this operation @@ -637,6 +649,8 @@ public function accountGetWithHttpInfo(?string $account_id = null, ?string $emai * * Get Account * + * Example: https://github.com/hellosign/dropbox-sign-php/blob/main/examples/AccountGetExample.php + * * @param string|null $account_id `account_id` or `email_address` is required. If both are provided, the account id prevails. The ID of the Account. (optional) * @param string|null $email_address `account_id` or `email_address` is required, If both are provided, the account id prevails. The email address of the Account. (optional) * @param string $contentType The value for the Content-Type header. Check self::contentTypes['accountGet'] to see the possible values for this operation @@ -660,6 +674,8 @@ function ($response) { * * Get Account * + * Example: https://github.com/hellosign/dropbox-sign-php/blob/main/examples/AccountGetExample.php + * * @param string|null $account_id `account_id` or `email_address` is required. If both are provided, the account id prevails. The ID of the Account. (optional) * @param string|null $email_address `account_id` or `email_address` is required, If both are provided, the account id prevails. The email address of the Account. (optional) * @param string $contentType The value for the Content-Type header. Check self::contentTypes['accountGet'] to see the possible values for this operation @@ -821,6 +837,8 @@ public function accountGetRequest(?string $account_id = null, ?string $email_add * * Update Account * + * Example: https://github.com/hellosign/dropbox-sign-php/blob/main/examples/AccountUpdateExample.php + * * @param Model\AccountUpdateRequest $account_update_request account_update_request (required) * * @return Model\AccountGetResponse @@ -838,6 +856,8 @@ public function accountUpdate(Model\AccountUpdateRequest $account_update_request * * Update Account * + * Example: https://github.com/hellosign/dropbox-sign-php/blob/main/examples/AccountUpdateExample.php + * * @param Model\AccountUpdateRequest $account_update_request (required) * @param string $contentType The value for the Content-Type header. Check self::contentTypes['accountUpdate'] to see the possible values for this operation * @@ -975,6 +995,8 @@ public function accountUpdateWithHttpInfo(Model\AccountUpdateRequest $account_up * * Update Account * + * Example: https://github.com/hellosign/dropbox-sign-php/blob/main/examples/AccountUpdateExample.php + * * @param Model\AccountUpdateRequest $account_update_request (required) * @param string $contentType The value for the Content-Type header. Check self::contentTypes['accountUpdate'] to see the possible values for this operation * @@ -997,6 +1019,8 @@ function ($response) { * * Update Account * + * Example: https://github.com/hellosign/dropbox-sign-php/blob/main/examples/AccountUpdateExample.php + * * @param Model\AccountUpdateRequest $account_update_request (required) * @param string $contentType The value for the Content-Type header. Check self::contentTypes['accountUpdate'] to see the possible values for this operation * @@ -1160,6 +1184,8 @@ public function accountUpdateRequest(Model\AccountUpdateRequest $account_update_ * * Verify Account * + * Example: https://github.com/hellosign/dropbox-sign-php/blob/main/examples/AccountVerifyExample.php + * * @param Model\AccountVerifyRequest $account_verify_request account_verify_request (required) * * @return Model\AccountVerifyResponse @@ -1177,6 +1203,8 @@ public function accountVerify(Model\AccountVerifyRequest $account_verify_request * * Verify Account * + * Example: https://github.com/hellosign/dropbox-sign-php/blob/main/examples/AccountVerifyExample.php + * * @param Model\AccountVerifyRequest $account_verify_request (required) * @param string $contentType The value for the Content-Type header. Check self::contentTypes['accountVerify'] to see the possible values for this operation * @@ -1314,6 +1342,8 @@ public function accountVerifyWithHttpInfo(Model\AccountVerifyRequest $account_ve * * Verify Account * + * Example: https://github.com/hellosign/dropbox-sign-php/blob/main/examples/AccountVerifyExample.php + * * @param Model\AccountVerifyRequest $account_verify_request (required) * @param string $contentType The value for the Content-Type header. Check self::contentTypes['accountVerify'] to see the possible values for this operation * @@ -1336,6 +1366,8 @@ function ($response) { * * Verify Account * + * Example: https://github.com/hellosign/dropbox-sign-php/blob/main/examples/AccountVerifyExample.php + * * @param Model\AccountVerifyRequest $account_verify_request (required) * @param string $contentType The value for the Content-Type header. Check self::contentTypes['accountVerify'] to see the possible values for this operation * diff --git a/sdks/php/src/Api/ApiAppApi.php b/sdks/php/src/Api/ApiAppApi.php index 95b80a91a..16c1a3617 100644 --- a/sdks/php/src/Api/ApiAppApi.php +++ b/sdks/php/src/Api/ApiAppApi.php @@ -147,6 +147,8 @@ public function getResponse() * * Create API App * + * Example: https://github.com/hellosign/dropbox-sign-php/blob/main/examples/ApiAppCreateExample.php + * * @param Model\ApiAppCreateRequest $api_app_create_request api_app_create_request (required) * * @return Model\ApiAppGetResponse @@ -164,6 +166,8 @@ public function apiAppCreate(Model\ApiAppCreateRequest $api_app_create_request) * * Create API App * + * Example: https://github.com/hellosign/dropbox-sign-php/blob/main/examples/ApiAppCreateExample.php + * * @param Model\ApiAppCreateRequest $api_app_create_request (required) * @param string $contentType The value for the Content-Type header. Check self::contentTypes['apiAppCreate'] to see the possible values for this operation * @@ -301,6 +305,8 @@ public function apiAppCreateWithHttpInfo(Model\ApiAppCreateRequest $api_app_crea * * Create API App * + * Example: https://github.com/hellosign/dropbox-sign-php/blob/main/examples/ApiAppCreateExample.php + * * @param Model\ApiAppCreateRequest $api_app_create_request (required) * @param string $contentType The value for the Content-Type header. Check self::contentTypes['apiAppCreate'] to see the possible values for this operation * @@ -323,6 +329,8 @@ function ($response) { * * Create API App * + * Example: https://github.com/hellosign/dropbox-sign-php/blob/main/examples/ApiAppCreateExample.php + * * @param Model\ApiAppCreateRequest $api_app_create_request (required) * @param string $contentType The value for the Content-Type header. Check self::contentTypes['apiAppCreate'] to see the possible values for this operation * @@ -486,6 +494,8 @@ public function apiAppCreateRequest(Model\ApiAppCreateRequest $api_app_create_re * * Delete API App * + * Example: https://github.com/hellosign/dropbox-sign-php/blob/main/examples/ApiAppDeleteExample.php + * * @param string $client_id The client id of the API App to delete. (required) * * @throws ApiException on non-2xx response or if the response body is not in the expected format @@ -501,6 +511,8 @@ public function apiAppDelete(string $client_id) * * Delete API App * + * Example: https://github.com/hellosign/dropbox-sign-php/blob/main/examples/ApiAppDeleteExample.php + * * @param string $client_id The client id of the API App to delete. (required) * @param string $contentType The value for the Content-Type header. Check self::contentTypes['apiAppDelete'] to see the possible values for this operation * @@ -552,6 +564,8 @@ public function apiAppDeleteWithHttpInfo(string $client_id, string $contentType * * Delete API App * + * Example: https://github.com/hellosign/dropbox-sign-php/blob/main/examples/ApiAppDeleteExample.php + * * @param string $client_id The client id of the API App to delete. (required) * @param string $contentType The value for the Content-Type header. Check self::contentTypes['apiAppDelete'] to see the possible values for this operation * @@ -574,6 +588,8 @@ function ($response) { * * Delete API App * + * Example: https://github.com/hellosign/dropbox-sign-php/blob/main/examples/ApiAppDeleteExample.php + * * @param string $client_id The client id of the API App to delete. (required) * @param string $contentType The value for the Content-Type header. Check self::contentTypes['apiAppDelete'] to see the possible values for this operation * @@ -717,6 +733,8 @@ public function apiAppDeleteRequest(string $client_id, string $contentType = sel * * Get API App * + * Example: https://github.com/hellosign/dropbox-sign-php/blob/main/examples/ApiAppGetExample.php + * * @param string $client_id The client id of the API App to retrieve. (required) * * @return Model\ApiAppGetResponse @@ -734,6 +752,8 @@ public function apiAppGet(string $client_id) * * Get API App * + * Example: https://github.com/hellosign/dropbox-sign-php/blob/main/examples/ApiAppGetExample.php + * * @param string $client_id The client id of the API App to retrieve. (required) * @param string $contentType The value for the Content-Type header. Check self::contentTypes['apiAppGet'] to see the possible values for this operation * @@ -871,6 +891,8 @@ public function apiAppGetWithHttpInfo(string $client_id, string $contentType = s * * Get API App * + * Example: https://github.com/hellosign/dropbox-sign-php/blob/main/examples/ApiAppGetExample.php + * * @param string $client_id The client id of the API App to retrieve. (required) * @param string $contentType The value for the Content-Type header. Check self::contentTypes['apiAppGet'] to see the possible values for this operation * @@ -893,6 +915,8 @@ function ($response) { * * Get API App * + * Example: https://github.com/hellosign/dropbox-sign-php/blob/main/examples/ApiAppGetExample.php + * * @param string $client_id The client id of the API App to retrieve. (required) * @param string $contentType The value for the Content-Type header. Check self::contentTypes['apiAppGet'] to see the possible values for this operation * @@ -1049,6 +1073,8 @@ public function apiAppGetRequest(string $client_id, string $contentType = self:: * * List API Apps * + * Example: https://github.com/hellosign/dropbox-sign-php/blob/main/examples/ApiAppListExample.php + * * @param int|null $page Which page number of the API App List to return. Defaults to `1`. (optional, default to 1) * @param int|null $page_size Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. (optional, default to 20) * @@ -1067,6 +1093,8 @@ public function apiAppList(?int $page = 1, ?int $page_size = 20) * * List API Apps * + * Example: https://github.com/hellosign/dropbox-sign-php/blob/main/examples/ApiAppListExample.php + * * @param int|null $page Which page number of the API App List to return. Defaults to `1`. (optional, default to 1) * @param int|null $page_size Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. (optional, default to 20) * @param string $contentType The value for the Content-Type header. Check self::contentTypes['apiAppList'] to see the possible values for this operation @@ -1205,6 +1233,8 @@ public function apiAppListWithHttpInfo(?int $page = 1, ?int $page_size = 20, str * * List API Apps * + * Example: https://github.com/hellosign/dropbox-sign-php/blob/main/examples/ApiAppListExample.php + * * @param int|null $page Which page number of the API App List to return. Defaults to `1`. (optional, default to 1) * @param int|null $page_size Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. (optional, default to 20) * @param string $contentType The value for the Content-Type header. Check self::contentTypes['apiAppList'] to see the possible values for this operation @@ -1228,6 +1258,8 @@ function ($response) { * * List API Apps * + * Example: https://github.com/hellosign/dropbox-sign-php/blob/main/examples/ApiAppListExample.php + * * @param int|null $page Which page number of the API App List to return. Defaults to `1`. (optional, default to 1) * @param int|null $page_size Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. (optional, default to 20) * @param string $contentType The value for the Content-Type header. Check self::contentTypes['apiAppList'] to see the possible values for this operation @@ -1389,6 +1421,8 @@ public function apiAppListRequest(?int $page = 1, ?int $page_size = 20, string $ * * Update API App * + * Example: https://github.com/hellosign/dropbox-sign-php/blob/main/examples/ApiAppUpdateExample.php + * * @param string $client_id The client id of the API App to update. (required) * @param Model\ApiAppUpdateRequest $api_app_update_request api_app_update_request (required) * @@ -1407,6 +1441,8 @@ public function apiAppUpdate(string $client_id, Model\ApiAppUpdateRequest $api_a * * Update API App * + * Example: https://github.com/hellosign/dropbox-sign-php/blob/main/examples/ApiAppUpdateExample.php + * * @param string $client_id The client id of the API App to update. (required) * @param Model\ApiAppUpdateRequest $api_app_update_request (required) * @param string $contentType The value for the Content-Type header. Check self::contentTypes['apiAppUpdate'] to see the possible values for this operation @@ -1545,6 +1581,8 @@ public function apiAppUpdateWithHttpInfo(string $client_id, Model\ApiAppUpdateRe * * Update API App * + * Example: https://github.com/hellosign/dropbox-sign-php/blob/main/examples/ApiAppUpdateExample.php + * * @param string $client_id The client id of the API App to update. (required) * @param Model\ApiAppUpdateRequest $api_app_update_request (required) * @param string $contentType The value for the Content-Type header. Check self::contentTypes['apiAppUpdate'] to see the possible values for this operation @@ -1568,6 +1606,8 @@ function ($response) { * * Update API App * + * Example: https://github.com/hellosign/dropbox-sign-php/blob/main/examples/ApiAppUpdateExample.php + * * @param string $client_id The client id of the API App to update. (required) * @param Model\ApiAppUpdateRequest $api_app_update_request (required) * @param string $contentType The value for the Content-Type header. Check self::contentTypes['apiAppUpdate'] to see the possible values for this operation diff --git a/sdks/php/src/Api/BulkSendJobApi.php b/sdks/php/src/Api/BulkSendJobApi.php index 3c6bb7e79..188e57a27 100644 --- a/sdks/php/src/Api/BulkSendJobApi.php +++ b/sdks/php/src/Api/BulkSendJobApi.php @@ -136,6 +136,8 @@ public function getResponse() * * Get Bulk Send Job * + * Example: https://github.com/hellosign/dropbox-sign-php/blob/main/examples/BulkSendJobGetExample.php + * * @param string $bulk_send_job_id The id of the BulkSendJob to retrieve. (required) * @param int|null $page Which page number of the BulkSendJob list to return. Defaults to `1`. (optional, default to 1) * @param int|null $page_size Number of objects to be returned per page. Must be between `1` and `100`. Default is 20. (optional, default to 20) @@ -155,6 +157,8 @@ public function bulkSendJobGet(string $bulk_send_job_id, ?int $page = 1, ?int $p * * Get Bulk Send Job * + * Example: https://github.com/hellosign/dropbox-sign-php/blob/main/examples/BulkSendJobGetExample.php + * * @param string $bulk_send_job_id The id of the BulkSendJob to retrieve. (required) * @param int|null $page Which page number of the BulkSendJob list to return. Defaults to `1`. (optional, default to 1) * @param int|null $page_size Number of objects to be returned per page. Must be between `1` and `100`. Default is 20. (optional, default to 20) @@ -294,6 +298,8 @@ public function bulkSendJobGetWithHttpInfo(string $bulk_send_job_id, ?int $page * * Get Bulk Send Job * + * Example: https://github.com/hellosign/dropbox-sign-php/blob/main/examples/BulkSendJobGetExample.php + * * @param string $bulk_send_job_id The id of the BulkSendJob to retrieve. (required) * @param int|null $page Which page number of the BulkSendJob list to return. Defaults to `1`. (optional, default to 1) * @param int|null $page_size Number of objects to be returned per page. Must be between `1` and `100`. Default is 20. (optional, default to 20) @@ -318,6 +324,8 @@ function ($response) { * * Get Bulk Send Job * + * Example: https://github.com/hellosign/dropbox-sign-php/blob/main/examples/BulkSendJobGetExample.php + * * @param string $bulk_send_job_id The id of the BulkSendJob to retrieve. (required) * @param int|null $page Which page number of the BulkSendJob list to return. Defaults to `1`. (optional, default to 1) * @param int|null $page_size Number of objects to be returned per page. Must be between `1` and `100`. Default is 20. (optional, default to 20) @@ -497,6 +505,8 @@ public function bulkSendJobGetRequest(string $bulk_send_job_id, ?int $page = 1, * * List Bulk Send Jobs * + * Example: https://github.com/hellosign/dropbox-sign-php/blob/main/examples/BulkSendJobListExample.php + * * @param int|null $page Which page number of the BulkSendJob List to return. Defaults to `1`. (optional, default to 1) * @param int|null $page_size Number of objects to be returned per page. Must be between `1` and `100`. Default is 20. (optional, default to 20) * @@ -515,6 +525,8 @@ public function bulkSendJobList(?int $page = 1, ?int $page_size = 20) * * List Bulk Send Jobs * + * Example: https://github.com/hellosign/dropbox-sign-php/blob/main/examples/BulkSendJobListExample.php + * * @param int|null $page Which page number of the BulkSendJob List to return. Defaults to `1`. (optional, default to 1) * @param int|null $page_size Number of objects to be returned per page. Must be between `1` and `100`. Default is 20. (optional, default to 20) * @param string $contentType The value for the Content-Type header. Check self::contentTypes['bulkSendJobList'] to see the possible values for this operation @@ -653,6 +665,8 @@ public function bulkSendJobListWithHttpInfo(?int $page = 1, ?int $page_size = 20 * * List Bulk Send Jobs * + * Example: https://github.com/hellosign/dropbox-sign-php/blob/main/examples/BulkSendJobListExample.php + * * @param int|null $page Which page number of the BulkSendJob List to return. Defaults to `1`. (optional, default to 1) * @param int|null $page_size Number of objects to be returned per page. Must be between `1` and `100`. Default is 20. (optional, default to 20) * @param string $contentType The value for the Content-Type header. Check self::contentTypes['bulkSendJobList'] to see the possible values for this operation @@ -676,6 +690,8 @@ function ($response) { * * List Bulk Send Jobs * + * Example: https://github.com/hellosign/dropbox-sign-php/blob/main/examples/BulkSendJobListExample.php + * * @param int|null $page Which page number of the BulkSendJob List to return. Defaults to `1`. (optional, default to 1) * @param int|null $page_size Number of objects to be returned per page. Must be between `1` and `100`. Default is 20. (optional, default to 20) * @param string $contentType The value for the Content-Type header. Check self::contentTypes['bulkSendJobList'] to see the possible values for this operation diff --git a/sdks/php/src/Api/EmbeddedApi.php b/sdks/php/src/Api/EmbeddedApi.php index 382228786..1aef64edb 100644 --- a/sdks/php/src/Api/EmbeddedApi.php +++ b/sdks/php/src/Api/EmbeddedApi.php @@ -136,6 +136,8 @@ public function getResponse() * * Get Embedded Template Edit URL * + * Example: https://github.com/hellosign/dropbox-sign-php/blob/main/examples/EmbeddedEditUrlExample.php + * * @param string $template_id The id of the template to edit. (required) * @param Model\EmbeddedEditUrlRequest $embedded_edit_url_request embedded_edit_url_request (required) * @@ -154,6 +156,8 @@ public function embeddedEditUrl(string $template_id, Model\EmbeddedEditUrlReques * * Get Embedded Template Edit URL * + * Example: https://github.com/hellosign/dropbox-sign-php/blob/main/examples/EmbeddedEditUrlExample.php + * * @param string $template_id The id of the template to edit. (required) * @param Model\EmbeddedEditUrlRequest $embedded_edit_url_request (required) * @param string $contentType The value for the Content-Type header. Check self::contentTypes['embeddedEditUrl'] to see the possible values for this operation @@ -292,6 +296,8 @@ public function embeddedEditUrlWithHttpInfo(string $template_id, Model\EmbeddedE * * Get Embedded Template Edit URL * + * Example: https://github.com/hellosign/dropbox-sign-php/blob/main/examples/EmbeddedEditUrlExample.php + * * @param string $template_id The id of the template to edit. (required) * @param Model\EmbeddedEditUrlRequest $embedded_edit_url_request (required) * @param string $contentType The value for the Content-Type header. Check self::contentTypes['embeddedEditUrl'] to see the possible values for this operation @@ -315,6 +321,8 @@ function ($response) { * * Get Embedded Template Edit URL * + * Example: https://github.com/hellosign/dropbox-sign-php/blob/main/examples/EmbeddedEditUrlExample.php + * * @param string $template_id The id of the template to edit. (required) * @param Model\EmbeddedEditUrlRequest $embedded_edit_url_request (required) * @param string $contentType The value for the Content-Type header. Check self::contentTypes['embeddedEditUrl'] to see the possible values for this operation @@ -496,6 +504,8 @@ public function embeddedEditUrlRequest(string $template_id, Model\EmbeddedEditUr * * Get Embedded Sign URL * + * Example: https://github.com/hellosign/dropbox-sign-php/blob/main/examples/EmbeddedSignUrlExample.php + * * @param string $signature_id The id of the signature to get a signature url for. (required) * * @return Model\EmbeddedSignUrlResponse @@ -513,6 +523,8 @@ public function embeddedSignUrl(string $signature_id) * * Get Embedded Sign URL * + * Example: https://github.com/hellosign/dropbox-sign-php/blob/main/examples/EmbeddedSignUrlExample.php + * * @param string $signature_id The id of the signature to get a signature url for. (required) * @param string $contentType The value for the Content-Type header. Check self::contentTypes['embeddedSignUrl'] to see the possible values for this operation * @@ -650,6 +662,8 @@ public function embeddedSignUrlWithHttpInfo(string $signature_id, string $conten * * Get Embedded Sign URL * + * Example: https://github.com/hellosign/dropbox-sign-php/blob/main/examples/EmbeddedSignUrlExample.php + * * @param string $signature_id The id of the signature to get a signature url for. (required) * @param string $contentType The value for the Content-Type header. Check self::contentTypes['embeddedSignUrl'] to see the possible values for this operation * @@ -672,6 +686,8 @@ function ($response) { * * Get Embedded Sign URL * + * Example: https://github.com/hellosign/dropbox-sign-php/blob/main/examples/EmbeddedSignUrlExample.php + * * @param string $signature_id The id of the signature to get a signature url for. (required) * @param string $contentType The value for the Content-Type header. Check self::contentTypes['embeddedSignUrl'] to see the possible values for this operation * diff --git a/sdks/php/src/Api/FaxApi.php b/sdks/php/src/Api/FaxApi.php index ec43e8a7f..e41132916 100644 --- a/sdks/php/src/Api/FaxApi.php +++ b/sdks/php/src/Api/FaxApi.php @@ -147,6 +147,8 @@ public function getResponse() * * Delete Fax * + * Example: https://github.com/hellosign/dropbox-sign-php/blob/main/examples/FaxDeleteExample.php + * * @param string $fax_id Fax ID (required) * * @throws ApiException on non-2xx response or if the response body is not in the expected format @@ -162,6 +164,8 @@ public function faxDelete(string $fax_id) * * Delete Fax * + * Example: https://github.com/hellosign/dropbox-sign-php/blob/main/examples/FaxDeleteExample.php + * * @param string $fax_id Fax ID (required) * @param string $contentType The value for the Content-Type header. Check self::contentTypes['faxDelete'] to see the possible values for this operation * @@ -213,6 +217,8 @@ public function faxDeleteWithHttpInfo(string $fax_id, string $contentType = self * * Delete Fax * + * Example: https://github.com/hellosign/dropbox-sign-php/blob/main/examples/FaxDeleteExample.php + * * @param string $fax_id Fax ID (required) * @param string $contentType The value for the Content-Type header. Check self::contentTypes['faxDelete'] to see the possible values for this operation * @@ -235,6 +241,8 @@ function ($response) { * * Delete Fax * + * Example: https://github.com/hellosign/dropbox-sign-php/blob/main/examples/FaxDeleteExample.php + * * @param string $fax_id Fax ID (required) * @param string $contentType The value for the Content-Type header. Check self::contentTypes['faxDelete'] to see the possible values for this operation * @@ -374,6 +382,8 @@ public function faxDeleteRequest(string $fax_id, string $contentType = self::con * * Download Fax Files * + * Example: https://github.com/hellosign/dropbox-sign-php/blob/main/examples/FaxFilesExample.php + * * @param string $fax_id Fax ID (required) * * @return SplFileObject @@ -391,6 +401,8 @@ public function faxFiles(string $fax_id) * * Download Fax Files * + * Example: https://github.com/hellosign/dropbox-sign-php/blob/main/examples/FaxFilesExample.php + * * @param string $fax_id Fax ID (required) * @param string $contentType The value for the Content-Type header. Check self::contentTypes['faxFiles'] to see the possible values for this operation * @@ -528,6 +540,8 @@ public function faxFilesWithHttpInfo(string $fax_id, string $contentType = self: * * Download Fax Files * + * Example: https://github.com/hellosign/dropbox-sign-php/blob/main/examples/FaxFilesExample.php + * * @param string $fax_id Fax ID (required) * @param string $contentType The value for the Content-Type header. Check self::contentTypes['faxFiles'] to see the possible values for this operation * @@ -550,6 +564,8 @@ function ($response) { * * Download Fax Files * + * Example: https://github.com/hellosign/dropbox-sign-php/blob/main/examples/FaxFilesExample.php + * * @param string $fax_id Fax ID (required) * @param string $contentType The value for the Content-Type header. Check self::contentTypes['faxFiles'] to see the possible values for this operation * @@ -702,6 +718,8 @@ public function faxFilesRequest(string $fax_id, string $contentType = self::cont * * Get Fax * + * Example: https://github.com/hellosign/dropbox-sign-php/blob/main/examples/FaxGetExample.php + * * @param string $fax_id Fax ID (required) * * @return Model\FaxGetResponse @@ -719,6 +737,8 @@ public function faxGet(string $fax_id) * * Get Fax * + * Example: https://github.com/hellosign/dropbox-sign-php/blob/main/examples/FaxGetExample.php + * * @param string $fax_id Fax ID (required) * @param string $contentType The value for the Content-Type header. Check self::contentTypes['faxGet'] to see the possible values for this operation * @@ -856,6 +876,8 @@ public function faxGetWithHttpInfo(string $fax_id, string $contentType = self::c * * Get Fax * + * Example: https://github.com/hellosign/dropbox-sign-php/blob/main/examples/FaxGetExample.php + * * @param string $fax_id Fax ID (required) * @param string $contentType The value for the Content-Type header. Check self::contentTypes['faxGet'] to see the possible values for this operation * @@ -878,6 +900,8 @@ function ($response) { * * Get Fax * + * Example: https://github.com/hellosign/dropbox-sign-php/blob/main/examples/FaxGetExample.php + * * @param string $fax_id Fax ID (required) * @param string $contentType The value for the Content-Type header. Check self::contentTypes['faxGet'] to see the possible values for this operation * @@ -1030,6 +1054,8 @@ public function faxGetRequest(string $fax_id, string $contentType = self::conten * * Lists Faxes * + * Example: https://github.com/hellosign/dropbox-sign-php/blob/main/examples/FaxListExample.php + * * @param int|null $page Which page number of the Fax List to return. Defaults to `1`. (optional, default to 1) * @param int|null $page_size Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. (optional, default to 20) * @@ -1048,6 +1074,8 @@ public function faxList(?int $page = 1, ?int $page_size = 20) * * Lists Faxes * + * Example: https://github.com/hellosign/dropbox-sign-php/blob/main/examples/FaxListExample.php + * * @param int|null $page Which page number of the Fax List to return. Defaults to `1`. (optional, default to 1) * @param int|null $page_size Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. (optional, default to 20) * @param string $contentType The value for the Content-Type header. Check self::contentTypes['faxList'] to see the possible values for this operation @@ -1186,6 +1214,8 @@ public function faxListWithHttpInfo(?int $page = 1, ?int $page_size = 20, string * * Lists Faxes * + * Example: https://github.com/hellosign/dropbox-sign-php/blob/main/examples/FaxListExample.php + * * @param int|null $page Which page number of the Fax List to return. Defaults to `1`. (optional, default to 1) * @param int|null $page_size Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. (optional, default to 20) * @param string $contentType The value for the Content-Type header. Check self::contentTypes['faxList'] to see the possible values for this operation @@ -1209,6 +1239,8 @@ function ($response) { * * Lists Faxes * + * Example: https://github.com/hellosign/dropbox-sign-php/blob/main/examples/FaxListExample.php + * * @param int|null $page Which page number of the Fax List to return. Defaults to `1`. (optional, default to 1) * @param int|null $page_size Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. (optional, default to 20) * @param string $contentType The value for the Content-Type header. Check self::contentTypes['faxList'] to see the possible values for this operation @@ -1377,6 +1409,8 @@ public function faxListRequest(?int $page = 1, ?int $page_size = 20, string $con * * Send Fax * + * Example: https://github.com/hellosign/dropbox-sign-php/blob/main/examples/FaxSendExample.php + * * @param Model\FaxSendRequest $fax_send_request fax_send_request (required) * * @return Model\FaxGetResponse @@ -1394,6 +1428,8 @@ public function faxSend(Model\FaxSendRequest $fax_send_request) * * Send Fax * + * Example: https://github.com/hellosign/dropbox-sign-php/blob/main/examples/FaxSendExample.php + * * @param Model\FaxSendRequest $fax_send_request (required) * @param string $contentType The value for the Content-Type header. Check self::contentTypes['faxSend'] to see the possible values for this operation * @@ -1531,6 +1567,8 @@ public function faxSendWithHttpInfo(Model\FaxSendRequest $fax_send_request, stri * * Send Fax * + * Example: https://github.com/hellosign/dropbox-sign-php/blob/main/examples/FaxSendExample.php + * * @param Model\FaxSendRequest $fax_send_request (required) * @param string $contentType The value for the Content-Type header. Check self::contentTypes['faxSend'] to see the possible values for this operation * @@ -1553,6 +1591,8 @@ function ($response) { * * Send Fax * + * Example: https://github.com/hellosign/dropbox-sign-php/blob/main/examples/FaxSendExample.php + * * @param Model\FaxSendRequest $fax_send_request (required) * @param string $contentType The value for the Content-Type header. Check self::contentTypes['faxSend'] to see the possible values for this operation * diff --git a/sdks/php/src/Api/FaxLineApi.php b/sdks/php/src/Api/FaxLineApi.php index 94a5e6e4a..2882dc492 100644 --- a/sdks/php/src/Api/FaxLineApi.php +++ b/sdks/php/src/Api/FaxLineApi.php @@ -151,6 +151,8 @@ public function getResponse() * * Add Fax Line User * + * Example: https://github.com/hellosign/dropbox-sign-php/blob/main/examples/FaxLineAddUserExample.php + * * @param Model\FaxLineAddUserRequest $fax_line_add_user_request fax_line_add_user_request (required) * * @return Model\FaxLineResponse @@ -168,6 +170,8 @@ public function faxLineAddUser(Model\FaxLineAddUserRequest $fax_line_add_user_re * * Add Fax Line User * + * Example: https://github.com/hellosign/dropbox-sign-php/blob/main/examples/FaxLineAddUserExample.php + * * @param Model\FaxLineAddUserRequest $fax_line_add_user_request (required) * @param string $contentType The value for the Content-Type header. Check self::contentTypes['faxLineAddUser'] to see the possible values for this operation * @@ -305,6 +309,8 @@ public function faxLineAddUserWithHttpInfo(Model\FaxLineAddUserRequest $fax_line * * Add Fax Line User * + * Example: https://github.com/hellosign/dropbox-sign-php/blob/main/examples/FaxLineAddUserExample.php + * * @param Model\FaxLineAddUserRequest $fax_line_add_user_request (required) * @param string $contentType The value for the Content-Type header. Check self::contentTypes['faxLineAddUser'] to see the possible values for this operation * @@ -327,6 +333,8 @@ function ($response) { * * Add Fax Line User * + * Example: https://github.com/hellosign/dropbox-sign-php/blob/main/examples/FaxLineAddUserExample.php + * * @param Model\FaxLineAddUserRequest $fax_line_add_user_request (required) * @param string $contentType The value for the Content-Type header. Check self::contentTypes['faxLineAddUser'] to see the possible values for this operation * @@ -486,6 +494,8 @@ public function faxLineAddUserRequest(Model\FaxLineAddUserRequest $fax_line_add_ * * Get Available Fax Line Area Codes * + * Example: https://github.com/hellosign/dropbox-sign-php/blob/main/examples/FaxLineAreaCodeGetExample.php + * * @param string $country Filter area codes by country (required) * @param string|null $state Filter area codes by state (optional) * @param string|null $province Filter area codes by province (optional) @@ -506,6 +516,8 @@ public function faxLineAreaCodeGet(string $country, ?string $state = null, ?stri * * Get Available Fax Line Area Codes * + * Example: https://github.com/hellosign/dropbox-sign-php/blob/main/examples/FaxLineAreaCodeGetExample.php + * * @param string $country Filter area codes by country (required) * @param string|null $state Filter area codes by state (optional) * @param string|null $province Filter area codes by province (optional) @@ -646,6 +658,8 @@ public function faxLineAreaCodeGetWithHttpInfo(string $country, ?string $state = * * Get Available Fax Line Area Codes * + * Example: https://github.com/hellosign/dropbox-sign-php/blob/main/examples/FaxLineAreaCodeGetExample.php + * * @param string $country Filter area codes by country (required) * @param string|null $state Filter area codes by state (optional) * @param string|null $province Filter area codes by province (optional) @@ -671,6 +685,8 @@ function ($response) { * * Get Available Fax Line Area Codes * + * Example: https://github.com/hellosign/dropbox-sign-php/blob/main/examples/FaxLineAreaCodeGetExample.php + * * @param string $country Filter area codes by country (required) * @param string|null $state Filter area codes by state (optional) * @param string|null $province Filter area codes by province (optional) @@ -857,6 +873,8 @@ public function faxLineAreaCodeGetRequest(string $country, ?string $state = null * * Purchase Fax Line * + * Example: https://github.com/hellosign/dropbox-sign-php/blob/main/examples/FaxLineCreateExample.php + * * @param Model\FaxLineCreateRequest $fax_line_create_request fax_line_create_request (required) * * @return Model\FaxLineResponse @@ -874,6 +892,8 @@ public function faxLineCreate(Model\FaxLineCreateRequest $fax_line_create_reques * * Purchase Fax Line * + * Example: https://github.com/hellosign/dropbox-sign-php/blob/main/examples/FaxLineCreateExample.php + * * @param Model\FaxLineCreateRequest $fax_line_create_request (required) * @param string $contentType The value for the Content-Type header. Check self::contentTypes['faxLineCreate'] to see the possible values for this operation * @@ -1011,6 +1031,8 @@ public function faxLineCreateWithHttpInfo(Model\FaxLineCreateRequest $fax_line_c * * Purchase Fax Line * + * Example: https://github.com/hellosign/dropbox-sign-php/blob/main/examples/FaxLineCreateExample.php + * * @param Model\FaxLineCreateRequest $fax_line_create_request (required) * @param string $contentType The value for the Content-Type header. Check self::contentTypes['faxLineCreate'] to see the possible values for this operation * @@ -1033,6 +1055,8 @@ function ($response) { * * Purchase Fax Line * + * Example: https://github.com/hellosign/dropbox-sign-php/blob/main/examples/FaxLineCreateExample.php + * * @param Model\FaxLineCreateRequest $fax_line_create_request (required) * @param string $contentType The value for the Content-Type header. Check self::contentTypes['faxLineCreate'] to see the possible values for this operation * @@ -1192,6 +1216,8 @@ public function faxLineCreateRequest(Model\FaxLineCreateRequest $fax_line_create * * Delete Fax Line * + * Example: https://github.com/hellosign/dropbox-sign-php/blob/main/examples/FaxLineDeleteExample.php + * * @param Model\FaxLineDeleteRequest $fax_line_delete_request fax_line_delete_request (required) * * @throws ApiException on non-2xx response or if the response body is not in the expected format @@ -1207,6 +1233,8 @@ public function faxLineDelete(Model\FaxLineDeleteRequest $fax_line_delete_reques * * Delete Fax Line * + * Example: https://github.com/hellosign/dropbox-sign-php/blob/main/examples/FaxLineDeleteExample.php + * * @param Model\FaxLineDeleteRequest $fax_line_delete_request (required) * @param string $contentType The value for the Content-Type header. Check self::contentTypes['faxLineDelete'] to see the possible values for this operation * @@ -1258,6 +1286,8 @@ public function faxLineDeleteWithHttpInfo(Model\FaxLineDeleteRequest $fax_line_d * * Delete Fax Line * + * Example: https://github.com/hellosign/dropbox-sign-php/blob/main/examples/FaxLineDeleteExample.php + * * @param Model\FaxLineDeleteRequest $fax_line_delete_request (required) * @param string $contentType The value for the Content-Type header. Check self::contentTypes['faxLineDelete'] to see the possible values for this operation * @@ -1280,6 +1310,8 @@ function ($response) { * * Delete Fax Line * + * Example: https://github.com/hellosign/dropbox-sign-php/blob/main/examples/FaxLineDeleteExample.php + * * @param Model\FaxLineDeleteRequest $fax_line_delete_request (required) * @param string $contentType The value for the Content-Type header. Check self::contentTypes['faxLineDelete'] to see the possible values for this operation * @@ -1426,6 +1458,8 @@ public function faxLineDeleteRequest(Model\FaxLineDeleteRequest $fax_line_delete * * Get Fax Line * + * Example: https://github.com/hellosign/dropbox-sign-php/blob/main/examples/FaxLineGetExample.php + * * @param string $number The Fax Line number (required) * * @return Model\FaxLineResponse @@ -1443,6 +1477,8 @@ public function faxLineGet(string $number) * * Get Fax Line * + * Example: https://github.com/hellosign/dropbox-sign-php/blob/main/examples/FaxLineGetExample.php + * * @param string $number The Fax Line number (required) * @param string $contentType The value for the Content-Type header. Check self::contentTypes['faxLineGet'] to see the possible values for this operation * @@ -1580,6 +1616,8 @@ public function faxLineGetWithHttpInfo(string $number, string $contentType = sel * * Get Fax Line * + * Example: https://github.com/hellosign/dropbox-sign-php/blob/main/examples/FaxLineGetExample.php + * * @param string $number The Fax Line number (required) * @param string $contentType The value for the Content-Type header. Check self::contentTypes['faxLineGet'] to see the possible values for this operation * @@ -1602,6 +1640,8 @@ function ($response) { * * Get Fax Line * + * Example: https://github.com/hellosign/dropbox-sign-php/blob/main/examples/FaxLineGetExample.php + * * @param string $number The Fax Line number (required) * @param string $contentType The value for the Content-Type header. Check self::contentTypes['faxLineGet'] to see the possible values for this operation * @@ -1755,6 +1795,8 @@ public function faxLineGetRequest(string $number, string $contentType = self::co * * List Fax Lines * + * Example: https://github.com/hellosign/dropbox-sign-php/blob/main/examples/FaxLineListExample.php + * * @param string|null $account_id Account ID (optional) * @param int|null $page Which page number of the Fax Line List to return. Defaults to `1`. (optional, default to 1) * @param int|null $page_size Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. (optional, default to 20) @@ -1775,6 +1817,8 @@ public function faxLineList(?string $account_id = null, ?int $page = 1, ?int $pa * * List Fax Lines * + * Example: https://github.com/hellosign/dropbox-sign-php/blob/main/examples/FaxLineListExample.php + * * @param string|null $account_id Account ID (optional) * @param int|null $page Which page number of the Fax Line List to return. Defaults to `1`. (optional, default to 1) * @param int|null $page_size Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. (optional, default to 20) @@ -1915,6 +1959,8 @@ public function faxLineListWithHttpInfo(?string $account_id = null, ?int $page = * * List Fax Lines * + * Example: https://github.com/hellosign/dropbox-sign-php/blob/main/examples/FaxLineListExample.php + * * @param string|null $account_id Account ID (optional) * @param int|null $page Which page number of the Fax Line List to return. Defaults to `1`. (optional, default to 1) * @param int|null $page_size Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. (optional, default to 20) @@ -1940,6 +1986,8 @@ function ($response) { * * List Fax Lines * + * Example: https://github.com/hellosign/dropbox-sign-php/blob/main/examples/FaxLineListExample.php + * * @param string|null $account_id Account ID (optional) * @param int|null $page Which page number of the Fax Line List to return. Defaults to `1`. (optional, default to 1) * @param int|null $page_size Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. (optional, default to 20) @@ -2119,6 +2167,8 @@ public function faxLineListRequest(?string $account_id = null, ?int $page = 1, ? * * Remove Fax Line Access * + * Example: https://github.com/hellosign/dropbox-sign-php/blob/main/examples/FaxLineRemoveUserExample.php + * * @param Model\FaxLineRemoveUserRequest $fax_line_remove_user_request fax_line_remove_user_request (required) * * @return Model\FaxLineResponse @@ -2136,6 +2186,8 @@ public function faxLineRemoveUser(Model\FaxLineRemoveUserRequest $fax_line_remov * * Remove Fax Line Access * + * Example: https://github.com/hellosign/dropbox-sign-php/blob/main/examples/FaxLineRemoveUserExample.php + * * @param Model\FaxLineRemoveUserRequest $fax_line_remove_user_request (required) * @param string $contentType The value for the Content-Type header. Check self::contentTypes['faxLineRemoveUser'] to see the possible values for this operation * @@ -2273,6 +2325,8 @@ public function faxLineRemoveUserWithHttpInfo(Model\FaxLineRemoveUserRequest $fa * * Remove Fax Line Access * + * Example: https://github.com/hellosign/dropbox-sign-php/blob/main/examples/FaxLineRemoveUserExample.php + * * @param Model\FaxLineRemoveUserRequest $fax_line_remove_user_request (required) * @param string $contentType The value for the Content-Type header. Check self::contentTypes['faxLineRemoveUser'] to see the possible values for this operation * @@ -2295,6 +2349,8 @@ function ($response) { * * Remove Fax Line Access * + * Example: https://github.com/hellosign/dropbox-sign-php/blob/main/examples/FaxLineRemoveUserExample.php + * * @param Model\FaxLineRemoveUserRequest $fax_line_remove_user_request (required) * @param string $contentType The value for the Content-Type header. Check self::contentTypes['faxLineRemoveUser'] to see the possible values for this operation * diff --git a/sdks/php/src/Api/OAuthApi.php b/sdks/php/src/Api/OAuthApi.php index 19b137a75..95bbf72e6 100644 --- a/sdks/php/src/Api/OAuthApi.php +++ b/sdks/php/src/Api/OAuthApi.php @@ -136,6 +136,8 @@ public function getResponse() * * OAuth Token Generate * + * Example: https://github.com/hellosign/dropbox-sign-php/blob/main/examples/OauthTokenGenerateExample.php + * * This operation contains host(s) defined in the OpenAPI spec. Use 'hostIndex' to select the host. * if needed, use the 'variables' parameter to pass variables to the host. * URL: https://app.hellosign.com @@ -157,6 +159,8 @@ public function oauthTokenGenerate(Model\OAuthTokenGenerateRequest $o_auth_token * * OAuth Token Generate * + * Example: https://github.com/hellosign/dropbox-sign-php/blob/main/examples/OauthTokenGenerateExample.php + * * This operation contains host(s) defined in the OpenAPI spec. Use 'hostIndex' to select the host. * if needed, use the 'variables' parameter to pass variables to the host. * URL: https://app.hellosign.com @@ -300,6 +304,8 @@ public function oauthTokenGenerateWithHttpInfo(Model\OAuthTokenGenerateRequest $ * * OAuth Token Generate * + * Example: https://github.com/hellosign/dropbox-sign-php/blob/main/examples/OauthTokenGenerateExample.php + * * This operation contains host(s) defined in the OpenAPI spec. Use 'hostIndex' to select the host. * if needed, use the 'variables' parameter to pass variables to the host. * URL: https://app.hellosign.com @@ -328,6 +334,8 @@ function ($response) { * * OAuth Token Generate * + * Example: https://github.com/hellosign/dropbox-sign-php/blob/main/examples/OauthTokenGenerateExample.php + * * This operation contains host(s) defined in the OpenAPI spec. Use 'hostIndex' to select the host. * if needed, use the 'variables' parameter to pass variables to the host. * URL: https://app.hellosign.com @@ -519,6 +527,8 @@ protected function getHostSettingsForoauthTokenGenerate(): array * * OAuth Token Refresh * + * Example: https://github.com/hellosign/dropbox-sign-php/blob/main/examples/OauthTokenRefreshExample.php + * * This operation contains host(s) defined in the OpenAPI spec. Use 'hostIndex' to select the host. * if needed, use the 'variables' parameter to pass variables to the host. * URL: https://app.hellosign.com @@ -540,6 +550,8 @@ public function oauthTokenRefresh(Model\OAuthTokenRefreshRequest $o_auth_token_r * * OAuth Token Refresh * + * Example: https://github.com/hellosign/dropbox-sign-php/blob/main/examples/OauthTokenRefreshExample.php + * * This operation contains host(s) defined in the OpenAPI spec. Use 'hostIndex' to select the host. * if needed, use the 'variables' parameter to pass variables to the host. * URL: https://app.hellosign.com @@ -683,6 +695,8 @@ public function oauthTokenRefreshWithHttpInfo(Model\OAuthTokenRefreshRequest $o_ * * OAuth Token Refresh * + * Example: https://github.com/hellosign/dropbox-sign-php/blob/main/examples/OauthTokenRefreshExample.php + * * This operation contains host(s) defined in the OpenAPI spec. Use 'hostIndex' to select the host. * if needed, use the 'variables' parameter to pass variables to the host. * URL: https://app.hellosign.com @@ -711,6 +725,8 @@ function ($response) { * * OAuth Token Refresh * + * Example: https://github.com/hellosign/dropbox-sign-php/blob/main/examples/OauthTokenRefreshExample.php + * * This operation contains host(s) defined in the OpenAPI spec. Use 'hostIndex' to select the host. * if needed, use the 'variables' parameter to pass variables to the host. * URL: https://app.hellosign.com diff --git a/sdks/php/src/Api/ReportApi.php b/sdks/php/src/Api/ReportApi.php index cde61fcaf..942e18e3b 100644 --- a/sdks/php/src/Api/ReportApi.php +++ b/sdks/php/src/Api/ReportApi.php @@ -133,6 +133,8 @@ public function getResponse() * * Create Report * + * Example: https://github.com/hellosign/dropbox-sign-php/blob/main/examples/ReportCreateExample.php + * * @param Model\ReportCreateRequest $report_create_request report_create_request (required) * * @return Model\ReportCreateResponse @@ -150,6 +152,8 @@ public function reportCreate(Model\ReportCreateRequest $report_create_request) * * Create Report * + * Example: https://github.com/hellosign/dropbox-sign-php/blob/main/examples/ReportCreateExample.php + * * @param Model\ReportCreateRequest $report_create_request (required) * @param string $contentType The value for the Content-Type header. Check self::contentTypes['reportCreate'] to see the possible values for this operation * @@ -287,6 +291,8 @@ public function reportCreateWithHttpInfo(Model\ReportCreateRequest $report_creat * * Create Report * + * Example: https://github.com/hellosign/dropbox-sign-php/blob/main/examples/ReportCreateExample.php + * * @param Model\ReportCreateRequest $report_create_request (required) * @param string $contentType The value for the Content-Type header. Check self::contentTypes['reportCreate'] to see the possible values for this operation * @@ -309,6 +315,8 @@ function ($response) { * * Create Report * + * Example: https://github.com/hellosign/dropbox-sign-php/blob/main/examples/ReportCreateExample.php + * * @param Model\ReportCreateRequest $report_create_request (required) * @param string $contentType The value for the Content-Type header. Check self::contentTypes['reportCreate'] to see the possible values for this operation * diff --git a/sdks/php/src/Api/SignatureRequestApi.php b/sdks/php/src/Api/SignatureRequestApi.php index 3f6ad70ec..0abcb76c2 100644 --- a/sdks/php/src/Api/SignatureRequestApi.php +++ b/sdks/php/src/Api/SignatureRequestApi.php @@ -201,6 +201,8 @@ public function getResponse() * * Embedded Bulk Send with Template * + * Example: https://github.com/hellosign/dropbox-sign-php/blob/main/examples/SignatureRequestBulkCreateEmbeddedWithTemplateExample.php + * * @param Model\SignatureRequestBulkCreateEmbeddedWithTemplateRequest $signature_request_bulk_create_embedded_with_template_request signature_request_bulk_create_embedded_with_template_request (required) * * @return Model\BulkSendJobSendResponse @@ -218,6 +220,8 @@ public function signatureRequestBulkCreateEmbeddedWithTemplate(Model\SignatureRe * * Embedded Bulk Send with Template * + * Example: https://github.com/hellosign/dropbox-sign-php/blob/main/examples/SignatureRequestBulkCreateEmbeddedWithTemplateExample.php + * * @param Model\SignatureRequestBulkCreateEmbeddedWithTemplateRequest $signature_request_bulk_create_embedded_with_template_request (required) * @param string $contentType The value for the Content-Type header. Check self::contentTypes['signatureRequestBulkCreateEmbeddedWithTemplate'] to see the possible values for this operation * @@ -355,6 +359,8 @@ public function signatureRequestBulkCreateEmbeddedWithTemplateWithHttpInfo(Model * * Embedded Bulk Send with Template * + * Example: https://github.com/hellosign/dropbox-sign-php/blob/main/examples/SignatureRequestBulkCreateEmbeddedWithTemplateExample.php + * * @param Model\SignatureRequestBulkCreateEmbeddedWithTemplateRequest $signature_request_bulk_create_embedded_with_template_request (required) * @param string $contentType The value for the Content-Type header. Check self::contentTypes['signatureRequestBulkCreateEmbeddedWithTemplate'] to see the possible values for this operation * @@ -377,6 +383,8 @@ function ($response) { * * Embedded Bulk Send with Template * + * Example: https://github.com/hellosign/dropbox-sign-php/blob/main/examples/SignatureRequestBulkCreateEmbeddedWithTemplateExample.php + * * @param Model\SignatureRequestBulkCreateEmbeddedWithTemplateRequest $signature_request_bulk_create_embedded_with_template_request (required) * @param string $contentType The value for the Content-Type header. Check self::contentTypes['signatureRequestBulkCreateEmbeddedWithTemplate'] to see the possible values for this operation * @@ -536,6 +544,8 @@ public function signatureRequestBulkCreateEmbeddedWithTemplateRequest(Model\Sign * * Bulk Send with Template * + * Example: https://github.com/hellosign/dropbox-sign-php/blob/main/examples/SignatureRequestBulkSendWithTemplateExample.php + * * @param Model\SignatureRequestBulkSendWithTemplateRequest $signature_request_bulk_send_with_template_request signature_request_bulk_send_with_template_request (required) * * @return Model\BulkSendJobSendResponse @@ -553,6 +563,8 @@ public function signatureRequestBulkSendWithTemplate(Model\SignatureRequestBulkS * * Bulk Send with Template * + * Example: https://github.com/hellosign/dropbox-sign-php/blob/main/examples/SignatureRequestBulkSendWithTemplateExample.php + * * @param Model\SignatureRequestBulkSendWithTemplateRequest $signature_request_bulk_send_with_template_request (required) * @param string $contentType The value for the Content-Type header. Check self::contentTypes['signatureRequestBulkSendWithTemplate'] to see the possible values for this operation * @@ -690,6 +702,8 @@ public function signatureRequestBulkSendWithTemplateWithHttpInfo(Model\Signature * * Bulk Send with Template * + * Example: https://github.com/hellosign/dropbox-sign-php/blob/main/examples/SignatureRequestBulkSendWithTemplateExample.php + * * @param Model\SignatureRequestBulkSendWithTemplateRequest $signature_request_bulk_send_with_template_request (required) * @param string $contentType The value for the Content-Type header. Check self::contentTypes['signatureRequestBulkSendWithTemplate'] to see the possible values for this operation * @@ -712,6 +726,8 @@ function ($response) { * * Bulk Send with Template * + * Example: https://github.com/hellosign/dropbox-sign-php/blob/main/examples/SignatureRequestBulkSendWithTemplateExample.php + * * @param Model\SignatureRequestBulkSendWithTemplateRequest $signature_request_bulk_send_with_template_request (required) * @param string $contentType The value for the Content-Type header. Check self::contentTypes['signatureRequestBulkSendWithTemplate'] to see the possible values for this operation * @@ -875,6 +891,8 @@ public function signatureRequestBulkSendWithTemplateRequest(Model\SignatureReque * * Cancel Incomplete Signature Request * + * Example: https://github.com/hellosign/dropbox-sign-php/blob/main/examples/SignatureRequestCancelExample.php + * * @param string $signature_request_id The id of the incomplete SignatureRequest to cancel. (required) * * @throws ApiException on non-2xx response or if the response body is not in the expected format @@ -890,6 +908,8 @@ public function signatureRequestCancel(string $signature_request_id) * * Cancel Incomplete Signature Request * + * Example: https://github.com/hellosign/dropbox-sign-php/blob/main/examples/SignatureRequestCancelExample.php + * * @param string $signature_request_id The id of the incomplete SignatureRequest to cancel. (required) * @param string $contentType The value for the Content-Type header. Check self::contentTypes['signatureRequestCancel'] to see the possible values for this operation * @@ -941,6 +961,8 @@ public function signatureRequestCancelWithHttpInfo(string $signature_request_id, * * Cancel Incomplete Signature Request * + * Example: https://github.com/hellosign/dropbox-sign-php/blob/main/examples/SignatureRequestCancelExample.php + * * @param string $signature_request_id The id of the incomplete SignatureRequest to cancel. (required) * @param string $contentType The value for the Content-Type header. Check self::contentTypes['signatureRequestCancel'] to see the possible values for this operation * @@ -963,6 +985,8 @@ function ($response) { * * Cancel Incomplete Signature Request * + * Example: https://github.com/hellosign/dropbox-sign-php/blob/main/examples/SignatureRequestCancelExample.php + * * @param string $signature_request_id The id of the incomplete SignatureRequest to cancel. (required) * @param string $contentType The value for the Content-Type header. Check self::contentTypes['signatureRequestCancel'] to see the possible values for this operation * @@ -1106,6 +1130,8 @@ public function signatureRequestCancelRequest(string $signature_request_id, stri * * Create Embedded Signature Request * + * Example: https://github.com/hellosign/dropbox-sign-php/blob/main/examples/SignatureRequestCreateEmbeddedExample.php + * * @param Model\SignatureRequestCreateEmbeddedRequest $signature_request_create_embedded_request signature_request_create_embedded_request (required) * * @return Model\SignatureRequestGetResponse @@ -1123,6 +1149,8 @@ public function signatureRequestCreateEmbedded(Model\SignatureRequestCreateEmbed * * Create Embedded Signature Request * + * Example: https://github.com/hellosign/dropbox-sign-php/blob/main/examples/SignatureRequestCreateEmbeddedExample.php + * * @param Model\SignatureRequestCreateEmbeddedRequest $signature_request_create_embedded_request (required) * @param string $contentType The value for the Content-Type header. Check self::contentTypes['signatureRequestCreateEmbedded'] to see the possible values for this operation * @@ -1260,6 +1288,8 @@ public function signatureRequestCreateEmbeddedWithHttpInfo(Model\SignatureReques * * Create Embedded Signature Request * + * Example: https://github.com/hellosign/dropbox-sign-php/blob/main/examples/SignatureRequestCreateEmbeddedExample.php + * * @param Model\SignatureRequestCreateEmbeddedRequest $signature_request_create_embedded_request (required) * @param string $contentType The value for the Content-Type header. Check self::contentTypes['signatureRequestCreateEmbedded'] to see the possible values for this operation * @@ -1282,6 +1312,8 @@ function ($response) { * * Create Embedded Signature Request * + * Example: https://github.com/hellosign/dropbox-sign-php/blob/main/examples/SignatureRequestCreateEmbeddedExample.php + * * @param Model\SignatureRequestCreateEmbeddedRequest $signature_request_create_embedded_request (required) * @param string $contentType The value for the Content-Type header. Check self::contentTypes['signatureRequestCreateEmbedded'] to see the possible values for this operation * @@ -1445,6 +1477,8 @@ public function signatureRequestCreateEmbeddedRequest(Model\SignatureRequestCrea * * Create Embedded Signature Request with Template * + * Example: https://github.com/hellosign/dropbox-sign-php/blob/main/examples/SignatureRequestCreateEmbeddedWithTemplateExample.php + * * @param Model\SignatureRequestCreateEmbeddedWithTemplateRequest $signature_request_create_embedded_with_template_request signature_request_create_embedded_with_template_request (required) * * @return Model\SignatureRequestGetResponse @@ -1462,6 +1496,8 @@ public function signatureRequestCreateEmbeddedWithTemplate(Model\SignatureReques * * Create Embedded Signature Request with Template * + * Example: https://github.com/hellosign/dropbox-sign-php/blob/main/examples/SignatureRequestCreateEmbeddedWithTemplateExample.php + * * @param Model\SignatureRequestCreateEmbeddedWithTemplateRequest $signature_request_create_embedded_with_template_request (required) * @param string $contentType The value for the Content-Type header. Check self::contentTypes['signatureRequestCreateEmbeddedWithTemplate'] to see the possible values for this operation * @@ -1599,6 +1635,8 @@ public function signatureRequestCreateEmbeddedWithTemplateWithHttpInfo(Model\Sig * * Create Embedded Signature Request with Template * + * Example: https://github.com/hellosign/dropbox-sign-php/blob/main/examples/SignatureRequestCreateEmbeddedWithTemplateExample.php + * * @param Model\SignatureRequestCreateEmbeddedWithTemplateRequest $signature_request_create_embedded_with_template_request (required) * @param string $contentType The value for the Content-Type header. Check self::contentTypes['signatureRequestCreateEmbeddedWithTemplate'] to see the possible values for this operation * @@ -1621,6 +1659,8 @@ function ($response) { * * Create Embedded Signature Request with Template * + * Example: https://github.com/hellosign/dropbox-sign-php/blob/main/examples/SignatureRequestCreateEmbeddedWithTemplateExample.php + * * @param Model\SignatureRequestCreateEmbeddedWithTemplateRequest $signature_request_create_embedded_with_template_request (required) * @param string $contentType The value for the Content-Type header. Check self::contentTypes['signatureRequestCreateEmbeddedWithTemplate'] to see the possible values for this operation * @@ -1784,6 +1824,8 @@ public function signatureRequestCreateEmbeddedWithTemplateRequest(Model\Signatur * * Edit Signature Request * + * Example: https://github.com/hellosign/dropbox-sign-php/blob/main/examples/SignatureRequestEditExample.php + * * @param string $signature_request_id The id of the SignatureRequest to edit. (required) * @param Model\SignatureRequestEditRequest $signature_request_edit_request signature_request_edit_request (required) * @@ -1802,6 +1844,8 @@ public function signatureRequestEdit(string $signature_request_id, Model\Signatu * * Edit Signature Request * + * Example: https://github.com/hellosign/dropbox-sign-php/blob/main/examples/SignatureRequestEditExample.php + * * @param string $signature_request_id The id of the SignatureRequest to edit. (required) * @param Model\SignatureRequestEditRequest $signature_request_edit_request (required) * @param string $contentType The value for the Content-Type header. Check self::contentTypes['signatureRequestEdit'] to see the possible values for this operation @@ -1940,6 +1984,8 @@ public function signatureRequestEditWithHttpInfo(string $signature_request_id, M * * Edit Signature Request * + * Example: https://github.com/hellosign/dropbox-sign-php/blob/main/examples/SignatureRequestEditExample.php + * * @param string $signature_request_id The id of the SignatureRequest to edit. (required) * @param Model\SignatureRequestEditRequest $signature_request_edit_request (required) * @param string $contentType The value for the Content-Type header. Check self::contentTypes['signatureRequestEdit'] to see the possible values for this operation @@ -1963,6 +2009,8 @@ function ($response) { * * Edit Signature Request * + * Example: https://github.com/hellosign/dropbox-sign-php/blob/main/examples/SignatureRequestEditExample.php + * * @param string $signature_request_id The id of the SignatureRequest to edit. (required) * @param Model\SignatureRequestEditRequest $signature_request_edit_request (required) * @param string $contentType The value for the Content-Type header. Check self::contentTypes['signatureRequestEdit'] to see the possible values for this operation @@ -2144,6 +2192,8 @@ public function signatureRequestEditRequest(string $signature_request_id, Model\ * * Edit Embedded Signature Request * + * Example: https://github.com/hellosign/dropbox-sign-php/blob/main/examples/SignatureRequestEditEmbeddedExample.php + * * @param string $signature_request_id The id of the SignatureRequest to edit. (required) * @param Model\SignatureRequestEditEmbeddedRequest $signature_request_edit_embedded_request signature_request_edit_embedded_request (required) * @@ -2162,6 +2212,8 @@ public function signatureRequestEditEmbedded(string $signature_request_id, Model * * Edit Embedded Signature Request * + * Example: https://github.com/hellosign/dropbox-sign-php/blob/main/examples/SignatureRequestEditEmbeddedExample.php + * * @param string $signature_request_id The id of the SignatureRequest to edit. (required) * @param Model\SignatureRequestEditEmbeddedRequest $signature_request_edit_embedded_request (required) * @param string $contentType The value for the Content-Type header. Check self::contentTypes['signatureRequestEditEmbedded'] to see the possible values for this operation @@ -2300,6 +2352,8 @@ public function signatureRequestEditEmbeddedWithHttpInfo(string $signature_reque * * Edit Embedded Signature Request * + * Example: https://github.com/hellosign/dropbox-sign-php/blob/main/examples/SignatureRequestEditEmbeddedExample.php + * * @param string $signature_request_id The id of the SignatureRequest to edit. (required) * @param Model\SignatureRequestEditEmbeddedRequest $signature_request_edit_embedded_request (required) * @param string $contentType The value for the Content-Type header. Check self::contentTypes['signatureRequestEditEmbedded'] to see the possible values for this operation @@ -2323,6 +2377,8 @@ function ($response) { * * Edit Embedded Signature Request * + * Example: https://github.com/hellosign/dropbox-sign-php/blob/main/examples/SignatureRequestEditEmbeddedExample.php + * * @param string $signature_request_id The id of the SignatureRequest to edit. (required) * @param Model\SignatureRequestEditEmbeddedRequest $signature_request_edit_embedded_request (required) * @param string $contentType The value for the Content-Type header. Check self::contentTypes['signatureRequestEditEmbedded'] to see the possible values for this operation @@ -2504,6 +2560,8 @@ public function signatureRequestEditEmbeddedRequest(string $signature_request_id * * Edit Embedded Signature Request with Template * + * Example: https://github.com/hellosign/dropbox-sign-php/blob/main/examples/SignatureRequestEditEmbeddedWithTemplateExample.php + * * @param string $signature_request_id The id of the SignatureRequest to edit. (required) * @param Model\SignatureRequestEditEmbeddedWithTemplateRequest $signature_request_edit_embedded_with_template_request signature_request_edit_embedded_with_template_request (required) * @@ -2522,6 +2580,8 @@ public function signatureRequestEditEmbeddedWithTemplate(string $signature_reque * * Edit Embedded Signature Request with Template * + * Example: https://github.com/hellosign/dropbox-sign-php/blob/main/examples/SignatureRequestEditEmbeddedWithTemplateExample.php + * * @param string $signature_request_id The id of the SignatureRequest to edit. (required) * @param Model\SignatureRequestEditEmbeddedWithTemplateRequest $signature_request_edit_embedded_with_template_request (required) * @param string $contentType The value for the Content-Type header. Check self::contentTypes['signatureRequestEditEmbeddedWithTemplate'] to see the possible values for this operation @@ -2660,6 +2720,8 @@ public function signatureRequestEditEmbeddedWithTemplateWithHttpInfo(string $sig * * Edit Embedded Signature Request with Template * + * Example: https://github.com/hellosign/dropbox-sign-php/blob/main/examples/SignatureRequestEditEmbeddedWithTemplateExample.php + * * @param string $signature_request_id The id of the SignatureRequest to edit. (required) * @param Model\SignatureRequestEditEmbeddedWithTemplateRequest $signature_request_edit_embedded_with_template_request (required) * @param string $contentType The value for the Content-Type header. Check self::contentTypes['signatureRequestEditEmbeddedWithTemplate'] to see the possible values for this operation @@ -2683,6 +2745,8 @@ function ($response) { * * Edit Embedded Signature Request with Template * + * Example: https://github.com/hellosign/dropbox-sign-php/blob/main/examples/SignatureRequestEditEmbeddedWithTemplateExample.php + * * @param string $signature_request_id The id of the SignatureRequest to edit. (required) * @param Model\SignatureRequestEditEmbeddedWithTemplateRequest $signature_request_edit_embedded_with_template_request (required) * @param string $contentType The value for the Content-Type header. Check self::contentTypes['signatureRequestEditEmbeddedWithTemplate'] to see the possible values for this operation @@ -2864,6 +2928,8 @@ public function signatureRequestEditEmbeddedWithTemplateRequest(string $signatur * * Edit Signature Request With Template * + * Example: https://github.com/hellosign/dropbox-sign-php/blob/main/examples/SignatureRequestEditWithTemplateExample.php + * * @param string $signature_request_id The id of the SignatureRequest to edit. (required) * @param Model\SignatureRequestEditWithTemplateRequest $signature_request_edit_with_template_request signature_request_edit_with_template_request (required) * @@ -2882,6 +2948,8 @@ public function signatureRequestEditWithTemplate(string $signature_request_id, M * * Edit Signature Request With Template * + * Example: https://github.com/hellosign/dropbox-sign-php/blob/main/examples/SignatureRequestEditWithTemplateExample.php + * * @param string $signature_request_id The id of the SignatureRequest to edit. (required) * @param Model\SignatureRequestEditWithTemplateRequest $signature_request_edit_with_template_request (required) * @param string $contentType The value for the Content-Type header. Check self::contentTypes['signatureRequestEditWithTemplate'] to see the possible values for this operation @@ -3020,6 +3088,8 @@ public function signatureRequestEditWithTemplateWithHttpInfo(string $signature_r * * Edit Signature Request With Template * + * Example: https://github.com/hellosign/dropbox-sign-php/blob/main/examples/SignatureRequestEditWithTemplateExample.php + * * @param string $signature_request_id The id of the SignatureRequest to edit. (required) * @param Model\SignatureRequestEditWithTemplateRequest $signature_request_edit_with_template_request (required) * @param string $contentType The value for the Content-Type header. Check self::contentTypes['signatureRequestEditWithTemplate'] to see the possible values for this operation @@ -3043,6 +3113,8 @@ function ($response) { * * Edit Signature Request With Template * + * Example: https://github.com/hellosign/dropbox-sign-php/blob/main/examples/SignatureRequestEditWithTemplateExample.php + * * @param string $signature_request_id The id of the SignatureRequest to edit. (required) * @param Model\SignatureRequestEditWithTemplateRequest $signature_request_edit_with_template_request (required) * @param string $contentType The value for the Content-Type header. Check self::contentTypes['signatureRequestEditWithTemplate'] to see the possible values for this operation @@ -3224,6 +3296,8 @@ public function signatureRequestEditWithTemplateRequest(string $signature_reques * * Download Files * + * Example: https://github.com/hellosign/dropbox-sign-php/blob/main/examples/SignatureRequestFilesExample.php + * * @param string $signature_request_id The id of the SignatureRequest to retrieve. (required) * @param string|null $file_type Set to `pdf` for a single merged document or `zip` for a collection of individual documents. (optional, default to 'pdf') * @@ -3242,6 +3316,8 @@ public function signatureRequestFiles(string $signature_request_id, ?string $fil * * Download Files * + * Example: https://github.com/hellosign/dropbox-sign-php/blob/main/examples/SignatureRequestFilesExample.php + * * @param string $signature_request_id The id of the SignatureRequest to retrieve. (required) * @param string|null $file_type Set to `pdf` for a single merged document or `zip` for a collection of individual documents. (optional, default to 'pdf') * @param string $contentType The value for the Content-Type header. Check self::contentTypes['signatureRequestFiles'] to see the possible values for this operation @@ -3380,6 +3456,8 @@ public function signatureRequestFilesWithHttpInfo(string $signature_request_id, * * Download Files * + * Example: https://github.com/hellosign/dropbox-sign-php/blob/main/examples/SignatureRequestFilesExample.php + * * @param string $signature_request_id The id of the SignatureRequest to retrieve. (required) * @param string|null $file_type Set to `pdf` for a single merged document or `zip` for a collection of individual documents. (optional, default to 'pdf') * @param string $contentType The value for the Content-Type header. Check self::contentTypes['signatureRequestFiles'] to see the possible values for this operation @@ -3403,6 +3481,8 @@ function ($response) { * * Download Files * + * Example: https://github.com/hellosign/dropbox-sign-php/blob/main/examples/SignatureRequestFilesExample.php + * * @param string $signature_request_id The id of the SignatureRequest to retrieve. (required) * @param string|null $file_type Set to `pdf` for a single merged document or `zip` for a collection of individual documents. (optional, default to 'pdf') * @param string $contentType The value for the Content-Type header. Check self::contentTypes['signatureRequestFiles'] to see the possible values for this operation @@ -3571,6 +3651,8 @@ public function signatureRequestFilesRequest(string $signature_request_id, ?stri * * Download Files as Data Uri * + * Example: https://github.com/hellosign/dropbox-sign-php/blob/main/examples/SignatureRequestFilesAsDataUriExample.php + * * @param string $signature_request_id The id of the SignatureRequest to retrieve. (required) * * @return Model\FileResponseDataUri @@ -3588,6 +3670,8 @@ public function signatureRequestFilesAsDataUri(string $signature_request_id) * * Download Files as Data Uri * + * Example: https://github.com/hellosign/dropbox-sign-php/blob/main/examples/SignatureRequestFilesAsDataUriExample.php + * * @param string $signature_request_id The id of the SignatureRequest to retrieve. (required) * @param string $contentType The value for the Content-Type header. Check self::contentTypes['signatureRequestFilesAsDataUri'] to see the possible values for this operation * @@ -3725,6 +3809,8 @@ public function signatureRequestFilesAsDataUriWithHttpInfo(string $signature_req * * Download Files as Data Uri * + * Example: https://github.com/hellosign/dropbox-sign-php/blob/main/examples/SignatureRequestFilesAsDataUriExample.php + * * @param string $signature_request_id The id of the SignatureRequest to retrieve. (required) * @param string $contentType The value for the Content-Type header. Check self::contentTypes['signatureRequestFilesAsDataUri'] to see the possible values for this operation * @@ -3747,6 +3833,8 @@ function ($response) { * * Download Files as Data Uri * + * Example: https://github.com/hellosign/dropbox-sign-php/blob/main/examples/SignatureRequestFilesAsDataUriExample.php + * * @param string $signature_request_id The id of the SignatureRequest to retrieve. (required) * @param string $contentType The value for the Content-Type header. Check self::contentTypes['signatureRequestFilesAsDataUri'] to see the possible values for this operation * @@ -3903,6 +3991,8 @@ public function signatureRequestFilesAsDataUriRequest(string $signature_request_ * * Download Files as File Url * + * Example: https://github.com/hellosign/dropbox-sign-php/blob/main/examples/SignatureRequestFilesAsFileUrlExample.php + * * @param string $signature_request_id The id of the SignatureRequest to retrieve. (required) * @param int|null $force_download By default when opening the `file_url` a browser will download the PDF and save it locally. When set to `0` the PDF file will be displayed in the browser. (optional, default to 1) * @@ -3921,6 +4011,8 @@ public function signatureRequestFilesAsFileUrl(string $signature_request_id, ?in * * Download Files as File Url * + * Example: https://github.com/hellosign/dropbox-sign-php/blob/main/examples/SignatureRequestFilesAsFileUrlExample.php + * * @param string $signature_request_id The id of the SignatureRequest to retrieve. (required) * @param int|null $force_download By default when opening the `file_url` a browser will download the PDF and save it locally. When set to `0` the PDF file will be displayed in the browser. (optional, default to 1) * @param string $contentType The value for the Content-Type header. Check self::contentTypes['signatureRequestFilesAsFileUrl'] to see the possible values for this operation @@ -4059,6 +4151,8 @@ public function signatureRequestFilesAsFileUrlWithHttpInfo(string $signature_req * * Download Files as File Url * + * Example: https://github.com/hellosign/dropbox-sign-php/blob/main/examples/SignatureRequestFilesAsFileUrlExample.php + * * @param string $signature_request_id The id of the SignatureRequest to retrieve. (required) * @param int|null $force_download By default when opening the `file_url` a browser will download the PDF and save it locally. When set to `0` the PDF file will be displayed in the browser. (optional, default to 1) * @param string $contentType The value for the Content-Type header. Check self::contentTypes['signatureRequestFilesAsFileUrl'] to see the possible values for this operation @@ -4082,6 +4176,8 @@ function ($response) { * * Download Files as File Url * + * Example: https://github.com/hellosign/dropbox-sign-php/blob/main/examples/SignatureRequestFilesAsFileUrlExample.php + * * @param string $signature_request_id The id of the SignatureRequest to retrieve. (required) * @param int|null $force_download By default when opening the `file_url` a browser will download the PDF and save it locally. When set to `0` the PDF file will be displayed in the browser. (optional, default to 1) * @param string $contentType The value for the Content-Type header. Check self::contentTypes['signatureRequestFilesAsFileUrl'] to see the possible values for this operation @@ -4250,6 +4346,8 @@ public function signatureRequestFilesAsFileUrlRequest(string $signature_request_ * * Get Signature Request * + * Example: https://github.com/hellosign/dropbox-sign-php/blob/main/examples/SignatureRequestGetExample.php + * * @param string $signature_request_id The id of the SignatureRequest to retrieve. (required) * * @return Model\SignatureRequestGetResponse @@ -4267,6 +4365,8 @@ public function signatureRequestGet(string $signature_request_id) * * Get Signature Request * + * Example: https://github.com/hellosign/dropbox-sign-php/blob/main/examples/SignatureRequestGetExample.php + * * @param string $signature_request_id The id of the SignatureRequest to retrieve. (required) * @param string $contentType The value for the Content-Type header. Check self::contentTypes['signatureRequestGet'] to see the possible values for this operation * @@ -4404,6 +4504,8 @@ public function signatureRequestGetWithHttpInfo(string $signature_request_id, st * * Get Signature Request * + * Example: https://github.com/hellosign/dropbox-sign-php/blob/main/examples/SignatureRequestGetExample.php + * * @param string $signature_request_id The id of the SignatureRequest to retrieve. (required) * @param string $contentType The value for the Content-Type header. Check self::contentTypes['signatureRequestGet'] to see the possible values for this operation * @@ -4426,6 +4528,8 @@ function ($response) { * * Get Signature Request * + * Example: https://github.com/hellosign/dropbox-sign-php/blob/main/examples/SignatureRequestGetExample.php + * * @param string $signature_request_id The id of the SignatureRequest to retrieve. (required) * @param string $contentType The value for the Content-Type header. Check self::contentTypes['signatureRequestGet'] to see the possible values for this operation * @@ -4582,6 +4686,8 @@ public function signatureRequestGetRequest(string $signature_request_id, string * * List Signature Requests * + * Example: https://github.com/hellosign/dropbox-sign-php/blob/main/examples/SignatureRequestListExample.php + * * @param string|null $account_id Which account to return SignatureRequests for. Must be a team member. Use `all` to indicate all team members. Defaults to your account. (optional) * @param int|null $page Which page number of the SignatureRequest List to return. Defaults to `1`. (optional, default to 1) * @param int|null $page_size Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. (optional, default to 20) @@ -4602,6 +4708,8 @@ public function signatureRequestList(?string $account_id = null, ?int $page = 1, * * List Signature Requests * + * Example: https://github.com/hellosign/dropbox-sign-php/blob/main/examples/SignatureRequestListExample.php + * * @param string|null $account_id Which account to return SignatureRequests for. Must be a team member. Use `all` to indicate all team members. Defaults to your account. (optional) * @param int|null $page Which page number of the SignatureRequest List to return. Defaults to `1`. (optional, default to 1) * @param int|null $page_size Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. (optional, default to 20) @@ -4742,6 +4850,8 @@ public function signatureRequestListWithHttpInfo(?string $account_id = null, ?in * * List Signature Requests * + * Example: https://github.com/hellosign/dropbox-sign-php/blob/main/examples/SignatureRequestListExample.php + * * @param string|null $account_id Which account to return SignatureRequests for. Must be a team member. Use `all` to indicate all team members. Defaults to your account. (optional) * @param int|null $page Which page number of the SignatureRequest List to return. Defaults to `1`. (optional, default to 1) * @param int|null $page_size Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. (optional, default to 20) @@ -4767,6 +4877,8 @@ function ($response) { * * List Signature Requests * + * Example: https://github.com/hellosign/dropbox-sign-php/blob/main/examples/SignatureRequestListExample.php + * * @param string|null $account_id Which account to return SignatureRequests for. Must be a team member. Use `all` to indicate all team members. Defaults to your account. (optional) * @param int|null $page Which page number of the SignatureRequest List to return. Defaults to `1`. (optional, default to 1) * @param int|null $page_size Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. (optional, default to 20) @@ -4950,6 +5062,8 @@ public function signatureRequestListRequest(?string $account_id = null, ?int $pa * * Release On-Hold Signature Request * + * Example: https://github.com/hellosign/dropbox-sign-php/blob/main/examples/SignatureRequestReleaseHoldExample.php + * * @param string $signature_request_id The id of the SignatureRequest to release. (required) * * @return Model\SignatureRequestGetResponse @@ -4967,6 +5081,8 @@ public function signatureRequestReleaseHold(string $signature_request_id) * * Release On-Hold Signature Request * + * Example: https://github.com/hellosign/dropbox-sign-php/blob/main/examples/SignatureRequestReleaseHoldExample.php + * * @param string $signature_request_id The id of the SignatureRequest to release. (required) * @param string $contentType The value for the Content-Type header. Check self::contentTypes['signatureRequestReleaseHold'] to see the possible values for this operation * @@ -5104,6 +5220,8 @@ public function signatureRequestReleaseHoldWithHttpInfo(string $signature_reques * * Release On-Hold Signature Request * + * Example: https://github.com/hellosign/dropbox-sign-php/blob/main/examples/SignatureRequestReleaseHoldExample.php + * * @param string $signature_request_id The id of the SignatureRequest to release. (required) * @param string $contentType The value for the Content-Type header. Check self::contentTypes['signatureRequestReleaseHold'] to see the possible values for this operation * @@ -5126,6 +5244,8 @@ function ($response) { * * Release On-Hold Signature Request * + * Example: https://github.com/hellosign/dropbox-sign-php/blob/main/examples/SignatureRequestReleaseHoldExample.php + * * @param string $signature_request_id The id of the SignatureRequest to release. (required) * @param string $contentType The value for the Content-Type header. Check self::contentTypes['signatureRequestReleaseHold'] to see the possible values for this operation * @@ -5282,6 +5402,8 @@ public function signatureRequestReleaseHoldRequest(string $signature_request_id, * * Send Request Reminder * + * Example: https://github.com/hellosign/dropbox-sign-php/blob/main/examples/SignatureRequestRemindExample.php + * * @param string $signature_request_id The id of the SignatureRequest to send a reminder for. (required) * @param Model\SignatureRequestRemindRequest $signature_request_remind_request signature_request_remind_request (required) * @@ -5300,6 +5422,8 @@ public function signatureRequestRemind(string $signature_request_id, Model\Signa * * Send Request Reminder * + * Example: https://github.com/hellosign/dropbox-sign-php/blob/main/examples/SignatureRequestRemindExample.php + * * @param string $signature_request_id The id of the SignatureRequest to send a reminder for. (required) * @param Model\SignatureRequestRemindRequest $signature_request_remind_request (required) * @param string $contentType The value for the Content-Type header. Check self::contentTypes['signatureRequestRemind'] to see the possible values for this operation @@ -5438,6 +5562,8 @@ public function signatureRequestRemindWithHttpInfo(string $signature_request_id, * * Send Request Reminder * + * Example: https://github.com/hellosign/dropbox-sign-php/blob/main/examples/SignatureRequestRemindExample.php + * * @param string $signature_request_id The id of the SignatureRequest to send a reminder for. (required) * @param Model\SignatureRequestRemindRequest $signature_request_remind_request (required) * @param string $contentType The value for the Content-Type header. Check self::contentTypes['signatureRequestRemind'] to see the possible values for this operation @@ -5461,6 +5587,8 @@ function ($response) { * * Send Request Reminder * + * Example: https://github.com/hellosign/dropbox-sign-php/blob/main/examples/SignatureRequestRemindExample.php + * * @param string $signature_request_id The id of the SignatureRequest to send a reminder for. (required) * @param Model\SignatureRequestRemindRequest $signature_request_remind_request (required) * @param string $contentType The value for the Content-Type header. Check self::contentTypes['signatureRequestRemind'] to see the possible values for this operation @@ -5642,6 +5770,8 @@ public function signatureRequestRemindRequest(string $signature_request_id, Mode * * Remove Signature Request Access * + * Example: https://github.com/hellosign/dropbox-sign-php/blob/main/examples/SignatureRequestRemoveExample.php + * * @param string $signature_request_id The id of the SignatureRequest to remove. (required) * * @throws ApiException on non-2xx response or if the response body is not in the expected format @@ -5657,6 +5787,8 @@ public function signatureRequestRemove(string $signature_request_id) * * Remove Signature Request Access * + * Example: https://github.com/hellosign/dropbox-sign-php/blob/main/examples/SignatureRequestRemoveExample.php + * * @param string $signature_request_id The id of the SignatureRequest to remove. (required) * @param string $contentType The value for the Content-Type header. Check self::contentTypes['signatureRequestRemove'] to see the possible values for this operation * @@ -5708,6 +5840,8 @@ public function signatureRequestRemoveWithHttpInfo(string $signature_request_id, * * Remove Signature Request Access * + * Example: https://github.com/hellosign/dropbox-sign-php/blob/main/examples/SignatureRequestRemoveExample.php + * * @param string $signature_request_id The id of the SignatureRequest to remove. (required) * @param string $contentType The value for the Content-Type header. Check self::contentTypes['signatureRequestRemove'] to see the possible values for this operation * @@ -5730,6 +5864,8 @@ function ($response) { * * Remove Signature Request Access * + * Example: https://github.com/hellosign/dropbox-sign-php/blob/main/examples/SignatureRequestRemoveExample.php + * * @param string $signature_request_id The id of the SignatureRequest to remove. (required) * @param string $contentType The value for the Content-Type header. Check self::contentTypes['signatureRequestRemove'] to see the possible values for this operation * @@ -5869,6 +6005,8 @@ public function signatureRequestRemoveRequest(string $signature_request_id, stri * * Send Signature Request * + * Example: https://github.com/hellosign/dropbox-sign-php/blob/main/examples/SignatureRequestSendExample.php + * * @param Model\SignatureRequestSendRequest $signature_request_send_request signature_request_send_request (required) * * @return Model\SignatureRequestGetResponse @@ -5886,6 +6024,8 @@ public function signatureRequestSend(Model\SignatureRequestSendRequest $signatur * * Send Signature Request * + * Example: https://github.com/hellosign/dropbox-sign-php/blob/main/examples/SignatureRequestSendExample.php + * * @param Model\SignatureRequestSendRequest $signature_request_send_request (required) * @param string $contentType The value for the Content-Type header. Check self::contentTypes['signatureRequestSend'] to see the possible values for this operation * @@ -6023,6 +6163,8 @@ public function signatureRequestSendWithHttpInfo(Model\SignatureRequestSendReque * * Send Signature Request * + * Example: https://github.com/hellosign/dropbox-sign-php/blob/main/examples/SignatureRequestSendExample.php + * * @param Model\SignatureRequestSendRequest $signature_request_send_request (required) * @param string $contentType The value for the Content-Type header. Check self::contentTypes['signatureRequestSend'] to see the possible values for this operation * @@ -6045,6 +6187,8 @@ function ($response) { * * Send Signature Request * + * Example: https://github.com/hellosign/dropbox-sign-php/blob/main/examples/SignatureRequestSendExample.php + * * @param Model\SignatureRequestSendRequest $signature_request_send_request (required) * @param string $contentType The value for the Content-Type header. Check self::contentTypes['signatureRequestSend'] to see the possible values for this operation * @@ -6208,6 +6352,8 @@ public function signatureRequestSendRequest(Model\SignatureRequestSendRequest $s * * Send with Template * + * Example: https://github.com/hellosign/dropbox-sign-php/blob/main/examples/SignatureRequestSendWithTemplateExample.php + * * @param Model\SignatureRequestSendWithTemplateRequest $signature_request_send_with_template_request signature_request_send_with_template_request (required) * * @return Model\SignatureRequestGetResponse @@ -6225,6 +6371,8 @@ public function signatureRequestSendWithTemplate(Model\SignatureRequestSendWithT * * Send with Template * + * Example: https://github.com/hellosign/dropbox-sign-php/blob/main/examples/SignatureRequestSendWithTemplateExample.php + * * @param Model\SignatureRequestSendWithTemplateRequest $signature_request_send_with_template_request (required) * @param string $contentType The value for the Content-Type header. Check self::contentTypes['signatureRequestSendWithTemplate'] to see the possible values for this operation * @@ -6362,6 +6510,8 @@ public function signatureRequestSendWithTemplateWithHttpInfo(Model\SignatureRequ * * Send with Template * + * Example: https://github.com/hellosign/dropbox-sign-php/blob/main/examples/SignatureRequestSendWithTemplateExample.php + * * @param Model\SignatureRequestSendWithTemplateRequest $signature_request_send_with_template_request (required) * @param string $contentType The value for the Content-Type header. Check self::contentTypes['signatureRequestSendWithTemplate'] to see the possible values for this operation * @@ -6384,6 +6534,8 @@ function ($response) { * * Send with Template * + * Example: https://github.com/hellosign/dropbox-sign-php/blob/main/examples/SignatureRequestSendWithTemplateExample.php + * * @param Model\SignatureRequestSendWithTemplateRequest $signature_request_send_with_template_request (required) * @param string $contentType The value for the Content-Type header. Check self::contentTypes['signatureRequestSendWithTemplate'] to see the possible values for this operation * @@ -6547,6 +6699,8 @@ public function signatureRequestSendWithTemplateRequest(Model\SignatureRequestSe * * Update Signature Request * + * Example: https://github.com/hellosign/dropbox-sign-php/blob/main/examples/SignatureRequestUpdateExample.php + * * @param string $signature_request_id The id of the SignatureRequest to update. (required) * @param Model\SignatureRequestUpdateRequest $signature_request_update_request signature_request_update_request (required) * @@ -6565,6 +6719,8 @@ public function signatureRequestUpdate(string $signature_request_id, Model\Signa * * Update Signature Request * + * Example: https://github.com/hellosign/dropbox-sign-php/blob/main/examples/SignatureRequestUpdateExample.php + * * @param string $signature_request_id The id of the SignatureRequest to update. (required) * @param Model\SignatureRequestUpdateRequest $signature_request_update_request (required) * @param string $contentType The value for the Content-Type header. Check self::contentTypes['signatureRequestUpdate'] to see the possible values for this operation @@ -6703,6 +6859,8 @@ public function signatureRequestUpdateWithHttpInfo(string $signature_request_id, * * Update Signature Request * + * Example: https://github.com/hellosign/dropbox-sign-php/blob/main/examples/SignatureRequestUpdateExample.php + * * @param string $signature_request_id The id of the SignatureRequest to update. (required) * @param Model\SignatureRequestUpdateRequest $signature_request_update_request (required) * @param string $contentType The value for the Content-Type header. Check self::contentTypes['signatureRequestUpdate'] to see the possible values for this operation @@ -6726,6 +6884,8 @@ function ($response) { * * Update Signature Request * + * Example: https://github.com/hellosign/dropbox-sign-php/blob/main/examples/SignatureRequestUpdateExample.php + * * @param string $signature_request_id The id of the SignatureRequest to update. (required) * @param Model\SignatureRequestUpdateRequest $signature_request_update_request (required) * @param string $contentType The value for the Content-Type header. Check self::contentTypes['signatureRequestUpdate'] to see the possible values for this operation diff --git a/sdks/php/src/Api/TeamApi.php b/sdks/php/src/Api/TeamApi.php index 8b61a5d4b..93652aeb9 100644 --- a/sdks/php/src/Api/TeamApi.php +++ b/sdks/php/src/Api/TeamApi.php @@ -160,6 +160,8 @@ public function getResponse() * * Add User to Team * + * Example: https://github.com/hellosign/dropbox-sign-php/blob/main/examples/TeamAddMemberExample.php + * * @param Model\TeamAddMemberRequest $team_add_member_request team_add_member_request (required) * @param string|null $team_id The id of the team. (optional) * @@ -178,6 +180,8 @@ public function teamAddMember(Model\TeamAddMemberRequest $team_add_member_reques * * Add User to Team * + * Example: https://github.com/hellosign/dropbox-sign-php/blob/main/examples/TeamAddMemberExample.php + * * @param Model\TeamAddMemberRequest $team_add_member_request (required) * @param string|null $team_id The id of the team. (optional) * @param string $contentType The value for the Content-Type header. Check self::contentTypes['teamAddMember'] to see the possible values for this operation @@ -316,6 +320,8 @@ public function teamAddMemberWithHttpInfo(Model\TeamAddMemberRequest $team_add_m * * Add User to Team * + * Example: https://github.com/hellosign/dropbox-sign-php/blob/main/examples/TeamAddMemberExample.php + * * @param Model\TeamAddMemberRequest $team_add_member_request (required) * @param string|null $team_id The id of the team. (optional) * @param string $contentType The value for the Content-Type header. Check self::contentTypes['teamAddMember'] to see the possible values for this operation @@ -339,6 +345,8 @@ function ($response) { * * Add User to Team * + * Example: https://github.com/hellosign/dropbox-sign-php/blob/main/examples/TeamAddMemberExample.php + * * @param Model\TeamAddMemberRequest $team_add_member_request (required) * @param string|null $team_id The id of the team. (optional) * @param string $contentType The value for the Content-Type header. Check self::contentTypes['teamAddMember'] to see the possible values for this operation @@ -513,6 +521,8 @@ public function teamAddMemberRequest(Model\TeamAddMemberRequest $team_add_member * * Create Team * + * Example: https://github.com/hellosign/dropbox-sign-php/blob/main/examples/TeamCreateExample.php + * * @param Model\TeamCreateRequest $team_create_request team_create_request (required) * * @return Model\TeamGetResponse @@ -530,6 +540,8 @@ public function teamCreate(Model\TeamCreateRequest $team_create_request) * * Create Team * + * Example: https://github.com/hellosign/dropbox-sign-php/blob/main/examples/TeamCreateExample.php + * * @param Model\TeamCreateRequest $team_create_request (required) * @param string $contentType The value for the Content-Type header. Check self::contentTypes['teamCreate'] to see the possible values for this operation * @@ -667,6 +679,8 @@ public function teamCreateWithHttpInfo(Model\TeamCreateRequest $team_create_requ * * Create Team * + * Example: https://github.com/hellosign/dropbox-sign-php/blob/main/examples/TeamCreateExample.php + * * @param Model\TeamCreateRequest $team_create_request (required) * @param string $contentType The value for the Content-Type header. Check self::contentTypes['teamCreate'] to see the possible values for this operation * @@ -689,6 +703,8 @@ function ($response) { * * Create Team * + * Example: https://github.com/hellosign/dropbox-sign-php/blob/main/examples/TeamCreateExample.php + * * @param Model\TeamCreateRequest $team_create_request (required) * @param string $contentType The value for the Content-Type header. Check self::contentTypes['teamCreate'] to see the possible values for this operation * @@ -852,6 +868,8 @@ public function teamCreateRequest(Model\TeamCreateRequest $team_create_request, * * Delete Team * + * Example: https://github.com/hellosign/dropbox-sign-php/blob/main/examples/TeamDeleteExample.php + * * @throws ApiException on non-2xx response or if the response body is not in the expected format * @throws InvalidArgumentException */ @@ -865,6 +883,8 @@ public function teamDelete() * * Delete Team * + * Example: https://github.com/hellosign/dropbox-sign-php/blob/main/examples/TeamDeleteExample.php + * * @param string $contentType The value for the Content-Type header. Check self::contentTypes['teamDelete'] to see the possible values for this operation * * @return array of null, HTTP status code, HTTP response headers (array of strings) @@ -915,6 +935,8 @@ public function teamDeleteWithHttpInfo(string $contentType = self::contentTypes[ * * Delete Team * + * Example: https://github.com/hellosign/dropbox-sign-php/blob/main/examples/TeamDeleteExample.php + * * @param string $contentType The value for the Content-Type header. Check self::contentTypes['teamDelete'] to see the possible values for this operation * * @return \GuzzleHttp\Promise\PromiseInterface @@ -936,6 +958,8 @@ function ($response) { * * Delete Team * + * Example: https://github.com/hellosign/dropbox-sign-php/blob/main/examples/TeamDeleteExample.php + * * @param string $contentType The value for the Content-Type header. Check self::contentTypes['teamDelete'] to see the possible values for this operation * * @return \GuzzleHttp\Promise\PromiseInterface @@ -1061,6 +1085,8 @@ public function teamDeleteRequest(string $contentType = self::contentTypes['team * * Get Team * + * Example: https://github.com/hellosign/dropbox-sign-php/blob/main/examples/TeamGetExample.php + * * @return Model\TeamGetResponse * @throws ApiException on non-2xx response or if the response body is not in the expected format * @throws InvalidArgumentException @@ -1076,6 +1102,8 @@ public function teamGet() * * Get Team * + * Example: https://github.com/hellosign/dropbox-sign-php/blob/main/examples/TeamGetExample.php + * * @param string $contentType The value for the Content-Type header. Check self::contentTypes['teamGet'] to see the possible values for this operation * * @return array of Model\TeamGetResponse, HTTP status code, HTTP response headers (array of strings) @@ -1212,6 +1240,8 @@ public function teamGetWithHttpInfo(string $contentType = self::contentTypes['te * * Get Team * + * Example: https://github.com/hellosign/dropbox-sign-php/blob/main/examples/TeamGetExample.php + * * @param string $contentType The value for the Content-Type header. Check self::contentTypes['teamGet'] to see the possible values for this operation * * @return \GuzzleHttp\Promise\PromiseInterface @@ -1233,6 +1263,8 @@ function ($response) { * * Get Team * + * Example: https://github.com/hellosign/dropbox-sign-php/blob/main/examples/TeamGetExample.php + * * @param string $contentType The value for the Content-Type header. Check self::contentTypes['teamGet'] to see the possible values for this operation * * @return \GuzzleHttp\Promise\PromiseInterface @@ -1371,6 +1403,8 @@ public function teamGetRequest(string $contentType = self::contentTypes['teamGet * * Get Team Info * + * Example: https://github.com/hellosign/dropbox-sign-php/blob/main/examples/TeamInfoExample.php + * * @param string|null $team_id The id of the team. (optional) * * @return Model\TeamGetInfoResponse @@ -1388,6 +1422,8 @@ public function teamInfo(?string $team_id = null) * * Get Team Info * + * Example: https://github.com/hellosign/dropbox-sign-php/blob/main/examples/TeamInfoExample.php + * * @param string|null $team_id The id of the team. (optional) * @param string $contentType The value for the Content-Type header. Check self::contentTypes['teamInfo'] to see the possible values for this operation * @@ -1525,6 +1561,8 @@ public function teamInfoWithHttpInfo(?string $team_id = null, string $contentTyp * * Get Team Info * + * Example: https://github.com/hellosign/dropbox-sign-php/blob/main/examples/TeamInfoExample.php + * * @param string|null $team_id The id of the team. (optional) * @param string $contentType The value for the Content-Type header. Check self::contentTypes['teamInfo'] to see the possible values for this operation * @@ -1547,6 +1585,8 @@ function ($response) { * * Get Team Info * + * Example: https://github.com/hellosign/dropbox-sign-php/blob/main/examples/TeamInfoExample.php + * * @param string|null $team_id The id of the team. (optional) * @param string $contentType The value for the Content-Type header. Check self::contentTypes['teamInfo'] to see the possible values for this operation * @@ -1697,6 +1737,8 @@ public function teamInfoRequest(?string $team_id = null, string $contentType = s * * List Team Invites * + * Example: https://github.com/hellosign/dropbox-sign-php/blob/main/examples/TeamInvitesExample.php + * * @param string|null $email_address The email address for which to display the team invites. (optional) * * @return Model\TeamInvitesResponse @@ -1714,6 +1756,8 @@ public function teamInvites(?string $email_address = null) * * List Team Invites * + * Example: https://github.com/hellosign/dropbox-sign-php/blob/main/examples/TeamInvitesExample.php + * * @param string|null $email_address The email address for which to display the team invites. (optional) * @param string $contentType The value for the Content-Type header. Check self::contentTypes['teamInvites'] to see the possible values for this operation * @@ -1851,6 +1895,8 @@ public function teamInvitesWithHttpInfo(?string $email_address = null, string $c * * List Team Invites * + * Example: https://github.com/hellosign/dropbox-sign-php/blob/main/examples/TeamInvitesExample.php + * * @param string|null $email_address The email address for which to display the team invites. (optional) * @param string $contentType The value for the Content-Type header. Check self::contentTypes['teamInvites'] to see the possible values for this operation * @@ -1873,6 +1919,8 @@ function ($response) { * * List Team Invites * + * Example: https://github.com/hellosign/dropbox-sign-php/blob/main/examples/TeamInvitesExample.php + * * @param string|null $email_address The email address for which to display the team invites. (optional) * @param string $contentType The value for the Content-Type header. Check self::contentTypes['teamInvites'] to see the possible values for this operation * @@ -2023,6 +2071,8 @@ public function teamInvitesRequest(?string $email_address = null, string $conten * * List Team Members * + * Example: https://github.com/hellosign/dropbox-sign-php/blob/main/examples/TeamMembersExample.php + * * @param string $team_id The id of the team that a member list is being requested from. (required) * @param int|null $page Which page number of the team member list to return. Defaults to `1`. (optional, default to 1) * @param int|null $page_size Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. (optional, default to 20) @@ -2042,6 +2092,8 @@ public function teamMembers(string $team_id, ?int $page = 1, ?int $page_size = 2 * * List Team Members * + * Example: https://github.com/hellosign/dropbox-sign-php/blob/main/examples/TeamMembersExample.php + * * @param string $team_id The id of the team that a member list is being requested from. (required) * @param int|null $page Which page number of the team member list to return. Defaults to `1`. (optional, default to 1) * @param int|null $page_size Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. (optional, default to 20) @@ -2181,6 +2233,8 @@ public function teamMembersWithHttpInfo(string $team_id, ?int $page = 1, ?int $p * * List Team Members * + * Example: https://github.com/hellosign/dropbox-sign-php/blob/main/examples/TeamMembersExample.php + * * @param string $team_id The id of the team that a member list is being requested from. (required) * @param int|null $page Which page number of the team member list to return. Defaults to `1`. (optional, default to 1) * @param int|null $page_size Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. (optional, default to 20) @@ -2205,6 +2259,8 @@ function ($response) { * * List Team Members * + * Example: https://github.com/hellosign/dropbox-sign-php/blob/main/examples/TeamMembersExample.php + * * @param string $team_id The id of the team that a member list is being requested from. (required) * @param int|null $page Which page number of the team member list to return. Defaults to `1`. (optional, default to 1) * @param int|null $page_size Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. (optional, default to 20) @@ -2391,6 +2447,8 @@ public function teamMembersRequest(string $team_id, ?int $page = 1, ?int $page_s * * Remove User from Team * + * Example: https://github.com/hellosign/dropbox-sign-php/blob/main/examples/TeamRemoveMemberExample.php + * * @param Model\TeamRemoveMemberRequest $team_remove_member_request team_remove_member_request (required) * * @return Model\TeamGetResponse @@ -2408,6 +2466,8 @@ public function teamRemoveMember(Model\TeamRemoveMemberRequest $team_remove_memb * * Remove User from Team * + * Example: https://github.com/hellosign/dropbox-sign-php/blob/main/examples/TeamRemoveMemberExample.php + * * @param Model\TeamRemoveMemberRequest $team_remove_member_request (required) * @param string $contentType The value for the Content-Type header. Check self::contentTypes['teamRemoveMember'] to see the possible values for this operation * @@ -2545,6 +2605,8 @@ public function teamRemoveMemberWithHttpInfo(Model\TeamRemoveMemberRequest $team * * Remove User from Team * + * Example: https://github.com/hellosign/dropbox-sign-php/blob/main/examples/TeamRemoveMemberExample.php + * * @param Model\TeamRemoveMemberRequest $team_remove_member_request (required) * @param string $contentType The value for the Content-Type header. Check self::contentTypes['teamRemoveMember'] to see the possible values for this operation * @@ -2567,6 +2629,8 @@ function ($response) { * * Remove User from Team * + * Example: https://github.com/hellosign/dropbox-sign-php/blob/main/examples/TeamRemoveMemberExample.php + * * @param Model\TeamRemoveMemberRequest $team_remove_member_request (required) * @param string $contentType The value for the Content-Type header. Check self::contentTypes['teamRemoveMember'] to see the possible values for this operation * @@ -2730,6 +2794,8 @@ public function teamRemoveMemberRequest(Model\TeamRemoveMemberRequest $team_remo * * List Sub Teams * + * Example: https://github.com/hellosign/dropbox-sign-php/blob/main/examples/TeamSubTeamsExample.php + * * @param string $team_id The id of the parent Team. (required) * @param int|null $page Which page number of the SubTeam List to return. Defaults to `1`. (optional, default to 1) * @param int|null $page_size Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. (optional, default to 20) @@ -2749,6 +2815,8 @@ public function teamSubTeams(string $team_id, ?int $page = 1, ?int $page_size = * * List Sub Teams * + * Example: https://github.com/hellosign/dropbox-sign-php/blob/main/examples/TeamSubTeamsExample.php + * * @param string $team_id The id of the parent Team. (required) * @param int|null $page Which page number of the SubTeam List to return. Defaults to `1`. (optional, default to 1) * @param int|null $page_size Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. (optional, default to 20) @@ -2888,6 +2956,8 @@ public function teamSubTeamsWithHttpInfo(string $team_id, ?int $page = 1, ?int $ * * List Sub Teams * + * Example: https://github.com/hellosign/dropbox-sign-php/blob/main/examples/TeamSubTeamsExample.php + * * @param string $team_id The id of the parent Team. (required) * @param int|null $page Which page number of the SubTeam List to return. Defaults to `1`. (optional, default to 1) * @param int|null $page_size Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. (optional, default to 20) @@ -2912,6 +2982,8 @@ function ($response) { * * List Sub Teams * + * Example: https://github.com/hellosign/dropbox-sign-php/blob/main/examples/TeamSubTeamsExample.php + * * @param string $team_id The id of the parent Team. (required) * @param int|null $page Which page number of the SubTeam List to return. Defaults to `1`. (optional, default to 1) * @param int|null $page_size Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. (optional, default to 20) @@ -3098,6 +3170,8 @@ public function teamSubTeamsRequest(string $team_id, ?int $page = 1, ?int $page_ * * Update Team * + * Example: https://github.com/hellosign/dropbox-sign-php/blob/main/examples/TeamUpdateExample.php + * * @param Model\TeamUpdateRequest $team_update_request team_update_request (required) * * @return Model\TeamGetResponse @@ -3115,6 +3189,8 @@ public function teamUpdate(Model\TeamUpdateRequest $team_update_request) * * Update Team * + * Example: https://github.com/hellosign/dropbox-sign-php/blob/main/examples/TeamUpdateExample.php + * * @param Model\TeamUpdateRequest $team_update_request (required) * @param string $contentType The value for the Content-Type header. Check self::contentTypes['teamUpdate'] to see the possible values for this operation * @@ -3252,6 +3328,8 @@ public function teamUpdateWithHttpInfo(Model\TeamUpdateRequest $team_update_requ * * Update Team * + * Example: https://github.com/hellosign/dropbox-sign-php/blob/main/examples/TeamUpdateExample.php + * * @param Model\TeamUpdateRequest $team_update_request (required) * @param string $contentType The value for the Content-Type header. Check self::contentTypes['teamUpdate'] to see the possible values for this operation * @@ -3274,6 +3352,8 @@ function ($response) { * * Update Team * + * Example: https://github.com/hellosign/dropbox-sign-php/blob/main/examples/TeamUpdateExample.php + * * @param Model\TeamUpdateRequest $team_update_request (required) * @param string $contentType The value for the Content-Type header. Check self::contentTypes['teamUpdate'] to see the possible values for this operation * diff --git a/sdks/php/src/Api/TemplateApi.php b/sdks/php/src/Api/TemplateApi.php index 2d39bc886..515142ada 100644 --- a/sdks/php/src/Api/TemplateApi.php +++ b/sdks/php/src/Api/TemplateApi.php @@ -167,6 +167,8 @@ public function getResponse() * * Add User to Template * + * Example: https://github.com/hellosign/dropbox-sign-php/blob/main/examples/TemplateAddUserExample.php + * * @param string $template_id The id of the Template to give the Account access to. (required) * @param Model\TemplateAddUserRequest $template_add_user_request template_add_user_request (required) * @@ -185,6 +187,8 @@ public function templateAddUser(string $template_id, Model\TemplateAddUserReques * * Add User to Template * + * Example: https://github.com/hellosign/dropbox-sign-php/blob/main/examples/TemplateAddUserExample.php + * * @param string $template_id The id of the Template to give the Account access to. (required) * @param Model\TemplateAddUserRequest $template_add_user_request (required) * @param string $contentType The value for the Content-Type header. Check self::contentTypes['templateAddUser'] to see the possible values for this operation @@ -323,6 +327,8 @@ public function templateAddUserWithHttpInfo(string $template_id, Model\TemplateA * * Add User to Template * + * Example: https://github.com/hellosign/dropbox-sign-php/blob/main/examples/TemplateAddUserExample.php + * * @param string $template_id The id of the Template to give the Account access to. (required) * @param Model\TemplateAddUserRequest $template_add_user_request (required) * @param string $contentType The value for the Content-Type header. Check self::contentTypes['templateAddUser'] to see the possible values for this operation @@ -346,6 +352,8 @@ function ($response) { * * Add User to Template * + * Example: https://github.com/hellosign/dropbox-sign-php/blob/main/examples/TemplateAddUserExample.php + * * @param string $template_id The id of the Template to give the Account access to. (required) * @param Model\TemplateAddUserRequest $template_add_user_request (required) * @param string $contentType The value for the Content-Type header. Check self::contentTypes['templateAddUser'] to see the possible values for this operation @@ -527,6 +535,8 @@ public function templateAddUserRequest(string $template_id, Model\TemplateAddUse * * Create Template * + * Example: https://github.com/hellosign/dropbox-sign-php/blob/main/examples/TemplateCreateExample.php + * * @param Model\TemplateCreateRequest $template_create_request template_create_request (required) * * @return Model\TemplateCreateResponse @@ -544,6 +554,8 @@ public function templateCreate(Model\TemplateCreateRequest $template_create_requ * * Create Template * + * Example: https://github.com/hellosign/dropbox-sign-php/blob/main/examples/TemplateCreateExample.php + * * @param Model\TemplateCreateRequest $template_create_request (required) * @param string $contentType The value for the Content-Type header. Check self::contentTypes['templateCreate'] to see the possible values for this operation * @@ -681,6 +693,8 @@ public function templateCreateWithHttpInfo(Model\TemplateCreateRequest $template * * Create Template * + * Example: https://github.com/hellosign/dropbox-sign-php/blob/main/examples/TemplateCreateExample.php + * * @param Model\TemplateCreateRequest $template_create_request (required) * @param string $contentType The value for the Content-Type header. Check self::contentTypes['templateCreate'] to see the possible values for this operation * @@ -703,6 +717,8 @@ function ($response) { * * Create Template * + * Example: https://github.com/hellosign/dropbox-sign-php/blob/main/examples/TemplateCreateExample.php + * * @param Model\TemplateCreateRequest $template_create_request (required) * @param string $contentType The value for the Content-Type header. Check self::contentTypes['templateCreate'] to see the possible values for this operation * @@ -866,6 +882,8 @@ public function templateCreateRequest(Model\TemplateCreateRequest $template_crea * * Create Embedded Template Draft * + * Example: https://github.com/hellosign/dropbox-sign-php/blob/main/examples/TemplateCreateEmbeddedDraftExample.php + * * @param Model\TemplateCreateEmbeddedDraftRequest $template_create_embedded_draft_request template_create_embedded_draft_request (required) * * @return Model\TemplateCreateEmbeddedDraftResponse @@ -883,6 +901,8 @@ public function templateCreateEmbeddedDraft(Model\TemplateCreateEmbeddedDraftReq * * Create Embedded Template Draft * + * Example: https://github.com/hellosign/dropbox-sign-php/blob/main/examples/TemplateCreateEmbeddedDraftExample.php + * * @param Model\TemplateCreateEmbeddedDraftRequest $template_create_embedded_draft_request (required) * @param string $contentType The value for the Content-Type header. Check self::contentTypes['templateCreateEmbeddedDraft'] to see the possible values for this operation * @@ -1020,6 +1040,8 @@ public function templateCreateEmbeddedDraftWithHttpInfo(Model\TemplateCreateEmbe * * Create Embedded Template Draft * + * Example: https://github.com/hellosign/dropbox-sign-php/blob/main/examples/TemplateCreateEmbeddedDraftExample.php + * * @param Model\TemplateCreateEmbeddedDraftRequest $template_create_embedded_draft_request (required) * @param string $contentType The value for the Content-Type header. Check self::contentTypes['templateCreateEmbeddedDraft'] to see the possible values for this operation * @@ -1042,6 +1064,8 @@ function ($response) { * * Create Embedded Template Draft * + * Example: https://github.com/hellosign/dropbox-sign-php/blob/main/examples/TemplateCreateEmbeddedDraftExample.php + * * @param Model\TemplateCreateEmbeddedDraftRequest $template_create_embedded_draft_request (required) * @param string $contentType The value for the Content-Type header. Check self::contentTypes['templateCreateEmbeddedDraft'] to see the possible values for this operation * @@ -1205,6 +1229,8 @@ public function templateCreateEmbeddedDraftRequest(Model\TemplateCreateEmbeddedD * * Delete Template * + * Example: https://github.com/hellosign/dropbox-sign-php/blob/main/examples/TemplateDeleteExample.php + * * @param string $template_id The id of the Template to delete. (required) * * @throws ApiException on non-2xx response or if the response body is not in the expected format @@ -1220,6 +1246,8 @@ public function templateDelete(string $template_id) * * Delete Template * + * Example: https://github.com/hellosign/dropbox-sign-php/blob/main/examples/TemplateDeleteExample.php + * * @param string $template_id The id of the Template to delete. (required) * @param string $contentType The value for the Content-Type header. Check self::contentTypes['templateDelete'] to see the possible values for this operation * @@ -1271,6 +1299,8 @@ public function templateDeleteWithHttpInfo(string $template_id, string $contentT * * Delete Template * + * Example: https://github.com/hellosign/dropbox-sign-php/blob/main/examples/TemplateDeleteExample.php + * * @param string $template_id The id of the Template to delete. (required) * @param string $contentType The value for the Content-Type header. Check self::contentTypes['templateDelete'] to see the possible values for this operation * @@ -1293,6 +1323,8 @@ function ($response) { * * Delete Template * + * Example: https://github.com/hellosign/dropbox-sign-php/blob/main/examples/TemplateDeleteExample.php + * * @param string $template_id The id of the Template to delete. (required) * @param string $contentType The value for the Content-Type header. Check self::contentTypes['templateDelete'] to see the possible values for this operation * @@ -1436,6 +1468,8 @@ public function templateDeleteRequest(string $template_id, string $contentType = * * Get Template Files * + * Example: https://github.com/hellosign/dropbox-sign-php/blob/main/examples/TemplateFilesExample.php + * * @param string $template_id The id of the template files to retrieve. (required) * @param string|null $file_type Set to `pdf` for a single merged document or `zip` for a collection of individual documents. (optional) * @@ -1454,6 +1488,8 @@ public function templateFiles(string $template_id, ?string $file_type = null) * * Get Template Files * + * Example: https://github.com/hellosign/dropbox-sign-php/blob/main/examples/TemplateFilesExample.php + * * @param string $template_id The id of the template files to retrieve. (required) * @param string|null $file_type Set to `pdf` for a single merged document or `zip` for a collection of individual documents. (optional) * @param string $contentType The value for the Content-Type header. Check self::contentTypes['templateFiles'] to see the possible values for this operation @@ -1592,6 +1628,8 @@ public function templateFilesWithHttpInfo(string $template_id, ?string $file_typ * * Get Template Files * + * Example: https://github.com/hellosign/dropbox-sign-php/blob/main/examples/TemplateFilesExample.php + * * @param string $template_id The id of the template files to retrieve. (required) * @param string|null $file_type Set to `pdf` for a single merged document or `zip` for a collection of individual documents. (optional) * @param string $contentType The value for the Content-Type header. Check self::contentTypes['templateFiles'] to see the possible values for this operation @@ -1615,6 +1653,8 @@ function ($response) { * * Get Template Files * + * Example: https://github.com/hellosign/dropbox-sign-php/blob/main/examples/TemplateFilesExample.php + * * @param string $template_id The id of the template files to retrieve. (required) * @param string|null $file_type Set to `pdf` for a single merged document or `zip` for a collection of individual documents. (optional) * @param string $contentType The value for the Content-Type header. Check self::contentTypes['templateFiles'] to see the possible values for this operation @@ -1783,6 +1823,8 @@ public function templateFilesRequest(string $template_id, ?string $file_type = n * * Get Template Files as Data Uri * + * Example: https://github.com/hellosign/dropbox-sign-php/blob/main/examples/TemplateFilesAsDataUriExample.php + * * @param string $template_id The id of the template files to retrieve. (required) * * @return Model\FileResponseDataUri @@ -1800,6 +1842,8 @@ public function templateFilesAsDataUri(string $template_id) * * Get Template Files as Data Uri * + * Example: https://github.com/hellosign/dropbox-sign-php/blob/main/examples/TemplateFilesAsDataUriExample.php + * * @param string $template_id The id of the template files to retrieve. (required) * @param string $contentType The value for the Content-Type header. Check self::contentTypes['templateFilesAsDataUri'] to see the possible values for this operation * @@ -1937,6 +1981,8 @@ public function templateFilesAsDataUriWithHttpInfo(string $template_id, string $ * * Get Template Files as Data Uri * + * Example: https://github.com/hellosign/dropbox-sign-php/blob/main/examples/TemplateFilesAsDataUriExample.php + * * @param string $template_id The id of the template files to retrieve. (required) * @param string $contentType The value for the Content-Type header. Check self::contentTypes['templateFilesAsDataUri'] to see the possible values for this operation * @@ -1959,6 +2005,8 @@ function ($response) { * * Get Template Files as Data Uri * + * Example: https://github.com/hellosign/dropbox-sign-php/blob/main/examples/TemplateFilesAsDataUriExample.php + * * @param string $template_id The id of the template files to retrieve. (required) * @param string $contentType The value for the Content-Type header. Check self::contentTypes['templateFilesAsDataUri'] to see the possible values for this operation * @@ -2115,6 +2163,8 @@ public function templateFilesAsDataUriRequest(string $template_id, string $conte * * Get Template Files as File Url * + * Example: https://github.com/hellosign/dropbox-sign-php/blob/main/examples/TemplateFilesAsFileUrlExample.php + * * @param string $template_id The id of the template files to retrieve. (required) * @param int|null $force_download By default when opening the `file_url` a browser will download the PDF and save it locally. When set to `0` the PDF file will be displayed in the browser. (optional, default to 1) * @@ -2133,6 +2183,8 @@ public function templateFilesAsFileUrl(string $template_id, ?int $force_download * * Get Template Files as File Url * + * Example: https://github.com/hellosign/dropbox-sign-php/blob/main/examples/TemplateFilesAsFileUrlExample.php + * * @param string $template_id The id of the template files to retrieve. (required) * @param int|null $force_download By default when opening the `file_url` a browser will download the PDF and save it locally. When set to `0` the PDF file will be displayed in the browser. (optional, default to 1) * @param string $contentType The value for the Content-Type header. Check self::contentTypes['templateFilesAsFileUrl'] to see the possible values for this operation @@ -2271,6 +2323,8 @@ public function templateFilesAsFileUrlWithHttpInfo(string $template_id, ?int $fo * * Get Template Files as File Url * + * Example: https://github.com/hellosign/dropbox-sign-php/blob/main/examples/TemplateFilesAsFileUrlExample.php + * * @param string $template_id The id of the template files to retrieve. (required) * @param int|null $force_download By default when opening the `file_url` a browser will download the PDF and save it locally. When set to `0` the PDF file will be displayed in the browser. (optional, default to 1) * @param string $contentType The value for the Content-Type header. Check self::contentTypes['templateFilesAsFileUrl'] to see the possible values for this operation @@ -2294,6 +2348,8 @@ function ($response) { * * Get Template Files as File Url * + * Example: https://github.com/hellosign/dropbox-sign-php/blob/main/examples/TemplateFilesAsFileUrlExample.php + * * @param string $template_id The id of the template files to retrieve. (required) * @param int|null $force_download By default when opening the `file_url` a browser will download the PDF and save it locally. When set to `0` the PDF file will be displayed in the browser. (optional, default to 1) * @param string $contentType The value for the Content-Type header. Check self::contentTypes['templateFilesAsFileUrl'] to see the possible values for this operation @@ -2462,6 +2518,8 @@ public function templateFilesAsFileUrlRequest(string $template_id, ?int $force_d * * Get Template * + * Example: https://github.com/hellosign/dropbox-sign-php/blob/main/examples/TemplateGetExample.php + * * @param string $template_id The id of the Template to retrieve. (required) * * @return Model\TemplateGetResponse @@ -2479,6 +2537,8 @@ public function templateGet(string $template_id) * * Get Template * + * Example: https://github.com/hellosign/dropbox-sign-php/blob/main/examples/TemplateGetExample.php + * * @param string $template_id The id of the Template to retrieve. (required) * @param string $contentType The value for the Content-Type header. Check self::contentTypes['templateGet'] to see the possible values for this operation * @@ -2616,6 +2676,8 @@ public function templateGetWithHttpInfo(string $template_id, string $contentType * * Get Template * + * Example: https://github.com/hellosign/dropbox-sign-php/blob/main/examples/TemplateGetExample.php + * * @param string $template_id The id of the Template to retrieve. (required) * @param string $contentType The value for the Content-Type header. Check self::contentTypes['templateGet'] to see the possible values for this operation * @@ -2638,6 +2700,8 @@ function ($response) { * * Get Template * + * Example: https://github.com/hellosign/dropbox-sign-php/blob/main/examples/TemplateGetExample.php + * * @param string $template_id The id of the Template to retrieve. (required) * @param string $contentType The value for the Content-Type header. Check self::contentTypes['templateGet'] to see the possible values for this operation * @@ -2794,6 +2858,8 @@ public function templateGetRequest(string $template_id, string $contentType = se * * List Templates * + * Example: https://github.com/hellosign/dropbox-sign-php/blob/main/examples/TemplateListExample.php + * * @param string|null $account_id Which account to return Templates for. Must be a team member. Use `all` to indicate all team members. Defaults to your account. (optional) * @param int|null $page Which page number of the Template List to return. Defaults to `1`. (optional, default to 1) * @param int|null $page_size Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. (optional, default to 20) @@ -2814,6 +2880,8 @@ public function templateList(?string $account_id = null, ?int $page = 1, ?int $p * * List Templates * + * Example: https://github.com/hellosign/dropbox-sign-php/blob/main/examples/TemplateListExample.php + * * @param string|null $account_id Which account to return Templates for. Must be a team member. Use `all` to indicate all team members. Defaults to your account. (optional) * @param int|null $page Which page number of the Template List to return. Defaults to `1`. (optional, default to 1) * @param int|null $page_size Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. (optional, default to 20) @@ -2954,6 +3022,8 @@ public function templateListWithHttpInfo(?string $account_id = null, ?int $page * * List Templates * + * Example: https://github.com/hellosign/dropbox-sign-php/blob/main/examples/TemplateListExample.php + * * @param string|null $account_id Which account to return Templates for. Must be a team member. Use `all` to indicate all team members. Defaults to your account. (optional) * @param int|null $page Which page number of the Template List to return. Defaults to `1`. (optional, default to 1) * @param int|null $page_size Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. (optional, default to 20) @@ -2979,6 +3049,8 @@ function ($response) { * * List Templates * + * Example: https://github.com/hellosign/dropbox-sign-php/blob/main/examples/TemplateListExample.php + * * @param string|null $account_id Which account to return Templates for. Must be a team member. Use `all` to indicate all team members. Defaults to your account. (optional) * @param int|null $page Which page number of the Template List to return. Defaults to `1`. (optional, default to 1) * @param int|null $page_size Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. (optional, default to 20) @@ -3169,6 +3241,8 @@ public function templateListRequest(?string $account_id = null, ?int $page = 1, * * Remove User from Template * + * Example: https://github.com/hellosign/dropbox-sign-php/blob/main/examples/TemplateRemoveUserExample.php + * * @param string $template_id The id of the Template to remove the Account's access to. (required) * @param Model\TemplateRemoveUserRequest $template_remove_user_request template_remove_user_request (required) * @@ -3187,6 +3261,8 @@ public function templateRemoveUser(string $template_id, Model\TemplateRemoveUser * * Remove User from Template * + * Example: https://github.com/hellosign/dropbox-sign-php/blob/main/examples/TemplateRemoveUserExample.php + * * @param string $template_id The id of the Template to remove the Account's access to. (required) * @param Model\TemplateRemoveUserRequest $template_remove_user_request (required) * @param string $contentType The value for the Content-Type header. Check self::contentTypes['templateRemoveUser'] to see the possible values for this operation @@ -3325,6 +3401,8 @@ public function templateRemoveUserWithHttpInfo(string $template_id, Model\Templa * * Remove User from Template * + * Example: https://github.com/hellosign/dropbox-sign-php/blob/main/examples/TemplateRemoveUserExample.php + * * @param string $template_id The id of the Template to remove the Account's access to. (required) * @param Model\TemplateRemoveUserRequest $template_remove_user_request (required) * @param string $contentType The value for the Content-Type header. Check self::contentTypes['templateRemoveUser'] to see the possible values for this operation @@ -3348,6 +3426,8 @@ function ($response) { * * Remove User from Template * + * Example: https://github.com/hellosign/dropbox-sign-php/blob/main/examples/TemplateRemoveUserExample.php + * * @param string $template_id The id of the Template to remove the Account's access to. (required) * @param Model\TemplateRemoveUserRequest $template_remove_user_request (required) * @param string $contentType The value for the Content-Type header. Check self::contentTypes['templateRemoveUser'] to see the possible values for this operation @@ -3529,6 +3609,8 @@ public function templateRemoveUserRequest(string $template_id, Model\TemplateRem * * Update Template Files * + * Example: https://github.com/hellosign/dropbox-sign-php/blob/main/examples/TemplateUpdateFilesExample.php + * * @param string $template_id The ID of the template whose files to update. (required) * @param Model\TemplateUpdateFilesRequest $template_update_files_request template_update_files_request (required) * @@ -3547,6 +3629,8 @@ public function templateUpdateFiles(string $template_id, Model\TemplateUpdateFil * * Update Template Files * + * Example: https://github.com/hellosign/dropbox-sign-php/blob/main/examples/TemplateUpdateFilesExample.php + * * @param string $template_id The ID of the template whose files to update. (required) * @param Model\TemplateUpdateFilesRequest $template_update_files_request (required) * @param string $contentType The value for the Content-Type header. Check self::contentTypes['templateUpdateFiles'] to see the possible values for this operation @@ -3685,6 +3769,8 @@ public function templateUpdateFilesWithHttpInfo(string $template_id, Model\Templ * * Update Template Files * + * Example: https://github.com/hellosign/dropbox-sign-php/blob/main/examples/TemplateUpdateFilesExample.php + * * @param string $template_id The ID of the template whose files to update. (required) * @param Model\TemplateUpdateFilesRequest $template_update_files_request (required) * @param string $contentType The value for the Content-Type header. Check self::contentTypes['templateUpdateFiles'] to see the possible values for this operation @@ -3708,6 +3794,8 @@ function ($response) { * * Update Template Files * + * Example: https://github.com/hellosign/dropbox-sign-php/blob/main/examples/TemplateUpdateFilesExample.php + * * @param string $template_id The ID of the template whose files to update. (required) * @param Model\TemplateUpdateFilesRequest $template_update_files_request (required) * @param string $contentType The value for the Content-Type header. Check self::contentTypes['templateUpdateFiles'] to see the possible values for this operation diff --git a/sdks/php/src/Api/UnclaimedDraftApi.php b/sdks/php/src/Api/UnclaimedDraftApi.php index bb24fb1d9..fbc0a7768 100644 --- a/sdks/php/src/Api/UnclaimedDraftApi.php +++ b/sdks/php/src/Api/UnclaimedDraftApi.php @@ -145,6 +145,8 @@ public function getResponse() * * Create Unclaimed Draft * + * Example: https://github.com/hellosign/dropbox-sign-php/blob/main/examples/UnclaimedDraftCreateExample.php + * * @param Model\UnclaimedDraftCreateRequest $unclaimed_draft_create_request unclaimed_draft_create_request (required) * * @return Model\UnclaimedDraftCreateResponse @@ -162,6 +164,8 @@ public function unclaimedDraftCreate(Model\UnclaimedDraftCreateRequest $unclaime * * Create Unclaimed Draft * + * Example: https://github.com/hellosign/dropbox-sign-php/blob/main/examples/UnclaimedDraftCreateExample.php + * * @param Model\UnclaimedDraftCreateRequest $unclaimed_draft_create_request (required) * @param string $contentType The value for the Content-Type header. Check self::contentTypes['unclaimedDraftCreate'] to see the possible values for this operation * @@ -299,6 +303,8 @@ public function unclaimedDraftCreateWithHttpInfo(Model\UnclaimedDraftCreateReque * * Create Unclaimed Draft * + * Example: https://github.com/hellosign/dropbox-sign-php/blob/main/examples/UnclaimedDraftCreateExample.php + * * @param Model\UnclaimedDraftCreateRequest $unclaimed_draft_create_request (required) * @param string $contentType The value for the Content-Type header. Check self::contentTypes['unclaimedDraftCreate'] to see the possible values for this operation * @@ -321,6 +327,8 @@ function ($response) { * * Create Unclaimed Draft * + * Example: https://github.com/hellosign/dropbox-sign-php/blob/main/examples/UnclaimedDraftCreateExample.php + * * @param Model\UnclaimedDraftCreateRequest $unclaimed_draft_create_request (required) * @param string $contentType The value for the Content-Type header. Check self::contentTypes['unclaimedDraftCreate'] to see the possible values for this operation * @@ -484,6 +492,8 @@ public function unclaimedDraftCreateRequest(Model\UnclaimedDraftCreateRequest $u * * Create Embedded Unclaimed Draft * + * Example: https://github.com/hellosign/dropbox-sign-php/blob/main/examples/UnclaimedDraftCreateEmbeddedExample.php + * * @param Model\UnclaimedDraftCreateEmbeddedRequest $unclaimed_draft_create_embedded_request unclaimed_draft_create_embedded_request (required) * * @return Model\UnclaimedDraftCreateResponse @@ -501,6 +511,8 @@ public function unclaimedDraftCreateEmbedded(Model\UnclaimedDraftCreateEmbeddedR * * Create Embedded Unclaimed Draft * + * Example: https://github.com/hellosign/dropbox-sign-php/blob/main/examples/UnclaimedDraftCreateEmbeddedExample.php + * * @param Model\UnclaimedDraftCreateEmbeddedRequest $unclaimed_draft_create_embedded_request (required) * @param string $contentType The value for the Content-Type header. Check self::contentTypes['unclaimedDraftCreateEmbedded'] to see the possible values for this operation * @@ -638,6 +650,8 @@ public function unclaimedDraftCreateEmbeddedWithHttpInfo(Model\UnclaimedDraftCre * * Create Embedded Unclaimed Draft * + * Example: https://github.com/hellosign/dropbox-sign-php/blob/main/examples/UnclaimedDraftCreateEmbeddedExample.php + * * @param Model\UnclaimedDraftCreateEmbeddedRequest $unclaimed_draft_create_embedded_request (required) * @param string $contentType The value for the Content-Type header. Check self::contentTypes['unclaimedDraftCreateEmbedded'] to see the possible values for this operation * @@ -660,6 +674,8 @@ function ($response) { * * Create Embedded Unclaimed Draft * + * Example: https://github.com/hellosign/dropbox-sign-php/blob/main/examples/UnclaimedDraftCreateEmbeddedExample.php + * * @param Model\UnclaimedDraftCreateEmbeddedRequest $unclaimed_draft_create_embedded_request (required) * @param string $contentType The value for the Content-Type header. Check self::contentTypes['unclaimedDraftCreateEmbedded'] to see the possible values for this operation * @@ -823,6 +839,8 @@ public function unclaimedDraftCreateEmbeddedRequest(Model\UnclaimedDraftCreateEm * * Create Embedded Unclaimed Draft with Template * + * Example: https://github.com/hellosign/dropbox-sign-php/blob/main/examples/UnclaimedDraftCreateEmbeddedWithTemplateExample.php + * * @param Model\UnclaimedDraftCreateEmbeddedWithTemplateRequest $unclaimed_draft_create_embedded_with_template_request unclaimed_draft_create_embedded_with_template_request (required) * * @return Model\UnclaimedDraftCreateResponse @@ -840,6 +858,8 @@ public function unclaimedDraftCreateEmbeddedWithTemplate(Model\UnclaimedDraftCre * * Create Embedded Unclaimed Draft with Template * + * Example: https://github.com/hellosign/dropbox-sign-php/blob/main/examples/UnclaimedDraftCreateEmbeddedWithTemplateExample.php + * * @param Model\UnclaimedDraftCreateEmbeddedWithTemplateRequest $unclaimed_draft_create_embedded_with_template_request (required) * @param string $contentType The value for the Content-Type header. Check self::contentTypes['unclaimedDraftCreateEmbeddedWithTemplate'] to see the possible values for this operation * @@ -977,6 +997,8 @@ public function unclaimedDraftCreateEmbeddedWithTemplateWithHttpInfo(Model\Uncla * * Create Embedded Unclaimed Draft with Template * + * Example: https://github.com/hellosign/dropbox-sign-php/blob/main/examples/UnclaimedDraftCreateEmbeddedWithTemplateExample.php + * * @param Model\UnclaimedDraftCreateEmbeddedWithTemplateRequest $unclaimed_draft_create_embedded_with_template_request (required) * @param string $contentType The value for the Content-Type header. Check self::contentTypes['unclaimedDraftCreateEmbeddedWithTemplate'] to see the possible values for this operation * @@ -999,6 +1021,8 @@ function ($response) { * * Create Embedded Unclaimed Draft with Template * + * Example: https://github.com/hellosign/dropbox-sign-php/blob/main/examples/UnclaimedDraftCreateEmbeddedWithTemplateExample.php + * * @param Model\UnclaimedDraftCreateEmbeddedWithTemplateRequest $unclaimed_draft_create_embedded_with_template_request (required) * @param string $contentType The value for the Content-Type header. Check self::contentTypes['unclaimedDraftCreateEmbeddedWithTemplate'] to see the possible values for this operation * @@ -1162,6 +1186,8 @@ public function unclaimedDraftCreateEmbeddedWithTemplateRequest(Model\UnclaimedD * * Edit and Resend Unclaimed Draft * + * Example: https://github.com/hellosign/dropbox-sign-php/blob/main/examples/UnclaimedDraftEditAndResendExample.php + * * @param string $signature_request_id The ID of the signature request to edit and resend. (required) * @param Model\UnclaimedDraftEditAndResendRequest $unclaimed_draft_edit_and_resend_request unclaimed_draft_edit_and_resend_request (required) * @@ -1180,6 +1206,8 @@ public function unclaimedDraftEditAndResend(string $signature_request_id, Model\ * * Edit and Resend Unclaimed Draft * + * Example: https://github.com/hellosign/dropbox-sign-php/blob/main/examples/UnclaimedDraftEditAndResendExample.php + * * @param string $signature_request_id The ID of the signature request to edit and resend. (required) * @param Model\UnclaimedDraftEditAndResendRequest $unclaimed_draft_edit_and_resend_request (required) * @param string $contentType The value for the Content-Type header. Check self::contentTypes['unclaimedDraftEditAndResend'] to see the possible values for this operation @@ -1318,6 +1346,8 @@ public function unclaimedDraftEditAndResendWithHttpInfo(string $signature_reques * * Edit and Resend Unclaimed Draft * + * Example: https://github.com/hellosign/dropbox-sign-php/blob/main/examples/UnclaimedDraftEditAndResendExample.php + * * @param string $signature_request_id The ID of the signature request to edit and resend. (required) * @param Model\UnclaimedDraftEditAndResendRequest $unclaimed_draft_edit_and_resend_request (required) * @param string $contentType The value for the Content-Type header. Check self::contentTypes['unclaimedDraftEditAndResend'] to see the possible values for this operation @@ -1341,6 +1371,8 @@ function ($response) { * * Edit and Resend Unclaimed Draft * + * Example: https://github.com/hellosign/dropbox-sign-php/blob/main/examples/UnclaimedDraftEditAndResendExample.php + * * @param string $signature_request_id The ID of the signature request to edit and resend. (required) * @param Model\UnclaimedDraftEditAndResendRequest $unclaimed_draft_edit_and_resend_request (required) * @param string $contentType The value for the Content-Type header. Check self::contentTypes['unclaimedDraftEditAndResend'] to see the possible values for this operation diff --git a/sdks/php/templates/api.mustache b/sdks/php/templates/api.mustache index cbcd7efb7..8cac61995 100644 --- a/sdks/php/templates/api.mustache +++ b/sdks/php/templates/api.mustache @@ -171,6 +171,8 @@ use Psr\Http\Message\ResponseInterface; * {{.}} * {{/description}} + * Example: https://github.com/hellosign/dropbox-sign-php/blob/main/examples/{{operationIdCamelCase}}Example.php + * {{#vendorExtensions.x-group-parameters}} * Note: the input parameter is an associative array with the keys listed as the parameter name below * @@ -240,6 +242,8 @@ use Psr\Http\Message\ResponseInterface; * {{.}} * {{/description}} + * Example: https://github.com/hellosign/dropbox-sign-php/blob/main/examples/{{operationIdCamelCase}}Example.php + * {{#vendorExtensions.x-group-parameters}} * Note: the input parameter is an associative array with the keys listed as the parameter name below * @@ -448,6 +452,8 @@ use Psr\Http\Message\ResponseInterface; * {{.}} * {{/description}} + * Example: https://github.com/hellosign/dropbox-sign-php/blob/main/examples/{{operationIdCamelCase}}Example.php + * {{#vendorExtensions.x-group-parameters}} * Note: the input parameter is an associative array with the keys listed as the parameter name below * @@ -513,6 +519,8 @@ use Psr\Http\Message\ResponseInterface; * {{.}} * {{/description}} + * Example: https://github.com/hellosign/dropbox-sign-php/blob/main/examples/{{operationIdCamelCase}}Example.php + * {{#vendorExtensions.x-group-parameters}} * Note: the input parameter is an associative array with the keys listed as the parameter name below * diff --git a/sdks/python/dropbox_sign/api/account_api.py b/sdks/python/dropbox_sign/api/account_api.py index c326dc17a..887a72b51 100644 --- a/sdks/python/dropbox_sign/api/account_api.py +++ b/sdks/python/dropbox_sign/api/account_api.py @@ -65,6 +65,8 @@ def account_create( Creates a new Dropbox Sign Account that is associated with the specified `email_address`. + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/AccountCreateExample.py + :param account_create_request: (required) :type account_create_request: AccountCreateRequest :param _request_timeout: timeout setting for this request. If one @@ -101,6 +103,7 @@ def account_create( "200": "AccountCreateResponse", "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -130,6 +133,8 @@ def account_create_with_http_info( Creates a new Dropbox Sign Account that is associated with the specified `email_address`. + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/AccountCreateExample.py + :param account_create_request: (required) :type account_create_request: AccountCreateRequest :param _request_timeout: timeout setting for this request. If one @@ -166,6 +171,7 @@ def account_create_with_http_info( "200": "AccountCreateResponse", "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -195,6 +201,8 @@ def account_create_without_preload_content( Creates a new Dropbox Sign Account that is associated with the specified `email_address`. + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/AccountCreateExample.py + :param account_create_request: (required) :type account_create_request: AccountCreateRequest :param _request_timeout: timeout setting for this request. If one @@ -231,6 +239,7 @@ def account_create_without_preload_content( "200": "AccountCreateResponse", "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -353,6 +362,8 @@ def account_get( Returns the properties and settings of your Account. + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/AccountGetExample.py + :param account_id: `account_id` or `email_address` is required. If both are provided, the account id prevails. The ID of the Account. :type account_id: str :param email_address: `account_id` or `email_address` is required, If both are provided, the account id prevails. The email address of the Account. @@ -392,6 +403,7 @@ def account_get( "200": "AccountGetResponse", "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -432,6 +444,8 @@ def account_get_with_http_info( Returns the properties and settings of your Account. + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/AccountGetExample.py + :param account_id: `account_id` or `email_address` is required. If both are provided, the account id prevails. The ID of the Account. :type account_id: str :param email_address: `account_id` or `email_address` is required, If both are provided, the account id prevails. The email address of the Account. @@ -471,6 +485,7 @@ def account_get_with_http_info( "200": "AccountGetResponse", "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -511,6 +526,8 @@ def account_get_without_preload_content( Returns the properties and settings of your Account. + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/AccountGetExample.py + :param account_id: `account_id` or `email_address` is required. If both are provided, the account id prevails. The ID of the Account. :type account_id: str :param email_address: `account_id` or `email_address` is required, If both are provided, the account id prevails. The email address of the Account. @@ -550,6 +567,7 @@ def account_get_without_preload_content( "200": "AccountGetResponse", "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -636,6 +654,8 @@ def account_update( Updates the properties and settings of your Account. Currently only allows for updates to the [Callback URL](/api/reference/tag/Callbacks-and-Events) and locale. + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/AccountUpdateExample.py + :param account_update_request: (required) :type account_update_request: AccountUpdateRequest :param _request_timeout: timeout setting for this request. If one @@ -672,6 +692,7 @@ def account_update( "200": "AccountGetResponse", "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -701,6 +722,8 @@ def account_update_with_http_info( Updates the properties and settings of your Account. Currently only allows for updates to the [Callback URL](/api/reference/tag/Callbacks-and-Events) and locale. + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/AccountUpdateExample.py + :param account_update_request: (required) :type account_update_request: AccountUpdateRequest :param _request_timeout: timeout setting for this request. If one @@ -737,6 +760,7 @@ def account_update_with_http_info( "200": "AccountGetResponse", "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -766,6 +790,8 @@ def account_update_without_preload_content( Updates the properties and settings of your Account. Currently only allows for updates to the [Callback URL](/api/reference/tag/Callbacks-and-Events) and locale. + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/AccountUpdateExample.py + :param account_update_request: (required) :type account_update_request: AccountUpdateRequest :param _request_timeout: timeout setting for this request. If one @@ -802,6 +828,7 @@ def account_update_without_preload_content( "200": "AccountGetResponse", "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -913,6 +940,8 @@ def account_verify( Verifies whether an Dropbox Sign Account exists for the given email address. + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/AccountVerifyExample.py + :param account_verify_request: (required) :type account_verify_request: AccountVerifyRequest :param _request_timeout: timeout setting for this request. If one @@ -949,6 +978,7 @@ def account_verify( "200": "AccountVerifyResponse", "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -978,6 +1008,8 @@ def account_verify_with_http_info( Verifies whether an Dropbox Sign Account exists for the given email address. + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/AccountVerifyExample.py + :param account_verify_request: (required) :type account_verify_request: AccountVerifyRequest :param _request_timeout: timeout setting for this request. If one @@ -1014,6 +1046,7 @@ def account_verify_with_http_info( "200": "AccountVerifyResponse", "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -1043,6 +1076,8 @@ def account_verify_without_preload_content( Verifies whether an Dropbox Sign Account exists for the given email address. + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/AccountVerifyExample.py + :param account_verify_request: (required) :type account_verify_request: AccountVerifyRequest :param _request_timeout: timeout setting for this request. If one @@ -1079,6 +1114,7 @@ def account_verify_without_preload_content( "200": "AccountVerifyResponse", "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) diff --git a/sdks/python/dropbox_sign/api/api_app_api.py b/sdks/python/dropbox_sign/api/api_app_api.py index 45ce475e3..b626413f4 100644 --- a/sdks/python/dropbox_sign/api/api_app_api.py +++ b/sdks/python/dropbox_sign/api/api_app_api.py @@ -63,6 +63,8 @@ def api_app_create( Creates a new API App. + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/ApiAppCreateExample.py + :param api_app_create_request: (required) :type api_app_create_request: ApiAppCreateRequest :param _request_timeout: timeout setting for this request. If one @@ -99,6 +101,7 @@ def api_app_create( "201": "ApiAppGetResponse", "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -128,6 +131,8 @@ def api_app_create_with_http_info( Creates a new API App. + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/ApiAppCreateExample.py + :param api_app_create_request: (required) :type api_app_create_request: ApiAppCreateRequest :param _request_timeout: timeout setting for this request. If one @@ -164,6 +169,7 @@ def api_app_create_with_http_info( "201": "ApiAppGetResponse", "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -193,6 +199,8 @@ def api_app_create_without_preload_content( Creates a new API App. + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/ApiAppCreateExample.py + :param api_app_create_request: (required) :type api_app_create_request: ApiAppCreateRequest :param _request_timeout: timeout setting for this request. If one @@ -229,6 +237,7 @@ def api_app_create_without_preload_content( "201": "ApiAppGetResponse", "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -342,6 +351,8 @@ def api_app_delete( Deletes an API App. Can only be invoked for apps you own. + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/ApiAppDeleteExample.py + :param client_id: The client id of the API App to delete. (required) :type client_id: str :param _request_timeout: timeout setting for this request. If one @@ -378,6 +389,7 @@ def api_app_delete( "204": None, "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -409,6 +421,8 @@ def api_app_delete_with_http_info( Deletes an API App. Can only be invoked for apps you own. + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/ApiAppDeleteExample.py + :param client_id: The client id of the API App to delete. (required) :type client_id: str :param _request_timeout: timeout setting for this request. If one @@ -445,6 +459,7 @@ def api_app_delete_with_http_info( "204": None, "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -476,6 +491,8 @@ def api_app_delete_without_preload_content( Deletes an API App. Can only be invoked for apps you own. + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/ApiAppDeleteExample.py + :param client_id: The client id of the API App to delete. (required) :type client_id: str :param _request_timeout: timeout setting for this request. If one @@ -512,6 +529,7 @@ def api_app_delete_without_preload_content( "204": None, "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -593,6 +611,8 @@ def api_app_get( Returns an object with information about an API App. + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/ApiAppGetExample.py + :param client_id: The client id of the API App to retrieve. (required) :type client_id: str :param _request_timeout: timeout setting for this request. If one @@ -629,6 +649,7 @@ def api_app_get( "200": "ApiAppGetResponse", "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -660,6 +681,8 @@ def api_app_get_with_http_info( Returns an object with information about an API App. + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/ApiAppGetExample.py + :param client_id: The client id of the API App to retrieve. (required) :type client_id: str :param _request_timeout: timeout setting for this request. If one @@ -696,6 +719,7 @@ def api_app_get_with_http_info( "200": "ApiAppGetResponse", "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -727,6 +751,8 @@ def api_app_get_without_preload_content( Returns an object with information about an API App. + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/ApiAppGetExample.py + :param client_id: The client id of the API App to retrieve. (required) :type client_id: str :param _request_timeout: timeout setting for this request. If one @@ -763,6 +789,7 @@ def api_app_get_without_preload_content( "200": "ApiAppGetResponse", "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -853,6 +880,8 @@ def api_app_list( Returns a list of API Apps that are accessible by you. If you are on a team with an Admin or Developer role, this list will include apps owned by teammates. + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/ApiAppListExample.py + :param page: Which page number of the API App List to return. Defaults to `1`. :type page: int :param page_size: Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. @@ -892,6 +921,7 @@ def api_app_list( "200": "ApiAppListResponse", "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -932,6 +962,8 @@ def api_app_list_with_http_info( Returns a list of API Apps that are accessible by you. If you are on a team with an Admin or Developer role, this list will include apps owned by teammates. + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/ApiAppListExample.py + :param page: Which page number of the API App List to return. Defaults to `1`. :type page: int :param page_size: Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. @@ -971,6 +1003,7 @@ def api_app_list_with_http_info( "200": "ApiAppListResponse", "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -1011,6 +1044,8 @@ def api_app_list_without_preload_content( Returns a list of API Apps that are accessible by you. If you are on a team with an Admin or Developer role, this list will include apps owned by teammates. + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/ApiAppListExample.py + :param page: Which page number of the API App List to return. Defaults to `1`. :type page: int :param page_size: Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. @@ -1050,6 +1085,7 @@ def api_app_list_without_preload_content( "200": "ApiAppListResponse", "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -1139,6 +1175,8 @@ def api_app_update( Updates an existing API App. Can only be invoked for apps you own. Only the fields you provide will be updated. If you wish to clear an existing optional field, provide an empty string. + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/ApiAppUpdateExample.py + :param client_id: The client id of the API App to update. (required) :type client_id: str :param api_app_update_request: (required) @@ -1178,6 +1216,7 @@ def api_app_update( "200": "ApiAppGetResponse", "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -1210,6 +1249,8 @@ def api_app_update_with_http_info( Updates an existing API App. Can only be invoked for apps you own. Only the fields you provide will be updated. If you wish to clear an existing optional field, provide an empty string. + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/ApiAppUpdateExample.py + :param client_id: The client id of the API App to update. (required) :type client_id: str :param api_app_update_request: (required) @@ -1249,6 +1290,7 @@ def api_app_update_with_http_info( "200": "ApiAppGetResponse", "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -1281,6 +1323,8 @@ def api_app_update_without_preload_content( Updates an existing API App. Can only be invoked for apps you own. Only the fields you provide will be updated. If you wish to clear an existing optional field, provide an empty string. + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/ApiAppUpdateExample.py + :param client_id: The client id of the API App to update. (required) :type client_id: str :param api_app_update_request: (required) @@ -1320,6 +1364,7 @@ def api_app_update_without_preload_content( "200": "ApiAppGetResponse", "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) diff --git a/sdks/python/dropbox_sign/api/bulk_send_job_api.py b/sdks/python/dropbox_sign/api/bulk_send_job_api.py index eb0b4bc3f..12eeb2cc1 100644 --- a/sdks/python/dropbox_sign/api/bulk_send_job_api.py +++ b/sdks/python/dropbox_sign/api/bulk_send_job_api.py @@ -75,6 +75,8 @@ def bulk_send_job_get( Returns the status of the BulkSendJob and its SignatureRequests specified by the `bulk_send_job_id` parameter. + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/BulkSendJobGetExample.py + :param bulk_send_job_id: The id of the BulkSendJob to retrieve. (required) :type bulk_send_job_id: str :param page: Which page number of the BulkSendJob list to return. Defaults to `1`. @@ -117,6 +119,7 @@ def bulk_send_job_get( "200": "BulkSendJobGetResponse", "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -160,6 +163,8 @@ def bulk_send_job_get_with_http_info( Returns the status of the BulkSendJob and its SignatureRequests specified by the `bulk_send_job_id` parameter. + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/BulkSendJobGetExample.py + :param bulk_send_job_id: The id of the BulkSendJob to retrieve. (required) :type bulk_send_job_id: str :param page: Which page number of the BulkSendJob list to return. Defaults to `1`. @@ -202,6 +207,7 @@ def bulk_send_job_get_with_http_info( "200": "BulkSendJobGetResponse", "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -245,6 +251,8 @@ def bulk_send_job_get_without_preload_content( Returns the status of the BulkSendJob and its SignatureRequests specified by the `bulk_send_job_id` parameter. + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/BulkSendJobGetExample.py + :param bulk_send_job_id: The id of the BulkSendJob to retrieve. (required) :type bulk_send_job_id: str :param page: Which page number of the BulkSendJob list to return. Defaults to `1`. @@ -287,6 +295,7 @@ def bulk_send_job_get_without_preload_content( "200": "BulkSendJobGetResponse", "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -387,6 +396,8 @@ def bulk_send_job_list( Returns a list of BulkSendJob that you can access. + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/BulkSendJobListExample.py + :param page: Which page number of the BulkSendJob List to return. Defaults to `1`. :type page: int :param page_size: Number of objects to be returned per page. Must be between `1` and `100`. Default is 20. @@ -426,6 +437,7 @@ def bulk_send_job_list( "200": "BulkSendJobListResponse", "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -466,6 +478,8 @@ def bulk_send_job_list_with_http_info( Returns a list of BulkSendJob that you can access. + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/BulkSendJobListExample.py + :param page: Which page number of the BulkSendJob List to return. Defaults to `1`. :type page: int :param page_size: Number of objects to be returned per page. Must be between `1` and `100`. Default is 20. @@ -505,6 +519,7 @@ def bulk_send_job_list_with_http_info( "200": "BulkSendJobListResponse", "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -545,6 +560,8 @@ def bulk_send_job_list_without_preload_content( Returns a list of BulkSendJob that you can access. + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/BulkSendJobListExample.py + :param page: Which page number of the BulkSendJob List to return. Defaults to `1`. :type page: int :param page_size: Number of objects to be returned per page. Must be between `1` and `100`. Default is 20. @@ -584,6 +601,7 @@ def bulk_send_job_list_without_preload_content( "200": "BulkSendJobListResponse", "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) diff --git a/sdks/python/dropbox_sign/api/embedded_api.py b/sdks/python/dropbox_sign/api/embedded_api.py index 450099e61..1a79db1be 100644 --- a/sdks/python/dropbox_sign/api/embedded_api.py +++ b/sdks/python/dropbox_sign/api/embedded_api.py @@ -64,6 +64,8 @@ def embedded_edit_url( Retrieves an embedded object containing a template url that can be opened in an iFrame. Note that only templates created via the embedded template process are available to be edited with this endpoint. + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/EmbeddedEditUrlExample.py + :param template_id: The id of the template to edit. (required) :type template_id: str :param embedded_edit_url_request: (required) @@ -103,6 +105,7 @@ def embedded_edit_url( "200": "EmbeddedEditUrlResponse", "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -135,6 +138,8 @@ def embedded_edit_url_with_http_info( Retrieves an embedded object containing a template url that can be opened in an iFrame. Note that only templates created via the embedded template process are available to be edited with this endpoint. + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/EmbeddedEditUrlExample.py + :param template_id: The id of the template to edit. (required) :type template_id: str :param embedded_edit_url_request: (required) @@ -174,6 +179,7 @@ def embedded_edit_url_with_http_info( "200": "EmbeddedEditUrlResponse", "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -206,6 +212,8 @@ def embedded_edit_url_without_preload_content( Retrieves an embedded object containing a template url that can be opened in an iFrame. Note that only templates created via the embedded template process are available to be edited with this endpoint. + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/EmbeddedEditUrlExample.py + :param template_id: The id of the template to edit. (required) :type template_id: str :param embedded_edit_url_request: (required) @@ -245,6 +253,7 @@ def embedded_edit_url_without_preload_content( "200": "EmbeddedEditUrlResponse", "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -362,6 +371,8 @@ def embedded_sign_url( Retrieves an embedded object containing a signature url that can be opened in an iFrame. Note that templates created via the embedded template process will only be accessible through the API. + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/EmbeddedSignUrlExample.py + :param signature_id: The id of the signature to get a signature url for. (required) :type signature_id: str :param _request_timeout: timeout setting for this request. If one @@ -398,6 +409,7 @@ def embedded_sign_url( "200": "EmbeddedSignUrlResponse", "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -430,6 +442,8 @@ def embedded_sign_url_with_http_info( Retrieves an embedded object containing a signature url that can be opened in an iFrame. Note that templates created via the embedded template process will only be accessible through the API. + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/EmbeddedSignUrlExample.py + :param signature_id: The id of the signature to get a signature url for. (required) :type signature_id: str :param _request_timeout: timeout setting for this request. If one @@ -466,6 +480,7 @@ def embedded_sign_url_with_http_info( "200": "EmbeddedSignUrlResponse", "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -498,6 +513,8 @@ def embedded_sign_url_without_preload_content( Retrieves an embedded object containing a signature url that can be opened in an iFrame. Note that templates created via the embedded template process will only be accessible through the API. + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/EmbeddedSignUrlExample.py + :param signature_id: The id of the signature to get a signature url for. (required) :type signature_id: str :param _request_timeout: timeout setting for this request. If one @@ -534,6 +551,7 @@ def embedded_sign_url_without_preload_content( "200": "EmbeddedSignUrlResponse", "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) diff --git a/sdks/python/dropbox_sign/api/fax_api.py b/sdks/python/dropbox_sign/api/fax_api.py index abf615a7f..682b26e40 100644 --- a/sdks/python/dropbox_sign/api/fax_api.py +++ b/sdks/python/dropbox_sign/api/fax_api.py @@ -62,6 +62,8 @@ def fax_delete( Deletes the specified Fax from the system + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/FaxDeleteExample.py + :param fax_id: Fax ID (required) :type fax_id: str :param _request_timeout: timeout setting for this request. If one @@ -98,6 +100,7 @@ def fax_delete( "204": None, "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -127,6 +130,8 @@ def fax_delete_with_http_info( Deletes the specified Fax from the system + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/FaxDeleteExample.py + :param fax_id: Fax ID (required) :type fax_id: str :param _request_timeout: timeout setting for this request. If one @@ -163,6 +168,7 @@ def fax_delete_with_http_info( "204": None, "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -192,6 +198,8 @@ def fax_delete_without_preload_content( Deletes the specified Fax from the system + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/FaxDeleteExample.py + :param fax_id: Fax ID (required) :type fax_id: str :param _request_timeout: timeout setting for this request. If one @@ -228,6 +236,7 @@ def fax_delete_without_preload_content( "204": None, "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -307,6 +316,8 @@ def fax_files( Downloads files associated with a Fax + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/FaxFilesExample.py + :param fax_id: Fax ID (required) :type fax_id: str :param _request_timeout: timeout setting for this request. If one @@ -343,6 +354,7 @@ def fax_files( "200": "io.IOBase", "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -372,6 +384,8 @@ def fax_files_with_http_info( Downloads files associated with a Fax + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/FaxFilesExample.py + :param fax_id: Fax ID (required) :type fax_id: str :param _request_timeout: timeout setting for this request. If one @@ -408,6 +422,7 @@ def fax_files_with_http_info( "200": "io.IOBase", "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -437,6 +452,8 @@ def fax_files_without_preload_content( Downloads files associated with a Fax + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/FaxFilesExample.py + :param fax_id: Fax ID (required) :type fax_id: str :param _request_timeout: timeout setting for this request. If one @@ -473,6 +490,7 @@ def fax_files_without_preload_content( "200": "io.IOBase", "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -552,6 +570,8 @@ def fax_get( Returns information about a Fax + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/FaxGetExample.py + :param fax_id: Fax ID (required) :type fax_id: str :param _request_timeout: timeout setting for this request. If one @@ -588,6 +608,7 @@ def fax_get( "200": "FaxGetResponse", "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -617,6 +638,8 @@ def fax_get_with_http_info( Returns information about a Fax + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/FaxGetExample.py + :param fax_id: Fax ID (required) :type fax_id: str :param _request_timeout: timeout setting for this request. If one @@ -653,6 +676,7 @@ def fax_get_with_http_info( "200": "FaxGetResponse", "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -682,6 +706,8 @@ def fax_get_without_preload_content( Returns information about a Fax + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/FaxGetExample.py + :param fax_id: Fax ID (required) :type fax_id: str :param _request_timeout: timeout setting for this request. If one @@ -718,6 +744,7 @@ def fax_get_without_preload_content( "200": "FaxGetResponse", "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -808,6 +835,8 @@ def fax_list( Returns properties of multiple Faxes + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/FaxListExample.py + :param page: Which page number of the Fax List to return. Defaults to `1`. :type page: int :param page_size: Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. @@ -847,6 +876,7 @@ def fax_list( "200": "FaxListResponse", "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -887,6 +917,8 @@ def fax_list_with_http_info( Returns properties of multiple Faxes + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/FaxListExample.py + :param page: Which page number of the Fax List to return. Defaults to `1`. :type page: int :param page_size: Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. @@ -926,6 +958,7 @@ def fax_list_with_http_info( "200": "FaxListResponse", "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -966,6 +999,8 @@ def fax_list_without_preload_content( Returns properties of multiple Faxes + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/FaxListExample.py + :param page: Which page number of the Fax List to return. Defaults to `1`. :type page: int :param page_size: Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. @@ -1005,6 +1040,7 @@ def fax_list_without_preload_content( "200": "FaxListResponse", "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -1091,6 +1127,8 @@ def fax_send( Creates and sends a new Fax with the submitted file(s) + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/FaxSendExample.py + :param fax_send_request: (required) :type fax_send_request: FaxSendRequest :param _request_timeout: timeout setting for this request. If one @@ -1127,6 +1165,7 @@ def fax_send( "200": "FaxGetResponse", "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -1156,6 +1195,8 @@ def fax_send_with_http_info( Creates and sends a new Fax with the submitted file(s) + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/FaxSendExample.py + :param fax_send_request: (required) :type fax_send_request: FaxSendRequest :param _request_timeout: timeout setting for this request. If one @@ -1192,6 +1233,7 @@ def fax_send_with_http_info( "200": "FaxGetResponse", "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -1221,6 +1263,8 @@ def fax_send_without_preload_content( Creates and sends a new Fax with the submitted file(s) + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/FaxSendExample.py + :param fax_send_request: (required) :type fax_send_request: FaxSendRequest :param _request_timeout: timeout setting for this request. If one @@ -1257,6 +1301,7 @@ def fax_send_without_preload_content( "200": "FaxGetResponse", "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) diff --git a/sdks/python/dropbox_sign/api/fax_line_api.py b/sdks/python/dropbox_sign/api/fax_line_api.py index c3ceff110..f752698b0 100644 --- a/sdks/python/dropbox_sign/api/fax_line_api.py +++ b/sdks/python/dropbox_sign/api/fax_line_api.py @@ -68,6 +68,8 @@ def fax_line_add_user( Grants a user access to the specified Fax Line. + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/FaxLineAddUserExample.py + :param fax_line_add_user_request: (required) :type fax_line_add_user_request: FaxLineAddUserRequest :param _request_timeout: timeout setting for this request. If one @@ -104,6 +106,7 @@ def fax_line_add_user( "200": "FaxLineResponse", "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -133,6 +136,8 @@ def fax_line_add_user_with_http_info( Grants a user access to the specified Fax Line. + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/FaxLineAddUserExample.py + :param fax_line_add_user_request: (required) :type fax_line_add_user_request: FaxLineAddUserRequest :param _request_timeout: timeout setting for this request. If one @@ -169,6 +174,7 @@ def fax_line_add_user_with_http_info( "200": "FaxLineResponse", "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -198,6 +204,8 @@ def fax_line_add_user_without_preload_content( Grants a user access to the specified Fax Line. + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/FaxLineAddUserExample.py + :param fax_line_add_user_request: (required) :type fax_line_add_user_request: FaxLineAddUserRequest :param _request_timeout: timeout setting for this request. If one @@ -234,6 +242,7 @@ def fax_line_add_user_without_preload_content( "200": "FaxLineResponse", "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -356,6 +365,8 @@ def fax_line_area_code_get( Returns a list of available area codes for a given state/province and city + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/FaxLineAreaCodeGetExample.py + :param country: Filter area codes by country (required) :type country: str :param state: Filter area codes by state @@ -401,6 +412,7 @@ def fax_line_area_code_get( "200": "FaxLineAreaCodeGetResponse", "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -441,6 +453,8 @@ def fax_line_area_code_get_with_http_info( Returns a list of available area codes for a given state/province and city + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/FaxLineAreaCodeGetExample.py + :param country: Filter area codes by country (required) :type country: str :param state: Filter area codes by state @@ -486,6 +500,7 @@ def fax_line_area_code_get_with_http_info( "200": "FaxLineAreaCodeGetResponse", "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -526,6 +541,8 @@ def fax_line_area_code_get_without_preload_content( Returns a list of available area codes for a given state/province and city + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/FaxLineAreaCodeGetExample.py + :param country: Filter area codes by country (required) :type country: str :param state: Filter area codes by state @@ -571,6 +588,7 @@ def fax_line_area_code_get_without_preload_content( "200": "FaxLineAreaCodeGetResponse", "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -667,6 +685,8 @@ def fax_line_create( Purchases a new Fax Line + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/FaxLineCreateExample.py + :param fax_line_create_request: (required) :type fax_line_create_request: FaxLineCreateRequest :param _request_timeout: timeout setting for this request. If one @@ -703,6 +723,7 @@ def fax_line_create( "200": "FaxLineResponse", "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -732,6 +753,8 @@ def fax_line_create_with_http_info( Purchases a new Fax Line + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/FaxLineCreateExample.py + :param fax_line_create_request: (required) :type fax_line_create_request: FaxLineCreateRequest :param _request_timeout: timeout setting for this request. If one @@ -768,6 +791,7 @@ def fax_line_create_with_http_info( "200": "FaxLineResponse", "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -797,6 +821,8 @@ def fax_line_create_without_preload_content( Purchases a new Fax Line + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/FaxLineCreateExample.py + :param fax_line_create_request: (required) :type fax_line_create_request: FaxLineCreateRequest :param _request_timeout: timeout setting for this request. If one @@ -833,6 +859,7 @@ def fax_line_create_without_preload_content( "200": "FaxLineResponse", "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -944,6 +971,8 @@ def fax_line_delete( Deletes the specified Fax Line from the subscription. + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/FaxLineDeleteExample.py + :param fax_line_delete_request: (required) :type fax_line_delete_request: FaxLineDeleteRequest :param _request_timeout: timeout setting for this request. If one @@ -980,6 +1009,7 @@ def fax_line_delete( "200": None, "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -1009,6 +1039,8 @@ def fax_line_delete_with_http_info( Deletes the specified Fax Line from the subscription. + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/FaxLineDeleteExample.py + :param fax_line_delete_request: (required) :type fax_line_delete_request: FaxLineDeleteRequest :param _request_timeout: timeout setting for this request. If one @@ -1045,6 +1077,7 @@ def fax_line_delete_with_http_info( "200": None, "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -1074,6 +1107,8 @@ def fax_line_delete_without_preload_content( Deletes the specified Fax Line from the subscription. + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/FaxLineDeleteExample.py + :param fax_line_delete_request: (required) :type fax_line_delete_request: FaxLineDeleteRequest :param _request_timeout: timeout setting for this request. If one @@ -1110,6 +1145,7 @@ def fax_line_delete_without_preload_content( "200": None, "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -1221,6 +1257,8 @@ def fax_line_get( Returns the properties and settings of a Fax Line. + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/FaxLineGetExample.py + :param number: The Fax Line number (required) :type number: str :param _request_timeout: timeout setting for this request. If one @@ -1257,6 +1295,7 @@ def fax_line_get( "200": "FaxLineResponse", "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -1286,6 +1325,8 @@ def fax_line_get_with_http_info( Returns the properties and settings of a Fax Line. + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/FaxLineGetExample.py + :param number: The Fax Line number (required) :type number: str :param _request_timeout: timeout setting for this request. If one @@ -1322,6 +1363,7 @@ def fax_line_get_with_http_info( "200": "FaxLineResponse", "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -1351,6 +1393,8 @@ def fax_line_get_without_preload_content( Returns the properties and settings of a Fax Line. + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/FaxLineGetExample.py + :param number: The Fax Line number (required) :type number: str :param _request_timeout: timeout setting for this request. If one @@ -1387,6 +1431,7 @@ def fax_line_get_without_preload_content( "200": "FaxLineResponse", "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -1488,6 +1533,8 @@ def fax_line_list( Returns the properties and settings of multiple Fax Lines. + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/FaxLineListExample.py + :param account_id: Account ID :type account_id: str :param page: Which page number of the Fax Line List to return. Defaults to `1`. @@ -1533,6 +1580,7 @@ def fax_line_list( "200": "FaxLineListResponse", "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -1582,6 +1630,8 @@ def fax_line_list_with_http_info( Returns the properties and settings of multiple Fax Lines. + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/FaxLineListExample.py + :param account_id: Account ID :type account_id: str :param page: Which page number of the Fax Line List to return. Defaults to `1`. @@ -1627,6 +1677,7 @@ def fax_line_list_with_http_info( "200": "FaxLineListResponse", "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -1676,6 +1727,8 @@ def fax_line_list_without_preload_content( Returns the properties and settings of multiple Fax Lines. + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/FaxLineListExample.py + :param account_id: Account ID :type account_id: str :param page: Which page number of the Fax Line List to return. Defaults to `1`. @@ -1721,6 +1774,7 @@ def fax_line_list_without_preload_content( "200": "FaxLineListResponse", "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -1817,6 +1871,8 @@ def fax_line_remove_user( Removes a user's access to the specified Fax Line + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/FaxLineRemoveUserExample.py + :param fax_line_remove_user_request: (required) :type fax_line_remove_user_request: FaxLineRemoveUserRequest :param _request_timeout: timeout setting for this request. If one @@ -1853,6 +1909,7 @@ def fax_line_remove_user( "200": "FaxLineResponse", "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -1882,6 +1939,8 @@ def fax_line_remove_user_with_http_info( Removes a user's access to the specified Fax Line + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/FaxLineRemoveUserExample.py + :param fax_line_remove_user_request: (required) :type fax_line_remove_user_request: FaxLineRemoveUserRequest :param _request_timeout: timeout setting for this request. If one @@ -1918,6 +1977,7 @@ def fax_line_remove_user_with_http_info( "200": "FaxLineResponse", "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -1947,6 +2007,8 @@ def fax_line_remove_user_without_preload_content( Removes a user's access to the specified Fax Line + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/FaxLineRemoveUserExample.py + :param fax_line_remove_user_request: (required) :type fax_line_remove_user_request: FaxLineRemoveUserRequest :param _request_timeout: timeout setting for this request. If one @@ -1983,6 +2045,7 @@ def fax_line_remove_user_without_preload_content( "200": "FaxLineResponse", "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) diff --git a/sdks/python/dropbox_sign/api/o_auth_api.py b/sdks/python/dropbox_sign/api/o_auth_api.py index 6ea59b559..c173208e2 100644 --- a/sdks/python/dropbox_sign/api/o_auth_api.py +++ b/sdks/python/dropbox_sign/api/o_auth_api.py @@ -59,6 +59,8 @@ def oauth_token_generate( Once you have retrieved the code from the user callback, you will need to exchange it for an access token via a backend call. + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/OauthTokenGenerateExample.py + :param o_auth_token_generate_request: (required) :type o_auth_token_generate_request: OAuthTokenGenerateRequest :param _request_timeout: timeout setting for this request. If one @@ -95,6 +97,7 @@ def oauth_token_generate( "200": "OAuthTokenResponse", "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -124,6 +127,8 @@ def oauth_token_generate_with_http_info( Once you have retrieved the code from the user callback, you will need to exchange it for an access token via a backend call. + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/OauthTokenGenerateExample.py + :param o_auth_token_generate_request: (required) :type o_auth_token_generate_request: OAuthTokenGenerateRequest :param _request_timeout: timeout setting for this request. If one @@ -160,6 +165,7 @@ def oauth_token_generate_with_http_info( "200": "OAuthTokenResponse", "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -189,6 +195,8 @@ def oauth_token_generate_without_preload_content( Once you have retrieved the code from the user callback, you will need to exchange it for an access token via a backend call. + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/OauthTokenGenerateExample.py + :param o_auth_token_generate_request: (required) :type o_auth_token_generate_request: OAuthTokenGenerateRequest :param _request_timeout: timeout setting for this request. If one @@ -225,6 +233,7 @@ def oauth_token_generate_without_preload_content( "200": "OAuthTokenResponse", "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -337,6 +346,8 @@ def oauth_token_refresh( Access tokens are only valid for a given period of time (typically one hour) for security reasons. Whenever acquiring an new access token its TTL is also given (see `expires_in`), along with a refresh token that can be used to acquire a new access token after the current one has expired. + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/OauthTokenRefreshExample.py + :param o_auth_token_refresh_request: (required) :type o_auth_token_refresh_request: OAuthTokenRefreshRequest :param _request_timeout: timeout setting for this request. If one @@ -373,6 +384,7 @@ def oauth_token_refresh( "200": "OAuthTokenResponse", "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -402,6 +414,8 @@ def oauth_token_refresh_with_http_info( Access tokens are only valid for a given period of time (typically one hour) for security reasons. Whenever acquiring an new access token its TTL is also given (see `expires_in`), along with a refresh token that can be used to acquire a new access token after the current one has expired. + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/OauthTokenRefreshExample.py + :param o_auth_token_refresh_request: (required) :type o_auth_token_refresh_request: OAuthTokenRefreshRequest :param _request_timeout: timeout setting for this request. If one @@ -438,6 +452,7 @@ def oauth_token_refresh_with_http_info( "200": "OAuthTokenResponse", "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -467,6 +482,8 @@ def oauth_token_refresh_without_preload_content( Access tokens are only valid for a given period of time (typically one hour) for security reasons. Whenever acquiring an new access token its TTL is also given (see `expires_in`), along with a refresh token that can be used to acquire a new access token after the current one has expired. + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/OauthTokenRefreshExample.py + :param o_auth_token_refresh_request: (required) :type o_auth_token_refresh_request: OAuthTokenRefreshRequest :param _request_timeout: timeout setting for this request. If one @@ -503,6 +520,7 @@ def oauth_token_refresh_without_preload_content( "200": "OAuthTokenResponse", "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) diff --git a/sdks/python/dropbox_sign/api/report_api.py b/sdks/python/dropbox_sign/api/report_api.py index f739dcba4..38b120b2a 100644 --- a/sdks/python/dropbox_sign/api/report_api.py +++ b/sdks/python/dropbox_sign/api/report_api.py @@ -58,6 +58,8 @@ def report_create( Request the creation of one or more report(s). When the report(s) have been generated, you will receive an email (one per requested report type) containing a link to download the report as a CSV file. The requested date range may be up to 12 months in duration, and `start_date` must not be more than 10 years in the past. + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/ReportCreateExample.py + :param report_create_request: (required) :type report_create_request: ReportCreateRequest :param _request_timeout: timeout setting for this request. If one @@ -94,6 +96,7 @@ def report_create( "200": "ReportCreateResponse", "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -123,6 +126,8 @@ def report_create_with_http_info( Request the creation of one or more report(s). When the report(s) have been generated, you will receive an email (one per requested report type) containing a link to download the report as a CSV file. The requested date range may be up to 12 months in duration, and `start_date` must not be more than 10 years in the past. + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/ReportCreateExample.py + :param report_create_request: (required) :type report_create_request: ReportCreateRequest :param _request_timeout: timeout setting for this request. If one @@ -159,6 +164,7 @@ def report_create_with_http_info( "200": "ReportCreateResponse", "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -188,6 +194,8 @@ def report_create_without_preload_content( Request the creation of one or more report(s). When the report(s) have been generated, you will receive an email (one per requested report type) containing a link to download the report as a CSV file. The requested date range may be up to 12 months in duration, and `start_date` must not be more than 10 years in the past. + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/ReportCreateExample.py + :param report_create_request: (required) :type report_create_request: ReportCreateRequest :param _request_timeout: timeout setting for this request. If one @@ -224,6 +232,7 @@ def report_create_without_preload_content( "200": "ReportCreateResponse", "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) diff --git a/sdks/python/dropbox_sign/api/signature_request_api.py b/sdks/python/dropbox_sign/api/signature_request_api.py index e7c1dc416..77f3c71bd 100644 --- a/sdks/python/dropbox_sign/api/signature_request_api.py +++ b/sdks/python/dropbox_sign/api/signature_request_api.py @@ -104,6 +104,8 @@ def signature_request_bulk_create_embedded_with_template( Creates BulkSendJob which sends up to 250 SignatureRequests in bulk based off of the provided Template(s) specified with the `template_ids` parameter to be signed in an embedded iFrame. These embedded signature requests can only be signed in embedded iFrames whereas normal signature requests can only be signed on Dropbox Sign. **NOTE:** Only available for Standard plan and higher. + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/SignatureRequestBulkCreateEmbeddedWithTemplateExample.py + :param signature_request_bulk_create_embedded_with_template_request: (required) :type signature_request_bulk_create_embedded_with_template_request: SignatureRequestBulkCreateEmbeddedWithTemplateRequest :param _request_timeout: timeout setting for this request. If one @@ -140,6 +142,7 @@ def signature_request_bulk_create_embedded_with_template( "200": "BulkSendJobSendResponse", "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -169,6 +172,8 @@ def signature_request_bulk_create_embedded_with_template_with_http_info( Creates BulkSendJob which sends up to 250 SignatureRequests in bulk based off of the provided Template(s) specified with the `template_ids` parameter to be signed in an embedded iFrame. These embedded signature requests can only be signed in embedded iFrames whereas normal signature requests can only be signed on Dropbox Sign. **NOTE:** Only available for Standard plan and higher. + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/SignatureRequestBulkCreateEmbeddedWithTemplateExample.py + :param signature_request_bulk_create_embedded_with_template_request: (required) :type signature_request_bulk_create_embedded_with_template_request: SignatureRequestBulkCreateEmbeddedWithTemplateRequest :param _request_timeout: timeout setting for this request. If one @@ -205,6 +210,7 @@ def signature_request_bulk_create_embedded_with_template_with_http_info( "200": "BulkSendJobSendResponse", "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -234,6 +240,8 @@ def signature_request_bulk_create_embedded_with_template_without_preload_content Creates BulkSendJob which sends up to 250 SignatureRequests in bulk based off of the provided Template(s) specified with the `template_ids` parameter to be signed in an embedded iFrame. These embedded signature requests can only be signed in embedded iFrames whereas normal signature requests can only be signed on Dropbox Sign. **NOTE:** Only available for Standard plan and higher. + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/SignatureRequestBulkCreateEmbeddedWithTemplateExample.py + :param signature_request_bulk_create_embedded_with_template_request: (required) :type signature_request_bulk_create_embedded_with_template_request: SignatureRequestBulkCreateEmbeddedWithTemplateRequest :param _request_timeout: timeout setting for this request. If one @@ -270,6 +278,7 @@ def signature_request_bulk_create_embedded_with_template_without_preload_content "200": "BulkSendJobSendResponse", "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -384,6 +393,8 @@ def signature_request_bulk_send_with_template( Creates BulkSendJob which sends up to 250 SignatureRequests in bulk based off of the provided Template(s) specified with the `template_ids` parameter. **NOTE:** Only available for Standard plan and higher. + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/SignatureRequestBulkSendWithTemplateExample.py + :param signature_request_bulk_send_with_template_request: (required) :type signature_request_bulk_send_with_template_request: SignatureRequestBulkSendWithTemplateRequest :param _request_timeout: timeout setting for this request. If one @@ -420,6 +431,7 @@ def signature_request_bulk_send_with_template( "200": "BulkSendJobSendResponse", "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -449,6 +461,8 @@ def signature_request_bulk_send_with_template_with_http_info( Creates BulkSendJob which sends up to 250 SignatureRequests in bulk based off of the provided Template(s) specified with the `template_ids` parameter. **NOTE:** Only available for Standard plan and higher. + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/SignatureRequestBulkSendWithTemplateExample.py + :param signature_request_bulk_send_with_template_request: (required) :type signature_request_bulk_send_with_template_request: SignatureRequestBulkSendWithTemplateRequest :param _request_timeout: timeout setting for this request. If one @@ -485,6 +499,7 @@ def signature_request_bulk_send_with_template_with_http_info( "200": "BulkSendJobSendResponse", "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -514,6 +529,8 @@ def signature_request_bulk_send_with_template_without_preload_content( Creates BulkSendJob which sends up to 250 SignatureRequests in bulk based off of the provided Template(s) specified with the `template_ids` parameter. **NOTE:** Only available for Standard plan and higher. + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/SignatureRequestBulkSendWithTemplateExample.py + :param signature_request_bulk_send_with_template_request: (required) :type signature_request_bulk_send_with_template_request: SignatureRequestBulkSendWithTemplateRequest :param _request_timeout: timeout setting for this request. If one @@ -550,6 +567,7 @@ def signature_request_bulk_send_with_template_without_preload_content( "200": "BulkSendJobSendResponse", "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -667,6 +685,8 @@ def signature_request_cancel( Cancels an incomplete signature request. This action is **not reversible**. The request will be canceled and signers will no longer be able to sign. If they try to access the signature request they will receive a HTTP 410 status code indicating that the resource has been deleted. Cancelation is asynchronous and a successful call to this endpoint will return an empty 200 OK response if the signature request is eligible to be canceled and has been successfully queued. This 200 OK response does not indicate a successful cancelation of the signature request itself. The cancelation is confirmed via the `signature_request_canceled` event. It is recommended that a [callback handler](/api/reference/tag/Callbacks-and-Events) be implemented to listen for the `signature_request_canceled` event. This callback will be sent only when the cancelation has completed successfully. If a callback handler has been configured and the event has not been received within 60 minutes of making the call, check the status of the request in the [API Dashboard](https://app.hellosign.com/apidashboard) and retry the cancelation if necessary. To be eligible for cancelation, a signature request must have been sent successfully, must not yet have been signed by all signers, and you must either be the sender or own the API app under which it was sent. A partially signed signature request can be canceled. **NOTE:** To remove your access to a completed signature request, use the endpoint: `POST /signature_request/remove/[:signature_request_id]`. + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/SignatureRequestCancelExample.py + :param signature_request_id: The id of the incomplete SignatureRequest to cancel. (required) :type signature_request_id: str :param _request_timeout: timeout setting for this request. If one @@ -703,6 +723,7 @@ def signature_request_cancel( "200": None, "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -735,6 +756,8 @@ def signature_request_cancel_with_http_info( Cancels an incomplete signature request. This action is **not reversible**. The request will be canceled and signers will no longer be able to sign. If they try to access the signature request they will receive a HTTP 410 status code indicating that the resource has been deleted. Cancelation is asynchronous and a successful call to this endpoint will return an empty 200 OK response if the signature request is eligible to be canceled and has been successfully queued. This 200 OK response does not indicate a successful cancelation of the signature request itself. The cancelation is confirmed via the `signature_request_canceled` event. It is recommended that a [callback handler](/api/reference/tag/Callbacks-and-Events) be implemented to listen for the `signature_request_canceled` event. This callback will be sent only when the cancelation has completed successfully. If a callback handler has been configured and the event has not been received within 60 minutes of making the call, check the status of the request in the [API Dashboard](https://app.hellosign.com/apidashboard) and retry the cancelation if necessary. To be eligible for cancelation, a signature request must have been sent successfully, must not yet have been signed by all signers, and you must either be the sender or own the API app under which it was sent. A partially signed signature request can be canceled. **NOTE:** To remove your access to a completed signature request, use the endpoint: `POST /signature_request/remove/[:signature_request_id]`. + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/SignatureRequestCancelExample.py + :param signature_request_id: The id of the incomplete SignatureRequest to cancel. (required) :type signature_request_id: str :param _request_timeout: timeout setting for this request. If one @@ -771,6 +794,7 @@ def signature_request_cancel_with_http_info( "200": None, "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -803,6 +827,8 @@ def signature_request_cancel_without_preload_content( Cancels an incomplete signature request. This action is **not reversible**. The request will be canceled and signers will no longer be able to sign. If they try to access the signature request they will receive a HTTP 410 status code indicating that the resource has been deleted. Cancelation is asynchronous and a successful call to this endpoint will return an empty 200 OK response if the signature request is eligible to be canceled and has been successfully queued. This 200 OK response does not indicate a successful cancelation of the signature request itself. The cancelation is confirmed via the `signature_request_canceled` event. It is recommended that a [callback handler](/api/reference/tag/Callbacks-and-Events) be implemented to listen for the `signature_request_canceled` event. This callback will be sent only when the cancelation has completed successfully. If a callback handler has been configured and the event has not been received within 60 minutes of making the call, check the status of the request in the [API Dashboard](https://app.hellosign.com/apidashboard) and retry the cancelation if necessary. To be eligible for cancelation, a signature request must have been sent successfully, must not yet have been signed by all signers, and you must either be the sender or own the API app under which it was sent. A partially signed signature request can be canceled. **NOTE:** To remove your access to a completed signature request, use the endpoint: `POST /signature_request/remove/[:signature_request_id]`. + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/SignatureRequestCancelExample.py + :param signature_request_id: The id of the incomplete SignatureRequest to cancel. (required) :type signature_request_id: str :param _request_timeout: timeout setting for this request. If one @@ -839,6 +865,7 @@ def signature_request_cancel_without_preload_content( "200": None, "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -918,6 +945,8 @@ def signature_request_create_embedded( Creates a new SignatureRequest with the submitted documents to be signed in an embedded iFrame. If form_fields_per_document is not specified, a signature page will be affixed where all signers will be required to add their signature, signifying their agreement to all contained documents. Note that embedded signature requests can only be signed in embedded iFrames whereas normal signature requests can only be signed on Dropbox Sign. + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/SignatureRequestCreateEmbeddedExample.py + :param signature_request_create_embedded_request: (required) :type signature_request_create_embedded_request: SignatureRequestCreateEmbeddedRequest :param _request_timeout: timeout setting for this request. If one @@ -954,6 +983,7 @@ def signature_request_create_embedded( "200": "SignatureRequestGetResponse", "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -983,6 +1013,8 @@ def signature_request_create_embedded_with_http_info( Creates a new SignatureRequest with the submitted documents to be signed in an embedded iFrame. If form_fields_per_document is not specified, a signature page will be affixed where all signers will be required to add their signature, signifying their agreement to all contained documents. Note that embedded signature requests can only be signed in embedded iFrames whereas normal signature requests can only be signed on Dropbox Sign. + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/SignatureRequestCreateEmbeddedExample.py + :param signature_request_create_embedded_request: (required) :type signature_request_create_embedded_request: SignatureRequestCreateEmbeddedRequest :param _request_timeout: timeout setting for this request. If one @@ -1019,6 +1051,7 @@ def signature_request_create_embedded_with_http_info( "200": "SignatureRequestGetResponse", "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -1048,6 +1081,8 @@ def signature_request_create_embedded_without_preload_content( Creates a new SignatureRequest with the submitted documents to be signed in an embedded iFrame. If form_fields_per_document is not specified, a signature page will be affixed where all signers will be required to add their signature, signifying their agreement to all contained documents. Note that embedded signature requests can only be signed in embedded iFrames whereas normal signature requests can only be signed on Dropbox Sign. + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/SignatureRequestCreateEmbeddedExample.py + :param signature_request_create_embedded_request: (required) :type signature_request_create_embedded_request: SignatureRequestCreateEmbeddedRequest :param _request_timeout: timeout setting for this request. If one @@ -1084,6 +1119,7 @@ def signature_request_create_embedded_without_preload_content( "200": "SignatureRequestGetResponse", "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -1195,6 +1231,8 @@ def signature_request_create_embedded_with_template( Creates a new SignatureRequest based on the given Template(s) to be signed in an embedded iFrame. Note that embedded signature requests can only be signed in embedded iFrames whereas normal signature requests can only be signed on Dropbox Sign. + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/SignatureRequestCreateEmbeddedWithTemplateExample.py + :param signature_request_create_embedded_with_template_request: (required) :type signature_request_create_embedded_with_template_request: SignatureRequestCreateEmbeddedWithTemplateRequest :param _request_timeout: timeout setting for this request. If one @@ -1231,6 +1269,7 @@ def signature_request_create_embedded_with_template( "200": "SignatureRequestGetResponse", "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -1260,6 +1299,8 @@ def signature_request_create_embedded_with_template_with_http_info( Creates a new SignatureRequest based on the given Template(s) to be signed in an embedded iFrame. Note that embedded signature requests can only be signed in embedded iFrames whereas normal signature requests can only be signed on Dropbox Sign. + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/SignatureRequestCreateEmbeddedWithTemplateExample.py + :param signature_request_create_embedded_with_template_request: (required) :type signature_request_create_embedded_with_template_request: SignatureRequestCreateEmbeddedWithTemplateRequest :param _request_timeout: timeout setting for this request. If one @@ -1296,6 +1337,7 @@ def signature_request_create_embedded_with_template_with_http_info( "200": "SignatureRequestGetResponse", "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -1325,6 +1367,8 @@ def signature_request_create_embedded_with_template_without_preload_content( Creates a new SignatureRequest based on the given Template(s) to be signed in an embedded iFrame. Note that embedded signature requests can only be signed in embedded iFrames whereas normal signature requests can only be signed on Dropbox Sign. + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/SignatureRequestCreateEmbeddedWithTemplateExample.py + :param signature_request_create_embedded_with_template_request: (required) :type signature_request_create_embedded_with_template_request: SignatureRequestCreateEmbeddedWithTemplateRequest :param _request_timeout: timeout setting for this request. If one @@ -1361,6 +1405,7 @@ def signature_request_create_embedded_with_template_without_preload_content( "200": "SignatureRequestGetResponse", "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -1478,6 +1523,8 @@ def signature_request_edit( Edits and sends a SignatureRequest with the submitted documents. If `form_fields_per_document` is not specified, a signature page will be affixed where all signers will be required to add their signature, signifying their agreement to all contained documents. **NOTE:** Edit and resend *will* deduct your signature request quota. + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/SignatureRequestEditExample.py + :param signature_request_id: The id of the SignatureRequest to edit. (required) :type signature_request_id: str :param signature_request_edit_request: (required) @@ -1517,6 +1564,7 @@ def signature_request_edit( "200": "SignatureRequestGetResponse", "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -1549,6 +1597,8 @@ def signature_request_edit_with_http_info( Edits and sends a SignatureRequest with the submitted documents. If `form_fields_per_document` is not specified, a signature page will be affixed where all signers will be required to add their signature, signifying their agreement to all contained documents. **NOTE:** Edit and resend *will* deduct your signature request quota. + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/SignatureRequestEditExample.py + :param signature_request_id: The id of the SignatureRequest to edit. (required) :type signature_request_id: str :param signature_request_edit_request: (required) @@ -1588,6 +1638,7 @@ def signature_request_edit_with_http_info( "200": "SignatureRequestGetResponse", "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -1620,6 +1671,8 @@ def signature_request_edit_without_preload_content( Edits and sends a SignatureRequest with the submitted documents. If `form_fields_per_document` is not specified, a signature page will be affixed where all signers will be required to add their signature, signifying their agreement to all contained documents. **NOTE:** Edit and resend *will* deduct your signature request quota. + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/SignatureRequestEditExample.py + :param signature_request_id: The id of the SignatureRequest to edit. (required) :type signature_request_id: str :param signature_request_edit_request: (required) @@ -1659,6 +1712,7 @@ def signature_request_edit_without_preload_content( "200": "SignatureRequestGetResponse", "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -1776,6 +1830,8 @@ def signature_request_edit_embedded( Edits a SignatureRequest with the submitted documents to be signed in an embedded iFrame. If form_fields_per_document is not specified, a signature page will be affixed where all signers will be required to add their signature, signifying their agreement to all contained documents. Note that embedded signature requests can only be signed in embedded iFrames whereas normal signature requests can only be signed on Dropbox Sign. **NOTE:** Edit and resend *will* deduct your signature request quota. + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/SignatureRequestEditEmbeddedExample.py + :param signature_request_id: The id of the SignatureRequest to edit. (required) :type signature_request_id: str :param signature_request_edit_embedded_request: (required) @@ -1815,6 +1871,7 @@ def signature_request_edit_embedded( "200": "SignatureRequestGetResponse", "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -1847,6 +1904,8 @@ def signature_request_edit_embedded_with_http_info( Edits a SignatureRequest with the submitted documents to be signed in an embedded iFrame. If form_fields_per_document is not specified, a signature page will be affixed where all signers will be required to add their signature, signifying their agreement to all contained documents. Note that embedded signature requests can only be signed in embedded iFrames whereas normal signature requests can only be signed on Dropbox Sign. **NOTE:** Edit and resend *will* deduct your signature request quota. + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/SignatureRequestEditEmbeddedExample.py + :param signature_request_id: The id of the SignatureRequest to edit. (required) :type signature_request_id: str :param signature_request_edit_embedded_request: (required) @@ -1886,6 +1945,7 @@ def signature_request_edit_embedded_with_http_info( "200": "SignatureRequestGetResponse", "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -1918,6 +1978,8 @@ def signature_request_edit_embedded_without_preload_content( Edits a SignatureRequest with the submitted documents to be signed in an embedded iFrame. If form_fields_per_document is not specified, a signature page will be affixed where all signers will be required to add their signature, signifying their agreement to all contained documents. Note that embedded signature requests can only be signed in embedded iFrames whereas normal signature requests can only be signed on Dropbox Sign. **NOTE:** Edit and resend *will* deduct your signature request quota. + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/SignatureRequestEditEmbeddedExample.py + :param signature_request_id: The id of the SignatureRequest to edit. (required) :type signature_request_id: str :param signature_request_edit_embedded_request: (required) @@ -1957,6 +2019,7 @@ def signature_request_edit_embedded_without_preload_content( "200": "SignatureRequestGetResponse", "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -2074,6 +2137,8 @@ def signature_request_edit_embedded_with_template( Edits a SignatureRequest based on the given Template(s) to be signed in an embedded iFrame. Note that embedded signature requests can only be signed in embedded iFrames whereas normal signature requests can only be signed on Dropbox Sign. **NOTE:** Edit and resend *will* deduct your signature request quota. + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/SignatureRequestEditEmbeddedWithTemplateExample.py + :param signature_request_id: The id of the SignatureRequest to edit. (required) :type signature_request_id: str :param signature_request_edit_embedded_with_template_request: (required) @@ -2113,6 +2178,7 @@ def signature_request_edit_embedded_with_template( "200": "SignatureRequestGetResponse", "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -2145,6 +2211,8 @@ def signature_request_edit_embedded_with_template_with_http_info( Edits a SignatureRequest based on the given Template(s) to be signed in an embedded iFrame. Note that embedded signature requests can only be signed in embedded iFrames whereas normal signature requests can only be signed on Dropbox Sign. **NOTE:** Edit and resend *will* deduct your signature request quota. + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/SignatureRequestEditEmbeddedWithTemplateExample.py + :param signature_request_id: The id of the SignatureRequest to edit. (required) :type signature_request_id: str :param signature_request_edit_embedded_with_template_request: (required) @@ -2184,6 +2252,7 @@ def signature_request_edit_embedded_with_template_with_http_info( "200": "SignatureRequestGetResponse", "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -2216,6 +2285,8 @@ def signature_request_edit_embedded_with_template_without_preload_content( Edits a SignatureRequest based on the given Template(s) to be signed in an embedded iFrame. Note that embedded signature requests can only be signed in embedded iFrames whereas normal signature requests can only be signed on Dropbox Sign. **NOTE:** Edit and resend *will* deduct your signature request quota. + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/SignatureRequestEditEmbeddedWithTemplateExample.py + :param signature_request_id: The id of the SignatureRequest to edit. (required) :type signature_request_id: str :param signature_request_edit_embedded_with_template_request: (required) @@ -2255,6 +2326,7 @@ def signature_request_edit_embedded_with_template_without_preload_content( "200": "SignatureRequestGetResponse", "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -2375,6 +2447,8 @@ def signature_request_edit_with_template( Edits and sends a SignatureRequest based off of the Template(s) specified with the template_ids parameter. **NOTE:** Edit and resend *will* deduct your signature request quota. + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/SignatureRequestEditWithTemplateExample.py + :param signature_request_id: The id of the SignatureRequest to edit. (required) :type signature_request_id: str :param signature_request_edit_with_template_request: (required) @@ -2414,6 +2488,7 @@ def signature_request_edit_with_template( "200": "SignatureRequestGetResponse", "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -2446,6 +2521,8 @@ def signature_request_edit_with_template_with_http_info( Edits and sends a SignatureRequest based off of the Template(s) specified with the template_ids parameter. **NOTE:** Edit and resend *will* deduct your signature request quota. + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/SignatureRequestEditWithTemplateExample.py + :param signature_request_id: The id of the SignatureRequest to edit. (required) :type signature_request_id: str :param signature_request_edit_with_template_request: (required) @@ -2485,6 +2562,7 @@ def signature_request_edit_with_template_with_http_info( "200": "SignatureRequestGetResponse", "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -2517,6 +2595,8 @@ def signature_request_edit_with_template_without_preload_content( Edits and sends a SignatureRequest based off of the Template(s) specified with the template_ids parameter. **NOTE:** Edit and resend *will* deduct your signature request quota. + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/SignatureRequestEditWithTemplateExample.py + :param signature_request_id: The id of the SignatureRequest to edit. (required) :type signature_request_id: str :param signature_request_edit_with_template_request: (required) @@ -2556,6 +2636,7 @@ def signature_request_edit_with_template_without_preload_content( "200": "SignatureRequestGetResponse", "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -2681,6 +2762,8 @@ def signature_request_files( Obtain a copy of the current documents specified by the `signature_request_id` parameter. Returns a PDF or ZIP file. If the files are currently being prepared, a status code of `409` will be returned instead. + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/SignatureRequestFilesExample.py + :param signature_request_id: The id of the SignatureRequest to retrieve. (required) :type signature_request_id: str :param file_type: Set to `pdf` for a single merged document or `zip` for a collection of individual documents. @@ -2720,6 +2803,7 @@ def signature_request_files( "200": "io.IOBase", "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -2757,6 +2841,8 @@ def signature_request_files_with_http_info( Obtain a copy of the current documents specified by the `signature_request_id` parameter. Returns a PDF or ZIP file. If the files are currently being prepared, a status code of `409` will be returned instead. + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/SignatureRequestFilesExample.py + :param signature_request_id: The id of the SignatureRequest to retrieve. (required) :type signature_request_id: str :param file_type: Set to `pdf` for a single merged document or `zip` for a collection of individual documents. @@ -2796,6 +2882,7 @@ def signature_request_files_with_http_info( "200": "io.IOBase", "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -2833,6 +2920,8 @@ def signature_request_files_without_preload_content( Obtain a copy of the current documents specified by the `signature_request_id` parameter. Returns a PDF or ZIP file. If the files are currently being prepared, a status code of `409` will be returned instead. + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/SignatureRequestFilesExample.py + :param signature_request_id: The id of the SignatureRequest to retrieve. (required) :type signature_request_id: str :param file_type: Set to `pdf` for a single merged document or `zip` for a collection of individual documents. @@ -2872,6 +2961,7 @@ def signature_request_files_without_preload_content( "200": "io.IOBase", "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -2958,6 +3048,8 @@ def signature_request_files_as_data_uri( Obtain a copy of the current documents specified by the `signature_request_id` parameter. Returns a JSON object with a `data_uri` representing the base64 encoded file (PDFs only). If the files are currently being prepared, a status code of `409` will be returned instead. + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/SignatureRequestFilesAsDataUriExample.py + :param signature_request_id: The id of the SignatureRequest to retrieve. (required) :type signature_request_id: str :param _request_timeout: timeout setting for this request. If one @@ -2994,6 +3086,7 @@ def signature_request_files_as_data_uri( "200": "FileResponseDataUri", "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -3025,6 +3118,8 @@ def signature_request_files_as_data_uri_with_http_info( Obtain a copy of the current documents specified by the `signature_request_id` parameter. Returns a JSON object with a `data_uri` representing the base64 encoded file (PDFs only). If the files are currently being prepared, a status code of `409` will be returned instead. + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/SignatureRequestFilesAsDataUriExample.py + :param signature_request_id: The id of the SignatureRequest to retrieve. (required) :type signature_request_id: str :param _request_timeout: timeout setting for this request. If one @@ -3061,6 +3156,7 @@ def signature_request_files_as_data_uri_with_http_info( "200": "FileResponseDataUri", "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -3092,6 +3188,8 @@ def signature_request_files_as_data_uri_without_preload_content( Obtain a copy of the current documents specified by the `signature_request_id` parameter. Returns a JSON object with a `data_uri` representing the base64 encoded file (PDFs only). If the files are currently being prepared, a status code of `409` will be returned instead. + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/SignatureRequestFilesAsDataUriExample.py + :param signature_request_id: The id of the SignatureRequest to retrieve. (required) :type signature_request_id: str :param _request_timeout: timeout setting for this request. If one @@ -3128,6 +3226,7 @@ def signature_request_files_as_data_uri_without_preload_content( "200": "FileResponseDataUri", "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -3215,6 +3314,8 @@ def signature_request_files_as_file_url( Obtain a copy of the current documents specified by the `signature_request_id` parameter. Returns a JSON object with a url to the file (PDFs only). If the files are currently being prepared, a status code of `409` will be returned instead. + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/SignatureRequestFilesAsFileUrlExample.py + :param signature_request_id: The id of the SignatureRequest to retrieve. (required) :type signature_request_id: str :param force_download: By default when opening the `file_url` a browser will download the PDF and save it locally. When set to `0` the PDF file will be displayed in the browser. @@ -3254,6 +3355,7 @@ def signature_request_files_as_file_url( "200": "FileResponse", "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -3291,6 +3393,8 @@ def signature_request_files_as_file_url_with_http_info( Obtain a copy of the current documents specified by the `signature_request_id` parameter. Returns a JSON object with a url to the file (PDFs only). If the files are currently being prepared, a status code of `409` will be returned instead. + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/SignatureRequestFilesAsFileUrlExample.py + :param signature_request_id: The id of the SignatureRequest to retrieve. (required) :type signature_request_id: str :param force_download: By default when opening the `file_url` a browser will download the PDF and save it locally. When set to `0` the PDF file will be displayed in the browser. @@ -3330,6 +3434,7 @@ def signature_request_files_as_file_url_with_http_info( "200": "FileResponse", "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -3367,6 +3472,8 @@ def signature_request_files_as_file_url_without_preload_content( Obtain a copy of the current documents specified by the `signature_request_id` parameter. Returns a JSON object with a url to the file (PDFs only). If the files are currently being prepared, a status code of `409` will be returned instead. + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/SignatureRequestFilesAsFileUrlExample.py + :param signature_request_id: The id of the SignatureRequest to retrieve. (required) :type signature_request_id: str :param force_download: By default when opening the `file_url` a browser will download the PDF and save it locally. When set to `0` the PDF file will be displayed in the browser. @@ -3406,6 +3513,7 @@ def signature_request_files_as_file_url_without_preload_content( "200": "FileResponse", "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -3492,6 +3600,8 @@ def signature_request_get( Returns the status of the SignatureRequest specified by the `signature_request_id` parameter. + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/SignatureRequestGetExample.py + :param signature_request_id: The id of the SignatureRequest to retrieve. (required) :type signature_request_id: str :param _request_timeout: timeout setting for this request. If one @@ -3528,6 +3638,7 @@ def signature_request_get( "200": "SignatureRequestGetResponse", "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -3559,6 +3670,8 @@ def signature_request_get_with_http_info( Returns the status of the SignatureRequest specified by the `signature_request_id` parameter. + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/SignatureRequestGetExample.py + :param signature_request_id: The id of the SignatureRequest to retrieve. (required) :type signature_request_id: str :param _request_timeout: timeout setting for this request. If one @@ -3595,6 +3708,7 @@ def signature_request_get_with_http_info( "200": "SignatureRequestGetResponse", "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -3626,6 +3740,8 @@ def signature_request_get_without_preload_content( Returns the status of the SignatureRequest specified by the `signature_request_id` parameter. + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/SignatureRequestGetExample.py + :param signature_request_id: The id of the SignatureRequest to retrieve. (required) :type signature_request_id: str :param _request_timeout: timeout setting for this request. If one @@ -3662,6 +3778,7 @@ def signature_request_get_without_preload_content( "200": "SignatureRequestGetResponse", "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -3764,6 +3881,8 @@ def signature_request_list( Returns a list of SignatureRequests that you can access. This includes SignatureRequests you have sent as well as received, but not ones that you have been CCed on. Take a look at our [search guide](/api/reference/search/) to learn more about querying signature requests. + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/SignatureRequestListExample.py + :param account_id: Which account to return SignatureRequests for. Must be a team member. Use `all` to indicate all team members. Defaults to your account. :type account_id: str :param page: Which page number of the SignatureRequest List to return. Defaults to `1`. @@ -3809,6 +3928,7 @@ def signature_request_list( "200": "SignatureRequestListResponse", "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -3861,6 +3981,8 @@ def signature_request_list_with_http_info( Returns a list of SignatureRequests that you can access. This includes SignatureRequests you have sent as well as received, but not ones that you have been CCed on. Take a look at our [search guide](/api/reference/search/) to learn more about querying signature requests. + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/SignatureRequestListExample.py + :param account_id: Which account to return SignatureRequests for. Must be a team member. Use `all` to indicate all team members. Defaults to your account. :type account_id: str :param page: Which page number of the SignatureRequest List to return. Defaults to `1`. @@ -3906,6 +4028,7 @@ def signature_request_list_with_http_info( "200": "SignatureRequestListResponse", "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -3958,6 +4081,8 @@ def signature_request_list_without_preload_content( Returns a list of SignatureRequests that you can access. This includes SignatureRequests you have sent as well as received, but not ones that you have been CCed on. Take a look at our [search guide](/api/reference/search/) to learn more about querying signature requests. + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/SignatureRequestListExample.py + :param account_id: Which account to return SignatureRequests for. Must be a team member. Use `all` to indicate all team members. Defaults to your account. :type account_id: str :param page: Which page number of the SignatureRequest List to return. Defaults to `1`. @@ -4003,6 +4128,7 @@ def signature_request_list_without_preload_content( "200": "SignatureRequestListResponse", "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -4101,6 +4227,8 @@ def signature_request_release_hold( Releases a held SignatureRequest that was claimed and prepared from an [UnclaimedDraft](/api/reference/tag/Unclaimed-Draft). The owner of the Draft must indicate at Draft creation that the SignatureRequest created from the Draft should be held. Releasing the SignatureRequest will send requests to all signers. + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/SignatureRequestReleaseHoldExample.py + :param signature_request_id: The id of the SignatureRequest to release. (required) :type signature_request_id: str :param _request_timeout: timeout setting for this request. If one @@ -4137,6 +4265,7 @@ def signature_request_release_hold( "200": "SignatureRequestGetResponse", "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -4168,6 +4297,8 @@ def signature_request_release_hold_with_http_info( Releases a held SignatureRequest that was claimed and prepared from an [UnclaimedDraft](/api/reference/tag/Unclaimed-Draft). The owner of the Draft must indicate at Draft creation that the SignatureRequest created from the Draft should be held. Releasing the SignatureRequest will send requests to all signers. + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/SignatureRequestReleaseHoldExample.py + :param signature_request_id: The id of the SignatureRequest to release. (required) :type signature_request_id: str :param _request_timeout: timeout setting for this request. If one @@ -4204,6 +4335,7 @@ def signature_request_release_hold_with_http_info( "200": "SignatureRequestGetResponse", "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -4235,6 +4367,8 @@ def signature_request_release_hold_without_preload_content( Releases a held SignatureRequest that was claimed and prepared from an [UnclaimedDraft](/api/reference/tag/Unclaimed-Draft). The owner of the Draft must indicate at Draft creation that the SignatureRequest created from the Draft should be held. Releasing the SignatureRequest will send requests to all signers. + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/SignatureRequestReleaseHoldExample.py + :param signature_request_id: The id of the SignatureRequest to release. (required) :type signature_request_id: str :param _request_timeout: timeout setting for this request. If one @@ -4271,6 +4405,7 @@ def signature_request_release_hold_without_preload_content( "200": "SignatureRequestGetResponse", "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -4354,6 +4489,8 @@ def signature_request_remind( Sends an email to the signer reminding them to sign the signature request. You cannot send a reminder within 1 hour of the last reminder that was sent. This includes manual AND automatic reminders. **NOTE:** This action can **not** be used with embedded signature requests. + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/SignatureRequestRemindExample.py + :param signature_request_id: The id of the SignatureRequest to send a reminder for. (required) :type signature_request_id: str :param signature_request_remind_request: (required) @@ -4393,6 +4530,7 @@ def signature_request_remind( "200": "SignatureRequestGetResponse", "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -4426,6 +4564,8 @@ def signature_request_remind_with_http_info( Sends an email to the signer reminding them to sign the signature request. You cannot send a reminder within 1 hour of the last reminder that was sent. This includes manual AND automatic reminders. **NOTE:** This action can **not** be used with embedded signature requests. + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/SignatureRequestRemindExample.py + :param signature_request_id: The id of the SignatureRequest to send a reminder for. (required) :type signature_request_id: str :param signature_request_remind_request: (required) @@ -4465,6 +4605,7 @@ def signature_request_remind_with_http_info( "200": "SignatureRequestGetResponse", "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -4498,6 +4639,8 @@ def signature_request_remind_without_preload_content( Sends an email to the signer reminding them to sign the signature request. You cannot send a reminder within 1 hour of the last reminder that was sent. This includes manual AND automatic reminders. **NOTE:** This action can **not** be used with embedded signature requests. + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/SignatureRequestRemindExample.py + :param signature_request_id: The id of the SignatureRequest to send a reminder for. (required) :type signature_request_id: str :param signature_request_remind_request: (required) @@ -4537,6 +4680,7 @@ def signature_request_remind_without_preload_content( "200": "SignatureRequestGetResponse", "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -4653,6 +4797,8 @@ def signature_request_remove( Removes your access to a completed signature request. This action is **not reversible**. The signature request must be fully executed by all parties (signed or declined to sign). Other parties will continue to maintain access to the completed signature request document(s). Unlike /signature_request/cancel, this endpoint is synchronous and your access will be immediately removed. Upon successful removal, this endpoint will return a 200 OK response. + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/SignatureRequestRemoveExample.py + :param signature_request_id: The id of the SignatureRequest to remove. (required) :type signature_request_id: str :param _request_timeout: timeout setting for this request. If one @@ -4689,6 +4835,7 @@ def signature_request_remove( "200": None, "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -4720,6 +4867,8 @@ def signature_request_remove_with_http_info( Removes your access to a completed signature request. This action is **not reversible**. The signature request must be fully executed by all parties (signed or declined to sign). Other parties will continue to maintain access to the completed signature request document(s). Unlike /signature_request/cancel, this endpoint is synchronous and your access will be immediately removed. Upon successful removal, this endpoint will return a 200 OK response. + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/SignatureRequestRemoveExample.py + :param signature_request_id: The id of the SignatureRequest to remove. (required) :type signature_request_id: str :param _request_timeout: timeout setting for this request. If one @@ -4756,6 +4905,7 @@ def signature_request_remove_with_http_info( "200": None, "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -4787,6 +4937,8 @@ def signature_request_remove_without_preload_content( Removes your access to a completed signature request. This action is **not reversible**. The signature request must be fully executed by all parties (signed or declined to sign). Other parties will continue to maintain access to the completed signature request document(s). Unlike /signature_request/cancel, this endpoint is synchronous and your access will be immediately removed. Upon successful removal, this endpoint will return a 200 OK response. + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/SignatureRequestRemoveExample.py + :param signature_request_id: The id of the SignatureRequest to remove. (required) :type signature_request_id: str :param _request_timeout: timeout setting for this request. If one @@ -4823,6 +4975,7 @@ def signature_request_remove_without_preload_content( "200": None, "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -4902,6 +5055,8 @@ def signature_request_send( Creates and sends a new SignatureRequest with the submitted documents. If `form_fields_per_document` is not specified, a signature page will be affixed where all signers will be required to add their signature, signifying their agreement to all contained documents. + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/SignatureRequestSendExample.py + :param signature_request_send_request: (required) :type signature_request_send_request: SignatureRequestSendRequest :param _request_timeout: timeout setting for this request. If one @@ -4938,6 +5093,7 @@ def signature_request_send( "200": "SignatureRequestGetResponse", "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -4967,6 +5123,8 @@ def signature_request_send_with_http_info( Creates and sends a new SignatureRequest with the submitted documents. If `form_fields_per_document` is not specified, a signature page will be affixed where all signers will be required to add their signature, signifying their agreement to all contained documents. + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/SignatureRequestSendExample.py + :param signature_request_send_request: (required) :type signature_request_send_request: SignatureRequestSendRequest :param _request_timeout: timeout setting for this request. If one @@ -5003,6 +5161,7 @@ def signature_request_send_with_http_info( "200": "SignatureRequestGetResponse", "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -5032,6 +5191,8 @@ def signature_request_send_without_preload_content( Creates and sends a new SignatureRequest with the submitted documents. If `form_fields_per_document` is not specified, a signature page will be affixed where all signers will be required to add their signature, signifying their agreement to all contained documents. + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/SignatureRequestSendExample.py + :param signature_request_send_request: (required) :type signature_request_send_request: SignatureRequestSendRequest :param _request_timeout: timeout setting for this request. If one @@ -5068,6 +5229,7 @@ def signature_request_send_without_preload_content( "200": "SignatureRequestGetResponse", "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -5179,6 +5341,8 @@ def signature_request_send_with_template( Creates and sends a new SignatureRequest based off of the Template(s) specified with the `template_ids` parameter. + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/SignatureRequestSendWithTemplateExample.py + :param signature_request_send_with_template_request: (required) :type signature_request_send_with_template_request: SignatureRequestSendWithTemplateRequest :param _request_timeout: timeout setting for this request. If one @@ -5215,6 +5379,7 @@ def signature_request_send_with_template( "200": "SignatureRequestGetResponse", "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -5244,6 +5409,8 @@ def signature_request_send_with_template_with_http_info( Creates and sends a new SignatureRequest based off of the Template(s) specified with the `template_ids` parameter. + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/SignatureRequestSendWithTemplateExample.py + :param signature_request_send_with_template_request: (required) :type signature_request_send_with_template_request: SignatureRequestSendWithTemplateRequest :param _request_timeout: timeout setting for this request. If one @@ -5280,6 +5447,7 @@ def signature_request_send_with_template_with_http_info( "200": "SignatureRequestGetResponse", "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -5309,6 +5477,8 @@ def signature_request_send_with_template_without_preload_content( Creates and sends a new SignatureRequest based off of the Template(s) specified with the `template_ids` parameter. + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/SignatureRequestSendWithTemplateExample.py + :param signature_request_send_with_template_request: (required) :type signature_request_send_with_template_request: SignatureRequestSendWithTemplateRequest :param _request_timeout: timeout setting for this request. If one @@ -5345,6 +5515,7 @@ def signature_request_send_with_template_without_preload_content( "200": "SignatureRequestGetResponse", "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -5462,6 +5633,8 @@ def signature_request_update( Updates the email address and/or the name for a given signer on a signature request. You can listen for the `signature_request_email_bounce` event on your app or account to detect bounced emails, and respond with this method. Updating the email address of a signer will generate a new `signature_id` value. **NOTE:** This action cannot be performed on a signature request with an appended signature page. + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/SignatureRequestUpdateExample.py + :param signature_request_id: The id of the SignatureRequest to update. (required) :type signature_request_id: str :param signature_request_update_request: (required) @@ -5501,6 +5674,7 @@ def signature_request_update( "200": "SignatureRequestGetResponse", "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -5533,6 +5707,8 @@ def signature_request_update_with_http_info( Updates the email address and/or the name for a given signer on a signature request. You can listen for the `signature_request_email_bounce` event on your app or account to detect bounced emails, and respond with this method. Updating the email address of a signer will generate a new `signature_id` value. **NOTE:** This action cannot be performed on a signature request with an appended signature page. + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/SignatureRequestUpdateExample.py + :param signature_request_id: The id of the SignatureRequest to update. (required) :type signature_request_id: str :param signature_request_update_request: (required) @@ -5572,6 +5748,7 @@ def signature_request_update_with_http_info( "200": "SignatureRequestGetResponse", "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -5604,6 +5781,8 @@ def signature_request_update_without_preload_content( Updates the email address and/or the name for a given signer on a signature request. You can listen for the `signature_request_email_bounce` event on your app or account to detect bounced emails, and respond with this method. Updating the email address of a signer will generate a new `signature_id` value. **NOTE:** This action cannot be performed on a signature request with an appended signature page. + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/SignatureRequestUpdateExample.py + :param signature_request_id: The id of the SignatureRequest to update. (required) :type signature_request_id: str :param signature_request_update_request: (required) @@ -5643,6 +5822,7 @@ def signature_request_update_without_preload_content( "200": "SignatureRequestGetResponse", "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) diff --git a/sdks/python/dropbox_sign/api/team_api.py b/sdks/python/dropbox_sign/api/team_api.py index f59cf5eeb..db6adcc16 100644 --- a/sdks/python/dropbox_sign/api/team_api.py +++ b/sdks/python/dropbox_sign/api/team_api.py @@ -71,6 +71,8 @@ def team_add_member( Invites a user (specified using the `email_address` parameter) to your Team. If the user does not currently have a Dropbox Sign Account, a new one will be created for them. If a user is already a part of another Team, a `team_invite_failed` error will be returned. + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/TeamAddMemberExample.py + :param team_add_member_request: (required) :type team_add_member_request: TeamAddMemberRequest :param team_id: The id of the team. @@ -110,6 +112,7 @@ def team_add_member( "200": "TeamGetResponse", "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -142,6 +145,8 @@ def team_add_member_with_http_info( Invites a user (specified using the `email_address` parameter) to your Team. If the user does not currently have a Dropbox Sign Account, a new one will be created for them. If a user is already a part of another Team, a `team_invite_failed` error will be returned. + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/TeamAddMemberExample.py + :param team_add_member_request: (required) :type team_add_member_request: TeamAddMemberRequest :param team_id: The id of the team. @@ -181,6 +186,7 @@ def team_add_member_with_http_info( "200": "TeamGetResponse", "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -213,6 +219,8 @@ def team_add_member_without_preload_content( Invites a user (specified using the `email_address` parameter) to your Team. If the user does not currently have a Dropbox Sign Account, a new one will be created for them. If a user is already a part of another Team, a `team_invite_failed` error will be returned. + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/TeamAddMemberExample.py + :param team_add_member_request: (required) :type team_add_member_request: TeamAddMemberRequest :param team_id: The id of the team. @@ -252,6 +260,7 @@ def team_add_member_without_preload_content( "200": "TeamGetResponse", "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -368,6 +377,8 @@ def team_create( Creates a new Team and makes you a member. You must not currently belong to a Team to invoke. + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/TeamCreateExample.py + :param team_create_request: (required) :type team_create_request: TeamCreateRequest :param _request_timeout: timeout setting for this request. If one @@ -404,6 +415,7 @@ def team_create( "200": "TeamGetResponse", "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -433,6 +445,8 @@ def team_create_with_http_info( Creates a new Team and makes you a member. You must not currently belong to a Team to invoke. + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/TeamCreateExample.py + :param team_create_request: (required) :type team_create_request: TeamCreateRequest :param _request_timeout: timeout setting for this request. If one @@ -469,6 +483,7 @@ def team_create_with_http_info( "200": "TeamGetResponse", "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -498,6 +513,8 @@ def team_create_without_preload_content( Creates a new Team and makes you a member. You must not currently belong to a Team to invoke. + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/TeamCreateExample.py + :param team_create_request: (required) :type team_create_request: TeamCreateRequest :param _request_timeout: timeout setting for this request. If one @@ -534,6 +551,7 @@ def team_create_without_preload_content( "200": "TeamGetResponse", "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -644,6 +662,8 @@ def team_delete( Deletes your Team. Can only be invoked when you have a Team with only one member (yourself). + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/TeamDeleteExample.py + :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of @@ -677,6 +697,7 @@ def team_delete( "200": None, "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -705,6 +726,8 @@ def team_delete_with_http_info( Deletes your Team. Can only be invoked when you have a Team with only one member (yourself). + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/TeamDeleteExample.py + :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of @@ -738,6 +761,7 @@ def team_delete_with_http_info( "200": None, "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -766,6 +790,8 @@ def team_delete_without_preload_content( Deletes your Team. Can only be invoked when you have a Team with only one member (yourself). + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/TeamDeleteExample.py + :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of @@ -799,6 +825,7 @@ def team_delete_without_preload_content( "200": None, "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -874,6 +901,8 @@ def team_get( Returns information about your Team as well as a list of its members. If you do not belong to a Team, a 404 error with an error_name of \"not_found\" will be returned. + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/TeamGetExample.py + :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of @@ -907,6 +936,7 @@ def team_get( "200": "TeamGetResponse", "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -935,6 +965,8 @@ def team_get_with_http_info( Returns information about your Team as well as a list of its members. If you do not belong to a Team, a 404 error with an error_name of \"not_found\" will be returned. + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/TeamGetExample.py + :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of @@ -968,6 +1000,7 @@ def team_get_with_http_info( "200": "TeamGetResponse", "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -996,6 +1029,8 @@ def team_get_without_preload_content( Returns information about your Team as well as a list of its members. If you do not belong to a Team, a 404 error with an error_name of \"not_found\" will be returned. + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/TeamGetExample.py + :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of @@ -1029,6 +1064,7 @@ def team_get_without_preload_content( "200": "TeamGetResponse", "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -1107,6 +1143,8 @@ def team_info( Provides information about a team. + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/TeamInfoExample.py + :param team_id: The id of the team. :type team_id: str :param _request_timeout: timeout setting for this request. If one @@ -1143,6 +1181,7 @@ def team_info( "200": "TeamGetInfoResponse", "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -1174,6 +1213,8 @@ def team_info_with_http_info( Provides information about a team. + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/TeamInfoExample.py + :param team_id: The id of the team. :type team_id: str :param _request_timeout: timeout setting for this request. If one @@ -1210,6 +1251,7 @@ def team_info_with_http_info( "200": "TeamGetInfoResponse", "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -1241,6 +1283,8 @@ def team_info_without_preload_content( Provides information about a team. + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/TeamInfoExample.py + :param team_id: The id of the team. :type team_id: str :param _request_timeout: timeout setting for this request. If one @@ -1277,6 +1321,7 @@ def team_info_without_preload_content( "200": "TeamGetInfoResponse", "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -1363,6 +1408,8 @@ def team_invites( Provides a list of team invites (and their roles). + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/TeamInvitesExample.py + :param email_address: The email address for which to display the team invites. :type email_address: str :param _request_timeout: timeout setting for this request. If one @@ -1399,6 +1446,7 @@ def team_invites( "200": "TeamInvitesResponse", "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -1433,6 +1481,8 @@ def team_invites_with_http_info( Provides a list of team invites (and their roles). + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/TeamInvitesExample.py + :param email_address: The email address for which to display the team invites. :type email_address: str :param _request_timeout: timeout setting for this request. If one @@ -1469,6 +1519,7 @@ def team_invites_with_http_info( "200": "TeamInvitesResponse", "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -1503,6 +1554,8 @@ def team_invites_without_preload_content( Provides a list of team invites (and their roles). + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/TeamInvitesExample.py + :param email_address: The email address for which to display the team invites. :type email_address: str :param _request_timeout: timeout setting for this request. If one @@ -1539,6 +1592,7 @@ def team_invites_without_preload_content( "200": "TeamInvitesResponse", "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -1637,6 +1691,8 @@ def team_members( Provides a paginated list of members (and their roles) that belong to a given team. + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/TeamMembersExample.py + :param team_id: The id of the team that a member list is being requested from. (required) :type team_id: str :param page: Which page number of the team member list to return. Defaults to `1`. @@ -1679,6 +1735,7 @@ def team_members( "200": "TeamMembersResponse", "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -1725,6 +1782,8 @@ def team_members_with_http_info( Provides a paginated list of members (and their roles) that belong to a given team. + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/TeamMembersExample.py + :param team_id: The id of the team that a member list is being requested from. (required) :type team_id: str :param page: Which page number of the team member list to return. Defaults to `1`. @@ -1767,6 +1826,7 @@ def team_members_with_http_info( "200": "TeamMembersResponse", "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -1813,6 +1873,8 @@ def team_members_without_preload_content( Provides a paginated list of members (and their roles) that belong to a given team. + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/TeamMembersExample.py + :param team_id: The id of the team that a member list is being requested from. (required) :type team_id: str :param page: Which page number of the team member list to return. Defaults to `1`. @@ -1855,6 +1917,7 @@ def team_members_without_preload_content( "200": "TeamMembersResponse", "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -1944,6 +2007,8 @@ def team_remove_member( Removes the provided user Account from your Team. If the Account had an outstanding invitation to your Team, the invitation will be expired. If you choose to transfer documents from the removed Account to an Account provided in the `new_owner_email_address` parameter (available only for Enterprise plans), the response status code will be 201, which indicates that your request has been queued but not fully executed. + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/TeamRemoveMemberExample.py + :param team_remove_member_request: (required) :type team_remove_member_request: TeamRemoveMemberRequest :param _request_timeout: timeout setting for this request. If one @@ -1980,6 +2045,7 @@ def team_remove_member( "201": "TeamGetResponse", "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -2009,6 +2075,8 @@ def team_remove_member_with_http_info( Removes the provided user Account from your Team. If the Account had an outstanding invitation to your Team, the invitation will be expired. If you choose to transfer documents from the removed Account to an Account provided in the `new_owner_email_address` parameter (available only for Enterprise plans), the response status code will be 201, which indicates that your request has been queued but not fully executed. + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/TeamRemoveMemberExample.py + :param team_remove_member_request: (required) :type team_remove_member_request: TeamRemoveMemberRequest :param _request_timeout: timeout setting for this request. If one @@ -2045,6 +2113,7 @@ def team_remove_member_with_http_info( "201": "TeamGetResponse", "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -2074,6 +2143,8 @@ def team_remove_member_without_preload_content( Removes the provided user Account from your Team. If the Account had an outstanding invitation to your Team, the invitation will be expired. If you choose to transfer documents from the removed Account to an Account provided in the `new_owner_email_address` parameter (available only for Enterprise plans), the response status code will be 201, which indicates that your request has been queued but not fully executed. + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/TeamRemoveMemberExample.py + :param team_remove_member_request: (required) :type team_remove_member_request: TeamRemoveMemberRequest :param _request_timeout: timeout setting for this request. If one @@ -2110,6 +2181,7 @@ def team_remove_member_without_preload_content( "201": "TeamGetResponse", "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -2233,6 +2305,8 @@ def team_sub_teams( Provides a paginated list of sub teams that belong to a given team. + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/TeamSubTeamsExample.py + :param team_id: The id of the parent Team. (required) :type team_id: str :param page: Which page number of the SubTeam List to return. Defaults to `1`. @@ -2275,6 +2349,7 @@ def team_sub_teams( "200": "TeamSubTeamsResponse", "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -2316,6 +2391,8 @@ def team_sub_teams_with_http_info( Provides a paginated list of sub teams that belong to a given team. + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/TeamSubTeamsExample.py + :param team_id: The id of the parent Team. (required) :type team_id: str :param page: Which page number of the SubTeam List to return. Defaults to `1`. @@ -2358,6 +2435,7 @@ def team_sub_teams_with_http_info( "200": "TeamSubTeamsResponse", "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -2399,6 +2477,8 @@ def team_sub_teams_without_preload_content( Provides a paginated list of sub teams that belong to a given team. + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/TeamSubTeamsExample.py + :param team_id: The id of the parent Team. (required) :type team_id: str :param page: Which page number of the SubTeam List to return. Defaults to `1`. @@ -2441,6 +2521,7 @@ def team_sub_teams_without_preload_content( "200": "TeamSubTeamsResponse", "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -2530,6 +2611,8 @@ def team_update( Updates the name of your Team. + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/TeamUpdateExample.py + :param team_update_request: (required) :type team_update_request: TeamUpdateRequest :param _request_timeout: timeout setting for this request. If one @@ -2566,6 +2649,7 @@ def team_update( "200": "TeamGetResponse", "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -2595,6 +2679,8 @@ def team_update_with_http_info( Updates the name of your Team. + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/TeamUpdateExample.py + :param team_update_request: (required) :type team_update_request: TeamUpdateRequest :param _request_timeout: timeout setting for this request. If one @@ -2631,6 +2717,7 @@ def team_update_with_http_info( "200": "TeamGetResponse", "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -2660,6 +2747,8 @@ def team_update_without_preload_content( Updates the name of your Team. + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/TeamUpdateExample.py + :param team_update_request: (required) :type team_update_request: TeamUpdateRequest :param _request_timeout: timeout setting for this request. If one @@ -2696,6 +2785,7 @@ def team_update_without_preload_content( "200": "TeamGetResponse", "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) diff --git a/sdks/python/dropbox_sign/api/template_api.py b/sdks/python/dropbox_sign/api/template_api.py index 723488921..4ae3b449b 100644 --- a/sdks/python/dropbox_sign/api/template_api.py +++ b/sdks/python/dropbox_sign/api/template_api.py @@ -81,6 +81,8 @@ def template_add_user( Gives the specified Account access to the specified Template. The specified Account must be a part of your Team. + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/TemplateAddUserExample.py + :param template_id: The id of the Template to give the Account access to. (required) :type template_id: str :param template_add_user_request: (required) @@ -120,6 +122,7 @@ def template_add_user( "200": "TemplateGetResponse", "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -153,6 +156,8 @@ def template_add_user_with_http_info( Gives the specified Account access to the specified Template. The specified Account must be a part of your Team. + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/TemplateAddUserExample.py + :param template_id: The id of the Template to give the Account access to. (required) :type template_id: str :param template_add_user_request: (required) @@ -192,6 +197,7 @@ def template_add_user_with_http_info( "200": "TemplateGetResponse", "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -225,6 +231,8 @@ def template_add_user_without_preload_content( Gives the specified Account access to the specified Template. The specified Account must be a part of your Team. + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/TemplateAddUserExample.py + :param template_id: The id of the Template to give the Account access to. (required) :type template_id: str :param template_add_user_request: (required) @@ -264,6 +272,7 @@ def template_add_user_without_preload_content( "200": "TemplateGetResponse", "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -378,6 +387,8 @@ def template_create( Creates a template that can be used in future signature requests. If `client_id` is provided, the template will be created as an embedded template. Embedded templates can be used for embedded signature requests and can be edited later by generating a new `edit_url` with [/embedded/edit_url/{template_id}](/api/reference/operation/embeddedEditUrl/). Template creation may complete asynchronously after the initial request is accepted. It is recommended that a callback be implemented to listen for the callback event. A `template_created` event indicates the template is ready to use, while a `template_error` event indicates there was a problem while creating the template. If a callback handler has been configured and the event has not been received within 60 minutes of making the call, check the status of the request in the API dashboard and retry the request if necessary. + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/TemplateCreateExample.py + :param template_create_request: (required) :type template_create_request: TemplateCreateRequest :param _request_timeout: timeout setting for this request. If one @@ -414,6 +425,7 @@ def template_create( "200": "TemplateCreateResponse", "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -443,6 +455,8 @@ def template_create_with_http_info( Creates a template that can be used in future signature requests. If `client_id` is provided, the template will be created as an embedded template. Embedded templates can be used for embedded signature requests and can be edited later by generating a new `edit_url` with [/embedded/edit_url/{template_id}](/api/reference/operation/embeddedEditUrl/). Template creation may complete asynchronously after the initial request is accepted. It is recommended that a callback be implemented to listen for the callback event. A `template_created` event indicates the template is ready to use, while a `template_error` event indicates there was a problem while creating the template. If a callback handler has been configured and the event has not been received within 60 minutes of making the call, check the status of the request in the API dashboard and retry the request if necessary. + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/TemplateCreateExample.py + :param template_create_request: (required) :type template_create_request: TemplateCreateRequest :param _request_timeout: timeout setting for this request. If one @@ -479,6 +493,7 @@ def template_create_with_http_info( "200": "TemplateCreateResponse", "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -508,6 +523,8 @@ def template_create_without_preload_content( Creates a template that can be used in future signature requests. If `client_id` is provided, the template will be created as an embedded template. Embedded templates can be used for embedded signature requests and can be edited later by generating a new `edit_url` with [/embedded/edit_url/{template_id}](/api/reference/operation/embeddedEditUrl/). Template creation may complete asynchronously after the initial request is accepted. It is recommended that a callback be implemented to listen for the callback event. A `template_created` event indicates the template is ready to use, while a `template_error` event indicates there was a problem while creating the template. If a callback handler has been configured and the event has not been received within 60 minutes of making the call, check the status of the request in the API dashboard and retry the request if necessary. + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/TemplateCreateExample.py + :param template_create_request: (required) :type template_create_request: TemplateCreateRequest :param _request_timeout: timeout setting for this request. If one @@ -544,6 +561,7 @@ def template_create_without_preload_content( "200": "TemplateCreateResponse", "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -655,6 +673,8 @@ def template_create_embedded_draft( The first step in an embedded template workflow. Creates a draft template that can then be further set up in the template 'edit' stage. + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/TemplateCreateEmbeddedDraftExample.py + :param template_create_embedded_draft_request: (required) :type template_create_embedded_draft_request: TemplateCreateEmbeddedDraftRequest :param _request_timeout: timeout setting for this request. If one @@ -691,6 +711,7 @@ def template_create_embedded_draft( "200": "TemplateCreateEmbeddedDraftResponse", "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -720,6 +741,8 @@ def template_create_embedded_draft_with_http_info( The first step in an embedded template workflow. Creates a draft template that can then be further set up in the template 'edit' stage. + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/TemplateCreateEmbeddedDraftExample.py + :param template_create_embedded_draft_request: (required) :type template_create_embedded_draft_request: TemplateCreateEmbeddedDraftRequest :param _request_timeout: timeout setting for this request. If one @@ -756,6 +779,7 @@ def template_create_embedded_draft_with_http_info( "200": "TemplateCreateEmbeddedDraftResponse", "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -785,6 +809,8 @@ def template_create_embedded_draft_without_preload_content( The first step in an embedded template workflow. Creates a draft template that can then be further set up in the template 'edit' stage. + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/TemplateCreateEmbeddedDraftExample.py + :param template_create_embedded_draft_request: (required) :type template_create_embedded_draft_request: TemplateCreateEmbeddedDraftRequest :param _request_timeout: timeout setting for this request. If one @@ -821,6 +847,7 @@ def template_create_embedded_draft_without_preload_content( "200": "TemplateCreateEmbeddedDraftResponse", "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -934,6 +961,8 @@ def template_delete( Completely deletes the template specified from the account. + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/TemplateDeleteExample.py + :param template_id: The id of the Template to delete. (required) :type template_id: str :param _request_timeout: timeout setting for this request. If one @@ -970,6 +999,7 @@ def template_delete( "200": None, "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -1001,6 +1031,8 @@ def template_delete_with_http_info( Completely deletes the template specified from the account. + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/TemplateDeleteExample.py + :param template_id: The id of the Template to delete. (required) :type template_id: str :param _request_timeout: timeout setting for this request. If one @@ -1037,6 +1069,7 @@ def template_delete_with_http_info( "200": None, "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -1068,6 +1101,8 @@ def template_delete_without_preload_content( Completely deletes the template specified from the account. + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/TemplateDeleteExample.py + :param template_id: The id of the Template to delete. (required) :type template_id: str :param _request_timeout: timeout setting for this request. If one @@ -1104,6 +1139,7 @@ def template_delete_without_preload_content( "200": None, "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -1191,6 +1227,8 @@ def template_files( Obtain a copy of the current documents specified by the `template_id` parameter. Returns a PDF or ZIP file. If the files are currently being prepared, a status code of `409` will be returned instead. In this case please wait for the `template_created` callback event. + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/TemplateFilesExample.py + :param template_id: The id of the template files to retrieve. (required) :type template_id: str :param file_type: Set to `pdf` for a single merged document or `zip` for a collection of individual documents. @@ -1230,6 +1268,7 @@ def template_files( "200": "io.IOBase", "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -1267,6 +1306,8 @@ def template_files_with_http_info( Obtain a copy of the current documents specified by the `template_id` parameter. Returns a PDF or ZIP file. If the files are currently being prepared, a status code of `409` will be returned instead. In this case please wait for the `template_created` callback event. + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/TemplateFilesExample.py + :param template_id: The id of the template files to retrieve. (required) :type template_id: str :param file_type: Set to `pdf` for a single merged document or `zip` for a collection of individual documents. @@ -1306,6 +1347,7 @@ def template_files_with_http_info( "200": "io.IOBase", "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -1343,6 +1385,8 @@ def template_files_without_preload_content( Obtain a copy of the current documents specified by the `template_id` parameter. Returns a PDF or ZIP file. If the files are currently being prepared, a status code of `409` will be returned instead. In this case please wait for the `template_created` callback event. + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/TemplateFilesExample.py + :param template_id: The id of the template files to retrieve. (required) :type template_id: str :param file_type: Set to `pdf` for a single merged document or `zip` for a collection of individual documents. @@ -1382,6 +1426,7 @@ def template_files_without_preload_content( "200": "io.IOBase", "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -1468,6 +1513,8 @@ def template_files_as_data_uri( Obtain a copy of the current documents specified by the `template_id` parameter. Returns a JSON object with a `data_uri` representing the base64 encoded file (PDFs only). If the files are currently being prepared, a status code of `409` will be returned instead. In this case please wait for the `template_created` callback event. + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/TemplateFilesAsDataUriExample.py + :param template_id: The id of the template files to retrieve. (required) :type template_id: str :param _request_timeout: timeout setting for this request. If one @@ -1504,6 +1551,7 @@ def template_files_as_data_uri( "200": "FileResponseDataUri", "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -1535,6 +1583,8 @@ def template_files_as_data_uri_with_http_info( Obtain a copy of the current documents specified by the `template_id` parameter. Returns a JSON object with a `data_uri` representing the base64 encoded file (PDFs only). If the files are currently being prepared, a status code of `409` will be returned instead. In this case please wait for the `template_created` callback event. + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/TemplateFilesAsDataUriExample.py + :param template_id: The id of the template files to retrieve. (required) :type template_id: str :param _request_timeout: timeout setting for this request. If one @@ -1571,6 +1621,7 @@ def template_files_as_data_uri_with_http_info( "200": "FileResponseDataUri", "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -1602,6 +1653,8 @@ def template_files_as_data_uri_without_preload_content( Obtain a copy of the current documents specified by the `template_id` parameter. Returns a JSON object with a `data_uri` representing the base64 encoded file (PDFs only). If the files are currently being prepared, a status code of `409` will be returned instead. In this case please wait for the `template_created` callback event. + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/TemplateFilesAsDataUriExample.py + :param template_id: The id of the template files to retrieve. (required) :type template_id: str :param _request_timeout: timeout setting for this request. If one @@ -1638,6 +1691,7 @@ def template_files_as_data_uri_without_preload_content( "200": "FileResponseDataUri", "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -1725,6 +1779,8 @@ def template_files_as_file_url( Obtain a copy of the current documents specified by the `template_id` parameter. Returns a JSON object with a url to the file (PDFs only). If the files are currently being prepared, a status code of `409` will be returned instead. In this case please wait for the `template_created` callback event. + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/TemplateFilesAsFileUrlExample.py + :param template_id: The id of the template files to retrieve. (required) :type template_id: str :param force_download: By default when opening the `file_url` a browser will download the PDF and save it locally. When set to `0` the PDF file will be displayed in the browser. @@ -1764,6 +1820,7 @@ def template_files_as_file_url( "200": "FileResponse", "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -1801,6 +1858,8 @@ def template_files_as_file_url_with_http_info( Obtain a copy of the current documents specified by the `template_id` parameter. Returns a JSON object with a url to the file (PDFs only). If the files are currently being prepared, a status code of `409` will be returned instead. In this case please wait for the `template_created` callback event. + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/TemplateFilesAsFileUrlExample.py + :param template_id: The id of the template files to retrieve. (required) :type template_id: str :param force_download: By default when opening the `file_url` a browser will download the PDF and save it locally. When set to `0` the PDF file will be displayed in the browser. @@ -1840,6 +1899,7 @@ def template_files_as_file_url_with_http_info( "200": "FileResponse", "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -1877,6 +1937,8 @@ def template_files_as_file_url_without_preload_content( Obtain a copy of the current documents specified by the `template_id` parameter. Returns a JSON object with a url to the file (PDFs only). If the files are currently being prepared, a status code of `409` will be returned instead. In this case please wait for the `template_created` callback event. + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/TemplateFilesAsFileUrlExample.py + :param template_id: The id of the template files to retrieve. (required) :type template_id: str :param force_download: By default when opening the `file_url` a browser will download the PDF and save it locally. When set to `0` the PDF file will be displayed in the browser. @@ -1916,6 +1978,7 @@ def template_files_as_file_url_without_preload_content( "200": "FileResponse", "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -2002,6 +2065,8 @@ def template_get( Returns the Template specified by the `template_id` parameter. + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/TemplateGetExample.py + :param template_id: The id of the Template to retrieve. (required) :type template_id: str :param _request_timeout: timeout setting for this request. If one @@ -2038,6 +2103,7 @@ def template_get( "200": "TemplateGetResponse", "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -2069,6 +2135,8 @@ def template_get_with_http_info( Returns the Template specified by the `template_id` parameter. + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/TemplateGetExample.py + :param template_id: The id of the Template to retrieve. (required) :type template_id: str :param _request_timeout: timeout setting for this request. If one @@ -2105,6 +2173,7 @@ def template_get_with_http_info( "200": "TemplateGetResponse", "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -2136,6 +2205,8 @@ def template_get_without_preload_content( Returns the Template specified by the `template_id` parameter. + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/TemplateGetExample.py + :param template_id: The id of the Template to retrieve. (required) :type template_id: str :param _request_timeout: timeout setting for this request. If one @@ -2172,6 +2243,7 @@ def template_get_without_preload_content( "200": "TemplateGetResponse", "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -2274,6 +2346,8 @@ def template_list( Returns a list of the Templates that are accessible by you. Take a look at our [search guide](/api/reference/search/) to learn more about querying templates. + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/TemplateListExample.py + :param account_id: Which account to return Templates for. Must be a team member. Use `all` to indicate all team members. Defaults to your account. :type account_id: str :param page: Which page number of the Template List to return. Defaults to `1`. @@ -2319,6 +2393,7 @@ def template_list( "200": "TemplateListResponse", "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -2371,6 +2446,8 @@ def template_list_with_http_info( Returns a list of the Templates that are accessible by you. Take a look at our [search guide](/api/reference/search/) to learn more about querying templates. + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/TemplateListExample.py + :param account_id: Which account to return Templates for. Must be a team member. Use `all` to indicate all team members. Defaults to your account. :type account_id: str :param page: Which page number of the Template List to return. Defaults to `1`. @@ -2416,6 +2493,7 @@ def template_list_with_http_info( "200": "TemplateListResponse", "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -2468,6 +2546,8 @@ def template_list_without_preload_content( Returns a list of the Templates that are accessible by you. Take a look at our [search guide](/api/reference/search/) to learn more about querying templates. + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/TemplateListExample.py + :param account_id: Which account to return Templates for. Must be a team member. Use `all` to indicate all team members. Defaults to your account. :type account_id: str :param page: Which page number of the Template List to return. Defaults to `1`. @@ -2513,6 +2593,7 @@ def template_list_without_preload_content( "200": "TemplateListResponse", "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -2615,6 +2696,8 @@ def template_remove_user( Removes the specified Account's access to the specified Template. + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/TemplateRemoveUserExample.py + :param template_id: The id of the Template to remove the Account's access to. (required) :type template_id: str :param template_remove_user_request: (required) @@ -2654,6 +2737,7 @@ def template_remove_user( "200": "TemplateGetResponse", "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -2689,6 +2773,8 @@ def template_remove_user_with_http_info( Removes the specified Account's access to the specified Template. + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/TemplateRemoveUserExample.py + :param template_id: The id of the Template to remove the Account's access to. (required) :type template_id: str :param template_remove_user_request: (required) @@ -2728,6 +2814,7 @@ def template_remove_user_with_http_info( "200": "TemplateGetResponse", "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -2763,6 +2850,8 @@ def template_remove_user_without_preload_content( Removes the specified Account's access to the specified Template. + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/TemplateRemoveUserExample.py + :param template_id: The id of the Template to remove the Account's access to. (required) :type template_id: str :param template_remove_user_request: (required) @@ -2802,6 +2891,7 @@ def template_remove_user_without_preload_content( "200": "TemplateGetResponse", "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -2920,6 +3010,8 @@ def template_update_files( Overlays a new file with the overlay of an existing template. The new file(s) must: 1. have the same or higher page count 2. the same orientation as the file(s) being replaced. This will not overwrite or in any way affect the existing template. Both the existing template and new template will be available for use after executing this endpoint. Also note that this will decrement your template quota. Overlaying new files is asynchronous and a successful call to this endpoint will return 200 OK response if the request passes initial validation checks. It is recommended that a callback be implemented to listen for the callback event. A `template_created` event will be sent when the files are updated or a `template_error` event will be sent if there was a problem while updating the files. If a callback handler has been configured and the event has not been received within 60 minutes of making the call, check the status of the request in the API dashboard and retry the request if necessary. If the page orientation or page count is different from the original template document, we will notify you with a `template_error` [callback event](https://app.hellosign.com/api/eventsAndCallbacksWalkthrough). + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/TemplateUpdateFilesExample.py + :param template_id: The ID of the template whose files to update. (required) :type template_id: str :param template_update_files_request: (required) @@ -2959,6 +3051,7 @@ def template_update_files( "200": "TemplateUpdateFilesResponse", "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -2992,6 +3085,8 @@ def template_update_files_with_http_info( Overlays a new file with the overlay of an existing template. The new file(s) must: 1. have the same or higher page count 2. the same orientation as the file(s) being replaced. This will not overwrite or in any way affect the existing template. Both the existing template and new template will be available for use after executing this endpoint. Also note that this will decrement your template quota. Overlaying new files is asynchronous and a successful call to this endpoint will return 200 OK response if the request passes initial validation checks. It is recommended that a callback be implemented to listen for the callback event. A `template_created` event will be sent when the files are updated or a `template_error` event will be sent if there was a problem while updating the files. If a callback handler has been configured and the event has not been received within 60 minutes of making the call, check the status of the request in the API dashboard and retry the request if necessary. If the page orientation or page count is different from the original template document, we will notify you with a `template_error` [callback event](https://app.hellosign.com/api/eventsAndCallbacksWalkthrough). + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/TemplateUpdateFilesExample.py + :param template_id: The ID of the template whose files to update. (required) :type template_id: str :param template_update_files_request: (required) @@ -3031,6 +3126,7 @@ def template_update_files_with_http_info( "200": "TemplateUpdateFilesResponse", "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -3064,6 +3160,8 @@ def template_update_files_without_preload_content( Overlays a new file with the overlay of an existing template. The new file(s) must: 1. have the same or higher page count 2. the same orientation as the file(s) being replaced. This will not overwrite or in any way affect the existing template. Both the existing template and new template will be available for use after executing this endpoint. Also note that this will decrement your template quota. Overlaying new files is asynchronous and a successful call to this endpoint will return 200 OK response if the request passes initial validation checks. It is recommended that a callback be implemented to listen for the callback event. A `template_created` event will be sent when the files are updated or a `template_error` event will be sent if there was a problem while updating the files. If a callback handler has been configured and the event has not been received within 60 minutes of making the call, check the status of the request in the API dashboard and retry the request if necessary. If the page orientation or page count is different from the original template document, we will notify you with a `template_error` [callback event](https://app.hellosign.com/api/eventsAndCallbacksWalkthrough). + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/TemplateUpdateFilesExample.py + :param template_id: The ID of the template whose files to update. (required) :type template_id: str :param template_update_files_request: (required) @@ -3103,6 +3201,7 @@ def template_update_files_without_preload_content( "200": "TemplateUpdateFilesResponse", "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) diff --git a/sdks/python/dropbox_sign/api/unclaimed_draft_api.py b/sdks/python/dropbox_sign/api/unclaimed_draft_api.py index 4d4d74382..3c9936164 100644 --- a/sdks/python/dropbox_sign/api/unclaimed_draft_api.py +++ b/sdks/python/dropbox_sign/api/unclaimed_draft_api.py @@ -73,6 +73,8 @@ def unclaimed_draft_create( Creates a new Draft that can be claimed using the claim URL. The first authenticated user to access the URL will claim the Draft and will be shown either the \"Sign and send\" or the \"Request signature\" page with the Draft loaded. Subsequent access to the claim URL will result in a 404. + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/UnclaimedDraftCreateExample.py + :param unclaimed_draft_create_request: (required) :type unclaimed_draft_create_request: UnclaimedDraftCreateRequest :param _request_timeout: timeout setting for this request. If one @@ -109,6 +111,7 @@ def unclaimed_draft_create( "200": "UnclaimedDraftCreateResponse", "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -138,6 +141,8 @@ def unclaimed_draft_create_with_http_info( Creates a new Draft that can be claimed using the claim URL. The first authenticated user to access the URL will claim the Draft and will be shown either the \"Sign and send\" or the \"Request signature\" page with the Draft loaded. Subsequent access to the claim URL will result in a 404. + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/UnclaimedDraftCreateExample.py + :param unclaimed_draft_create_request: (required) :type unclaimed_draft_create_request: UnclaimedDraftCreateRequest :param _request_timeout: timeout setting for this request. If one @@ -174,6 +179,7 @@ def unclaimed_draft_create_with_http_info( "200": "UnclaimedDraftCreateResponse", "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -203,6 +209,8 @@ def unclaimed_draft_create_without_preload_content( Creates a new Draft that can be claimed using the claim URL. The first authenticated user to access the URL will claim the Draft and will be shown either the \"Sign and send\" or the \"Request signature\" page with the Draft loaded. Subsequent access to the claim URL will result in a 404. + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/UnclaimedDraftCreateExample.py + :param unclaimed_draft_create_request: (required) :type unclaimed_draft_create_request: UnclaimedDraftCreateRequest :param _request_timeout: timeout setting for this request. If one @@ -239,6 +247,7 @@ def unclaimed_draft_create_without_preload_content( "200": "UnclaimedDraftCreateResponse", "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -350,6 +359,8 @@ def unclaimed_draft_create_embedded( Creates a new Draft that can be claimed and used in an embedded iFrame. The first authenticated user to access the URL will claim the Draft and will be shown the \"Request signature\" page with the Draft loaded. Subsequent access to the claim URL will result in a `404`. For this embedded endpoint the `requester_email_address` parameter is required. **NOTE:** Embedded unclaimed drafts can only be accessed in embedded iFrames whereas normal drafts can be used and accessed on Dropbox Sign. + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/UnclaimedDraftCreateEmbeddedExample.py + :param unclaimed_draft_create_embedded_request: (required) :type unclaimed_draft_create_embedded_request: UnclaimedDraftCreateEmbeddedRequest :param _request_timeout: timeout setting for this request. If one @@ -386,6 +397,7 @@ def unclaimed_draft_create_embedded( "200": "UnclaimedDraftCreateResponse", "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -415,6 +427,8 @@ def unclaimed_draft_create_embedded_with_http_info( Creates a new Draft that can be claimed and used in an embedded iFrame. The first authenticated user to access the URL will claim the Draft and will be shown the \"Request signature\" page with the Draft loaded. Subsequent access to the claim URL will result in a `404`. For this embedded endpoint the `requester_email_address` parameter is required. **NOTE:** Embedded unclaimed drafts can only be accessed in embedded iFrames whereas normal drafts can be used and accessed on Dropbox Sign. + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/UnclaimedDraftCreateEmbeddedExample.py + :param unclaimed_draft_create_embedded_request: (required) :type unclaimed_draft_create_embedded_request: UnclaimedDraftCreateEmbeddedRequest :param _request_timeout: timeout setting for this request. If one @@ -451,6 +465,7 @@ def unclaimed_draft_create_embedded_with_http_info( "200": "UnclaimedDraftCreateResponse", "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -480,6 +495,8 @@ def unclaimed_draft_create_embedded_without_preload_content( Creates a new Draft that can be claimed and used in an embedded iFrame. The first authenticated user to access the URL will claim the Draft and will be shown the \"Request signature\" page with the Draft loaded. Subsequent access to the claim URL will result in a `404`. For this embedded endpoint the `requester_email_address` parameter is required. **NOTE:** Embedded unclaimed drafts can only be accessed in embedded iFrames whereas normal drafts can be used and accessed on Dropbox Sign. + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/UnclaimedDraftCreateEmbeddedExample.py + :param unclaimed_draft_create_embedded_request: (required) :type unclaimed_draft_create_embedded_request: UnclaimedDraftCreateEmbeddedRequest :param _request_timeout: timeout setting for this request. If one @@ -516,6 +533,7 @@ def unclaimed_draft_create_embedded_without_preload_content( "200": "UnclaimedDraftCreateResponse", "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -627,6 +645,8 @@ def unclaimed_draft_create_embedded_with_template( Creates a new Draft with a previously saved template(s) that can be claimed and used in an embedded iFrame. The first authenticated user to access the URL will claim the Draft and will be shown the \"Request signature\" page with the Draft loaded. Subsequent access to the claim URL will result in a `404`. For this embedded endpoint the `requester_email_address` parameter is required. **NOTE:** Embedded unclaimed drafts can only be accessed in embedded iFrames whereas normal drafts can be used and accessed on Dropbox Sign. + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/UnclaimedDraftCreateEmbeddedWithTemplateExample.py + :param unclaimed_draft_create_embedded_with_template_request: (required) :type unclaimed_draft_create_embedded_with_template_request: UnclaimedDraftCreateEmbeddedWithTemplateRequest :param _request_timeout: timeout setting for this request. If one @@ -663,6 +683,7 @@ def unclaimed_draft_create_embedded_with_template( "200": "UnclaimedDraftCreateResponse", "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -692,6 +713,8 @@ def unclaimed_draft_create_embedded_with_template_with_http_info( Creates a new Draft with a previously saved template(s) that can be claimed and used in an embedded iFrame. The first authenticated user to access the URL will claim the Draft and will be shown the \"Request signature\" page with the Draft loaded. Subsequent access to the claim URL will result in a `404`. For this embedded endpoint the `requester_email_address` parameter is required. **NOTE:** Embedded unclaimed drafts can only be accessed in embedded iFrames whereas normal drafts can be used and accessed on Dropbox Sign. + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/UnclaimedDraftCreateEmbeddedWithTemplateExample.py + :param unclaimed_draft_create_embedded_with_template_request: (required) :type unclaimed_draft_create_embedded_with_template_request: UnclaimedDraftCreateEmbeddedWithTemplateRequest :param _request_timeout: timeout setting for this request. If one @@ -728,6 +751,7 @@ def unclaimed_draft_create_embedded_with_template_with_http_info( "200": "UnclaimedDraftCreateResponse", "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -757,6 +781,8 @@ def unclaimed_draft_create_embedded_with_template_without_preload_content( Creates a new Draft with a previously saved template(s) that can be claimed and used in an embedded iFrame. The first authenticated user to access the URL will claim the Draft and will be shown the \"Request signature\" page with the Draft loaded. Subsequent access to the claim URL will result in a `404`. For this embedded endpoint the `requester_email_address` parameter is required. **NOTE:** Embedded unclaimed drafts can only be accessed in embedded iFrames whereas normal drafts can be used and accessed on Dropbox Sign. + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/UnclaimedDraftCreateEmbeddedWithTemplateExample.py + :param unclaimed_draft_create_embedded_with_template_request: (required) :type unclaimed_draft_create_embedded_with_template_request: UnclaimedDraftCreateEmbeddedWithTemplateRequest :param _request_timeout: timeout setting for this request. If one @@ -793,6 +819,7 @@ def unclaimed_draft_create_embedded_with_template_without_preload_content( "200": "UnclaimedDraftCreateResponse", "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -911,6 +938,8 @@ def unclaimed_draft_edit_and_resend( Creates a new signature request from an embedded request that can be edited prior to being sent to the recipients. Parameter `test_mode` can be edited prior to request. Signers can be edited in embedded editor. Requester's email address will remain unchanged if `requester_email_address` parameter is not set. **NOTE:** Embedded unclaimed drafts can only be accessed in embedded iFrames whereas normal drafts can be used and accessed on Dropbox Sign. + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/UnclaimedDraftEditAndResendExample.py + :param signature_request_id: The ID of the signature request to edit and resend. (required) :type signature_request_id: str :param unclaimed_draft_edit_and_resend_request: (required) @@ -950,6 +979,7 @@ def unclaimed_draft_edit_and_resend( "200": "UnclaimedDraftCreateResponse", "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -983,6 +1013,8 @@ def unclaimed_draft_edit_and_resend_with_http_info( Creates a new signature request from an embedded request that can be edited prior to being sent to the recipients. Parameter `test_mode` can be edited prior to request. Signers can be edited in embedded editor. Requester's email address will remain unchanged if `requester_email_address` parameter is not set. **NOTE:** Embedded unclaimed drafts can only be accessed in embedded iFrames whereas normal drafts can be used and accessed on Dropbox Sign. + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/UnclaimedDraftEditAndResendExample.py + :param signature_request_id: The ID of the signature request to edit and resend. (required) :type signature_request_id: str :param unclaimed_draft_edit_and_resend_request: (required) @@ -1022,6 +1054,7 @@ def unclaimed_draft_edit_and_resend_with_http_info( "200": "UnclaimedDraftCreateResponse", "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -1055,6 +1088,8 @@ def unclaimed_draft_edit_and_resend_without_preload_content( Creates a new signature request from an embedded request that can be edited prior to being sent to the recipients. Parameter `test_mode` can be edited prior to request. Signers can be edited in embedded editor. Requester's email address will remain unchanged if `requester_email_address` parameter is not set. **NOTE:** Embedded unclaimed drafts can only be accessed in embedded iFrames whereas normal drafts can be used and accessed on Dropbox Sign. + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/UnclaimedDraftEditAndResendExample.py + :param signature_request_id: The ID of the signature request to edit and resend. (required) :type signature_request_id: str :param unclaimed_draft_edit_and_resend_request: (required) @@ -1094,6 +1129,7 @@ def unclaimed_draft_edit_and_resend_without_preload_content( "200": "UnclaimedDraftCreateResponse", "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) diff --git a/sdks/python/templates/partial_api.mustache b/sdks/python/templates/partial_api.mustache index dd3a9a1fa..58a9269b3 100644 --- a/sdks/python/templates/partial_api.mustache +++ b/sdks/python/templates/partial_api.mustache @@ -4,6 +4,8 @@ {{{.}}} {{/notes}} + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/{{operationIdCamelCase}}Example.py + {{#allParams}} :param {{paramName}}:{{#description}} {{{.}}}{{/description}}{{#required}} (required){{/required}}{{#optional}}(optional){{/optional}} :type {{paramName}}: {{dataType}}{{#optional}}, optional{{/optional}} @@ -49,4 +51,4 @@ '{{code}}': {{#dataType}}"{{.}}"{{/dataType}}{{^dataType}}None{{/dataType}}, {{/isWildcard}} {{/responses}} - } \ No newline at end of file + } diff --git a/sdks/ruby/lib/dropbox-sign/api/account_api.rb b/sdks/ruby/lib/dropbox-sign/api/account_api.rb index 93a66cc2f..873531b58 100644 --- a/sdks/ruby/lib/dropbox-sign/api/account_api.rb +++ b/sdks/ruby/lib/dropbox-sign/api/account_api.rb @@ -24,6 +24,7 @@ def initialize(api_client = ApiClient.default) end # Create Account # Creates a new Dropbox Sign Account that is associated with the specified `email_address`. + # Example: https://github.com/hellosign/dropbox-sign-ruby/blob/main/examples/AccountCreateExample.rb # @param account_create_request [AccountCreateRequest] # @param [Hash] opts the optional parameters # @return [AccountCreateResponse] @@ -34,6 +35,7 @@ def account_create(account_create_request, opts = {}) # Create Account # Creates a new Dropbox Sign Account that is associated with the specified `email_address`. + # Example: https://github.com/hellosign/dropbox-sign-ruby/blob/main/examples/AccountCreateExample.rb # @param account_create_request [AccountCreateRequest] # @param [Hash] opts the optional parameters # @return [Array<(AccountCreateResponse, Integer, Hash)>] AccountCreateResponse data, response status code and response headers @@ -134,6 +136,7 @@ def account_create_with_http_info(account_create_request, opts = {}) # Get Account # Returns the properties and settings of your Account. + # Example: https://github.com/hellosign/dropbox-sign-ruby/blob/main/examples/AccountGetExample.rb # @param [Hash] opts the optional parameters # @option opts [String] :account_id `account_id` or `email_address` is required. If both are provided, the account id prevails. The ID of the Account. # @option opts [String] :email_address `account_id` or `email_address` is required, If both are provided, the account id prevails. The email address of the Account. @@ -145,6 +148,7 @@ def account_get(opts = {}) # Get Account # Returns the properties and settings of your Account. + # Example: https://github.com/hellosign/dropbox-sign-ruby/blob/main/examples/AccountGetExample.rb # @param [Hash] opts the optional parameters # @option opts [String] :account_id `account_id` or `email_address` is required. If both are provided, the account id prevails. The ID of the Account. # @option opts [String] :email_address `account_id` or `email_address` is required, If both are provided, the account id prevails. The email address of the Account. @@ -229,6 +233,7 @@ def account_get_with_http_info(opts = {}) # Update Account # Updates the properties and settings of your Account. Currently only allows for updates to the [Callback URL](/api/reference/tag/Callbacks-and-Events) and locale. + # Example: https://github.com/hellosign/dropbox-sign-ruby/blob/main/examples/AccountUpdateExample.rb # @param account_update_request [AccountUpdateRequest] # @param [Hash] opts the optional parameters # @return [AccountGetResponse] @@ -239,6 +244,7 @@ def account_update(account_update_request, opts = {}) # Update Account # Updates the properties and settings of your Account. Currently only allows for updates to the [Callback URL](/api/reference/tag/Callbacks-and-Events) and locale. + # Example: https://github.com/hellosign/dropbox-sign-ruby/blob/main/examples/AccountUpdateExample.rb # @param account_update_request [AccountUpdateRequest] # @param [Hash] opts the optional parameters # @return [Array<(AccountGetResponse, Integer, Hash)>] AccountGetResponse data, response status code and response headers @@ -339,6 +345,7 @@ def account_update_with_http_info(account_update_request, opts = {}) # Verify Account # Verifies whether an Dropbox Sign Account exists for the given email address. + # Example: https://github.com/hellosign/dropbox-sign-ruby/blob/main/examples/AccountVerifyExample.rb # @param account_verify_request [AccountVerifyRequest] # @param [Hash] opts the optional parameters # @return [AccountVerifyResponse] @@ -349,6 +356,7 @@ def account_verify(account_verify_request, opts = {}) # Verify Account # Verifies whether an Dropbox Sign Account exists for the given email address. + # Example: https://github.com/hellosign/dropbox-sign-ruby/blob/main/examples/AccountVerifyExample.rb # @param account_verify_request [AccountVerifyRequest] # @param [Hash] opts the optional parameters # @return [Array<(AccountVerifyResponse, Integer, Hash)>] AccountVerifyResponse data, response status code and response headers diff --git a/sdks/ruby/lib/dropbox-sign/api/api_app_api.rb b/sdks/ruby/lib/dropbox-sign/api/api_app_api.rb index 55a35c719..0ec145b5a 100644 --- a/sdks/ruby/lib/dropbox-sign/api/api_app_api.rb +++ b/sdks/ruby/lib/dropbox-sign/api/api_app_api.rb @@ -24,6 +24,7 @@ def initialize(api_client = ApiClient.default) end # Create API App # Creates a new API App. + # Example: https://github.com/hellosign/dropbox-sign-ruby/blob/main/examples/ApiAppCreateExample.rb # @param api_app_create_request [ApiAppCreateRequest] # @param [Hash] opts the optional parameters # @return [ApiAppGetResponse] @@ -34,6 +35,7 @@ def api_app_create(api_app_create_request, opts = {}) # Create API App # Creates a new API App. + # Example: https://github.com/hellosign/dropbox-sign-ruby/blob/main/examples/ApiAppCreateExample.rb # @param api_app_create_request [ApiAppCreateRequest] # @param [Hash] opts the optional parameters # @return [Array<(ApiAppGetResponse, Integer, Hash)>] ApiAppGetResponse data, response status code and response headers @@ -134,6 +136,7 @@ def api_app_create_with_http_info(api_app_create_request, opts = {}) # Delete API App # Deletes an API App. Can only be invoked for apps you own. + # Example: https://github.com/hellosign/dropbox-sign-ruby/blob/main/examples/ApiAppDeleteExample.rb # @param client_id [String] The client id of the API App to delete. # @param [Hash] opts the optional parameters # @return [nil] @@ -144,6 +147,7 @@ def api_app_delete(client_id, opts = {}) # Delete API App # Deletes an API App. Can only be invoked for apps you own. + # Example: https://github.com/hellosign/dropbox-sign-ruby/blob/main/examples/ApiAppDeleteExample.rb # @param client_id [String] The client id of the API App to delete. # @param [Hash] opts the optional parameters # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers @@ -202,6 +206,7 @@ def api_app_delete_with_http_info(client_id, opts = {}) # Get API App # Returns an object with information about an API App. + # Example: https://github.com/hellosign/dropbox-sign-ruby/blob/main/examples/ApiAppGetExample.rb # @param client_id [String] The client id of the API App to retrieve. # @param [Hash] opts the optional parameters # @return [ApiAppGetResponse] @@ -212,6 +217,7 @@ def api_app_get(client_id, opts = {}) # Get API App # Returns an object with information about an API App. + # Example: https://github.com/hellosign/dropbox-sign-ruby/blob/main/examples/ApiAppGetExample.rb # @param client_id [String] The client id of the API App to retrieve. # @param [Hash] opts the optional parameters # @return [Array<(ApiAppGetResponse, Integer, Hash)>] ApiAppGetResponse data, response status code and response headers @@ -297,6 +303,7 @@ def api_app_get_with_http_info(client_id, opts = {}) # List API Apps # Returns a list of API Apps that are accessible by you. If you are on a team with an Admin or Developer role, this list will include apps owned by teammates. + # Example: https://github.com/hellosign/dropbox-sign-ruby/blob/main/examples/ApiAppListExample.rb # @param [Hash] opts the optional parameters # @option opts [Integer] :page Which page number of the API App List to return. Defaults to `1`. (default to 1) # @option opts [Integer] :page_size Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. (default to 20) @@ -308,6 +315,7 @@ def api_app_list(opts = {}) # List API Apps # Returns a list of API Apps that are accessible by you. If you are on a team with an Admin or Developer role, this list will include apps owned by teammates. + # Example: https://github.com/hellosign/dropbox-sign-ruby/blob/main/examples/ApiAppListExample.rb # @param [Hash] opts the optional parameters # @option opts [Integer] :page Which page number of the API App List to return. Defaults to `1`. (default to 1) # @option opts [Integer] :page_size Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. (default to 20) @@ -392,6 +400,7 @@ def api_app_list_with_http_info(opts = {}) # Update API App # Updates an existing API App. Can only be invoked for apps you own. Only the fields you provide will be updated. If you wish to clear an existing optional field, provide an empty string. + # Example: https://github.com/hellosign/dropbox-sign-ruby/blob/main/examples/ApiAppUpdateExample.rb # @param client_id [String] The client id of the API App to update. # @param api_app_update_request [ApiAppUpdateRequest] # @param [Hash] opts the optional parameters @@ -403,6 +412,7 @@ def api_app_update(client_id, api_app_update_request, opts = {}) # Update API App # Updates an existing API App. Can only be invoked for apps you own. Only the fields you provide will be updated. If you wish to clear an existing optional field, provide an empty string. + # Example: https://github.com/hellosign/dropbox-sign-ruby/blob/main/examples/ApiAppUpdateExample.rb # @param client_id [String] The client id of the API App to update. # @param api_app_update_request [ApiAppUpdateRequest] # @param [Hash] opts the optional parameters diff --git a/sdks/ruby/lib/dropbox-sign/api/bulk_send_job_api.rb b/sdks/ruby/lib/dropbox-sign/api/bulk_send_job_api.rb index 69bd2006d..10dcdfe2d 100644 --- a/sdks/ruby/lib/dropbox-sign/api/bulk_send_job_api.rb +++ b/sdks/ruby/lib/dropbox-sign/api/bulk_send_job_api.rb @@ -24,6 +24,7 @@ def initialize(api_client = ApiClient.default) end # Get Bulk Send Job # Returns the status of the BulkSendJob and its SignatureRequests specified by the `bulk_send_job_id` parameter. + # Example: https://github.com/hellosign/dropbox-sign-ruby/blob/main/examples/BulkSendJobGetExample.rb # @param bulk_send_job_id [String] The id of the BulkSendJob to retrieve. # @param [Hash] opts the optional parameters # @option opts [Integer] :page Which page number of the BulkSendJob list to return. Defaults to `1`. (default to 1) @@ -36,6 +37,7 @@ def bulk_send_job_get(bulk_send_job_id, opts = {}) # Get Bulk Send Job # Returns the status of the BulkSendJob and its SignatureRequests specified by the `bulk_send_job_id` parameter. + # Example: https://github.com/hellosign/dropbox-sign-ruby/blob/main/examples/BulkSendJobGetExample.rb # @param bulk_send_job_id [String] The id of the BulkSendJob to retrieve. # @param [Hash] opts the optional parameters # @option opts [Integer] :page Which page number of the BulkSendJob list to return. Defaults to `1`. (default to 1) @@ -125,6 +127,7 @@ def bulk_send_job_get_with_http_info(bulk_send_job_id, opts = {}) # List Bulk Send Jobs # Returns a list of BulkSendJob that you can access. + # Example: https://github.com/hellosign/dropbox-sign-ruby/blob/main/examples/BulkSendJobListExample.rb # @param [Hash] opts the optional parameters # @option opts [Integer] :page Which page number of the BulkSendJob List to return. Defaults to `1`. (default to 1) # @option opts [Integer] :page_size Number of objects to be returned per page. Must be between `1` and `100`. Default is 20. (default to 20) @@ -136,6 +139,7 @@ def bulk_send_job_list(opts = {}) # List Bulk Send Jobs # Returns a list of BulkSendJob that you can access. + # Example: https://github.com/hellosign/dropbox-sign-ruby/blob/main/examples/BulkSendJobListExample.rb # @param [Hash] opts the optional parameters # @option opts [Integer] :page Which page number of the BulkSendJob List to return. Defaults to `1`. (default to 1) # @option opts [Integer] :page_size Number of objects to be returned per page. Must be between `1` and `100`. Default is 20. (default to 20) diff --git a/sdks/ruby/lib/dropbox-sign/api/embedded_api.rb b/sdks/ruby/lib/dropbox-sign/api/embedded_api.rb index efbc7f927..e5c021909 100644 --- a/sdks/ruby/lib/dropbox-sign/api/embedded_api.rb +++ b/sdks/ruby/lib/dropbox-sign/api/embedded_api.rb @@ -24,6 +24,7 @@ def initialize(api_client = ApiClient.default) end # Get Embedded Template Edit URL # Retrieves an embedded object containing a template url that can be opened in an iFrame. Note that only templates created via the embedded template process are available to be edited with this endpoint. + # Example: https://github.com/hellosign/dropbox-sign-ruby/blob/main/examples/EmbeddedEditUrlExample.rb # @param template_id [String] The id of the template to edit. # @param embedded_edit_url_request [EmbeddedEditUrlRequest] # @param [Hash] opts the optional parameters @@ -35,6 +36,7 @@ def embedded_edit_url(template_id, embedded_edit_url_request, opts = {}) # Get Embedded Template Edit URL # Retrieves an embedded object containing a template url that can be opened in an iFrame. Note that only templates created via the embedded template process are available to be edited with this endpoint. + # Example: https://github.com/hellosign/dropbox-sign-ruby/blob/main/examples/EmbeddedEditUrlExample.rb # @param template_id [String] The id of the template to edit. # @param embedded_edit_url_request [EmbeddedEditUrlRequest] # @param [Hash] opts the optional parameters @@ -140,6 +142,7 @@ def embedded_edit_url_with_http_info(template_id, embedded_edit_url_request, opt # Get Embedded Sign URL # Retrieves an embedded object containing a signature url that can be opened in an iFrame. Note that templates created via the embedded template process will only be accessible through the API. + # Example: https://github.com/hellosign/dropbox-sign-ruby/blob/main/examples/EmbeddedSignUrlExample.rb # @param signature_id [String] The id of the signature to get a signature url for. # @param [Hash] opts the optional parameters # @return [EmbeddedSignUrlResponse] @@ -150,6 +153,7 @@ def embedded_sign_url(signature_id, opts = {}) # Get Embedded Sign URL # Retrieves an embedded object containing a signature url that can be opened in an iFrame. Note that templates created via the embedded template process will only be accessible through the API. + # Example: https://github.com/hellosign/dropbox-sign-ruby/blob/main/examples/EmbeddedSignUrlExample.rb # @param signature_id [String] The id of the signature to get a signature url for. # @param [Hash] opts the optional parameters # @return [Array<(EmbeddedSignUrlResponse, Integer, Hash)>] EmbeddedSignUrlResponse data, response status code and response headers diff --git a/sdks/ruby/lib/dropbox-sign/api/fax_api.rb b/sdks/ruby/lib/dropbox-sign/api/fax_api.rb index f4cfda3a6..04d04eb8c 100644 --- a/sdks/ruby/lib/dropbox-sign/api/fax_api.rb +++ b/sdks/ruby/lib/dropbox-sign/api/fax_api.rb @@ -24,6 +24,7 @@ def initialize(api_client = ApiClient.default) end # Delete Fax # Deletes the specified Fax from the system + # Example: https://github.com/hellosign/dropbox-sign-ruby/blob/main/examples/FaxDeleteExample.rb # @param fax_id [String] Fax ID # @param [Hash] opts the optional parameters # @return [nil] @@ -34,6 +35,7 @@ def fax_delete(fax_id, opts = {}) # Delete Fax # Deletes the specified Fax from the system + # Example: https://github.com/hellosign/dropbox-sign-ruby/blob/main/examples/FaxDeleteExample.rb # @param fax_id [String] Fax ID # @param [Hash] opts the optional parameters # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers @@ -92,6 +94,7 @@ def fax_delete_with_http_info(fax_id, opts = {}) # Download Fax Files # Downloads files associated with a Fax + # Example: https://github.com/hellosign/dropbox-sign-ruby/blob/main/examples/FaxFilesExample.rb # @param fax_id [String] Fax ID # @param [Hash] opts the optional parameters # @return [File] @@ -102,6 +105,7 @@ def fax_files(fax_id, opts = {}) # Download Fax Files # Downloads files associated with a Fax + # Example: https://github.com/hellosign/dropbox-sign-ruby/blob/main/examples/FaxFilesExample.rb # @param fax_id [String] Fax ID # @param [Hash] opts the optional parameters # @return [Array<(File, Integer, Hash)>] File data, response status code and response headers @@ -187,6 +191,7 @@ def fax_files_with_http_info(fax_id, opts = {}) # Get Fax # Returns information about a Fax + # Example: https://github.com/hellosign/dropbox-sign-ruby/blob/main/examples/FaxGetExample.rb # @param fax_id [String] Fax ID # @param [Hash] opts the optional parameters # @return [FaxGetResponse] @@ -197,6 +202,7 @@ def fax_get(fax_id, opts = {}) # Get Fax # Returns information about a Fax + # Example: https://github.com/hellosign/dropbox-sign-ruby/blob/main/examples/FaxGetExample.rb # @param fax_id [String] Fax ID # @param [Hash] opts the optional parameters # @return [Array<(FaxGetResponse, Integer, Hash)>] FaxGetResponse data, response status code and response headers @@ -282,6 +288,7 @@ def fax_get_with_http_info(fax_id, opts = {}) # Lists Faxes # Returns properties of multiple Faxes + # Example: https://github.com/hellosign/dropbox-sign-ruby/blob/main/examples/FaxListExample.rb # @param [Hash] opts the optional parameters # @option opts [Integer] :page Which page number of the Fax List to return. Defaults to `1`. (default to 1) # @option opts [Integer] :page_size Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. (default to 20) @@ -293,6 +300,7 @@ def fax_list(opts = {}) # Lists Faxes # Returns properties of multiple Faxes + # Example: https://github.com/hellosign/dropbox-sign-ruby/blob/main/examples/FaxListExample.rb # @param [Hash] opts the optional parameters # @option opts [Integer] :page Which page number of the Fax List to return. Defaults to `1`. (default to 1) # @option opts [Integer] :page_size Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. (default to 20) @@ -389,6 +397,7 @@ def fax_list_with_http_info(opts = {}) # Send Fax # Creates and sends a new Fax with the submitted file(s) + # Example: https://github.com/hellosign/dropbox-sign-ruby/blob/main/examples/FaxSendExample.rb # @param fax_send_request [FaxSendRequest] # @param [Hash] opts the optional parameters # @return [FaxGetResponse] @@ -399,6 +408,7 @@ def fax_send(fax_send_request, opts = {}) # Send Fax # Creates and sends a new Fax with the submitted file(s) + # Example: https://github.com/hellosign/dropbox-sign-ruby/blob/main/examples/FaxSendExample.rb # @param fax_send_request [FaxSendRequest] # @param [Hash] opts the optional parameters # @return [Array<(FaxGetResponse, Integer, Hash)>] FaxGetResponse data, response status code and response headers diff --git a/sdks/ruby/lib/dropbox-sign/api/fax_line_api.rb b/sdks/ruby/lib/dropbox-sign/api/fax_line_api.rb index 3c8a86155..232aaa736 100644 --- a/sdks/ruby/lib/dropbox-sign/api/fax_line_api.rb +++ b/sdks/ruby/lib/dropbox-sign/api/fax_line_api.rb @@ -24,6 +24,7 @@ def initialize(api_client = ApiClient.default) end # Add Fax Line User # Grants a user access to the specified Fax Line. + # Example: https://github.com/hellosign/dropbox-sign-ruby/blob/main/examples/FaxLineAddUserExample.rb # @param fax_line_add_user_request [FaxLineAddUserRequest] # @param [Hash] opts the optional parameters # @return [FaxLineResponse] @@ -34,6 +35,7 @@ def fax_line_add_user(fax_line_add_user_request, opts = {}) # Add Fax Line User # Grants a user access to the specified Fax Line. + # Example: https://github.com/hellosign/dropbox-sign-ruby/blob/main/examples/FaxLineAddUserExample.rb # @param fax_line_add_user_request [FaxLineAddUserRequest] # @param [Hash] opts the optional parameters # @return [Array<(FaxLineResponse, Integer, Hash)>] FaxLineResponse data, response status code and response headers @@ -134,6 +136,7 @@ def fax_line_add_user_with_http_info(fax_line_add_user_request, opts = {}) # Get Available Fax Line Area Codes # Returns a list of available area codes for a given state/province and city + # Example: https://github.com/hellosign/dropbox-sign-ruby/blob/main/examples/FaxLineAreaCodeGetExample.rb # @param country [String] Filter area codes by country # @param [Hash] opts the optional parameters # @option opts [String] :state Filter area codes by state @@ -147,6 +150,7 @@ def fax_line_area_code_get(country, opts = {}) # Get Available Fax Line Area Codes # Returns a list of available area codes for a given state/province and city + # Example: https://github.com/hellosign/dropbox-sign-ruby/blob/main/examples/FaxLineAreaCodeGetExample.rb # @param country [String] Filter area codes by country # @param [Hash] opts the optional parameters # @option opts [String] :state Filter area codes by state @@ -252,6 +256,7 @@ def fax_line_area_code_get_with_http_info(country, opts = {}) # Purchase Fax Line # Purchases a new Fax Line + # Example: https://github.com/hellosign/dropbox-sign-ruby/blob/main/examples/FaxLineCreateExample.rb # @param fax_line_create_request [FaxLineCreateRequest] # @param [Hash] opts the optional parameters # @return [FaxLineResponse] @@ -262,6 +267,7 @@ def fax_line_create(fax_line_create_request, opts = {}) # Purchase Fax Line # Purchases a new Fax Line + # Example: https://github.com/hellosign/dropbox-sign-ruby/blob/main/examples/FaxLineCreateExample.rb # @param fax_line_create_request [FaxLineCreateRequest] # @param [Hash] opts the optional parameters # @return [Array<(FaxLineResponse, Integer, Hash)>] FaxLineResponse data, response status code and response headers @@ -362,6 +368,7 @@ def fax_line_create_with_http_info(fax_line_create_request, opts = {}) # Delete Fax Line # Deletes the specified Fax Line from the subscription. + # Example: https://github.com/hellosign/dropbox-sign-ruby/blob/main/examples/FaxLineDeleteExample.rb # @param fax_line_delete_request [FaxLineDeleteRequest] # @param [Hash] opts the optional parameters # @return [nil] @@ -372,6 +379,7 @@ def fax_line_delete(fax_line_delete_request, opts = {}) # Delete Fax Line # Deletes the specified Fax Line from the subscription. + # Example: https://github.com/hellosign/dropbox-sign-ruby/blob/main/examples/FaxLineDeleteExample.rb # @param fax_line_delete_request [FaxLineDeleteRequest] # @param [Hash] opts the optional parameters # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers @@ -445,6 +453,7 @@ def fax_line_delete_with_http_info(fax_line_delete_request, opts = {}) # Get Fax Line # Returns the properties and settings of a Fax Line. + # Example: https://github.com/hellosign/dropbox-sign-ruby/blob/main/examples/FaxLineGetExample.rb # @param number [String] The Fax Line number # @param [Hash] opts the optional parameters # @return [FaxLineResponse] @@ -455,6 +464,7 @@ def fax_line_get(number, opts = {}) # Get Fax Line # Returns the properties and settings of a Fax Line. + # Example: https://github.com/hellosign/dropbox-sign-ruby/blob/main/examples/FaxLineGetExample.rb # @param number [String] The Fax Line number # @param [Hash] opts the optional parameters # @return [Array<(FaxLineResponse, Integer, Hash)>] FaxLineResponse data, response status code and response headers @@ -541,6 +551,7 @@ def fax_line_get_with_http_info(number, opts = {}) # List Fax Lines # Returns the properties and settings of multiple Fax Lines. + # Example: https://github.com/hellosign/dropbox-sign-ruby/blob/main/examples/FaxLineListExample.rb # @param [Hash] opts the optional parameters # @option opts [String] :account_id Account ID # @option opts [Integer] :page Which page number of the Fax Line List to return. Defaults to `1`. (default to 1) @@ -554,6 +565,7 @@ def fax_line_list(opts = {}) # List Fax Lines # Returns the properties and settings of multiple Fax Lines. + # Example: https://github.com/hellosign/dropbox-sign-ruby/blob/main/examples/FaxLineListExample.rb # @param [Hash] opts the optional parameters # @option opts [String] :account_id Account ID # @option opts [Integer] :page Which page number of the Fax Line List to return. Defaults to `1`. (default to 1) @@ -642,6 +654,7 @@ def fax_line_list_with_http_info(opts = {}) # Remove Fax Line Access # Removes a user's access to the specified Fax Line + # Example: https://github.com/hellosign/dropbox-sign-ruby/blob/main/examples/FaxLineRemoveUserExample.rb # @param fax_line_remove_user_request [FaxLineRemoveUserRequest] # @param [Hash] opts the optional parameters # @return [FaxLineResponse] @@ -652,6 +665,7 @@ def fax_line_remove_user(fax_line_remove_user_request, opts = {}) # Remove Fax Line Access # Removes a user's access to the specified Fax Line + # Example: https://github.com/hellosign/dropbox-sign-ruby/blob/main/examples/FaxLineRemoveUserExample.rb # @param fax_line_remove_user_request [FaxLineRemoveUserRequest] # @param [Hash] opts the optional parameters # @return [Array<(FaxLineResponse, Integer, Hash)>] FaxLineResponse data, response status code and response headers diff --git a/sdks/ruby/lib/dropbox-sign/api/o_auth_api.rb b/sdks/ruby/lib/dropbox-sign/api/o_auth_api.rb index 24acc4fa4..6c37c6ce6 100644 --- a/sdks/ruby/lib/dropbox-sign/api/o_auth_api.rb +++ b/sdks/ruby/lib/dropbox-sign/api/o_auth_api.rb @@ -24,6 +24,7 @@ def initialize(api_client = ApiClient.default) end # OAuth Token Generate # Once you have retrieved the code from the user callback, you will need to exchange it for an access token via a backend call. + # Example: https://github.com/hellosign/dropbox-sign-ruby/blob/main/examples/OauthTokenGenerateExample.rb # @param o_auth_token_generate_request [OAuthTokenGenerateRequest] # @param [Hash] opts the optional parameters # @return [OAuthTokenResponse] @@ -34,6 +35,7 @@ def oauth_token_generate(o_auth_token_generate_request, opts = {}) # OAuth Token Generate # Once you have retrieved the code from the user callback, you will need to exchange it for an access token via a backend call. + # Example: https://github.com/hellosign/dropbox-sign-ruby/blob/main/examples/OauthTokenGenerateExample.rb # @param o_auth_token_generate_request [OAuthTokenGenerateRequest] # @param [Hash] opts the optional parameters # @return [Array<(OAuthTokenResponse, Integer, Hash)>] OAuthTokenResponse data, response status code and response headers @@ -134,6 +136,7 @@ def oauth_token_generate_with_http_info(o_auth_token_generate_request, opts = {} # OAuth Token Refresh # Access tokens are only valid for a given period of time (typically one hour) for security reasons. Whenever acquiring an new access token its TTL is also given (see `expires_in`), along with a refresh token that can be used to acquire a new access token after the current one has expired. + # Example: https://github.com/hellosign/dropbox-sign-ruby/blob/main/examples/OauthTokenRefreshExample.rb # @param o_auth_token_refresh_request [OAuthTokenRefreshRequest] # @param [Hash] opts the optional parameters # @return [OAuthTokenResponse] @@ -144,6 +147,7 @@ def oauth_token_refresh(o_auth_token_refresh_request, opts = {}) # OAuth Token Refresh # Access tokens are only valid for a given period of time (typically one hour) for security reasons. Whenever acquiring an new access token its TTL is also given (see `expires_in`), along with a refresh token that can be used to acquire a new access token after the current one has expired. + # Example: https://github.com/hellosign/dropbox-sign-ruby/blob/main/examples/OauthTokenRefreshExample.rb # @param o_auth_token_refresh_request [OAuthTokenRefreshRequest] # @param [Hash] opts the optional parameters # @return [Array<(OAuthTokenResponse, Integer, Hash)>] OAuthTokenResponse data, response status code and response headers diff --git a/sdks/ruby/lib/dropbox-sign/api/report_api.rb b/sdks/ruby/lib/dropbox-sign/api/report_api.rb index 9bbaf033d..a6e414821 100644 --- a/sdks/ruby/lib/dropbox-sign/api/report_api.rb +++ b/sdks/ruby/lib/dropbox-sign/api/report_api.rb @@ -24,6 +24,7 @@ def initialize(api_client = ApiClient.default) end # Create Report # Request the creation of one or more report(s). When the report(s) have been generated, you will receive an email (one per requested report type) containing a link to download the report as a CSV file. The requested date range may be up to 12 months in duration, and `start_date` must not be more than 10 years in the past. + # Example: https://github.com/hellosign/dropbox-sign-ruby/blob/main/examples/ReportCreateExample.rb # @param report_create_request [ReportCreateRequest] # @param [Hash] opts the optional parameters # @return [ReportCreateResponse] @@ -34,6 +35,7 @@ def report_create(report_create_request, opts = {}) # Create Report # Request the creation of one or more report(s). When the report(s) have been generated, you will receive an email (one per requested report type) containing a link to download the report as a CSV file. The requested date range may be up to 12 months in duration, and `start_date` must not be more than 10 years in the past. + # Example: https://github.com/hellosign/dropbox-sign-ruby/blob/main/examples/ReportCreateExample.rb # @param report_create_request [ReportCreateRequest] # @param [Hash] opts the optional parameters # @return [Array<(ReportCreateResponse, Integer, Hash)>] ReportCreateResponse data, response status code and response headers diff --git a/sdks/ruby/lib/dropbox-sign/api/signature_request_api.rb b/sdks/ruby/lib/dropbox-sign/api/signature_request_api.rb index cb68136fa..84294f5b2 100644 --- a/sdks/ruby/lib/dropbox-sign/api/signature_request_api.rb +++ b/sdks/ruby/lib/dropbox-sign/api/signature_request_api.rb @@ -24,6 +24,7 @@ def initialize(api_client = ApiClient.default) end # Embedded Bulk Send with Template # Creates BulkSendJob which sends up to 250 SignatureRequests in bulk based off of the provided Template(s) specified with the `template_ids` parameter to be signed in an embedded iFrame. These embedded signature requests can only be signed in embedded iFrames whereas normal signature requests can only be signed on Dropbox Sign. **NOTE:** Only available for Standard plan and higher. + # Example: https://github.com/hellosign/dropbox-sign-ruby/blob/main/examples/SignatureRequestBulkCreateEmbeddedWithTemplateExample.rb # @param signature_request_bulk_create_embedded_with_template_request [SignatureRequestBulkCreateEmbeddedWithTemplateRequest] # @param [Hash] opts the optional parameters # @return [BulkSendJobSendResponse] @@ -34,6 +35,7 @@ def signature_request_bulk_create_embedded_with_template(signature_request_bulk_ # Embedded Bulk Send with Template # Creates BulkSendJob which sends up to 250 SignatureRequests in bulk based off of the provided Template(s) specified with the `template_ids` parameter to be signed in an embedded iFrame. These embedded signature requests can only be signed in embedded iFrames whereas normal signature requests can only be signed on Dropbox Sign. **NOTE:** Only available for Standard plan and higher. + # Example: https://github.com/hellosign/dropbox-sign-ruby/blob/main/examples/SignatureRequestBulkCreateEmbeddedWithTemplateExample.rb # @param signature_request_bulk_create_embedded_with_template_request [SignatureRequestBulkCreateEmbeddedWithTemplateRequest] # @param [Hash] opts the optional parameters # @return [Array<(BulkSendJobSendResponse, Integer, Hash)>] BulkSendJobSendResponse data, response status code and response headers @@ -134,6 +136,7 @@ def signature_request_bulk_create_embedded_with_template_with_http_info(signatur # Bulk Send with Template # Creates BulkSendJob which sends up to 250 SignatureRequests in bulk based off of the provided Template(s) specified with the `template_ids` parameter. **NOTE:** Only available for Standard plan and higher. + # Example: https://github.com/hellosign/dropbox-sign-ruby/blob/main/examples/SignatureRequestBulkSendWithTemplateExample.rb # @param signature_request_bulk_send_with_template_request [SignatureRequestBulkSendWithTemplateRequest] # @param [Hash] opts the optional parameters # @return [BulkSendJobSendResponse] @@ -144,6 +147,7 @@ def signature_request_bulk_send_with_template(signature_request_bulk_send_with_t # Bulk Send with Template # Creates BulkSendJob which sends up to 250 SignatureRequests in bulk based off of the provided Template(s) specified with the `template_ids` parameter. **NOTE:** Only available for Standard plan and higher. + # Example: https://github.com/hellosign/dropbox-sign-ruby/blob/main/examples/SignatureRequestBulkSendWithTemplateExample.rb # @param signature_request_bulk_send_with_template_request [SignatureRequestBulkSendWithTemplateRequest] # @param [Hash] opts the optional parameters # @return [Array<(BulkSendJobSendResponse, Integer, Hash)>] BulkSendJobSendResponse data, response status code and response headers @@ -244,6 +248,7 @@ def signature_request_bulk_send_with_template_with_http_info(signature_request_b # Cancel Incomplete Signature Request # Cancels an incomplete signature request. This action is **not reversible**. The request will be canceled and signers will no longer be able to sign. If they try to access the signature request they will receive a HTTP 410 status code indicating that the resource has been deleted. Cancelation is asynchronous and a successful call to this endpoint will return an empty 200 OK response if the signature request is eligible to be canceled and has been successfully queued. This 200 OK response does not indicate a successful cancelation of the signature request itself. The cancelation is confirmed via the `signature_request_canceled` event. It is recommended that a [callback handler](/api/reference/tag/Callbacks-and-Events) be implemented to listen for the `signature_request_canceled` event. This callback will be sent only when the cancelation has completed successfully. If a callback handler has been configured and the event has not been received within 60 minutes of making the call, check the status of the request in the [API Dashboard](https://app.hellosign.com/apidashboard) and retry the cancelation if necessary. To be eligible for cancelation, a signature request must have been sent successfully, must not yet have been signed by all signers, and you must either be the sender or own the API app under which it was sent. A partially signed signature request can be canceled. **NOTE:** To remove your access to a completed signature request, use the endpoint: `POST /signature_request/remove/[:signature_request_id]`. + # Example: https://github.com/hellosign/dropbox-sign-ruby/blob/main/examples/SignatureRequestCancelExample.rb # @param signature_request_id [String] The id of the incomplete SignatureRequest to cancel. # @param [Hash] opts the optional parameters # @return [nil] @@ -254,6 +259,7 @@ def signature_request_cancel(signature_request_id, opts = {}) # Cancel Incomplete Signature Request # Cancels an incomplete signature request. This action is **not reversible**. The request will be canceled and signers will no longer be able to sign. If they try to access the signature request they will receive a HTTP 410 status code indicating that the resource has been deleted. Cancelation is asynchronous and a successful call to this endpoint will return an empty 200 OK response if the signature request is eligible to be canceled and has been successfully queued. This 200 OK response does not indicate a successful cancelation of the signature request itself. The cancelation is confirmed via the `signature_request_canceled` event. It is recommended that a [callback handler](/api/reference/tag/Callbacks-and-Events) be implemented to listen for the `signature_request_canceled` event. This callback will be sent only when the cancelation has completed successfully. If a callback handler has been configured and the event has not been received within 60 minutes of making the call, check the status of the request in the [API Dashboard](https://app.hellosign.com/apidashboard) and retry the cancelation if necessary. To be eligible for cancelation, a signature request must have been sent successfully, must not yet have been signed by all signers, and you must either be the sender or own the API app under which it was sent. A partially signed signature request can be canceled. **NOTE:** To remove your access to a completed signature request, use the endpoint: `POST /signature_request/remove/[:signature_request_id]`. + # Example: https://github.com/hellosign/dropbox-sign-ruby/blob/main/examples/SignatureRequestCancelExample.rb # @param signature_request_id [String] The id of the incomplete SignatureRequest to cancel. # @param [Hash] opts the optional parameters # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers @@ -312,6 +318,7 @@ def signature_request_cancel_with_http_info(signature_request_id, opts = {}) # Create Embedded Signature Request # Creates a new SignatureRequest with the submitted documents to be signed in an embedded iFrame. If form_fields_per_document is not specified, a signature page will be affixed where all signers will be required to add their signature, signifying their agreement to all contained documents. Note that embedded signature requests can only be signed in embedded iFrames whereas normal signature requests can only be signed on Dropbox Sign. + # Example: https://github.com/hellosign/dropbox-sign-ruby/blob/main/examples/SignatureRequestCreateEmbeddedExample.rb # @param signature_request_create_embedded_request [SignatureRequestCreateEmbeddedRequest] # @param [Hash] opts the optional parameters # @return [SignatureRequestGetResponse] @@ -322,6 +329,7 @@ def signature_request_create_embedded(signature_request_create_embedded_request, # Create Embedded Signature Request # Creates a new SignatureRequest with the submitted documents to be signed in an embedded iFrame. If form_fields_per_document is not specified, a signature page will be affixed where all signers will be required to add their signature, signifying their agreement to all contained documents. Note that embedded signature requests can only be signed in embedded iFrames whereas normal signature requests can only be signed on Dropbox Sign. + # Example: https://github.com/hellosign/dropbox-sign-ruby/blob/main/examples/SignatureRequestCreateEmbeddedExample.rb # @param signature_request_create_embedded_request [SignatureRequestCreateEmbeddedRequest] # @param [Hash] opts the optional parameters # @return [Array<(SignatureRequestGetResponse, Integer, Hash)>] SignatureRequestGetResponse data, response status code and response headers @@ -422,6 +430,7 @@ def signature_request_create_embedded_with_http_info(signature_request_create_em # Create Embedded Signature Request with Template # Creates a new SignatureRequest based on the given Template(s) to be signed in an embedded iFrame. Note that embedded signature requests can only be signed in embedded iFrames whereas normal signature requests can only be signed on Dropbox Sign. + # Example: https://github.com/hellosign/dropbox-sign-ruby/blob/main/examples/SignatureRequestCreateEmbeddedWithTemplateExample.rb # @param signature_request_create_embedded_with_template_request [SignatureRequestCreateEmbeddedWithTemplateRequest] # @param [Hash] opts the optional parameters # @return [SignatureRequestGetResponse] @@ -432,6 +441,7 @@ def signature_request_create_embedded_with_template(signature_request_create_emb # Create Embedded Signature Request with Template # Creates a new SignatureRequest based on the given Template(s) to be signed in an embedded iFrame. Note that embedded signature requests can only be signed in embedded iFrames whereas normal signature requests can only be signed on Dropbox Sign. + # Example: https://github.com/hellosign/dropbox-sign-ruby/blob/main/examples/SignatureRequestCreateEmbeddedWithTemplateExample.rb # @param signature_request_create_embedded_with_template_request [SignatureRequestCreateEmbeddedWithTemplateRequest] # @param [Hash] opts the optional parameters # @return [Array<(SignatureRequestGetResponse, Integer, Hash)>] SignatureRequestGetResponse data, response status code and response headers @@ -532,6 +542,7 @@ def signature_request_create_embedded_with_template_with_http_info(signature_req # Edit Signature Request # Edits and sends a SignatureRequest with the submitted documents. If `form_fields_per_document` is not specified, a signature page will be affixed where all signers will be required to add their signature, signifying their agreement to all contained documents. **NOTE:** Edit and resend *will* deduct your signature request quota. + # Example: https://github.com/hellosign/dropbox-sign-ruby/blob/main/examples/SignatureRequestEditExample.rb # @param signature_request_id [String] The id of the SignatureRequest to edit. # @param signature_request_edit_request [SignatureRequestEditRequest] # @param [Hash] opts the optional parameters @@ -543,6 +554,7 @@ def signature_request_edit(signature_request_id, signature_request_edit_request, # Edit Signature Request # Edits and sends a SignatureRequest with the submitted documents. If `form_fields_per_document` is not specified, a signature page will be affixed where all signers will be required to add their signature, signifying their agreement to all contained documents. **NOTE:** Edit and resend *will* deduct your signature request quota. + # Example: https://github.com/hellosign/dropbox-sign-ruby/blob/main/examples/SignatureRequestEditExample.rb # @param signature_request_id [String] The id of the SignatureRequest to edit. # @param signature_request_edit_request [SignatureRequestEditRequest] # @param [Hash] opts the optional parameters @@ -648,6 +660,7 @@ def signature_request_edit_with_http_info(signature_request_id, signature_reques # Edit Embedded Signature Request # Edits a SignatureRequest with the submitted documents to be signed in an embedded iFrame. If form_fields_per_document is not specified, a signature page will be affixed where all signers will be required to add their signature, signifying their agreement to all contained documents. Note that embedded signature requests can only be signed in embedded iFrames whereas normal signature requests can only be signed on Dropbox Sign. **NOTE:** Edit and resend *will* deduct your signature request quota. + # Example: https://github.com/hellosign/dropbox-sign-ruby/blob/main/examples/SignatureRequestEditEmbeddedExample.rb # @param signature_request_id [String] The id of the SignatureRequest to edit. # @param signature_request_edit_embedded_request [SignatureRequestEditEmbeddedRequest] # @param [Hash] opts the optional parameters @@ -659,6 +672,7 @@ def signature_request_edit_embedded(signature_request_id, signature_request_edit # Edit Embedded Signature Request # Edits a SignatureRequest with the submitted documents to be signed in an embedded iFrame. If form_fields_per_document is not specified, a signature page will be affixed where all signers will be required to add their signature, signifying their agreement to all contained documents. Note that embedded signature requests can only be signed in embedded iFrames whereas normal signature requests can only be signed on Dropbox Sign. **NOTE:** Edit and resend *will* deduct your signature request quota. + # Example: https://github.com/hellosign/dropbox-sign-ruby/blob/main/examples/SignatureRequestEditEmbeddedExample.rb # @param signature_request_id [String] The id of the SignatureRequest to edit. # @param signature_request_edit_embedded_request [SignatureRequestEditEmbeddedRequest] # @param [Hash] opts the optional parameters @@ -764,6 +778,7 @@ def signature_request_edit_embedded_with_http_info(signature_request_id, signatu # Edit Embedded Signature Request with Template # Edits a SignatureRequest based on the given Template(s) to be signed in an embedded iFrame. Note that embedded signature requests can only be signed in embedded iFrames whereas normal signature requests can only be signed on Dropbox Sign. **NOTE:** Edit and resend *will* deduct your signature request quota. + # Example: https://github.com/hellosign/dropbox-sign-ruby/blob/main/examples/SignatureRequestEditEmbeddedWithTemplateExample.rb # @param signature_request_id [String] The id of the SignatureRequest to edit. # @param signature_request_edit_embedded_with_template_request [SignatureRequestEditEmbeddedWithTemplateRequest] # @param [Hash] opts the optional parameters @@ -775,6 +790,7 @@ def signature_request_edit_embedded_with_template(signature_request_id, signatur # Edit Embedded Signature Request with Template # Edits a SignatureRequest based on the given Template(s) to be signed in an embedded iFrame. Note that embedded signature requests can only be signed in embedded iFrames whereas normal signature requests can only be signed on Dropbox Sign. **NOTE:** Edit and resend *will* deduct your signature request quota. + # Example: https://github.com/hellosign/dropbox-sign-ruby/blob/main/examples/SignatureRequestEditEmbeddedWithTemplateExample.rb # @param signature_request_id [String] The id of the SignatureRequest to edit. # @param signature_request_edit_embedded_with_template_request [SignatureRequestEditEmbeddedWithTemplateRequest] # @param [Hash] opts the optional parameters @@ -880,6 +896,7 @@ def signature_request_edit_embedded_with_template_with_http_info(signature_reque # Edit Signature Request With Template # Edits and sends a SignatureRequest based off of the Template(s) specified with the template_ids parameter. **NOTE:** Edit and resend *will* deduct your signature request quota. + # Example: https://github.com/hellosign/dropbox-sign-ruby/blob/main/examples/SignatureRequestEditWithTemplateExample.rb # @param signature_request_id [String] The id of the SignatureRequest to edit. # @param signature_request_edit_with_template_request [SignatureRequestEditWithTemplateRequest] # @param [Hash] opts the optional parameters @@ -891,6 +908,7 @@ def signature_request_edit_with_template(signature_request_id, signature_request # Edit Signature Request With Template # Edits and sends a SignatureRequest based off of the Template(s) specified with the template_ids parameter. **NOTE:** Edit and resend *will* deduct your signature request quota. + # Example: https://github.com/hellosign/dropbox-sign-ruby/blob/main/examples/SignatureRequestEditWithTemplateExample.rb # @param signature_request_id [String] The id of the SignatureRequest to edit. # @param signature_request_edit_with_template_request [SignatureRequestEditWithTemplateRequest] # @param [Hash] opts the optional parameters @@ -996,6 +1014,7 @@ def signature_request_edit_with_template_with_http_info(signature_request_id, si # Download Files # Obtain a copy of the current documents specified by the `signature_request_id` parameter. Returns a PDF or ZIP file. If the files are currently being prepared, a status code of `409` will be returned instead. + # Example: https://github.com/hellosign/dropbox-sign-ruby/blob/main/examples/SignatureRequestFilesExample.rb # @param signature_request_id [String] The id of the SignatureRequest to retrieve. # @param [Hash] opts the optional parameters # @option opts [String] :file_type Set to `pdf` for a single merged document or `zip` for a collection of individual documents. (default to 'pdf') @@ -1007,6 +1026,7 @@ def signature_request_files(signature_request_id, opts = {}) # Download Files # Obtain a copy of the current documents specified by the `signature_request_id` parameter. Returns a PDF or ZIP file. If the files are currently being prepared, a status code of `409` will be returned instead. + # Example: https://github.com/hellosign/dropbox-sign-ruby/blob/main/examples/SignatureRequestFilesExample.rb # @param signature_request_id [String] The id of the SignatureRequest to retrieve. # @param [Hash] opts the optional parameters # @option opts [String] :file_type Set to `pdf` for a single merged document or `zip` for a collection of individual documents. (default to 'pdf') @@ -1098,6 +1118,7 @@ def signature_request_files_with_http_info(signature_request_id, opts = {}) # Download Files as Data Uri # Obtain a copy of the current documents specified by the `signature_request_id` parameter. Returns a JSON object with a `data_uri` representing the base64 encoded file (PDFs only). If the files are currently being prepared, a status code of `409` will be returned instead. + # Example: https://github.com/hellosign/dropbox-sign-ruby/blob/main/examples/SignatureRequestFilesAsDataUriExample.rb # @param signature_request_id [String] The id of the SignatureRequest to retrieve. # @param [Hash] opts the optional parameters # @return [FileResponseDataUri] @@ -1108,6 +1129,7 @@ def signature_request_files_as_data_uri(signature_request_id, opts = {}) # Download Files as Data Uri # Obtain a copy of the current documents specified by the `signature_request_id` parameter. Returns a JSON object with a `data_uri` representing the base64 encoded file (PDFs only). If the files are currently being prepared, a status code of `409` will be returned instead. + # Example: https://github.com/hellosign/dropbox-sign-ruby/blob/main/examples/SignatureRequestFilesAsDataUriExample.rb # @param signature_request_id [String] The id of the SignatureRequest to retrieve. # @param [Hash] opts the optional parameters # @return [Array<(FileResponseDataUri, Integer, Hash)>] FileResponseDataUri data, response status code and response headers @@ -1193,6 +1215,7 @@ def signature_request_files_as_data_uri_with_http_info(signature_request_id, opt # Download Files as File Url # Obtain a copy of the current documents specified by the `signature_request_id` parameter. Returns a JSON object with a url to the file (PDFs only). If the files are currently being prepared, a status code of `409` will be returned instead. + # Example: https://github.com/hellosign/dropbox-sign-ruby/blob/main/examples/SignatureRequestFilesAsFileUrlExample.rb # @param signature_request_id [String] The id of the SignatureRequest to retrieve. # @param [Hash] opts the optional parameters # @option opts [Integer] :force_download By default when opening the `file_url` a browser will download the PDF and save it locally. When set to `0` the PDF file will be displayed in the browser. (default to 1) @@ -1204,6 +1227,7 @@ def signature_request_files_as_file_url(signature_request_id, opts = {}) # Download Files as File Url # Obtain a copy of the current documents specified by the `signature_request_id` parameter. Returns a JSON object with a url to the file (PDFs only). If the files are currently being prepared, a status code of `409` will be returned instead. + # Example: https://github.com/hellosign/dropbox-sign-ruby/blob/main/examples/SignatureRequestFilesAsFileUrlExample.rb # @param signature_request_id [String] The id of the SignatureRequest to retrieve. # @param [Hash] opts the optional parameters # @option opts [Integer] :force_download By default when opening the `file_url` a browser will download the PDF and save it locally. When set to `0` the PDF file will be displayed in the browser. (default to 1) @@ -1291,6 +1315,7 @@ def signature_request_files_as_file_url_with_http_info(signature_request_id, opt # Get Signature Request # Returns the status of the SignatureRequest specified by the `signature_request_id` parameter. + # Example: https://github.com/hellosign/dropbox-sign-ruby/blob/main/examples/SignatureRequestGetExample.rb # @param signature_request_id [String] The id of the SignatureRequest to retrieve. # @param [Hash] opts the optional parameters # @return [SignatureRequestGetResponse] @@ -1301,6 +1326,7 @@ def signature_request_get(signature_request_id, opts = {}) # Get Signature Request # Returns the status of the SignatureRequest specified by the `signature_request_id` parameter. + # Example: https://github.com/hellosign/dropbox-sign-ruby/blob/main/examples/SignatureRequestGetExample.rb # @param signature_request_id [String] The id of the SignatureRequest to retrieve. # @param [Hash] opts the optional parameters # @return [Array<(SignatureRequestGetResponse, Integer, Hash)>] SignatureRequestGetResponse data, response status code and response headers @@ -1386,6 +1412,7 @@ def signature_request_get_with_http_info(signature_request_id, opts = {}) # List Signature Requests # Returns a list of SignatureRequests that you can access. This includes SignatureRequests you have sent as well as received, but not ones that you have been CCed on. Take a look at our [search guide](/api/reference/search/) to learn more about querying signature requests. + # Example: https://github.com/hellosign/dropbox-sign-ruby/blob/main/examples/SignatureRequestListExample.rb # @param [Hash] opts the optional parameters # @option opts [String] :account_id Which account to return SignatureRequests for. Must be a team member. Use `all` to indicate all team members. Defaults to your account. # @option opts [Integer] :page Which page number of the SignatureRequest List to return. Defaults to `1`. (default to 1) @@ -1399,6 +1426,7 @@ def signature_request_list(opts = {}) # List Signature Requests # Returns a list of SignatureRequests that you can access. This includes SignatureRequests you have sent as well as received, but not ones that you have been CCed on. Take a look at our [search guide](/api/reference/search/) to learn more about querying signature requests. + # Example: https://github.com/hellosign/dropbox-sign-ruby/blob/main/examples/SignatureRequestListExample.rb # @param [Hash] opts the optional parameters # @option opts [String] :account_id Which account to return SignatureRequests for. Must be a team member. Use `all` to indicate all team members. Defaults to your account. # @option opts [Integer] :page Which page number of the SignatureRequest List to return. Defaults to `1`. (default to 1) @@ -1487,6 +1515,7 @@ def signature_request_list_with_http_info(opts = {}) # Release On-Hold Signature Request # Releases a held SignatureRequest that was claimed and prepared from an [UnclaimedDraft](/api/reference/tag/Unclaimed-Draft). The owner of the Draft must indicate at Draft creation that the SignatureRequest created from the Draft should be held. Releasing the SignatureRequest will send requests to all signers. + # Example: https://github.com/hellosign/dropbox-sign-ruby/blob/main/examples/SignatureRequestReleaseHoldExample.rb # @param signature_request_id [String] The id of the SignatureRequest to release. # @param [Hash] opts the optional parameters # @return [SignatureRequestGetResponse] @@ -1497,6 +1526,7 @@ def signature_request_release_hold(signature_request_id, opts = {}) # Release On-Hold Signature Request # Releases a held SignatureRequest that was claimed and prepared from an [UnclaimedDraft](/api/reference/tag/Unclaimed-Draft). The owner of the Draft must indicate at Draft creation that the SignatureRequest created from the Draft should be held. Releasing the SignatureRequest will send requests to all signers. + # Example: https://github.com/hellosign/dropbox-sign-ruby/blob/main/examples/SignatureRequestReleaseHoldExample.rb # @param signature_request_id [String] The id of the SignatureRequest to release. # @param [Hash] opts the optional parameters # @return [Array<(SignatureRequestGetResponse, Integer, Hash)>] SignatureRequestGetResponse data, response status code and response headers @@ -1582,6 +1612,7 @@ def signature_request_release_hold_with_http_info(signature_request_id, opts = { # Send Request Reminder # Sends an email to the signer reminding them to sign the signature request. You cannot send a reminder within 1 hour of the last reminder that was sent. This includes manual AND automatic reminders. **NOTE:** This action can **not** be used with embedded signature requests. + # Example: https://github.com/hellosign/dropbox-sign-ruby/blob/main/examples/SignatureRequestRemindExample.rb # @param signature_request_id [String] The id of the SignatureRequest to send a reminder for. # @param signature_request_remind_request [SignatureRequestRemindRequest] # @param [Hash] opts the optional parameters @@ -1593,6 +1624,7 @@ def signature_request_remind(signature_request_id, signature_request_remind_requ # Send Request Reminder # Sends an email to the signer reminding them to sign the signature request. You cannot send a reminder within 1 hour of the last reminder that was sent. This includes manual AND automatic reminders. **NOTE:** This action can **not** be used with embedded signature requests. + # Example: https://github.com/hellosign/dropbox-sign-ruby/blob/main/examples/SignatureRequestRemindExample.rb # @param signature_request_id [String] The id of the SignatureRequest to send a reminder for. # @param signature_request_remind_request [SignatureRequestRemindRequest] # @param [Hash] opts the optional parameters @@ -1698,6 +1730,7 @@ def signature_request_remind_with_http_info(signature_request_id, signature_requ # Remove Signature Request Access # Removes your access to a completed signature request. This action is **not reversible**. The signature request must be fully executed by all parties (signed or declined to sign). Other parties will continue to maintain access to the completed signature request document(s). Unlike /signature_request/cancel, this endpoint is synchronous and your access will be immediately removed. Upon successful removal, this endpoint will return a 200 OK response. + # Example: https://github.com/hellosign/dropbox-sign-ruby/blob/main/examples/SignatureRequestRemoveExample.rb # @param signature_request_id [String] The id of the SignatureRequest to remove. # @param [Hash] opts the optional parameters # @return [nil] @@ -1708,6 +1741,7 @@ def signature_request_remove(signature_request_id, opts = {}) # Remove Signature Request Access # Removes your access to a completed signature request. This action is **not reversible**. The signature request must be fully executed by all parties (signed or declined to sign). Other parties will continue to maintain access to the completed signature request document(s). Unlike /signature_request/cancel, this endpoint is synchronous and your access will be immediately removed. Upon successful removal, this endpoint will return a 200 OK response. + # Example: https://github.com/hellosign/dropbox-sign-ruby/blob/main/examples/SignatureRequestRemoveExample.rb # @param signature_request_id [String] The id of the SignatureRequest to remove. # @param [Hash] opts the optional parameters # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers @@ -1766,6 +1800,7 @@ def signature_request_remove_with_http_info(signature_request_id, opts = {}) # Send Signature Request # Creates and sends a new SignatureRequest with the submitted documents. If `form_fields_per_document` is not specified, a signature page will be affixed where all signers will be required to add their signature, signifying their agreement to all contained documents. + # Example: https://github.com/hellosign/dropbox-sign-ruby/blob/main/examples/SignatureRequestSendExample.rb # @param signature_request_send_request [SignatureRequestSendRequest] # @param [Hash] opts the optional parameters # @return [SignatureRequestGetResponse] @@ -1776,6 +1811,7 @@ def signature_request_send(signature_request_send_request, opts = {}) # Send Signature Request # Creates and sends a new SignatureRequest with the submitted documents. If `form_fields_per_document` is not specified, a signature page will be affixed where all signers will be required to add their signature, signifying their agreement to all contained documents. + # Example: https://github.com/hellosign/dropbox-sign-ruby/blob/main/examples/SignatureRequestSendExample.rb # @param signature_request_send_request [SignatureRequestSendRequest] # @param [Hash] opts the optional parameters # @return [Array<(SignatureRequestGetResponse, Integer, Hash)>] SignatureRequestGetResponse data, response status code and response headers @@ -1876,6 +1912,7 @@ def signature_request_send_with_http_info(signature_request_send_request, opts = # Send with Template # Creates and sends a new SignatureRequest based off of the Template(s) specified with the `template_ids` parameter. + # Example: https://github.com/hellosign/dropbox-sign-ruby/blob/main/examples/SignatureRequestSendWithTemplateExample.rb # @param signature_request_send_with_template_request [SignatureRequestSendWithTemplateRequest] # @param [Hash] opts the optional parameters # @return [SignatureRequestGetResponse] @@ -1886,6 +1923,7 @@ def signature_request_send_with_template(signature_request_send_with_template_re # Send with Template # Creates and sends a new SignatureRequest based off of the Template(s) specified with the `template_ids` parameter. + # Example: https://github.com/hellosign/dropbox-sign-ruby/blob/main/examples/SignatureRequestSendWithTemplateExample.rb # @param signature_request_send_with_template_request [SignatureRequestSendWithTemplateRequest] # @param [Hash] opts the optional parameters # @return [Array<(SignatureRequestGetResponse, Integer, Hash)>] SignatureRequestGetResponse data, response status code and response headers @@ -1986,6 +2024,7 @@ def signature_request_send_with_template_with_http_info(signature_request_send_w # Update Signature Request # Updates the email address and/or the name for a given signer on a signature request. You can listen for the `signature_request_email_bounce` event on your app or account to detect bounced emails, and respond with this method. Updating the email address of a signer will generate a new `signature_id` value. **NOTE:** This action cannot be performed on a signature request with an appended signature page. + # Example: https://github.com/hellosign/dropbox-sign-ruby/blob/main/examples/SignatureRequestUpdateExample.rb # @param signature_request_id [String] The id of the SignatureRequest to update. # @param signature_request_update_request [SignatureRequestUpdateRequest] # @param [Hash] opts the optional parameters @@ -1997,6 +2036,7 @@ def signature_request_update(signature_request_id, signature_request_update_requ # Update Signature Request # Updates the email address and/or the name for a given signer on a signature request. You can listen for the `signature_request_email_bounce` event on your app or account to detect bounced emails, and respond with this method. Updating the email address of a signer will generate a new `signature_id` value. **NOTE:** This action cannot be performed on a signature request with an appended signature page. + # Example: https://github.com/hellosign/dropbox-sign-ruby/blob/main/examples/SignatureRequestUpdateExample.rb # @param signature_request_id [String] The id of the SignatureRequest to update. # @param signature_request_update_request [SignatureRequestUpdateRequest] # @param [Hash] opts the optional parameters diff --git a/sdks/ruby/lib/dropbox-sign/api/team_api.rb b/sdks/ruby/lib/dropbox-sign/api/team_api.rb index 4fbe8cb85..bafc56226 100644 --- a/sdks/ruby/lib/dropbox-sign/api/team_api.rb +++ b/sdks/ruby/lib/dropbox-sign/api/team_api.rb @@ -24,6 +24,7 @@ def initialize(api_client = ApiClient.default) end # Add User to Team # Invites a user (specified using the `email_address` parameter) to your Team. If the user does not currently have a Dropbox Sign Account, a new one will be created for them. If a user is already a part of another Team, a `team_invite_failed` error will be returned. + # Example: https://github.com/hellosign/dropbox-sign-ruby/blob/main/examples/TeamAddMemberExample.rb # @param team_add_member_request [TeamAddMemberRequest] # @param [Hash] opts the optional parameters # @option opts [String] :team_id The id of the team. @@ -35,6 +36,7 @@ def team_add_member(team_add_member_request, opts = {}) # Add User to Team # Invites a user (specified using the `email_address` parameter) to your Team. If the user does not currently have a Dropbox Sign Account, a new one will be created for them. If a user is already a part of another Team, a `team_invite_failed` error will be returned. + # Example: https://github.com/hellosign/dropbox-sign-ruby/blob/main/examples/TeamAddMemberExample.rb # @param team_add_member_request [TeamAddMemberRequest] # @param [Hash] opts the optional parameters # @option opts [String] :team_id The id of the team. @@ -137,6 +139,7 @@ def team_add_member_with_http_info(team_add_member_request, opts = {}) # Create Team # Creates a new Team and makes you a member. You must not currently belong to a Team to invoke. + # Example: https://github.com/hellosign/dropbox-sign-ruby/blob/main/examples/TeamCreateExample.rb # @param team_create_request [TeamCreateRequest] # @param [Hash] opts the optional parameters # @return [TeamGetResponse] @@ -147,6 +150,7 @@ def team_create(team_create_request, opts = {}) # Create Team # Creates a new Team and makes you a member. You must not currently belong to a Team to invoke. + # Example: https://github.com/hellosign/dropbox-sign-ruby/blob/main/examples/TeamCreateExample.rb # @param team_create_request [TeamCreateRequest] # @param [Hash] opts the optional parameters # @return [Array<(TeamGetResponse, Integer, Hash)>] TeamGetResponse data, response status code and response headers @@ -247,6 +251,7 @@ def team_create_with_http_info(team_create_request, opts = {}) # Delete Team # Deletes your Team. Can only be invoked when you have a Team with only one member (yourself). + # Example: https://github.com/hellosign/dropbox-sign-ruby/blob/main/examples/TeamDeleteExample.rb # @param [Hash] opts the optional parameters # @return [nil] def team_delete(opts = {}) @@ -256,6 +261,7 @@ def team_delete(opts = {}) # Delete Team # Deletes your Team. Can only be invoked when you have a Team with only one member (yourself). + # Example: https://github.com/hellosign/dropbox-sign-ruby/blob/main/examples/TeamDeleteExample.rb # @param [Hash] opts the optional parameters # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers def team_delete_with_http_info(opts = {}) @@ -309,6 +315,7 @@ def team_delete_with_http_info(opts = {}) # Get Team # Returns information about your Team as well as a list of its members. If you do not belong to a Team, a 404 error with an error_name of \"not_found\" will be returned. + # Example: https://github.com/hellosign/dropbox-sign-ruby/blob/main/examples/TeamGetExample.rb # @param [Hash] opts the optional parameters # @return [TeamGetResponse] def team_get(opts = {}) @@ -318,6 +325,7 @@ def team_get(opts = {}) # Get Team # Returns information about your Team as well as a list of its members. If you do not belong to a Team, a 404 error with an error_name of \"not_found\" will be returned. + # Example: https://github.com/hellosign/dropbox-sign-ruby/blob/main/examples/TeamGetExample.rb # @param [Hash] opts the optional parameters # @return [Array<(TeamGetResponse, Integer, Hash)>] TeamGetResponse data, response status code and response headers def team_get_with_http_info(opts = {}) @@ -398,6 +406,7 @@ def team_get_with_http_info(opts = {}) # Get Team Info # Provides information about a team. + # Example: https://github.com/hellosign/dropbox-sign-ruby/blob/main/examples/TeamInfoExample.rb # @param [Hash] opts the optional parameters # @option opts [String] :team_id The id of the team. # @return [TeamGetInfoResponse] @@ -408,6 +417,7 @@ def team_info(opts = {}) # Get Team Info # Provides information about a team. + # Example: https://github.com/hellosign/dropbox-sign-ruby/blob/main/examples/TeamInfoExample.rb # @param [Hash] opts the optional parameters # @option opts [String] :team_id The id of the team. # @return [Array<(TeamGetInfoResponse, Integer, Hash)>] TeamGetInfoResponse data, response status code and response headers @@ -490,6 +500,7 @@ def team_info_with_http_info(opts = {}) # List Team Invites # Provides a list of team invites (and their roles). + # Example: https://github.com/hellosign/dropbox-sign-ruby/blob/main/examples/TeamInvitesExample.rb # @param [Hash] opts the optional parameters # @option opts [String] :email_address The email address for which to display the team invites. # @return [TeamInvitesResponse] @@ -500,6 +511,7 @@ def team_invites(opts = {}) # List Team Invites # Provides a list of team invites (and their roles). + # Example: https://github.com/hellosign/dropbox-sign-ruby/blob/main/examples/TeamInvitesExample.rb # @param [Hash] opts the optional parameters # @option opts [String] :email_address The email address for which to display the team invites. # @return [Array<(TeamInvitesResponse, Integer, Hash)>] TeamInvitesResponse data, response status code and response headers @@ -582,6 +594,7 @@ def team_invites_with_http_info(opts = {}) # List Team Members # Provides a paginated list of members (and their roles) that belong to a given team. + # Example: https://github.com/hellosign/dropbox-sign-ruby/blob/main/examples/TeamMembersExample.rb # @param team_id [String] The id of the team that a member list is being requested from. # @param [Hash] opts the optional parameters # @option opts [Integer] :page Which page number of the team member list to return. Defaults to `1`. (default to 1) @@ -594,6 +607,7 @@ def team_members(team_id, opts = {}) # List Team Members # Provides a paginated list of members (and their roles) that belong to a given team. + # Example: https://github.com/hellosign/dropbox-sign-ruby/blob/main/examples/TeamMembersExample.rb # @param team_id [String] The id of the team that a member list is being requested from. # @param [Hash] opts the optional parameters # @option opts [Integer] :page Which page number of the team member list to return. Defaults to `1`. (default to 1) @@ -691,6 +705,7 @@ def team_members_with_http_info(team_id, opts = {}) # Remove User from Team # Removes the provided user Account from your Team. If the Account had an outstanding invitation to your Team, the invitation will be expired. If you choose to transfer documents from the removed Account to an Account provided in the `new_owner_email_address` parameter (available only for Enterprise plans), the response status code will be 201, which indicates that your request has been queued but not fully executed. + # Example: https://github.com/hellosign/dropbox-sign-ruby/blob/main/examples/TeamRemoveMemberExample.rb # @param team_remove_member_request [TeamRemoveMemberRequest] # @param [Hash] opts the optional parameters # @return [TeamGetResponse] @@ -701,6 +716,7 @@ def team_remove_member(team_remove_member_request, opts = {}) # Remove User from Team # Removes the provided user Account from your Team. If the Account had an outstanding invitation to your Team, the invitation will be expired. If you choose to transfer documents from the removed Account to an Account provided in the `new_owner_email_address` parameter (available only for Enterprise plans), the response status code will be 201, which indicates that your request has been queued but not fully executed. + # Example: https://github.com/hellosign/dropbox-sign-ruby/blob/main/examples/TeamRemoveMemberExample.rb # @param team_remove_member_request [TeamRemoveMemberRequest] # @param [Hash] opts the optional parameters # @return [Array<(TeamGetResponse, Integer, Hash)>] TeamGetResponse data, response status code and response headers @@ -801,6 +817,7 @@ def team_remove_member_with_http_info(team_remove_member_request, opts = {}) # List Sub Teams # Provides a paginated list of sub teams that belong to a given team. + # Example: https://github.com/hellosign/dropbox-sign-ruby/blob/main/examples/TeamSubTeamsExample.rb # @param team_id [String] The id of the parent Team. # @param [Hash] opts the optional parameters # @option opts [Integer] :page Which page number of the SubTeam List to return. Defaults to `1`. (default to 1) @@ -813,6 +830,7 @@ def team_sub_teams(team_id, opts = {}) # List Sub Teams # Provides a paginated list of sub teams that belong to a given team. + # Example: https://github.com/hellosign/dropbox-sign-ruby/blob/main/examples/TeamSubTeamsExample.rb # @param team_id [String] The id of the parent Team. # @param [Hash] opts the optional parameters # @option opts [Integer] :page Which page number of the SubTeam List to return. Defaults to `1`. (default to 1) @@ -910,6 +928,7 @@ def team_sub_teams_with_http_info(team_id, opts = {}) # Update Team # Updates the name of your Team. + # Example: https://github.com/hellosign/dropbox-sign-ruby/blob/main/examples/TeamUpdateExample.rb # @param team_update_request [TeamUpdateRequest] # @param [Hash] opts the optional parameters # @return [TeamGetResponse] @@ -920,6 +939,7 @@ def team_update(team_update_request, opts = {}) # Update Team # Updates the name of your Team. + # Example: https://github.com/hellosign/dropbox-sign-ruby/blob/main/examples/TeamUpdateExample.rb # @param team_update_request [TeamUpdateRequest] # @param [Hash] opts the optional parameters # @return [Array<(TeamGetResponse, Integer, Hash)>] TeamGetResponse data, response status code and response headers diff --git a/sdks/ruby/lib/dropbox-sign/api/template_api.rb b/sdks/ruby/lib/dropbox-sign/api/template_api.rb index a649223c1..e88070145 100644 --- a/sdks/ruby/lib/dropbox-sign/api/template_api.rb +++ b/sdks/ruby/lib/dropbox-sign/api/template_api.rb @@ -24,6 +24,7 @@ def initialize(api_client = ApiClient.default) end # Add User to Template # Gives the specified Account access to the specified Template. The specified Account must be a part of your Team. + # Example: https://github.com/hellosign/dropbox-sign-ruby/blob/main/examples/TemplateAddUserExample.rb # @param template_id [String] The id of the Template to give the Account access to. # @param template_add_user_request [TemplateAddUserRequest] # @param [Hash] opts the optional parameters @@ -35,6 +36,7 @@ def template_add_user(template_id, template_add_user_request, opts = {}) # Add User to Template # Gives the specified Account access to the specified Template. The specified Account must be a part of your Team. + # Example: https://github.com/hellosign/dropbox-sign-ruby/blob/main/examples/TemplateAddUserExample.rb # @param template_id [String] The id of the Template to give the Account access to. # @param template_add_user_request [TemplateAddUserRequest] # @param [Hash] opts the optional parameters @@ -140,6 +142,7 @@ def template_add_user_with_http_info(template_id, template_add_user_request, opt # Create Template # Creates a template that can be used in future signature requests. If `client_id` is provided, the template will be created as an embedded template. Embedded templates can be used for embedded signature requests and can be edited later by generating a new `edit_url` with [/embedded/edit_url/{template_id}](/api/reference/operation/embeddedEditUrl/). Template creation may complete asynchronously after the initial request is accepted. It is recommended that a callback be implemented to listen for the callback event. A `template_created` event indicates the template is ready to use, while a `template_error` event indicates there was a problem while creating the template. If a callback handler has been configured and the event has not been received within 60 minutes of making the call, check the status of the request in the API dashboard and retry the request if necessary. + # Example: https://github.com/hellosign/dropbox-sign-ruby/blob/main/examples/TemplateCreateExample.rb # @param template_create_request [TemplateCreateRequest] # @param [Hash] opts the optional parameters # @return [TemplateCreateResponse] @@ -150,6 +153,7 @@ def template_create(template_create_request, opts = {}) # Create Template # Creates a template that can be used in future signature requests. If `client_id` is provided, the template will be created as an embedded template. Embedded templates can be used for embedded signature requests and can be edited later by generating a new `edit_url` with [/embedded/edit_url/{template_id}](/api/reference/operation/embeddedEditUrl/). Template creation may complete asynchronously after the initial request is accepted. It is recommended that a callback be implemented to listen for the callback event. A `template_created` event indicates the template is ready to use, while a `template_error` event indicates there was a problem while creating the template. If a callback handler has been configured and the event has not been received within 60 minutes of making the call, check the status of the request in the API dashboard and retry the request if necessary. + # Example: https://github.com/hellosign/dropbox-sign-ruby/blob/main/examples/TemplateCreateExample.rb # @param template_create_request [TemplateCreateRequest] # @param [Hash] opts the optional parameters # @return [Array<(TemplateCreateResponse, Integer, Hash)>] TemplateCreateResponse data, response status code and response headers @@ -250,6 +254,7 @@ def template_create_with_http_info(template_create_request, opts = {}) # Create Embedded Template Draft # The first step in an embedded template workflow. Creates a draft template that can then be further set up in the template 'edit' stage. + # Example: https://github.com/hellosign/dropbox-sign-ruby/blob/main/examples/TemplateCreateEmbeddedDraftExample.rb # @param template_create_embedded_draft_request [TemplateCreateEmbeddedDraftRequest] # @param [Hash] opts the optional parameters # @return [TemplateCreateEmbeddedDraftResponse] @@ -260,6 +265,7 @@ def template_create_embedded_draft(template_create_embedded_draft_request, opts # Create Embedded Template Draft # The first step in an embedded template workflow. Creates a draft template that can then be further set up in the template 'edit' stage. + # Example: https://github.com/hellosign/dropbox-sign-ruby/blob/main/examples/TemplateCreateEmbeddedDraftExample.rb # @param template_create_embedded_draft_request [TemplateCreateEmbeddedDraftRequest] # @param [Hash] opts the optional parameters # @return [Array<(TemplateCreateEmbeddedDraftResponse, Integer, Hash)>] TemplateCreateEmbeddedDraftResponse data, response status code and response headers @@ -360,6 +366,7 @@ def template_create_embedded_draft_with_http_info(template_create_embedded_draft # Delete Template # Completely deletes the template specified from the account. + # Example: https://github.com/hellosign/dropbox-sign-ruby/blob/main/examples/TemplateDeleteExample.rb # @param template_id [String] The id of the Template to delete. # @param [Hash] opts the optional parameters # @return [nil] @@ -370,6 +377,7 @@ def template_delete(template_id, opts = {}) # Delete Template # Completely deletes the template specified from the account. + # Example: https://github.com/hellosign/dropbox-sign-ruby/blob/main/examples/TemplateDeleteExample.rb # @param template_id [String] The id of the Template to delete. # @param [Hash] opts the optional parameters # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers @@ -428,6 +436,7 @@ def template_delete_with_http_info(template_id, opts = {}) # Get Template Files # Obtain a copy of the current documents specified by the `template_id` parameter. Returns a PDF or ZIP file. If the files are currently being prepared, a status code of `409` will be returned instead. In this case please wait for the `template_created` callback event. + # Example: https://github.com/hellosign/dropbox-sign-ruby/blob/main/examples/TemplateFilesExample.rb # @param template_id [String] The id of the template files to retrieve. # @param [Hash] opts the optional parameters # @option opts [String] :file_type Set to `pdf` for a single merged document or `zip` for a collection of individual documents. @@ -439,6 +448,7 @@ def template_files(template_id, opts = {}) # Get Template Files # Obtain a copy of the current documents specified by the `template_id` parameter. Returns a PDF or ZIP file. If the files are currently being prepared, a status code of `409` will be returned instead. In this case please wait for the `template_created` callback event. + # Example: https://github.com/hellosign/dropbox-sign-ruby/blob/main/examples/TemplateFilesExample.rb # @param template_id [String] The id of the template files to retrieve. # @param [Hash] opts the optional parameters # @option opts [String] :file_type Set to `pdf` for a single merged document or `zip` for a collection of individual documents. @@ -530,6 +540,7 @@ def template_files_with_http_info(template_id, opts = {}) # Get Template Files as Data Uri # Obtain a copy of the current documents specified by the `template_id` parameter. Returns a JSON object with a `data_uri` representing the base64 encoded file (PDFs only). If the files are currently being prepared, a status code of `409` will be returned instead. In this case please wait for the `template_created` callback event. + # Example: https://github.com/hellosign/dropbox-sign-ruby/blob/main/examples/TemplateFilesAsDataUriExample.rb # @param template_id [String] The id of the template files to retrieve. # @param [Hash] opts the optional parameters # @return [FileResponseDataUri] @@ -540,6 +551,7 @@ def template_files_as_data_uri(template_id, opts = {}) # Get Template Files as Data Uri # Obtain a copy of the current documents specified by the `template_id` parameter. Returns a JSON object with a `data_uri` representing the base64 encoded file (PDFs only). If the files are currently being prepared, a status code of `409` will be returned instead. In this case please wait for the `template_created` callback event. + # Example: https://github.com/hellosign/dropbox-sign-ruby/blob/main/examples/TemplateFilesAsDataUriExample.rb # @param template_id [String] The id of the template files to retrieve. # @param [Hash] opts the optional parameters # @return [Array<(FileResponseDataUri, Integer, Hash)>] FileResponseDataUri data, response status code and response headers @@ -625,6 +637,7 @@ def template_files_as_data_uri_with_http_info(template_id, opts = {}) # Get Template Files as File Url # Obtain a copy of the current documents specified by the `template_id` parameter. Returns a JSON object with a url to the file (PDFs only). If the files are currently being prepared, a status code of `409` will be returned instead. In this case please wait for the `template_created` callback event. + # Example: https://github.com/hellosign/dropbox-sign-ruby/blob/main/examples/TemplateFilesAsFileUrlExample.rb # @param template_id [String] The id of the template files to retrieve. # @param [Hash] opts the optional parameters # @option opts [Integer] :force_download By default when opening the `file_url` a browser will download the PDF and save it locally. When set to `0` the PDF file will be displayed in the browser. (default to 1) @@ -636,6 +649,7 @@ def template_files_as_file_url(template_id, opts = {}) # Get Template Files as File Url # Obtain a copy of the current documents specified by the `template_id` parameter. Returns a JSON object with a url to the file (PDFs only). If the files are currently being prepared, a status code of `409` will be returned instead. In this case please wait for the `template_created` callback event. + # Example: https://github.com/hellosign/dropbox-sign-ruby/blob/main/examples/TemplateFilesAsFileUrlExample.rb # @param template_id [String] The id of the template files to retrieve. # @param [Hash] opts the optional parameters # @option opts [Integer] :force_download By default when opening the `file_url` a browser will download the PDF and save it locally. When set to `0` the PDF file will be displayed in the browser. (default to 1) @@ -723,6 +737,7 @@ def template_files_as_file_url_with_http_info(template_id, opts = {}) # Get Template # Returns the Template specified by the `template_id` parameter. + # Example: https://github.com/hellosign/dropbox-sign-ruby/blob/main/examples/TemplateGetExample.rb # @param template_id [String] The id of the Template to retrieve. # @param [Hash] opts the optional parameters # @return [TemplateGetResponse] @@ -733,6 +748,7 @@ def template_get(template_id, opts = {}) # Get Template # Returns the Template specified by the `template_id` parameter. + # Example: https://github.com/hellosign/dropbox-sign-ruby/blob/main/examples/TemplateGetExample.rb # @param template_id [String] The id of the Template to retrieve. # @param [Hash] opts the optional parameters # @return [Array<(TemplateGetResponse, Integer, Hash)>] TemplateGetResponse data, response status code and response headers @@ -818,6 +834,7 @@ def template_get_with_http_info(template_id, opts = {}) # List Templates # Returns a list of the Templates that are accessible by you. Take a look at our [search guide](/api/reference/search/) to learn more about querying templates. + # Example: https://github.com/hellosign/dropbox-sign-ruby/blob/main/examples/TemplateListExample.rb # @param [Hash] opts the optional parameters # @option opts [String] :account_id Which account to return Templates for. Must be a team member. Use `all` to indicate all team members. Defaults to your account. # @option opts [Integer] :page Which page number of the Template List to return. Defaults to `1`. (default to 1) @@ -831,6 +848,7 @@ def template_list(opts = {}) # List Templates # Returns a list of the Templates that are accessible by you. Take a look at our [search guide](/api/reference/search/) to learn more about querying templates. + # Example: https://github.com/hellosign/dropbox-sign-ruby/blob/main/examples/TemplateListExample.rb # @param [Hash] opts the optional parameters # @option opts [String] :account_id Which account to return Templates for. Must be a team member. Use `all` to indicate all team members. Defaults to your account. # @option opts [Integer] :page Which page number of the Template List to return. Defaults to `1`. (default to 1) @@ -927,6 +945,7 @@ def template_list_with_http_info(opts = {}) # Remove User from Template # Removes the specified Account's access to the specified Template. + # Example: https://github.com/hellosign/dropbox-sign-ruby/blob/main/examples/TemplateRemoveUserExample.rb # @param template_id [String] The id of the Template to remove the Account's access to. # @param template_remove_user_request [TemplateRemoveUserRequest] # @param [Hash] opts the optional parameters @@ -938,6 +957,7 @@ def template_remove_user(template_id, template_remove_user_request, opts = {}) # Remove User from Template # Removes the specified Account's access to the specified Template. + # Example: https://github.com/hellosign/dropbox-sign-ruby/blob/main/examples/TemplateRemoveUserExample.rb # @param template_id [String] The id of the Template to remove the Account's access to. # @param template_remove_user_request [TemplateRemoveUserRequest] # @param [Hash] opts the optional parameters @@ -1043,6 +1063,7 @@ def template_remove_user_with_http_info(template_id, template_remove_user_reques # Update Template Files # Overlays a new file with the overlay of an existing template. The new file(s) must: 1. have the same or higher page count 2. the same orientation as the file(s) being replaced. This will not overwrite or in any way affect the existing template. Both the existing template and new template will be available for use after executing this endpoint. Also note that this will decrement your template quota. Overlaying new files is asynchronous and a successful call to this endpoint will return 200 OK response if the request passes initial validation checks. It is recommended that a callback be implemented to listen for the callback event. A `template_created` event will be sent when the files are updated or a `template_error` event will be sent if there was a problem while updating the files. If a callback handler has been configured and the event has not been received within 60 minutes of making the call, check the status of the request in the API dashboard and retry the request if necessary. If the page orientation or page count is different from the original template document, we will notify you with a `template_error` [callback event](https://app.hellosign.com/api/eventsAndCallbacksWalkthrough). + # Example: https://github.com/hellosign/dropbox-sign-ruby/blob/main/examples/TemplateUpdateFilesExample.rb # @param template_id [String] The ID of the template whose files to update. # @param template_update_files_request [TemplateUpdateFilesRequest] # @param [Hash] opts the optional parameters @@ -1054,6 +1075,7 @@ def template_update_files(template_id, template_update_files_request, opts = {}) # Update Template Files # Overlays a new file with the overlay of an existing template. The new file(s) must: 1. have the same or higher page count 2. the same orientation as the file(s) being replaced. This will not overwrite or in any way affect the existing template. Both the existing template and new template will be available for use after executing this endpoint. Also note that this will decrement your template quota. Overlaying new files is asynchronous and a successful call to this endpoint will return 200 OK response if the request passes initial validation checks. It is recommended that a callback be implemented to listen for the callback event. A `template_created` event will be sent when the files are updated or a `template_error` event will be sent if there was a problem while updating the files. If a callback handler has been configured and the event has not been received within 60 minutes of making the call, check the status of the request in the API dashboard and retry the request if necessary. If the page orientation or page count is different from the original template document, we will notify you with a `template_error` [callback event](https://app.hellosign.com/api/eventsAndCallbacksWalkthrough). + # Example: https://github.com/hellosign/dropbox-sign-ruby/blob/main/examples/TemplateUpdateFilesExample.rb # @param template_id [String] The ID of the template whose files to update. # @param template_update_files_request [TemplateUpdateFilesRequest] # @param [Hash] opts the optional parameters diff --git a/sdks/ruby/lib/dropbox-sign/api/unclaimed_draft_api.rb b/sdks/ruby/lib/dropbox-sign/api/unclaimed_draft_api.rb index bf6e1587c..27f4e10ab 100644 --- a/sdks/ruby/lib/dropbox-sign/api/unclaimed_draft_api.rb +++ b/sdks/ruby/lib/dropbox-sign/api/unclaimed_draft_api.rb @@ -24,6 +24,7 @@ def initialize(api_client = ApiClient.default) end # Create Unclaimed Draft # Creates a new Draft that can be claimed using the claim URL. The first authenticated user to access the URL will claim the Draft and will be shown either the \"Sign and send\" or the \"Request signature\" page with the Draft loaded. Subsequent access to the claim URL will result in a 404. + # Example: https://github.com/hellosign/dropbox-sign-ruby/blob/main/examples/UnclaimedDraftCreateExample.rb # @param unclaimed_draft_create_request [UnclaimedDraftCreateRequest] # @param [Hash] opts the optional parameters # @return [UnclaimedDraftCreateResponse] @@ -34,6 +35,7 @@ def unclaimed_draft_create(unclaimed_draft_create_request, opts = {}) # Create Unclaimed Draft # Creates a new Draft that can be claimed using the claim URL. The first authenticated user to access the URL will claim the Draft and will be shown either the \"Sign and send\" or the \"Request signature\" page with the Draft loaded. Subsequent access to the claim URL will result in a 404. + # Example: https://github.com/hellosign/dropbox-sign-ruby/blob/main/examples/UnclaimedDraftCreateExample.rb # @param unclaimed_draft_create_request [UnclaimedDraftCreateRequest] # @param [Hash] opts the optional parameters # @return [Array<(UnclaimedDraftCreateResponse, Integer, Hash)>] UnclaimedDraftCreateResponse data, response status code and response headers @@ -134,6 +136,7 @@ def unclaimed_draft_create_with_http_info(unclaimed_draft_create_request, opts = # Create Embedded Unclaimed Draft # Creates a new Draft that can be claimed and used in an embedded iFrame. The first authenticated user to access the URL will claim the Draft and will be shown the \"Request signature\" page with the Draft loaded. Subsequent access to the claim URL will result in a `404`. For this embedded endpoint the `requester_email_address` parameter is required. **NOTE:** Embedded unclaimed drafts can only be accessed in embedded iFrames whereas normal drafts can be used and accessed on Dropbox Sign. + # Example: https://github.com/hellosign/dropbox-sign-ruby/blob/main/examples/UnclaimedDraftCreateEmbeddedExample.rb # @param unclaimed_draft_create_embedded_request [UnclaimedDraftCreateEmbeddedRequest] # @param [Hash] opts the optional parameters # @return [UnclaimedDraftCreateResponse] @@ -144,6 +147,7 @@ def unclaimed_draft_create_embedded(unclaimed_draft_create_embedded_request, opt # Create Embedded Unclaimed Draft # Creates a new Draft that can be claimed and used in an embedded iFrame. The first authenticated user to access the URL will claim the Draft and will be shown the \"Request signature\" page with the Draft loaded. Subsequent access to the claim URL will result in a `404`. For this embedded endpoint the `requester_email_address` parameter is required. **NOTE:** Embedded unclaimed drafts can only be accessed in embedded iFrames whereas normal drafts can be used and accessed on Dropbox Sign. + # Example: https://github.com/hellosign/dropbox-sign-ruby/blob/main/examples/UnclaimedDraftCreateEmbeddedExample.rb # @param unclaimed_draft_create_embedded_request [UnclaimedDraftCreateEmbeddedRequest] # @param [Hash] opts the optional parameters # @return [Array<(UnclaimedDraftCreateResponse, Integer, Hash)>] UnclaimedDraftCreateResponse data, response status code and response headers @@ -244,6 +248,7 @@ def unclaimed_draft_create_embedded_with_http_info(unclaimed_draft_create_embedd # Create Embedded Unclaimed Draft with Template # Creates a new Draft with a previously saved template(s) that can be claimed and used in an embedded iFrame. The first authenticated user to access the URL will claim the Draft and will be shown the \"Request signature\" page with the Draft loaded. Subsequent access to the claim URL will result in a `404`. For this embedded endpoint the `requester_email_address` parameter is required. **NOTE:** Embedded unclaimed drafts can only be accessed in embedded iFrames whereas normal drafts can be used and accessed on Dropbox Sign. + # Example: https://github.com/hellosign/dropbox-sign-ruby/blob/main/examples/UnclaimedDraftCreateEmbeddedWithTemplateExample.rb # @param unclaimed_draft_create_embedded_with_template_request [UnclaimedDraftCreateEmbeddedWithTemplateRequest] # @param [Hash] opts the optional parameters # @return [UnclaimedDraftCreateResponse] @@ -254,6 +259,7 @@ def unclaimed_draft_create_embedded_with_template(unclaimed_draft_create_embedde # Create Embedded Unclaimed Draft with Template # Creates a new Draft with a previously saved template(s) that can be claimed and used in an embedded iFrame. The first authenticated user to access the URL will claim the Draft and will be shown the \"Request signature\" page with the Draft loaded. Subsequent access to the claim URL will result in a `404`. For this embedded endpoint the `requester_email_address` parameter is required. **NOTE:** Embedded unclaimed drafts can only be accessed in embedded iFrames whereas normal drafts can be used and accessed on Dropbox Sign. + # Example: https://github.com/hellosign/dropbox-sign-ruby/blob/main/examples/UnclaimedDraftCreateEmbeddedWithTemplateExample.rb # @param unclaimed_draft_create_embedded_with_template_request [UnclaimedDraftCreateEmbeddedWithTemplateRequest] # @param [Hash] opts the optional parameters # @return [Array<(UnclaimedDraftCreateResponse, Integer, Hash)>] UnclaimedDraftCreateResponse data, response status code and response headers @@ -354,6 +360,7 @@ def unclaimed_draft_create_embedded_with_template_with_http_info(unclaimed_draft # Edit and Resend Unclaimed Draft # Creates a new signature request from an embedded request that can be edited prior to being sent to the recipients. Parameter `test_mode` can be edited prior to request. Signers can be edited in embedded editor. Requester's email address will remain unchanged if `requester_email_address` parameter is not set. **NOTE:** Embedded unclaimed drafts can only be accessed in embedded iFrames whereas normal drafts can be used and accessed on Dropbox Sign. + # Example: https://github.com/hellosign/dropbox-sign-ruby/blob/main/examples/UnclaimedDraftEditAndResendExample.rb # @param signature_request_id [String] The ID of the signature request to edit and resend. # @param unclaimed_draft_edit_and_resend_request [UnclaimedDraftEditAndResendRequest] # @param [Hash] opts the optional parameters @@ -365,6 +372,7 @@ def unclaimed_draft_edit_and_resend(signature_request_id, unclaimed_draft_edit_a # Edit and Resend Unclaimed Draft # Creates a new signature request from an embedded request that can be edited prior to being sent to the recipients. Parameter `test_mode` can be edited prior to request. Signers can be edited in embedded editor. Requester's email address will remain unchanged if `requester_email_address` parameter is not set. **NOTE:** Embedded unclaimed drafts can only be accessed in embedded iFrames whereas normal drafts can be used and accessed on Dropbox Sign. + # Example: https://github.com/hellosign/dropbox-sign-ruby/blob/main/examples/UnclaimedDraftEditAndResendExample.rb # @param signature_request_id [String] The ID of the signature request to edit and resend. # @param unclaimed_draft_edit_and_resend_request [UnclaimedDraftEditAndResendRequest] # @param [Hash] opts the optional parameters diff --git a/sdks/ruby/templates/api.mustache b/sdks/ruby/templates/api.mustache index cade90e77..d61f0a900 100644 --- a/sdks/ruby/templates/api.mustache +++ b/sdks/ruby/templates/api.mustache @@ -24,6 +24,7 @@ module {{moduleName}} {{#notes}} # {{{.}}} {{/notes}} + # Example: https://github.com/hellosign/dropbox-sign-ruby/blob/main/examples/{{operationIdCamelCase}}Example.rb {{#vendorExtensions.x-group-parameters}} # @param [Hash] opts the parameters {{#allParams}} @@ -57,6 +58,7 @@ module {{moduleName}} {{#notes}} # {{.}} {{/notes}} + # Example: https://github.com/hellosign/dropbox-sign-ruby/blob/main/examples/{{operationIdCamelCase}}Example.rb {{#vendorExtensions.x-group-parameters}} # @param [Hash] opts the parameters {{#allParams}}