From f99f350ca5a30d6c0c966723965d0c48999309d2 Mon Sep 17 00:00:00 2001 From: Juan Treminio Date: Thu, 10 Oct 2024 10:28:12 -0500 Subject: [PATCH 1/4] AccountQuota -1 to mean "unlimited" --- openapi-sdk.yaml | 16 ++++----- openapi.yaml | 16 ++++----- sdks/dotnet/README.md | 2 +- sdks/dotnet/docs/AccountResponseQuotas.md | 2 +- sdks/dotnet/docs/SignatureRequestApi.md | 2 +- sdks/dotnet/docs/TemplateApi.md | 6 ++-- .../Dropbox.Sign/Api/SignatureRequestApi.cs | 16 ++++----- .../src/Dropbox.Sign/Api/TemplateApi.cs | 16 ++++----- .../Model/AccountResponseQuotas.cs | 36 +++++++++---------- sdks/java-v1/README.md | 2 +- sdks/java-v1/docs/AccountResponseQuotas.md | 12 +++---- sdks/java-v1/docs/SignatureRequestApi.md | 2 +- sdks/java-v1/docs/TemplateApi.md | 4 +-- .../sign/model/AccountResponseQuotas.java | 10 +++--- sdks/java-v2/README.md | 2 +- sdks/java-v2/docs/AccountResponseQuotas.md | 12 +++---- sdks/java-v2/docs/SignatureRequestApi.md | 2 +- sdks/java-v2/docs/TemplateApi.md | 4 +-- .../dropbox/sign/api/SignatureRequestApi.java | 4 +-- .../com/dropbox/sign/api/TemplateApi.java | 4 +-- .../sign/model/AccountResponseQuotas.java | 12 +++---- sdks/node/README.md | 2 +- sdks/node/api/signatureRequestApi.ts | 2 +- sdks/node/api/templateApi.ts | 2 +- sdks/node/docs/api/SignatureRequestApi.md | 2 +- sdks/node/docs/api/TemplateApi.md | 4 +-- sdks/node/docs/model/AccountResponseQuotas.md | 12 +++---- sdks/node/model/accountResponseQuotas.ts | 12 +++---- sdks/php/README.md | 2 +- sdks/php/docs/Api/SignatureRequestApi.md | 2 +- sdks/php/docs/Api/TemplateApi.md | 4 +-- sdks/php/docs/Model/AccountResponseQuotas.md | 12 +++---- sdks/php/src/Api/TemplateApi.php | 8 ++--- sdks/php/src/Model/AccountResponseQuotas.php | 12 +++---- sdks/python/README.md | 2 +- sdks/python/docs/AccountResponseQuotas.md | 12 +++---- sdks/python/docs/SignatureRequestApi.md | 2 +- sdks/python/docs/TemplateApi.md | 4 +-- .../dropbox_sign/api/signature_request_api.py | 6 ++-- sdks/python/dropbox_sign/api/template_api.py | 6 ++-- .../models/account_response_quotas.py | 17 +++++---- sdks/ruby/README.md | 2 +- sdks/ruby/docs/AccountResponseQuotas.md | 12 +++---- sdks/ruby/docs/SignatureRequestApi.md | 2 +- sdks/ruby/docs/TemplateApi.md | 6 ++-- .../dropbox-sign/api/signature_request_api.rb | 4 +-- .../ruby/lib/dropbox-sign/api/template_api.rb | 4 +-- .../models/account_response_quotas.rb | 12 +++---- translations/en.yaml | 22 ++++++------ 49 files changed, 188 insertions(+), 183 deletions(-) diff --git a/openapi-sdk.yaml b/openapi-sdk.yaml index 592a587f1..e8684be1b 100644 --- a/openapi-sdk.yaml +++ b/openapi-sdk.yaml @@ -2703,7 +2703,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. @@ -5440,7 +5440,7 @@ paths: post: tags: - Template - summary: 'Create Template' + summary: 'Create Template' description: 'Creates a template that can then be used.' operationId: templateCreate requestBody: @@ -10372,27 +10372,27 @@ components: description: 'Details concerning remaining monthly quotas.' properties: api_signature_requests_left: - description: 'API signature requests remaining.' + description: 'API signature requests remaining. A value of `-1` means unlimited.' type: integer nullable: true documents_left: - description: 'Signature requests remaining.' + description: 'Signature requests remaining. A value of `-1` means unlimited.' type: integer nullable: true templates_total: - description: 'Total API templates allowed.' + description: 'Total API templates allowed. A value of `-1` means unlimited.' type: integer nullable: true templates_left: - description: 'API templates remaining.' + description: 'API templates remaining. A value of `-1` means unlimited.' type: integer nullable: true sms_verifications_left: - description: 'SMS verifications remaining.' + description: 'SMS verifications remaining.' type: integer nullable: true num_fax_pages_left: - description: 'Number of fax pages left' + description: 'Number of fax pages left. A value of `-1` means unlimited.' type: integer nullable: true type: object diff --git a/openapi.yaml b/openapi.yaml index d66309216..d7a6c443b 100644 --- a/openapi.yaml +++ b/openapi.yaml @@ -2703,7 +2703,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. @@ -5440,7 +5440,7 @@ paths: post: tags: - Template - summary: 'Create Template' + summary: 'Create Template' description: 'Creates a template that can then be used.' operationId: templateCreate requestBody: @@ -10350,27 +10350,27 @@ components: description: 'Details concerning remaining monthly quotas.' properties: api_signature_requests_left: - description: 'API signature requests remaining.' + description: 'API signature requests remaining. A value of `-1` means unlimited.' type: integer nullable: true documents_left: - description: 'Signature requests remaining.' + description: 'Signature requests remaining. A value of `-1` means unlimited.' type: integer nullable: true templates_total: - description: 'Total API templates allowed.' + description: 'Total API templates allowed. A value of `-1` means unlimited.' type: integer nullable: true templates_left: - description: 'API templates remaining.' + description: 'API templates remaining. A value of `-1` means unlimited.' type: integer nullable: true sms_verifications_left: - description: 'SMS verifications remaining.' + description: 'SMS verifications remaining.' type: integer nullable: true num_fax_pages_left: - description: 'Number of fax pages left' + description: 'Number of fax pages left. A value of `-1` means unlimited.' type: integer nullable: true type: object 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..4baee19ee 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. A value of `-1` means unlimited. | [optional] **DocumentsLeft** | **int?** | Signature requests remaining. A value of `-1` means unlimited. | [optional] **TemplatesTotal** | **int?** | Total API templates allowed. A value of `-1` means unlimited. | [optional] **TemplatesLeft** | **int?** | API templates remaining. A value of `-1` means unlimited. | [optional] **SmsVerificationsLeft** | **int?** | SMS verifications remaining. | [optional] **NumFaxPagesLeft** | **int?** | Number of fax pages left. A value of `-1` means unlimited. | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/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..c12ae8742 100644 --- a/sdks/dotnet/src/Dropbox.Sign/Model/AccountResponseQuotas.cs +++ b/sdks/dotnet/src/Dropbox.Sign/Model/AccountResponseQuotas.cs @@ -41,12 +41,12 @@ 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. + /// API signature requests remaining. A value of `-1` means unlimited.. + /// Signature requests remaining. A value of `-1` means unlimited.. + /// Total API templates allowed. A value of `-1` means unlimited.. + /// API templates remaining. A value of `-1` means unlimited.. + /// SMS verifications remaining.. + /// Number of fax pages left. A value of `-1` means unlimited.. 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?)) { @@ -75,44 +75,44 @@ public static AccountResponseQuotas Init(string jsonData) } /// - /// API signature requests remaining. + /// API signature requests remaining. A value of `-1` means unlimited. /// - /// API signature requests remaining. + /// API signature requests remaining. A value of `-1` means unlimited. [DataMember(Name = "api_signature_requests_left", EmitDefaultValue = true)] public int? ApiSignatureRequestsLeft { get; set; } /// - /// Signature requests remaining. + /// Signature requests remaining. A value of `-1` means unlimited. /// - /// Signature requests remaining. + /// Signature requests remaining. A value of `-1` means unlimited. [DataMember(Name = "documents_left", EmitDefaultValue = true)] public int? DocumentsLeft { get; set; } /// - /// Total API templates allowed. + /// Total API templates allowed. A value of `-1` means unlimited. /// - /// Total API templates allowed. + /// Total API templates allowed. A value of `-1` means unlimited. [DataMember(Name = "templates_total", EmitDefaultValue = true)] public int? TemplatesTotal { get; set; } /// - /// API templates remaining. + /// API templates remaining. A value of `-1` means unlimited. /// - /// API templates remaining. + /// API templates remaining. A value of `-1` means unlimited. [DataMember(Name = "templates_left", EmitDefaultValue = true)] 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; } /// - /// Number of fax pages left + /// Number of fax pages left. A value of `-1` means unlimited. /// - /// Number of fax pages left + /// Number of fax pages left. A value of `-1` means unlimited. [DataMember(Name = "num_fax_pages_left", EmitDefaultValue = true)] public int? NumFaxPagesLeft { get; set; } 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..91f28f23c 100644 --- a/sdks/java-v1/docs/AccountResponseQuotas.md +++ b/sdks/java-v1/docs/AccountResponseQuotas.md @@ -8,12 +8,12 @@ Details concerning remaining monthly quotas. | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| -| `apiSignatureRequestsLeft` | ```Integer``` | API signature requests remaining. | | -| `documentsLeft` | ```Integer``` | Signature requests remaining. | | -| `templatesTotal` | ```Integer``` | Total API templates allowed. | | -| `templatesLeft` | ```Integer``` | API templates remaining. | | -| `smsVerificationsLeft` | ```Integer``` | SMS verifications remaining. | | -| `numFaxPagesLeft` | ```Integer``` | Number of fax pages left | | +| `apiSignatureRequestsLeft` | ```Integer``` | API signature requests remaining. A value of `-1` means unlimited. | | +| `documentsLeft` | ```Integer``` | Signature requests remaining. A value of `-1` means unlimited. | | +| `templatesTotal` | ```Integer``` | Total API templates allowed. A value of `-1` means unlimited. | | +| `templatesLeft` | ```Integer``` | API templates remaining. A value of `-1` means unlimited. | | +| `smsVerificationsLeft` | ```Integer``` | SMS verifications remaining. | | +| `numFaxPagesLeft` | ```Integer``` | Number of fax pages left. A value of `-1` means unlimited. | | 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..5cfec7e79 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 @@ -79,7 +79,7 @@ public AccountResponseQuotas apiSignatureRequestsLeft(Integer apiSignatureReques } /** - * API signature requests remaining. + * API signature requests remaining. A value of `-1` means unlimited. * * @return apiSignatureRequestsLeft */ @@ -101,7 +101,7 @@ public AccountResponseQuotas documentsLeft(Integer documentsLeft) { } /** - * Signature requests remaining. + * Signature requests remaining. A value of `-1` means unlimited. * * @return documentsLeft */ @@ -123,7 +123,7 @@ public AccountResponseQuotas templatesTotal(Integer templatesTotal) { } /** - * Total API templates allowed. + * Total API templates allowed. A value of `-1` means unlimited. * * @return templatesTotal */ @@ -145,7 +145,7 @@ public AccountResponseQuotas templatesLeft(Integer templatesLeft) { } /** - * API templates remaining. + * API templates remaining. A value of `-1` means unlimited. * * @return templatesLeft */ @@ -189,7 +189,7 @@ public AccountResponseQuotas numFaxPagesLeft(Integer numFaxPagesLeft) { } /** - * Number of fax pages left + * Number of fax pages left. A value of `-1` means unlimited. * * @return numFaxPagesLeft */ 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..91f28f23c 100644 --- a/sdks/java-v2/docs/AccountResponseQuotas.md +++ b/sdks/java-v2/docs/AccountResponseQuotas.md @@ -8,12 +8,12 @@ Details concerning remaining monthly quotas. | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| -| `apiSignatureRequestsLeft` | ```Integer``` | API signature requests remaining. | | -| `documentsLeft` | ```Integer``` | Signature requests remaining. | | -| `templatesTotal` | ```Integer``` | Total API templates allowed. | | -| `templatesLeft` | ```Integer``` | API templates remaining. | | -| `smsVerificationsLeft` | ```Integer``` | SMS verifications remaining. | | -| `numFaxPagesLeft` | ```Integer``` | Number of fax pages left | | +| `apiSignatureRequestsLeft` | ```Integer``` | API signature requests remaining. A value of `-1` means unlimited. | | +| `documentsLeft` | ```Integer``` | Signature requests remaining. A value of `-1` means unlimited. | | +| `templatesTotal` | ```Integer``` | Total API templates allowed. A value of `-1` means unlimited. | | +| `templatesLeft` | ```Integer``` | API templates remaining. A value of `-1` means unlimited. | | +| `smsVerificationsLeft` | ```Integer``` | SMS verifications remaining. | | +| `numFaxPagesLeft` | ```Integer``` | Number of fax pages left. A value of `-1` means unlimited. | | 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..c7a98d521 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 @@ -85,7 +85,7 @@ public AccountResponseQuotas apiSignatureRequestsLeft(Integer apiSignatureReques } /** - * API signature requests remaining. + * API signature requests remaining. A value of `-1` means unlimited. * @return apiSignatureRequestsLeft */ @jakarta.annotation.Nullable @@ -110,7 +110,7 @@ public AccountResponseQuotas documentsLeft(Integer documentsLeft) { } /** - * Signature requests remaining. + * Signature requests remaining. A value of `-1` means unlimited. * @return documentsLeft */ @jakarta.annotation.Nullable @@ -135,7 +135,7 @@ public AccountResponseQuotas templatesTotal(Integer templatesTotal) { } /** - * Total API templates allowed. + * Total API templates allowed. A value of `-1` means unlimited. * @return templatesTotal */ @jakarta.annotation.Nullable @@ -160,7 +160,7 @@ public AccountResponseQuotas templatesLeft(Integer templatesLeft) { } /** - * API templates remaining. + * API templates remaining. A value of `-1` means unlimited. * @return templatesLeft */ @jakarta.annotation.Nullable @@ -185,7 +185,7 @@ public AccountResponseQuotas smsVerificationsLeft(Integer smsVerificationsLeft) } /** - * SMS verifications remaining. + * SMS verifications remaining. * @return smsVerificationsLeft */ @jakarta.annotation.Nullable @@ -210,7 +210,7 @@ public AccountResponseQuotas numFaxPagesLeft(Integer numFaxPagesLeft) { } /** - * Number of fax pages left + * Number of fax pages left. A value of `-1` means unlimited. * @return numFaxPagesLeft */ @jakarta.annotation.Nullable 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/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..8c4c5c60d 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. A value of `-1` means unlimited. | | +| `documentsLeft` | ```number``` | Signature requests remaining. A value of `-1` means unlimited. | | +| `templatesTotal` | ```number``` | Total API templates allowed. A value of `-1` means unlimited. | | +| `templatesLeft` | ```number``` | API templates remaining. A value of `-1` means unlimited. | | +| `smsVerificationsLeft` | ```number``` | SMS verifications remaining. | | +| `numFaxPagesLeft` | ```number``` | Number of fax pages left. A value of `-1` means unlimited. | | [[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..ee01a1625 100644 --- a/sdks/node/model/accountResponseQuotas.ts +++ b/sdks/node/model/accountResponseQuotas.ts @@ -29,27 +29,27 @@ import { AttributeTypeMap, ObjectSerializer } from "./"; */ export class AccountResponseQuotas { /** - * API signature requests remaining. + * API signature requests remaining. A value of `-1` means unlimited. */ "apiSignatureRequestsLeft"?: number | null; /** - * Signature requests remaining. + * Signature requests remaining. A value of `-1` means unlimited. */ "documentsLeft"?: number | null; /** - * Total API templates allowed. + * Total API templates allowed. A value of `-1` means unlimited. */ "templatesTotal"?: number | null; /** - * API templates remaining. + * API templates remaining. A value of `-1` means unlimited. */ "templatesLeft"?: number | null; /** - * SMS verifications remaining. + * SMS verifications remaining. */ "smsVerificationsLeft"?: number | null; /** - * Number of fax pages left + * Number of fax pages left. A value of `-1` means unlimited. */ "numFaxPagesLeft"?: number | null; 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..a82da8629 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. A value of `-1` means unlimited. | | +| `documents_left` | ```int``` | Signature requests remaining. A value of `-1` means unlimited. | | +| `templates_total` | ```int``` | Total API templates allowed. A value of `-1` means unlimited. | | +| `templates_left` | ```int``` | API templates remaining. A value of `-1` means unlimited. | | +| `sms_verifications_left` | ```int``` | SMS verifications remaining. | | +| `num_fax_pages_left` | ```int``` | Number of fax pages left. A value of `-1` means unlimited. | | [[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..a50c72634 100644 --- a/sdks/php/src/Model/AccountResponseQuotas.php +++ b/sdks/php/src/Model/AccountResponseQuotas.php @@ -343,7 +343,7 @@ public function getApiSignatureRequestsLeft() /** * Sets api_signature_requests_left * - * @param int|null $api_signature_requests_left API signature requests remaining + * @param int|null $api_signature_requests_left API signature requests remaining. A value of `-1` means unlimited. * * @return self */ @@ -377,7 +377,7 @@ public function getDocumentsLeft() /** * Sets documents_left * - * @param int|null $documents_left signature requests remaining + * @param int|null $documents_left Signature requests remaining. A value of `-1` means unlimited. * * @return self */ @@ -411,7 +411,7 @@ public function getTemplatesTotal() /** * Sets templates_total * - * @param int|null $templates_total total API templates allowed + * @param int|null $templates_total Total API templates allowed. A value of `-1` means unlimited. * * @return self */ @@ -445,7 +445,7 @@ public function getTemplatesLeft() /** * Sets templates_left * - * @param int|null $templates_left API templates remaining + * @param int|null $templates_left API templates remaining. A value of `-1` means unlimited. * * @return self */ @@ -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 */ @@ -513,7 +513,7 @@ public function getNumFaxPagesLeft() /** * Sets num_fax_pages_left * - * @param int|null $num_fax_pages_left Number of fax pages left + * @param int|null $num_fax_pages_left Number of fax pages left. A value of `-1` means unlimited. * * @return self */ 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..15dd521bf 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. A value of `-1` means unlimited. | | +| `documents_left` | ```int``` | Signature requests remaining. A value of `-1` means unlimited. | | +| `templates_total` | ```int``` | Total API templates allowed. A value of `-1` means unlimited. | | +| `templates_left` | ```int``` | API templates remaining. A value of `-1` means unlimited. | | +| `sms_verifications_left` | ```int``` | SMS verifications remaining. | | +| `num_fax_pages_left` | ```int``` | Number of fax pages left. A value of `-1` means unlimited. | | [[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..2a70521b1 100644 --- a/sdks/python/dropbox_sign/models/account_response_quotas.py +++ b/sdks/python/dropbox_sign/models/account_response_quotas.py @@ -33,22 +33,27 @@ class AccountResponseQuotas(BaseModel): """ # noqa: E501 api_signature_requests_left: Optional[StrictInt] = Field( - default=None, description="API signature requests remaining." + default=None, + description="API signature requests remaining. A value of `-1` means unlimited.", ) documents_left: Optional[StrictInt] = Field( - default=None, description="Signature requests remaining." + default=None, + description="Signature requests remaining. A value of `-1` means unlimited.", ) templates_total: Optional[StrictInt] = Field( - default=None, description="Total API templates allowed." + default=None, + description="Total API templates allowed. A value of `-1` means unlimited.", ) templates_left: Optional[StrictInt] = Field( - default=None, description="API templates remaining." + default=None, + description="API templates remaining. A value of `-1` means unlimited.", ) sms_verifications_left: Optional[StrictInt] = Field( - default=None, description="SMS verifications remaining." + default=None, description="SMS verifications remaining." ) num_fax_pages_left: Optional[StrictInt] = Field( - default=None, description="Number of fax pages left" + default=None, + description="Number of fax pages left. A value of `-1` means unlimited.", ) __properties: ClassVar[List[str]] = [ "api_signature_requests_left", 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..044f3cf0a 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. A value of `-1` means unlimited. | | +| `documents_left` | ```Integer``` | Signature requests remaining. A value of `-1` means unlimited. | | +| `templates_total` | ```Integer``` | Total API templates allowed. A value of `-1` means unlimited. | | +| `templates_left` | ```Integer``` | API templates remaining. A value of `-1` means unlimited. | | +| `sms_verifications_left` | ```Integer``` | SMS verifications remaining. | | +| `num_fax_pages_left` | ```Integer``` | Number of fax pages left. A value of `-1` means unlimited. | | 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..04f549a76 100644 --- a/sdks/ruby/lib/dropbox-sign/models/account_response_quotas.rb +++ b/sdks/ruby/lib/dropbox-sign/models/account_response_quotas.rb @@ -19,27 +19,27 @@ module Dropbox module Dropbox::Sign # Details concerning remaining monthly quotas. class AccountResponseQuotas - # API signature requests remaining. + # API signature requests remaining. A value of `-1` means unlimited. # @return [Integer, nil] attr_accessor :api_signature_requests_left - # Signature requests remaining. + # Signature requests remaining. A value of `-1` means unlimited. # @return [Integer, nil] attr_accessor :documents_left - # Total API templates allowed. + # Total API templates allowed. A value of `-1` means unlimited. # @return [Integer, nil] attr_accessor :templates_total - # API templates remaining. + # API templates remaining. A value of `-1` means unlimited. # @return [Integer, nil] attr_accessor :templates_left - # SMS verifications remaining. + # SMS verifications remaining. # @return [Integer, nil] attr_accessor :sms_verifications_left - # Number of fax pages left + # Number of fax pages left. A value of `-1` means unlimited. # @return [Integer, nil] attr_accessor :num_fax_pages_left diff --git a/translations/en.yaml b/translations/en.yaml index 5cbf3ca41..8e1a992b4 100644 --- a/translations/en.yaml +++ b/translations/en.yaml @@ -273,7 +273,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. @@ -642,7 +642,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. @@ -766,7 +766,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. @@ -816,7 +816,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. @@ -1195,12 +1195,12 @@ "Account::LOCALE": The locale used in this Account. Check out the list of [supported locales](/api/reference/constants/#supported-locales) to learn more about the possible values. "Account::QUOTA": Details concerning remaining monthly quotas. "Account::USAGE": Details concerning monthly usage -"AccountQuota::TEMPLATES_LEFT": API templates remaining. -"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::NUM_FAX_PAGES_LEFT": Number of fax pages left +"AccountQuota::TEMPLATES_LEFT": API templates remaining. A value of `-1` means unlimited. +"AccountQuota::TEMPLATES_TOTAL": Total API templates allowed. A value of `-1` means unlimited. +"AccountQuota::API_SIGNATURE_REQUESTS_LEFT": API signature requests remaining. A value of `-1` means unlimited. +"AccountQuota::DOCUMENTS_LEFT": Signature requests remaining. A value of `-1` means unlimited. +"AccountQuota::SMS_VERIFICATIONS_LEFT": SMS verifications remaining. +"AccountQuota::NUM_FAX_PAGES_LEFT": Number of fax pages left. A value of `-1` means unlimited. "AccountUsage::FAX_PAGES_SENT": Number of fax pages sent "ApiAppCreateResponseExample::SUMMARY": API App @@ -1256,7 +1256,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 --** From 3c6b9cbf72d1d53a64377c95227b684c34bcf36b Mon Sep 17 00:00:00 2001 From: Juan Treminio Date: Thu, 10 Oct 2024 11:33:48 -0500 Subject: [PATCH 2/4] Improvements to Account response; reduces nullability, sets defaults --- openapi-raw.yaml | 16 ++- openapi-sdk.yaml | 16 ++- openapi.yaml | 16 ++- sdks/dotnet/docs/AccountResponse.md | 2 +- sdks/dotnet/docs/AccountResponseQuotas.md | 2 +- sdks/dotnet/docs/AccountResponseUsage.md | 2 +- .../src/Dropbox.Sign/Model/AccountResponse.cs | 80 ++++++----- .../Model/AccountResponseQuotas.cs | 32 +++-- .../Model/AccountResponseUsage.cs | 18 +-- sdks/java-v1/docs/AccountResponse.md | 10 +- sdks/java-v1/docs/AccountResponseUsage.md | 2 +- .../dropbox/sign/model/AccountResponse.java | 133 +++++++++--------- .../sign/model/AccountResponseQuotas.java | 12 +- .../sign/model/AccountResponseUsage.java | 9 +- sdks/java-v2/docs/AccountResponse.md | 10 +- sdks/java-v2/docs/AccountResponseUsage.md | 2 +- .../dropbox/sign/model/AccountResponse.java | 132 ++++++++--------- .../sign/model/AccountResponseQuotas.java | 12 +- .../sign/model/AccountResponseUsage.java | 8 +- sdks/node/dist/api.js | 21 ++- sdks/node/docs/model/AccountResponse.md | 10 +- sdks/node/docs/model/AccountResponseQuotas.md | 12 +- sdks/node/docs/model/AccountResponseUsage.md | 2 +- sdks/node/model/accountResponse.ts | 28 ++-- sdks/node/model/accountResponseQuotas.ts | 12 +- sdks/node/model/accountResponseUsage.ts | 2 +- sdks/node/types/model/accountResponse.d.ts | 10 +- .../types/model/accountResponseUsage.d.ts | 2 +- sdks/php/docs/Model/AccountResponse.md | 10 +- sdks/php/docs/Model/AccountResponseQuotas.md | 12 +- sdks/php/docs/Model/AccountResponseUsage.md | 2 +- sdks/php/src/Model/AccountResponse.php | 117 ++++++++------- sdks/php/src/Model/AccountResponseQuotas.php | 12 +- sdks/php/src/Model/AccountResponseUsage.php | 27 ++-- sdks/python/docs/AccountResponse.md | 10 +- sdks/python/docs/AccountResponseQuotas.md | 12 +- sdks/python/docs/AccountResponseUsage.md | 2 +- .../dropbox_sign/models/account_response.py | 31 ++-- .../models/account_response_quotas.py | 48 +++++-- .../models/account_response_usage.py | 16 ++- sdks/ruby/docs/AccountResponse.md | 10 +- sdks/ruby/docs/AccountResponseQuotas.md | 12 +- sdks/ruby/docs/AccountResponseUsage.md | 2 +- .../dropbox-sign/models/account_response.rb | 49 +++++-- .../models/account_response_quotas.rb | 12 ++ .../models/account_response_usage.rb | 10 +- 46 files changed, 581 insertions(+), 426 deletions(-) diff --git a/openapi-raw.yaml b/openapi-raw.yaml index 302eb4482..6b7f03da3 100644 --- a/openapi-raw.yaml +++ b/openapi-raw.yaml @@ -9706,6 +9706,12 @@ components: type: object x-internal-class: true AccountResponse: + required: + - account_id + - is_locked + - is_paid_hs + - is_paid_hf + - quotas properties: account_id: description: '_t__Account::ACCOUNT_ID' @@ -9766,36 +9772,44 @@ 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 AccountResponseUsage: description: '_t__Account::USAGE' + required: + - fax_pages_sent properties: 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 e8684be1b..e2ae8a09f 100644 --- a/openapi-sdk.yaml +++ b/openapi-sdk.yaml @@ -10314,6 +10314,12 @@ components: type: object x-internal-class: true AccountResponse: + required: + - account_id + - is_locked + - is_paid_hs + - is_paid_hf + - quotas properties: account_id: description: 'The ID of the Account' @@ -10374,36 +10380,44 @@ components: api_signature_requests_left: description: 'API signature requests remaining. A value of `-1` means unlimited.' type: integer + default: 0 nullable: true documents_left: description: 'Signature requests remaining. A value of `-1` means unlimited.' type: integer + default: 0 nullable: true templates_total: description: 'Total API templates allowed. A value of `-1` means unlimited.' type: integer + default: 0 nullable: true templates_left: description: 'API templates remaining. A value of `-1` means unlimited.' type: integer + default: 0 nullable: true sms_verifications_left: description: 'SMS verifications remaining.' type: integer + default: 0 nullable: true num_fax_pages_left: description: 'Number of fax pages left. A value of `-1` means unlimited.' type: integer + default: 0 nullable: true type: object x-internal-class: true AccountResponseUsage: description: 'Details concerning monthly usage' + required: + - fax_pages_sent properties: 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 d7a6c443b..19be8315e 100644 --- a/openapi.yaml +++ b/openapi.yaml @@ -10292,6 +10292,12 @@ components: type: object x-internal-class: true AccountResponse: + required: + - account_id + - is_locked + - is_paid_hs + - is_paid_hf + - quotas properties: account_id: description: 'The ID of the Account' @@ -10352,36 +10358,44 @@ components: api_signature_requests_left: description: 'API signature requests remaining. A value of `-1` means unlimited.' type: integer + default: 0 nullable: true documents_left: description: 'Signature requests remaining. A value of `-1` means unlimited.' type: integer + default: 0 nullable: true templates_total: description: 'Total API templates allowed. A value of `-1` means unlimited.' type: integer + default: 0 nullable: true templates_left: description: 'API templates remaining. A value of `-1` means unlimited.' type: integer + default: 0 nullable: true sms_verifications_left: description: 'SMS verifications remaining.' type: integer + default: 0 nullable: true num_fax_pages_left: description: 'Number of fax pages left. A value of `-1` means unlimited.' type: integer + default: 0 nullable: true type: object x-internal-class: true AccountResponseUsage: description: 'Details concerning monthly usage' + required: + - fax_pages_sent properties: 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/docs/AccountResponse.md b/sdks/dotnet/docs/AccountResponse.md index 2f9672466..8b57e4692 100644 --- a/sdks/dotnet/docs/AccountResponse.md +++ b/sdks/dotnet/docs/AccountResponse.md @@ -4,7 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**AccountId** | **string** | The ID of the Account | [optional] **EmailAddress** | **string** | The email address associated with the Account. | [optional] **IsLocked** | **bool** | Returns `true` if the user has been locked out of their account by a team admin. | [optional] **IsPaidHs** | **bool** | Returns `true` if the user has a paid Dropbox Sign account. | [optional] **IsPaidHf** | **bool** | Returns `true` if the user has a paid HelloFax account. | [optional] **Quotas** | [**AccountResponseQuotas**](AccountResponseQuotas.md) | | [optional] **CallbackUrl** | **string** | The URL that Dropbox Sign events will `POST` to. | [optional] **RoleCode** | **string** | The membership role for the team. | [optional] **TeamId** | **string** | The id of the team account belongs to. | [optional] **Locale** | **string** | The locale used in this Account. Check out the list of [supported locales](/api/reference/constants/#supported-locales) to learn more about the possible values. | [optional] **Usage** | [**AccountResponseUsage**](AccountResponseUsage.md) | | [optional] +**AccountId** | **string** | The ID of the Account | **IsLocked** | **bool** | Returns `true` if the user has been locked out of their account by a team admin. | **IsPaidHs** | **bool** | Returns `true` if the user has a paid Dropbox Sign account. | **IsPaidHf** | **bool** | Returns `true` if the user has a paid HelloFax account. | **Quotas** | [**AccountResponseQuotas**](AccountResponseQuotas.md) | | **EmailAddress** | **string** | The email address associated with the Account. | [optional] **CallbackUrl** | **string** | The URL that Dropbox Sign events will `POST` to. | [optional] **RoleCode** | **string** | The membership role for the team. | [optional] **TeamId** | **string** | The id of the team account belongs to. | [optional] **Locale** | **string** | The locale used in this Account. Check out the list of [supported locales](/api/reference/constants/#supported-locales) to learn more about the possible values. | [optional] **Usage** | [**AccountResponseUsage**](AccountResponseUsage.md) | | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/sdks/dotnet/docs/AccountResponseQuotas.md b/sdks/dotnet/docs/AccountResponseQuotas.md index 4baee19ee..8dd046fa5 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. A value of `-1` means unlimited. | [optional] **DocumentsLeft** | **int?** | Signature requests remaining. A value of `-1` means unlimited. | [optional] **TemplatesTotal** | **int?** | Total API templates allowed. A value of `-1` means unlimited. | [optional] **TemplatesLeft** | **int?** | API templates remaining. A value of `-1` means unlimited. | [optional] **SmsVerificationsLeft** | **int?** | SMS verifications remaining. | [optional] **NumFaxPagesLeft** | **int?** | Number of fax pages left. A value of `-1` means unlimited. | [optional] +**ApiSignatureRequestsLeft** | **int?** | API signature requests remaining. A value of `-1` means unlimited. | [optional] [default to 0]**DocumentsLeft** | **int?** | Signature requests remaining. A value of `-1` means unlimited. | [optional] [default to 0]**TemplatesTotal** | **int?** | Total API templates allowed. A value of `-1` means unlimited. | [optional] [default to 0]**TemplatesLeft** | **int?** | API templates remaining. A value of `-1` means unlimited. | [optional] [default to 0]**SmsVerificationsLeft** | **int?** | SMS verifications remaining. | [optional] [default to 0]**NumFaxPagesLeft** | **int?** | Number of fax pages left. A value of `-1` means unlimited. | [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..9cd85a179 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 | [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/src/Dropbox.Sign/Model/AccountResponse.cs b/sdks/dotnet/src/Dropbox.Sign/Model/AccountResponse.cs index 6d65726d7..a67bff328 100644 --- a/sdks/dotnet/src/Dropbox.Sign/Model/AccountResponse.cs +++ b/sdks/dotnet/src/Dropbox.Sign/Model/AccountResponse.cs @@ -41,12 +41,12 @@ protected AccountResponse() { } /// /// Initializes a new instance of the class. /// - /// The ID of the Account. + /// The ID of the Account (required). /// The email address associated with the Account.. - /// Returns `true` if the user has been locked out of their account by a team admin.. - /// Returns `true` if the user has a paid Dropbox Sign account.. - /// Returns `true` if the user has a paid HelloFax account.. - /// quotas. + /// Returns `true` if the user has been locked out of their account by a team admin. (required). + /// Returns `true` if the user has a paid Dropbox Sign account. (required). + /// Returns `true` if the user has a paid HelloFax account. (required). + /// quotas (required). /// The URL that Dropbox Sign events will `POST` to.. /// The membership role for the team.. /// The id of the team account belongs to.. @@ -55,12 +55,22 @@ protected AccountResponse() { } public AccountResponse(string accountId = default(string), string emailAddress = default(string), bool isLocked = default(bool), bool isPaidHs = default(bool), bool isPaidHf = default(bool), AccountResponseQuotas quotas = default(AccountResponseQuotas), string callbackUrl = default(string), string roleCode = default(string), string teamId = default(string), string locale = default(string), AccountResponseUsage usage = default(AccountResponseUsage)) { + // to ensure "accountId" is required (not null) + if (accountId == null) + { + throw new ArgumentNullException("accountId is a required property for AccountResponse and cannot be null"); + } this.AccountId = accountId; - this.EmailAddress = emailAddress; this.IsLocked = isLocked; this.IsPaidHs = isPaidHs; this.IsPaidHf = isPaidHf; + // to ensure "quotas" is required (not null) + if (quotas == null) + { + throw new ArgumentNullException("quotas is a required property for AccountResponse and cannot be null"); + } this.Quotas = quotas; + this.EmailAddress = emailAddress; this.CallbackUrl = callbackUrl; this.RoleCode = roleCode; this.TeamId = teamId; @@ -88,43 +98,43 @@ public static AccountResponse Init(string jsonData) /// The ID of the Account /// /// The ID of the Account - [DataMember(Name = "account_id", EmitDefaultValue = true)] + [DataMember(Name = "account_id", IsRequired = true, EmitDefaultValue = true)] public string AccountId { get; set; } - /// - /// The email address associated with the Account. - /// - /// The email address associated with the Account. - [DataMember(Name = "email_address", EmitDefaultValue = true)] - public string EmailAddress { get; set; } - /// /// Returns `true` if the user has been locked out of their account by a team admin. /// /// Returns `true` if the user has been locked out of their account by a team admin. - [DataMember(Name = "is_locked", EmitDefaultValue = true)] + [DataMember(Name = "is_locked", IsRequired = true, EmitDefaultValue = true)] public bool IsLocked { get; set; } /// /// Returns `true` if the user has a paid Dropbox Sign account. /// /// Returns `true` if the user has a paid Dropbox Sign account. - [DataMember(Name = "is_paid_hs", EmitDefaultValue = true)] + [DataMember(Name = "is_paid_hs", IsRequired = true, EmitDefaultValue = true)] public bool IsPaidHs { get; set; } /// /// Returns `true` if the user has a paid HelloFax account. /// /// Returns `true` if the user has a paid HelloFax account. - [DataMember(Name = "is_paid_hf", EmitDefaultValue = true)] + [DataMember(Name = "is_paid_hf", IsRequired = true, EmitDefaultValue = true)] public bool IsPaidHf { get; set; } /// /// Gets or Sets Quotas /// - [DataMember(Name = "quotas", EmitDefaultValue = true)] + [DataMember(Name = "quotas", IsRequired = true, EmitDefaultValue = true)] public AccountResponseQuotas Quotas { get; set; } + /// + /// The email address associated with the Account. + /// + /// The email address associated with the Account. + [DataMember(Name = "email_address", EmitDefaultValue = true)] + public string EmailAddress { get; set; } + /// /// The URL that Dropbox Sign events will `POST` to. /// @@ -168,11 +178,11 @@ public override string ToString() StringBuilder sb = new StringBuilder(); sb.Append("class AccountResponse {\n"); sb.Append(" AccountId: ").Append(AccountId).Append("\n"); - sb.Append(" EmailAddress: ").Append(EmailAddress).Append("\n"); sb.Append(" IsLocked: ").Append(IsLocked).Append("\n"); sb.Append(" IsPaidHs: ").Append(IsPaidHs).Append("\n"); sb.Append(" IsPaidHf: ").Append(IsPaidHf).Append("\n"); sb.Append(" Quotas: ").Append(Quotas).Append("\n"); + sb.Append(" EmailAddress: ").Append(EmailAddress).Append("\n"); sb.Append(" CallbackUrl: ").Append(CallbackUrl).Append("\n"); sb.Append(" RoleCode: ").Append(RoleCode).Append("\n"); sb.Append(" TeamId: ").Append(TeamId).Append("\n"); @@ -218,11 +228,6 @@ public bool Equals(AccountResponse input) (this.AccountId != null && this.AccountId.Equals(input.AccountId)) ) && - ( - this.EmailAddress == input.EmailAddress || - (this.EmailAddress != null && - this.EmailAddress.Equals(input.EmailAddress)) - ) && ( this.IsLocked == input.IsLocked || this.IsLocked.Equals(input.IsLocked) @@ -240,6 +245,11 @@ public bool Equals(AccountResponse input) (this.Quotas != null && this.Quotas.Equals(input.Quotas)) ) && + ( + this.EmailAddress == input.EmailAddress || + (this.EmailAddress != null && + this.EmailAddress.Equals(input.EmailAddress)) + ) && ( this.CallbackUrl == input.CallbackUrl || (this.CallbackUrl != null && @@ -280,10 +290,6 @@ public override int GetHashCode() { hashCode = (hashCode * 59) + this.AccountId.GetHashCode(); } - if (this.EmailAddress != null) - { - hashCode = (hashCode * 59) + this.EmailAddress.GetHashCode(); - } hashCode = (hashCode * 59) + this.IsLocked.GetHashCode(); hashCode = (hashCode * 59) + this.IsPaidHs.GetHashCode(); hashCode = (hashCode * 59) + this.IsPaidHf.GetHashCode(); @@ -291,6 +297,10 @@ public override int GetHashCode() { hashCode = (hashCode * 59) + this.Quotas.GetHashCode(); } + if (this.EmailAddress != null) + { + hashCode = (hashCode * 59) + this.EmailAddress.GetHashCode(); + } if (this.CallbackUrl != null) { hashCode = (hashCode * 59) + this.CallbackUrl.GetHashCode(); @@ -335,13 +345,6 @@ public List GetOpenApiTypes() Value = AccountId, }); types.Add(new OpenApiType() - { - Name = "email_address", - Property = "EmailAddress", - Type = "string", - Value = EmailAddress, - }); - types.Add(new OpenApiType() { Name = "is_locked", Property = "IsLocked", @@ -370,6 +373,13 @@ public List GetOpenApiTypes() Value = Quotas, }); types.Add(new OpenApiType() + { + Name = "email_address", + Property = "EmailAddress", + Type = "string", + Value = EmailAddress, + }); + types.Add(new OpenApiType() { Name = "callback_url", Property = "CallbackUrl", diff --git a/sdks/dotnet/src/Dropbox.Sign/Model/AccountResponseQuotas.cs b/sdks/dotnet/src/Dropbox.Sign/Model/AccountResponseQuotas.cs index c12ae8742..6cc3fcb7c 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. A value of `-1` means unlimited.. - /// Signature requests remaining. A value of `-1` means unlimited.. - /// Total API templates allowed. A value of `-1` means unlimited.. - /// API templates remaining. A value of `-1` means unlimited.. - /// SMS verifications remaining.. - /// Number of fax pages left. A value of `-1` means unlimited.. - 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. A value of `-1` means unlimited. (default to 0). + /// Signature requests remaining. A value of `-1` means unlimited. (default to 0). + /// Total API templates allowed. A value of `-1` means unlimited. (default to 0). + /// API templates remaining. A value of `-1` means unlimited. (default to 0). + /// SMS verifications remaining. (default to 0). + /// Number of fax pages left. A value of `-1` means unlimited. (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; } /// diff --git a/sdks/dotnet/src/Dropbox.Sign/Model/AccountResponseUsage.cs b/sdks/dotnet/src/Dropbox.Sign/Model/AccountResponseUsage.cs index bd9e2e5ac..06d953041 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 (required) (default to 0). + public AccountResponseUsage(int faxPagesSent = 0) { this.FaxPagesSent = faxPagesSent; @@ -68,8 +68,8 @@ public static AccountResponseUsage Init(string jsonData) /// Number of fax pages sent /// /// Number of fax pages sent - [DataMember(Name = "fax_pages_sent", EmitDefaultValue = true)] - public int? FaxPagesSent { get; set; } + [DataMember(Name = "fax_pages_sent", IsRequired = true, EmitDefaultValue = true)] + 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/docs/AccountResponse.md b/sdks/java-v1/docs/AccountResponse.md index 5b73aa02d..000d9a54d 100644 --- a/sdks/java-v1/docs/AccountResponse.md +++ b/sdks/java-v1/docs/AccountResponse.md @@ -8,12 +8,12 @@ | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| -| `accountId` | ```String``` | The ID of the Account | | +| `accountId`*_required_ | ```String``` | The ID of the Account | | +| `isLocked`*_required_ | ```Boolean``` | Returns `true` if the user has been locked out of their account by a team admin. | | +| `isPaidHs`*_required_ | ```Boolean``` | Returns `true` if the user has a paid Dropbox Sign account. | | +| `isPaidHf`*_required_ | ```Boolean``` | Returns `true` if the user has a paid HelloFax account. | | +| `quotas`*_required_ | [```AccountResponseQuotas```](AccountResponseQuotas.md) | | | | `emailAddress` | ```String``` | The email address associated with the Account. | | -| `isLocked` | ```Boolean``` | Returns `true` if the user has been locked out of their account by a team admin. | | -| `isPaidHs` | ```Boolean``` | Returns `true` if the user has a paid Dropbox Sign account. | | -| `isPaidHf` | ```Boolean``` | Returns `true` if the user has a paid HelloFax account. | | -| `quotas` | [```AccountResponseQuotas```](AccountResponseQuotas.md) | | | | `callbackUrl` | ```String``` | The URL that Dropbox Sign events will `POST` to. | | | `roleCode` | ```String``` | The membership role for the team. | | | `teamId` | ```String``` | The id of the team account belongs to. | | diff --git a/sdks/java-v1/docs/AccountResponseUsage.md b/sdks/java-v1/docs/AccountResponseUsage.md index 1cdb76629..af34642c7 100644 --- a/sdks/java-v1/docs/AccountResponseUsage.md +++ b/sdks/java-v1/docs/AccountResponseUsage.md @@ -8,7 +8,7 @@ Details concerning monthly usage | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| -| `faxPagesSent` | ```Integer``` | Number of fax pages sent | | +| `faxPagesSent`*_required_ | ```Integer``` | Number of fax pages sent | | diff --git a/sdks/java-v1/src/main/java/com/dropbox/sign/model/AccountResponse.java b/sdks/java-v1/src/main/java/com/dropbox/sign/model/AccountResponse.java index 541c7f61d..8eaae02e1 100644 --- a/sdks/java-v1/src/main/java/com/dropbox/sign/model/AccountResponse.java +++ b/sdks/java-v1/src/main/java/com/dropbox/sign/model/AccountResponse.java @@ -26,11 +26,11 @@ /** AccountResponse */ @JsonPropertyOrder({ AccountResponse.JSON_PROPERTY_ACCOUNT_ID, - AccountResponse.JSON_PROPERTY_EMAIL_ADDRESS, AccountResponse.JSON_PROPERTY_IS_LOCKED, AccountResponse.JSON_PROPERTY_IS_PAID_HS, AccountResponse.JSON_PROPERTY_IS_PAID_HF, AccountResponse.JSON_PROPERTY_QUOTAS, + AccountResponse.JSON_PROPERTY_EMAIL_ADDRESS, AccountResponse.JSON_PROPERTY_CALLBACK_URL, AccountResponse.JSON_PROPERTY_ROLE_CODE, AccountResponse.JSON_PROPERTY_TEAM_ID, @@ -45,9 +45,6 @@ public class AccountResponse { public static final String JSON_PROPERTY_ACCOUNT_ID = "account_id"; private String accountId; - public static final String JSON_PROPERTY_EMAIL_ADDRESS = "email_address"; - private String emailAddress; - public static final String JSON_PROPERTY_IS_LOCKED = "is_locked"; private Boolean isLocked; @@ -60,6 +57,9 @@ public class AccountResponse { public static final String JSON_PROPERTY_QUOTAS = "quotas"; private AccountResponseQuotas quotas; + public static final String JSON_PROPERTY_EMAIL_ADDRESS = "email_address"; + private String emailAddress; + public static final String JSON_PROPERTY_CALLBACK_URL = "callback_url"; private String callbackUrl; @@ -101,40 +101,19 @@ public AccountResponse accountId(String accountId) { * * @return accountId */ - @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_ACCOUNT_ID) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @javax.annotation.Nonnull + @JsonProperty(JSON_PROPERTY_ACCOUNT_ID) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public String getAccountId() { return accountId; } @JsonProperty(JSON_PROPERTY_ACCOUNT_ID) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setAccountId(String accountId) { this.accountId = accountId; } - public AccountResponse emailAddress(String emailAddress) { - this.emailAddress = emailAddress; - return this; - } - - /** - * The email address associated with the Account. - * - * @return emailAddress - */ - @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_EMAIL_ADDRESS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public String getEmailAddress() { - return emailAddress; - } - - @JsonProperty(JSON_PROPERTY_EMAIL_ADDRESS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setEmailAddress(String emailAddress) { - this.emailAddress = emailAddress; - } - public AccountResponse isLocked(Boolean isLocked) { this.isLocked = isLocked; return this; @@ -145,14 +124,15 @@ public AccountResponse isLocked(Boolean isLocked) { * * @return isLocked */ - @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_IS_LOCKED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @javax.annotation.Nonnull + @JsonProperty(JSON_PROPERTY_IS_LOCKED) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public Boolean getIsLocked() { return isLocked; } @JsonProperty(JSON_PROPERTY_IS_LOCKED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setIsLocked(Boolean isLocked) { this.isLocked = isLocked; } @@ -167,14 +147,15 @@ public AccountResponse isPaidHs(Boolean isPaidHs) { * * @return isPaidHs */ - @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_IS_PAID_HS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @javax.annotation.Nonnull + @JsonProperty(JSON_PROPERTY_IS_PAID_HS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public Boolean getIsPaidHs() { return isPaidHs; } @JsonProperty(JSON_PROPERTY_IS_PAID_HS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setIsPaidHs(Boolean isPaidHs) { this.isPaidHs = isPaidHs; } @@ -189,14 +170,15 @@ public AccountResponse isPaidHf(Boolean isPaidHf) { * * @return isPaidHf */ - @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_IS_PAID_HF) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @javax.annotation.Nonnull + @JsonProperty(JSON_PROPERTY_IS_PAID_HF) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public Boolean getIsPaidHf() { return isPaidHf; } @JsonProperty(JSON_PROPERTY_IS_PAID_HF) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setIsPaidHf(Boolean isPaidHf) { this.isPaidHf = isPaidHf; } @@ -211,18 +193,41 @@ public AccountResponse quotas(AccountResponseQuotas quotas) { * * @return quotas */ - @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_QUOTAS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @javax.annotation.Nonnull + @JsonProperty(JSON_PROPERTY_QUOTAS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public AccountResponseQuotas getQuotas() { return quotas; } @JsonProperty(JSON_PROPERTY_QUOTAS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setQuotas(AccountResponseQuotas quotas) { this.quotas = quotas; } + public AccountResponse emailAddress(String emailAddress) { + this.emailAddress = emailAddress; + return this; + } + + /** + * The email address associated with the Account. + * + * @return emailAddress + */ + @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_EMAIL_ADDRESS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public String getEmailAddress() { + return emailAddress; + } + + @JsonProperty(JSON_PROPERTY_EMAIL_ADDRESS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setEmailAddress(String emailAddress) { + this.emailAddress = emailAddress; + } + public AccountResponse callbackUrl(String callbackUrl) { this.callbackUrl = callbackUrl; return this; @@ -346,11 +351,11 @@ public boolean equals(Object o) { } AccountResponse accountResponse = (AccountResponse) o; return Objects.equals(this.accountId, accountResponse.accountId) - && Objects.equals(this.emailAddress, accountResponse.emailAddress) && Objects.equals(this.isLocked, accountResponse.isLocked) && Objects.equals(this.isPaidHs, accountResponse.isPaidHs) && Objects.equals(this.isPaidHf, accountResponse.isPaidHf) && Objects.equals(this.quotas, accountResponse.quotas) + && Objects.equals(this.emailAddress, accountResponse.emailAddress) && Objects.equals(this.callbackUrl, accountResponse.callbackUrl) && Objects.equals(this.roleCode, accountResponse.roleCode) && Objects.equals(this.teamId, accountResponse.teamId) @@ -362,11 +367,11 @@ public boolean equals(Object o) { public int hashCode() { return Objects.hash( accountId, - emailAddress, isLocked, isPaidHs, isPaidHf, quotas, + emailAddress, callbackUrl, roleCode, teamId, @@ -379,11 +384,11 @@ public String toString() { StringBuilder sb = new StringBuilder(); sb.append("class AccountResponse {\n"); sb.append(" accountId: ").append(toIndentedString(accountId)).append("\n"); - sb.append(" emailAddress: ").append(toIndentedString(emailAddress)).append("\n"); sb.append(" isLocked: ").append(toIndentedString(isLocked)).append("\n"); sb.append(" isPaidHs: ").append(toIndentedString(isPaidHs)).append("\n"); sb.append(" isPaidHf: ").append(toIndentedString(isPaidHf)).append("\n"); sb.append(" quotas: ").append(toIndentedString(quotas)).append("\n"); + sb.append(" emailAddress: ").append(toIndentedString(emailAddress)).append("\n"); sb.append(" callbackUrl: ").append(toIndentedString(callbackUrl)).append("\n"); sb.append(" roleCode: ").append(toIndentedString(roleCode)).append("\n"); sb.append(" teamId: ").append(toIndentedString(teamId)).append("\n"); @@ -417,26 +422,6 @@ public Map createFormData() throws ApiException { JSON.getDefault().getMapper().writeValueAsString(accountId)); } } - if (emailAddress != null) { - if (isFileTypeOrListOfFiles(emailAddress)) { - fileTypeFound = true; - } - - if (emailAddress.getClass().equals(java.io.File.class) - || emailAddress.getClass().equals(Integer.class) - || emailAddress.getClass().equals(String.class) - || emailAddress.getClass().isEnum()) { - map.put("email_address", emailAddress); - } else if (isListOfFile(emailAddress)) { - for (int i = 0; i < getListSize(emailAddress); i++) { - map.put("email_address[" + i + "]", getFromList(emailAddress, i)); - } - } else { - map.put( - "email_address", - JSON.getDefault().getMapper().writeValueAsString(emailAddress)); - } - } if (isLocked != null) { if (isFileTypeOrListOfFiles(isLocked)) { fileTypeFound = true; @@ -515,6 +500,26 @@ public Map createFormData() throws ApiException { map.put("quotas", JSON.getDefault().getMapper().writeValueAsString(quotas)); } } + if (emailAddress != null) { + if (isFileTypeOrListOfFiles(emailAddress)) { + fileTypeFound = true; + } + + if (emailAddress.getClass().equals(java.io.File.class) + || emailAddress.getClass().equals(Integer.class) + || emailAddress.getClass().equals(String.class) + || emailAddress.getClass().isEnum()) { + map.put("email_address", emailAddress); + } else if (isListOfFile(emailAddress)) { + for (int i = 0; i < getListSize(emailAddress); i++) { + map.put("email_address[" + i + "]", getFromList(emailAddress, i)); + } + } else { + map.put( + "email_address", + JSON.getDefault().getMapper().writeValueAsString(emailAddress)); + } + } if (callbackUrl != null) { if (isFileTypeOrListOfFiles(callbackUrl)) { fileTypeFound = true; 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 5cfec7e79..9081f09f4 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..811367cdc 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() {} @@ -59,14 +59,15 @@ public AccountResponseUsage faxPagesSent(Integer faxPagesSent) { * * @return faxPagesSent */ - @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_FAX_PAGES_SENT) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @javax.annotation.Nonnull + @JsonProperty(JSON_PROPERTY_FAX_PAGES_SENT) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public Integer getFaxPagesSent() { return faxPagesSent; } @JsonProperty(JSON_PROPERTY_FAX_PAGES_SENT) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setFaxPagesSent(Integer faxPagesSent) { this.faxPagesSent = faxPagesSent; } diff --git a/sdks/java-v2/docs/AccountResponse.md b/sdks/java-v2/docs/AccountResponse.md index 5b73aa02d..000d9a54d 100644 --- a/sdks/java-v2/docs/AccountResponse.md +++ b/sdks/java-v2/docs/AccountResponse.md @@ -8,12 +8,12 @@ | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| -| `accountId` | ```String``` | The ID of the Account | | +| `accountId`*_required_ | ```String``` | The ID of the Account | | +| `isLocked`*_required_ | ```Boolean``` | Returns `true` if the user has been locked out of their account by a team admin. | | +| `isPaidHs`*_required_ | ```Boolean``` | Returns `true` if the user has a paid Dropbox Sign account. | | +| `isPaidHf`*_required_ | ```Boolean``` | Returns `true` if the user has a paid HelloFax account. | | +| `quotas`*_required_ | [```AccountResponseQuotas```](AccountResponseQuotas.md) | | | | `emailAddress` | ```String``` | The email address associated with the Account. | | -| `isLocked` | ```Boolean``` | Returns `true` if the user has been locked out of their account by a team admin. | | -| `isPaidHs` | ```Boolean``` | Returns `true` if the user has a paid Dropbox Sign account. | | -| `isPaidHf` | ```Boolean``` | Returns `true` if the user has a paid HelloFax account. | | -| `quotas` | [```AccountResponseQuotas```](AccountResponseQuotas.md) | | | | `callbackUrl` | ```String``` | The URL that Dropbox Sign events will `POST` to. | | | `roleCode` | ```String``` | The membership role for the team. | | | `teamId` | ```String``` | The id of the team account belongs to. | | diff --git a/sdks/java-v2/docs/AccountResponseUsage.md b/sdks/java-v2/docs/AccountResponseUsage.md index 1cdb76629..af34642c7 100644 --- a/sdks/java-v2/docs/AccountResponseUsage.md +++ b/sdks/java-v2/docs/AccountResponseUsage.md @@ -8,7 +8,7 @@ Details concerning monthly usage | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| -| `faxPagesSent` | ```Integer``` | Number of fax pages sent | | +| `faxPagesSent`*_required_ | ```Integer``` | Number of fax pages sent | | diff --git a/sdks/java-v2/src/main/java/com/dropbox/sign/model/AccountResponse.java b/sdks/java-v2/src/main/java/com/dropbox/sign/model/AccountResponse.java index 6f431abf6..405fe0b00 100644 --- a/sdks/java-v2/src/main/java/com/dropbox/sign/model/AccountResponse.java +++ b/sdks/java-v2/src/main/java/com/dropbox/sign/model/AccountResponse.java @@ -36,11 +36,11 @@ */ @JsonPropertyOrder({ AccountResponse.JSON_PROPERTY_ACCOUNT_ID, - AccountResponse.JSON_PROPERTY_EMAIL_ADDRESS, AccountResponse.JSON_PROPERTY_IS_LOCKED, AccountResponse.JSON_PROPERTY_IS_PAID_HS, AccountResponse.JSON_PROPERTY_IS_PAID_HF, AccountResponse.JSON_PROPERTY_QUOTAS, + AccountResponse.JSON_PROPERTY_EMAIL_ADDRESS, AccountResponse.JSON_PROPERTY_CALLBACK_URL, AccountResponse.JSON_PROPERTY_ROLE_CODE, AccountResponse.JSON_PROPERTY_TEAM_ID, @@ -53,9 +53,6 @@ public class AccountResponse { public static final String JSON_PROPERTY_ACCOUNT_ID = "account_id"; private String accountId; - public static final String JSON_PROPERTY_EMAIL_ADDRESS = "email_address"; - private String emailAddress; - public static final String JSON_PROPERTY_IS_LOCKED = "is_locked"; private Boolean isLocked; @@ -68,6 +65,9 @@ public class AccountResponse { public static final String JSON_PROPERTY_QUOTAS = "quotas"; private AccountResponseQuotas quotas; + public static final String JSON_PROPERTY_EMAIL_ADDRESS = "email_address"; + private String emailAddress; + public static final String JSON_PROPERTY_CALLBACK_URL = "callback_url"; private String callbackUrl; @@ -110,9 +110,9 @@ public AccountResponse accountId(String accountId) { * The ID of the Account * @return accountId */ - @jakarta.annotation.Nullable + @jakarta.annotation.Nonnull @JsonProperty(JSON_PROPERTY_ACCOUNT_ID) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public String getAccountId() { return accountId; @@ -120,37 +120,12 @@ public String getAccountId() { @JsonProperty(JSON_PROPERTY_ACCOUNT_ID) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setAccountId(String accountId) { this.accountId = accountId; } - public AccountResponse emailAddress(String emailAddress) { - this.emailAddress = emailAddress; - return this; - } - - /** - * The email address associated with the Account. - * @return emailAddress - */ - @jakarta.annotation.Nullable - @JsonProperty(JSON_PROPERTY_EMAIL_ADDRESS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getEmailAddress() { - return emailAddress; - } - - - @JsonProperty(JSON_PROPERTY_EMAIL_ADDRESS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setEmailAddress(String emailAddress) { - this.emailAddress = emailAddress; - } - - public AccountResponse isLocked(Boolean isLocked) { this.isLocked = isLocked; return this; @@ -160,9 +135,9 @@ public AccountResponse isLocked(Boolean isLocked) { * Returns `true` if the user has been locked out of their account by a team admin. * @return isLocked */ - @jakarta.annotation.Nullable + @jakarta.annotation.Nonnull @JsonProperty(JSON_PROPERTY_IS_LOCKED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public Boolean getIsLocked() { return isLocked; @@ -170,7 +145,7 @@ public Boolean getIsLocked() { @JsonProperty(JSON_PROPERTY_IS_LOCKED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setIsLocked(Boolean isLocked) { this.isLocked = isLocked; } @@ -185,9 +160,9 @@ public AccountResponse isPaidHs(Boolean isPaidHs) { * Returns `true` if the user has a paid Dropbox Sign account. * @return isPaidHs */ - @jakarta.annotation.Nullable + @jakarta.annotation.Nonnull @JsonProperty(JSON_PROPERTY_IS_PAID_HS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public Boolean getIsPaidHs() { return isPaidHs; @@ -195,7 +170,7 @@ public Boolean getIsPaidHs() { @JsonProperty(JSON_PROPERTY_IS_PAID_HS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setIsPaidHs(Boolean isPaidHs) { this.isPaidHs = isPaidHs; } @@ -210,9 +185,9 @@ public AccountResponse isPaidHf(Boolean isPaidHf) { * Returns `true` if the user has a paid HelloFax account. * @return isPaidHf */ - @jakarta.annotation.Nullable + @jakarta.annotation.Nonnull @JsonProperty(JSON_PROPERTY_IS_PAID_HF) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public Boolean getIsPaidHf() { return isPaidHf; @@ -220,7 +195,7 @@ public Boolean getIsPaidHf() { @JsonProperty(JSON_PROPERTY_IS_PAID_HF) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setIsPaidHf(Boolean isPaidHf) { this.isPaidHf = isPaidHf; } @@ -235,9 +210,9 @@ public AccountResponse quotas(AccountResponseQuotas quotas) { * Get quotas * @return quotas */ - @jakarta.annotation.Nullable + @jakarta.annotation.Nonnull @JsonProperty(JSON_PROPERTY_QUOTAS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public AccountResponseQuotas getQuotas() { return quotas; @@ -245,12 +220,37 @@ public AccountResponseQuotas getQuotas() { @JsonProperty(JSON_PROPERTY_QUOTAS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setQuotas(AccountResponseQuotas quotas) { this.quotas = quotas; } + public AccountResponse emailAddress(String emailAddress) { + this.emailAddress = emailAddress; + return this; + } + + /** + * The email address associated with the Account. + * @return emailAddress + */ + @jakarta.annotation.Nullable + @JsonProperty(JSON_PROPERTY_EMAIL_ADDRESS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public String getEmailAddress() { + return emailAddress; + } + + + @JsonProperty(JSON_PROPERTY_EMAIL_ADDRESS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setEmailAddress(String emailAddress) { + this.emailAddress = emailAddress; + } + + public AccountResponse callbackUrl(String callbackUrl) { this.callbackUrl = callbackUrl; return this; @@ -389,11 +389,11 @@ public boolean equals(Object o) { } AccountResponse accountResponse = (AccountResponse) o; return Objects.equals(this.accountId, accountResponse.accountId) && - Objects.equals(this.emailAddress, accountResponse.emailAddress) && Objects.equals(this.isLocked, accountResponse.isLocked) && Objects.equals(this.isPaidHs, accountResponse.isPaidHs) && Objects.equals(this.isPaidHf, accountResponse.isPaidHf) && Objects.equals(this.quotas, accountResponse.quotas) && + Objects.equals(this.emailAddress, accountResponse.emailAddress) && Objects.equals(this.callbackUrl, accountResponse.callbackUrl) && Objects.equals(this.roleCode, accountResponse.roleCode) && Objects.equals(this.teamId, accountResponse.teamId) && @@ -403,7 +403,7 @@ public boolean equals(Object o) { @Override public int hashCode() { - return Objects.hash(accountId, emailAddress, isLocked, isPaidHs, isPaidHf, quotas, callbackUrl, roleCode, teamId, locale, usage); + return Objects.hash(accountId, isLocked, isPaidHs, isPaidHf, quotas, emailAddress, callbackUrl, roleCode, teamId, locale, usage); } @Override @@ -411,11 +411,11 @@ public String toString() { StringBuilder sb = new StringBuilder(); sb.append("class AccountResponse {\n"); sb.append(" accountId: ").append(toIndentedString(accountId)).append("\n"); - sb.append(" emailAddress: ").append(toIndentedString(emailAddress)).append("\n"); sb.append(" isLocked: ").append(toIndentedString(isLocked)).append("\n"); sb.append(" isPaidHs: ").append(toIndentedString(isPaidHs)).append("\n"); sb.append(" isPaidHf: ").append(toIndentedString(isPaidHf)).append("\n"); sb.append(" quotas: ").append(toIndentedString(quotas)).append("\n"); + sb.append(" emailAddress: ").append(toIndentedString(emailAddress)).append("\n"); sb.append(" callbackUrl: ").append(toIndentedString(callbackUrl)).append("\n"); sb.append(" roleCode: ").append(toIndentedString(roleCode)).append("\n"); sb.append(" teamId: ").append(toIndentedString(teamId)).append("\n"); @@ -448,25 +448,6 @@ public Map createFormData() throws ApiException { map.put("account_id", JSON.getDefault().getMapper().writeValueAsString(accountId)); } } - if (emailAddress != null) { - if (isFileTypeOrListOfFiles(emailAddress)) { - fileTypeFound = true; - } - - if (emailAddress.getClass().equals(java.io.File.class) || - emailAddress.getClass().equals(Integer.class) || - emailAddress.getClass().equals(String.class) || - emailAddress.getClass().isEnum()) { - map.put("email_address", emailAddress); - } else if (isListOfFile(emailAddress)) { - for(int i = 0; i< getListSize(emailAddress); i++) { - map.put("email_address[" + i + "]", getFromList(emailAddress, i)); - } - } - else { - map.put("email_address", JSON.getDefault().getMapper().writeValueAsString(emailAddress)); - } - } if (isLocked != null) { if (isFileTypeOrListOfFiles(isLocked)) { fileTypeFound = true; @@ -543,6 +524,25 @@ public Map createFormData() throws ApiException { map.put("quotas", JSON.getDefault().getMapper().writeValueAsString(quotas)); } } + if (emailAddress != null) { + if (isFileTypeOrListOfFiles(emailAddress)) { + fileTypeFound = true; + } + + if (emailAddress.getClass().equals(java.io.File.class) || + emailAddress.getClass().equals(Integer.class) || + emailAddress.getClass().equals(String.class) || + emailAddress.getClass().isEnum()) { + map.put("email_address", emailAddress); + } else if (isListOfFile(emailAddress)) { + for(int i = 0; i< getListSize(emailAddress); i++) { + map.put("email_address[" + i + "]", getFromList(emailAddress, i)); + } + } + else { + map.put("email_address", JSON.getDefault().getMapper().writeValueAsString(emailAddress)); + } + } if (callbackUrl != null) { if (isFileTypeOrListOfFiles(callbackUrl)) { fileTypeFound = true; 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 c7a98d521..d947a80c1 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() { } 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..4f2308ff0 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() { } @@ -68,9 +68,9 @@ public AccountResponseUsage faxPagesSent(Integer faxPagesSent) { * Number of fax pages sent * @return faxPagesSent */ - @jakarta.annotation.Nullable + @jakarta.annotation.Nonnull @JsonProperty(JSON_PROPERTY_FAX_PAGES_SENT) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public Integer getFaxPagesSent() { return faxPagesSent; @@ -78,7 +78,7 @@ public Integer getFaxPagesSent() { @JsonProperty(JSON_PROPERTY_FAX_PAGES_SENT) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setFaxPagesSent(Integer faxPagesSent) { this.faxPagesSent = faxPagesSent; } diff --git a/sdks/node/dist/api.js b/sdks/node/dist/api.js index 69fdca0c9..9a825ca48 100644 --- a/sdks/node/dist/api.js +++ b/sdks/node/dist/api.js @@ -16464,11 +16464,6 @@ AccountResponse.attributeTypeMap = [ baseName: "account_id", type: "string" }, - { - name: "emailAddress", - baseName: "email_address", - type: "string" - }, { name: "isLocked", baseName: "is_locked", @@ -16489,6 +16484,11 @@ AccountResponse.attributeTypeMap = [ baseName: "quotas", type: "AccountResponseQuotas" }, + { + name: "emailAddress", + baseName: "email_address", + type: "string" + }, { name: "callbackUrl", baseName: "callback_url", @@ -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/model/AccountResponse.md b/sdks/node/docs/model/AccountResponse.md index b24e1638f..6e64d72a1 100644 --- a/sdks/node/docs/model/AccountResponse.md +++ b/sdks/node/docs/model/AccountResponse.md @@ -6,12 +6,12 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `accountId` | ```string``` | The ID of the Account | | +| `accountId`*_required_ | ```string``` | The ID of the Account | | +| `isLocked`*_required_ | ```boolean``` | Returns `true` if the user has been locked out of their account by a team admin. | | +| `isPaidHs`*_required_ | ```boolean``` | Returns `true` if the user has a paid Dropbox Sign account. | | +| `isPaidHf`*_required_ | ```boolean``` | Returns `true` if the user has a paid HelloFax account. | | +| `quotas`*_required_ | [```AccountResponseQuotas```](AccountResponseQuotas.md) | | | | `emailAddress` | ```string``` | The email address associated with the Account. | | -| `isLocked` | ```boolean``` | Returns `true` if the user has been locked out of their account by a team admin. | | -| `isPaidHs` | ```boolean``` | Returns `true` if the user has a paid Dropbox Sign account. | | -| `isPaidHf` | ```boolean``` | Returns `true` if the user has a paid HelloFax account. | | -| `quotas` | [```AccountResponseQuotas```](AccountResponseQuotas.md) | | | | `callbackUrl` | ```string``` | The URL that Dropbox Sign events will `POST` to. | | | `roleCode` | ```string``` | The membership role for the team. | | | `teamId` | ```string``` | The id of the team account belongs to. | | diff --git a/sdks/node/docs/model/AccountResponseQuotas.md b/sdks/node/docs/model/AccountResponseQuotas.md index 8c4c5c60d..4044ce4e7 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. A value of `-1` means unlimited. | | -| `documentsLeft` | ```number``` | Signature requests remaining. A value of `-1` means unlimited. | | -| `templatesTotal` | ```number``` | Total API templates allowed. A value of `-1` means unlimited. | | -| `templatesLeft` | ```number``` | API templates remaining. A value of `-1` means unlimited. | | -| `smsVerificationsLeft` | ```number``` | SMS verifications remaining. | | -| `numFaxPagesLeft` | ```number``` | Number of fax pages left. A value of `-1` means unlimited. | | +| `apiSignatureRequestsLeft` | ```number``` | API signature requests remaining. A value of `-1` means unlimited. | [default to 0] | +| `documentsLeft` | ```number``` | Signature requests remaining. A value of `-1` means unlimited. | [default to 0] | +| `templatesTotal` | ```number``` | Total API templates allowed. A value of `-1` means unlimited. | [default to 0] | +| `templatesLeft` | ```number``` | API templates remaining. A value of `-1` means unlimited. | [default to 0] | +| `smsVerificationsLeft` | ```number``` | SMS verifications remaining. | [default to 0] | +| `numFaxPagesLeft` | ```number``` | Number of fax pages left. A value of `-1` means unlimited. | [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..b6281b84b 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`*_required_ | ```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/accountResponse.ts b/sdks/node/model/accountResponse.ts index 73394d615..51a858e78 100644 --- a/sdks/node/model/accountResponse.ts +++ b/sdks/node/model/accountResponse.ts @@ -30,24 +30,24 @@ export class AccountResponse { /** * The ID of the Account */ - "accountId"?: string; - /** - * The email address associated with the Account. - */ - "emailAddress"?: string; + "accountId": string; /** * Returns `true` if the user has been locked out of their account by a team admin. */ - "isLocked"?: boolean; + "isLocked": boolean; /** * Returns `true` if the user has a paid Dropbox Sign account. */ - "isPaidHs"?: boolean; + "isPaidHs": boolean; /** * Returns `true` if the user has a paid HelloFax account. */ - "isPaidHf"?: boolean; - "quotas"?: AccountResponseQuotas; + "isPaidHf": boolean; + "quotas": AccountResponseQuotas; + /** + * The email address associated with the Account. + */ + "emailAddress"?: string; /** * The URL that Dropbox Sign events will `POST` to. */ @@ -74,11 +74,6 @@ export class AccountResponse { baseName: "account_id", type: "string", }, - { - name: "emailAddress", - baseName: "email_address", - type: "string", - }, { name: "isLocked", baseName: "is_locked", @@ -99,6 +94,11 @@ export class AccountResponse { baseName: "quotas", type: "AccountResponseQuotas", }, + { + name: "emailAddress", + baseName: "email_address", + type: "string", + }, { name: "callbackUrl", baseName: "callback_url", diff --git a/sdks/node/model/accountResponseQuotas.ts b/sdks/node/model/accountResponseQuotas.ts index ee01a1625..d4df012c9 100644 --- a/sdks/node/model/accountResponseQuotas.ts +++ b/sdks/node/model/accountResponseQuotas.ts @@ -31,27 +31,27 @@ export class AccountResponseQuotas { /** * API signature requests remaining. A value of `-1` means unlimited. */ - "apiSignatureRequestsLeft"?: number | null; + "apiSignatureRequestsLeft"?: number | null = 0; /** * Signature requests remaining. A value of `-1` means unlimited. */ - "documentsLeft"?: number | null; + "documentsLeft"?: number | null = 0; /** * Total API templates allowed. A value of `-1` means unlimited. */ - "templatesTotal"?: number | null; + "templatesTotal"?: number | null = 0; /** * API templates remaining. A value of `-1` means unlimited. */ - "templatesLeft"?: number | null; + "templatesLeft"?: number | null = 0; /** * SMS verifications remaining. */ - "smsVerificationsLeft"?: number | null; + "smsVerificationsLeft"?: number | null = 0; /** * Number of fax pages left. A value of `-1` means unlimited. */ - "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..96e7d02f6 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/accountResponse.d.ts b/sdks/node/types/model/accountResponse.d.ts index c38fde985..ef8d619b0 100644 --- a/sdks/node/types/model/accountResponse.d.ts +++ b/sdks/node/types/model/accountResponse.d.ts @@ -2,12 +2,12 @@ import { AttributeTypeMap } from "./"; import { AccountResponseQuotas } from "./accountResponseQuotas"; import { AccountResponseUsage } from "./accountResponseUsage"; export declare class AccountResponse { - "accountId"?: string; + "accountId": string; + "isLocked": boolean; + "isPaidHs": boolean; + "isPaidHf": boolean; + "quotas": AccountResponseQuotas; "emailAddress"?: string; - "isLocked"?: boolean; - "isPaidHs"?: boolean; - "isPaidHf"?: boolean; - "quotas"?: AccountResponseQuotas; "callbackUrl"?: string | null; "roleCode"?: string | null; "teamId"?: string | null; diff --git a/sdks/node/types/model/accountResponseUsage.d.ts b/sdks/node/types/model/accountResponseUsage.d.ts index 7506ca0ee..6f4602df2 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/docs/Model/AccountResponse.md b/sdks/php/docs/Model/AccountResponse.md index 3121826ba..815cc2f24 100644 --- a/sdks/php/docs/Model/AccountResponse.md +++ b/sdks/php/docs/Model/AccountResponse.md @@ -6,12 +6,12 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `account_id` | ```string``` | The ID of the Account | | +| `account_id`*_required_ | ```string``` | The ID of the Account | | +| `is_locked`*_required_ | ```bool``` | Returns `true` if the user has been locked out of their account by a team admin. | | +| `is_paid_hs`*_required_ | ```bool``` | Returns `true` if the user has a paid Dropbox Sign account. | | +| `is_paid_hf`*_required_ | ```bool``` | Returns `true` if the user has a paid HelloFax account. | | +| `quotas`*_required_ | [```\Dropbox\Sign\Model\AccountResponseQuotas```](AccountResponseQuotas.md) | | | | `email_address` | ```string``` | The email address associated with the Account. | | -| `is_locked` | ```bool``` | Returns `true` if the user has been locked out of their account by a team admin. | | -| `is_paid_hs` | ```bool``` | Returns `true` if the user has a paid Dropbox Sign account. | | -| `is_paid_hf` | ```bool``` | Returns `true` if the user has a paid HelloFax account. | | -| `quotas` | [```\Dropbox\Sign\Model\AccountResponseQuotas```](AccountResponseQuotas.md) | | | | `callback_url` | ```string``` | The URL that Dropbox Sign events will `POST` to. | | | `role_code` | ```string``` | The membership role for the team. | | | `team_id` | ```string``` | The id of the team account belongs to. | | diff --git a/sdks/php/docs/Model/AccountResponseQuotas.md b/sdks/php/docs/Model/AccountResponseQuotas.md index a82da8629..0dab7be73 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. A value of `-1` means unlimited. | | -| `documents_left` | ```int``` | Signature requests remaining. A value of `-1` means unlimited. | | -| `templates_total` | ```int``` | Total API templates allowed. A value of `-1` means unlimited. | | -| `templates_left` | ```int``` | API templates remaining. A value of `-1` means unlimited. | | -| `sms_verifications_left` | ```int``` | SMS verifications remaining. | | -| `num_fax_pages_left` | ```int``` | Number of fax pages left. A value of `-1` means unlimited. | | +| `api_signature_requests_left` | ```int``` | API signature requests remaining. A value of `-1` means unlimited. | [default to 0] | +| `documents_left` | ```int``` | Signature requests remaining. A value of `-1` means unlimited. | [default to 0] | +| `templates_total` | ```int``` | Total API templates allowed. A value of `-1` means unlimited. | [default to 0] | +| `templates_left` | ```int``` | API templates remaining. A value of `-1` means unlimited. | [default to 0] | +| `sms_verifications_left` | ```int``` | SMS verifications remaining. | [default to 0] | +| `num_fax_pages_left` | ```int``` | Number of fax pages left. A value of `-1` means unlimited. | [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..bac729127 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`*_required_ | ```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/Model/AccountResponse.php b/sdks/php/src/Model/AccountResponse.php index 3fb1a1869..d7fc22ce9 100644 --- a/sdks/php/src/Model/AccountResponse.php +++ b/sdks/php/src/Model/AccountResponse.php @@ -58,11 +58,11 @@ class AccountResponse implements ModelInterface, ArrayAccess, JsonSerializable */ protected static $openAPITypes = [ 'account_id' => 'string', - 'email_address' => 'string', 'is_locked' => 'bool', 'is_paid_hs' => 'bool', 'is_paid_hf' => 'bool', 'quotas' => '\Dropbox\Sign\Model\AccountResponseQuotas', + 'email_address' => 'string', 'callback_url' => 'string', 'role_code' => 'string', 'team_id' => 'string', @@ -79,11 +79,11 @@ class AccountResponse implements ModelInterface, ArrayAccess, JsonSerializable */ protected static $openAPIFormats = [ 'account_id' => null, - 'email_address' => null, 'is_locked' => null, 'is_paid_hs' => null, 'is_paid_hf' => null, 'quotas' => null, + 'email_address' => null, 'callback_url' => null, 'role_code' => null, 'team_id' => null, @@ -98,11 +98,11 @@ class AccountResponse implements ModelInterface, ArrayAccess, JsonSerializable */ protected static array $openAPINullables = [ 'account_id' => false, - 'email_address' => false, 'is_locked' => false, 'is_paid_hs' => false, 'is_paid_hf' => false, 'quotas' => false, + 'email_address' => false, 'callback_url' => true, 'role_code' => true, 'team_id' => true, @@ -189,11 +189,11 @@ public function isNullableSetToNull(string $property): bool */ protected static $attributeMap = [ 'account_id' => 'account_id', - 'email_address' => 'email_address', 'is_locked' => 'is_locked', 'is_paid_hs' => 'is_paid_hs', 'is_paid_hf' => 'is_paid_hf', 'quotas' => 'quotas', + 'email_address' => 'email_address', 'callback_url' => 'callback_url', 'role_code' => 'role_code', 'team_id' => 'team_id', @@ -208,11 +208,11 @@ public function isNullableSetToNull(string $property): bool */ protected static $setters = [ 'account_id' => 'setAccountId', - 'email_address' => 'setEmailAddress', 'is_locked' => 'setIsLocked', 'is_paid_hs' => 'setIsPaidHs', 'is_paid_hf' => 'setIsPaidHf', 'quotas' => 'setQuotas', + 'email_address' => 'setEmailAddress', 'callback_url' => 'setCallbackUrl', 'role_code' => 'setRoleCode', 'team_id' => 'setTeamId', @@ -227,11 +227,11 @@ public function isNullableSetToNull(string $property): bool */ protected static $getters = [ 'account_id' => 'getAccountId', - 'email_address' => 'getEmailAddress', 'is_locked' => 'getIsLocked', 'is_paid_hs' => 'getIsPaidHs', 'is_paid_hf' => 'getIsPaidHf', 'quotas' => 'getQuotas', + 'email_address' => 'getEmailAddress', 'callback_url' => 'getCallbackUrl', 'role_code' => 'getRoleCode', 'team_id' => 'getTeamId', @@ -296,11 +296,11 @@ public function getModelName() public function __construct(array $data = null) { $this->setIfExists('account_id', $data ?? [], null); - $this->setIfExists('email_address', $data ?? [], null); $this->setIfExists('is_locked', $data ?? [], null); $this->setIfExists('is_paid_hs', $data ?? [], null); $this->setIfExists('is_paid_hf', $data ?? [], null); $this->setIfExists('quotas', $data ?? [], null); + $this->setIfExists('email_address', $data ?? [], null); $this->setIfExists('callback_url', $data ?? [], null); $this->setIfExists('role_code', $data ?? [], null); $this->setIfExists('team_id', $data ?? [], null); @@ -351,7 +351,24 @@ private function setIfExists(string $variableName, array $fields, $defaultValue) */ public function listInvalidProperties() { - return []; + $invalidProperties = []; + + if ($this->container['account_id'] === null) { + $invalidProperties[] = "'account_id' can't be null"; + } + if ($this->container['is_locked'] === null) { + $invalidProperties[] = "'is_locked' can't be null"; + } + if ($this->container['is_paid_hs'] === null) { + $invalidProperties[] = "'is_paid_hs' can't be null"; + } + if ($this->container['is_paid_hf'] === null) { + $invalidProperties[] = "'is_paid_hf' can't be null"; + } + if ($this->container['quotas'] === null) { + $invalidProperties[] = "'quotas' can't be null"; + } + return $invalidProperties; } /** @@ -368,7 +385,7 @@ public function valid() /** * Gets account_id * - * @return string|null + * @return string */ public function getAccountId() { @@ -378,11 +395,11 @@ public function getAccountId() /** * Sets account_id * - * @param string|null $account_id The ID of the Account + * @param string $account_id The ID of the Account * * @return self */ - public function setAccountId(?string $account_id) + public function setAccountId(string $account_id) { if (is_null($account_id)) { throw new InvalidArgumentException('non-nullable account_id cannot be null'); @@ -392,37 +409,10 @@ public function setAccountId(?string $account_id) return $this; } - /** - * Gets email_address - * - * @return string|null - */ - public function getEmailAddress() - { - return $this->container['email_address']; - } - - /** - * Sets email_address - * - * @param string|null $email_address the email address associated with the Account - * - * @return self - */ - public function setEmailAddress(?string $email_address) - { - if (is_null($email_address)) { - throw new InvalidArgumentException('non-nullable email_address cannot be null'); - } - $this->container['email_address'] = $email_address; - - return $this; - } - /** * Gets is_locked * - * @return bool|null + * @return bool */ public function getIsLocked() { @@ -432,11 +422,11 @@ public function getIsLocked() /** * Sets is_locked * - * @param bool|null $is_locked returns `true` if the user has been locked out of their account by a team admin + * @param bool $is_locked returns `true` if the user has been locked out of their account by a team admin * * @return self */ - public function setIsLocked(?bool $is_locked) + public function setIsLocked(bool $is_locked) { if (is_null($is_locked)) { throw new InvalidArgumentException('non-nullable is_locked cannot be null'); @@ -449,7 +439,7 @@ public function setIsLocked(?bool $is_locked) /** * Gets is_paid_hs * - * @return bool|null + * @return bool */ public function getIsPaidHs() { @@ -459,11 +449,11 @@ public function getIsPaidHs() /** * Sets is_paid_hs * - * @param bool|null $is_paid_hs returns `true` if the user has a paid Dropbox Sign account + * @param bool $is_paid_hs returns `true` if the user has a paid Dropbox Sign account * * @return self */ - public function setIsPaidHs(?bool $is_paid_hs) + public function setIsPaidHs(bool $is_paid_hs) { if (is_null($is_paid_hs)) { throw new InvalidArgumentException('non-nullable is_paid_hs cannot be null'); @@ -476,7 +466,7 @@ public function setIsPaidHs(?bool $is_paid_hs) /** * Gets is_paid_hf * - * @return bool|null + * @return bool */ public function getIsPaidHf() { @@ -486,11 +476,11 @@ public function getIsPaidHf() /** * Sets is_paid_hf * - * @param bool|null $is_paid_hf returns `true` if the user has a paid HelloFax account + * @param bool $is_paid_hf returns `true` if the user has a paid HelloFax account * * @return self */ - public function setIsPaidHf(?bool $is_paid_hf) + public function setIsPaidHf(bool $is_paid_hf) { if (is_null($is_paid_hf)) { throw new InvalidArgumentException('non-nullable is_paid_hf cannot be null'); @@ -503,7 +493,7 @@ public function setIsPaidHf(?bool $is_paid_hf) /** * Gets quotas * - * @return AccountResponseQuotas|null + * @return AccountResponseQuotas */ public function getQuotas() { @@ -513,11 +503,11 @@ public function getQuotas() /** * Sets quotas * - * @param AccountResponseQuotas|null $quotas quotas + * @param AccountResponseQuotas $quotas quotas * * @return self */ - public function setQuotas(?AccountResponseQuotas $quotas) + public function setQuotas(AccountResponseQuotas $quotas) { if (is_null($quotas)) { throw new InvalidArgumentException('non-nullable quotas cannot be null'); @@ -527,6 +517,33 @@ public function setQuotas(?AccountResponseQuotas $quotas) return $this; } + /** + * Gets email_address + * + * @return string|null + */ + public function getEmailAddress() + { + return $this->container['email_address']; + } + + /** + * Sets email_address + * + * @param string|null $email_address the email address associated with the Account + * + * @return self + */ + public function setEmailAddress(?string $email_address) + { + if (is_null($email_address)) { + throw new InvalidArgumentException('non-nullable email_address cannot be null'); + } + $this->container['email_address'] = $email_address; + + return $this; + } + /** * Gets callback_url * diff --git a/sdks/php/src/Model/AccountResponseQuotas.php b/sdks/php/src/Model/AccountResponseQuotas.php index a50c72634..aa943122a 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); } /** diff --git a/sdks/php/src/Model/AccountResponseUsage.php b/sdks/php/src/Model/AccountResponseUsage.php index 94eb509e7..0e4bedf2b 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); } /** @@ -281,7 +282,12 @@ private function setIfExists(string $variableName, array $fields, $defaultValue) */ public function listInvalidProperties() { - return []; + $invalidProperties = []; + + if ($this->container['fax_pages_sent'] === null) { + $invalidProperties[] = "'fax_pages_sent' can't be null"; + } + return $invalidProperties; } /** @@ -298,7 +304,7 @@ public function valid() /** * Gets fax_pages_sent * - * @return int|null + * @return int */ public function getFaxPagesSent() { @@ -308,21 +314,14 @@ public function getFaxPagesSent() /** * Sets fax_pages_sent * - * @param int|null $fax_pages_sent Number of fax pages sent + * @param int $fax_pages_sent Number of fax pages sent * * @return self */ - public function setFaxPagesSent(?int $fax_pages_sent) + 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/docs/AccountResponse.md b/sdks/python/docs/AccountResponse.md index 26ce76bd1..09b705bdf 100644 --- a/sdks/python/docs/AccountResponse.md +++ b/sdks/python/docs/AccountResponse.md @@ -5,12 +5,12 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `account_id` | ```str``` | The ID of the Account | | +| `account_id`*_required_ | ```str``` | The ID of the Account | | +| `is_locked`*_required_ | ```bool``` | Returns `true` if the user has been locked out of their account by a team admin. | | +| `is_paid_hs`*_required_ | ```bool``` | Returns `true` if the user has a paid Dropbox Sign account. | | +| `is_paid_hf`*_required_ | ```bool``` | Returns `true` if the user has a paid HelloFax account. | | +| `quotas`*_required_ | [```AccountResponseQuotas```](AccountResponseQuotas.md) | | | | `email_address` | ```str``` | The email address associated with the Account. | | -| `is_locked` | ```bool``` | Returns `true` if the user has been locked out of their account by a team admin. | | -| `is_paid_hs` | ```bool``` | Returns `true` if the user has a paid Dropbox Sign account. | | -| `is_paid_hf` | ```bool``` | Returns `true` if the user has a paid HelloFax account. | | -| `quotas` | [```AccountResponseQuotas```](AccountResponseQuotas.md) | | | | `callback_url` | ```str``` | The URL that Dropbox Sign events will `POST` to. | | | `role_code` | ```str``` | The membership role for the team. | | | `team_id` | ```str``` | The id of the team account belongs to. | | diff --git a/sdks/python/docs/AccountResponseQuotas.md b/sdks/python/docs/AccountResponseQuotas.md index 15dd521bf..df5288b41 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. A value of `-1` means unlimited. | | -| `documents_left` | ```int``` | Signature requests remaining. A value of `-1` means unlimited. | | -| `templates_total` | ```int``` | Total API templates allowed. A value of `-1` means unlimited. | | -| `templates_left` | ```int``` | API templates remaining. A value of `-1` means unlimited. | | -| `sms_verifications_left` | ```int``` | SMS verifications remaining. | | -| `num_fax_pages_left` | ```int``` | Number of fax pages left. A value of `-1` means unlimited. | | +| `api_signature_requests_left` | ```int``` | API signature requests remaining. A value of `-1` means unlimited. | [default to 0] | +| `documents_left` | ```int``` | Signature requests remaining. A value of `-1` means unlimited. | [default to 0] | +| `templates_total` | ```int``` | Total API templates allowed. A value of `-1` means unlimited. | [default to 0] | +| `templates_left` | ```int``` | API templates remaining. A value of `-1` means unlimited. | [default to 0] | +| `sms_verifications_left` | ```int``` | SMS verifications remaining. | [default to 0] | +| `num_fax_pages_left` | ```int``` | Number of fax pages left. A value of `-1` means unlimited. | [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..efbc3fc1a 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`*_required_ | ```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/dropbox_sign/models/account_response.py b/sdks/python/dropbox_sign/models/account_response.py index 8af0a6fb5..24aaf1763 100644 --- a/sdks/python/dropbox_sign/models/account_response.py +++ b/sdks/python/dropbox_sign/models/account_response.py @@ -34,25 +34,20 @@ class AccountResponse(BaseModel): AccountResponse """ # noqa: E501 - account_id: Optional[StrictStr] = Field( - default=None, description="The ID of the Account" + account_id: StrictStr = Field(description="The ID of the Account") + is_locked: StrictBool = Field( + description="Returns `true` if the user has been locked out of their account by a team admin." ) - email_address: Optional[StrictStr] = Field( - default=None, description="The email address associated with the Account." + is_paid_hs: StrictBool = Field( + description="Returns `true` if the user has a paid Dropbox Sign account." ) - is_locked: Optional[StrictBool] = Field( - default=None, - description="Returns `true` if the user has been locked out of their account by a team admin.", + is_paid_hf: StrictBool = Field( + description="Returns `true` if the user has a paid HelloFax account." ) - is_paid_hs: Optional[StrictBool] = Field( - default=None, - description="Returns `true` if the user has a paid Dropbox Sign account.", - ) - is_paid_hf: Optional[StrictBool] = Field( - default=None, - description="Returns `true` if the user has a paid HelloFax account.", + quotas: AccountResponseQuotas + email_address: Optional[StrictStr] = Field( + default=None, description="The email address associated with the Account." ) - quotas: Optional[AccountResponseQuotas] = None callback_url: Optional[StrictStr] = Field( default=None, description="The URL that Dropbox Sign events will `POST` to." ) @@ -69,11 +64,11 @@ class AccountResponse(BaseModel): usage: Optional[AccountResponseUsage] = None __properties: ClassVar[List[str]] = [ "account_id", - "email_address", "is_locked", "is_paid_hs", "is_paid_hf", "quotas", + "email_address", "callback_url", "role_code", "team_id", @@ -151,7 +146,6 @@ def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: _obj = cls.model_validate( { "account_id": obj.get("account_id"), - "email_address": obj.get("email_address"), "is_locked": obj.get("is_locked"), "is_paid_hs": obj.get("is_paid_hs"), "is_paid_hf": obj.get("is_paid_hf"), @@ -160,6 +154,7 @@ def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: if obj.get("quotas") is not None else None ), + "email_address": obj.get("email_address"), "callback_url": obj.get("callback_url"), "role_code": obj.get("role_code"), "team_id": obj.get("team_id"), @@ -187,11 +182,11 @@ def init(cls, data: Any) -> Self: def openapi_types(cls) -> Dict[str, str]: return { "account_id": "(str,)", - "email_address": "(str,)", "is_locked": "(bool,)", "is_paid_hs": "(bool,)", "is_paid_hf": "(bool,)", "quotas": "(AccountResponseQuotas,)", + "email_address": "(str,)", "callback_url": "(str,)", "role_code": "(str,)", "team_id": "(str,)", diff --git a/sdks/python/dropbox_sign/models/account_response_quotas.py b/sdks/python/dropbox_sign/models/account_response_quotas.py index 2a70521b1..5f938a369 100644 --- a/sdks/python/dropbox_sign/models/account_response_quotas.py +++ b/sdks/python/dropbox_sign/models/account_response_quotas.py @@ -33,26 +33,26 @@ class AccountResponseQuotas(BaseModel): """ # noqa: E501 api_signature_requests_left: Optional[StrictInt] = Field( - default=None, + default=0, description="API signature requests remaining. A value of `-1` means unlimited.", ) documents_left: Optional[StrictInt] = Field( - default=None, + default=0, description="Signature requests remaining. A value of `-1` means unlimited.", ) templates_total: Optional[StrictInt] = Field( - default=None, + default=0, description="Total API templates allowed. A value of `-1` means unlimited.", ) templates_left: Optional[StrictInt] = Field( - default=None, + default=0, description="API templates remaining. A value of `-1` means unlimited.", ) 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, + default=0, description="Number of fax pages left. A value of `-1` means unlimited.", ) __properties: ClassVar[List[str]] = [ @@ -127,12 +127,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..8df6b3be8 100644 --- a/sdks/python/dropbox_sign/models/account_response_usage.py +++ b/sdks/python/dropbox_sign/models/account_response_usage.py @@ -19,7 +19,7 @@ import json from pydantic import BaseModel, ConfigDict, Field, StrictInt -from typing import Any, ClassVar, Dict, List, Optional +from typing import Any, ClassVar, Dict, List from typing import Optional, Set, Tuple from typing_extensions import Self import io @@ -32,9 +32,7 @@ class AccountResponseUsage(BaseModel): Details concerning monthly usage """ # noqa: E501 - fax_pages_sent: Optional[StrictInt] = Field( - default=None, description="Number of fax pages sent" - ) + fax_pages_sent: StrictInt = Field(description="Number of fax pages sent") __properties: ClassVar[List[str]] = ["fax_pages_sent"] model_config = ConfigDict( @@ -98,7 +96,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/docs/AccountResponse.md b/sdks/ruby/docs/AccountResponse.md index 294f29431..c2c28a069 100644 --- a/sdks/ruby/docs/AccountResponse.md +++ b/sdks/ruby/docs/AccountResponse.md @@ -6,12 +6,12 @@ | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | -| `account_id` | ```String``` | The ID of the Account | | +| `account_id`*_required_ | ```String``` | The ID of the Account | | +| `is_locked`*_required_ | ```Boolean``` | Returns `true` if the user has been locked out of their account by a team admin. | | +| `is_paid_hs`*_required_ | ```Boolean``` | Returns `true` if the user has a paid Dropbox Sign account. | | +| `is_paid_hf`*_required_ | ```Boolean``` | Returns `true` if the user has a paid HelloFax account. | | +| `quotas`*_required_ | [```AccountResponseQuotas```](AccountResponseQuotas.md) | | | | `email_address` | ```String``` | The email address associated with the Account. | | -| `is_locked` | ```Boolean``` | Returns `true` if the user has been locked out of their account by a team admin. | | -| `is_paid_hs` | ```Boolean``` | Returns `true` if the user has a paid Dropbox Sign account. | | -| `is_paid_hf` | ```Boolean``` | Returns `true` if the user has a paid HelloFax account. | | -| `quotas` | [```AccountResponseQuotas```](AccountResponseQuotas.md) | | | | `callback_url` | ```String``` | The URL that Dropbox Sign events will `POST` to. | | | `role_code` | ```String``` | The membership role for the team. | | | `team_id` | ```String``` | The id of the team account belongs to. | | diff --git a/sdks/ruby/docs/AccountResponseQuotas.md b/sdks/ruby/docs/AccountResponseQuotas.md index 044f3cf0a..66b374ff2 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. A value of `-1` means unlimited. | | -| `documents_left` | ```Integer``` | Signature requests remaining. A value of `-1` means unlimited. | | -| `templates_total` | ```Integer``` | Total API templates allowed. A value of `-1` means unlimited. | | -| `templates_left` | ```Integer``` | API templates remaining. A value of `-1` means unlimited. | | -| `sms_verifications_left` | ```Integer``` | SMS verifications remaining. | | -| `num_fax_pages_left` | ```Integer``` | Number of fax pages left. A value of `-1` means unlimited. | | +| `api_signature_requests_left` | ```Integer``` | API signature requests remaining. A value of `-1` means unlimited. | [default to 0] | +| `documents_left` | ```Integer``` | Signature requests remaining. A value of `-1` means unlimited. | [default to 0] | +| `templates_total` | ```Integer``` | Total API templates allowed. A value of `-1` means unlimited. | [default to 0] | +| `templates_left` | ```Integer``` | API templates remaining. A value of `-1` means unlimited. | [default to 0] | +| `sms_verifications_left` | ```Integer``` | SMS verifications remaining. | [default to 0] | +| `num_fax_pages_left` | ```Integer``` | Number of fax pages left. A value of `-1` means unlimited. | [default to 0] | diff --git a/sdks/ruby/docs/AccountResponseUsage.md b/sdks/ruby/docs/AccountResponseUsage.md index 6dc2ddc21..30f42673f 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`*_required_ | ```Integer``` | Number of fax pages sent | [default to 0] | diff --git a/sdks/ruby/lib/dropbox-sign/models/account_response.rb b/sdks/ruby/lib/dropbox-sign/models/account_response.rb index 1ab6a5d47..a6accd25b 100644 --- a/sdks/ruby/lib/dropbox-sign/models/account_response.rb +++ b/sdks/ruby/lib/dropbox-sign/models/account_response.rb @@ -22,10 +22,6 @@ class AccountResponse # @return [String] attr_accessor :account_id - # The email address associated with the Account. - # @return [String] - attr_accessor :email_address - # Returns `true` if the user has been locked out of their account by a team admin. # @return [Boolean] attr_accessor :is_locked @@ -41,6 +37,10 @@ class AccountResponse # @return [AccountResponseQuotas] attr_accessor :quotas + # The email address associated with the Account. + # @return [String] + attr_accessor :email_address + # The URL that Dropbox Sign events will `POST` to. # @return [String, nil] attr_accessor :callback_url @@ -64,11 +64,11 @@ class AccountResponse def self.attribute_map { :'account_id' => :'account_id', - :'email_address' => :'email_address', :'is_locked' => :'is_locked', :'is_paid_hs' => :'is_paid_hs', :'is_paid_hf' => :'is_paid_hf', :'quotas' => :'quotas', + :'email_address' => :'email_address', :'callback_url' => :'callback_url', :'role_code' => :'role_code', :'team_id' => :'team_id', @@ -86,11 +86,11 @@ def self.acceptable_attributes def self.openapi_types { :'account_id' => :'String', - :'email_address' => :'String', :'is_locked' => :'Boolean', :'is_paid_hs' => :'Boolean', :'is_paid_hf' => :'Boolean', :'quotas' => :'AccountResponseQuotas', + :'email_address' => :'String', :'callback_url' => :'String', :'role_code' => :'String', :'team_id' => :'String', @@ -153,10 +153,6 @@ def initialize(attributes = {}) self.account_id = attributes[:'account_id'] end - if attributes.key?(:'email_address') - self.email_address = attributes[:'email_address'] - end - if attributes.key?(:'is_locked') self.is_locked = attributes[:'is_locked'] end @@ -173,6 +169,10 @@ def initialize(attributes = {}) self.quotas = attributes[:'quotas'] end + if attributes.key?(:'email_address') + self.email_address = attributes[:'email_address'] + end + if attributes.key?(:'callback_url') self.callback_url = attributes[:'callback_url'] end @@ -198,12 +198,37 @@ def initialize(attributes = {}) # @return Array for valid properties with the reasons def list_invalid_properties invalid_properties = Array.new + if @account_id.nil? + invalid_properties.push('invalid value for "account_id", account_id cannot be nil.') + end + + if @is_locked.nil? + invalid_properties.push('invalid value for "is_locked", is_locked cannot be nil.') + end + + if @is_paid_hs.nil? + invalid_properties.push('invalid value for "is_paid_hs", is_paid_hs cannot be nil.') + end + + if @is_paid_hf.nil? + invalid_properties.push('invalid value for "is_paid_hf", is_paid_hf cannot be nil.') + end + + if @quotas.nil? + invalid_properties.push('invalid value for "quotas", quotas cannot be nil.') + end + invalid_properties end # Check to see if the all the properties in the model are valid # @return true if the model is valid def valid? + return false if @account_id.nil? + return false if @is_locked.nil? + return false if @is_paid_hs.nil? + return false if @is_paid_hf.nil? + return false if @quotas.nil? true end @@ -213,11 +238,11 @@ def ==(o) return true if self.equal?(o) self.class == o.class && account_id == o.account_id && - email_address == o.email_address && is_locked == o.is_locked && is_paid_hs == o.is_paid_hs && is_paid_hf == o.is_paid_hf && quotas == o.quotas && + email_address == o.email_address && callback_url == o.callback_url && role_code == o.role_code && team_id == o.team_id && @@ -234,7 +259,7 @@ def eql?(o) # Calculates hash code according to all attributes. # @return [Integer] Hash code def hash - [account_id, email_address, is_locked, is_paid_hs, is_paid_hf, quotas, callback_url, role_code, team_id, locale, usage].hash + [account_id, is_locked, is_paid_hs, is_paid_hf, quotas, email_address, callback_url, role_code, team_id, locale, usage].hash end # Builds the object from hash 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 04f549a76..28f09bde2 100644 --- a/sdks/ruby/lib/dropbox-sign/models/account_response_quotas.rb +++ b/sdks/ruby/lib/dropbox-sign/models/account_response_quotas.rb @@ -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..7f27e59bf 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 @@ -98,12 +99,17 @@ def initialize(attributes = {}) # @return Array for valid properties with the reasons def list_invalid_properties invalid_properties = Array.new + if @fax_pages_sent.nil? + invalid_properties.push('invalid value for "fax_pages_sent", fax_pages_sent cannot be nil.') + end + invalid_properties end # Check to see if the all the properties in the model are valid # @return true if the model is valid def valid? + return false if @fax_pages_sent.nil? true end From c954a2a1d42baec27ef12d883f238977556aafdb Mon Sep 17 00:00:00 2001 From: Juan Treminio Date: Fri, 18 Oct 2024 11:08:00 -0500 Subject: [PATCH 3/4] Remove -1 === unlimited copy --- openapi-sdk.yaml | 10 +++---- openapi.yaml | 10 +++---- sdks/dotnet/docs/AccountResponseQuotas.md | 2 +- .../Model/AccountResponseQuotas.cs | 30 +++++++++---------- sdks/java-v1/docs/AccountResponseQuotas.md | 10 +++---- .../sign/model/AccountResponseQuotas.java | 10 +++---- sdks/java-v2/docs/AccountResponseQuotas.md | 10 +++---- .../sign/model/AccountResponseQuotas.java | 10 +++---- sdks/node/docs/model/AccountResponseQuotas.md | 10 +++---- sdks/node/model/accountResponseQuotas.ts | 10 +++---- sdks/php/docs/Model/AccountResponseQuotas.md | 10 +++---- sdks/php/src/Model/AccountResponseQuotas.php | 10 +++---- sdks/python/docs/AccountResponseQuotas.md | 10 +++---- .../models/account_response_quotas.py | 15 ++++------ sdks/ruby/docs/AccountResponseQuotas.md | 10 +++---- .../models/account_response_quotas.rb | 10 +++---- translations/en.yaml | 10 +++---- 17 files changed, 91 insertions(+), 96 deletions(-) diff --git a/openapi-sdk.yaml b/openapi-sdk.yaml index 9105cf761..e48040c88 100644 --- a/openapi-sdk.yaml +++ b/openapi-sdk.yaml @@ -10418,22 +10418,22 @@ components: description: 'Details concerning remaining monthly quotas.' properties: api_signature_requests_left: - description: 'API signature requests remaining. A value of `-1` means unlimited.' + description: 'API signature requests remaining.' type: integer default: 0 nullable: true documents_left: - description: 'Signature requests remaining. A value of `-1` means unlimited.' + description: 'Signature requests remaining.' type: integer default: 0 nullable: true templates_total: - description: 'Total API templates allowed. A value of `-1` means unlimited.' + description: 'Total API templates allowed.' type: integer default: 0 nullable: true templates_left: - description: 'API templates remaining. A value of `-1` means unlimited.' + description: 'API templates remaining.' type: integer default: 0 nullable: true @@ -10443,7 +10443,7 @@ components: default: 0 nullable: true num_fax_pages_left: - description: 'Number of fax pages left. A value of `-1` means unlimited.' + description: 'Number of fax pages left' type: integer default: 0 nullable: true diff --git a/openapi.yaml b/openapi.yaml index 503d7ccc6..e992a7caf 100644 --- a/openapi.yaml +++ b/openapi.yaml @@ -10396,22 +10396,22 @@ components: description: 'Details concerning remaining monthly quotas.' properties: api_signature_requests_left: - description: 'API signature requests remaining. A value of `-1` means unlimited.' + description: 'API signature requests remaining.' type: integer default: 0 nullable: true documents_left: - description: 'Signature requests remaining. A value of `-1` means unlimited.' + description: 'Signature requests remaining.' type: integer default: 0 nullable: true templates_total: - description: 'Total API templates allowed. A value of `-1` means unlimited.' + description: 'Total API templates allowed.' type: integer default: 0 nullable: true templates_left: - description: 'API templates remaining. A value of `-1` means unlimited.' + description: 'API templates remaining.' type: integer default: 0 nullable: true @@ -10421,7 +10421,7 @@ components: default: 0 nullable: true num_fax_pages_left: - description: 'Number of fax pages left. A value of `-1` means unlimited.' + description: 'Number of fax pages left' type: integer default: 0 nullable: true diff --git a/sdks/dotnet/docs/AccountResponseQuotas.md b/sdks/dotnet/docs/AccountResponseQuotas.md index 8dd046fa5..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. A value of `-1` means unlimited. | [optional] [default to 0]**DocumentsLeft** | **int?** | Signature requests remaining. A value of `-1` means unlimited. | [optional] [default to 0]**TemplatesTotal** | **int?** | Total API templates allowed. A value of `-1` means unlimited. | [optional] [default to 0]**TemplatesLeft** | **int?** | API templates remaining. A value of `-1` means unlimited. | [optional] [default to 0]**SmsVerificationsLeft** | **int?** | SMS verifications remaining. | [optional] [default to 0]**NumFaxPagesLeft** | **int?** | Number of fax pages left. A value of `-1` means unlimited. | [optional] [default to 0] +**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/src/Dropbox.Sign/Model/AccountResponseQuotas.cs b/sdks/dotnet/src/Dropbox.Sign/Model/AccountResponseQuotas.cs index 6cc3fcb7c..8140337a2 100644 --- a/sdks/dotnet/src/Dropbox.Sign/Model/AccountResponseQuotas.cs +++ b/sdks/dotnet/src/Dropbox.Sign/Model/AccountResponseQuotas.cs @@ -41,12 +41,12 @@ protected AccountResponseQuotas() { } /// /// Initializes a new instance of the class. /// - /// API signature requests remaining. A value of `-1` means unlimited. (default to 0). - /// Signature requests remaining. A value of `-1` means unlimited. (default to 0). - /// Total API templates allowed. A value of `-1` means unlimited. (default to 0). - /// API templates remaining. A value of `-1` means unlimited. (default to 0). + /// 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. A value of `-1` means unlimited. (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) { @@ -81,30 +81,30 @@ public static AccountResponseQuotas Init(string jsonData) } /// - /// API signature requests remaining. A value of `-1` means unlimited. + /// API signature requests remaining. /// - /// API signature requests remaining. A value of `-1` means unlimited. + /// API signature requests remaining. [DataMember(Name = "api_signature_requests_left", EmitDefaultValue = true)] public int? ApiSignatureRequestsLeft { get; set; } /// - /// Signature requests remaining. A value of `-1` means unlimited. + /// Signature requests remaining. /// - /// Signature requests remaining. A value of `-1` means unlimited. + /// Signature requests remaining. [DataMember(Name = "documents_left", EmitDefaultValue = true)] public int? DocumentsLeft { get; set; } /// - /// Total API templates allowed. A value of `-1` means unlimited. + /// Total API templates allowed. /// - /// Total API templates allowed. A value of `-1` means unlimited. + /// Total API templates allowed. [DataMember(Name = "templates_total", EmitDefaultValue = true)] public int? TemplatesTotal { get; set; } /// - /// API templates remaining. A value of `-1` means unlimited. + /// API templates remaining. /// - /// API templates remaining. A value of `-1` means unlimited. + /// API templates remaining. [DataMember(Name = "templates_left", EmitDefaultValue = true)] public int? TemplatesLeft { get; set; } @@ -116,9 +116,9 @@ public static AccountResponseQuotas Init(string jsonData) public int? SmsVerificationsLeft { get; set; } /// - /// Number of fax pages left. A value of `-1` means unlimited. + /// Number of fax pages left /// - /// Number of fax pages left. A value of `-1` means unlimited. + /// Number of fax pages left [DataMember(Name = "num_fax_pages_left", EmitDefaultValue = true)] public int? NumFaxPagesLeft { get; set; } diff --git a/sdks/java-v1/docs/AccountResponseQuotas.md b/sdks/java-v1/docs/AccountResponseQuotas.md index 91f28f23c..e7510a8d7 100644 --- a/sdks/java-v1/docs/AccountResponseQuotas.md +++ b/sdks/java-v1/docs/AccountResponseQuotas.md @@ -8,12 +8,12 @@ Details concerning remaining monthly quotas. | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| -| `apiSignatureRequestsLeft` | ```Integer``` | API signature requests remaining. A value of `-1` means unlimited. | | -| `documentsLeft` | ```Integer``` | Signature requests remaining. A value of `-1` means unlimited. | | -| `templatesTotal` | ```Integer``` | Total API templates allowed. A value of `-1` means unlimited. | | -| `templatesLeft` | ```Integer``` | API templates remaining. A value of `-1` means unlimited. | | +| `apiSignatureRequestsLeft` | ```Integer``` | API signature requests remaining. | | +| `documentsLeft` | ```Integer``` | Signature requests remaining. | | +| `templatesTotal` | ```Integer``` | Total API templates allowed. | | +| `templatesLeft` | ```Integer``` | API templates remaining. | | | `smsVerificationsLeft` | ```Integer``` | SMS verifications remaining. | | -| `numFaxPagesLeft` | ```Integer``` | Number of fax pages left. A value of `-1` means unlimited. | | +| `numFaxPagesLeft` | ```Integer``` | Number of fax pages left | | 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 9081f09f4..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 @@ -79,7 +79,7 @@ public AccountResponseQuotas apiSignatureRequestsLeft(Integer apiSignatureReques } /** - * API signature requests remaining. A value of `-1` means unlimited. + * API signature requests remaining. * * @return apiSignatureRequestsLeft */ @@ -101,7 +101,7 @@ public AccountResponseQuotas documentsLeft(Integer documentsLeft) { } /** - * Signature requests remaining. A value of `-1` means unlimited. + * Signature requests remaining. * * @return documentsLeft */ @@ -123,7 +123,7 @@ public AccountResponseQuotas templatesTotal(Integer templatesTotal) { } /** - * Total API templates allowed. A value of `-1` means unlimited. + * Total API templates allowed. * * @return templatesTotal */ @@ -145,7 +145,7 @@ public AccountResponseQuotas templatesLeft(Integer templatesLeft) { } /** - * API templates remaining. A value of `-1` means unlimited. + * API templates remaining. * * @return templatesLeft */ @@ -189,7 +189,7 @@ public AccountResponseQuotas numFaxPagesLeft(Integer numFaxPagesLeft) { } /** - * Number of fax pages left. A value of `-1` means unlimited. + * Number of fax pages left * * @return numFaxPagesLeft */ diff --git a/sdks/java-v2/docs/AccountResponseQuotas.md b/sdks/java-v2/docs/AccountResponseQuotas.md index 91f28f23c..e7510a8d7 100644 --- a/sdks/java-v2/docs/AccountResponseQuotas.md +++ b/sdks/java-v2/docs/AccountResponseQuotas.md @@ -8,12 +8,12 @@ Details concerning remaining monthly quotas. | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| -| `apiSignatureRequestsLeft` | ```Integer``` | API signature requests remaining. A value of `-1` means unlimited. | | -| `documentsLeft` | ```Integer``` | Signature requests remaining. A value of `-1` means unlimited. | | -| `templatesTotal` | ```Integer``` | Total API templates allowed. A value of `-1` means unlimited. | | -| `templatesLeft` | ```Integer``` | API templates remaining. A value of `-1` means unlimited. | | +| `apiSignatureRequestsLeft` | ```Integer``` | API signature requests remaining. | | +| `documentsLeft` | ```Integer``` | Signature requests remaining. | | +| `templatesTotal` | ```Integer``` | Total API templates allowed. | | +| `templatesLeft` | ```Integer``` | API templates remaining. | | | `smsVerificationsLeft` | ```Integer``` | SMS verifications remaining. | | -| `numFaxPagesLeft` | ```Integer``` | Number of fax pages left. A value of `-1` means unlimited. | | +| `numFaxPagesLeft` | ```Integer``` | Number of fax pages left | | 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 d947a80c1..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 @@ -85,7 +85,7 @@ public AccountResponseQuotas apiSignatureRequestsLeft(Integer apiSignatureReques } /** - * API signature requests remaining. A value of `-1` means unlimited. + * API signature requests remaining. * @return apiSignatureRequestsLeft */ @jakarta.annotation.Nullable @@ -110,7 +110,7 @@ public AccountResponseQuotas documentsLeft(Integer documentsLeft) { } /** - * Signature requests remaining. A value of `-1` means unlimited. + * Signature requests remaining. * @return documentsLeft */ @jakarta.annotation.Nullable @@ -135,7 +135,7 @@ public AccountResponseQuotas templatesTotal(Integer templatesTotal) { } /** - * Total API templates allowed. A value of `-1` means unlimited. + * Total API templates allowed. * @return templatesTotal */ @jakarta.annotation.Nullable @@ -160,7 +160,7 @@ public AccountResponseQuotas templatesLeft(Integer templatesLeft) { } /** - * API templates remaining. A value of `-1` means unlimited. + * API templates remaining. * @return templatesLeft */ @jakarta.annotation.Nullable @@ -210,7 +210,7 @@ public AccountResponseQuotas numFaxPagesLeft(Integer numFaxPagesLeft) { } /** - * Number of fax pages left. A value of `-1` means unlimited. + * Number of fax pages left * @return numFaxPagesLeft */ @jakarta.annotation.Nullable diff --git a/sdks/node/docs/model/AccountResponseQuotas.md b/sdks/node/docs/model/AccountResponseQuotas.md index 4044ce4e7..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. A value of `-1` means unlimited. | [default to 0] | -| `documentsLeft` | ```number``` | Signature requests remaining. A value of `-1` means unlimited. | [default to 0] | -| `templatesTotal` | ```number``` | Total API templates allowed. A value of `-1` means unlimited. | [default to 0] | -| `templatesLeft` | ```number``` | API templates remaining. A value of `-1` means unlimited. | [default to 0] | +| `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. A value of `-1` means unlimited. | [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/model/accountResponseQuotas.ts b/sdks/node/model/accountResponseQuotas.ts index d4df012c9..e1efe123f 100644 --- a/sdks/node/model/accountResponseQuotas.ts +++ b/sdks/node/model/accountResponseQuotas.ts @@ -29,19 +29,19 @@ import { AttributeTypeMap, ObjectSerializer } from "./"; */ export class AccountResponseQuotas { /** - * API signature requests remaining. A value of `-1` means unlimited. + * API signature requests remaining. */ "apiSignatureRequestsLeft"?: number | null = 0; /** - * Signature requests remaining. A value of `-1` means unlimited. + * Signature requests remaining. */ "documentsLeft"?: number | null = 0; /** - * Total API templates allowed. A value of `-1` means unlimited. + * Total API templates allowed. */ "templatesTotal"?: number | null = 0; /** - * API templates remaining. A value of `-1` means unlimited. + * API templates remaining. */ "templatesLeft"?: number | null = 0; /** @@ -49,7 +49,7 @@ export class AccountResponseQuotas { */ "smsVerificationsLeft"?: number | null = 0; /** - * Number of fax pages left. A value of `-1` means unlimited. + * Number of fax pages left */ "numFaxPagesLeft"?: number | null = 0; diff --git a/sdks/php/docs/Model/AccountResponseQuotas.md b/sdks/php/docs/Model/AccountResponseQuotas.md index 0dab7be73..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. A value of `-1` means unlimited. | [default to 0] | -| `documents_left` | ```int``` | Signature requests remaining. A value of `-1` means unlimited. | [default to 0] | -| `templates_total` | ```int``` | Total API templates allowed. A value of `-1` means unlimited. | [default to 0] | -| `templates_left` | ```int``` | API templates remaining. A value of `-1` means unlimited. | [default to 0] | +| `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. A value of `-1` means unlimited. | [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/src/Model/AccountResponseQuotas.php b/sdks/php/src/Model/AccountResponseQuotas.php index aa943122a..98fb55ed0 100644 --- a/sdks/php/src/Model/AccountResponseQuotas.php +++ b/sdks/php/src/Model/AccountResponseQuotas.php @@ -343,7 +343,7 @@ public function getApiSignatureRequestsLeft() /** * Sets api_signature_requests_left * - * @param int|null $api_signature_requests_left API signature requests remaining. A value of `-1` means unlimited. + * @param int|null $api_signature_requests_left API signature requests remaining * * @return self */ @@ -377,7 +377,7 @@ public function getDocumentsLeft() /** * Sets documents_left * - * @param int|null $documents_left Signature requests remaining. A value of `-1` means unlimited. + * @param int|null $documents_left signature requests remaining * * @return self */ @@ -411,7 +411,7 @@ public function getTemplatesTotal() /** * Sets templates_total * - * @param int|null $templates_total Total API templates allowed. A value of `-1` means unlimited. + * @param int|null $templates_total total API templates allowed * * @return self */ @@ -445,7 +445,7 @@ public function getTemplatesLeft() /** * Sets templates_left * - * @param int|null $templates_left API templates remaining. A value of `-1` means unlimited. + * @param int|null $templates_left API templates remaining * * @return self */ @@ -513,7 +513,7 @@ public function getNumFaxPagesLeft() /** * Sets num_fax_pages_left * - * @param int|null $num_fax_pages_left Number of fax pages left. A value of `-1` means unlimited. + * @param int|null $num_fax_pages_left Number of fax pages left * * @return self */ diff --git a/sdks/python/docs/AccountResponseQuotas.md b/sdks/python/docs/AccountResponseQuotas.md index df5288b41..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. A value of `-1` means unlimited. | [default to 0] | -| `documents_left` | ```int``` | Signature requests remaining. A value of `-1` means unlimited. | [default to 0] | -| `templates_total` | ```int``` | Total API templates allowed. A value of `-1` means unlimited. | [default to 0] | -| `templates_left` | ```int``` | API templates remaining. A value of `-1` means unlimited. | [default to 0] | +| `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. A value of `-1` means unlimited. | [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/dropbox_sign/models/account_response_quotas.py b/sdks/python/dropbox_sign/models/account_response_quotas.py index 5f938a369..c39cc3889 100644 --- a/sdks/python/dropbox_sign/models/account_response_quotas.py +++ b/sdks/python/dropbox_sign/models/account_response_quotas.py @@ -33,27 +33,22 @@ class AccountResponseQuotas(BaseModel): """ # noqa: E501 api_signature_requests_left: Optional[StrictInt] = Field( - default=0, - description="API signature requests remaining. A value of `-1` means unlimited.", + default=0, description="API signature requests remaining." ) documents_left: Optional[StrictInt] = Field( - default=0, - description="Signature requests remaining. A value of `-1` means unlimited.", + default=0, description="Signature requests remaining." ) templates_total: Optional[StrictInt] = Field( - default=0, - description="Total API templates allowed. A value of `-1` means unlimited.", + default=0, description="Total API templates allowed." ) templates_left: Optional[StrictInt] = Field( - default=0, - description="API templates remaining. A value of `-1` means unlimited.", + default=0, description="API templates remaining." ) sms_verifications_left: Optional[StrictInt] = Field( default=0, description="SMS verifications remaining." ) num_fax_pages_left: Optional[StrictInt] = Field( - default=0, - description="Number of fax pages left. A value of `-1` means unlimited.", + default=0, description="Number of fax pages left" ) __properties: ClassVar[List[str]] = [ "api_signature_requests_left", diff --git a/sdks/ruby/docs/AccountResponseQuotas.md b/sdks/ruby/docs/AccountResponseQuotas.md index 66b374ff2..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. A value of `-1` means unlimited. | [default to 0] | -| `documents_left` | ```Integer``` | Signature requests remaining. A value of `-1` means unlimited. | [default to 0] | -| `templates_total` | ```Integer``` | Total API templates allowed. A value of `-1` means unlimited. | [default to 0] | -| `templates_left` | ```Integer``` | API templates remaining. A value of `-1` means unlimited. | [default to 0] | +| `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. A value of `-1` means unlimited. | [default to 0] | +| `num_fax_pages_left` | ```Integer``` | Number of fax pages left | [default to 0] | 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 28f09bde2..d202a1c1b 100644 --- a/sdks/ruby/lib/dropbox-sign/models/account_response_quotas.rb +++ b/sdks/ruby/lib/dropbox-sign/models/account_response_quotas.rb @@ -19,19 +19,19 @@ module Dropbox module Dropbox::Sign # Details concerning remaining monthly quotas. class AccountResponseQuotas - # API signature requests remaining. A value of `-1` means unlimited. + # API signature requests remaining. # @return [Integer, nil] attr_accessor :api_signature_requests_left - # Signature requests remaining. A value of `-1` means unlimited. + # Signature requests remaining. # @return [Integer, nil] attr_accessor :documents_left - # Total API templates allowed. A value of `-1` means unlimited. + # Total API templates allowed. # @return [Integer, nil] attr_accessor :templates_total - # API templates remaining. A value of `-1` means unlimited. + # API templates remaining. # @return [Integer, nil] attr_accessor :templates_left @@ -39,7 +39,7 @@ class AccountResponseQuotas # @return [Integer, nil] attr_accessor :sms_verifications_left - # Number of fax pages left. A value of `-1` means unlimited. + # Number of fax pages left # @return [Integer, nil] attr_accessor :num_fax_pages_left diff --git a/translations/en.yaml b/translations/en.yaml index 67e1ecc41..53aa2306d 100644 --- a/translations/en.yaml +++ b/translations/en.yaml @@ -1197,12 +1197,12 @@ "Account::LOCALE": The locale used in this Account. Check out the list of [supported locales](/api/reference/constants/#supported-locales) to learn more about the possible values. "Account::QUOTA": Details concerning remaining monthly quotas. "Account::USAGE": Details concerning monthly usage -"AccountQuota::TEMPLATES_LEFT": API templates remaining. A value of `-1` means unlimited. -"AccountQuota::TEMPLATES_TOTAL": Total API templates allowed. A value of `-1` means unlimited. -"AccountQuota::API_SIGNATURE_REQUESTS_LEFT": API signature requests remaining. A value of `-1` means unlimited. -"AccountQuota::DOCUMENTS_LEFT": Signature requests remaining. A value of `-1` means unlimited. +"AccountQuota::TEMPLATES_LEFT": API templates remaining. +"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::NUM_FAX_PAGES_LEFT": Number of fax pages left. A value of `-1` means unlimited. +"AccountQuota::NUM_FAX_PAGES_LEFT": Number of fax pages left "AccountUsage::FAX_PAGES_SENT": Number of fax pages sent "ApiAppCreateResponseExample::SUMMARY": API App From caa734967f1f854925163301da149fd7cc7ddf52 Mon Sep 17 00:00:00 2001 From: Juan Treminio Date: Fri, 18 Oct 2024 12:17:59 -0500 Subject: [PATCH 4/4] Revert changes to "required" --- openapi-raw.yaml | 8 -- openapi-sdk.yaml | 8 -- openapi.yaml | 8 -- sdks/dotnet/docs/AccountResponse.md | 2 +- sdks/dotnet/docs/AccountResponseUsage.md | 2 +- .../src/Dropbox.Sign/Model/AccountResponse.cs | 80 +++++------ .../Model/AccountResponseUsage.cs | 4 +- sdks/java-v1/docs/AccountResponse.md | 10 +- sdks/java-v1/docs/AccountResponseUsage.md | 2 +- .../dropbox/sign/model/AccountResponse.java | 133 +++++++++--------- .../sign/model/AccountResponseUsage.java | 7 +- sdks/java-v2/docs/AccountResponse.md | 10 +- sdks/java-v2/docs/AccountResponseUsage.md | 2 +- .../dropbox/sign/model/AccountResponse.java | 132 ++++++++--------- .../sign/model/AccountResponseUsage.java | 6 +- sdks/node/dist/api.js | 10 +- sdks/node/docs/model/AccountResponse.md | 10 +- sdks/node/docs/model/AccountResponseUsage.md | 2 +- sdks/node/model/accountResponse.ts | 28 ++-- sdks/node/model/accountResponseUsage.ts | 2 +- sdks/node/types/model/accountResponse.d.ts | 10 +- .../types/model/accountResponseUsage.d.ts | 2 +- sdks/php/docs/Model/AccountResponse.md | 10 +- sdks/php/docs/Model/AccountResponseUsage.md | 2 +- sdks/php/src/Model/AccountResponse.php | 117 +++++++-------- sdks/php/src/Model/AccountResponseUsage.php | 13 +- sdks/python/docs/AccountResponse.md | 10 +- sdks/python/docs/AccountResponseUsage.md | 2 +- .../dropbox_sign/models/account_response.py | 31 ++-- .../models/account_response_usage.py | 6 +- sdks/ruby/docs/AccountResponse.md | 10 +- sdks/ruby/docs/AccountResponseUsage.md | 2 +- .../dropbox-sign/models/account_response.rb | 49 ++----- .../models/account_response_usage.rb | 5 - 34 files changed, 325 insertions(+), 410 deletions(-) diff --git a/openapi-raw.yaml b/openapi-raw.yaml index 2d701a8ea..daa800714 100644 --- a/openapi-raw.yaml +++ b/openapi-raw.yaml @@ -9746,12 +9746,6 @@ components: type: object x-internal-class: true AccountResponse: - required: - - account_id - - is_locked - - is_paid_hs - - is_paid_hf - - quotas properties: account_id: description: '_t__Account::ACCOUNT_ID' @@ -9843,8 +9837,6 @@ components: x-internal-class: true AccountResponseUsage: description: '_t__Account::USAGE' - required: - - fax_pages_sent properties: fax_pages_sent: description: '_t__AccountUsage::FAX_PAGES_SENT' diff --git a/openapi-sdk.yaml b/openapi-sdk.yaml index e48040c88..39bd58e57 100644 --- a/openapi-sdk.yaml +++ b/openapi-sdk.yaml @@ -10354,12 +10354,6 @@ components: type: object x-internal-class: true AccountResponse: - required: - - account_id - - is_locked - - is_paid_hs - - is_paid_hf - - quotas properties: account_id: description: 'The ID of the Account' @@ -10451,8 +10445,6 @@ components: x-internal-class: true AccountResponseUsage: description: 'Details concerning monthly usage' - required: - - fax_pages_sent properties: fax_pages_sent: description: 'Number of fax pages sent' diff --git a/openapi.yaml b/openapi.yaml index e992a7caf..2e044d5f8 100644 --- a/openapi.yaml +++ b/openapi.yaml @@ -10332,12 +10332,6 @@ components: type: object x-internal-class: true AccountResponse: - required: - - account_id - - is_locked - - is_paid_hs - - is_paid_hf - - quotas properties: account_id: description: 'The ID of the Account' @@ -10429,8 +10423,6 @@ components: x-internal-class: true AccountResponseUsage: description: 'Details concerning monthly usage' - required: - - fax_pages_sent properties: fax_pages_sent: description: 'Number of fax pages sent' diff --git a/sdks/dotnet/docs/AccountResponse.md b/sdks/dotnet/docs/AccountResponse.md index 8b57e4692..2f9672466 100644 --- a/sdks/dotnet/docs/AccountResponse.md +++ b/sdks/dotnet/docs/AccountResponse.md @@ -4,7 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**AccountId** | **string** | The ID of the Account | **IsLocked** | **bool** | Returns `true` if the user has been locked out of their account by a team admin. | **IsPaidHs** | **bool** | Returns `true` if the user has a paid Dropbox Sign account. | **IsPaidHf** | **bool** | Returns `true` if the user has a paid HelloFax account. | **Quotas** | [**AccountResponseQuotas**](AccountResponseQuotas.md) | | **EmailAddress** | **string** | The email address associated with the Account. | [optional] **CallbackUrl** | **string** | The URL that Dropbox Sign events will `POST` to. | [optional] **RoleCode** | **string** | The membership role for the team. | [optional] **TeamId** | **string** | The id of the team account belongs to. | [optional] **Locale** | **string** | The locale used in this Account. Check out the list of [supported locales](/api/reference/constants/#supported-locales) to learn more about the possible values. | [optional] **Usage** | [**AccountResponseUsage**](AccountResponseUsage.md) | | [optional] +**AccountId** | **string** | The ID of the Account | [optional] **EmailAddress** | **string** | The email address associated with the Account. | [optional] **IsLocked** | **bool** | Returns `true` if the user has been locked out of their account by a team admin. | [optional] **IsPaidHs** | **bool** | Returns `true` if the user has a paid Dropbox Sign account. | [optional] **IsPaidHf** | **bool** | Returns `true` if the user has a paid HelloFax account. | [optional] **Quotas** | [**AccountResponseQuotas**](AccountResponseQuotas.md) | | [optional] **CallbackUrl** | **string** | The URL that Dropbox Sign events will `POST` to. | [optional] **RoleCode** | **string** | The membership role for the team. | [optional] **TeamId** | **string** | The id of the team account belongs to. | [optional] **Locale** | **string** | The locale used in this Account. Check out the list of [supported locales](/api/reference/constants/#supported-locales) to learn more about the possible values. | [optional] **Usage** | [**AccountResponseUsage**](AccountResponseUsage.md) | | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/sdks/dotnet/docs/AccountResponseUsage.md b/sdks/dotnet/docs/AccountResponseUsage.md index 9cd85a179..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 | [default to 0] +**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/src/Dropbox.Sign/Model/AccountResponse.cs b/sdks/dotnet/src/Dropbox.Sign/Model/AccountResponse.cs index a67bff328..6d65726d7 100644 --- a/sdks/dotnet/src/Dropbox.Sign/Model/AccountResponse.cs +++ b/sdks/dotnet/src/Dropbox.Sign/Model/AccountResponse.cs @@ -41,12 +41,12 @@ protected AccountResponse() { } /// /// Initializes a new instance of the class. /// - /// The ID of the Account (required). + /// The ID of the Account. /// The email address associated with the Account.. - /// Returns `true` if the user has been locked out of their account by a team admin. (required). - /// Returns `true` if the user has a paid Dropbox Sign account. (required). - /// Returns `true` if the user has a paid HelloFax account. (required). - /// quotas (required). + /// Returns `true` if the user has been locked out of their account by a team admin.. + /// Returns `true` if the user has a paid Dropbox Sign account.. + /// Returns `true` if the user has a paid HelloFax account.. + /// quotas. /// The URL that Dropbox Sign events will `POST` to.. /// The membership role for the team.. /// The id of the team account belongs to.. @@ -55,22 +55,12 @@ protected AccountResponse() { } public AccountResponse(string accountId = default(string), string emailAddress = default(string), bool isLocked = default(bool), bool isPaidHs = default(bool), bool isPaidHf = default(bool), AccountResponseQuotas quotas = default(AccountResponseQuotas), string callbackUrl = default(string), string roleCode = default(string), string teamId = default(string), string locale = default(string), AccountResponseUsage usage = default(AccountResponseUsage)) { - // to ensure "accountId" is required (not null) - if (accountId == null) - { - throw new ArgumentNullException("accountId is a required property for AccountResponse and cannot be null"); - } this.AccountId = accountId; + this.EmailAddress = emailAddress; this.IsLocked = isLocked; this.IsPaidHs = isPaidHs; this.IsPaidHf = isPaidHf; - // to ensure "quotas" is required (not null) - if (quotas == null) - { - throw new ArgumentNullException("quotas is a required property for AccountResponse and cannot be null"); - } this.Quotas = quotas; - this.EmailAddress = emailAddress; this.CallbackUrl = callbackUrl; this.RoleCode = roleCode; this.TeamId = teamId; @@ -98,43 +88,43 @@ public static AccountResponse Init(string jsonData) /// The ID of the Account /// /// The ID of the Account - [DataMember(Name = "account_id", IsRequired = true, EmitDefaultValue = true)] + [DataMember(Name = "account_id", EmitDefaultValue = true)] public string AccountId { get; set; } + /// + /// The email address associated with the Account. + /// + /// The email address associated with the Account. + [DataMember(Name = "email_address", EmitDefaultValue = true)] + public string EmailAddress { get; set; } + /// /// Returns `true` if the user has been locked out of their account by a team admin. /// /// Returns `true` if the user has been locked out of their account by a team admin. - [DataMember(Name = "is_locked", IsRequired = true, EmitDefaultValue = true)] + [DataMember(Name = "is_locked", EmitDefaultValue = true)] public bool IsLocked { get; set; } /// /// Returns `true` if the user has a paid Dropbox Sign account. /// /// Returns `true` if the user has a paid Dropbox Sign account. - [DataMember(Name = "is_paid_hs", IsRequired = true, EmitDefaultValue = true)] + [DataMember(Name = "is_paid_hs", EmitDefaultValue = true)] public bool IsPaidHs { get; set; } /// /// Returns `true` if the user has a paid HelloFax account. /// /// Returns `true` if the user has a paid HelloFax account. - [DataMember(Name = "is_paid_hf", IsRequired = true, EmitDefaultValue = true)] + [DataMember(Name = "is_paid_hf", EmitDefaultValue = true)] public bool IsPaidHf { get; set; } /// /// Gets or Sets Quotas /// - [DataMember(Name = "quotas", IsRequired = true, EmitDefaultValue = true)] + [DataMember(Name = "quotas", EmitDefaultValue = true)] public AccountResponseQuotas Quotas { get; set; } - /// - /// The email address associated with the Account. - /// - /// The email address associated with the Account. - [DataMember(Name = "email_address", EmitDefaultValue = true)] - public string EmailAddress { get; set; } - /// /// The URL that Dropbox Sign events will `POST` to. /// @@ -178,11 +168,11 @@ public override string ToString() StringBuilder sb = new StringBuilder(); sb.Append("class AccountResponse {\n"); sb.Append(" AccountId: ").Append(AccountId).Append("\n"); + sb.Append(" EmailAddress: ").Append(EmailAddress).Append("\n"); sb.Append(" IsLocked: ").Append(IsLocked).Append("\n"); sb.Append(" IsPaidHs: ").Append(IsPaidHs).Append("\n"); sb.Append(" IsPaidHf: ").Append(IsPaidHf).Append("\n"); sb.Append(" Quotas: ").Append(Quotas).Append("\n"); - sb.Append(" EmailAddress: ").Append(EmailAddress).Append("\n"); sb.Append(" CallbackUrl: ").Append(CallbackUrl).Append("\n"); sb.Append(" RoleCode: ").Append(RoleCode).Append("\n"); sb.Append(" TeamId: ").Append(TeamId).Append("\n"); @@ -228,6 +218,11 @@ public bool Equals(AccountResponse input) (this.AccountId != null && this.AccountId.Equals(input.AccountId)) ) && + ( + this.EmailAddress == input.EmailAddress || + (this.EmailAddress != null && + this.EmailAddress.Equals(input.EmailAddress)) + ) && ( this.IsLocked == input.IsLocked || this.IsLocked.Equals(input.IsLocked) @@ -245,11 +240,6 @@ public bool Equals(AccountResponse input) (this.Quotas != null && this.Quotas.Equals(input.Quotas)) ) && - ( - this.EmailAddress == input.EmailAddress || - (this.EmailAddress != null && - this.EmailAddress.Equals(input.EmailAddress)) - ) && ( this.CallbackUrl == input.CallbackUrl || (this.CallbackUrl != null && @@ -290,6 +280,10 @@ public override int GetHashCode() { hashCode = (hashCode * 59) + this.AccountId.GetHashCode(); } + if (this.EmailAddress != null) + { + hashCode = (hashCode * 59) + this.EmailAddress.GetHashCode(); + } hashCode = (hashCode * 59) + this.IsLocked.GetHashCode(); hashCode = (hashCode * 59) + this.IsPaidHs.GetHashCode(); hashCode = (hashCode * 59) + this.IsPaidHf.GetHashCode(); @@ -297,10 +291,6 @@ public override int GetHashCode() { hashCode = (hashCode * 59) + this.Quotas.GetHashCode(); } - if (this.EmailAddress != null) - { - hashCode = (hashCode * 59) + this.EmailAddress.GetHashCode(); - } if (this.CallbackUrl != null) { hashCode = (hashCode * 59) + this.CallbackUrl.GetHashCode(); @@ -345,6 +335,13 @@ public List GetOpenApiTypes() Value = AccountId, }); types.Add(new OpenApiType() + { + Name = "email_address", + Property = "EmailAddress", + Type = "string", + Value = EmailAddress, + }); + types.Add(new OpenApiType() { Name = "is_locked", Property = "IsLocked", @@ -373,13 +370,6 @@ public List GetOpenApiTypes() Value = Quotas, }); types.Add(new OpenApiType() - { - Name = "email_address", - Property = "EmailAddress", - Type = "string", - Value = EmailAddress, - }); - types.Add(new OpenApiType() { Name = "callback_url", Property = "CallbackUrl", diff --git a/sdks/dotnet/src/Dropbox.Sign/Model/AccountResponseUsage.cs b/sdks/dotnet/src/Dropbox.Sign/Model/AccountResponseUsage.cs index 06d953041..dd51fdcb5 100644 --- a/sdks/dotnet/src/Dropbox.Sign/Model/AccountResponseUsage.cs +++ b/sdks/dotnet/src/Dropbox.Sign/Model/AccountResponseUsage.cs @@ -41,7 +41,7 @@ protected AccountResponseUsage() { } /// /// Initializes a new instance of the class. /// - /// Number of fax pages sent (required) (default to 0). + /// Number of fax pages sent (default to 0). public AccountResponseUsage(int faxPagesSent = 0) { @@ -68,7 +68,7 @@ public static AccountResponseUsage Init(string jsonData) /// Number of fax pages sent /// /// Number of fax pages sent - [DataMember(Name = "fax_pages_sent", IsRequired = true, EmitDefaultValue = true)] + [DataMember(Name = "fax_pages_sent", EmitDefaultValue = true)] public int FaxPagesSent { get; set; } /// diff --git a/sdks/java-v1/docs/AccountResponse.md b/sdks/java-v1/docs/AccountResponse.md index 000d9a54d..5b73aa02d 100644 --- a/sdks/java-v1/docs/AccountResponse.md +++ b/sdks/java-v1/docs/AccountResponse.md @@ -8,12 +8,12 @@ | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| -| `accountId`*_required_ | ```String``` | The ID of the Account | | -| `isLocked`*_required_ | ```Boolean``` | Returns `true` if the user has been locked out of their account by a team admin. | | -| `isPaidHs`*_required_ | ```Boolean``` | Returns `true` if the user has a paid Dropbox Sign account. | | -| `isPaidHf`*_required_ | ```Boolean``` | Returns `true` if the user has a paid HelloFax account. | | -| `quotas`*_required_ | [```AccountResponseQuotas```](AccountResponseQuotas.md) | | | +| `accountId` | ```String``` | The ID of the Account | | | `emailAddress` | ```String``` | The email address associated with the Account. | | +| `isLocked` | ```Boolean``` | Returns `true` if the user has been locked out of their account by a team admin. | | +| `isPaidHs` | ```Boolean``` | Returns `true` if the user has a paid Dropbox Sign account. | | +| `isPaidHf` | ```Boolean``` | Returns `true` if the user has a paid HelloFax account. | | +| `quotas` | [```AccountResponseQuotas```](AccountResponseQuotas.md) | | | | `callbackUrl` | ```String``` | The URL that Dropbox Sign events will `POST` to. | | | `roleCode` | ```String``` | The membership role for the team. | | | `teamId` | ```String``` | The id of the team account belongs to. | | diff --git a/sdks/java-v1/docs/AccountResponseUsage.md b/sdks/java-v1/docs/AccountResponseUsage.md index af34642c7..1cdb76629 100644 --- a/sdks/java-v1/docs/AccountResponseUsage.md +++ b/sdks/java-v1/docs/AccountResponseUsage.md @@ -8,7 +8,7 @@ Details concerning monthly usage | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| -| `faxPagesSent`*_required_ | ```Integer``` | Number of fax pages sent | | +| `faxPagesSent` | ```Integer``` | Number of fax pages sent | | diff --git a/sdks/java-v1/src/main/java/com/dropbox/sign/model/AccountResponse.java b/sdks/java-v1/src/main/java/com/dropbox/sign/model/AccountResponse.java index 8eaae02e1..541c7f61d 100644 --- a/sdks/java-v1/src/main/java/com/dropbox/sign/model/AccountResponse.java +++ b/sdks/java-v1/src/main/java/com/dropbox/sign/model/AccountResponse.java @@ -26,11 +26,11 @@ /** AccountResponse */ @JsonPropertyOrder({ AccountResponse.JSON_PROPERTY_ACCOUNT_ID, + AccountResponse.JSON_PROPERTY_EMAIL_ADDRESS, AccountResponse.JSON_PROPERTY_IS_LOCKED, AccountResponse.JSON_PROPERTY_IS_PAID_HS, AccountResponse.JSON_PROPERTY_IS_PAID_HF, AccountResponse.JSON_PROPERTY_QUOTAS, - AccountResponse.JSON_PROPERTY_EMAIL_ADDRESS, AccountResponse.JSON_PROPERTY_CALLBACK_URL, AccountResponse.JSON_PROPERTY_ROLE_CODE, AccountResponse.JSON_PROPERTY_TEAM_ID, @@ -45,6 +45,9 @@ public class AccountResponse { public static final String JSON_PROPERTY_ACCOUNT_ID = "account_id"; private String accountId; + public static final String JSON_PROPERTY_EMAIL_ADDRESS = "email_address"; + private String emailAddress; + public static final String JSON_PROPERTY_IS_LOCKED = "is_locked"; private Boolean isLocked; @@ -57,9 +60,6 @@ public class AccountResponse { public static final String JSON_PROPERTY_QUOTAS = "quotas"; private AccountResponseQuotas quotas; - public static final String JSON_PROPERTY_EMAIL_ADDRESS = "email_address"; - private String emailAddress; - public static final String JSON_PROPERTY_CALLBACK_URL = "callback_url"; private String callbackUrl; @@ -101,19 +101,40 @@ public AccountResponse accountId(String accountId) { * * @return accountId */ - @javax.annotation.Nonnull - @JsonProperty(JSON_PROPERTY_ACCOUNT_ID) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_ACCOUNT_ID) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public String getAccountId() { return accountId; } @JsonProperty(JSON_PROPERTY_ACCOUNT_ID) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAccountId(String accountId) { this.accountId = accountId; } + public AccountResponse emailAddress(String emailAddress) { + this.emailAddress = emailAddress; + return this; + } + + /** + * The email address associated with the Account. + * + * @return emailAddress + */ + @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_EMAIL_ADDRESS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public String getEmailAddress() { + return emailAddress; + } + + @JsonProperty(JSON_PROPERTY_EMAIL_ADDRESS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setEmailAddress(String emailAddress) { + this.emailAddress = emailAddress; + } + public AccountResponse isLocked(Boolean isLocked) { this.isLocked = isLocked; return this; @@ -124,15 +145,14 @@ public AccountResponse isLocked(Boolean isLocked) { * * @return isLocked */ - @javax.annotation.Nonnull - @JsonProperty(JSON_PROPERTY_IS_LOCKED) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_IS_LOCKED) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public Boolean getIsLocked() { return isLocked; } @JsonProperty(JSON_PROPERTY_IS_LOCKED) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setIsLocked(Boolean isLocked) { this.isLocked = isLocked; } @@ -147,15 +167,14 @@ public AccountResponse isPaidHs(Boolean isPaidHs) { * * @return isPaidHs */ - @javax.annotation.Nonnull - @JsonProperty(JSON_PROPERTY_IS_PAID_HS) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_IS_PAID_HS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public Boolean getIsPaidHs() { return isPaidHs; } @JsonProperty(JSON_PROPERTY_IS_PAID_HS) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setIsPaidHs(Boolean isPaidHs) { this.isPaidHs = isPaidHs; } @@ -170,15 +189,14 @@ public AccountResponse isPaidHf(Boolean isPaidHf) { * * @return isPaidHf */ - @javax.annotation.Nonnull - @JsonProperty(JSON_PROPERTY_IS_PAID_HF) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_IS_PAID_HF) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public Boolean getIsPaidHf() { return isPaidHf; } @JsonProperty(JSON_PROPERTY_IS_PAID_HF) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setIsPaidHf(Boolean isPaidHf) { this.isPaidHf = isPaidHf; } @@ -193,41 +211,18 @@ public AccountResponse quotas(AccountResponseQuotas quotas) { * * @return quotas */ - @javax.annotation.Nonnull - @JsonProperty(JSON_PROPERTY_QUOTAS) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_QUOTAS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public AccountResponseQuotas getQuotas() { return quotas; } @JsonProperty(JSON_PROPERTY_QUOTAS) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setQuotas(AccountResponseQuotas quotas) { this.quotas = quotas; } - public AccountResponse emailAddress(String emailAddress) { - this.emailAddress = emailAddress; - return this; - } - - /** - * The email address associated with the Account. - * - * @return emailAddress - */ - @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_EMAIL_ADDRESS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public String getEmailAddress() { - return emailAddress; - } - - @JsonProperty(JSON_PROPERTY_EMAIL_ADDRESS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setEmailAddress(String emailAddress) { - this.emailAddress = emailAddress; - } - public AccountResponse callbackUrl(String callbackUrl) { this.callbackUrl = callbackUrl; return this; @@ -351,11 +346,11 @@ public boolean equals(Object o) { } AccountResponse accountResponse = (AccountResponse) o; return Objects.equals(this.accountId, accountResponse.accountId) + && Objects.equals(this.emailAddress, accountResponse.emailAddress) && Objects.equals(this.isLocked, accountResponse.isLocked) && Objects.equals(this.isPaidHs, accountResponse.isPaidHs) && Objects.equals(this.isPaidHf, accountResponse.isPaidHf) && Objects.equals(this.quotas, accountResponse.quotas) - && Objects.equals(this.emailAddress, accountResponse.emailAddress) && Objects.equals(this.callbackUrl, accountResponse.callbackUrl) && Objects.equals(this.roleCode, accountResponse.roleCode) && Objects.equals(this.teamId, accountResponse.teamId) @@ -367,11 +362,11 @@ public boolean equals(Object o) { public int hashCode() { return Objects.hash( accountId, + emailAddress, isLocked, isPaidHs, isPaidHf, quotas, - emailAddress, callbackUrl, roleCode, teamId, @@ -384,11 +379,11 @@ public String toString() { StringBuilder sb = new StringBuilder(); sb.append("class AccountResponse {\n"); sb.append(" accountId: ").append(toIndentedString(accountId)).append("\n"); + sb.append(" emailAddress: ").append(toIndentedString(emailAddress)).append("\n"); sb.append(" isLocked: ").append(toIndentedString(isLocked)).append("\n"); sb.append(" isPaidHs: ").append(toIndentedString(isPaidHs)).append("\n"); sb.append(" isPaidHf: ").append(toIndentedString(isPaidHf)).append("\n"); sb.append(" quotas: ").append(toIndentedString(quotas)).append("\n"); - sb.append(" emailAddress: ").append(toIndentedString(emailAddress)).append("\n"); sb.append(" callbackUrl: ").append(toIndentedString(callbackUrl)).append("\n"); sb.append(" roleCode: ").append(toIndentedString(roleCode)).append("\n"); sb.append(" teamId: ").append(toIndentedString(teamId)).append("\n"); @@ -422,6 +417,26 @@ public Map createFormData() throws ApiException { JSON.getDefault().getMapper().writeValueAsString(accountId)); } } + if (emailAddress != null) { + if (isFileTypeOrListOfFiles(emailAddress)) { + fileTypeFound = true; + } + + if (emailAddress.getClass().equals(java.io.File.class) + || emailAddress.getClass().equals(Integer.class) + || emailAddress.getClass().equals(String.class) + || emailAddress.getClass().isEnum()) { + map.put("email_address", emailAddress); + } else if (isListOfFile(emailAddress)) { + for (int i = 0; i < getListSize(emailAddress); i++) { + map.put("email_address[" + i + "]", getFromList(emailAddress, i)); + } + } else { + map.put( + "email_address", + JSON.getDefault().getMapper().writeValueAsString(emailAddress)); + } + } if (isLocked != null) { if (isFileTypeOrListOfFiles(isLocked)) { fileTypeFound = true; @@ -500,26 +515,6 @@ public Map createFormData() throws ApiException { map.put("quotas", JSON.getDefault().getMapper().writeValueAsString(quotas)); } } - if (emailAddress != null) { - if (isFileTypeOrListOfFiles(emailAddress)) { - fileTypeFound = true; - } - - if (emailAddress.getClass().equals(java.io.File.class) - || emailAddress.getClass().equals(Integer.class) - || emailAddress.getClass().equals(String.class) - || emailAddress.getClass().isEnum()) { - map.put("email_address", emailAddress); - } else if (isListOfFile(emailAddress)) { - for (int i = 0; i < getListSize(emailAddress); i++) { - map.put("email_address[" + i + "]", getFromList(emailAddress, i)); - } - } else { - map.put( - "email_address", - JSON.getDefault().getMapper().writeValueAsString(emailAddress)); - } - } if (callbackUrl != null) { if (isFileTypeOrListOfFiles(callbackUrl)) { fileTypeFound = true; 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 811367cdc..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 @@ -59,15 +59,14 @@ public AccountResponseUsage faxPagesSent(Integer faxPagesSent) { * * @return faxPagesSent */ - @javax.annotation.Nonnull - @JsonProperty(JSON_PROPERTY_FAX_PAGES_SENT) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_FAX_PAGES_SENT) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public Integer getFaxPagesSent() { return faxPagesSent; } @JsonProperty(JSON_PROPERTY_FAX_PAGES_SENT) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setFaxPagesSent(Integer faxPagesSent) { this.faxPagesSent = faxPagesSent; } diff --git a/sdks/java-v2/docs/AccountResponse.md b/sdks/java-v2/docs/AccountResponse.md index 000d9a54d..5b73aa02d 100644 --- a/sdks/java-v2/docs/AccountResponse.md +++ b/sdks/java-v2/docs/AccountResponse.md @@ -8,12 +8,12 @@ | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| -| `accountId`*_required_ | ```String``` | The ID of the Account | | -| `isLocked`*_required_ | ```Boolean``` | Returns `true` if the user has been locked out of their account by a team admin. | | -| `isPaidHs`*_required_ | ```Boolean``` | Returns `true` if the user has a paid Dropbox Sign account. | | -| `isPaidHf`*_required_ | ```Boolean``` | Returns `true` if the user has a paid HelloFax account. | | -| `quotas`*_required_ | [```AccountResponseQuotas```](AccountResponseQuotas.md) | | | +| `accountId` | ```String``` | The ID of the Account | | | `emailAddress` | ```String``` | The email address associated with the Account. | | +| `isLocked` | ```Boolean``` | Returns `true` if the user has been locked out of their account by a team admin. | | +| `isPaidHs` | ```Boolean``` | Returns `true` if the user has a paid Dropbox Sign account. | | +| `isPaidHf` | ```Boolean``` | Returns `true` if the user has a paid HelloFax account. | | +| `quotas` | [```AccountResponseQuotas```](AccountResponseQuotas.md) | | | | `callbackUrl` | ```String``` | The URL that Dropbox Sign events will `POST` to. | | | `roleCode` | ```String``` | The membership role for the team. | | | `teamId` | ```String``` | The id of the team account belongs to. | | diff --git a/sdks/java-v2/docs/AccountResponseUsage.md b/sdks/java-v2/docs/AccountResponseUsage.md index af34642c7..1cdb76629 100644 --- a/sdks/java-v2/docs/AccountResponseUsage.md +++ b/sdks/java-v2/docs/AccountResponseUsage.md @@ -8,7 +8,7 @@ Details concerning monthly usage | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| -| `faxPagesSent`*_required_ | ```Integer``` | Number of fax pages sent | | +| `faxPagesSent` | ```Integer``` | Number of fax pages sent | | diff --git a/sdks/java-v2/src/main/java/com/dropbox/sign/model/AccountResponse.java b/sdks/java-v2/src/main/java/com/dropbox/sign/model/AccountResponse.java index 405fe0b00..6f431abf6 100644 --- a/sdks/java-v2/src/main/java/com/dropbox/sign/model/AccountResponse.java +++ b/sdks/java-v2/src/main/java/com/dropbox/sign/model/AccountResponse.java @@ -36,11 +36,11 @@ */ @JsonPropertyOrder({ AccountResponse.JSON_PROPERTY_ACCOUNT_ID, + AccountResponse.JSON_PROPERTY_EMAIL_ADDRESS, AccountResponse.JSON_PROPERTY_IS_LOCKED, AccountResponse.JSON_PROPERTY_IS_PAID_HS, AccountResponse.JSON_PROPERTY_IS_PAID_HF, AccountResponse.JSON_PROPERTY_QUOTAS, - AccountResponse.JSON_PROPERTY_EMAIL_ADDRESS, AccountResponse.JSON_PROPERTY_CALLBACK_URL, AccountResponse.JSON_PROPERTY_ROLE_CODE, AccountResponse.JSON_PROPERTY_TEAM_ID, @@ -53,6 +53,9 @@ public class AccountResponse { public static final String JSON_PROPERTY_ACCOUNT_ID = "account_id"; private String accountId; + public static final String JSON_PROPERTY_EMAIL_ADDRESS = "email_address"; + private String emailAddress; + public static final String JSON_PROPERTY_IS_LOCKED = "is_locked"; private Boolean isLocked; @@ -65,9 +68,6 @@ public class AccountResponse { public static final String JSON_PROPERTY_QUOTAS = "quotas"; private AccountResponseQuotas quotas; - public static final String JSON_PROPERTY_EMAIL_ADDRESS = "email_address"; - private String emailAddress; - public static final String JSON_PROPERTY_CALLBACK_URL = "callback_url"; private String callbackUrl; @@ -110,9 +110,9 @@ public AccountResponse accountId(String accountId) { * The ID of the Account * @return accountId */ - @jakarta.annotation.Nonnull + @jakarta.annotation.Nullable @JsonProperty(JSON_PROPERTY_ACCOUNT_ID) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public String getAccountId() { return accountId; @@ -120,12 +120,37 @@ public String getAccountId() { @JsonProperty(JSON_PROPERTY_ACCOUNT_ID) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAccountId(String accountId) { this.accountId = accountId; } + public AccountResponse emailAddress(String emailAddress) { + this.emailAddress = emailAddress; + return this; + } + + /** + * The email address associated with the Account. + * @return emailAddress + */ + @jakarta.annotation.Nullable + @JsonProperty(JSON_PROPERTY_EMAIL_ADDRESS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public String getEmailAddress() { + return emailAddress; + } + + + @JsonProperty(JSON_PROPERTY_EMAIL_ADDRESS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setEmailAddress(String emailAddress) { + this.emailAddress = emailAddress; + } + + public AccountResponse isLocked(Boolean isLocked) { this.isLocked = isLocked; return this; @@ -135,9 +160,9 @@ public AccountResponse isLocked(Boolean isLocked) { * Returns `true` if the user has been locked out of their account by a team admin. * @return isLocked */ - @jakarta.annotation.Nonnull + @jakarta.annotation.Nullable @JsonProperty(JSON_PROPERTY_IS_LOCKED) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public Boolean getIsLocked() { return isLocked; @@ -145,7 +170,7 @@ public Boolean getIsLocked() { @JsonProperty(JSON_PROPERTY_IS_LOCKED) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setIsLocked(Boolean isLocked) { this.isLocked = isLocked; } @@ -160,9 +185,9 @@ public AccountResponse isPaidHs(Boolean isPaidHs) { * Returns `true` if the user has a paid Dropbox Sign account. * @return isPaidHs */ - @jakarta.annotation.Nonnull + @jakarta.annotation.Nullable @JsonProperty(JSON_PROPERTY_IS_PAID_HS) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public Boolean getIsPaidHs() { return isPaidHs; @@ -170,7 +195,7 @@ public Boolean getIsPaidHs() { @JsonProperty(JSON_PROPERTY_IS_PAID_HS) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setIsPaidHs(Boolean isPaidHs) { this.isPaidHs = isPaidHs; } @@ -185,9 +210,9 @@ public AccountResponse isPaidHf(Boolean isPaidHf) { * Returns `true` if the user has a paid HelloFax account. * @return isPaidHf */ - @jakarta.annotation.Nonnull + @jakarta.annotation.Nullable @JsonProperty(JSON_PROPERTY_IS_PAID_HF) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public Boolean getIsPaidHf() { return isPaidHf; @@ -195,7 +220,7 @@ public Boolean getIsPaidHf() { @JsonProperty(JSON_PROPERTY_IS_PAID_HF) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setIsPaidHf(Boolean isPaidHf) { this.isPaidHf = isPaidHf; } @@ -210,9 +235,9 @@ public AccountResponse quotas(AccountResponseQuotas quotas) { * Get quotas * @return quotas */ - @jakarta.annotation.Nonnull + @jakarta.annotation.Nullable @JsonProperty(JSON_PROPERTY_QUOTAS) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public AccountResponseQuotas getQuotas() { return quotas; @@ -220,37 +245,12 @@ public AccountResponseQuotas getQuotas() { @JsonProperty(JSON_PROPERTY_QUOTAS) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setQuotas(AccountResponseQuotas quotas) { this.quotas = quotas; } - public AccountResponse emailAddress(String emailAddress) { - this.emailAddress = emailAddress; - return this; - } - - /** - * The email address associated with the Account. - * @return emailAddress - */ - @jakarta.annotation.Nullable - @JsonProperty(JSON_PROPERTY_EMAIL_ADDRESS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getEmailAddress() { - return emailAddress; - } - - - @JsonProperty(JSON_PROPERTY_EMAIL_ADDRESS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setEmailAddress(String emailAddress) { - this.emailAddress = emailAddress; - } - - public AccountResponse callbackUrl(String callbackUrl) { this.callbackUrl = callbackUrl; return this; @@ -389,11 +389,11 @@ public boolean equals(Object o) { } AccountResponse accountResponse = (AccountResponse) o; return Objects.equals(this.accountId, accountResponse.accountId) && + Objects.equals(this.emailAddress, accountResponse.emailAddress) && Objects.equals(this.isLocked, accountResponse.isLocked) && Objects.equals(this.isPaidHs, accountResponse.isPaidHs) && Objects.equals(this.isPaidHf, accountResponse.isPaidHf) && Objects.equals(this.quotas, accountResponse.quotas) && - Objects.equals(this.emailAddress, accountResponse.emailAddress) && Objects.equals(this.callbackUrl, accountResponse.callbackUrl) && Objects.equals(this.roleCode, accountResponse.roleCode) && Objects.equals(this.teamId, accountResponse.teamId) && @@ -403,7 +403,7 @@ public boolean equals(Object o) { @Override public int hashCode() { - return Objects.hash(accountId, isLocked, isPaidHs, isPaidHf, quotas, emailAddress, callbackUrl, roleCode, teamId, locale, usage); + return Objects.hash(accountId, emailAddress, isLocked, isPaidHs, isPaidHf, quotas, callbackUrl, roleCode, teamId, locale, usage); } @Override @@ -411,11 +411,11 @@ public String toString() { StringBuilder sb = new StringBuilder(); sb.append("class AccountResponse {\n"); sb.append(" accountId: ").append(toIndentedString(accountId)).append("\n"); + sb.append(" emailAddress: ").append(toIndentedString(emailAddress)).append("\n"); sb.append(" isLocked: ").append(toIndentedString(isLocked)).append("\n"); sb.append(" isPaidHs: ").append(toIndentedString(isPaidHs)).append("\n"); sb.append(" isPaidHf: ").append(toIndentedString(isPaidHf)).append("\n"); sb.append(" quotas: ").append(toIndentedString(quotas)).append("\n"); - sb.append(" emailAddress: ").append(toIndentedString(emailAddress)).append("\n"); sb.append(" callbackUrl: ").append(toIndentedString(callbackUrl)).append("\n"); sb.append(" roleCode: ").append(toIndentedString(roleCode)).append("\n"); sb.append(" teamId: ").append(toIndentedString(teamId)).append("\n"); @@ -448,6 +448,25 @@ public Map createFormData() throws ApiException { map.put("account_id", JSON.getDefault().getMapper().writeValueAsString(accountId)); } } + if (emailAddress != null) { + if (isFileTypeOrListOfFiles(emailAddress)) { + fileTypeFound = true; + } + + if (emailAddress.getClass().equals(java.io.File.class) || + emailAddress.getClass().equals(Integer.class) || + emailAddress.getClass().equals(String.class) || + emailAddress.getClass().isEnum()) { + map.put("email_address", emailAddress); + } else if (isListOfFile(emailAddress)) { + for(int i = 0; i< getListSize(emailAddress); i++) { + map.put("email_address[" + i + "]", getFromList(emailAddress, i)); + } + } + else { + map.put("email_address", JSON.getDefault().getMapper().writeValueAsString(emailAddress)); + } + } if (isLocked != null) { if (isFileTypeOrListOfFiles(isLocked)) { fileTypeFound = true; @@ -524,25 +543,6 @@ public Map createFormData() throws ApiException { map.put("quotas", JSON.getDefault().getMapper().writeValueAsString(quotas)); } } - if (emailAddress != null) { - if (isFileTypeOrListOfFiles(emailAddress)) { - fileTypeFound = true; - } - - if (emailAddress.getClass().equals(java.io.File.class) || - emailAddress.getClass().equals(Integer.class) || - emailAddress.getClass().equals(String.class) || - emailAddress.getClass().isEnum()) { - map.put("email_address", emailAddress); - } else if (isListOfFile(emailAddress)) { - for(int i = 0; i< getListSize(emailAddress); i++) { - map.put("email_address[" + i + "]", getFromList(emailAddress, i)); - } - } - else { - map.put("email_address", JSON.getDefault().getMapper().writeValueAsString(emailAddress)); - } - } if (callbackUrl != null) { if (isFileTypeOrListOfFiles(callbackUrl)) { fileTypeFound = true; 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 4f2308ff0..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 @@ -68,9 +68,9 @@ public AccountResponseUsage faxPagesSent(Integer faxPagesSent) { * Number of fax pages sent * @return faxPagesSent */ - @jakarta.annotation.Nonnull + @jakarta.annotation.Nullable @JsonProperty(JSON_PROPERTY_FAX_PAGES_SENT) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public Integer getFaxPagesSent() { return faxPagesSent; @@ -78,7 +78,7 @@ public Integer getFaxPagesSent() { @JsonProperty(JSON_PROPERTY_FAX_PAGES_SENT) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setFaxPagesSent(Integer faxPagesSent) { this.faxPagesSent = faxPagesSent; } diff --git a/sdks/node/dist/api.js b/sdks/node/dist/api.js index cb3a1c785..7c29b6899 100644 --- a/sdks/node/dist/api.js +++ b/sdks/node/dist/api.js @@ -16464,6 +16464,11 @@ AccountResponse.attributeTypeMap = [ baseName: "account_id", type: "string" }, + { + name: "emailAddress", + baseName: "email_address", + type: "string" + }, { name: "isLocked", baseName: "is_locked", @@ -16484,11 +16489,6 @@ AccountResponse.attributeTypeMap = [ baseName: "quotas", type: "AccountResponseQuotas" }, - { - name: "emailAddress", - baseName: "email_address", - type: "string" - }, { name: "callbackUrl", baseName: "callback_url", diff --git a/sdks/node/docs/model/AccountResponse.md b/sdks/node/docs/model/AccountResponse.md index 6e64d72a1..b24e1638f 100644 --- a/sdks/node/docs/model/AccountResponse.md +++ b/sdks/node/docs/model/AccountResponse.md @@ -6,12 +6,12 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `accountId`*_required_ | ```string``` | The ID of the Account | | -| `isLocked`*_required_ | ```boolean``` | Returns `true` if the user has been locked out of their account by a team admin. | | -| `isPaidHs`*_required_ | ```boolean``` | Returns `true` if the user has a paid Dropbox Sign account. | | -| `isPaidHf`*_required_ | ```boolean``` | Returns `true` if the user has a paid HelloFax account. | | -| `quotas`*_required_ | [```AccountResponseQuotas```](AccountResponseQuotas.md) | | | +| `accountId` | ```string``` | The ID of the Account | | | `emailAddress` | ```string``` | The email address associated with the Account. | | +| `isLocked` | ```boolean``` | Returns `true` if the user has been locked out of their account by a team admin. | | +| `isPaidHs` | ```boolean``` | Returns `true` if the user has a paid Dropbox Sign account. | | +| `isPaidHf` | ```boolean``` | Returns `true` if the user has a paid HelloFax account. | | +| `quotas` | [```AccountResponseQuotas```](AccountResponseQuotas.md) | | | | `callbackUrl` | ```string``` | The URL that Dropbox Sign events will `POST` to. | | | `roleCode` | ```string``` | The membership role for the team. | | | `teamId` | ```string``` | The id of the team account belongs to. | | diff --git a/sdks/node/docs/model/AccountResponseUsage.md b/sdks/node/docs/model/AccountResponseUsage.md index b6281b84b..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`*_required_ | ```number``` | Number of fax pages sent | [default to 0] | +| `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/accountResponse.ts b/sdks/node/model/accountResponse.ts index 51a858e78..73394d615 100644 --- a/sdks/node/model/accountResponse.ts +++ b/sdks/node/model/accountResponse.ts @@ -30,24 +30,24 @@ export class AccountResponse { /** * The ID of the Account */ - "accountId": string; + "accountId"?: string; + /** + * The email address associated with the Account. + */ + "emailAddress"?: string; /** * Returns `true` if the user has been locked out of their account by a team admin. */ - "isLocked": boolean; + "isLocked"?: boolean; /** * Returns `true` if the user has a paid Dropbox Sign account. */ - "isPaidHs": boolean; + "isPaidHs"?: boolean; /** * Returns `true` if the user has a paid HelloFax account. */ - "isPaidHf": boolean; - "quotas": AccountResponseQuotas; - /** - * The email address associated with the Account. - */ - "emailAddress"?: string; + "isPaidHf"?: boolean; + "quotas"?: AccountResponseQuotas; /** * The URL that Dropbox Sign events will `POST` to. */ @@ -74,6 +74,11 @@ export class AccountResponse { baseName: "account_id", type: "string", }, + { + name: "emailAddress", + baseName: "email_address", + type: "string", + }, { name: "isLocked", baseName: "is_locked", @@ -94,11 +99,6 @@ export class AccountResponse { baseName: "quotas", type: "AccountResponseQuotas", }, - { - name: "emailAddress", - baseName: "email_address", - type: "string", - }, { name: "callbackUrl", baseName: "callback_url", diff --git a/sdks/node/model/accountResponseUsage.ts b/sdks/node/model/accountResponseUsage.ts index 96e7d02f6..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 = 0; + "faxPagesSent"?: number = 0; static discriminator: string | undefined = undefined; diff --git a/sdks/node/types/model/accountResponse.d.ts b/sdks/node/types/model/accountResponse.d.ts index ef8d619b0..c38fde985 100644 --- a/sdks/node/types/model/accountResponse.d.ts +++ b/sdks/node/types/model/accountResponse.d.ts @@ -2,12 +2,12 @@ import { AttributeTypeMap } from "./"; import { AccountResponseQuotas } from "./accountResponseQuotas"; import { AccountResponseUsage } from "./accountResponseUsage"; export declare class AccountResponse { - "accountId": string; - "isLocked": boolean; - "isPaidHs": boolean; - "isPaidHf": boolean; - "quotas": AccountResponseQuotas; + "accountId"?: string; "emailAddress"?: string; + "isLocked"?: boolean; + "isPaidHs"?: boolean; + "isPaidHf"?: boolean; + "quotas"?: AccountResponseQuotas; "callbackUrl"?: string | null; "roleCode"?: string | null; "teamId"?: string | null; diff --git a/sdks/node/types/model/accountResponseUsage.d.ts b/sdks/node/types/model/accountResponseUsage.d.ts index 6f4602df2..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; + "faxPagesSent"?: number; static discriminator: string | undefined; static attributeTypeMap: AttributeTypeMap; static getAttributeTypeMap(): AttributeTypeMap; diff --git a/sdks/php/docs/Model/AccountResponse.md b/sdks/php/docs/Model/AccountResponse.md index 815cc2f24..3121826ba 100644 --- a/sdks/php/docs/Model/AccountResponse.md +++ b/sdks/php/docs/Model/AccountResponse.md @@ -6,12 +6,12 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `account_id`*_required_ | ```string``` | The ID of the Account | | -| `is_locked`*_required_ | ```bool``` | Returns `true` if the user has been locked out of their account by a team admin. | | -| `is_paid_hs`*_required_ | ```bool``` | Returns `true` if the user has a paid Dropbox Sign account. | | -| `is_paid_hf`*_required_ | ```bool``` | Returns `true` if the user has a paid HelloFax account. | | -| `quotas`*_required_ | [```\Dropbox\Sign\Model\AccountResponseQuotas```](AccountResponseQuotas.md) | | | +| `account_id` | ```string``` | The ID of the Account | | | `email_address` | ```string``` | The email address associated with the Account. | | +| `is_locked` | ```bool``` | Returns `true` if the user has been locked out of their account by a team admin. | | +| `is_paid_hs` | ```bool``` | Returns `true` if the user has a paid Dropbox Sign account. | | +| `is_paid_hf` | ```bool``` | Returns `true` if the user has a paid HelloFax account. | | +| `quotas` | [```\Dropbox\Sign\Model\AccountResponseQuotas```](AccountResponseQuotas.md) | | | | `callback_url` | ```string``` | The URL that Dropbox Sign events will `POST` to. | | | `role_code` | ```string``` | The membership role for the team. | | | `team_id` | ```string``` | The id of the team account belongs to. | | diff --git a/sdks/php/docs/Model/AccountResponseUsage.md b/sdks/php/docs/Model/AccountResponseUsage.md index bac729127..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`*_required_ | ```int``` | Number of fax pages sent | [default to 0] | +| `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/Model/AccountResponse.php b/sdks/php/src/Model/AccountResponse.php index d7fc22ce9..3fb1a1869 100644 --- a/sdks/php/src/Model/AccountResponse.php +++ b/sdks/php/src/Model/AccountResponse.php @@ -58,11 +58,11 @@ class AccountResponse implements ModelInterface, ArrayAccess, JsonSerializable */ protected static $openAPITypes = [ 'account_id' => 'string', + 'email_address' => 'string', 'is_locked' => 'bool', 'is_paid_hs' => 'bool', 'is_paid_hf' => 'bool', 'quotas' => '\Dropbox\Sign\Model\AccountResponseQuotas', - 'email_address' => 'string', 'callback_url' => 'string', 'role_code' => 'string', 'team_id' => 'string', @@ -79,11 +79,11 @@ class AccountResponse implements ModelInterface, ArrayAccess, JsonSerializable */ protected static $openAPIFormats = [ 'account_id' => null, + 'email_address' => null, 'is_locked' => null, 'is_paid_hs' => null, 'is_paid_hf' => null, 'quotas' => null, - 'email_address' => null, 'callback_url' => null, 'role_code' => null, 'team_id' => null, @@ -98,11 +98,11 @@ class AccountResponse implements ModelInterface, ArrayAccess, JsonSerializable */ protected static array $openAPINullables = [ 'account_id' => false, + 'email_address' => false, 'is_locked' => false, 'is_paid_hs' => false, 'is_paid_hf' => false, 'quotas' => false, - 'email_address' => false, 'callback_url' => true, 'role_code' => true, 'team_id' => true, @@ -189,11 +189,11 @@ public function isNullableSetToNull(string $property): bool */ protected static $attributeMap = [ 'account_id' => 'account_id', + 'email_address' => 'email_address', 'is_locked' => 'is_locked', 'is_paid_hs' => 'is_paid_hs', 'is_paid_hf' => 'is_paid_hf', 'quotas' => 'quotas', - 'email_address' => 'email_address', 'callback_url' => 'callback_url', 'role_code' => 'role_code', 'team_id' => 'team_id', @@ -208,11 +208,11 @@ public function isNullableSetToNull(string $property): bool */ protected static $setters = [ 'account_id' => 'setAccountId', + 'email_address' => 'setEmailAddress', 'is_locked' => 'setIsLocked', 'is_paid_hs' => 'setIsPaidHs', 'is_paid_hf' => 'setIsPaidHf', 'quotas' => 'setQuotas', - 'email_address' => 'setEmailAddress', 'callback_url' => 'setCallbackUrl', 'role_code' => 'setRoleCode', 'team_id' => 'setTeamId', @@ -227,11 +227,11 @@ public function isNullableSetToNull(string $property): bool */ protected static $getters = [ 'account_id' => 'getAccountId', + 'email_address' => 'getEmailAddress', 'is_locked' => 'getIsLocked', 'is_paid_hs' => 'getIsPaidHs', 'is_paid_hf' => 'getIsPaidHf', 'quotas' => 'getQuotas', - 'email_address' => 'getEmailAddress', 'callback_url' => 'getCallbackUrl', 'role_code' => 'getRoleCode', 'team_id' => 'getTeamId', @@ -296,11 +296,11 @@ public function getModelName() public function __construct(array $data = null) { $this->setIfExists('account_id', $data ?? [], null); + $this->setIfExists('email_address', $data ?? [], null); $this->setIfExists('is_locked', $data ?? [], null); $this->setIfExists('is_paid_hs', $data ?? [], null); $this->setIfExists('is_paid_hf', $data ?? [], null); $this->setIfExists('quotas', $data ?? [], null); - $this->setIfExists('email_address', $data ?? [], null); $this->setIfExists('callback_url', $data ?? [], null); $this->setIfExists('role_code', $data ?? [], null); $this->setIfExists('team_id', $data ?? [], null); @@ -351,24 +351,7 @@ private function setIfExists(string $variableName, array $fields, $defaultValue) */ public function listInvalidProperties() { - $invalidProperties = []; - - if ($this->container['account_id'] === null) { - $invalidProperties[] = "'account_id' can't be null"; - } - if ($this->container['is_locked'] === null) { - $invalidProperties[] = "'is_locked' can't be null"; - } - if ($this->container['is_paid_hs'] === null) { - $invalidProperties[] = "'is_paid_hs' can't be null"; - } - if ($this->container['is_paid_hf'] === null) { - $invalidProperties[] = "'is_paid_hf' can't be null"; - } - if ($this->container['quotas'] === null) { - $invalidProperties[] = "'quotas' can't be null"; - } - return $invalidProperties; + return []; } /** @@ -385,7 +368,7 @@ public function valid() /** * Gets account_id * - * @return string + * @return string|null */ public function getAccountId() { @@ -395,11 +378,11 @@ public function getAccountId() /** * Sets account_id * - * @param string $account_id The ID of the Account + * @param string|null $account_id The ID of the Account * * @return self */ - public function setAccountId(string $account_id) + public function setAccountId(?string $account_id) { if (is_null($account_id)) { throw new InvalidArgumentException('non-nullable account_id cannot be null'); @@ -409,10 +392,37 @@ public function setAccountId(string $account_id) return $this; } + /** + * Gets email_address + * + * @return string|null + */ + public function getEmailAddress() + { + return $this->container['email_address']; + } + + /** + * Sets email_address + * + * @param string|null $email_address the email address associated with the Account + * + * @return self + */ + public function setEmailAddress(?string $email_address) + { + if (is_null($email_address)) { + throw new InvalidArgumentException('non-nullable email_address cannot be null'); + } + $this->container['email_address'] = $email_address; + + return $this; + } + /** * Gets is_locked * - * @return bool + * @return bool|null */ public function getIsLocked() { @@ -422,11 +432,11 @@ public function getIsLocked() /** * Sets is_locked * - * @param bool $is_locked returns `true` if the user has been locked out of their account by a team admin + * @param bool|null $is_locked returns `true` if the user has been locked out of their account by a team admin * * @return self */ - public function setIsLocked(bool $is_locked) + public function setIsLocked(?bool $is_locked) { if (is_null($is_locked)) { throw new InvalidArgumentException('non-nullable is_locked cannot be null'); @@ -439,7 +449,7 @@ public function setIsLocked(bool $is_locked) /** * Gets is_paid_hs * - * @return bool + * @return bool|null */ public function getIsPaidHs() { @@ -449,11 +459,11 @@ public function getIsPaidHs() /** * Sets is_paid_hs * - * @param bool $is_paid_hs returns `true` if the user has a paid Dropbox Sign account + * @param bool|null $is_paid_hs returns `true` if the user has a paid Dropbox Sign account * * @return self */ - public function setIsPaidHs(bool $is_paid_hs) + public function setIsPaidHs(?bool $is_paid_hs) { if (is_null($is_paid_hs)) { throw new InvalidArgumentException('non-nullable is_paid_hs cannot be null'); @@ -466,7 +476,7 @@ public function setIsPaidHs(bool $is_paid_hs) /** * Gets is_paid_hf * - * @return bool + * @return bool|null */ public function getIsPaidHf() { @@ -476,11 +486,11 @@ public function getIsPaidHf() /** * Sets is_paid_hf * - * @param bool $is_paid_hf returns `true` if the user has a paid HelloFax account + * @param bool|null $is_paid_hf returns `true` if the user has a paid HelloFax account * * @return self */ - public function setIsPaidHf(bool $is_paid_hf) + public function setIsPaidHf(?bool $is_paid_hf) { if (is_null($is_paid_hf)) { throw new InvalidArgumentException('non-nullable is_paid_hf cannot be null'); @@ -493,7 +503,7 @@ public function setIsPaidHf(bool $is_paid_hf) /** * Gets quotas * - * @return AccountResponseQuotas + * @return AccountResponseQuotas|null */ public function getQuotas() { @@ -503,11 +513,11 @@ public function getQuotas() /** * Sets quotas * - * @param AccountResponseQuotas $quotas quotas + * @param AccountResponseQuotas|null $quotas quotas * * @return self */ - public function setQuotas(AccountResponseQuotas $quotas) + public function setQuotas(?AccountResponseQuotas $quotas) { if (is_null($quotas)) { throw new InvalidArgumentException('non-nullable quotas cannot be null'); @@ -517,33 +527,6 @@ public function setQuotas(AccountResponseQuotas $quotas) return $this; } - /** - * Gets email_address - * - * @return string|null - */ - public function getEmailAddress() - { - return $this->container['email_address']; - } - - /** - * Sets email_address - * - * @param string|null $email_address the email address associated with the Account - * - * @return self - */ - public function setEmailAddress(?string $email_address) - { - if (is_null($email_address)) { - throw new InvalidArgumentException('non-nullable email_address cannot be null'); - } - $this->container['email_address'] = $email_address; - - return $this; - } - /** * Gets callback_url * diff --git a/sdks/php/src/Model/AccountResponseUsage.php b/sdks/php/src/Model/AccountResponseUsage.php index 0e4bedf2b..6728300ac 100644 --- a/sdks/php/src/Model/AccountResponseUsage.php +++ b/sdks/php/src/Model/AccountResponseUsage.php @@ -282,12 +282,7 @@ private function setIfExists(string $variableName, array $fields, $defaultValue) */ public function listInvalidProperties() { - $invalidProperties = []; - - if ($this->container['fax_pages_sent'] === null) { - $invalidProperties[] = "'fax_pages_sent' can't be null"; - } - return $invalidProperties; + return []; } /** @@ -304,7 +299,7 @@ public function valid() /** * Gets fax_pages_sent * - * @return int + * @return int|null */ public function getFaxPagesSent() { @@ -314,11 +309,11 @@ public function getFaxPagesSent() /** * Sets fax_pages_sent * - * @param int $fax_pages_sent Number of fax pages sent + * @param int|null $fax_pages_sent Number of fax pages sent * * @return self */ - public function setFaxPagesSent(int $fax_pages_sent) + public function setFaxPagesSent(?int $fax_pages_sent) { if (is_null($fax_pages_sent)) { throw new InvalidArgumentException('non-nullable fax_pages_sent cannot be null'); diff --git a/sdks/python/docs/AccountResponse.md b/sdks/python/docs/AccountResponse.md index 09b705bdf..26ce76bd1 100644 --- a/sdks/python/docs/AccountResponse.md +++ b/sdks/python/docs/AccountResponse.md @@ -5,12 +5,12 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `account_id`*_required_ | ```str``` | The ID of the Account | | -| `is_locked`*_required_ | ```bool``` | Returns `true` if the user has been locked out of their account by a team admin. | | -| `is_paid_hs`*_required_ | ```bool``` | Returns `true` if the user has a paid Dropbox Sign account. | | -| `is_paid_hf`*_required_ | ```bool``` | Returns `true` if the user has a paid HelloFax account. | | -| `quotas`*_required_ | [```AccountResponseQuotas```](AccountResponseQuotas.md) | | | +| `account_id` | ```str``` | The ID of the Account | | | `email_address` | ```str``` | The email address associated with the Account. | | +| `is_locked` | ```bool``` | Returns `true` if the user has been locked out of their account by a team admin. | | +| `is_paid_hs` | ```bool``` | Returns `true` if the user has a paid Dropbox Sign account. | | +| `is_paid_hf` | ```bool``` | Returns `true` if the user has a paid HelloFax account. | | +| `quotas` | [```AccountResponseQuotas```](AccountResponseQuotas.md) | | | | `callback_url` | ```str``` | The URL that Dropbox Sign events will `POST` to. | | | `role_code` | ```str``` | The membership role for the team. | | | `team_id` | ```str``` | The id of the team account belongs to. | | diff --git a/sdks/python/docs/AccountResponseUsage.md b/sdks/python/docs/AccountResponseUsage.md index efbc3fc1a..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`*_required_ | ```int``` | Number of fax pages sent | [default to 0] | +| `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/dropbox_sign/models/account_response.py b/sdks/python/dropbox_sign/models/account_response.py index 24aaf1763..8af0a6fb5 100644 --- a/sdks/python/dropbox_sign/models/account_response.py +++ b/sdks/python/dropbox_sign/models/account_response.py @@ -34,20 +34,25 @@ class AccountResponse(BaseModel): AccountResponse """ # noqa: E501 - account_id: StrictStr = Field(description="The ID of the Account") - is_locked: StrictBool = Field( - description="Returns `true` if the user has been locked out of their account by a team admin." + account_id: Optional[StrictStr] = Field( + default=None, description="The ID of the Account" ) - is_paid_hs: StrictBool = Field( - description="Returns `true` if the user has a paid Dropbox Sign account." - ) - is_paid_hf: StrictBool = Field( - description="Returns `true` if the user has a paid HelloFax account." - ) - quotas: AccountResponseQuotas email_address: Optional[StrictStr] = Field( default=None, description="The email address associated with the Account." ) + is_locked: Optional[StrictBool] = Field( + default=None, + description="Returns `true` if the user has been locked out of their account by a team admin.", + ) + is_paid_hs: Optional[StrictBool] = Field( + default=None, + description="Returns `true` if the user has a paid Dropbox Sign account.", + ) + is_paid_hf: Optional[StrictBool] = Field( + default=None, + description="Returns `true` if the user has a paid HelloFax account.", + ) + quotas: Optional[AccountResponseQuotas] = None callback_url: Optional[StrictStr] = Field( default=None, description="The URL that Dropbox Sign events will `POST` to." ) @@ -64,11 +69,11 @@ class AccountResponse(BaseModel): usage: Optional[AccountResponseUsage] = None __properties: ClassVar[List[str]] = [ "account_id", + "email_address", "is_locked", "is_paid_hs", "is_paid_hf", "quotas", - "email_address", "callback_url", "role_code", "team_id", @@ -146,6 +151,7 @@ def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: _obj = cls.model_validate( { "account_id": obj.get("account_id"), + "email_address": obj.get("email_address"), "is_locked": obj.get("is_locked"), "is_paid_hs": obj.get("is_paid_hs"), "is_paid_hf": obj.get("is_paid_hf"), @@ -154,7 +160,6 @@ def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: if obj.get("quotas") is not None else None ), - "email_address": obj.get("email_address"), "callback_url": obj.get("callback_url"), "role_code": obj.get("role_code"), "team_id": obj.get("team_id"), @@ -182,11 +187,11 @@ def init(cls, data: Any) -> Self: def openapi_types(cls) -> Dict[str, str]: return { "account_id": "(str,)", + "email_address": "(str,)", "is_locked": "(bool,)", "is_paid_hs": "(bool,)", "is_paid_hf": "(bool,)", "quotas": "(AccountResponseQuotas,)", - "email_address": "(str,)", "callback_url": "(str,)", "role_code": "(str,)", "team_id": "(str,)", diff --git a/sdks/python/dropbox_sign/models/account_response_usage.py b/sdks/python/dropbox_sign/models/account_response_usage.py index 8df6b3be8..84e6f9841 100644 --- a/sdks/python/dropbox_sign/models/account_response_usage.py +++ b/sdks/python/dropbox_sign/models/account_response_usage.py @@ -19,7 +19,7 @@ import json from pydantic import BaseModel, ConfigDict, Field, StrictInt -from typing import Any, ClassVar, Dict, List +from typing import Any, ClassVar, Dict, List, Optional from typing import Optional, Set, Tuple from typing_extensions import Self import io @@ -32,7 +32,9 @@ class AccountResponseUsage(BaseModel): Details concerning monthly usage """ # noqa: E501 - fax_pages_sent: StrictInt = Field(description="Number of fax pages sent") + fax_pages_sent: Optional[StrictInt] = Field( + default=0, description="Number of fax pages sent" + ) __properties: ClassVar[List[str]] = ["fax_pages_sent"] model_config = ConfigDict( diff --git a/sdks/ruby/docs/AccountResponse.md b/sdks/ruby/docs/AccountResponse.md index c2c28a069..294f29431 100644 --- a/sdks/ruby/docs/AccountResponse.md +++ b/sdks/ruby/docs/AccountResponse.md @@ -6,12 +6,12 @@ | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | -| `account_id`*_required_ | ```String``` | The ID of the Account | | -| `is_locked`*_required_ | ```Boolean``` | Returns `true` if the user has been locked out of their account by a team admin. | | -| `is_paid_hs`*_required_ | ```Boolean``` | Returns `true` if the user has a paid Dropbox Sign account. | | -| `is_paid_hf`*_required_ | ```Boolean``` | Returns `true` if the user has a paid HelloFax account. | | -| `quotas`*_required_ | [```AccountResponseQuotas```](AccountResponseQuotas.md) | | | +| `account_id` | ```String``` | The ID of the Account | | | `email_address` | ```String``` | The email address associated with the Account. | | +| `is_locked` | ```Boolean``` | Returns `true` if the user has been locked out of their account by a team admin. | | +| `is_paid_hs` | ```Boolean``` | Returns `true` if the user has a paid Dropbox Sign account. | | +| `is_paid_hf` | ```Boolean``` | Returns `true` if the user has a paid HelloFax account. | | +| `quotas` | [```AccountResponseQuotas```](AccountResponseQuotas.md) | | | | `callback_url` | ```String``` | The URL that Dropbox Sign events will `POST` to. | | | `role_code` | ```String``` | The membership role for the team. | | | `team_id` | ```String``` | The id of the team account belongs to. | | diff --git a/sdks/ruby/docs/AccountResponseUsage.md b/sdks/ruby/docs/AccountResponseUsage.md index 30f42673f..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`*_required_ | ```Integer``` | Number of fax pages sent | [default to 0] | +| `fax_pages_sent` | ```Integer``` | Number of fax pages sent | [default to 0] | diff --git a/sdks/ruby/lib/dropbox-sign/models/account_response.rb b/sdks/ruby/lib/dropbox-sign/models/account_response.rb index a6accd25b..1ab6a5d47 100644 --- a/sdks/ruby/lib/dropbox-sign/models/account_response.rb +++ b/sdks/ruby/lib/dropbox-sign/models/account_response.rb @@ -22,6 +22,10 @@ class AccountResponse # @return [String] attr_accessor :account_id + # The email address associated with the Account. + # @return [String] + attr_accessor :email_address + # Returns `true` if the user has been locked out of their account by a team admin. # @return [Boolean] attr_accessor :is_locked @@ -37,10 +41,6 @@ class AccountResponse # @return [AccountResponseQuotas] attr_accessor :quotas - # The email address associated with the Account. - # @return [String] - attr_accessor :email_address - # The URL that Dropbox Sign events will `POST` to. # @return [String, nil] attr_accessor :callback_url @@ -64,11 +64,11 @@ class AccountResponse def self.attribute_map { :'account_id' => :'account_id', + :'email_address' => :'email_address', :'is_locked' => :'is_locked', :'is_paid_hs' => :'is_paid_hs', :'is_paid_hf' => :'is_paid_hf', :'quotas' => :'quotas', - :'email_address' => :'email_address', :'callback_url' => :'callback_url', :'role_code' => :'role_code', :'team_id' => :'team_id', @@ -86,11 +86,11 @@ def self.acceptable_attributes def self.openapi_types { :'account_id' => :'String', + :'email_address' => :'String', :'is_locked' => :'Boolean', :'is_paid_hs' => :'Boolean', :'is_paid_hf' => :'Boolean', :'quotas' => :'AccountResponseQuotas', - :'email_address' => :'String', :'callback_url' => :'String', :'role_code' => :'String', :'team_id' => :'String', @@ -153,6 +153,10 @@ def initialize(attributes = {}) self.account_id = attributes[:'account_id'] end + if attributes.key?(:'email_address') + self.email_address = attributes[:'email_address'] + end + if attributes.key?(:'is_locked') self.is_locked = attributes[:'is_locked'] end @@ -169,10 +173,6 @@ def initialize(attributes = {}) self.quotas = attributes[:'quotas'] end - if attributes.key?(:'email_address') - self.email_address = attributes[:'email_address'] - end - if attributes.key?(:'callback_url') self.callback_url = attributes[:'callback_url'] end @@ -198,37 +198,12 @@ def initialize(attributes = {}) # @return Array for valid properties with the reasons def list_invalid_properties invalid_properties = Array.new - if @account_id.nil? - invalid_properties.push('invalid value for "account_id", account_id cannot be nil.') - end - - if @is_locked.nil? - invalid_properties.push('invalid value for "is_locked", is_locked cannot be nil.') - end - - if @is_paid_hs.nil? - invalid_properties.push('invalid value for "is_paid_hs", is_paid_hs cannot be nil.') - end - - if @is_paid_hf.nil? - invalid_properties.push('invalid value for "is_paid_hf", is_paid_hf cannot be nil.') - end - - if @quotas.nil? - invalid_properties.push('invalid value for "quotas", quotas cannot be nil.') - end - invalid_properties end # Check to see if the all the properties in the model are valid # @return true if the model is valid def valid? - return false if @account_id.nil? - return false if @is_locked.nil? - return false if @is_paid_hs.nil? - return false if @is_paid_hf.nil? - return false if @quotas.nil? true end @@ -238,11 +213,11 @@ def ==(o) return true if self.equal?(o) self.class == o.class && account_id == o.account_id && + email_address == o.email_address && is_locked == o.is_locked && is_paid_hs == o.is_paid_hs && is_paid_hf == o.is_paid_hf && quotas == o.quotas && - email_address == o.email_address && callback_url == o.callback_url && role_code == o.role_code && team_id == o.team_id && @@ -259,7 +234,7 @@ def eql?(o) # Calculates hash code according to all attributes. # @return [Integer] Hash code def hash - [account_id, is_locked, is_paid_hs, is_paid_hf, quotas, email_address, callback_url, role_code, team_id, locale, usage].hash + [account_id, email_address, is_locked, is_paid_hs, is_paid_hf, quotas, callback_url, role_code, team_id, locale, usage].hash end # Builds the object from hash 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 7f27e59bf..fe57fc441 100644 --- a/sdks/ruby/lib/dropbox-sign/models/account_response_usage.rb +++ b/sdks/ruby/lib/dropbox-sign/models/account_response_usage.rb @@ -99,17 +99,12 @@ def initialize(attributes = {}) # @return Array for valid properties with the reasons def list_invalid_properties invalid_properties = Array.new - if @fax_pages_sent.nil? - invalid_properties.push('invalid value for "fax_pages_sent", fax_pages_sent cannot be nil.') - end - invalid_properties end # Check to see if the all the properties in the model are valid # @return true if the model is valid def valid? - return false if @fax_pages_sent.nil? true end