Skip to content
New issue

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

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

Already on GitHub? Sign in to your account

Release 1.3.0 #9

Merged
merged 1 commit into from
Jan 29, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion VERSION
Original file line number Diff line number Diff line change
@@ -1 +1 @@
1.2.0
1.3.0
5 changes: 3 additions & 2 deletions docs/SignatureRequestApi.md
Original file line number Diff line number Diff line change
Expand Up @@ -846,7 +846,7 @@ catch (ApiException e)

<a name="signaturerequestfilesasfileurl"></a>
# **SignatureRequestFilesAsFileUrl**
> FileResponse SignatureRequestFilesAsFileUrl (string signatureRequestId)
> FileResponse SignatureRequestFilesAsFileUrl (string signatureRequestId, int? forceDownload = null)

Download Files as File Url

Expand Down Expand Up @@ -898,7 +898,7 @@ This returns an ApiResponse object which contains the response data, status code
try
{
// Download Files as File Url
ApiResponse<FileResponse> response = apiInstance.SignatureRequestFilesAsFileUrlWithHttpInfo(signatureRequestId);
ApiResponse<FileResponse> response = apiInstance.SignatureRequestFilesAsFileUrlWithHttpInfo(signatureRequestId, forceDownload);
Debug.Write("Status Code: " + response.StatusCode);
Debug.Write("Response Headers: " + response.Headers);
Debug.Write("Response Body: " + response.Data);
Expand All @@ -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

Expand Down
5 changes: 3 additions & 2 deletions docs/TemplateApi.md
Original file line number Diff line number Diff line change
Expand Up @@ -684,7 +684,7 @@ catch (ApiException e)

<a name="templatefilesasfileurl"></a>
# **TemplateFilesAsFileUrl**
> FileResponse TemplateFilesAsFileUrl (string templateId)
> FileResponse TemplateFilesAsFileUrl (string templateId, int? forceDownload = null)

Get Template Files as File Url

Expand Down Expand Up @@ -736,7 +736,7 @@ This returns an ApiResponse object which contains the response data, status code
try
{
// Get Template Files as File Url
ApiResponse<FileResponse> response = apiInstance.TemplateFilesAsFileUrlWithHttpInfo(templateId);
ApiResponse<FileResponse> response = apiInstance.TemplateFilesAsFileUrlWithHttpInfo(templateId, forceDownload);
Debug.Write("Status Code: " + response.StatusCode);
Debug.Write("Response Headers: " + response.Headers);
Debug.Write("Response Body: " + response.Data);
Expand All @@ -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

Expand Down
2 changes: 1 addition & 1 deletion docs/TemplateCreateResponse.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Template** | [**TemplateCreateResponse**](TemplateCreateResponse.md) | | [optional]
**Template** | [**TemplateCreateResponseTemplate**](TemplateCreateResponseTemplate.md) | | [optional]
**Warnings** | [**List&lt;WarningResponse&gt;**](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)
Expand Down
1 change: 1 addition & 0 deletions docs/UnclaimedDraftCreateEmbeddedWithTemplateRequest.md
Original file line number Diff line number Diff line change
Expand Up @@ -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&#39;s information during signing.<br><br>⚠️ **Note** ⚠️: Keep your signer&#39;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)

2 changes: 1 addition & 1 deletion openapi-config.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
214 changes: 116 additions & 98 deletions openapi-sdk.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -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'
Expand Down Expand Up @@ -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'
Expand Down Expand Up @@ -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:
Expand Down Expand Up @@ -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:
Expand Down Expand Up @@ -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:
Expand Down Expand Up @@ -11178,7 +11119,7 @@ components:
TemplateCreateResponse:
properties:
template:
$ref: '#/components/schemas/TemplateCreateResponse'
$ref: '#/components/schemas/TemplateCreateResponseTemplate'
warnings:
description: 'A list of warnings.'
type: array
Expand Down Expand Up @@ -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'
Expand Down Expand Up @@ -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:
Expand Down Expand Up @@ -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: |-
Expand Down
Loading
Loading