diff --git a/openapi-raw.yaml b/openapi-raw.yaml index e0d57e123..daa800714 100644 --- a/openapi-raw.yaml +++ b/openapi-raw.yaml @@ -9806,26 +9806,32 @@ components: api_signature_requests_left: description: '_t__AccountQuota::API_SIGNATURE_REQUESTS_LEFT' type: integer + default: 0 nullable: true documents_left: description: '_t__AccountQuota::DOCUMENTS_LEFT' type: integer + default: 0 nullable: true templates_total: description: '_t__AccountQuota::TEMPLATES_TOTAL' type: integer + default: 0 nullable: true templates_left: description: '_t__AccountQuota::TEMPLATES_LEFT' type: integer + default: 0 nullable: true sms_verifications_left: description: '_t__AccountQuota::SMS_VERIFICATIONS_LEFT' type: integer + default: 0 nullable: true num_fax_pages_left: description: '_t__AccountQuota::NUM_FAX_PAGES_LEFT' type: integer + default: 0 nullable: true type: object x-internal-class: true @@ -9835,7 +9841,7 @@ components: fax_pages_sent: description: '_t__AccountUsage::FAX_PAGES_SENT' type: integer - nullable: true + default: 0 type: object x-internal-class: true AccountVerifyResponseAccount: diff --git a/openapi-sdk.yaml b/openapi-sdk.yaml index f24937c67..39bd58e57 100644 --- a/openapi-sdk.yaml +++ b/openapi-sdk.yaml @@ -2737,7 +2737,7 @@ paths: 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. + 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. @@ -5474,7 +5474,7 @@ paths: post: tags: - Template - summary: 'Create Template' + summary: 'Create Template' description: 'Creates a template that can then be used.' operationId: templateCreate requestBody: @@ -10414,26 +10414,32 @@ components: api_signature_requests_left: description: 'API signature requests remaining.' type: integer + default: 0 nullable: true documents_left: description: 'Signature requests remaining.' type: integer + default: 0 nullable: true templates_total: description: 'Total API templates allowed.' type: integer + default: 0 nullable: true templates_left: description: 'API templates remaining.' type: integer + default: 0 nullable: true sms_verifications_left: - description: 'SMS verifications remaining.' + description: 'SMS verifications remaining.' type: integer + default: 0 nullable: true num_fax_pages_left: description: 'Number of fax pages left' type: integer + default: 0 nullable: true type: object x-internal-class: true @@ -10443,7 +10449,7 @@ components: fax_pages_sent: description: 'Number of fax pages sent' type: integer - nullable: true + default: 0 type: object x-internal-class: true AccountVerifyResponseAccount: diff --git a/openapi.yaml b/openapi.yaml index 56be94ebe..2e044d5f8 100644 --- a/openapi.yaml +++ b/openapi.yaml @@ -2737,7 +2737,7 @@ paths: 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. + 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. @@ -5474,7 +5474,7 @@ paths: post: tags: - Template - summary: 'Create Template' + summary: 'Create Template' description: 'Creates a template that can then be used.' operationId: templateCreate requestBody: @@ -10392,26 +10392,32 @@ components: api_signature_requests_left: description: 'API signature requests remaining.' type: integer + default: 0 nullable: true documents_left: description: 'Signature requests remaining.' type: integer + default: 0 nullable: true templates_total: description: 'Total API templates allowed.' type: integer + default: 0 nullable: true templates_left: description: 'API templates remaining.' type: integer + default: 0 nullable: true sms_verifications_left: - description: 'SMS verifications remaining.' + description: 'SMS verifications remaining.' type: integer + default: 0 nullable: true num_fax_pages_left: description: 'Number of fax pages left' type: integer + default: 0 nullable: true type: object x-internal-class: true @@ -10421,7 +10427,7 @@ components: fax_pages_sent: description: 'Number of fax pages sent' type: integer - nullable: true + default: 0 type: object x-internal-class: true AccountVerifyResponseAccount: diff --git a/sdks/dotnet/README.md b/sdks/dotnet/README.md index e3507dbe3..a13746f94 100644 --- a/sdks/dotnet/README.md +++ b/sdks/dotnet/README.md @@ -178,7 +178,7 @@ Class | Method | HTTP request | Description *TeamApi* | [**TeamSubTeams**](docs/TeamApi.md#teamsubteams) | **GET** /team/sub_teams/{team_id} | List Sub Teams *TeamApi* | [**TeamUpdate**](docs/TeamApi.md#teamupdate) | **PUT** /team | Update Team *TemplateApi* | [**TemplateAddUser**](docs/TemplateApi.md#templateadduser) | **POST** /template/add_user/{template_id} | Add User to Template -*TemplateApi* | [**TemplateCreate**](docs/TemplateApi.md#templatecreate) | **POST** /template/create | Create Template +*TemplateApi* | [**TemplateCreate**](docs/TemplateApi.md#templatecreate) | **POST** /template/create | Create Template *TemplateApi* | [**TemplateCreateEmbeddedDraft**](docs/TemplateApi.md#templatecreateembeddeddraft) | **POST** /template/create_embedded_draft | Create Embedded Template Draft *TemplateApi* | [**TemplateDelete**](docs/TemplateApi.md#templatedelete) | **POST** /template/delete/{template_id} | Delete Template *TemplateApi* | [**TemplateFiles**](docs/TemplateApi.md#templatefiles) | **GET** /template/files/{template_id} | Get Template Files diff --git a/sdks/dotnet/docs/AccountResponseQuotas.md b/sdks/dotnet/docs/AccountResponseQuotas.md index 2e12ea8cb..ca716dbff 100644 --- a/sdks/dotnet/docs/AccountResponseQuotas.md +++ b/sdks/dotnet/docs/AccountResponseQuotas.md @@ -5,7 +5,7 @@ Details concerning remaining monthly quotas. Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**ApiSignatureRequestsLeft** | **int?** | API signature requests remaining. | [optional] **DocumentsLeft** | **int?** | Signature requests remaining. | [optional] **TemplatesTotal** | **int?** | Total API templates allowed. | [optional] **TemplatesLeft** | **int?** | API templates remaining. | [optional] **SmsVerificationsLeft** | **int?** | SMS verifications remaining. | [optional] **NumFaxPagesLeft** | **int?** | Number of fax pages left | [optional] +**ApiSignatureRequestsLeft** | **int?** | API signature requests remaining. | [optional] [default to 0]**DocumentsLeft** | **int?** | Signature requests remaining. | [optional] [default to 0]**TemplatesTotal** | **int?** | Total API templates allowed. | [optional] [default to 0]**TemplatesLeft** | **int?** | API templates remaining. | [optional] [default to 0]**SmsVerificationsLeft** | **int?** | SMS verifications remaining. | [optional] [default to 0]**NumFaxPagesLeft** | **int?** | Number of fax pages left | [optional] [default to 0] [[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/sdks/dotnet/docs/AccountResponseUsage.md b/sdks/dotnet/docs/AccountResponseUsage.md index fa5536881..27e541f8f 100644 --- a/sdks/dotnet/docs/AccountResponseUsage.md +++ b/sdks/dotnet/docs/AccountResponseUsage.md @@ -5,7 +5,7 @@ Details concerning monthly usage Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**FaxPagesSent** | **int?** | Number of fax pages sent | [optional] +**FaxPagesSent** | **int** | Number of fax pages sent | [optional] [default to 0] [[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/sdks/dotnet/docs/SignatureRequestApi.md b/sdks/dotnet/docs/SignatureRequestApi.md index c411d0c01..a507cc08f 100644 --- a/sdks/dotnet/docs/SignatureRequestApi.md +++ b/sdks/dotnet/docs/SignatureRequestApi.md @@ -312,7 +312,7 @@ catch (ApiException e) 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]`. +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 ```csharp diff --git a/sdks/dotnet/docs/TemplateApi.md b/sdks/dotnet/docs/TemplateApi.md index d7f4c3bda..c51decd9d 100644 --- a/sdks/dotnet/docs/TemplateApi.md +++ b/sdks/dotnet/docs/TemplateApi.md @@ -5,7 +5,7 @@ All URIs are relative to *https://api.hellosign.com/v3* | Method | HTTP request | Description | |--------|--------------|-------------| | [**TemplateAddUser**](TemplateApi.md#templateadduser) | **POST** /template/add_user/{template_id} | Add User to Template | -| [**TemplateCreate**](TemplateApi.md#templatecreate) | **POST** /template/create | Create Template | +| [**TemplateCreate**](TemplateApi.md#templatecreate) | **POST** /template/create | Create Template | | [**TemplateCreateEmbeddedDraft**](TemplateApi.md#templatecreateembeddeddraft) | **POST** /template/create_embedded_draft | Create Embedded Template Draft | | [**TemplateDelete**](TemplateApi.md#templatedelete) | **POST** /template/delete/{template_id} | Delete Template | | [**TemplateFiles**](TemplateApi.md#templatefiles) | **GET** /template/files/{template_id} | Get Template Files | @@ -120,7 +120,7 @@ catch (ApiException e) # **TemplateCreate** > TemplateCreateResponse TemplateCreate (TemplateCreateRequest templateCreateRequest) -Create Template +Create Template Creates a template that can then be used. @@ -214,7 +214,7 @@ This returns an ApiResponse object which contains the response data, status code ```csharp try { - // Create Template + // Create Template ApiResponse response = apiInstance.TemplateCreateWithHttpInfo(templateCreateRequest); Debug.Write("Status Code: " + response.StatusCode); Debug.Write("Response Headers: " + response.Headers); diff --git a/sdks/dotnet/src/Dropbox.Sign/Api/SignatureRequestApi.cs b/sdks/dotnet/src/Dropbox.Sign/Api/SignatureRequestApi.cs index 0669f9132..7671b5780 100644 --- a/sdks/dotnet/src/Dropbox.Sign/Api/SignatureRequestApi.cs +++ b/sdks/dotnet/src/Dropbox.Sign/Api/SignatureRequestApi.cs @@ -77,7 +77,7 @@ public interface ISignatureRequestApiSync : IApiAccessor /// 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]`. + /// 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]`. /// /// Thrown when fails to make API call /// The id of the incomplete SignatureRequest to cancel. @@ -89,7 +89,7 @@ public interface ISignatureRequestApiSync : IApiAccessor /// 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]`. + /// 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]`. /// /// Thrown when fails to make API call /// The id of the incomplete SignatureRequest to cancel. @@ -472,7 +472,7 @@ public interface ISignatureRequestApiAsync : IApiAccessor /// 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]`. + /// 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]`. /// /// Thrown when fails to make API call /// The id of the incomplete SignatureRequest to cancel. @@ -485,7 +485,7 @@ public interface ISignatureRequestApiAsync : IApiAccessor /// 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]`. + /// 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]`. /// /// Thrown when fails to make API call /// The id of the incomplete SignatureRequest to cancel. @@ -1309,7 +1309,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]`. + /// 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]`. /// /// Thrown when fails to make API call /// The id of the incomplete SignatureRequest to cancel. @@ -1321,7 +1321,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]`. + /// 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]`. /// /// Thrown when fails to make API call /// The id of the incomplete SignatureRequest to cancel. @@ -1390,7 +1390,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]`. + /// 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]`. /// /// Thrown when fails to make API call /// The id of the incomplete SignatureRequest to cancel. @@ -1403,7 +1403,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]`. + /// 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]`. /// /// Thrown when fails to make API call /// The id of the incomplete SignatureRequest to cancel. diff --git a/sdks/dotnet/src/Dropbox.Sign/Api/TemplateApi.cs b/sdks/dotnet/src/Dropbox.Sign/Api/TemplateApi.cs index 01bb32262..f98f0671c 100644 --- a/sdks/dotnet/src/Dropbox.Sign/Api/TemplateApi.cs +++ b/sdks/dotnet/src/Dropbox.Sign/Api/TemplateApi.cs @@ -53,7 +53,7 @@ public interface ITemplateApiSync : IApiAccessor /// ApiResponse of TemplateGetResponse ApiResponse TemplateAddUserWithHttpInfo(string templateId, TemplateAddUserRequest templateAddUserRequest, int operationIndex = 0); /// - /// Create Template + /// Create Template /// /// /// Creates a template that can then be used. @@ -65,7 +65,7 @@ public interface ITemplateApiSync : IApiAccessor TemplateCreateResponse TemplateCreate(TemplateCreateRequest templateCreateRequest, int operationIndex = 0); /// - /// Create Template + /// Create Template /// /// /// Creates a template that can then be used. @@ -333,7 +333,7 @@ public interface ITemplateApiAsync : IApiAccessor /// Task of ApiResponse (TemplateGetResponse) System.Threading.Tasks.Task> TemplateAddUserWithHttpInfoAsync(string templateId, TemplateAddUserRequest templateAddUserRequest, int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)); /// - /// Create Template + /// Create Template /// /// /// Creates a template that can then be used. @@ -346,7 +346,7 @@ public interface ITemplateApiAsync : IApiAccessor System.Threading.Tasks.Task TemplateCreateAsync(TemplateCreateRequest templateCreateRequest, int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)); /// - /// Create Template + /// Create Template /// /// /// Creates a template that can then be used. @@ -919,7 +919,7 @@ public Dropbox.Sign.Client.ApiResponse TemplateAddUserWithH } /// - /// Create Template Creates a template that can then be used. + /// Create Template Creates a template that can then be used. /// /// Thrown when fails to make API call /// @@ -932,7 +932,7 @@ public TemplateCreateResponse TemplateCreate(TemplateCreateRequest templateCreat } /// - /// Create Template Creates a template that can then be used. + /// Create Template Creates a template that can then be used. /// /// Thrown when fails to make API call /// @@ -1009,7 +1009,7 @@ public Dropbox.Sign.Client.ApiResponse TemplateCreateWit } /// - /// Create Template Creates a template that can then be used. + /// Create Template Creates a template that can then be used. /// /// Thrown when fails to make API call /// @@ -1023,7 +1023,7 @@ public Dropbox.Sign.Client.ApiResponse TemplateCreateWit } /// - /// Create Template Creates a template that can then be used. + /// Create Template Creates a template that can then be used. /// /// Thrown when fails to make API call /// diff --git a/sdks/dotnet/src/Dropbox.Sign/Model/AccountResponseQuotas.cs b/sdks/dotnet/src/Dropbox.Sign/Model/AccountResponseQuotas.cs index f72e2721f..8140337a2 100644 --- a/sdks/dotnet/src/Dropbox.Sign/Model/AccountResponseQuotas.cs +++ b/sdks/dotnet/src/Dropbox.Sign/Model/AccountResponseQuotas.cs @@ -41,21 +41,27 @@ protected AccountResponseQuotas() { } /// /// Initializes a new instance of the class. /// - /// API signature requests remaining.. - /// Signature requests remaining.. - /// Total API templates allowed.. - /// API templates remaining.. - /// SMS verifications remaining.. - /// Number of fax pages left. - public AccountResponseQuotas(int? apiSignatureRequestsLeft = default(int?), int? documentsLeft = default(int?), int? templatesTotal = default(int?), int? templatesLeft = default(int?), int? smsVerificationsLeft = default(int?), int? numFaxPagesLeft = default(int?)) + /// API signature requests remaining. (default to 0). + /// Signature requests remaining. (default to 0). + /// Total API templates allowed. (default to 0). + /// API templates remaining. (default to 0). + /// SMS verifications remaining. (default to 0). + /// Number of fax pages left (default to 0). + public AccountResponseQuotas(int? apiSignatureRequestsLeft = 0, int? documentsLeft = 0, int? templatesTotal = 0, int? templatesLeft = 0, int? smsVerificationsLeft = 0, int? numFaxPagesLeft = 0) { - this.ApiSignatureRequestsLeft = apiSignatureRequestsLeft; - this.DocumentsLeft = documentsLeft; - this.TemplatesTotal = templatesTotal; - this.TemplatesLeft = templatesLeft; - this.SmsVerificationsLeft = smsVerificationsLeft; - this.NumFaxPagesLeft = numFaxPagesLeft; + // use default value if no "apiSignatureRequestsLeft" provided + this.ApiSignatureRequestsLeft = apiSignatureRequestsLeft ?? 0; + // use default value if no "documentsLeft" provided + this.DocumentsLeft = documentsLeft ?? 0; + // use default value if no "templatesTotal" provided + this.TemplatesTotal = templatesTotal ?? 0; + // use default value if no "templatesLeft" provided + this.TemplatesLeft = templatesLeft ?? 0; + // use default value if no "smsVerificationsLeft" provided + this.SmsVerificationsLeft = smsVerificationsLeft ?? 0; + // use default value if no "numFaxPagesLeft" provided + this.NumFaxPagesLeft = numFaxPagesLeft ?? 0; } /// @@ -103,9 +109,9 @@ public static AccountResponseQuotas Init(string jsonData) public int? TemplatesLeft { get; set; } /// - /// SMS verifications remaining. + /// SMS verifications remaining. /// - /// SMS verifications remaining. + /// SMS verifications remaining. [DataMember(Name = "sms_verifications_left", EmitDefaultValue = true)] public int? SmsVerificationsLeft { get; set; } diff --git a/sdks/dotnet/src/Dropbox.Sign/Model/AccountResponseUsage.cs b/sdks/dotnet/src/Dropbox.Sign/Model/AccountResponseUsage.cs index bd9e2e5ac..dd51fdcb5 100644 --- a/sdks/dotnet/src/Dropbox.Sign/Model/AccountResponseUsage.cs +++ b/sdks/dotnet/src/Dropbox.Sign/Model/AccountResponseUsage.cs @@ -41,8 +41,8 @@ protected AccountResponseUsage() { } /// /// Initializes a new instance of the class. /// - /// Number of fax pages sent. - public AccountResponseUsage(int? faxPagesSent = default(int?)) + /// Number of fax pages sent (default to 0). + public AccountResponseUsage(int faxPagesSent = 0) { this.FaxPagesSent = faxPagesSent; @@ -69,7 +69,7 @@ public static AccountResponseUsage Init(string jsonData) /// /// Number of fax pages sent [DataMember(Name = "fax_pages_sent", EmitDefaultValue = true)] - public int? FaxPagesSent { get; set; } + public int FaxPagesSent { get; set; } /// /// Returns the string presentation of the object @@ -117,8 +117,7 @@ public bool Equals(AccountResponseUsage input) return ( this.FaxPagesSent == input.FaxPagesSent || - (this.FaxPagesSent != null && - this.FaxPagesSent.Equals(input.FaxPagesSent)) + this.FaxPagesSent.Equals(input.FaxPagesSent) ); } @@ -131,10 +130,7 @@ public override int GetHashCode() unchecked // Overflow is fine, just wrap { int hashCode = 41; - if (this.FaxPagesSent != null) - { - hashCode = (hashCode * 59) + this.FaxPagesSent.GetHashCode(); - } + hashCode = (hashCode * 59) + this.FaxPagesSent.GetHashCode(); return hashCode; } } @@ -155,7 +151,7 @@ public List GetOpenApiTypes() { Name = "fax_pages_sent", Property = "FaxPagesSent", - Type = "int?", + Type = "int", Value = FaxPagesSent, }); diff --git a/sdks/java-v1/README.md b/sdks/java-v1/README.md index b78da75be..8ef139fc2 100644 --- a/sdks/java-v1/README.md +++ b/sdks/java-v1/README.md @@ -214,7 +214,7 @@ Class | Method | HTTP request | Description *TeamApi* | [**teamSubTeams**](docs/TeamApi.md#teamSubTeams) | **GET** /team/sub_teams/{team_id} | List Sub Teams *TeamApi* | [**teamUpdate**](docs/TeamApi.md#teamUpdate) | **PUT** /team | Update Team *TemplateApi* | [**templateAddUser**](docs/TemplateApi.md#templateAddUser) | **POST** /template/add_user/{template_id} | Add User to Template -*TemplateApi* | [**templateCreate**](docs/TemplateApi.md#templateCreate) | **POST** /template/create | Create Template +*TemplateApi* | [**templateCreate**](docs/TemplateApi.md#templateCreate) | **POST** /template/create | Create Template *TemplateApi* | [**templateCreateEmbeddedDraft**](docs/TemplateApi.md#templateCreateEmbeddedDraft) | **POST** /template/create_embedded_draft | Create Embedded Template Draft *TemplateApi* | [**templateDelete**](docs/TemplateApi.md#templateDelete) | **POST** /template/delete/{template_id} | Delete Template *TemplateApi* | [**templateFiles**](docs/TemplateApi.md#templateFiles) | **GET** /template/files/{template_id} | Get Template Files diff --git a/sdks/java-v1/docs/AccountResponseQuotas.md b/sdks/java-v1/docs/AccountResponseQuotas.md index 3b7fe4e58..e7510a8d7 100644 --- a/sdks/java-v1/docs/AccountResponseQuotas.md +++ b/sdks/java-v1/docs/AccountResponseQuotas.md @@ -12,7 +12,7 @@ Details concerning remaining monthly quotas. | `documentsLeft` | ```Integer``` | Signature requests remaining. | | | `templatesTotal` | ```Integer``` | Total API templates allowed. | | | `templatesLeft` | ```Integer``` | API templates remaining. | | -| `smsVerificationsLeft` | ```Integer``` | SMS verifications remaining. | | +| `smsVerificationsLeft` | ```Integer``` | SMS verifications remaining. | | | `numFaxPagesLeft` | ```Integer``` | Number of fax pages left | | diff --git a/sdks/java-v1/docs/SignatureRequestApi.md b/sdks/java-v1/docs/SignatureRequestApi.md index ee42461ce..60e02426f 100644 --- a/sdks/java-v1/docs/SignatureRequestApi.md +++ b/sdks/java-v1/docs/SignatureRequestApi.md @@ -265,7 +265,7 @@ 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. +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. diff --git a/sdks/java-v1/docs/TemplateApi.md b/sdks/java-v1/docs/TemplateApi.md index a3394d6a1..e6c7d1745 100644 --- a/sdks/java-v1/docs/TemplateApi.md +++ b/sdks/java-v1/docs/TemplateApi.md @@ -5,7 +5,7 @@ All URIs are relative to *https://api.hellosign.com/v3* | Method | HTTP request | Description | |------------- | ------------- | -------------| [**templateAddUser**](TemplateApi.md#templateAddUser) | **POST** /template/add_user/{template_id} | Add User to Template -[**templateCreate**](TemplateApi.md#templateCreate) | **POST** /template/create | Create Template +[**templateCreate**](TemplateApi.md#templateCreate) | **POST** /template/create | Create Template [**templateCreateEmbeddedDraft**](TemplateApi.md#templateCreateEmbeddedDraft) | **POST** /template/create_embedded_draft | Create Embedded Template Draft [**templateDelete**](TemplateApi.md#templateDelete) | **POST** /template/delete/{template_id} | Delete Template [**templateFiles**](TemplateApi.md#templateFiles) | **GET** /template/files/{template_id} | Get Template Files @@ -100,7 +100,7 @@ public class Example { > TemplateCreateResponse templateCreate(templateCreateRequest) -Create Template +Create Template Creates a template that can then be used. diff --git a/sdks/java-v1/src/main/java/com/dropbox/sign/model/AccountResponseQuotas.java b/sdks/java-v1/src/main/java/com/dropbox/sign/model/AccountResponseQuotas.java index 584917ff9..bc47dc564 100644 --- a/sdks/java-v1/src/main/java/com/dropbox/sign/model/AccountResponseQuotas.java +++ b/sdks/java-v1/src/main/java/com/dropbox/sign/model/AccountResponseQuotas.java @@ -39,22 +39,22 @@ public class AccountResponseQuotas { public static final String JSON_PROPERTY_API_SIGNATURE_REQUESTS_LEFT = "api_signature_requests_left"; - private Integer apiSignatureRequestsLeft; + private Integer apiSignatureRequestsLeft = 0; public static final String JSON_PROPERTY_DOCUMENTS_LEFT = "documents_left"; - private Integer documentsLeft; + private Integer documentsLeft = 0; public static final String JSON_PROPERTY_TEMPLATES_TOTAL = "templates_total"; - private Integer templatesTotal; + private Integer templatesTotal = 0; public static final String JSON_PROPERTY_TEMPLATES_LEFT = "templates_left"; - private Integer templatesLeft; + private Integer templatesLeft = 0; public static final String JSON_PROPERTY_SMS_VERIFICATIONS_LEFT = "sms_verifications_left"; - private Integer smsVerificationsLeft; + private Integer smsVerificationsLeft = 0; public static final String JSON_PROPERTY_NUM_FAX_PAGES_LEFT = "num_fax_pages_left"; - private Integer numFaxPagesLeft; + private Integer numFaxPagesLeft = 0; public AccountResponseQuotas() {} diff --git a/sdks/java-v1/src/main/java/com/dropbox/sign/model/AccountResponseUsage.java b/sdks/java-v1/src/main/java/com/dropbox/sign/model/AccountResponseUsage.java index daac05931..c45fe4ce2 100644 --- a/sdks/java-v1/src/main/java/com/dropbox/sign/model/AccountResponseUsage.java +++ b/sdks/java-v1/src/main/java/com/dropbox/sign/model/AccountResponseUsage.java @@ -31,7 +31,7 @@ @JsonIgnoreProperties(ignoreUnknown = true) public class AccountResponseUsage { public static final String JSON_PROPERTY_FAX_PAGES_SENT = "fax_pages_sent"; - private Integer faxPagesSent; + private Integer faxPagesSent = 0; public AccountResponseUsage() {} diff --git a/sdks/java-v2/README.md b/sdks/java-v2/README.md index 75edf1dcb..2733d9f9e 100644 --- a/sdks/java-v2/README.md +++ b/sdks/java-v2/README.md @@ -190,7 +190,7 @@ Class | Method | HTTP request | Description *TeamApi* | [**teamSubTeams**](docs/TeamApi.md#teamSubTeams) | **GET** /team/sub_teams/{team_id} | List Sub Teams *TeamApi* | [**teamUpdate**](docs/TeamApi.md#teamUpdate) | **PUT** /team | Update Team *TemplateApi* | [**templateAddUser**](docs/TemplateApi.md#templateAddUser) | **POST** /template/add_user/{template_id} | Add User to Template -*TemplateApi* | [**templateCreate**](docs/TemplateApi.md#templateCreate) | **POST** /template/create | Create Template +*TemplateApi* | [**templateCreate**](docs/TemplateApi.md#templateCreate) | **POST** /template/create | Create Template *TemplateApi* | [**templateCreateEmbeddedDraft**](docs/TemplateApi.md#templateCreateEmbeddedDraft) | **POST** /template/create_embedded_draft | Create Embedded Template Draft *TemplateApi* | [**templateDelete**](docs/TemplateApi.md#templateDelete) | **POST** /template/delete/{template_id} | Delete Template *TemplateApi* | [**templateFiles**](docs/TemplateApi.md#templateFiles) | **GET** /template/files/{template_id} | Get Template Files diff --git a/sdks/java-v2/docs/AccountResponseQuotas.md b/sdks/java-v2/docs/AccountResponseQuotas.md index 3b7fe4e58..e7510a8d7 100644 --- a/sdks/java-v2/docs/AccountResponseQuotas.md +++ b/sdks/java-v2/docs/AccountResponseQuotas.md @@ -12,7 +12,7 @@ Details concerning remaining monthly quotas. | `documentsLeft` | ```Integer``` | Signature requests remaining. | | | `templatesTotal` | ```Integer``` | Total API templates allowed. | | | `templatesLeft` | ```Integer``` | API templates remaining. | | -| `smsVerificationsLeft` | ```Integer``` | SMS verifications remaining. | | +| `smsVerificationsLeft` | ```Integer``` | SMS verifications remaining. | | | `numFaxPagesLeft` | ```Integer``` | Number of fax pages left | | diff --git a/sdks/java-v2/docs/SignatureRequestApi.md b/sdks/java-v2/docs/SignatureRequestApi.md index ee42461ce..60e02426f 100644 --- a/sdks/java-v2/docs/SignatureRequestApi.md +++ b/sdks/java-v2/docs/SignatureRequestApi.md @@ -265,7 +265,7 @@ 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. +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. diff --git a/sdks/java-v2/docs/TemplateApi.md b/sdks/java-v2/docs/TemplateApi.md index a3394d6a1..e6c7d1745 100644 --- a/sdks/java-v2/docs/TemplateApi.md +++ b/sdks/java-v2/docs/TemplateApi.md @@ -5,7 +5,7 @@ All URIs are relative to *https://api.hellosign.com/v3* | Method | HTTP request | Description | |------------- | ------------- | -------------| [**templateAddUser**](TemplateApi.md#templateAddUser) | **POST** /template/add_user/{template_id} | Add User to Template -[**templateCreate**](TemplateApi.md#templateCreate) | **POST** /template/create | Create Template +[**templateCreate**](TemplateApi.md#templateCreate) | **POST** /template/create | Create Template [**templateCreateEmbeddedDraft**](TemplateApi.md#templateCreateEmbeddedDraft) | **POST** /template/create_embedded_draft | Create Embedded Template Draft [**templateDelete**](TemplateApi.md#templateDelete) | **POST** /template/delete/{template_id} | Delete Template [**templateFiles**](TemplateApi.md#templateFiles) | **GET** /template/files/{template_id} | Get Template Files @@ -100,7 +100,7 @@ public class Example { > TemplateCreateResponse templateCreate(templateCreateRequest) -Create Template +Create Template Creates a template that can then be used. 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 c326a36dc..711191bc9 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 @@ -184,7 +184,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]`. + * 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]`. * @param signatureRequestId The id of the incomplete SignatureRequest to cancel. (required) * @throws ApiException if fails to make API call * @http.response.details @@ -201,7 +201,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]`. + * 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]`. * @param signatureRequestId The id of the incomplete SignatureRequest to cancel. (required) * @return ApiResponse<Void> * @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 7fb8db518..c64166a85 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 @@ -130,7 +130,7 @@ public ApiResponse templateAddUserWithHttpInfo(String templ ); } /** - * Create Template. + * Create Template. * Creates a template that can then be used. * @param templateCreateRequest (required) * @return TemplateCreateResponse @@ -148,7 +148,7 @@ public TemplateCreateResponse templateCreate(TemplateCreateRequest templateCreat /** - * Create Template. + * Create Template. * Creates a template that can then be used. * @param templateCreateRequest (required) * @return ApiResponse<TemplateCreateResponse> diff --git a/sdks/java-v2/src/main/java/com/dropbox/sign/model/AccountResponseQuotas.java b/sdks/java-v2/src/main/java/com/dropbox/sign/model/AccountResponseQuotas.java index 04c1fe763..fd725681d 100644 --- a/sdks/java-v2/src/main/java/com/dropbox/sign/model/AccountResponseQuotas.java +++ b/sdks/java-v2/src/main/java/com/dropbox/sign/model/AccountResponseQuotas.java @@ -44,22 +44,22 @@ @JsonIgnoreProperties(ignoreUnknown=true) public class AccountResponseQuotas { public static final String JSON_PROPERTY_API_SIGNATURE_REQUESTS_LEFT = "api_signature_requests_left"; - private Integer apiSignatureRequestsLeft; + private Integer apiSignatureRequestsLeft = 0; public static final String JSON_PROPERTY_DOCUMENTS_LEFT = "documents_left"; - private Integer documentsLeft; + private Integer documentsLeft = 0; public static final String JSON_PROPERTY_TEMPLATES_TOTAL = "templates_total"; - private Integer templatesTotal; + private Integer templatesTotal = 0; public static final String JSON_PROPERTY_TEMPLATES_LEFT = "templates_left"; - private Integer templatesLeft; + private Integer templatesLeft = 0; public static final String JSON_PROPERTY_SMS_VERIFICATIONS_LEFT = "sms_verifications_left"; - private Integer smsVerificationsLeft; + private Integer smsVerificationsLeft = 0; public static final String JSON_PROPERTY_NUM_FAX_PAGES_LEFT = "num_fax_pages_left"; - private Integer numFaxPagesLeft; + private Integer numFaxPagesLeft = 0; public AccountResponseQuotas() { } @@ -185,7 +185,7 @@ public AccountResponseQuotas smsVerificationsLeft(Integer smsVerificationsLeft) } /** - * SMS verifications remaining. + * SMS verifications remaining. * @return smsVerificationsLeft */ @jakarta.annotation.Nullable diff --git a/sdks/java-v2/src/main/java/com/dropbox/sign/model/AccountResponseUsage.java b/sdks/java-v2/src/main/java/com/dropbox/sign/model/AccountResponseUsage.java index 741d5e58c..34dc9f8c0 100644 --- a/sdks/java-v2/src/main/java/com/dropbox/sign/model/AccountResponseUsage.java +++ b/sdks/java-v2/src/main/java/com/dropbox/sign/model/AccountResponseUsage.java @@ -39,7 +39,7 @@ @JsonIgnoreProperties(ignoreUnknown=true) public class AccountResponseUsage { public static final String JSON_PROPERTY_FAX_PAGES_SENT = "fax_pages_sent"; - private Integer faxPagesSent; + private Integer faxPagesSent = 0; public AccountResponseUsage() { } diff --git a/sdks/node/README.md b/sdks/node/README.md index 4aca5d208..542d01e29 100644 --- a/sdks/node/README.md +++ b/sdks/node/README.md @@ -157,7 +157,7 @@ All URIs are relative to *https://api.hellosign.com/v3* | *TeamApi* | [**teamSubTeams**](./docs/api/TeamApi.md#teamsubteams) | **GET** /team/sub_teams/{team_id} | List Sub Teams | | *TeamApi* | [**teamUpdate**](./docs/api/TeamApi.md#teamupdate) | **PUT** /team | Update Team | | *TemplateApi* | [**templateAddUser**](./docs/api/TemplateApi.md#templateadduser) | **POST** /template/add_user/{template_id} | Add User to Template | -| *TemplateApi* | [**templateCreate**](./docs/api/TemplateApi.md#templatecreate) | **POST** /template/create | Create Template | +| *TemplateApi* | [**templateCreate**](./docs/api/TemplateApi.md#templatecreate) | **POST** /template/create | Create Template | | *TemplateApi* | [**templateCreateEmbeddedDraft**](./docs/api/TemplateApi.md#templatecreateembeddeddraft) | **POST** /template/create_embedded_draft | Create Embedded Template Draft | | *TemplateApi* | [**templateDelete**](./docs/api/TemplateApi.md#templatedelete) | **POST** /template/delete/{template_id} | Delete Template | | *TemplateApi* | [**templateFiles**](./docs/api/TemplateApi.md#templatefiles) | **GET** /template/files/{template_id} | Get Template Files | diff --git a/sdks/node/api/signatureRequestApi.ts b/sdks/node/api/signatureRequestApi.ts index 51ccd93bf..3fd0d611e 100644 --- a/sdks/node/api/signatureRequestApi.ts +++ b/sdks/node/api/signatureRequestApi.ts @@ -422,7 +422,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]`. + * 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 * @param signatureRequestId The id of the incomplete SignatureRequest to cancel. * @param options diff --git a/sdks/node/api/templateApi.ts b/sdks/node/api/templateApi.ts index 50ff0b4e7..35ac24648 100644 --- a/sdks/node/api/templateApi.ts +++ b/sdks/node/api/templateApi.ts @@ -291,7 +291,7 @@ export class TemplateApi { } /** * Creates a template that can then be used. - * @summary Create Template + * @summary Create Template * @param templateCreateRequest * @param options */ diff --git a/sdks/node/dist/api.js b/sdks/node/dist/api.js index 27094d35b..7c29b6899 100644 --- a/sdks/node/dist/api.js +++ b/sdks/node/dist/api.js @@ -16518,6 +16518,14 @@ AccountResponse.attributeTypeMap = [ // model/accountResponseQuotas.ts var _AccountResponseQuotas = class { + constructor() { + this["apiSignatureRequestsLeft"] = 0; + this["documentsLeft"] = 0; + this["templatesTotal"] = 0; + this["templatesLeft"] = 0; + this["smsVerificationsLeft"] = 0; + this["numFaxPagesLeft"] = 0; + } static getAttributeTypeMap() { return _AccountResponseQuotas.attributeTypeMap; } @@ -16562,6 +16570,9 @@ AccountResponseQuotas.attributeTypeMap = [ // model/accountResponseUsage.ts var _AccountResponseUsage = class { + constructor() { + this["faxPagesSent"] = 0; + } static getAttributeTypeMap() { return _AccountResponseUsage.attributeTypeMap; } diff --git a/sdks/node/docs/api/SignatureRequestApi.md b/sdks/node/docs/api/SignatureRequestApi.md index 189d58b92..459c8c120 100644 --- a/sdks/node/docs/api/SignatureRequestApi.md +++ b/sdks/node/docs/api/SignatureRequestApi.md @@ -379,7 +379,7 @@ signatureRequestCancel(signatureRequestId: string) 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]`. +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]`. ### TypeScript Example diff --git a/sdks/node/docs/api/TemplateApi.md b/sdks/node/docs/api/TemplateApi.md index 995945f30..e73e5930d 100644 --- a/sdks/node/docs/api/TemplateApi.md +++ b/sdks/node/docs/api/TemplateApi.md @@ -5,7 +5,7 @@ All URIs are relative to https://api.hellosign.com/v3. | Method | HTTP request | Description | | ------------- | ------------- | ------------- | | [**templateAddUser()**](TemplateApi.md#templateAddUser) | **POST** /template/add_user/{template_id} | Add User to Template | -| [**templateCreate()**](TemplateApi.md#templateCreate) | **POST** /template/create | Create Template | +| [**templateCreate()**](TemplateApi.md#templateCreate) | **POST** /template/create | Create Template | | [**templateCreateEmbeddedDraft()**](TemplateApi.md#templateCreateEmbeddedDraft) | **POST** /template/create_embedded_draft | Create Embedded Template Draft | | [**templateDelete()**](TemplateApi.md#templateDelete) | **POST** /template/delete/{template_id} | Delete Template | | [**templateFiles()**](TemplateApi.md#templateFiles) | **GET** /template/files/{template_id} | Get Template Files | @@ -115,7 +115,7 @@ result.then(response => { templateCreate(templateCreateRequest: TemplateCreateRequest): TemplateCreateResponse ``` -Create Template +Create Template Creates a template that can then be used. diff --git a/sdks/node/docs/model/AccountResponseQuotas.md b/sdks/node/docs/model/AccountResponseQuotas.md index 55beed9cb..7d6188988 100644 --- a/sdks/node/docs/model/AccountResponseQuotas.md +++ b/sdks/node/docs/model/AccountResponseQuotas.md @@ -6,11 +6,11 @@ Details concerning remaining monthly quotas. Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `apiSignatureRequestsLeft` | ```number``` | API signature requests remaining. | | -| `documentsLeft` | ```number``` | Signature requests remaining. | | -| `templatesTotal` | ```number``` | Total API templates allowed. | | -| `templatesLeft` | ```number``` | API templates remaining. | | -| `smsVerificationsLeft` | ```number``` | SMS verifications remaining. | | -| `numFaxPagesLeft` | ```number``` | Number of fax pages left | | +| `apiSignatureRequestsLeft` | ```number``` | API signature requests remaining. | [default to 0] | +| `documentsLeft` | ```number``` | Signature requests remaining. | [default to 0] | +| `templatesTotal` | ```number``` | Total API templates allowed. | [default to 0] | +| `templatesLeft` | ```number``` | API templates remaining. | [default to 0] | +| `smsVerificationsLeft` | ```number``` | SMS verifications remaining. | [default to 0] | +| `numFaxPagesLeft` | ```number``` | Number of fax pages left | [default to 0] | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/node/docs/model/AccountResponseUsage.md b/sdks/node/docs/model/AccountResponseUsage.md index 2f095fba9..0591e3c98 100644 --- a/sdks/node/docs/model/AccountResponseUsage.md +++ b/sdks/node/docs/model/AccountResponseUsage.md @@ -6,6 +6,6 @@ Details concerning monthly usage Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `faxPagesSent` | ```number``` | Number of fax pages sent | | +| `faxPagesSent` | ```number``` | Number of fax pages sent | [default to 0] | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/node/model/accountResponseQuotas.ts b/sdks/node/model/accountResponseQuotas.ts index 3553070d7..e1efe123f 100644 --- a/sdks/node/model/accountResponseQuotas.ts +++ b/sdks/node/model/accountResponseQuotas.ts @@ -31,27 +31,27 @@ export class AccountResponseQuotas { /** * API signature requests remaining. */ - "apiSignatureRequestsLeft"?: number | null; + "apiSignatureRequestsLeft"?: number | null = 0; /** * Signature requests remaining. */ - "documentsLeft"?: number | null; + "documentsLeft"?: number | null = 0; /** * Total API templates allowed. */ - "templatesTotal"?: number | null; + "templatesTotal"?: number | null = 0; /** * API templates remaining. */ - "templatesLeft"?: number | null; + "templatesLeft"?: number | null = 0; /** - * SMS verifications remaining. + * SMS verifications remaining. */ - "smsVerificationsLeft"?: number | null; + "smsVerificationsLeft"?: number | null = 0; /** * Number of fax pages left */ - "numFaxPagesLeft"?: number | null; + "numFaxPagesLeft"?: number | null = 0; static discriminator: string | undefined = undefined; diff --git a/sdks/node/model/accountResponseUsage.ts b/sdks/node/model/accountResponseUsage.ts index 95f6f9f88..ce2d969c0 100644 --- a/sdks/node/model/accountResponseUsage.ts +++ b/sdks/node/model/accountResponseUsage.ts @@ -31,7 +31,7 @@ export class AccountResponseUsage { /** * Number of fax pages sent */ - "faxPagesSent"?: number | null; + "faxPagesSent"?: number = 0; static discriminator: string | undefined = undefined; diff --git a/sdks/node/types/model/accountResponseUsage.d.ts b/sdks/node/types/model/accountResponseUsage.d.ts index 7506ca0ee..0b520ac76 100644 --- a/sdks/node/types/model/accountResponseUsage.d.ts +++ b/sdks/node/types/model/accountResponseUsage.d.ts @@ -1,6 +1,6 @@ import { AttributeTypeMap } from "./"; export declare class AccountResponseUsage { - "faxPagesSent"?: number | null; + "faxPagesSent"?: number; static discriminator: string | undefined; static attributeTypeMap: AttributeTypeMap; static getAttributeTypeMap(): AttributeTypeMap; diff --git a/sdks/php/README.md b/sdks/php/README.md index b68ace90a..11d7e67f7 100644 --- a/sdks/php/README.md +++ b/sdks/php/README.md @@ -197,7 +197,7 @@ All URIs are relative to *https://api.hellosign.com/v3* | *TeamApi* | [**teamSubTeams**](docs/Api/TeamApi.md#teamsubteams) | **GET** /team/sub_teams/{team_id} | List Sub Teams | | *TeamApi* | [**teamUpdate**](docs/Api/TeamApi.md#teamupdate) | **PUT** /team | Update Team | | *TemplateApi* | [**templateAddUser**](docs/Api/TemplateApi.md#templateadduser) | **POST** /template/add_user/{template_id} | Add User to Template | -| *TemplateApi* | [**templateCreate**](docs/Api/TemplateApi.md#templatecreate) | **POST** /template/create | Create Template | +| *TemplateApi* | [**templateCreate**](docs/Api/TemplateApi.md#templatecreate) | **POST** /template/create | Create Template | | *TemplateApi* | [**templateCreateEmbeddedDraft**](docs/Api/TemplateApi.md#templatecreateembeddeddraft) | **POST** /template/create_embedded_draft | Create Embedded Template Draft | | *TemplateApi* | [**templateDelete**](docs/Api/TemplateApi.md#templatedelete) | **POST** /template/delete/{template_id} | Delete Template | | *TemplateApi* | [**templateFiles**](docs/Api/TemplateApi.md#templatefiles) | **GET** /template/files/{template_id} | Get Template Files | diff --git a/sdks/php/docs/Api/SignatureRequestApi.md b/sdks/php/docs/Api/SignatureRequestApi.md index 373d1215c..aa4979035 100644 --- a/sdks/php/docs/Api/SignatureRequestApi.md +++ b/sdks/php/docs/Api/SignatureRequestApi.md @@ -227,7 +227,7 @@ signatureRequestCancel($signature_request_id) ``` 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]`. +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 diff --git a/sdks/php/docs/Api/TemplateApi.md b/sdks/php/docs/Api/TemplateApi.md index 3331db8dd..5381a8290 100644 --- a/sdks/php/docs/Api/TemplateApi.md +++ b/sdks/php/docs/Api/TemplateApi.md @@ -5,7 +5,7 @@ All URIs are relative to https://api.hellosign.com/v3. | Method | HTTP request | Description | | ------------- | ------------- | ------------- | | [**templateAddUser()**](TemplateApi.md#templateAddUser) | **POST** /template/add_user/{template_id} | Add User to Template | -| [**templateCreate()**](TemplateApi.md#templateCreate) | **POST** /template/create | Create Template | +| [**templateCreate()**](TemplateApi.md#templateCreate) | **POST** /template/create | Create Template | | [**templateCreateEmbeddedDraft()**](TemplateApi.md#templateCreateEmbeddedDraft) | **POST** /template/create_embedded_draft | Create Embedded Template Draft | | [**templateDelete()**](TemplateApi.md#templateDelete) | **POST** /template/delete/{template_id} | Delete Template | | [**templateFiles()**](TemplateApi.md#templateFiles) | **GET** /template/files/{template_id} | Get Template Files | @@ -88,7 +88,7 @@ try { ```php templateCreate($template_create_request): \Dropbox\Sign\Model\TemplateCreateResponse ``` -Create Template +Create Template Creates a template that can then be used. diff --git a/sdks/php/docs/Model/AccountResponseQuotas.md b/sdks/php/docs/Model/AccountResponseQuotas.md index 9490fa320..cd9d40a48 100644 --- a/sdks/php/docs/Model/AccountResponseQuotas.md +++ b/sdks/php/docs/Model/AccountResponseQuotas.md @@ -6,11 +6,11 @@ Details concerning remaining monthly quotas. Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `api_signature_requests_left` | ```int``` | API signature requests remaining. | | -| `documents_left` | ```int``` | Signature requests remaining. | | -| `templates_total` | ```int``` | Total API templates allowed. | | -| `templates_left` | ```int``` | API templates remaining. | | -| `sms_verifications_left` | ```int``` | SMS verifications remaining. | | -| `num_fax_pages_left` | ```int``` | Number of fax pages left | | +| `api_signature_requests_left` | ```int``` | API signature requests remaining. | [default to 0] | +| `documents_left` | ```int``` | Signature requests remaining. | [default to 0] | +| `templates_total` | ```int``` | Total API templates allowed. | [default to 0] | +| `templates_left` | ```int``` | API templates remaining. | [default to 0] | +| `sms_verifications_left` | ```int``` | SMS verifications remaining. | [default to 0] | +| `num_fax_pages_left` | ```int``` | Number of fax pages left | [default to 0] | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/AccountResponseUsage.md b/sdks/php/docs/Model/AccountResponseUsage.md index 3d8c992c2..c87b1422d 100644 --- a/sdks/php/docs/Model/AccountResponseUsage.md +++ b/sdks/php/docs/Model/AccountResponseUsage.md @@ -6,6 +6,6 @@ Details concerning monthly usage Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `fax_pages_sent` | ```int``` | Number of fax pages sent | | +| `fax_pages_sent` | ```int``` | Number of fax pages sent | [default to 0] | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/src/Api/TemplateApi.php b/sdks/php/src/Api/TemplateApi.php index 6b356fc7b..091dc84d6 100644 --- a/sdks/php/src/Api/TemplateApi.php +++ b/sdks/php/src/Api/TemplateApi.php @@ -525,7 +525,7 @@ public function templateAddUserRequest(string $template_id, Model\TemplateAddUse /** * Operation templateCreate * - * Create Template + * Create Template * * @param Model\TemplateCreateRequest $template_create_request template_create_request (required) * @@ -542,7 +542,7 @@ public function templateCreate(Model\TemplateCreateRequest $template_create_requ /** * Operation templateCreateWithHttpInfo * - * Create Template + * Create Template * * @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 @@ -679,7 +679,7 @@ public function templateCreateWithHttpInfo(Model\TemplateCreateRequest $template /** * Operation templateCreateAsync * - * Create Template + * Create Template * * @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 @@ -701,7 +701,7 @@ function ($response) { /** * Operation templateCreateAsyncWithHttpInfo * - * Create Template + * Create Template * * @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 diff --git a/sdks/php/src/Model/AccountResponseQuotas.php b/sdks/php/src/Model/AccountResponseQuotas.php index 3ec8d7a9e..98fb55ed0 100644 --- a/sdks/php/src/Model/AccountResponseQuotas.php +++ b/sdks/php/src/Model/AccountResponseQuotas.php @@ -265,12 +265,12 @@ public function getModelName() */ public function __construct(array $data = null) { - $this->setIfExists('api_signature_requests_left', $data ?? [], null); - $this->setIfExists('documents_left', $data ?? [], null); - $this->setIfExists('templates_total', $data ?? [], null); - $this->setIfExists('templates_left', $data ?? [], null); - $this->setIfExists('sms_verifications_left', $data ?? [], null); - $this->setIfExists('num_fax_pages_left', $data ?? [], null); + $this->setIfExists('api_signature_requests_left', $data ?? [], 0); + $this->setIfExists('documents_left', $data ?? [], 0); + $this->setIfExists('templates_total', $data ?? [], 0); + $this->setIfExists('templates_left', $data ?? [], 0); + $this->setIfExists('sms_verifications_left', $data ?? [], 0); + $this->setIfExists('num_fax_pages_left', $data ?? [], 0); } /** @@ -479,7 +479,7 @@ public function getSmsVerificationsLeft() /** * Sets sms_verifications_left * - * @param int|null $sms_verifications_left SMS verifications remaining + * @param int|null $sms_verifications_left SMS verifications remaining * * @return self */ diff --git a/sdks/php/src/Model/AccountResponseUsage.php b/sdks/php/src/Model/AccountResponseUsage.php index 94eb509e7..6728300ac 100644 --- a/sdks/php/src/Model/AccountResponseUsage.php +++ b/sdks/php/src/Model/AccountResponseUsage.php @@ -29,6 +29,7 @@ use ArrayAccess; use Dropbox\Sign\ObjectSerializer; +use InvalidArgumentException; use JsonSerializable; use ReturnTypeWillChange; @@ -77,7 +78,7 @@ class AccountResponseUsage implements ModelInterface, ArrayAccess, JsonSerializa * @var bool[] */ protected static array $openAPINullables = [ - 'fax_pages_sent' => true, + 'fax_pages_sent' => false, ]; /** @@ -235,7 +236,7 @@ public function getModelName() */ public function __construct(array $data = null) { - $this->setIfExists('fax_pages_sent', $data ?? [], null); + $this->setIfExists('fax_pages_sent', $data ?? [], 0); } /** @@ -315,14 +316,7 @@ public function getFaxPagesSent() public function setFaxPagesSent(?int $fax_pages_sent) { if (is_null($fax_pages_sent)) { - array_push($this->openAPINullablesSetToNull, 'fax_pages_sent'); - } else { - $nullablesSetToNull = $this->getOpenAPINullablesSetToNull(); - $index = array_search('fax_pages_sent', $nullablesSetToNull); - if ($index !== false) { - unset($nullablesSetToNull[$index]); - $this->setOpenAPINullablesSetToNull($nullablesSetToNull); - } + throw new InvalidArgumentException('non-nullable fax_pages_sent cannot be null'); } $this->container['fax_pages_sent'] = $fax_pages_sent; diff --git a/sdks/python/README.md b/sdks/python/README.md index 15be18ce8..2ace00b7b 100644 --- a/sdks/python/README.md +++ b/sdks/python/README.md @@ -152,7 +152,7 @@ Class | Method | HTTP request | Description ```TeamApi``` | [```team_sub_teams```](docs/TeamApi.md#team_sub_teams) | ```GET /team/sub_teams/{team_id}``` | List Sub Teams| ```TeamApi``` | [```team_update```](docs/TeamApi.md#team_update) | ```PUT /team``` | Update Team| |```TemplateApi``` | [```template_add_user```](docs/TemplateApi.md#template_add_user) | ```POST /template/add_user/{template_id}``` | Add User to Template| -```TemplateApi``` | [```template_create```](docs/TemplateApi.md#template_create) | ```POST /template/create``` | Create Template| +```TemplateApi``` | [```template_create```](docs/TemplateApi.md#template_create) | ```POST /template/create``` | Create Template| ```TemplateApi``` | [```template_create_embedded_draft```](docs/TemplateApi.md#template_create_embedded_draft) | ```POST /template/create_embedded_draft``` | Create Embedded Template Draft| ```TemplateApi``` | [```template_delete```](docs/TemplateApi.md#template_delete) | ```POST /template/delete/{template_id}``` | Delete Template| ```TemplateApi``` | [```template_files```](docs/TemplateApi.md#template_files) | ```GET /template/files/{template_id}``` | Get Template Files| diff --git a/sdks/python/docs/AccountResponseQuotas.md b/sdks/python/docs/AccountResponseQuotas.md index 740ad2357..ab1b36dc0 100644 --- a/sdks/python/docs/AccountResponseQuotas.md +++ b/sdks/python/docs/AccountResponseQuotas.md @@ -5,12 +5,12 @@ Details concerning remaining monthly quotas. ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `api_signature_requests_left` | ```int``` | API signature requests remaining. | | -| `documents_left` | ```int``` | Signature requests remaining. | | -| `templates_total` | ```int``` | Total API templates allowed. | | -| `templates_left` | ```int``` | API templates remaining. | | -| `sms_verifications_left` | ```int``` | SMS verifications remaining. | | -| `num_fax_pages_left` | ```int``` | Number of fax pages left | | +| `api_signature_requests_left` | ```int``` | API signature requests remaining. | [default to 0] | +| `documents_left` | ```int``` | Signature requests remaining. | [default to 0] | +| `templates_total` | ```int``` | Total API templates allowed. | [default to 0] | +| `templates_left` | ```int``` | API templates remaining. | [default to 0] | +| `sms_verifications_left` | ```int``` | SMS verifications remaining. | [default to 0] | +| `num_fax_pages_left` | ```int``` | Number of fax pages left | [default to 0] | [[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/sdks/python/docs/AccountResponseUsage.md b/sdks/python/docs/AccountResponseUsage.md index dd99429af..a8ca8e606 100644 --- a/sdks/python/docs/AccountResponseUsage.md +++ b/sdks/python/docs/AccountResponseUsage.md @@ -5,7 +5,7 @@ Details concerning monthly usage ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `fax_pages_sent` | ```int``` | Number of fax pages sent | | +| `fax_pages_sent` | ```int``` | Number of fax pages sent | [default to 0] | [[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/sdks/python/docs/SignatureRequestApi.md b/sdks/python/docs/SignatureRequestApi.md index a4554ef44..2db45f1a5 100644 --- a/sdks/python/docs/SignatureRequestApi.md +++ b/sdks/python/docs/SignatureRequestApi.md @@ -253,7 +253,7 @@ with ApiClient(configuration) as api_client: 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]`. +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 diff --git a/sdks/python/docs/TemplateApi.md b/sdks/python/docs/TemplateApi.md index 9adb98a8a..153be9c2e 100644 --- a/sdks/python/docs/TemplateApi.md +++ b/sdks/python/docs/TemplateApi.md @@ -5,7 +5,7 @@ All URIs are relative to *https://api.hellosign.com/v3* Method | HTTP request | Description ------------- | ------------- | ------------- |[```template_add_user```](TemplateApi.md#template_add_user) | ```POST /template/add_user/{template_id}``` | Add User to Template| -|[```template_create```](TemplateApi.md#template_create) | ```POST /template/create``` | Create Template| +|[```template_create```](TemplateApi.md#template_create) | ```POST /template/create``` | Create Template| |[```template_create_embedded_draft```](TemplateApi.md#template_create_embedded_draft) | ```POST /template/create_embedded_draft``` | Create Embedded Template Draft| |[```template_delete```](TemplateApi.md#template_delete) | ```POST /template/delete/{template_id}``` | Delete Template| |[```template_files```](TemplateApi.md#template_files) | ```GET /template/files/{template_id}``` | Get Template Files| @@ -90,7 +90,7 @@ with ApiClient(configuration) as api_client: # ```template_create``` > ```TemplateCreateResponse template_create(template_create_request)``` -Create Template +Create Template Creates a template that can then be used. diff --git a/sdks/python/dropbox_sign/api/signature_request_api.py b/sdks/python/dropbox_sign/api/signature_request_api.py index 4298079c1..f78d1a219 100644 --- a/sdks/python/dropbox_sign/api/signature_request_api.py +++ b/sdks/python/dropbox_sign/api/signature_request_api.py @@ -649,7 +649,7 @@ def signature_request_cancel( ) -> None: """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]`. + 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]`. :param signature_request_id: The id of the incomplete SignatureRequest to cancel. (required) :type signature_request_id: str @@ -717,7 +717,7 @@ def signature_request_cancel_with_http_info( ) -> ApiResponse[None]: """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]`. + 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]`. :param signature_request_id: The id of the incomplete SignatureRequest to cancel. (required) :type signature_request_id: str @@ -785,7 +785,7 @@ def signature_request_cancel_without_preload_content( ) -> RESTResponseType: """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]`. + 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]`. :param signature_request_id: The id of the incomplete SignatureRequest to cancel. (required) :type signature_request_id: str diff --git a/sdks/python/dropbox_sign/api/template_api.py b/sdks/python/dropbox_sign/api/template_api.py index 9f87978ee..87be9f0fd 100644 --- a/sdks/python/dropbox_sign/api/template_api.py +++ b/sdks/python/dropbox_sign/api/template_api.py @@ -372,7 +372,7 @@ def template_create( _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, ) -> TemplateCreateResponse: - """Create Template + """Create Template Creates a template that can then be used. @@ -437,7 +437,7 @@ def template_create_with_http_info( _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, ) -> ApiResponse[TemplateCreateResponse]: - """Create Template + """Create Template Creates a template that can then be used. @@ -502,7 +502,7 @@ def template_create_without_preload_content( _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, ) -> RESTResponseType: - """Create Template + """Create Template Creates a template that can then be used. diff --git a/sdks/python/dropbox_sign/models/account_response_quotas.py b/sdks/python/dropbox_sign/models/account_response_quotas.py index 1b90d4162..c39cc3889 100644 --- a/sdks/python/dropbox_sign/models/account_response_quotas.py +++ b/sdks/python/dropbox_sign/models/account_response_quotas.py @@ -33,22 +33,22 @@ class AccountResponseQuotas(BaseModel): """ # noqa: E501 api_signature_requests_left: Optional[StrictInt] = Field( - default=None, description="API signature requests remaining." + default=0, description="API signature requests remaining." ) documents_left: Optional[StrictInt] = Field( - default=None, description="Signature requests remaining." + default=0, description="Signature requests remaining." ) templates_total: Optional[StrictInt] = Field( - default=None, description="Total API templates allowed." + default=0, description="Total API templates allowed." ) templates_left: Optional[StrictInt] = Field( - default=None, description="API templates remaining." + default=0, description="API templates remaining." ) sms_verifications_left: Optional[StrictInt] = Field( - default=None, description="SMS verifications remaining." + default=0, description="SMS verifications remaining." ) num_fax_pages_left: Optional[StrictInt] = Field( - default=None, description="Number of fax pages left" + default=0, description="Number of fax pages left" ) __properties: ClassVar[List[str]] = [ "api_signature_requests_left", @@ -122,12 +122,36 @@ def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: _obj = cls.model_validate( { - "api_signature_requests_left": obj.get("api_signature_requests_left"), - "documents_left": obj.get("documents_left"), - "templates_total": obj.get("templates_total"), - "templates_left": obj.get("templates_left"), - "sms_verifications_left": obj.get("sms_verifications_left"), - "num_fax_pages_left": obj.get("num_fax_pages_left"), + "api_signature_requests_left": ( + obj.get("api_signature_requests_left") + if obj.get("api_signature_requests_left") is not None + else 0 + ), + "documents_left": ( + obj.get("documents_left") + if obj.get("documents_left") is not None + else 0 + ), + "templates_total": ( + obj.get("templates_total") + if obj.get("templates_total") is not None + else 0 + ), + "templates_left": ( + obj.get("templates_left") + if obj.get("templates_left") is not None + else 0 + ), + "sms_verifications_left": ( + obj.get("sms_verifications_left") + if obj.get("sms_verifications_left") is not None + else 0 + ), + "num_fax_pages_left": ( + obj.get("num_fax_pages_left") + if obj.get("num_fax_pages_left") is not None + else 0 + ), } ) return _obj diff --git a/sdks/python/dropbox_sign/models/account_response_usage.py b/sdks/python/dropbox_sign/models/account_response_usage.py index 8efc7a64b..84e6f9841 100644 --- a/sdks/python/dropbox_sign/models/account_response_usage.py +++ b/sdks/python/dropbox_sign/models/account_response_usage.py @@ -33,7 +33,7 @@ class AccountResponseUsage(BaseModel): """ # noqa: E501 fax_pages_sent: Optional[StrictInt] = Field( - default=None, description="Number of fax pages sent" + default=0, description="Number of fax pages sent" ) __properties: ClassVar[List[str]] = ["fax_pages_sent"] @@ -98,7 +98,15 @@ def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: if not isinstance(obj, dict): return cls.model_validate(obj) - _obj = cls.model_validate({"fax_pages_sent": obj.get("fax_pages_sent")}) + _obj = cls.model_validate( + { + "fax_pages_sent": ( + obj.get("fax_pages_sent") + if obj.get("fax_pages_sent") is not None + else 0 + ) + } + ) return _obj @classmethod diff --git a/sdks/ruby/README.md b/sdks/ruby/README.md index 1dd16ae20..e8291bf2f 100644 --- a/sdks/ruby/README.md +++ b/sdks/ruby/README.md @@ -158,7 +158,7 @@ All URIs are relative to *https://api.hellosign.com/v3* |*Dropbox::Sign::TeamApi* | [**team_sub_teams**](docs/TeamApi.md#team_sub_teams) | **GET** /team/sub_teams/{team_id} | List Sub Teams | |*Dropbox::Sign::TeamApi* | [**team_update**](docs/TeamApi.md#team_update) | **PUT** /team | Update Team | |*Dropbox::Sign::TemplateApi* | [**template_add_user**](docs/TemplateApi.md#template_add_user) | **POST** /template/add_user/{template_id} | Add User to Template | -|*Dropbox::Sign::TemplateApi* | [**template_create**](docs/TemplateApi.md#template_create) | **POST** /template/create | Create Template | +|*Dropbox::Sign::TemplateApi* | [**template_create**](docs/TemplateApi.md#template_create) | **POST** /template/create | Create Template | |*Dropbox::Sign::TemplateApi* | [**template_create_embedded_draft**](docs/TemplateApi.md#template_create_embedded_draft) | **POST** /template/create_embedded_draft | Create Embedded Template Draft | |*Dropbox::Sign::TemplateApi* | [**template_delete**](docs/TemplateApi.md#template_delete) | **POST** /template/delete/{template_id} | Delete Template | |*Dropbox::Sign::TemplateApi* | [**template_files**](docs/TemplateApi.md#template_files) | **GET** /template/files/{template_id} | Get Template Files | diff --git a/sdks/ruby/docs/AccountResponseQuotas.md b/sdks/ruby/docs/AccountResponseQuotas.md index 2a6b0c98a..d50615615 100644 --- a/sdks/ruby/docs/AccountResponseQuotas.md +++ b/sdks/ruby/docs/AccountResponseQuotas.md @@ -6,10 +6,10 @@ Details concerning remaining monthly quotas. | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | -| `api_signature_requests_left` | ```Integer``` | API signature requests remaining. | | -| `documents_left` | ```Integer``` | Signature requests remaining. | | -| `templates_total` | ```Integer``` | Total API templates allowed. | | -| `templates_left` | ```Integer``` | API templates remaining. | | -| `sms_verifications_left` | ```Integer``` | SMS verifications remaining. | | -| `num_fax_pages_left` | ```Integer``` | Number of fax pages left | | +| `api_signature_requests_left` | ```Integer``` | API signature requests remaining. | [default to 0] | +| `documents_left` | ```Integer``` | Signature requests remaining. | [default to 0] | +| `templates_total` | ```Integer``` | Total API templates allowed. | [default to 0] | +| `templates_left` | ```Integer``` | API templates remaining. | [default to 0] | +| `sms_verifications_left` | ```Integer``` | SMS verifications remaining. | [default to 0] | +| `num_fax_pages_left` | ```Integer``` | Number of fax pages left | [default to 0] | diff --git a/sdks/ruby/docs/AccountResponseUsage.md b/sdks/ruby/docs/AccountResponseUsage.md index 6dc2ddc21..85145219a 100644 --- a/sdks/ruby/docs/AccountResponseUsage.md +++ b/sdks/ruby/docs/AccountResponseUsage.md @@ -6,5 +6,5 @@ Details concerning monthly usage | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | -| `fax_pages_sent` | ```Integer``` | Number of fax pages sent | | +| `fax_pages_sent` | ```Integer``` | Number of fax pages sent | [default to 0] | diff --git a/sdks/ruby/docs/SignatureRequestApi.md b/sdks/ruby/docs/SignatureRequestApi.md index 7bc3482fa..0261ffa5c 100644 --- a/sdks/ruby/docs/SignatureRequestApi.md +++ b/sdks/ruby/docs/SignatureRequestApi.md @@ -249,7 +249,7 @@ end 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]`. +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]`. ### Examples diff --git a/sdks/ruby/docs/TemplateApi.md b/sdks/ruby/docs/TemplateApi.md index 3e9361b14..bcd27fae0 100644 --- a/sdks/ruby/docs/TemplateApi.md +++ b/sdks/ruby/docs/TemplateApi.md @@ -5,7 +5,7 @@ All URIs are relative to *https://api.hellosign.com/v3* | Method | HTTP request | Description | | ------ | ------------ | ----------- | | [`template_add_user`](TemplateApi.md#template_add_user) | **POST** `/template/add_user/{template_id}` | Add User to Template | -| [`template_create`](TemplateApi.md#template_create) | **POST** `/template/create` | Create Template | +| [`template_create`](TemplateApi.md#template_create) | **POST** `/template/create` | Create Template | | [`template_create_embedded_draft`](TemplateApi.md#template_create_embedded_draft) | **POST** `/template/create_embedded_draft` | Create Embedded Template Draft | | [`template_delete`](TemplateApi.md#template_delete) | **POST** `/template/delete/{template_id}` | Delete Template | | [`template_files`](TemplateApi.md#template_files) | **GET** `/template/files/{template_id}` | Get Template Files | @@ -97,7 +97,7 @@ end > ` template_create(template_create_request)` -Create Template +Create Template Creates a template that can then be used. @@ -164,7 +164,7 @@ This returns an Array which contains the response data, status code and headers. ```ruby begin - # Create Template + # Create Template data, status_code, headers = api_instance.template_create_with_http_info(template_create_request) p status_code # => 2xx p 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 438940953..d61d27b46 100644 --- a/sdks/ruby/lib/dropbox-sign/api/signature_request_api.rb +++ b/sdks/ruby/lib/dropbox-sign/api/signature_request_api.rb @@ -241,7 +241,7 @@ def signature_request_bulk_send_with_template_with_http_info(signature_request_b end # 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]`. + # 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]`. # @param signature_request_id [String] The id of the incomplete SignatureRequest to cancel. # @param [Hash] opts the optional parameters # @return [nil] @@ -251,7 +251,7 @@ def signature_request_cancel(signature_request_id, opts = {}) end # 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]`. + # 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]`. # @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 diff --git a/sdks/ruby/lib/dropbox-sign/api/template_api.rb b/sdks/ruby/lib/dropbox-sign/api/template_api.rb index 445ee2b47..7b6e4ac16 100644 --- a/sdks/ruby/lib/dropbox-sign/api/template_api.rb +++ b/sdks/ruby/lib/dropbox-sign/api/template_api.rb @@ -137,7 +137,7 @@ def template_add_user_with_http_info(template_id, template_add_user_request, opt return data, status_code, headers end - # Create Template + # Create Template # Creates a template that can then be used. # @param template_create_request [TemplateCreateRequest] # @param [Hash] opts the optional parameters @@ -147,7 +147,7 @@ def template_create(template_create_request, opts = {}) data end - # Create Template + # Create Template # Creates a template that can then be used. # @param template_create_request [TemplateCreateRequest] # @param [Hash] opts the optional parameters diff --git a/sdks/ruby/lib/dropbox-sign/models/account_response_quotas.rb b/sdks/ruby/lib/dropbox-sign/models/account_response_quotas.rb index 03ac4898f..d202a1c1b 100644 --- a/sdks/ruby/lib/dropbox-sign/models/account_response_quotas.rb +++ b/sdks/ruby/lib/dropbox-sign/models/account_response_quotas.rb @@ -35,7 +35,7 @@ class AccountResponseQuotas # @return [Integer, nil] attr_accessor :templates_left - # SMS verifications remaining. + # SMS verifications remaining. # @return [Integer, nil] attr_accessor :sms_verifications_left @@ -126,26 +126,38 @@ def initialize(attributes = {}) if attributes.key?(:'api_signature_requests_left') self.api_signature_requests_left = attributes[:'api_signature_requests_left'] + else + self.api_signature_requests_left = 0 end if attributes.key?(:'documents_left') self.documents_left = attributes[:'documents_left'] + else + self.documents_left = 0 end if attributes.key?(:'templates_total') self.templates_total = attributes[:'templates_total'] + else + self.templates_total = 0 end if attributes.key?(:'templates_left') self.templates_left = attributes[:'templates_left'] + else + self.templates_left = 0 end if attributes.key?(:'sms_verifications_left') self.sms_verifications_left = attributes[:'sms_verifications_left'] + else + self.sms_verifications_left = 0 end if attributes.key?(:'num_fax_pages_left') self.num_fax_pages_left = attributes[:'num_fax_pages_left'] + else + self.num_fax_pages_left = 0 end end diff --git a/sdks/ruby/lib/dropbox-sign/models/account_response_usage.rb b/sdks/ruby/lib/dropbox-sign/models/account_response_usage.rb index 3eb518794..fe57fc441 100644 --- a/sdks/ruby/lib/dropbox-sign/models/account_response_usage.rb +++ b/sdks/ruby/lib/dropbox-sign/models/account_response_usage.rb @@ -20,7 +20,7 @@ module Dropbox::Sign # Details concerning monthly usage class AccountResponseUsage # Number of fax pages sent - # @return [Integer, nil] + # @return [Integer] attr_accessor :fax_pages_sent # Attribute mapping from ruby-style variable name to JSON key. @@ -45,7 +45,6 @@ def self.openapi_types # List of attributes with nullable: true def self.openapi_nullable Set.new([ - :'fax_pages_sent' ]) end @@ -91,6 +90,8 @@ def initialize(attributes = {}) if attributes.key?(:'fax_pages_sent') self.fax_pages_sent = attributes[:'fax_pages_sent'] + else + self.fax_pages_sent = 0 end end diff --git a/translations/en.yaml b/translations/en.yaml index a2b4a367c..53aa2306d 100644 --- a/translations/en.yaml +++ b/translations/en.yaml @@ -275,7 +275,7 @@ 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. + 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. @@ -644,7 +644,7 @@ "TemplateCreateEmbeddedDraft::USE_PREEXISTING_FIELDS": Enable the detection of predefined PDF fields by setting the `use_preexisting_fields` to `true` (defaults to disabled, or `false`). -"TemplateCreate::SUMMARY": Create Template +"TemplateCreate::SUMMARY": Create Template "TemplateCreate::DESCRIPTION": Creates a template that can then be used. "TemplateCreate::ALLOW_CCS": This allows the requester to specify whether the user is allowed to provide email addresses to CC when creating a template. @@ -768,7 +768,7 @@ "UnclaimedDraftCreate::TYPE": The type of unclaimed draft to create. Use `send_document` to create a claimable file, and `request_signature` for a claimable signature request. If the type is `request_signature` then signers name and email_address are not optional. "UnclaimedDraftCreate::USE_PREEXISTING_FIELDS": Set `use_text_tags` to `true` to enable [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) parsing in your document (defaults to disabled, or `false`). Alternatively, if your PDF contains pre-defined fields, enable the detection of these fields by setting the `use_preexisting_fields` to `true` (defaults to disabled, or `false`). Currently we only support use of either `use_text_tags` or `use_preexisting_fields` parameter, not both. "UnclaimedDraftCreate::USE_TEXT_TAGS": Set `use_text_tags` to `true` to enable [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) parsing in your document (defaults to disabled, or `false`). Alternatively, if your PDF contains pre-defined fields, enable the detection of these fields by setting the `use_preexisting_fields` to `true` (defaults to disabled, or `false`). Currently we only support use of either `use_text_tags` or `use_preexisting_fields` parameter, not both. -"UnclaimedDraftCreate::EXPIRES_AT": |- +"UnclaimedDraftCreate::EXPIRES_AT": |- When the signature request will expire. Unsigned signatures will be moved to the expired status, and no longer signable. See [Signature Request Expiration Date](https://developers.hellosign.com/docs/signature-request/expiration/) for details. **NOTE:** This does not correspond to the **expires_at** returned in the response. @@ -818,7 +818,7 @@ 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. -"UnclaimedDraftCreateEmbedded::EXPIRES_AT": |- +"UnclaimedDraftCreateEmbedded::EXPIRES_AT": |- When the signature request will expire. Unsigned signatures will be moved to the expired status, and no longer signable. See [Signature Request Expiration Date](https://developers.hellosign.com/docs/signature-request/expiration/) for details. **NOTE:** This does not correspond to the **expires_at** returned in the response. @@ -1201,7 +1201,7 @@ "AccountQuota::TEMPLATES_TOTAL": Total API templates allowed. "AccountQuota::API_SIGNATURE_REQUESTS_LEFT": API signature requests remaining. "AccountQuota::DOCUMENTS_LEFT": Signature requests remaining. -"AccountQuota::SMS_VERIFICATIONS_LEFT": SMS verifications remaining. +"AccountQuota::SMS_VERIFICATIONS_LEFT": SMS verifications remaining. "AccountQuota::NUM_FAX_PAGES_LEFT": Number of fax pages left "AccountUsage::FAX_PAGES_SENT": Number of fax pages sent @@ -1258,7 +1258,7 @@ "EmbeddedEditUrlResponseEmbedded::DESCRIPTION": An embedded template object. "EmbeddedEditUrlResponseEmbedded::EDIT_URL": A template url that can be opened in an iFrame. -"EmbeddedEditUrlResponseEmbedded::EXPIRES_AT": The specific time that the the `edit_url` link expires, in epoch. +"EmbeddedEditUrlResponseEmbedded::EXPIRES_AT": The specific time that the the `edit_url` link expires, in epoch. "EventCallbackAccountRequest::DESCRIPTION": |- **Account Callback Payloads --**