diff --git a/README.md b/README.md index 3a92deb..49bec34 100644 --- a/README.md +++ b/README.md @@ -23,7 +23,7 @@ directory that corresponds to the file you want updated. This C# SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project: - API version: 3.0.0 -- SDK version: 1.2.0 +- SDK version: 1.3.0 - Build package: org.openapitools.codegen.languages.CSharpNetCoreClientCodegen ### Building diff --git a/VERSION b/VERSION index 26aaba0..f0bb29e 100644 --- a/VERSION +++ b/VERSION @@ -1 +1 @@ -1.2.0 +1.3.0 diff --git a/docs/SignatureRequestApi.md b/docs/SignatureRequestApi.md index 30bc905..80c05e8 100644 --- a/docs/SignatureRequestApi.md +++ b/docs/SignatureRequestApi.md @@ -846,7 +846,7 @@ catch (ApiException e) # **SignatureRequestFilesAsFileUrl** -> FileResponse SignatureRequestFilesAsFileUrl (string signatureRequestId) +> FileResponse SignatureRequestFilesAsFileUrl (string signatureRequestId, int? forceDownload = null) Download Files as File Url @@ -898,7 +898,7 @@ This returns an ApiResponse object which contains the response data, status code try { // Download Files as File Url - ApiResponse response = apiInstance.SignatureRequestFilesAsFileUrlWithHttpInfo(signatureRequestId); + ApiResponse response = apiInstance.SignatureRequestFilesAsFileUrlWithHttpInfo(signatureRequestId, forceDownload); Debug.Write("Status Code: " + response.StatusCode); Debug.Write("Response Headers: " + response.Headers); Debug.Write("Response Body: " + response.Data); @@ -916,6 +916,7 @@ catch (ApiException e) | Name | Type | Description | Notes | |------|------|-------------|-------| | **signatureRequestId** | **string** | The id of the SignatureRequest to retrieve. | | +| **forceDownload** | **int?** | 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 type diff --git a/docs/TemplateApi.md b/docs/TemplateApi.md index bdd47bb..60384f6 100644 --- a/docs/TemplateApi.md +++ b/docs/TemplateApi.md @@ -684,7 +684,7 @@ catch (ApiException e) # **TemplateFilesAsFileUrl** -> FileResponse TemplateFilesAsFileUrl (string templateId) +> FileResponse TemplateFilesAsFileUrl (string templateId, int? forceDownload = null) Get Template Files as File Url @@ -736,7 +736,7 @@ This returns an ApiResponse object which contains the response data, status code try { // Get Template Files as File Url - ApiResponse response = apiInstance.TemplateFilesAsFileUrlWithHttpInfo(templateId); + ApiResponse response = apiInstance.TemplateFilesAsFileUrlWithHttpInfo(templateId, forceDownload); Debug.Write("Status Code: " + response.StatusCode); Debug.Write("Response Headers: " + response.Headers); Debug.Write("Response Body: " + response.Data); @@ -754,6 +754,7 @@ catch (ApiException e) | Name | Type | Description | Notes | |------|------|-------------|-------| | **templateId** | **string** | The id of the template files to retrieve. | | +| **forceDownload** | **int?** | 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 type diff --git a/docs/TemplateCreateResponse.md b/docs/TemplateCreateResponse.md index e85ea1d..cbd87a7 100644 --- a/docs/TemplateCreateResponse.md +++ b/docs/TemplateCreateResponse.md @@ -4,7 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**Template** | [**TemplateCreateResponse**](TemplateCreateResponse.md) | | [optional] +**Template** | [**TemplateCreateResponseTemplate**](TemplateCreateResponseTemplate.md) | | [optional] **Warnings** | [**List<WarningResponse>**](WarningResponse.md) | A list of warnings. | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/UnclaimedDraftCreateEmbeddedWithTemplateRequest.md b/docs/UnclaimedDraftCreateEmbeddedWithTemplateRequest.md index 5ca8f02..930494f 100644 --- a/docs/UnclaimedDraftCreateEmbeddedWithTemplateRequest.md +++ b/docs/UnclaimedDraftCreateEmbeddedWithTemplateRequest.md @@ -33,6 +33,7 @@ Name | Type | Description | Notes **TestMode** | **bool** | Whether this is a test, the signature request created from this draft will not be legally binding if set to `true`. Defaults to `false`. | [optional] [default to false] **Title** | **string** | The title you want to assign to the SignatureRequest. | [optional] **PopulateAutoFillFields** | **bool** | Controls whether [auto fill fields](https://faq.hellosign.com/hc/en-us/articles/360051467511-Auto-Fill-Fields) can automatically populate a signer's information during signing.

⚠️ **Note** ⚠️: Keep your signer's information safe by ensuring that the _signer on your signature request is the intended party_ before using this feature. | [optional] [default to false] +**AllowCcs** | **bool** | This allows the requester to specify whether the user is allowed to provide email addresses to CC when claiming the draft. | [optional] [default to false] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/openapi-config.yaml b/openapi-config.yaml index 3d2bacd..12c8e82 100644 --- a/openapi-config.yaml +++ b/openapi-config.yaml @@ -5,7 +5,7 @@ additionalProperties: packageAuthors: Dropbox Sign API Team packageCompany: Dropbox Sign API Team packageDescription: Client library for using the Dropbox Sign API - packageVersion: 1.2.0 + packageVersion: 1.3.0 packageTitle: Dropbox Sign .Net SDK sortModelPropertiesByRequiredFlag: true optionalEmitDefaultValues: true diff --git a/openapi-sdk.yaml b/openapi-sdk.yaml index 44642ca..6ef2e00 100644 --- a/openapi-sdk.yaml +++ b/openapi-sdk.yaml @@ -2483,6 +2483,13 @@ paths: schema: type: string example: fa5c8a0b0f492d768749333ad6fcc214c111e967 + - + name: force_download + in: query + description: '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.' + schema: + type: integer + default: 1 responses: 200: description: 'successful operation' @@ -5214,6 +5221,13 @@ paths: schema: type: string example: f57db65d3f933b5316d398057a36176831451a35 + - + name: force_download + in: query + description: '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.' + schema: + type: integer + default: 1 responses: 200: description: 'successful operation' @@ -9074,6 +9088,10 @@ components: ⚠️ **Note** ⚠️: Keep your signer's information safe by ensuring that the _signer on your signature request is the intended party_ before using this feature. type: boolean default: false + allow_ccs: + description: 'This allows the requester to specify whether the user is allowed to provide email addresses to CC when claiming the draft.' + type: boolean + default: false type: object UnclaimedDraftEditAndResendRequest: required: @@ -9242,20 +9260,6 @@ components: error: $ref: '#/components/schemas/ErrorResponseError' type: object - EventCallbackRequest: - title: EventCallbackRequest - required: - - event - properties: - event: - $ref: '#/components/schemas/EventCallbackRequestEvent' - account: - $ref: '#/components/schemas/AccountResponse' - signature_request: - $ref: '#/components/schemas/SignatureRequestResponse' - template: - $ref: '#/components/schemas/TemplateResponse' - type: object FileResponse: properties: file_url: @@ -9572,69 +9576,6 @@ components: description: 'Name of the error.' type: string type: object - EventCallbackRequestEvent: - description: 'Basic information about the event that occurred.' - required: - - event_time - - event_type - - event_hash - - event_metadata - properties: - event_time: - description: 'Time the event was created (using Unix time).' - type: string - event_type: - description: 'Type of callback event that was triggered.' - type: string - enum: - - account_confirmed - - unknown_error - - file_error - - sign_url_invalid - - signature_request_viewed - - signature_request_signed - - signature_request_sent - - signature_request_all_signed - - signature_request_email_bounce - - signature_request_remind - - signature_request_incomplete_qes - - signature_request_destroyed - - signature_request_canceled - - signature_request_downloadable - - signature_request_declined - - signature_request_reassigned - - signature_request_invalid - - signature_request_prepared - - signature_request_expired - - template_created - - template_error - - callback_test - event_hash: - description: 'Generated hash used to verify source of event data.' - type: string - event_metadata: - $ref: '#/components/schemas/EventCallbackRequestEventMetadata' - type: object - EventCallbackRequestEventMetadata: - description: 'Specific metadata about the event.' - properties: - related_signature_id: - description: 'Signature ID for a specific signer. Applicable to `signature_request_signed` and `signature_request_viewed` events.' - type: string - nullable: true - reported_for_account_id: - description: 'Account ID the event was reported for.' - type: string - nullable: true - reported_for_app_id: - description: 'App ID the event was reported for.' - type: string - nullable: true - event_message: - description: 'Message about a declined or failed (due to error) signature flow.' - type: string - nullable: true - type: object ListInfoResponse: description: 'Contains pagination information about the data returned.' properties: @@ -11178,7 +11119,7 @@ components: TemplateCreateResponse: properties: template: - $ref: '#/components/schemas/TemplateCreateResponse' + $ref: '#/components/schemas/TemplateCreateResponseTemplate' warnings: description: 'A list of warnings.' type: array @@ -11247,6 +11188,83 @@ components: $ref: '#/components/schemas/WarningResponse' type: object x-internal: true + EventCallbackRequest: + title: EventCallbackRequest + required: + - event + properties: + event: + $ref: '#/components/schemas/EventCallbackRequestEvent' + account: + $ref: '#/components/schemas/AccountResponse' + signature_request: + $ref: '#/components/schemas/SignatureRequestResponse' + template: + $ref: '#/components/schemas/TemplateResponse' + type: object + EventCallbackRequestEvent: + description: 'Basic information about the event that occurred.' + required: + - event_time + - event_type + - event_hash + - event_metadata + properties: + event_time: + description: 'Time the event was created (using Unix time).' + type: string + event_type: + description: 'Type of callback event that was triggered.' + type: string + enum: + - account_confirmed + - unknown_error + - file_error + - sign_url_invalid + - signature_request_viewed + - signature_request_signed + - signature_request_sent + - signature_request_all_signed + - signature_request_email_bounce + - signature_request_remind + - signature_request_incomplete_qes + - signature_request_destroyed + - signature_request_canceled + - signature_request_downloadable + - signature_request_declined + - signature_request_reassigned + - signature_request_invalid + - signature_request_prepared + - signature_request_expired + - template_created + - template_error + - callback_test + event_hash: + description: 'Generated hash used to verify source of event data.' + type: string + event_metadata: + $ref: '#/components/schemas/EventCallbackRequestEventMetadata' + type: object + EventCallbackRequestEventMetadata: + description: 'Specific metadata about the event.' + properties: + related_signature_id: + description: 'Signature ID for a specific signer. Applicable to `signature_request_signed` and `signature_request_viewed` events.' + type: string + nullable: true + reported_for_account_id: + description: 'Account ID the event was reported for.' + type: string + nullable: true + reported_for_app_id: + description: 'App ID the event was reported for.' + type: string + nullable: true + event_message: + description: 'Message about a declined or failed (due to error) signature flow.' + type: string + nullable: true + type: object responses: EventCallbackResponse: description: 'successful operation' @@ -11560,26 +11578,6 @@ components: summary: 'API App Update' value: $ref: examples/json/ApiAppUpdateResponseExample.json - EventCallbackAccountSignatureRequestSentExample: - summary: 'Example: signature_request_sent' - value: - $ref: examples/json/EventCallbackAccountSignatureRequestSentExample.json - EventCallbackAccountTemplateCreatedExample: - summary: 'Example: template_created' - value: - $ref: examples/json/EventCallbackAccountTemplateCreatedExample.json - EventCallbackAppAccountConfirmedExample: - summary: 'Example: account_confirmed' - value: - $ref: examples/json/EventCallbackAppAccountConfirmedExample.json - EventCallbackAppSignatureRequestSentExample: - summary: 'Example: signature_request_sent' - value: - $ref: examples/json/EventCallbackAppSignatureRequestSentExample.json - EventCallbackAppTemplateCreatedExample: - summary: 'Example: template_created' - value: - $ref: examples/json/EventCallbackAppTemplateCreatedExample.json SignatureRequestCreateEmbeddedResponseExample: summary: 'Create Embedded Signature Request' value: @@ -11708,6 +11706,26 @@ components: summary: 'Unclaimed Draft Create' value: $ref: examples/json/UnclaimedDraftCreateResponseExample.json + EventCallbackAccountSignatureRequestSentExample: + summary: 'Example: signature_request_sent' + value: + $ref: examples/json/EventCallbackAccountSignatureRequestSentExample.json + EventCallbackAccountTemplateCreatedExample: + summary: 'Example: template_created' + value: + $ref: examples/json/EventCallbackAccountTemplateCreatedExample.json + EventCallbackAppAccountConfirmedExample: + summary: 'Example: account_confirmed' + value: + $ref: examples/json/EventCallbackAppAccountConfirmedExample.json + EventCallbackAppSignatureRequestSentExample: + summary: 'Example: signature_request_sent' + value: + $ref: examples/json/EventCallbackAppSignatureRequestSentExample.json + EventCallbackAppTemplateCreatedExample: + summary: 'Example: template_created' + value: + $ref: examples/json/EventCallbackAppTemplateCreatedExample.json requestBodies: EventCallbackAccountRequest: description: |- diff --git a/src/Dropbox.Sign/Api/SignatureRequestApi.cs b/src/Dropbox.Sign/Api/SignatureRequestApi.cs index 2a1dc84..eb79bee 100644 --- a/src/Dropbox.Sign/Api/SignatureRequestApi.cs +++ b/src/Dropbox.Sign/Api/SignatureRequestApi.cs @@ -198,9 +198,10 @@ public interface ISignatureRequestApiSync : IApiAccessor /// /// 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) /// Index associated with the operation. /// FileResponse - FileResponse SignatureRequestFilesAsFileUrl(string signatureRequestId, int operationIndex = 0); + FileResponse SignatureRequestFilesAsFileUrl(string signatureRequestId, int? forceDownload = default(int?), int operationIndex = 0); /// /// Download Files as File Url @@ -210,9 +211,10 @@ public interface ISignatureRequestApiSync : IApiAccessor /// /// 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) /// Index associated with the operation. /// ApiResponse of FileResponse - ApiResponse SignatureRequestFilesAsFileUrlWithHttpInfo(string signatureRequestId, int operationIndex = 0); + ApiResponse SignatureRequestFilesAsFileUrlWithHttpInfo(string signatureRequestId, int? forceDownload = default(int?), int operationIndex = 0); /// /// Get Signature Request /// @@ -601,10 +603,11 @@ public interface ISignatureRequestApiAsync : IApiAccessor /// /// 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) /// Index associated with the operation. /// Cancellation Token to cancel the request. /// Task of FileResponse - System.Threading.Tasks.Task SignatureRequestFilesAsFileUrlAsync(string signatureRequestId, int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)); + System.Threading.Tasks.Task SignatureRequestFilesAsFileUrlAsync(string signatureRequestId, int? forceDownload = default(int?), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)); /// /// Download Files as File Url @@ -614,10 +617,11 @@ public interface ISignatureRequestApiAsync : IApiAccessor /// /// 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) /// Index associated with the operation. /// Cancellation Token to cancel the request. /// Task of ApiResponse (FileResponse) - System.Threading.Tasks.Task> SignatureRequestFilesAsFileUrlWithHttpInfoAsync(string signatureRequestId, int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)); + System.Threading.Tasks.Task> SignatureRequestFilesAsFileUrlWithHttpInfoAsync(string signatureRequestId, int? forceDownload = default(int?), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)); /// /// Get Signature Request /// @@ -2184,11 +2188,12 @@ public Dropbox.Sign.Client.ApiResponse SignatureRequestFile /// /// 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) /// Index associated with the operation. /// FileResponse - public FileResponse SignatureRequestFilesAsFileUrl(string signatureRequestId, int operationIndex = 0) + public FileResponse SignatureRequestFilesAsFileUrl(string signatureRequestId, int? forceDownload = default(int?), int operationIndex = 0) { - Dropbox.Sign.Client.ApiResponse localVarResponse = SignatureRequestFilesAsFileUrlWithHttpInfo(signatureRequestId); + Dropbox.Sign.Client.ApiResponse localVarResponse = SignatureRequestFilesAsFileUrlWithHttpInfo(signatureRequestId, forceDownload); return localVarResponse.Data; } @@ -2197,9 +2202,10 @@ public FileResponse SignatureRequestFilesAsFileUrl(string signatureRequestId, in /// /// 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) /// Index associated with the operation. /// ApiResponse of FileResponse - public Dropbox.Sign.Client.ApiResponse SignatureRequestFilesAsFileUrlWithHttpInfo(string signatureRequestId, int operationIndex = 0) + public Dropbox.Sign.Client.ApiResponse SignatureRequestFilesAsFileUrlWithHttpInfo(string signatureRequestId, int? forceDownload = default(int?), int operationIndex = 0) { // verify the required parameter 'signatureRequestId' is set if (signatureRequestId == null) @@ -2230,6 +2236,10 @@ public Dropbox.Sign.Client.ApiResponse SignatureRequestFilesAsFile } localVarRequestOptions.PathParameters.Add("signature_request_id", Dropbox.Sign.Client.ClientUtils.ParameterToString(signatureRequestId)); // path parameter + if (forceDownload != null) + { + localVarRequestOptions.QueryParameters.Add(Dropbox.Sign.Client.ClientUtils.ParameterToMultiMap("", "force_download", forceDownload)); + } localVarRequestOptions.Operation = "SignatureRequestApi.SignatureRequestFilesAsFileUrl"; localVarRequestOptions.OperationIndex = operationIndex; @@ -2265,12 +2275,13 @@ public Dropbox.Sign.Client.ApiResponse SignatureRequestFilesAsFile /// /// 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) /// Index associated with the operation. /// Cancellation Token to cancel the request. /// Task of FileResponse - public async System.Threading.Tasks.Task SignatureRequestFilesAsFileUrlAsync(string signatureRequestId, int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) + public async System.Threading.Tasks.Task SignatureRequestFilesAsFileUrlAsync(string signatureRequestId, int? forceDownload = default(int?), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) { - Dropbox.Sign.Client.ApiResponse localVarResponse = await SignatureRequestFilesAsFileUrlWithHttpInfoAsync(signatureRequestId, operationIndex, cancellationToken).ConfigureAwait(false); + Dropbox.Sign.Client.ApiResponse localVarResponse = await SignatureRequestFilesAsFileUrlWithHttpInfoAsync(signatureRequestId, forceDownload, operationIndex, cancellationToken).ConfigureAwait(false); return localVarResponse.Data; } @@ -2279,10 +2290,11 @@ public Dropbox.Sign.Client.ApiResponse SignatureRequestFilesAsFile /// /// 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) /// Index associated with the operation. /// Cancellation Token to cancel the request. /// Task of ApiResponse (FileResponse) - public async System.Threading.Tasks.Task> SignatureRequestFilesAsFileUrlWithHttpInfoAsync(string signatureRequestId, int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) + public async System.Threading.Tasks.Task> SignatureRequestFilesAsFileUrlWithHttpInfoAsync(string signatureRequestId, int? forceDownload = default(int?), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) { // verify the required parameter 'signatureRequestId' is set if (signatureRequestId == null) @@ -2315,6 +2327,10 @@ public Dropbox.Sign.Client.ApiResponse SignatureRequestFilesAsFile } localVarRequestOptions.PathParameters.Add("signature_request_id", Dropbox.Sign.Client.ClientUtils.ParameterToString(signatureRequestId)); // path parameter + if (forceDownload != null) + { + localVarRequestOptions.QueryParameters.Add(Dropbox.Sign.Client.ClientUtils.ParameterToMultiMap("", "force_download", forceDownload)); + } localVarRequestOptions.Operation = "SignatureRequestApi.SignatureRequestFilesAsFileUrl"; localVarRequestOptions.OperationIndex = operationIndex; diff --git a/src/Dropbox.Sign/Api/TemplateApi.cs b/src/Dropbox.Sign/Api/TemplateApi.cs index ccb0774..103e311 100644 --- a/src/Dropbox.Sign/Api/TemplateApi.cs +++ b/src/Dropbox.Sign/Api/TemplateApi.cs @@ -177,9 +177,10 @@ public interface ITemplateApiSync : IApiAccessor /// /// 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) /// Index associated with the operation. /// FileResponse - FileResponse TemplateFilesAsFileUrl(string templateId, int operationIndex = 0); + FileResponse TemplateFilesAsFileUrl(string templateId, int? forceDownload = default(int?), int operationIndex = 0); /// /// Get Template Files as File Url @@ -189,9 +190,10 @@ public interface ITemplateApiSync : IApiAccessor /// /// 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) /// Index associated with the operation. /// ApiResponse of FileResponse - ApiResponse TemplateFilesAsFileUrlWithHttpInfo(string templateId, int operationIndex = 0); + ApiResponse TemplateFilesAsFileUrlWithHttpInfo(string templateId, int? forceDownload = default(int?), int operationIndex = 0); /// /// Get Template /// @@ -465,10 +467,11 @@ public interface ITemplateApiAsync : IApiAccessor /// /// 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) /// Index associated with the operation. /// Cancellation Token to cancel the request. /// Task of FileResponse - System.Threading.Tasks.Task TemplateFilesAsFileUrlAsync(string templateId, int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)); + System.Threading.Tasks.Task TemplateFilesAsFileUrlAsync(string templateId, int? forceDownload = default(int?), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)); /// /// Get Template Files as File Url @@ -478,10 +481,11 @@ public interface ITemplateApiAsync : IApiAccessor /// /// 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) /// Index associated with the operation. /// Cancellation Token to cancel the request. /// Task of ApiResponse (FileResponse) - System.Threading.Tasks.Task> TemplateFilesAsFileUrlWithHttpInfoAsync(string templateId, int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)); + System.Threading.Tasks.Task> TemplateFilesAsFileUrlWithHttpInfoAsync(string templateId, int? forceDownload = default(int?), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)); /// /// Get Template /// @@ -1796,11 +1800,12 @@ public Dropbox.Sign.Client.ApiResponse TemplateFilesAsDataU /// /// 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) /// Index associated with the operation. /// FileResponse - public FileResponse TemplateFilesAsFileUrl(string templateId, int operationIndex = 0) + public FileResponse TemplateFilesAsFileUrl(string templateId, int? forceDownload = default(int?), int operationIndex = 0) { - Dropbox.Sign.Client.ApiResponse localVarResponse = TemplateFilesAsFileUrlWithHttpInfo(templateId); + Dropbox.Sign.Client.ApiResponse localVarResponse = TemplateFilesAsFileUrlWithHttpInfo(templateId, forceDownload); return localVarResponse.Data; } @@ -1809,9 +1814,10 @@ public FileResponse TemplateFilesAsFileUrl(string templateId, int operationIndex /// /// 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) /// Index associated with the operation. /// ApiResponse of FileResponse - public Dropbox.Sign.Client.ApiResponse TemplateFilesAsFileUrlWithHttpInfo(string templateId, int operationIndex = 0) + public Dropbox.Sign.Client.ApiResponse TemplateFilesAsFileUrlWithHttpInfo(string templateId, int? forceDownload = default(int?), int operationIndex = 0) { // verify the required parameter 'templateId' is set if (templateId == null) @@ -1842,6 +1848,10 @@ public Dropbox.Sign.Client.ApiResponse TemplateFilesAsFileUrlWithH } localVarRequestOptions.PathParameters.Add("template_id", Dropbox.Sign.Client.ClientUtils.ParameterToString(templateId)); // path parameter + if (forceDownload != null) + { + localVarRequestOptions.QueryParameters.Add(Dropbox.Sign.Client.ClientUtils.ParameterToMultiMap("", "force_download", forceDownload)); + } localVarRequestOptions.Operation = "TemplateApi.TemplateFilesAsFileUrl"; localVarRequestOptions.OperationIndex = operationIndex; @@ -1877,12 +1887,13 @@ public Dropbox.Sign.Client.ApiResponse TemplateFilesAsFileUrlWithH /// /// 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) /// Index associated with the operation. /// Cancellation Token to cancel the request. /// Task of FileResponse - public async System.Threading.Tasks.Task TemplateFilesAsFileUrlAsync(string templateId, int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) + public async System.Threading.Tasks.Task TemplateFilesAsFileUrlAsync(string templateId, int? forceDownload = default(int?), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) { - Dropbox.Sign.Client.ApiResponse localVarResponse = await TemplateFilesAsFileUrlWithHttpInfoAsync(templateId, operationIndex, cancellationToken).ConfigureAwait(false); + Dropbox.Sign.Client.ApiResponse localVarResponse = await TemplateFilesAsFileUrlWithHttpInfoAsync(templateId, forceDownload, operationIndex, cancellationToken).ConfigureAwait(false); return localVarResponse.Data; } @@ -1891,10 +1902,11 @@ public Dropbox.Sign.Client.ApiResponse TemplateFilesAsFileUrlWithH /// /// 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) /// Index associated with the operation. /// Cancellation Token to cancel the request. /// Task of ApiResponse (FileResponse) - public async System.Threading.Tasks.Task> TemplateFilesAsFileUrlWithHttpInfoAsync(string templateId, int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) + public async System.Threading.Tasks.Task> TemplateFilesAsFileUrlWithHttpInfoAsync(string templateId, int? forceDownload = default(int?), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) { // verify the required parameter 'templateId' is set if (templateId == null) @@ -1927,6 +1939,10 @@ public Dropbox.Sign.Client.ApiResponse TemplateFilesAsFileUrlWithH } localVarRequestOptions.PathParameters.Add("template_id", Dropbox.Sign.Client.ClientUtils.ParameterToString(templateId)); // path parameter + if (forceDownload != null) + { + localVarRequestOptions.QueryParameters.Add(Dropbox.Sign.Client.ClientUtils.ParameterToMultiMap("", "force_download", forceDownload)); + } localVarRequestOptions.Operation = "TemplateApi.TemplateFilesAsFileUrl"; localVarRequestOptions.OperationIndex = operationIndex; diff --git a/src/Dropbox.Sign/Client/Configuration.cs b/src/Dropbox.Sign/Client/Configuration.cs index 612b3d7..3fd2864 100644 --- a/src/Dropbox.Sign/Client/Configuration.cs +++ b/src/Dropbox.Sign/Client/Configuration.cs @@ -36,7 +36,7 @@ public class Configuration : IReadableConfiguration /// Version of the package. /// /// Version of the package. - public const string Version = "1.2.0"; + public const string Version = "1.3.0"; /// /// Identifier for ISO 8601 DateTime Format @@ -118,7 +118,7 @@ public class Configuration : IReadableConfiguration public Configuration() { Proxy = null; - UserAgent = WebUtility.UrlEncode("OpenAPI-Generator/1.2.0/csharp"); + UserAgent = WebUtility.UrlEncode("OpenAPI-Generator/1.3.0/csharp"); BasePath = "https://api.hellosign.com/v3"; DefaultHeaders = new ConcurrentDictionary(); ApiKey = new ConcurrentDictionary(); @@ -550,7 +550,7 @@ public static string ToDebugReport() report += " OS: " + System.Environment.OSVersion + "\n"; report += " .NET Framework Version: " + System.Environment.Version + "\n"; report += " Version of the API: 3.0.0\n"; - report += " SDK Package Version: 1.2.0\n"; + report += " SDK Package Version: 1.3.0\n"; return report; } diff --git a/src/Dropbox.Sign/Dropbox.Sign.csproj b/src/Dropbox.Sign/Dropbox.Sign.csproj index bd13ab4..5332c75 100644 --- a/src/Dropbox.Sign/Dropbox.Sign.csproj +++ b/src/Dropbox.Sign/Dropbox.Sign.csproj @@ -11,7 +11,7 @@ Dropbox Sign .Net SDK Client library for using the Dropbox Sign API Dropbox.Sign - 1.2.0 + 1.3.0 bin\$(Configuration)\$(TargetFramework)\Dropbox.Sign.xml https://github.com/hellosign/dropbox-sign-dotnet.git git diff --git a/src/Dropbox.Sign/Model/TemplateCreateResponse.cs b/src/Dropbox.Sign/Model/TemplateCreateResponse.cs index 02675e8..a342dd9 100644 --- a/src/Dropbox.Sign/Model/TemplateCreateResponse.cs +++ b/src/Dropbox.Sign/Model/TemplateCreateResponse.cs @@ -43,7 +43,7 @@ protected TemplateCreateResponse() { } /// /// template. /// A list of warnings.. - public TemplateCreateResponse(TemplateCreateResponse template = default(TemplateCreateResponse), List warnings = default(List)) + public TemplateCreateResponse(TemplateCreateResponseTemplate template = default(TemplateCreateResponseTemplate), List warnings = default(List)) { this.Template = template; @@ -70,7 +70,7 @@ public static TemplateCreateResponse Init(string jsonData) /// Gets or Sets Template /// [DataMember(Name = "template", EmitDefaultValue = true)] - public TemplateCreateResponse Template { get; set; } + public TemplateCreateResponseTemplate Template { get; set; } /// /// A list of warnings. @@ -164,7 +164,7 @@ public List GetOpenApiTypes() types.Add(new OpenApiType(){ Name = "template", Property = "Template", - Type = "TemplateCreateResponse", + Type = "TemplateCreateResponseTemplate", Value = Template, }); types.Add(new OpenApiType(){ diff --git a/src/Dropbox.Sign/Model/UnclaimedDraftCreateEmbeddedWithTemplateRequest.cs b/src/Dropbox.Sign/Model/UnclaimedDraftCreateEmbeddedWithTemplateRequest.cs index 87431d9..07194f0 100644 --- a/src/Dropbox.Sign/Model/UnclaimedDraftCreateEmbeddedWithTemplateRequest.cs +++ b/src/Dropbox.Sign/Model/UnclaimedDraftCreateEmbeddedWithTemplateRequest.cs @@ -70,7 +70,8 @@ protected UnclaimedDraftCreateEmbeddedWithTemplateRequest() { } /// Whether this is a test, the signature request created from this draft will not be legally binding if set to `true`. Defaults to `false`. (default to false). /// The title you want to assign to the SignatureRequest.. /// Controls whether [auto fill fields](https://faq.hellosign.com/hc/en-us/articles/360051467511-Auto-Fill-Fields) can automatically populate a signer's information during signing. ⚠️ **Note** ⚠️: Keep your signer's information safe by ensuring that the _signer on your signature request is the intended party_ before using this feature. (default to false). - public UnclaimedDraftCreateEmbeddedWithTemplateRequest(bool allowDecline = false, bool allowReassign = false, List ccs = default(List), string clientId = default(string), List customFields = default(List), SubEditorOptions editorOptions = default(SubEditorOptions), SubFieldOptions fieldOptions = default(SubFieldOptions), List files = default(List), List fileUrls = default(List), bool forceSignerRoles = false, bool forceSubjectMessage = false, bool holdRequest = false, bool isForEmbeddedSigning = false, string message = default(string), Dictionary metadata = default(Dictionary), bool previewOnly = false, string requesterEmailAddress = default(string), string requestingRedirectUrl = default(string), bool showPreview = false, bool showProgressStepper = true, List signers = default(List), SubSigningOptions signingOptions = default(SubSigningOptions), string signingRedirectUrl = default(string), bool skipMeNow = false, string subject = default(string), List templateIds = default(List), bool testMode = false, string title = default(string), bool populateAutoFillFields = false) + /// This allows the requester to specify whether the user is allowed to provide email addresses to CC when claiming the draft. (default to false). + public UnclaimedDraftCreateEmbeddedWithTemplateRequest(bool allowDecline = false, bool allowReassign = false, List ccs = default(List), string clientId = default(string), List customFields = default(List), SubEditorOptions editorOptions = default(SubEditorOptions), SubFieldOptions fieldOptions = default(SubFieldOptions), List files = default(List), List fileUrls = default(List), bool forceSignerRoles = false, bool forceSubjectMessage = false, bool holdRequest = false, bool isForEmbeddedSigning = false, string message = default(string), Dictionary metadata = default(Dictionary), bool previewOnly = false, string requesterEmailAddress = default(string), string requestingRedirectUrl = default(string), bool showPreview = false, bool showProgressStepper = true, List signers = default(List), SubSigningOptions signingOptions = default(SubSigningOptions), string signingRedirectUrl = default(string), bool skipMeNow = false, string subject = default(string), List templateIds = default(List), bool testMode = false, string title = default(string), bool populateAutoFillFields = false, bool allowCcs = false) { // to ensure "clientId" is required (not null) @@ -117,6 +118,7 @@ protected UnclaimedDraftCreateEmbeddedWithTemplateRequest() { } this.TestMode = testMode; this.Title = title; this.PopulateAutoFillFields = populateAutoFillFields; + this.AllowCcs = allowCcs; } /// @@ -335,6 +337,13 @@ public static UnclaimedDraftCreateEmbeddedWithTemplateRequest Init(string jsonDa [DataMember(Name = "populate_auto_fill_fields", EmitDefaultValue = true)] public bool PopulateAutoFillFields { get; set; } + /// + /// This allows the requester to specify whether the user is allowed to provide email addresses to CC when claiming the draft. + /// + /// This allows the requester to specify whether the user is allowed to provide email addresses to CC when claiming the draft. + [DataMember(Name = "allow_ccs", EmitDefaultValue = true)] + public bool AllowCcs { get; set; } + /// /// Returns the string presentation of the object /// @@ -372,6 +381,7 @@ public override string ToString() sb.Append(" TestMode: ").Append(TestMode).Append("\n"); sb.Append(" Title: ").Append(Title).Append("\n"); sb.Append(" PopulateAutoFillFields: ").Append(PopulateAutoFillFields).Append("\n"); + sb.Append(" AllowCcs: ").Append(AllowCcs).Append("\n"); sb.Append("}\n"); return sb.ToString(); } @@ -546,6 +556,10 @@ public bool Equals(UnclaimedDraftCreateEmbeddedWithTemplateRequest input) ( this.PopulateAutoFillFields == input.PopulateAutoFillFields || this.PopulateAutoFillFields.Equals(input.PopulateAutoFillFields) + ) && + ( + this.AllowCcs == input.AllowCcs || + this.AllowCcs.Equals(input.AllowCcs) ); } @@ -638,6 +652,7 @@ public override int GetHashCode() hashCode = (hashCode * 59) + this.Title.GetHashCode(); } hashCode = (hashCode * 59) + this.PopulateAutoFillFields.GetHashCode(); + hashCode = (hashCode * 59) + this.AllowCcs.GetHashCode(); return hashCode; } } @@ -819,6 +834,12 @@ public List GetOpenApiTypes() Type = "bool", Value = PopulateAutoFillFields, }); + types.Add(new OpenApiType(){ + Name = "allow_ccs", + Property = "AllowCcs", + Type = "bool", + Value = AllowCcs, + }); return types; } diff --git a/test_fixtures/UnclaimedDraftCreateEmbeddedWithTemplateRequest.json b/test_fixtures/UnclaimedDraftCreateEmbeddedWithTemplateRequest.json index d59cf95..4a1aafb 100644 --- a/test_fixtures/UnclaimedDraftCreateEmbeddedWithTemplateRequest.json +++ b/test_fixtures/UnclaimedDraftCreateEmbeddedWithTemplateRequest.json @@ -62,6 +62,7 @@ "61a832ff0d8423f91d503e76bfbcc750f7417c78" ], "test_mode": false, - "title": "NDA with Acme Co." + "title": "NDA with Acme Co.", + "allow_ccs": true } }